Class: PEAR_Task_Postinstallscript_rw

Source Location: /PEAR-1.10.12/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.10.12

Copyright:

1997-2009 The Authors

Inherited Variables

Class: PEAR_Task_Postinstallscript

PEAR_Task_Postinstallscript::$phase
PEAR_Task_Postinstallscript::$type
PEAR_Task_Postinstallscript::$_class
PEAR_Task_Postinstallscript::$_contents
PEAR_Task_Postinstallscript::$_obj
PEAR_Task_Postinstallscript::$_params

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, because this task is handled post-installation
PEAR_Task_Postinstallscript::validateXml(): Validate the raw xml at parsing-time.
PEAR_Task_Postinstallscript::_stripNamespace(): Strip the tasks: namespace from internal params

Class: PEAR_Task_Common

PEAR_Task_Common::__construct()
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
PEAR_Task_Common::throwError()
PEAR_Task_Common::validateXml(): Validate the basic contents of a task tag.

Class Details

[line 30]
Abstracts the postinstallscript file task xml.

Author: Greg Beaver <cellog@php.net>
Version: Release: 1.10.12
Copyright: 1997-2009 The Authors
Link: http://pear.php.net/package/PEAR
Since: Class available since Release 1.4.0a10
License: New BSD License

[ Top ]

Class Variables

$_pkg =

[line 37]

parent package file object

Access: public

Type:	PEAR_PackageFile_v2_rw
Overrides:	Array

[ Top ]

Method Detail

__construct (Constructor) [line 48]

PEAR_Task_Postinstallscript_rw __construct(

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

Enter description here...

Overrides PEAR_Task_Common::__construct() (parent method not documented)

Parameters:

PEAR_PackageFile_v2_rw	`$pkg`	—	Package
PEAR_Config	`$config`	—	Config
PEAR_Frontend	`$logger`	—	Logger
array	`$fileXml`	—	XML
	`&$pkg`	—
	`&$config`	—
	`&$logger`	—

[ Top ]

addConditionTypeGroup [line 121]

void addConditionTypeGroup(
string
$id, string
$oldgroup, string
$param, string
$value, [string
$conditiontype = '='], [array|false
$params = false], [string|false
$instructions = false])

Add a complex <paramgroup> to the post-install script with conditions

This inserts a <paramgroup> with

Order is significant, so call this method in the same sequence the users should see the paramgroups. The $params parameter should either be the result of a call to getParam() or an array of calls to getParam().

Use addParamGroup() to add a simple <paramgroup>

Access: public

Parameters:

string	`$id`	—	<paramgroup> id as seen by the script
string	`$oldgroup`	—	<paramgroup> id of the section referenced by <conditiontype>
string	`$param`	—	name of the <param> from the older section referenced by <contitiontype>
string	`$value`	—	value to match of the parameter
string	`$conditiontype`	—	one of '=', '!=', 'preg_match'
array\|false	`$params`	—	array of getParam() calls, or false for no params
string\|false	`$instructions`	—

[ Top ]

addParamGroup [line 81]

void addParamGroup(
string
$id, [array|false
$params = false], [string|false
$instructions = false])

add a simple <paramgroup> to the post-install script

Use addConditionTypeGroup() to add a <paramgroup> containing a <conditiontype> tag

Access: public

Parameters:

string	`$id`	—	<paramgroup> id as seen by the script
array\|false	`$params`	—	array of getParam() calls, or false for no params
string\|false	`$instructions`	—

[ Top ]

getName [line 61]

void getName(
)

Access: public

[ Top ]

getParam [line 162]

array getParam(
mixed
$name, mixed
$prompt, [string
$type = 'string'], [mixed
$default = null])

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

Access: public

Parameters:

mixed	`$name`	—	Name of parameter
mixed	`$prompt`	—	Prompt
string	`$type`	—	Type, defaults to 'string'
mixed	`$default`	—	Default value

[ Top ]

getXml [line 147]

void getXml(
)

Access: public

[ Top ]

validate [line 56]

void validate(
)

Access: public

[ Top ]