Docs For Class PEAR_PackageFile

PEAR_PackageFile_v2 (Constructor) [line 138]

PEAR_PackageFile_v2 PEAR_PackageFile_v2(
)

The constructor merely sets up the private error stack

[ Top ]

analyzeSourceCode [line 1882]

void analyzeSourceCode(

$file, [
$string = false])

Parameters:

	`$file`	—
	`$string`	—

[ Top ]

dependsOn [line 1542]

void dependsOn(

$package, 
$channel)

Parameters:

	`$package`	—
	`$channel`	—

[ Top ]

flattenFilelist [line 655]

void flattenFilelist(
)

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

[ Top ]

fromArray [line 793]

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

void getArchiveFile(
)

[ Top ]

getArray [line 817]

void getArray(
[
$forReg = false])

Parameters:

$forReg —

[ Top ]

getBundledPackages [line 1807]

void getBundledPackages(
)

[ Top ]

getChangelog [line 1770]

array getChangelog(
)

[ Top ]

getChannel [line 884]

void getChannel(
)

[ Top ]

getCompatible [line 1467]

array|false getCompatible(
)

[ Top ]

getConfigureOptions [line 1187]

array|false getConfigureOptions(
)

Return configure options array, if any

[ Top ]

getContents [line 1344]

void getContents(
)

Retrieve the contents tag

[ Top ]

getContributors [line 1009]

void getContributors(
)

[ Top ]

getDate [line 1055]

void getDate(
)

[ Top ]

getDefaultGenerator [line 1873]

void &getDefaultGenerator(
)

[ Top ]

getDependencies [line 1475]

void getDependencies(
)

[ Top ]

getDependencyGroup [line 1590]

array|false getDependencyGroup(
string
$name)

Get the contents of a dependency group

Parameters:

string $name —

[ Top ]

getDeps [line 1619]

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

void getDescription(
)

[ Top ]

getDevelopers [line 1001]

void getDevelopers(
)

[ Top ]

getDirtree [line 1404]

void getDirtree(
)

[ Top ]

getExtends [line 903]

void getExtends(
)

[ Top ]

getFileContents [line 1828]

string getFileContents(
string
$file)

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

Parameters:

string $file —

[ Top ]

getFilelist [line 1156]

void getFilelist(
[
$preserve = false])

This should only be used to retrieve filenames and install attributes

Parameters:

$preserve —

[ Top ]

getHelpers [line 1017]

void getHelpers(
)

[ Top ]

getInstallationFilelist [line 1221]

array getInstallationFilelist(
[
$forfilecheck = false])

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

Parameters:

$forfilecheck —

[ Top ]

getInstalledBinary [line 176]

void getInstalledBinary(
)

[ Top ]

getInstalledLocation [line 1319]

void getInstalledLocation(

$file)

Parameters:

$file —

[ Top ]

getLastInstalledVersion [line 530]

string|false getLastInstalledVersion(
)

[ Top ]

getLastModified [line 1815]

void getLastModified(
)

[ Top ]

getLeads [line 993]

void getLeads(
)

[ Top ]

getLicense [line 1098]

void getLicense(
[
$raw = false])

Parameters:

$raw —

[ Top ]

getLicenseLocation [line 1113]

void getLicenseLocation(
)

[ Top ]

getMaintainers [line 927]

void getMaintainers(
[
$raw = false])

Parameters:

$raw —

[ Top ]

getName [line 871]

void getName(
)

[ Top ]

getNotes [line 1121]

void getNotes(
)

[ Top ]

getPackage [line 876]

void getPackage(
)

[ Top ]

getPackageFile [line 775]

void getPackageFile(
)

[ Top ]

getPackageType [line 1729]

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

[ Top ]

getPackagexmlVersion [line 1783]

void getPackagexmlVersion(
)

[ Top ]

getPEARDependency2 [line 167]

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

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

string|false getProvidesExtension(
)

Return: Extension name

[ Top ]

getReleases [line 1755]

array|false getReleases(
)

[ Top ]

getRequestedGroup [line 508]

void getRequestedGroup(
)

[ Top ]

getRW [line 1853]

void &getRW(
)

[ Top ]

getSourcePackage [line 1797]

array|false getSourcePackage(
)

[ Top ]

getStability [line 1082]

void getStability(
)

[ Top ]

getState [line 1090]

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

Parameters:

$key —

[ Top ]

getSummary [line 911]

void getSummary(
)

[ Top ]

getTask [line 1937]

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

void getTasksNs(
)

[ Top ]

getTime [line 1063]

void getTime(
)

[ Top ]

getUri [line 895]

void getUri(
)

[ Top ]

getUsesrole [line 1133]

array|false getUsesrole(
)

Return the <usesrole> tag contents, if any

[ Top ]

getUsestask [line 1145]

array|false getUsestask(
)

Return the <usestask> tag contents, if any

[ Top ]

getValidationWarnings [line 770]

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

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

Parameters:

package|api $key — version category to return

[ Top ]

hasDeps [line 1778]

void hasDeps(
)

[ Top ]

initPostinstallScripts [line 589]

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

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

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

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

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

bool isExtension(
string
$extension)

Parameters:

string $extension — Extension name

[ Top ]

isIncomplete [line 801]

void isIncomplete(
)

[ Top ]

isSubpackage [line 1495]

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

void isSubpackageOf(

$p)

Parameters:

$p —

[ Top ]

listPostinstallScripts [line 542]

array|false listPostinstallScripts(
)

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

[ Top ]

packageInfo [line 844]

void packageInfo(

$field)

Parameters:

$field —

[ Top ]

resetDirtree [line 1412]

void resetDirtree(
)

[ Top ]

resetFilelist [line 1212]

void resetFilelist(
)

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

[ Top ]

runPostinstallScripts [line 640]

void runPostinstallScripts(
)

[ Top ]

setConfig [line 737]

void setConfig(

&$config)

Parameters:

&$config —

[ Top ]

setDate [line 1025]

void setDate(

$date)

Parameters:

$date —

[ Top ]

setDeps [line 754]

void setDeps(

$deps)

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

Parameters:

$deps —

[ Top ]

setDirtree [line 1396]

void setDirtree(

$path)

Parameters:

$path —

[ Top ]

setFileAttribute [line 1360]

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

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

void setLastInstalledVersion(
string
$version)

For saving in the registry.

Set the last version that was installed

Parameters:

string $version —

[ Top ]

setLogger [line 743]

void setLogger(

&$logger)

Parameters:

&$logger —

[ Top ]

setPackagefile [line 759]

void setPackagefile(

$file, [
$archive = false])

Parameters:

	`$file`	—
	`$archive`	—

[ Top ]

setRawChannel [line 498]

void setRawChannel(

$channel)

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

Parameters:

$channel —

[ Top ]

setRawCompatible [line 482]

void setRawCompatible(

$compatible)

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

Parameters:

$compatible —

[ Top ]

setRawPackage [line 490]

void setRawPackage(

$package)

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

Parameters:

$package —

[ Top ]

setRawState [line 474]

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

analyzeSourceCode [line 1882]

Parameters:

dependsOn [line 1542]

Parameters:

flattenFilelist [line 655]

fromArray [line 793]

Parameters:

getArchiveFile [line 780]

getArray [line 817]

Parameters:

getBundledPackages [line 1807]

getChangelog [line 1770]

getChannel [line 884]

getCompatible [line 1467]

getConfigureOptions [line 1187]

getContents [line 1344]

getContributors [line 1009]

getDate [line 1055]

getDefaultGenerator [line 1873]

getDependencies [line 1475]

getDependencyGroup [line 1590]

Parameters:

getDeps [line 1619]

Parameters:

getDescription [line 919]

getDevelopers [line 1001]

getDirtree [line 1404]

getExtends [line 903]

getFileContents [line 1828]

Parameters:

getFilelist [line 1156]

Parameters:

getHelpers [line 1017]

getInstallationFilelist [line 1221]

Parameters:

getInstalledBinary [line 176]

getInstalledLocation [line 1319]

Parameters:

getLastInstalledVersion [line 530]

getLastModified [line 1815]

getLeads [line 993]

getLicense [line 1098]

Parameters:

getLicenseLocation [line 1113]

getMaintainers [line 927]

Parameters:

getName [line 871]

getNotes [line 1121]

getPackage [line 876]

getPackageFile [line 775]

getPackageType [line 1729]

getPackagexmlVersion [line 1783]

getPEARDependency2 [line 167]

Parameters:

getPEARDownloader [line 152]

Parameters:

getProvidesExtension [line 266]

getReleases [line 1755]

getRequestedGroup [line 508]

getRW [line 1853]

getSourcePackage [line 1797]

getStability [line 1082]