Class: PEAR_Task_Postinstallscript_rw

Source Location: /PEAR-1.4.0/PEAR/Task/Postinstallscript/rw.php

Class Overview

PEAR_Task_Common
   |
   --PEAR_Task_Postinstallscript
      |
      --PEAR_Task_Postinstallscript_rw

Abstracts the postinstallscript file task xml.

Author(s):

Greg Beaver <cellog at php.net>

Version:

Release: 1.4.0

Copyright:

1997-2005 The PHP Group

Methods

Inherited Variables

Class: PEAR_Task_Postinstallscript

PEAR_Task_Postinstallscript::$phase
PEAR_Task_Postinstallscript::$type

Class: PEAR_Task_Common

PEAR_Task_Common::$config
PEAR_Task_Common::$installphase
PEAR_Task_Common::$logger
PEAR_Task_Common::$registry

Inherited Methods

Class: PEAR_Task_Postinstallscript

PEAR_Task_Postinstallscript::init(): Initialize a task instance with the parameters
PEAR_Task_Postinstallscript::run(): No longer used
PEAR_Task_Postinstallscript::startSession(): Unlike other tasks, the installed file name is passed in instead of the file contents,
PEAR_Task_Postinstallscript::validateXml(): Validate the raw xml at parsing-time.

Class: PEAR_Task_Common

PEAR_Task_Common::PEAR_Task_Common()
PEAR_Task_Common::hasPostinstallTasks()
PEAR_Task_Common::init(): Initialize a task instance with the parameters
PEAR_Task_Common::isScript(): Determines whether a role is a script
PEAR_Task_Common::run(): This method is used to process each of the tasks for a particular multiple class type. Simple tasks need not implement this method.
PEAR_Task_Common::runPostinstallTasks()
PEAR_Task_Common::startSession(): Begin a task processing session. All multiple tasks will be processed after each file has been successfully installed, all simple tasks should perform their task here and return any errors using the custom throwError() method to allow forward compatibility
PEAR_Task_Common::throwError()
PEAR_Task_Common::validXml(): Validate the basic contents of a task tag.

Class Details

[line 37]
Abstracts the postinstallscript file task xml.

Author: Greg Beaver <cellog@php.net>
Version: Release: 1.4.0
Copyright: 1997-2005 The PHP Group
Link: http://pear.php.net/package/PEAR
Since: Class available since Release 1.4.0a10
License: PHP License 3.0

[ Top ]

Method Detail

PEAR_Task_Postinstallscript_rw (Constructor) [line 54]

PEAR_Task_Postinstallscript_rw PEAR_Task_Postinstallscript_rw(

&$pkg, 
&$config, 
&$logger, array
$fileXml, PEAR_PackageFile_v2_rw
$pkg, PEAR_Config
$config, PEAR_Frontend
$logger)

Enter description here...

Parameters:

PEAR_PackageFile_v2_rw	`$pkg`	—
PEAR_Config	`$config`	—
PEAR_Frontend	`$logger`	—
array	`$fileXml`	—
	`&$pkg`	—
	`&$config`	—
	`&$logger`	—

[ Top ]

addConditionTypeGroup [line 88]

void addConditionTypeGroup(

$id, 
$oldgroup, 
$param, 
$value, [
$conditiontype = '='])

Parameters:

	`$id`	—
	`$oldgroup`	—
	`$param`	—
	`$value`	—
	`$conditiontype`	—

[ Top ]

addParamGroup [line 72]

void addParamGroup(

$id, 
$params, [
$instructions = false])

Parameters:

	`$id`	—
	`$params`	—
	`$instructions`	—

[ Top ]

getName [line 67]

void getName(
)

[ Top ]

getParam [line 112]

void getParam(

$name, 
$prompt, [
$type = 'string'], [
$default = null])

Use to set up a param tag for use in creating a paramgroup

Parameters:

	`$name`	—
	`$prompt`	—
	`$type`	—
	`$default`	—

[ Top ]

getXml [line 103]

void getXml(
)

[ Top ]

validate [line 62]

void validate(
)

[ Top ]