PEAR_Task_Common Class Reference

Inheritance diagram for PEAR_Task_Common:

Public Member Functions
	__construct (&$config, &$logger, $phase)
	init ($xml, $fileAttributes, $lastVersion)
	isScript ()
	startSession ($pkg, $contents, $dest)
	throwError ($msg, $code=-1)

Static Public Member Functions
static	hasPostinstallTasks ()
static	run ($tasks)
static	runPostinstallTasks ()
static	validateXml ($pkg, $xml, $config, $fileXml)

Data Fields
	$logger
	$phase = PEAR_TASK_INSTALL

Protected Attributes
	$config
	$installphase
	$registry
	$type = 'simple'

Detailed Description

Definition at line 55 of file Common.php.

Constructor & Destructor Documentation

__construct()

__construct	(	&	$config,
		&	$logger,
			$phase )

Parameters

PEAR_Config
PEAR_Common

Definition at line 93 of file Common.php.

    {
        $this->config = &$config;
        $this->registry = &$config->getRegistry();
        $this->logger = &$logger;
        $this->installphase = $phase;
        if ($this->type == 'multiple') {
            $GLOBALS['_PEAR_TASK_POSTINSTANCES'][get_class($this)][] = &$this;
        }
    }

References $config, $GLOBALS, $logger, and $phase.

Member Function Documentation

hasPostinstallTasks()

hasPostinstallTasks ( )

static

@final

Definition at line 170 of file Common.php.

    {
        return isset($GLOBALS['_PEAR_TASK_POSTINSTANCES']);
    }

References $GLOBALS.

Referenced by PEAR_Installer\install().

Here is the caller graph for this function:

init()

init	(		$xml,
			$fileAttributes,
			$lastVersion )

Initialize a task instance with the parameters

Parameters

array	raw, parsed xml
array	attributes from the <file> tag containing this task
string|null	last installed version of this package @abstract

Reimplemented in PEAR_Task_Postinstallscript, PEAR_Task_Replace, PEAR_Task_Unixeol, and PEAR_Task_Windowseol.

Definition at line 133 of file Common.php.

    {
    }

isScript()

isScript

(

)

Determines whether a role is a script

Returns

bool

Definition at line 196 of file Common.php.

    {
            return $this->type == 'script';
    }

run()

run ( $tasks )

static

This method is used to process each of the tasks for a particular multiple class type. Simple tasks need not implement this method.

Parameters

array

an array of tasks @access protected

Reimplemented in PEAR_Task_Postinstallscript.

Definition at line 163 of file Common.php.

    {
    }

runPostinstallTasks()

runPostinstallTasks ( )

static

@final

Definition at line 178 of file Common.php.

    {
        foreach ($GLOBALS['_PEAR_TASK_POSTINSTANCES'] as $class => $tasks) {
            $err = call_user_func(
                array($class, 'run'),
                $GLOBALS['_PEAR_TASK_POSTINSTANCES'][$class]
            );
            if ($err) {
                return PEAR_Task_Common::throwError($err);
            }
        }
        unset($GLOBALS['_PEAR_TASK_POSTINSTANCES']);
    }

References $GLOBALS, and throwError().

Referenced by PEAR_Installer\install().

Here is the call graph for this function:

Here is the caller graph for this function:

startSession()

startSession	(		$pkg,
			$contents,
			$dest )

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

This method MUST NOT write out any changes to disk

Parameters

PEAR_PackageFile_v2
string	file contents
string	the eventual final file location (informational only)

Returns

string|false|PEAR_Error false to skip this file, PEAR_Error to fail (use $this->throwError), otherwise return the new contents @abstract

Reimplemented in PEAR_Task_Postinstallscript, PEAR_Task_Replace, PEAR_Task_Unixeol, and PEAR_Task_Windowseol.

Definition at line 152 of file Common.php.

    {
    }

throwError()

throwError	(		$msg,
			$code = -1 )

Definition at line 201 of file Common.php.

    {
        include_once 'PEAR.php';
 
        return PEAR::raiseError($msg, $code);
    }

Referenced by runPostinstallTasks(), and PEAR_Task_Postinstallscript\startSession().

Here is the caller graph for this function:

validateXml()

validateXml ( $pkg, $xml, $config, $fileXml )

static

Validate the basic contents of a task tag.

Parameters

PEAR_PackageFile_v2
array
PEAR_Config
array	the entire parsed <file> tag

Returns

true|array On error, return an array in format: array(PEAR_TASK_ERROR_???[, param1][, param2][, ...])

For PEAR_TASK_ERROR_MISSING_ATTRIB, pass the attribute name in For PEAR_TASK_ERROR_WRONG_ATTRIB_VALUE, pass the attribute name and an array of legal values in

@abstract

Reimplemented in PEAR_Task_Postinstallscript, PEAR_Task_Replace, PEAR_Task_Unixeol, and PEAR_Task_Windowseol.

Definition at line 121 of file Common.php.

    {
    }

References $config.

Field Documentation

$config

$config

protected

@access protected

Definition at line 76 of file Common.php.

Referenced by __construct(), PEAR_Task_Postinstallscript_rw\__construct(), PEAR_Task_Replace_rw\__construct(), PEAR_Task_Unixeol_rw\__construct(), PEAR_Task_Windowseol_rw\__construct(), validateXml(), PEAR_Task_Postinstallscript\validateXml(), PEAR_Task_Replace\validateXml(), PEAR_Task_Unixeol\validateXml(), and PEAR_Task_Windowseol\validateXml().

$installphase

$installphase

protected

@access protected

Definition at line 88 of file Common.php.

$logger

$logger

@access protected

Definition at line 84 of file Common.php.

Referenced by __construct(), PEAR_Task_Postinstallscript_rw\__construct(), PEAR_Task_Replace_rw\__construct(), PEAR_Task_Unixeol_rw\__construct(), and PEAR_Task_Windowseol_rw\__construct().

$phase

$phase = PEAR_TASK_INSTALL

Determines which install phase this task is executed under

Definition at line 72 of file Common.php.

Referenced by __construct().

$registry

$registry

protected

@access protected

Definition at line 80 of file Common.php.

$type

$type = 'simple'

protected

Valid types for this version are 'simple' and 'multiple'

• simple tasks operate on the contents of a file and write out changes to disk
• multiple tasks operate on the contents of many files and write out the changes directly to disk

Child task classes must override this property.

@access protected

Definition at line 68 of file Common.php.

---

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

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