Docs For Class PEAR_PackageFile_v2

addArchDep [line 1157]

void addArchDep(
string
$pattern, [boolean
$conflicts = false])

Parameters:

string	`$pattern`	—	Architecture matching pattern
boolean	`$conflicts`	—	true if this package cannot be installed on this architecture

[ Top ]

addBinarypackage [line 1293]

void addBinarypackage(
string
$package)

Add an extension binary package for this extension source code release

Note that the package must be from the same channel as the extension source package

Parameters:

string $package —

[ Top ]

addBundledPackage [line 446]

void addBundledPackage(
string
$path)

Parameters:

string $path — relative path of the bundled package.

[ Top ]

addCompatiblePackage [line 571]

void addCompatiblePackage(
string
$name, string
$channel, string
$min, string
$max, [string
$exclude = false])

Parameters:

string	`$name`	—	Dependent package name
string	`$channel`	—	Dependent package's channel name
string	`$min`	—	minimum version of specified package that this release is guaranteed to be compatible with
string	`$max`	—	maximum version of specified package that this release is guaranteed to be compatible with
string	`$exclude`	—	versions of specified package that this release is not compatible with

[ Top ]

addConfigureOption [line 1315]

void addConfigureOption(
string
$name, string
$prompt, [string
$default = null])

Add a configureoption to an extension source package

Parameters:

string	`$name`	—
string	`$prompt`	—
string	`$default`	—

[ Top ]

addConflictingPackageDepWithChannel [line 760]

void addConflictingPackageDepWithChannel(
string
$name, string
$channel, [string
$providesextension = false])

Mark a package as conflicting with this package

Parameters:

string	`$name`	—	package name
string	`$channel`	—	package channel
string	`$providesextension`	—	extension this package provides, if any

[ Top ]

addConflictingPackageDepWithUri [line 788]

void addConflictingPackageDepWithUri(
string
$name, string
$uri, [string
$providesextension = false])

Mark a package as conflicting with this package

Parameters:

string	`$name`	—	package name
string	`$uri`	—	package channel
string	`$providesextension`	—	extension this package provides, if any

[ Top ]

addDependencyGroup [line 810]

void addDependencyGroup(

$name, 
$hint)

Parameters:

	`$name`	—
	`$hint`	—

[ Top ]

addExtensionDep [line 1113]

void addExtensionDep(
optional|required
$type, string
$name, [string
$min = false], [string
$max = false], [string
$recommended = false], [array
$exclude = false])

Parameters:

optional\|required	`$type`	—	optional, required
string	`$name`	—	extension name
string	`$min`	—	minimum version
string	`$max`	—	maximum version
string	`$recommended`	—	recommended version
array	`$exclude`	—	incompatible versions

[ Top ]

addExtensionInstallCondition [line 1373]

void addExtensionInstallCondition(
optional|required
$name, [string
$min = false], [string
$max = false], [string
$recommended = false], [string
$exclude = false], array
5)

Parameters:

array	`5`	—	incompatible versions
optional\|required	`$name`	—	optional, required
string	`$min`	—	extension name
string	`$max`	—	minimum version
string	`$recommended`	—	maximum version
string	`$exclude`	—	recommended version

[ Top ]

addFile [line 530]

void addFile(
string
$dir, string
$file, array
$attrs)

Parameters:

string	`$dir`	—	path to the file
string	`$file`	—	filename
array	`$attrs`	—	extra attributes

[ Top ]

addGroupExtensionDep [line 931]

void addGroupExtensionDep(
string
$groupname, string
$name, [string
$min = false], [string
$max = false], [string
$recommended = false], [array
$exclude = false])

Parameters:

string	`$groupname`	—	group name (must be pre-existing)
string	`$name`	—	extension name
string	`$min`	—	minimum version allowed
string	`$max`	—	maximum version allowed
string	`$recommended`	—	recommended version
array	`$exclude`	—	incompatible versions

[ Top ]

addGroupPackageDepWithChannel [line 889]

bool addGroupPackageDepWithChannel(
package|subpackage
$type, string
$groupname, string
$name, string
$channel, [string
$min = false], [string
$max = false], [string
$recommended = false], [array|false
$exclude = false], [string
$providesextension = false], [bool
$nodefault = false])

Return: false if the dependency group has not been initialized with addDependencyGroup(), or a subpackage is added with a providesextension

Parameters:

package\|subpackage	`$type`	—
string	`$groupname`	—	group name
string	`$name`	—	package name
string	`$channel`	—	package channel
string	`$min`	—	minimum version
string	`$max`	—	maximum version
string	`$recommended`	—	recommended version
array\|false	`$exclude`	—	optional excluded versions
string	`$providesextension`	—	extension this package provides, if any
bool	`$nodefault`	—	if true, tells the installer to ignore the default optional dependency group when installing this package

[ Top ]

addGroupPackageDepWithURI [line 912]

bool addGroupPackageDepWithURI(
package|subpackage
$type, string
$groupname, string
$name, string
$uri, [string
$providesextension = false], [bool
$nodefault = false])

Return: false if the dependency group has not been initialized with addDependencyGroup()

Parameters:

package\|subpackage	`$type`	—
string	`$groupname`	—	group name
string	`$name`	—	package name
string	`$uri`	—	package uri
string	`$providesextension`	—	extension this package provides, if any
bool	`$nodefault`	—	if true, tells the installer to ignore the default optional dependency group when installing this package

[ Top ]

addIgnore [line 1273]

bool addIgnore(
string
$path)

Add a file to the current release that should be ignored

Return: success of operation

Parameters:

string $path — <contents> path to file

[ Top ]

addInstallAs [line 1254]

void addInstallAs(
string
$path, string
$as)

Add a file to the current release that should be installed under a different name

Parameters:

string	`$path`	—	<contents> path to file
string	`$as`	—	name the file should be installed as

[ Top ]

addMaintainer [line 166]

void addMaintainer(

$role, 
$handle, 
$name, 
$email, [
$active = 'yes'])

Adds a new maintainer - no checking of duplicates is performed, use updatemaintainer for that purpose.

Parameters:

	`$role`	—
	`$handle`	—
	`$name`	—
	`$email`	—
	`$active`	—

[ Top ]

addOsDep [line 1136]

void addOsDep(
string
$name, [boolean
$conflicts = false])

Parameters:

string	`$name`	—	Operating system name
boolean	`$conflicts`	—	true if this package cannot be installed on this OS

[ Top ]

addPackageDepWithChannel [line 999]

void addPackageDepWithChannel(
optional|required
$type, string
$name, string
$channel, [string
$min = false], [string
$max = false], [string
$recommended = false], [string
$exclude = false], [bool
$providesextension = false], [array|false
$nodefault = false])

Parameters:

optional\|required	`$type`	—
string	`$name`	—	package name
string	`$channel`	—	package channel
string	`$min`	—	minimum version
string	`$max`	—	maximum version
string	`$recommended`	—	recommended version
string	`$exclude`	—	extension this package provides, if any
bool	`$providesextension`	—	if true, tells the installer to ignore the default optional dependency group when installing this package
array\|false	`$nodefault`	—	optional excluded versions

[ Top ]

addPackageDepWithUri [line 1028]

void addPackageDepWithUri(
optional|required
$type, string
$name, string
$uri, [string
$providesextension = false], [bool
$nodefault = false])

Parameters:

optional\|required	`$type`	—
string	`$name`	—	name of the package
string	`$uri`	—	uri of the package
string	`$providesextension`	—	extension this package provides, if any
bool	`$nodefault`	—	if true, tells the installer to ignore the default optional dependency group when installing this package

[ Top ]

addRelease [line 1208]

bool addRelease(
)

Return: true if package type is set up

[ Top ]

addSubpackageDepWithChannel [line 1059]

void addSubpackageDepWithChannel(
optional|required
$type, string
$name, string
$channel, [string
$min = false], [string
$max = false], [string
$recommended = false], [array
$exclude = false], [bool
$nodefault = false])

Parameters:

optional\|required	`$type`	—	optional, required
string	`$name`	—	package name
string	`$channel`	—	package channel
string	`$min`	—	minimum version
string	`$max`	—	maximum version
string	`$recommended`	—	recommended version
array	`$exclude`	—	incompatible versions
bool	`$nodefault`	—	if true, tells the installer to ignore the default optional dependency group when installing this package

[ Top ]

addSubpackageDepWithUri [line 1087]

void addSubpackageDepWithUri(
optional|required
$type, string
$name, string
$uri, [bool
$nodefault = false])

Parameters:

optional\|required	`$type`	—	optional, required
string	`$name`	—	package name
string	`$uri`	—	package uri for download
bool	`$nodefault`	—	if true, tells the installer to ignore the default optional dependency group when installing this package

[ Top ]

addTaskToFile [line 464]

void addTaskToFile(
string
$filename, PEAR_Task_Common
$task)

Parameters:

string	`$filename`	—	file name
PEAR_Task_Common	`$task`	—	a read/write task

[ Top ]

addUsesrole [line 606]

void addUsesrole(
string
$role, string
$packageOrUri, [string
$channel = false])

Parameters:

string	`$role`	—
string	`$packageOrUri`	—	package name or uri
string	`$channel`	—	channel name if non-uri

[ Top ]

addUsestask [line 637]

void addUsestask(
string
$task, string
$packageOrUri, [string
$channel = false])

Parameters:

string	`$task`	—
string	`$packageOrUri`	—	package name or uri
string	`$channel`	—	channel name if non-uri

[ Top ]

clearChangeLog [line 1527]

void clearChangeLog(
)

Remove the changelog entirely

[ Top ]

clearCompatible [line 655]

void clearCompatible(
)

Remove all compatible tags

[ Top ]

clearContents [line 423]

void clearContents(
[string
$baseinstall = false])

Reset the listing of package contents

Parameters:

string $baseinstall — base installation dir for the whole package, if any

[ Top ]

clearDeps [line 663]

void clearDeps(
)

Reset dependencies prior to adding new ones

[ Top ]

deleteMaintainer [line 247]

void deleteMaintainer(

$handle)

Parameters:

$handle —

[ Top ]

generateChangeLogEntry [line 1464]

void generateChangeLogEntry(
[string|false
$notes = false])

Generate a valid change log entry from the current package.xml

Parameters:

string|false $notes —

[ Top ]

getChangelog [line 1516]

array getChangelog(
)

[ Top ]

installedFile [line 409]

void installedFile(

$file, 
$atts)

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

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

Parameters:

	`$file`	—
	`$atts`	—

[ Top ]

resetUsesrole [line 594]

void resetUsesrole(
)

Removes the <usesrole> tag entirely

[ Top ]

resetUsestask [line 624]

void resetUsestask(
)

Removes the <usestask> tag entirely

[ Top ]

setAPIStability [line 337]

void setAPIStability(
devel|alpha|beta|stable
$state)

Parameters:

devel|alpha|beta|stable $state —

[ Top ]

setAPIVersion [line 301]

void setAPIVersion(

$version)

Parameters:

$version —

[ Top ]

setArchInstallCondition [line 1420]

void setArchInstallCondition(
string
$pattern, [bool
$conflicts = false])

Set an installation condition based on architecture for the current release set

Parameters:

string	`$pattern`	—	architecture pattern
bool	`$conflicts`	—	whether this arch is incompatible with the current release

[ Top ]

setChangelogEntry [line 1484]

void setChangelogEntry(
string
$releaseversion, array
$contents)

Parameters:

string	`$releaseversion`	—	release version to set change log notes for
array	`$contents`	—	output of generateChangeLogEntry()

[ Top ]

setChannel [line 97]

void setChannel(

$channel)

Parameters:

$channel —

[ Top ]

setDescription [line 146]

void setDescription(

$desc)

Parameters:

$desc —

[ Top ]

setExtends [line 114]

void setExtends(

$extends)

Parameters:

$extends —

[ Top ]

setInstalledAs [line 397]

void setInstalledAs(
string
$file, string
$path)

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

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

Parameters:

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

[ Top ]

setLicense [line 352]

void setLicense(

$license, [
$uri = false], [
$filesource = false])

Parameters:

	`$license`	—
	`$uri`	—
	`$filesource`	—

[ Top ]

setNotes [line 377]

void setNotes(

$notes)

Parameters:

$notes —

[ Top ]

setOsInstallCondition [line 1394]

void setOsInstallCondition(
string
$name, [bool
$conflicts = false])

Set an installation condition based on operating system for the current release set

Parameters:

string	`$name`	—	OS name
bool	`$conflicts`	—	whether this OS is incompatible with the current release

[ Top ]

setPackage [line 58]

void setPackage(

$package)

Parameters:

$package —

[ Top ]

setPackageType [line 1184]

bool setPackageType(
php|extbin|extsrc|bundle
$type)

Set the kind of package, and erase all release tags

a php package is a PEAR-style package
an extbin package is a PECL-style extension binary
an extsrc package is a PECL-style source for a binary
a bundle package is a collection of other pre-packaged packages

Return: success

Parameters:

php|extbin|extsrc|bundle $type —

[ Top ]

setPearinstallerDep [line 719]

void setPearinstallerDep(
string
$min, [string
$max = false], [string
$recommended = false], [array
$exclude = false])

Parameters:

string	`$min`	—	minimum allowed PEAR installer version
string	`$max`	—	maximum allowed PEAR installer version
string	`$recommended`	—	recommended PEAR installer version
array	`$exclude`	—	incompatible version of the PEAR installer

[ Top ]

setPhpDep [line 680]

void setPhpDep(
string
$min, [string
$max = false], [array
$exclude = false])

Parameters:

array	`$exclude`	—	incompatible PHP versions
string	`$min`	—	minimum PHP version allowed
string	`$max`	—	maximum PHP version allowed

[ Top ]

setPhpInstallCondition [line 1341]

void setPhpInstallCondition(
string
$min, string
$max, [false|array
$exclude = false])

Set an installation condition based on php version for the current release set

Parameters:

string	`$min`	—	minimum version
string	`$max`	—	maximum version
false\|array	`$exclude`	—	incompatible versions of PHP

[ Top ]

setProvidesExtension [line 42]

bool setProvidesExtension(
string
$extension)

Return: success of operation

Parameters:

string $extension — Extension name

[ Top ]

setReleaseStability [line 319]

void setReleaseStability(

$state)

snapshot|devel|alpha|beta|stable

Parameters:

$state —

[ Top ]

setReleaseVersion [line 286]

void setReleaseVersion(

$version)

Parameters:

$version —

[ Top ]

setSourcePackage [line 1447]

void setSourcePackage(
string
$packageOrUri)

For extension binary releases, this is used to specify either the static URI to a source package, or the package name and channel of the extsrc package it is based on.

Parameters:

string $packageOrUri — Package name, or full URI to source package (extsrc type)

[ Top ]

setSummary [line 130]

void setSummary(

$summary)

Parameters:

$summary —

[ Top ]

setUri [line 80]

void setUri(

$uri)

Parameters:

$uri —

[ Top ]

updateMaintainer [line 211]

void updateMaintainer(

$newrole, 
$handle, 
$name, 
$email, [
$active = 'yes'])

Parameters:

	`$newrole`	—
	`$handle`	—
	`$name`	—
	`$email`	—
	`$active`	—

[ Top ]

Class: PEAR_PackageFile_v2_rw

Class Overview

Author(s):

Version:

Copyright:

Methods

Inherited Variables

Class: PEAR_PackageFile_v2

Inherited Methods

Class: PEAR_PackageFile_v2

Class Details

Method Detail

addArchDep [line 1157]

Parameters:

addBinarypackage [line 1293]

Parameters:

addBundledPackage [line 446]

Parameters:

addCompatiblePackage [line 571]

Parameters:

addConfigureOption [line 1315]

Parameters:

addConflictingPackageDepWithChannel [line 760]

Parameters:

addConflictingPackageDepWithUri [line 788]

Parameters:

addDependencyGroup [line 810]

Parameters:

addExtensionDep [line 1113]

Parameters:

addExtensionInstallCondition [line 1373]

Parameters:

addFile [line 530]

Parameters:

addGroupExtensionDep [line 931]

Parameters:

addGroupPackageDepWithChannel [line 889]

Parameters:

addGroupPackageDepWithURI [line 912]

Parameters:

addIgnore [line 1273]

Parameters:

addInstallAs [line 1254]

Parameters:

addMaintainer [line 166]

Parameters:

addOsDep [line 1136]

Parameters:

addPackageDepWithChannel [line 999]

Parameters:

addPackageDepWithUri [line 1028]

Parameters:

addRelease [line 1208]

addSubpackageDepWithChannel [line 1059]

Parameters:

addSubpackageDepWithUri [line 1087]

Parameters:

addTaskToFile [line 464]

Parameters:

addUsesrole [line 606]

Parameters:

addUsestask [line 637]

Parameters:

clearChangeLog [line 1527]

clearCompatible [line 655]

clearContents [line 423]

Parameters:

clearDeps [line 663]

deleteMaintainer [line 247]

Parameters:

generateChangeLogEntry [line 1464]

Parameters:

getChangelog [line 1516]

installedFile [line 409]

Parameters:

resetUsesrole [line 594]

resetUsestask [line 624]

setAPIStability [line 337]

Parameters:

setAPIVersion [line 301]