PEAR_Task_Postinstallscript_rw Class Reference

Inheritance diagram for PEAR_Task_Postinstallscript_rw:

Collaboration diagram for PEAR_Task_Postinstallscript_rw:

Public Member Functions
	__construct (&$pkg, &$config, &$logger, $fileXml)
	addConditionTypeGroup ($id, $oldgroup, $param, $value, $conditiontype='=', $params=false, $instructions=false)
	addParamGroup ($id, $params=false, $instructions=false)
	getName ()
	getParam ( $name, $prompt, $type='string', $default=null)
	getXml ()
	validate ()
Public Member Functions inherited from PEAR_Task_Postinstallscript
	_stripNamespace ($params=null)
	init ($xml, $fileattribs, $lastversion)
	startSession ($pkg, $contents, $dest)
Public Member Functions inherited from PEAR_Task_Common
	__construct (&$config, &$logger, $phase)
	isScript ()
	throwError ($msg, $code=-1)

Data Fields
	$_pkg
Data Fields inherited from PEAR_Task_Postinstallscript
	$_class
	$_contents
	$_obj
	$_params
	$_pkg
	$phase = PEAR_TASK_INSTALL
	$type = 'script'
Data Fields inherited from PEAR_Task_Common
	$logger
	$phase = PEAR_TASK_INSTALL

Additional Inherited Members
Static Public Member Functions inherited from PEAR_Task_Postinstallscript
static	run ($tasks)
static	validateXml ($pkg, $xml, $config, $fileXml)
Static Public Member Functions inherited from PEAR_Task_Common
static	hasPostinstallTasks ()
static	runPostinstallTasks ()
Protected Attributes inherited from PEAR_Task_Common
	$config
	$installphase
	$registry
	$type = 'simple'

Detailed Description

Definition at line 30 of file rw.php.

Constructor & Destructor Documentation

__construct()

__construct	(	&	$pkg,
		&	$config,
		&	$logger,
			$fileXml )

Enter description here...

Parameters

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

Returns

PEAR_Task_Postinstallscript_rw

Definition at line 48 of file rw.php.

    {
        parent::__construct($config, $logger, PEAR_TASK_PACKAGE);
        $this->_contents = $fileXml;
        $this->_pkg = &$pkg;
        $this->_params = array();
    }

References PEAR_Task_Common\$config, PEAR_Task_Common\$logger, and PEAR_TASK_PACKAGE.

Member Function Documentation

addConditionTypeGroup()

addConditionTypeGroup	(		$id,
			$oldgroup,
			$param,
			$value,
			$conditiontype = '=',
			$params = 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>

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 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

Definition at line 121 of file rw.php.

      {
        if ($params && isset($params[0]) && !isset($params[1])) {
            $params = $params[0];
        }
        $stuff = array(
            $this->_pkg->getTasksNs().':id' => $id,
        );
        if ($instructions) {
            $stuff[$this->_pkg->getTasksNs().':instructions'] = $instructions;
        }
        $stuff[$this->_pkg->getTasksNs().':name'] = $oldgroup.'::'.$param;
        $stuff[$this->_pkg->getTasksNs().':conditiontype'] = $conditiontype;
        $stuff[$this->_pkg->getTasksNs().':value'] = $value;
        if ($params) {
            $stuff[$this->_pkg->getTasksNs().':param'] = $params;
        }
        $this->_params[$this->_pkg->getTasksNs().':paramgroup'][] = $stuff;
    }

addParamGroup()

addParamGroup	(		$id,
			$params = false,
			$instructions = false )

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

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 addConditionTypeGroup() to add a <paramgroup> containing a <conditiontype> tag

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

Definition at line 81 of file rw.php.

    {
        if ($params && isset($params[0]) && !isset($params[1])) {
            $params = $params[0];
        }
        $stuff =
            array(
                $this->_pkg->getTasksNs().':id' => $id,
            );
        if ($instructions) {
            $stuff[$this->_pkg->getTasksNs().':instructions'] = $instructions;
        }
        if ($params) {
            $stuff[$this->_pkg->getTasksNs().':param'] = $params;
        }
        $this->_params[$this->_pkg->getTasksNs().':paramgroup'][] = $stuff;
    }

getName()

getName

(

)

Definition at line 61 of file rw.php.

    {
        return 'postinstallscript';
    }

getParam()

getParam	(		$name,
			$prompt,
			$type = 'string',
			$default = null )

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

Parameters

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

Returns

array

Definition at line 162 of file rw.php.

      {
        if ($default !== null) {
            return
            array(
                $this->_pkg->getTasksNs().':name' => $name,
                $this->_pkg->getTasksNs().':prompt' => $prompt,
                $this->_pkg->getTasksNs().':type' => $type,
                $this->_pkg->getTasksNs().':default' => $default,
            );
        }
 
        return
            array(
                $this->_pkg->getTasksNs().':name' => $name,
                $this->_pkg->getTasksNs().':prompt' => $prompt,
                $this->_pkg->getTasksNs().':type' => $type,
            );
    }

References PEAR_Task_Postinstallscript\$type.

getXml()

getXml

(

)

Definition at line 147 of file rw.php.

    {
        return $this->_params;
    }

References PEAR_Task_Postinstallscript\$_params.

validate()

validate

(

)

Definition at line 56 of file rw.php.

    {
        return $this->validateXml($this->_pkg, $this->_params, $this->config, $this->_contents);
    }

References PEAR_Task_Postinstallscript\validateXml().

Here is the call graph for this function:

Field Documentation

$_pkg

$_pkg

Definition at line 37 of file rw.php.

---

The documentation for this class was generated from the following file:

• E:/Bearsampp-development/sandbox/core/libs/php/pear/pear/PEAR/Task/Postinstallscript/rw.php