Docs For Class PEAR_PackageFile

PEAR_PackageFile_v2 (Constructor) [line 133]

PEAR_PackageFile_v2 PEAR_PackageFile_v2(
)

The constructor merely sets up the private error stack

[ Top ]

analyzeSourceCode [line 1843]

void analyzeSourceCode(

$file, [
$string = false])

Parameters:

	`$file`	—
	`$string`	—

[ Top ]

dependsOn [line 1527]

void dependsOn(

$package, 
$channel)

Parameters:

	`$package`	—
	`$channel`	—

[ Top ]

flattenFilelist [line 643]

void flattenFilelist(
)

Convert a recursive set of <dir> and <file> tags into a single <dir> tag with <file> tags.

[ Top ]

fromArray [line 781]

void fromArray(
array
$pinfo)

Directly set the array that defines this packagefile

WARNING: no validation. This should only be performed by internal methods inside PEAR or by inputting an array saved from an existing PEAR_PackageFile_v2

Parameters:

array $pinfo —

[ Top ]

getArchiveFile [line 768]

void getArchiveFile(
)

[ Top ]

getArray [line 805]

void getArray(
[
$forReg = false])

Parameters:

$forReg —

[ Top ]

getBundledPackages [line 1768]

void getBundledPackages(
)

[ Top ]

getChangelog [line 1738]

array getChangelog(
)

[ Top ]

getChannel [line 872]

void getChannel(
)

[ Top ]

getCompatible [line 1452]

array|false getCompatible(
)

[ Top ]

getConfigureOptions [line 1175]

array|false getConfigureOptions(
)

Return configure options array, if any

[ Top ]

getContents [line 1332]

void getContents(
)

Retrieve the contents tag

[ Top ]

getContributors [line 997]

void getContributors(
)

[ Top ]

getDate [line 1043]

void getDate(
)

[ Top ]

getDefaultGenerator [line 1834]

void &getDefaultGenerator(
)

[ Top ]

getDependencies [line 1460]

void getDependencies(
)

[ Top ]

getDependencyGroup [line 1575]

array|false getDependencyGroup(
string
$name)

Get the contents of a dependency group

Parameters:

string $name —

[ Top ]

getDeps [line 1604]

array|false getDeps(
[boolean
$raw = false], [
$nopearinstaller = false])

Retrieve a partial package.xml 1.0 representation of dependencies

a very limited representation of dependencies is returned by this method. The <exclude> tag for excluding certain versions of a dependency is completely ignored. In addition, dependency groups are ignored, with the assumption that all dependencies in dependency groups are also listed in the optional group that work with all dependency groups

Parameters:

boolean	`$raw`	—	return package.xml 2.0 <dependencies> tag
	`$nopearinstaller`	—

[ Top ]

getDescription [line 907]

void getDescription(
)

[ Top ]

getDevelopers [line 989]

void getDevelopers(
)

[ Top ]

getDirtree [line 1389]

void getDirtree(
)

[ Top ]

getExtends [line 891]

void getExtends(
)

[ Top ]

getFileContents [line 1789]

string getFileContents(
string
$file)

Get the contents of a file listed within the package.xml

Parameters:

string $file —

[ Top ]

getFilelist [line 1144]

void getFilelist(
[
$preserve = false])

This should only be used to retrieve filenames and install attributes

Parameters:

$preserve —

[ Top ]

getHelpers [line 1005]

void getHelpers(
)

[ Top ]

getInstallationFilelist [line 1209]

array getInstallationFilelist(
[
$forfilecheck = false])

Retrieve a list of files that should be installed on this computer

Parameters:

$forfilecheck —

[ Top ]

getInstalledBinary [line 171]

void getInstalledBinary(
)

[ Top ]

getInstalledLocation [line 1307]

void getInstalledLocation(

$file)

Parameters:

$file —

[ Top ]

getLastInstalledVersion [line 522]

string|false getLastInstalledVersion(
)

[ Top ]

getLastModified [line 1776]

void getLastModified(
)

[ Top ]

getLeads [line 981]

void getLeads(
)

[ Top ]

getLicense [line 1086]

void getLicense(
[
$raw = false])

Parameters:

$raw —

[ Top ]

getLicenseLocation [line 1101]

void getLicenseLocation(
)

[ Top ]

getMaintainers [line 915]

void getMaintainers(
[
$raw = false])

Parameters:

$raw —

[ Top ]

getName [line 859]

void getName(
)

[ Top ]

getNotes [line 1109]

void getNotes(
)

[ Top ]

getPackage [line 864]

void getPackage(
)

[ Top ]

getPackageFile [line 763]

void getPackageFile(
)

[ Top ]

getPackageType [line 1703]

php|extsrc|extbin|bundle|false getPackageType(
)

[ Top ]

getPackagexmlVersion [line 1751]

void getPackagexmlVersion(
)

[ Top ]

getPEARDependency2 [line 162]

PEAR_Dependency2 &getPEARDependency2(
PEAR_Config
&$c, array
$o, array
$p, [int
$s = PEAR_VALIDATE_INSTALLING])

To make unit-testing easier

Access: protected

Parameters:

PEAR_Config	`&$c`	—
array	`$o`	—	options
array	`$p`	—	package name as returned from PEAR_Registry::parsePackageName()
int	`$s`	—	PEAR_VALIDATE_* constant

[ Top ]

getPEARDownloader [line 147]

PEAR_Downloader &getPEARDownloader(
PEAR_Frontend_*
&$i, array
$o, PEAR_Config
&$c)

To make unit-testing easier

Access: protected

Parameters:

PEAR_Frontend_*	`&$i`	—
array	`$o`	—	options
PEAR_Config	`&$c`	—

[ Top ]

getProvidesExtension [line 260]

string|false getProvidesExtension(
)

Return: Extension name

[ Top ]

getReleases [line 1723]

array|false getReleases(
)

[ Top ]

getRequestedGroup [line 500]

void getRequestedGroup(
)

[ Top ]

getRW [line 1814]

void &getRW(
)

[ Top ]

getSourcePackage [line 1759]

array|false getSourcePackage(
)

[ Top ]

getStability [line 1070]

void getStability(
)

[ Top ]

getState [line 1078]

void getState(
[
$key = 'release'])

Parameters:

$key —

[ Top ]

getSummary [line 899]

void getSummary(
)

[ Top ]

getTask [line 1896]

boolean getTask(
string
$task)

Determine whether a task name is a valid task. Custom tasks may be defined using subdirectories by putting a "-" in the name, as in <tasks:mycustom-task>

Note that this method will auto-load the task class file and test for the existence of the name with "-" replaced by "_" as in PEAR/Task/mycustom/task.php makes class PEAR_Task_mycustom_task

Parameters:

string $task —

[ Top ]

getTasksNs [line 1871]

void getTasksNs(
)

[ Top ]

getTime [line 1051]

void getTime(
)

[ Top ]

getUri [line 883]

void getUri(
)

[ Top ]

getUsesrole [line 1121]

array|false getUsesrole(
)

Return the <usesrole> tag contents, if any

[ Top ]

getUsestask [line 1133]

array|false getUsestask(
)

Return the <usestask> tag contents, if any

[ Top ]

getValidationWarnings [line 758]

array getValidationWarnings(
[boolean
$purge = true])

Wrapper to PEAR_ErrorStack::getErrors()

Parameters:

boolean $purge — determines whether to purge the error stack after retrieving

[ Top ]

getVersion [line 1062]

void getVersion(
[package|api
$key = 'release'])

Parameters:

package|api $key — version category to return

[ Top ]

hasDeps [line 1746]

void hasDeps(
)

[ Top ]

initPostinstallScripts [line 581]

bool initPostinstallScripts(
)

Initialize post-install scripts for running

This method can be used to detect post-install scripts, as the return value indicates whether any exist

[ Top ]

installBinary [line 183]

array|false installBinary(
PEAR_Installer
&$installer)

Installation of source package has failed, attempt to download and install the binary version of this package.

Parameters:

PEAR_Installer &$installer —

[ Top ]

installedFile [line 1319]

void installedFile(

$file, 
$atts)

This is only used at install-time, after all serialization is over.

Overridden in child classes as:

PEAR_PackageFile_v2_rw::installedFile(): This is only used at install-time, after all serialization is over.

Parameters:

	`$file`	—
	`$atts`	—

[ Top ]

isCompatible [line 1408]

boolean isCompatible(
PEAR_PackageFile_v2|PEAR_PackageFile_v1|PEAR_Downloader_Package
$pf)

Determines whether this package claims it is compatible with the version of

the package that has a recommended version dependency

Parameters:

PEAR_PackageFile_v2|PEAR_PackageFile_v1|PEAR_Downloader_Package $pf —

[ Top ]

isEquivalent [line 288]

bool isEquivalent(
PEAR_PackageFile_v1
$pf1)

Tests whether every part of the package.xml 1.0 is represented in

this package.xml 2.0

Parameters:

PEAR_PackageFile_v1 $pf1 —

[ Top ]

isExtension [line 274]

bool isExtension(
string
$extension)

Parameters:

string $extension — Extension name

[ Top ]

isIncomplete [line 789]

void isIncomplete(
)

[ Top ]

isSubpackage [line 1480]

bool isSubpackage(
PEAR_PackageFile_v1|PEAR_PackageFile_v2
$p)

Determines whether the passed in package is a subpackage of this package.

No version checking is done, only name verification.

Parameters:

PEAR_PackageFile_v1|PEAR_PackageFile_v2 $p —

[ Top ]

isSubpackageOf [line 1468]

void isSubpackageOf(

$p)

Parameters:

$p —

[ Top ]

listPostinstallScripts [line 534]

array|false listPostinstallScripts(
)

Determines whether this package.xml has post-install scripts or not

[ Top ]

packageInfo [line 832]

void packageInfo(

$field)

Parameters:

$field —

[ Top ]

resetDirtree [line 1397]

void resetDirtree(
)

[ Top ]

resetFilelist [line 1200]

void resetFilelist(
)

This is only used at install-time, after all serialization is over.

[ Top ]

runPostinstallScripts [line 628]

void runPostinstallScripts(
)

[ Top ]

setConfig [line 725]

void setConfig(

&$config)

Parameters:

&$config —

[ Top ]

setDate [line 1013]

void setDate(

$date)

Parameters:

$date —

[ Top ]

setDeps [line 742]

void setDeps(

$deps)

WARNING - do not use this function directly unless you know what you're doing

Parameters:

$deps —

[ Top ]

setDirtree [line 1384]

void setDirtree(

$path)

Parameters:

$path —

[ Top ]

setFileAttribute [line 1348]

bool setFileAttribute(
string
$filename, string
$attr, string
$value, [int
$index = false])

Return: success of operation

Parameters:

string	`$filename`	—	full path to file
string	`$attr`	—	attribute name
string	`$value`	—	attribute value
int	`$index`	—	risky but fast - use this to choose a file based on its position in the list of files. Index is zero-based like PHP arrays.

[ Top ]

setInstalledAs [line 1299]

void setInstalledAs(
string
$file, string
$path)

This is only used at install-time, after all serialization is over.

Overridden in child classes as:

PEAR_PackageFile_v2_rw::setInstalledAs(): This is only used at install-time, after all serialization is over.

Parameters:

string	`$file`	—	file name
string	`$path`	—	installed path

[ Top ]

setLastInstalledVersion [line 514]

void setLastInstalledVersion(
string
$version)

For saving in the registry.

Set the last version that was installed

Parameters:

string $version —

[ Top ]

setLogger [line 731]

void setLogger(

&$logger)

Parameters:

&$logger —

[ Top ]

setPackagefile [line 747]

void setPackagefile(

$file, [
$archive = false])

Parameters:

	`$file`	—
	`$archive`	—

[ Top ]

setRawChannel [line 490]

void setRawChannel(

$channel)

WARNING - do not use this function unless you know what you're doing

Parameters:

$channel —

[ Top ]

setRawCompatible [line 474]

void setRawCompatible(

$compatible)

WARNING - do not use this function unless you know what you're doing

Parameters:

$compatible —

[ Top ]

setRawPackage [line 482]

void setRawPackage(

$package)

WARNING - do not use this function unless you know what you're doing

Parameters:

$package —

[ Top ]

setRawState [line 466]

void setRawState(

$state)

array _getFlattenedFilelist(
array
&$files, array
$dir, [string|false
$baseinstall = false], [string
$path = ''])

Access: protected

Parameters:

array	`&$files`	—	the final flattened file list
array	`$dir`	—	the current directory being processed
string\|false	`$baseinstall`	—	any recursively inherited baeinstalldir attribute
string	`$path`	—	private recursion variable

[ Top ]

Class: PEAR_PackageFile_v2

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$_config =

$_logger =

$_registry =

$_stack =

Method Detail

PEAR_PackageFile_v2 (Constructor) [line 133]

analyzeSourceCode [line 1843]

Parameters:

dependsOn [line 1527]

Parameters:

flattenFilelist [line 643]

fromArray [line 781]

Parameters:

getArchiveFile [line 768]

getArray [line 805]

Parameters:

getBundledPackages [line 1768]

getChangelog [line 1738]

getChannel [line 872]

getCompatible [line 1452]

getConfigureOptions [line 1175]

getContents [line 1332]

getContributors [line 997]

getDate [line 1043]

getDefaultGenerator [line 1834]

getDependencies [line 1460]

getDependencyGroup [line 1575]

Parameters:

getDeps [line 1604]

Parameters:

getDescription [line 907]

getDevelopers [line 989]

getDirtree [line 1389]

getExtends [line 891]

getFileContents [line 1789]

Parameters:

getFilelist [line 1144]

Parameters:

getHelpers [line 1005]

getInstallationFilelist [line 1209]

Parameters:

getInstalledBinary [line 171]

getInstalledLocation [line 1307]

Parameters:

getLastInstalledVersion [line 522]

getLastModified [line 1776]

getLeads [line 981]

getLicense [line 1086]

Parameters:

getLicenseLocation [line 1101]

getMaintainers [line 915]

Parameters:

getName [line 859]

getNotes [line 1109]

getPackage [line 864]

getPackageFile [line 763]

getPackageType [line 1703]

getPackagexmlVersion [line 1751]

getPEARDependency2 [line 162]

Parameters:

getPEARDownloader [line 147]

Parameters:

getProvidesExtension [line 260]

getReleases [line 1723]

getRequestedGroup [line 500]

getRW [line 1814]

getSourcePackage [line 1759]

getStability [line 1070]