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

Class: PEAR_Installer_Role_Common

Source Location: /PEAR-1.10.0dev3/PEAR/Installer/Role/Common.php

Class Overview

Base class for all installation roles.



  • Release: 1.10.0dev3


  • 1997-2006 The PHP Group



Child classes:

Inherited Variables

Inherited Methods

Class Details

[line 30]
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 36]

  • Access: protected

Type:   PEAR_Config

[ Top ]

Method Detail

__construct (Constructor)   [line 41]

PEAR_Installer_Role_Common __construct( PEAR_Config &$config)


PEAR_Config   &$config   — 

[ Top ]

getInfo   [line 52]

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

string|false getLocationConfig( )

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

[ Top ]

isExecutable   [line 143]

void isExecutable( )

[ Top ]

isExtension   [line 163]

void isExtension( )

[ Top ]

isInstallable   [line 153]

void isInstallable( )

[ Top ]

processInstallation   [line 72]

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
   $tmp_path   — 
   $layer   — 

[ Top ]

setup   [line 139]

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 Mon, 28 Sep 2015 18:30:21 +0000 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.