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

Class: PEAR_Installer_Role

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

Class Overview



  • Release: 1.9.5


  • 1997-2009 The Authors


Inherited Variables

Inherited Methods

Class Details

[line 32]

[ Top ]

Method Detail

factory   [line 64]

PEAR_Installer_Role_Common &factory( PEAR_PackageFile_v2 $pkg, string $role, PEAR_Config &$config)


PEAR_PackageFile_v2   $pkg     
string   $role     role name
PEAR_Config   &$config     

[ Top ]

getBaseinstallRoles   [line 163]

array getBaseinstallRoles( [bool $clear = false])

Return an array of roles that are affected by the baseinstalldir attribute

Most roles ignore this attribute, and instead install directly into: PackageName/filepath so a tests file tests/file.phpt is installed into PackageName/tests/filepath.php


bool   $clear     clear cache

[ Top ]

getInstallableRoles   [line 128]

array getInstallableRoles( [bool $clear = false])

Get a list of roles that require their files to be installed

Most roles must be installed, but src and package roles, for instance are pseudo-roles. src files are compiled into a new extension. Package roles are actually fully bundled releases of a package


bool   $clear     clear cache

[ Top ]

getPhpRoles   [line 195]

array getPhpRoles( [bool $clear = false])

Return an array of file roles that should be analyzed for PHP content at package time, like the "php" role.


bool   $clear     clear cache

[ Top ]

getValidRoles   [line 93]

array getValidRoles( string $release, [bool $clear = false])

Get a list of file roles that are valid for the particular release type.

For instance, src files serve no purpose in regular php releases.


string   $release     
bool   $clear     clear cache

[ Top ]

registerRoles   [line 232]

bool registerRoles( [string $dir = null])

Scan through the Command directory looking for classes and see what commands they implement.
  • Return: TRUE on success, a PEAR error on failure
  • Access: public


string   $dir     which directory to look for classes, defaults to the Installer/Roles subdirectory of the directory from where this file (__FILE__) is included.

[ Top ]

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