Docs For Class PEAR_Installer_Role

PEAR_Installer_Role_Common (Constructor) [line 161]

PEAR_Installer_Role_Common PEAR_Installer_Role_Common(
PEAR_Config
&$config)

Parameters:

PEAR_Config &$config —

[ Top ]

getInfo [line 68]

array getInfo(
)

This is used at startup to initialize the list of valid file roles, and what each role

means in terms of installation. All values present in the base class must exist in every custom role

Overridden in child classes as:

PEAR_Installer_Role_Ext::getInfo()

PEAR_Installer_Role_Test::getInfo()

PEAR_Installer_Role_Data::getInfo()

PEAR_Installer_Role_Php::getInfo()

PEAR_Installer_Role_Doc::getInfo()

PEAR_Installer_Role_Src::getInfo()

PEAR_Installer_Role_Script::getInfo()

[ Top ]

getLocationConfig [line 153]

string|false getLocationConfig(
)

Get the name of the configuration variable that specifies the location of this file

[ Top ]

getSupportingConfigVars [line 144]

void getSupportingConfigVars(
PEAR_Config
0)

This method is called upon instantiating a PEAR_Config object.

This method MUST an array of information for all new configuration variables required by the file role. addConfigVar() expects an array of configuration information that is identical to what is used internally in PEAR_Config

Access: protected

Parameters:

PEAR_Config 0 —

[ Top ]

isExecutable [line 177]

void isExecutable(
)

[ Top ]

isExtension [line 187]

void isExtension(
)

[ Top ]

isInstallable [line 182]

void isInstallable(
)

[ Top ]

processInstallation [line 94]

array processInstallation(
PEAR_PackageFile_v1|PEAR_PackageFile_v2
$pkg, array
$atts, string
$file, 
$tmp_path, [
$layer = null])

This is called for each file to set up the directories and files

Return:
an array consisting of:
1. the original, pre-baseinstalldir installation directory
2. the final installation directory
3. the full path to the final location of the file
4. the location of the pre-installation file

Parameters:

PEAR_PackageFile_v1\|PEAR_PackageFile_v2	`$pkg`	—
array	`$atts`	—	attributes from the <file> tag
string	`$file`	—	file name
	`$tmp_path`	—
	`$layer`	—

[ Top ]

setup [line 173]

void setup(
PEAR_Installer
&$installer, PEAR_PackageFile_v1|PEAR_PackageFile_v2
$pkg, array
$atts, string
$file)

Do any unusual setup here

Overridden in child classes as:

PEAR_Installer_Role_Ext::setup()

PEAR_Installer_Role_Test::setup()

PEAR_Installer_Role_Data::setup()

PEAR_Installer_Role_Php::setup()

PEAR_Installer_Role_Doc::setup()

PEAR_Installer_Role_Src::setup()

PEAR_Installer_Role_Script::setup()

Parameters:

PEAR_Installer	`&$installer`	—
PEAR_PackageFile_v1\|PEAR_PackageFile_v2	`$pkg`	—
array	`$atts`	—	file attributes
string	`$file`	—	file name

[ Top ]

Class: PEAR_Installer_Role_Common

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$config =

Method Detail

PEAR_Installer_Role_Common (Constructor) [line 161]

Parameters:

getInfo [line 68]

getLocationConfig [line 153]

getSupportingConfigVars [line 144]

Parameters:

isExecutable [line 177]

isExtension [line 187]

isInstallable [line 182]

processInstallation [line 94]

Parameters:

setup [line 173]

Parameters: