Docs For Class PEAR_PackageFile

PEAR_PackageFile_v2 (Constructor) [line 141]

PEAR_PackageFile_v2 PEAR_PackageFile_v2(
)

PHP 4 style constructor for backwards compatibility.

Used by PEAR_PackageFileManager2

Access: public

[ Top ]

__construct (Constructor) [line 131]

PEAR_PackageFile_v2 __construct(
)

The constructor merely sets up the private error stack

[ Top ]

analyzeSourceCode [line 1910]

void analyzeSourceCode(

$file, [
$string = false])

Parameters:

	`$file`	—
	`$string`	—

[ Top ]

dependsOn [line 1569]

void dependsOn(

$package, 
$channel)

Parameters:

	`$package`	—
	`$channel`	—

[ Top ]

flattenFilelist [line 659]

void flattenFilelist(
)

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

[ Top ]

fromArray [line 805]

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

void getArchiveFile(
)

[ Top ]

getArray [line 833]

void getArray(
[
$forReg = false])

Parameters:

$forReg —

[ Top ]

getBundledPackages [line 1835]

void getBundledPackages(
)

[ Top ]

getChangelog [line 1798]

array getChangelog(
)

[ Top ]

getChannel [line 900]

void getChannel(
)

[ Top ]

getCompatible [line 1494]

array|false getCompatible(
)

[ Top ]

getConfigureOptions [line 1209]

array|false getConfigureOptions(
)

Return configure options array, if any

[ Top ]

getContents [line 1371]

void getContents(
)

Retrieve the contents tag

[ Top ]

getContributors [line 1025]

void getContributors(
)

[ Top ]

getDate [line 1071]

void getDate(
)

[ Top ]

getDefaultGenerator [line 1901]

void &getDefaultGenerator(
)

[ Top ]

getDependencies [line 1502]

void getDependencies(
)

[ Top ]

getDependencyGroup [line 1617]

array|false getDependencyGroup(
string
$name)

Get the contents of a dependency group

Parameters:

string $name —

[ Top ]

getDeps [line 1646]

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

void getDescription(
)

[ Top ]

getDevelopers [line 1017]

void getDevelopers(
)

[ Top ]

getDirtree [line 1431]

void getDirtree(
)

[ Top ]

getExtends [line 919]

void getExtends(
)

[ Top ]

getFileContents [line 1856]

string getFileContents(
string
$file)

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

Parameters:

string $file —

[ Top ]

getFilelist [line 1172]

void getFilelist(
[
$preserve = false])

This should only be used to retrieve filenames and install attributes

Parameters:

$preserve —

[ Top ]

getHelpers [line 1033]

void getHelpers(
)

[ Top ]

getInstallationFilelist [line 1248]

array getInstallationFilelist(
[
$forfilecheck = false])

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

Parameters:

$forfilecheck —

[ Top ]

getInstalledBinary [line 178]

void getInstalledBinary(
)

[ Top ]

getInstalledLocation [line 1346]

void getInstalledLocation(

$file)

Parameters:

$file —

[ Top ]

getLastInstalledVersion [line 535]

string|false getLastInstalledVersion(
)

[ Top ]

getLastModified [line 1843]

void getLastModified(
)

[ Top ]

getLeads [line 1009]

void getLeads(
)

[ Top ]

getLicense [line 1114]

void getLicense(
[
$raw = false])

Parameters:

$raw —

[ Top ]

getLicenseLocation [line 1129]

void getLicenseLocation(
)

[ Top ]

getMaintainers [line 943]

void getMaintainers(
[
$raw = false])

Parameters:

$raw —

[ Top ]

getName [line 887]

void getName(
)

[ Top ]

getNotes [line 1137]

void getNotes(
)

[ Top ]

getPackage [line 892]

void getPackage(
)

[ Top ]

getPackageFile [line 787]

void getPackageFile(
)

[ Top ]

getPackageType [line 1757]

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

[ Top ]

getPackagexmlVersion [line 1811]

void getPackagexmlVersion(
)

[ Top ]

getPEARDependency2 [line 169]

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

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

string|false getProvidesExtension(
)

Return: Extension name

[ Top ]

getReleases [line 1783]

array|false getReleases(
)

[ Top ]

getRequestedGroup [line 513]

void getRequestedGroup(
)

[ Top ]

getRW [line 1881]

void &getRW(
)

[ Top ]

getSourcePackage [line 1825]

array|false getSourcePackage(
)

[ Top ]

getStability [line 1098]

void getStability(
)

[ Top ]

getState [line 1106]

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

Parameters:

$key —

[ Top ]

getSummary [line 927]

void getSummary(
)

[ Top ]

getTask [line 1965]

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

void getTasksNs(
)

[ Top ]

getTime [line 1079]

void getTime(
)

[ Top ]

getUri [line 911]

void getUri(
)

[ Top ]

getUsesrole [line 1149]

array|false getUsesrole(
)

Return the <usesrole> tag contents, if any

[ Top ]

getUsestask [line 1161]

array|false getUsestask(
)

Return the <usestask> tag contents, if any

[ Top ]

getValidationWarnings [line 782]

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

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

Parameters:

package|api $key — version category to return

[ Top ]

hasDeps [line 1806]

void hasDeps(
)

[ Top ]

initPostinstallScripts [line 594]

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

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

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

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

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

bool isExtension(
string
$extension)

Parameters:

string $extension — Extension name

[ Top ]

isIncomplete [line 817]

void isIncomplete(
)

[ Top ]

isSubpackage [line 1522]

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

void isSubpackageOf(

$p)

Parameters:

$p —

[ Top ]

listPostinstallScripts [line 547]

array|false listPostinstallScripts(
)

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

[ Top ]

packageInfo [line 860]

void packageInfo(

$field)

Parameters:

$field —

[ Top ]

resetDirtree [line 1439]

void resetDirtree(
)

[ Top ]

resetFilelist [line 1239]

void resetFilelist(
)

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

[ Top ]

runPostinstallScripts [line 644]

void runPostinstallScripts(
)

[ Top ]

setCompatible [line 766]

void setCompatible(

$compat)

void setDeps(

$deps)

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

Parameters:

$deps —

[ Top ]

setDirtree [line 1423]

void setDirtree(

$path)

Parameters:

$path —

[ Top ]

setFileAttribute [line 1387]

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

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

void setLastInstalledVersion(
string
$version)

For saving in the registry.

Set the last version that was installed

Parameters:

string $version —

[ Top ]

setLogger [line 747]

void setLogger(

&$logger)

Parameters:

&$logger —

[ Top ]

setPackagefile [line 771]

void setPackagefile(

$file, [
$archive = false])

Parameters:

	`$file`	—
	`$archive`	—

[ Top ]

setRawChannel [line 503]

void setRawChannel(

$channel)

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

Parameters:

$channel —

[ Top ]

setRawCompatible [line 487]

void setRawCompatible(

$compatible)

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

Parameters:

$compatible —

[ Top ]

setRawPackage [line 495]

void setRawPackage(

$package)

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

Parameters:

$package —

[ Top ]

setRawState [line 476]

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

__construct (Constructor) [line 131]

analyzeSourceCode [line 1910]

Parameters:

dependsOn [line 1569]

Parameters:

flattenFilelist [line 659]

fromArray [line 805]

Parameters:

getArchiveFile [line 792]

getArray [line 833]

Parameters:

getBundledPackages [line 1835]

getChangelog [line 1798]

getChannel [line 900]

getCompatible [line 1494]

getConfigureOptions [line 1209]

getContents [line 1371]

getContributors [line 1025]

getDate [line 1071]

getDefaultGenerator [line 1901]

getDependencies [line 1502]

getDependencyGroup [line 1617]

Parameters:

getDeps [line 1646]

Parameters:

getDescription [line 935]

getDevelopers [line 1017]

getDirtree [line 1431]

getExtends [line 919]

getFileContents [line 1856]

Parameters:

getFilelist [line 1172]

Parameters:

getHelpers [line 1033]

getInstallationFilelist [line 1248]

Parameters:

getInstalledBinary [line 178]

getInstalledLocation [line 1346]

Parameters:

getLastInstalledVersion [line 535]

getLastModified [line 1843]

getLeads [line 1009]

getLicense [line 1114]

Parameters:

getLicenseLocation [line 1129]

getMaintainers [line 943]

Parameters:

getName [line 887]

getNotes [line 1137]

getPackage [line 892]

getPackageFile [line 787]

getPackageType [line 1757]

getPackagexmlVersion [line 1811]

getPEARDependency2 [line 169]

Parameters:

getPEARDownloader [line 154]

Parameters:

getProvidesExtension [line 268]

getReleases [line 1783]

getRequestedGroup [line 513]

getRW [line 1881]

getSourcePackage [line 1825]