PEAR_Frontend_Web
[ class tree: PEAR_Frontend_Web ] [ index: PEAR_Frontend_Web ] [ all elements ]
Packages:
PEAR_Frontend_Web
apidoc


Classes:
PEAR_Command_Categories
PEAR_Frontend_Web
PEAR_Frontend_Web_Docviewer
Files:
Categories.php
Docviewer.php
pearfrontendweb.php
Web.php

Class: PEAR_Frontend_Web

Source Location: /PEAR_Frontend_Web-0.7.2/Frontend/Web.php

Class Overview

PEAR_Frontend
   |
   --PEAR_Frontend_Web

PEAR_Frontend_Web is a HTML based Webfrontend for the PEAR Installer


Author(s):

Version:

  • CVS: $Id: Web.php,v 1.86 2008/01/20 12:40:56 tias Exp $

Copyright:

  • 1997-2007 The PHP Group

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

[line 57]
PEAR_Frontend_Web is a HTML based Webfrontend for the PEAR Installer

The Webfrontend provides basic functionality of the Installer, such as a package list grouped by categories, a search mask, the possibility to install/upgrade/uninstall packages and some minor things. PEAR_Frontend_Web makes use of the PEAR::HTML_IT Template engine which provides the possibillity to skin the Installer.



[ Top ]

Class Variables

$config =

[line 82]

The config object

Type:   mixed


[ Top ]

$type =  'Web'

[line 66]

What type of user interface this frontend is for.
  • Access: public

Type:   string


[ Top ]


Method Detail

PEAR_Frontend_Web (Constructor)   [line 118]

PEAR_Frontend_Web PEAR_Frontend_Web( )


[ Top ]

bold   [line 1953]

void bold( $text)

Totaly deprecated function

Needed to install pearified's role_web : / Don't use this !


Parameters:

   $text   — 

[ Top ]

confirmDialog   [line 1727]

array|false confirmDialog( array $params, string $pkg)

Ask for user input, confirm the answers and continue until the user is satisfied

Parameters:

array   $params   —  an array of arrays, format array('name' => 'paramname', 'prompt' => 'text to display', 'type' => 'string'[, default => 'default value'])
string   $pkg   —  Package Name

[ Top ]

displayError   [line 171]

null displayError( mixed $eobj, [string $title = 'Error'], [string $img = 'error'], [boolean $popup = false])

Display an error page
  • Return: does not return anything, but exit the script
  • Access: public

Parameters:

mixed   $eobj   —  PEAR_Error object or string containing the error message
string   $title   —  (optional) title of the page
string   $img   —  (optional) iconhandle for this page
boolean   $popup   —  (optional) popuperror or normal?

[ Top ]

displayFatalError   [line 210]

void displayFatalError( $eobj, [ $title = 'Error'], [ $img = 'error'])

Alias for PEAR_Frontend_Web::displayError()

Parameters:

   $eobj   — 
   $title   — 
   $img   — 

[ Top ]

finishOutput   [line 1476]

void finishOutput( $command, [ $redirectLink = false])

End session: output all saved output

Parameters:

   $command   — 
   $redirectLink   — 

[ Top ]

htmlentities_recursive   [line 2352]

void htmlentities_recursive( $data)

apply 'htmlentities' to every value of the array

array_walk_recursive($array, 'htmlentities') in PHP5


Parameters:

   $data   — 

[ Top ]

log   [line 1869]

boolean log( string $text)

Write message to log
  • Return: true
  • Access: public

Parameters:

string   $text   —  message which has to written to log

[ Top ]

outputBegin   [line 2170]

void outputBegin( $command)

Start output, HTML header etc

Parameters:

   $command   — 

[ Top ]

outputData   [line 1272]

mixed outputData( mixed $data, [string $command = '_default'])

Output all kinds of data depending on the command which called this method
  • Return: highly depends on the command
  • Access: public

Parameters:

mixed   $data   —  datastructure containing the information to display
string   $command   —  (optional) command from which this method was called

[ Top ]

outputEnd   [line 2247]

void outputEnd( $command)

End output, HTML footer etc

Parameters:

   $command   — 

[ Top ]

outputFrontendFile   [line 1968]

null outputFrontendFile( string $handle, string $group)

Sends the required file along with Headers and exits the script
  • Return: nothing, because script exits
  • Access: public

Parameters:

string   $handle   —  handle of the requested file
string   $group   —  group of the requested file

[ Top ]

outputSearch   [line 1421]

void outputSearch( )

Output the 'search' page

[ Top ]

outputTableOfChannels   [line 1390]

void outputTableOfChannels( )

Output a Table Of Channels:

Table of contents like thing for all channels (using <a name= stuff


[ Top ]

outputUpgradeAll   [line 1411]

void outputUpgradeAll( )

Output the 'upgrade-all' page

[ Top ]

runInstallScript   [line 1579]

void runInstallScript( array $xml, &$script, &$pkg, object $script, PEAR_PackageFile_v1|PEAR_PackageFile_v2 $pkg, string $contents)


Parameters:

array   $xml   —  contents of postinstallscript tag example: Array (
object   $script   —  post-installation script
PEAR_PackageFile_v1|PEAR_PackageFile_v2   $pkg   — 
string   $contents   —  contents of the install script
   &$script   — 
   &$pkg   — 

[ Top ]

runPostinstallScripts   [line 1500]

void runPostinstallScripts( array &$scripts, PEAR_PackageFile_v2 $pkg)

Run postinstall scripts

Parameters:

array   &$scripts   —  An array of PEAR_Task_Postinstallscript objects (or related scripts)
PEAR_PackageFile_v2   $pkg   — 

[ Top ]

setConfig   [line 124]

void setConfig( &$config)


Parameters:

   &$config   — 

[ Top ]

skipParamgroup   [line 1557]

void skipParamgroup( string $id)

Instruct the runInstallScript method to skip a paramgroup that matches the id value passed in.

This method is useful for dynamically configuring which sections of a post-install script will be run based on the user's setup, which is very useful for making flexible post-install scripts without losing the cross-Frontend ability to retrieve user input


Parameters:

string   $id   — 

[ Top ]

startSession   [line 1461]

void startSession( )

Start session: starts saving output temporary

[ Top ]

userConfirm   [line 1761]

void userConfirm( $prompt, [ $default = 'yes'])

Useless function that needs to exists for Frontend::setFrontendObject()

Reported in bug #10656


Parameters:

   $prompt   — 
   $default   — 

[ Top ]

userDialog   [line 1784]

array userDialog( string $command, array $prompts, [array $types = array()], [array $defaults = array()], [string $title = ''], [string $icon = ''], [array $extra = array()])

Display a formular and return the given input (yes. needs to requests)
  • Return: input sended by the user
  • Access: public

Parameters:

string   $command   —  command from which this method was called
array   $prompts   —  associative array. keys are the inputfieldnames and values are the description
array   $types   —  (optional) array of inputfieldtypes (text, password, etc.) keys have to be the same like in $prompts
array   $defaults   —  (optional) array of defaultvalues. again keys have to be the same like in $prompts
string   $title   —  (optional) title of the page
string   $icon   —  (optional) iconhandle for this page
array   $extra   —  (optional) extra parameters to put in the form action

[ Top ]

__getData   [line 2083]

void __getData( $from, $limit, $numrows, [ $maxpages = false])


Parameters:

   $from   — 
   $limit   — 
   $numrows   — 
   $maxpages   — 

[ Top ]
Documentation generated on Mon, 11 Mar 2019 15:14:53 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.