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

void analyzeSourceCode(

$file, [
$string = false])

Parameters:

	`$file`	—
	`$string`	—

[ Top ]

dependsOn [line 1516]

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

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

void getArchiveFile(
)

[ Top ]

getArray [line 800]

void getArray(
[
$forReg = false])

Parameters:

$forReg —

[ Top ]

getBundledPackages [line 1757]

void getBundledPackages(
)

[ Top ]

getChangelog [line 1727]

array getChangelog(
)

[ Top ]

getChannel [line 861]

void getChannel(
)

[ Top ]

getCompatible [line 1441]

array|false getCompatible(
)

[ Top ]

getConfigureOptions [line 1164]

array|false getConfigureOptions(
)

Return configure options array, if any

[ Top ]

getContents [line 1321]

void getContents(
)

Retrieve the contents tag

[ Top ]

getContributors [line 986]

void getContributors(
)

[ Top ]

getDate [line 1032]

void getDate(
)

[ Top ]

getDefaultGenerator [line 1823]

void &getDefaultGenerator(
)

[ Top ]

getDependencies [line 1449]

void getDependencies(
)

[ Top ]

getDependencyGroup [line 1564]

array|false getDependencyGroup(
string
$name)

Get the contents of a dependency group

Parameters:

string $name —

[ Top ]

getDeps [line 1593]

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

void getDescription(
)

[ Top ]

getDevelopers [line 978]

void getDevelopers(
)

[ Top ]

getDirtree [line 1378]

void getDirtree(
)

[ Top ]

getExtends [line 880]

void getExtends(
)

[ Top ]

getFileContents [line 1778]

string getFileContents(
string
$file)

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

Parameters:

string $file —

[ Top ]

getFilelist [line 1133]

void getFilelist(
[
$preserve = false])

This should only be used to retrieve filenames and install attributes

Parameters:

$preserve —

[ Top ]

getHelpers [line 994]

void getHelpers(
)

[ Top ]

getInstallationFilelist [line 1198]

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

void getInstalledLocation(

$file)

Parameters:

$file —

[ Top ]

getLastInstalledVersion [line 522]

string|false getLastInstalledVersion(
)

[ Top ]

getLastModified [line 1765]

void getLastModified(
)

[ Top ]

getLeads [line 970]

void getLeads(
)

[ Top ]

getLicense [line 1075]

void getLicense(
[
$raw = false])

Parameters:

$raw —

[ Top ]

getLicenseLocation [line 1090]

void getLicenseLocation(
)

[ Top ]

getMaintainers [line 904]

void getMaintainers(
[
$raw = false])

Parameters:

$raw —

[ Top ]

getName [line 848]

void getName(
)

[ Top ]

getNotes [line 1098]

void getNotes(
)

[ Top ]

getPackage [line 853]

void getPackage(
)

[ Top ]

getPackageFile [line 758]

void getPackageFile(
)

[ Top ]

getPackageType [line 1692]

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

[ Top ]

getPackagexmlVersion [line 1740]

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

array|false getReleases(
)

[ Top ]

getRequestedGroup [line 500]

void getRequestedGroup(
)

[ Top ]

getRW [line 1803]

void &getRW(
)

[ Top ]

getSourcePackage [line 1748]

array|false getSourcePackage(
)

[ Top ]

getStability [line 1059]

void getStability(
)

[ Top ]

getState [line 1067]

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

Parameters:

$key —

[ Top ]

getSummary [line 888]

void getSummary(
)

[ Top ]

getTask [line 1885]

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

void getTasksNs(
)

[ Top ]

getTime [line 1040]

void getTime(
)

[ Top ]

getUri [line 872]

void getUri(
)

[ Top ]

getUsesrole [line 1110]

array|false getUsesrole(
)

Return the <usesrole> tag contents, if any

[ Top ]

getUsestask [line 1122]

array|false getUsestask(
)

Return the <usestask> tag contents, if any

[ Top ]

getValidationWarnings [line 753]

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

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

Parameters:

package|api $key — version category to return

[ Top ]

hasDeps [line 1735]

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

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

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

void isIncomplete(
)

[ Top ]

isSubpackage [line 1469]

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

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

void packageInfo(

$field)

Parameters:

$field —

[ Top ]

resetDirtree [line 1386]

void resetDirtree(
)

[ Top ]

resetFilelist [line 1189]

void resetFilelist(
)

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

[ Top ]

runPostinstallScripts [line 628]

void runPostinstallScripts(
)

[ Top ]

setConfig [line 720]

void setConfig(

&$config)

Parameters:

&$config —

[ Top ]

setDate [line 1002]

void setDate(

$date)

Parameters:

$date —

[ Top ]

setDeps [line 737]

void setDeps(

$deps)

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

Parameters:

$deps —

[ Top ]

setDirtree [line 1373]

void setDirtree(

$path)

Parameters:

$path —

[ Top ]

setFileAttribute [line 1337]

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

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

void setLogger(

&$logger)

Parameters:

&$logger —

[ Top ]

setPackagefile [line 742]

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

Parameters:

dependsOn [line 1516]

Parameters:

flattenFilelist [line 643]

fromArray [line 776]

Parameters:

getArchiveFile [line 763]

getArray [line 800]

Parameters:

getBundledPackages [line 1757]

getChangelog [line 1727]

getChannel [line 861]

getCompatible [line 1441]

getConfigureOptions [line 1164]

getContents [line 1321]

getContributors [line 986]

getDate [line 1032]

getDefaultGenerator [line 1823]

getDependencies [line 1449]

getDependencyGroup [line 1564]

Parameters:

getDeps [line 1593]

Parameters:

getDescription [line 896]

getDevelopers [line 978]

getDirtree [line 1378]

getExtends [line 880]

getFileContents [line 1778]

Parameters:

getFilelist [line 1133]

Parameters:

getHelpers [line 994]

getInstallationFilelist [line 1198]

Parameters:

getInstalledBinary [line 171]

getInstalledLocation [line 1296]

Parameters:

getLastInstalledVersion [line 522]

getLastModified [line 1765]

getLeads [line 970]

getLicense [line 1075]

Parameters:

getLicenseLocation [line 1090]

getMaintainers [line 904]

Parameters:

getName [line 848]

getNotes [line 1098]

getPackage [line 853]

getPackageFile [line 758]

getPackageType [line 1692]

getPackagexmlVersion [line 1740]

getPEARDependency2 [line 162]

Parameters:

getPEARDownloader [line 147]

Parameters:

getProvidesExtension [line 260]

getReleases [line 1712]

getRequestedGroup [line 500]

getRW [line 1803]

getSourcePackage [line 1748]

getStability [line 1059]