Docs For Class PEAR_Installer

Class: PEAR_Installer_Role

Inherited Variables

Inherited Methods

Class Details

[line 31]

Author: Greg Beaver <cellog@php.net>
Version: Release: 1.10.12
Copyright: 1997-2009 The Authors
Link: http://pear.php.net/package/PEAR
Since: Class available since Release 1.4.0a1
License: New BSD License

Method Detail

factory [line 60]

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

Access: public

Parameters:

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

[ Top ]

getBaseinstallRoles [line 156]

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

Access: public

Parameters:

bool $clear — clear cache

[ Top ]

getInstallableRoles [line 122]

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

Access: public

Parameters:

bool $clear — clear cache

[ Top ]

getPhpRoles [line 187]

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.

Access: public

Parameters:

bool $clear — clear cache

[ Top ]

getValidRoles [line 88]

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.

Access: public

Parameters:

string	`$release`	—
bool	`$clear`	—	clear cache

[ Top ]

initializeConfig [line 39]

void initializeConfig(
PEAR_Config
&$config)

Set up any additional configuration variables that file roles require

Never call this directly, it is called by the PEAR_Config constructor

Access: public

Parameters:

PEAR_Config &$config —

[ Top ]

registerRoles [line 222]

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

Parameters:

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 ]

Class: PEAR_Installer_Role

Class Overview

Author(s):

Version:

Copyright:

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

factory [line 60]

Parameters:

getBaseinstallRoles [line 156]

Parameters:

getInstallableRoles [line 122]

Parameters:

getPhpRoles [line 187]

Parameters:

getValidRoles [line 88]

Parameters:

initializeConfig [line 39]

Parameters:

registerRoles [line 222]

Parameters: