[ class tree: PEAR ] [ index: PEAR ] [ all elements ]

Class: PEAR_Installer_Role_Common

Source Location: /PEAR-1.9.5/PEAR/Installer/Role/Common.php

Class Overview

Base class for all installation roles.



  • Release: 1.9.5


  • 1997-2006 The PHP Group



Child classes:

Inherited Variables

Inherited Methods

Class Details

[line 31]
Base class for all installation roles.

This class allows extensibility of file roles. Packages with complex customization can now provide custom file roles along with the possibility of adding configuration values to match.

[ Top ]

Class Variables

$config =

[line 37]

  • Access: protected

Type:   PEAR_Config

[ Top ]

Method Detail

PEAR_Installer_Role_Common (Constructor)   [line 42]

PEAR_Installer_Role_Common PEAR_Installer_Role_Common( PEAR_Config &$config)


PEAR_Config   &$config     

[ Top ]

getInfo   [line 53]

array getInfo( string $role)

Retrieve configuration information about a file role from its XML info


string   $role     Role Classname, as in "PEAR_Installer_Role_Data"

[ Top ]

getLocationConfig   [line 123]

string|false getLocationConfig( )

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

[ Top ]

isExecutable   [line 144]

void isExecutable( )

[ Top ]

isExtension   [line 164]

void isExtension( )

[ Top ]

isInstallable   [line 154]

void isInstallable( )

[ Top ]

processInstallation   [line 73]

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

Overridden in child classes as:



PEAR_PackageFile_v1|PEAR_PackageFile_v2   $pkg     
array   $atts     attributes from the <file> tag
string   $file     file name

[ Top ]

setup   [line 140]

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

Do any unusual setup here

Overridden in child classes as:

Do any unusual setup here


PEAR_Installer   &$installer     
PEAR_PackageFile_v2   $pkg     
array   $atts     file attributes
string   $file     file name

[ Top ]

Documentation generated on Sat, 12 Jul 2014 14:00:30 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.