PEAR

[ ] [ ] [ ]

Packages:
PEAR
PEAR_ErrorStack
System

Classes:

OS_Guess
PEAR
PEAR_Autoloader
PEAR_Builder
PEAR_ChannelFile
PEAR_ChannelFile_Parser
PEAR_Command
PEAR_Command_Auth
PEAR_Command_Build
PEAR_Command_Channels
PEAR_Command_Common
PEAR_Command_Config
PEAR_Command_Install
PEAR_Command_Mirror
PEAR_Command_Package
PEAR_Command_Pickle
PEAR_Command_Registry
PEAR_Command_Remote
PEAR_Command_Test
PEAR_Common
PEAR_Config
PEAR_Dependency2
PEAR_DependencyDB
PEAR_Downloader
PEAR_Downloader_Package
PEAR_Error
PEAR_Exception
PEAR_Frontend
PEAR_Frontend_CLI
PEAR_Installer
PEAR_Installer_Role
PEAR_Installer_Role_Cfg
PEAR_Installer_Role_Common
PEAR_Installer_Role_Data
PEAR_Installer_Role_Doc
PEAR_Installer_Role_Ext
PEAR_Installer_Role_Php
PEAR_Installer_Role_Script
PEAR_Installer_Role_Src
PEAR_Installer_Role_Test
PEAR_Installer_Role_Www
PEAR_PackageFile
PEAR_PackageFile_Generator_v1
PEAR_PackageFile_Generator_v2
PEAR_PackageFile_Parser_v1
PEAR_PackageFile_Parser_v2
PEAR_PackageFile_v1
PEAR_PackageFile_v2
PEAR_PackageFile_v2_rw
PEAR_Packager
PEAR_Registry
PEAR_REST
PEAR_REST_10
PEAR_REST_11
PEAR_REST_13
PEAR_RunTest
PEAR_Task_Common
PEAR_Task_Postinstallscript
PEAR_Task_Postinstallscript_rw
PEAR_Task_Replace
PEAR_Task_Replace_rw
PEAR_Task_Unixeol
PEAR_Task_Unixeol_rw
PEAR_Task_Windowseol
PEAR_Task_Windowseol_rw
PEAR_Validate
PEAR_Validator_PECL
PEAR_XMLParser

Files:

10.php
11.php
13.php
Auth.php
Autoloader.php
Build.php
Builder.php
Cfg.php
ChannelFile.php
Channels.php
CLI.php
Command.php
Common.php
Common.php
Common.php
Common.php
Config.php
Config.php
Data.php
Dependency2.php
DependencyDB.php
Doc.php
Downloader.php
Exception.php
Ext.php
FixPHP5PEARWarnings.php
Frontend.php
Guess.php
Install.php
Installer.php
Mirror.php
Package.php
Package.php
PackageFile.php
Packager.php
Parser.php
PEAR.php
PEAR5.php
pearcmd.php
PECL.php
peclcmd.php
Php.php
Pickle.php
Postinstallscript.php
Registry.php
Registry.php
Remote.php
Replace.php
REST.php
Role.php
RunTest.php
rw.php
rw.php
rw.php
rw.php
rw.php
Script.php
Src.php
Test.php
Test.php
Unixeol.php
v1.php
v1.php
v1.php
v2.php
v2.php
v2.php
Validate.php
Validator.php
Windowseol.php
Www.php
XMLParser.php

Class: PEAR_Installer_Role_Common

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

Class Overview

Base class for all installation roles.

Author(s):

Greg Beaver <cellog at php.net>

Version:

Release: 1.9.4

Copyright:

1997-2006 The PHP Group

Variables

$config

Methods

Child classes:

PEAR_Installer_Role_Script

PEAR_Installer_Role_Doc

PEAR_Installer_Role_Cfg

PEAR_Installer_Role_Data

PEAR_Installer_Role_Www

PEAR_Installer_Role_Php

PEAR_Installer_Role_Ext

PEAR_Installer_Role_Src

PEAR_Installer_Role_Test

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.

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

[ Top ]

Class Variables

$config =

[line 37]

Access: protected

Type:

[ Top ]

Method Detail

PEAR_Installer_Role_Common (Constructor) [line 42]

PEAR_Installer_Role_Common PEAR_Installer_Role_Common(
PEAR_Config
&$config)

Parameters:

PEAR_Config &$config —

[ Top ]

getInfo [line 53]

array getInfo(
string
$role)

Retrieve configuration information about a file role from its XML info

Parameters:

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_Installer_Role_Cfg::processInstallation()

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

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

Do any unusual setup here

Overridden in child classes as:

PEAR_Installer_Role_Cfg::setup(): Do any unusual setup here

PEAR_Installer_Role_Src::setup()

Parameters:

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

[ Top ]

Documentation generated on Wed, 06 Jul 2011 23:30:34 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.