Class: PEAR_Frontend_Web_Docviewer

Source Location: /PEAR_Frontend_Web-0.7.5/Frontend/Web/Docviewer.php

Class Overview

PEAR_Frontend_Web_Docviewer allows you to view the documentation of the installed packages, in the webfrontend.

Author(s):

Tias Guns <tias at ulyssis.org>

Version:

CVS: $Id: Docviewer.php 235933 2007-05-19 15:36:40Z tias $

Copyright:

1997-2007 The PHP Group

Variables

$config
$ui

Methods

Inherited Variables

Inherited Methods

Class Details

[line 29]
PEAR_Frontend_Web_Docviewer allows you to view the documentation of the installed packages, in the webfrontend.

Most packages provide some documentation files, this class allows you to find out which ones, and to display there content.

Author: Tias Guns <tias@ulyssis.org>
Version: CVS: $Id: Docviewer.php 235933 2007-05-19 15:36:40Z tias $
Copyright: 1997-2007 The PHP Group
Link: http://pear.php.net/package/PEAR_Frontend_Web
Since: File available since Release 0.6.2
License: PHP License 2.02

[ Top ]

Class Variables

$config =

[line 35]

The config object

Type:

mixed

[ Top ]

$ui =

[line 41]

User Interface object, for all interaction with the user.

Type:

object

[ Top ]

Method Detail

PEAR_Frontend_Web_Docviewer (Constructor) [line 48]

PEAR_Frontend_Web_Docviewer PEAR_Frontend_Web_Docviewer(
$ui
&$ui)

Create instance and set config to global frontweb config

Parameters:

$ui &$ui — User Interface object

[ Top ]

getDocFiles [line 73]

array('name' getDocFiles(

$package_name, string
$channel, string
$package)

Get the files with role 'doc' of the given package

Can be called as static method

Return: => 'installed_as', ...

Parameters:

string	`$package`	—	package name
string	`$channel`	—
	`$package_name`	—

[ Top ]

outputDocShow [line 125]

true outputDocShow(

$package_name, string
$channel, string
$file, string
$package)

Output in HTML the documentation file of given package

Return: (uses the User Interface object)

Parameters:

string	`$package`	—	package name
string	`$channel`	—
string	`$file`	—
	`$package_name`	—

[ Top ]

outputListDocs [line 93]

true outputListDocs(

$package_name, string
$channel, string
$package)

Output in HTML the list of docs of given package

Return: (uses the User Interface object)

Parameters:

string	`$package`	—	package name
string	`$channel`	—
	`$package_name`	—

[ Top ]

setConfig [line 59]

void setConfig(
$config
&$config)

Set the config, manually

Parameters:

$config &$config — config object

[ Top ]