Docs For Class PEAR

__construct (Constructor) [line 133]

PEAR_Registry __construct(
[string
$pear_install_dir = PEAR_INSTALL_DIR], [PEAR_ChannelFile
$pear_channel = false], [PEAR_ChannelFile
$pecl_channel = false], [
$pear_metadata_dir = ''])

PEAR_Registry constructor.

Access: public

Overrides PEAR::__construct() (Constructor. Registers this object in $_PEAR_destructor_object_list for destructor emulation if a destructor object exists.)

Parameters:

string	`$pear_install_dir`	—	(optional) PEAR install directory (for .php files)
PEAR_ChannelFile	`$pear_channel`	—	PEAR_ChannelFile object representing the PEAR channel, if default values are not desired. Only used the very first time a PEAR repository is initialized
PEAR_ChannelFile	`$pecl_channel`	—	PEAR_ChannelFile object representing the PECL channel, if default values are not desired. Only used the very first time a PEAR repository is initialized
	`$pear_metadata_dir`	—

[ Top ]

addChannel [line 1833]

boolean|PEAR_Error addChannel(
PEAR_ChannelFile
$channel, [string
$lastmodified = false], [
$update = false])

Return: True on creation, false if it already exists

Parameters:

PEAR_ChannelFile	`$channel`	—	Channel object
string	`$lastmodified`	—	Last-Modified header from HTTP for caching
	`$update`	—

[ Top ]

addPackage [line 1744]

bool addPackage(
string|PEAR_PackageFile_v1|PEAR_PackageFile_v2
$package, array
$info)

Add an installed package to the registry

Return: success of saving

Parameters:

string\|PEAR_PackageFile_v1\|PEAR_PackageFile_v2	`$package`	—	package name or object that will be passed to addPackage2()
array	`$info`	—	package info (parsed by PEAR_Common::infoFrom*() methods)

[ Top ]

addPackage2 [line 1770]

void addPackage2(

$info)

Parameters:

$info —

[ Top ]

apiVersion [line 2147]

string apiVersion(
)

Get the expected API version. Channels API is version 1.1, as it is backwards

compatible with 1.0

[ Top ]

channelAlias [line 1687]

void channelAlias(
string
$channel)

Parameters:

string $channel —

[ Top ]

channelExists [line 1582]

bool channelExists(
string
$channel, [bool
$noaliases = false])

Parameters:

string	`$channel`	—	channel name
bool	`$noaliases`	—	if true, then aliases will be ignored

[ Top ]

channelInfo [line 1659]

array|null|PEAR_Error channelInfo(
[string
$channel = null], [bool
$noaliases = false])

Retrieve a raw array of channel data.

Do not use this, instead use getChannel() for normal operations. Array structure is undefined in this method

Parameters:

string	`$channel`	—	channel name
bool	`$noaliases`	—	whether to strictly retrieve information only on non-aliases

[ Top ]

channelName [line 1674]

void channelName(
string
$channel)

Parameters:

string $channel —

[ Top ]

checkFileMap [line 2060]

array|false checkFileMap(
string|array
$path, [string|array
$package = false], [string
$api = '1.0'], [array
$attrs = false])

Test whether a file or set of files belongs to a package.

If an array is passed in

Return: which package and channel the file belongs to, or an empty string if the file does not belong to an installed package, or belongs to the second parameter's package

Parameters:

string\|array	`$path`	—	file path, absolute or relative to the pear install dir
string\|array	`$package`	—	name of PEAR package or array('package' => name, 'channel' => channel) of a package that will be ignored
string	`$api`	—	API version - 1.1 will exclude any files belonging to a package
array	`$attrs`	—	private recursion variable

[ Top ]

deleteChannel [line 1810]

boolean|PEAR_Error deleteChannel(
string|PEAR_ChannelFile
$channel)

Deletion fails if there are any packages installed from the channel

Return: True on deletion, false if it doesn't exist

Parameters:

string|PEAR_ChannelFile $channel — channel name

[ Top ]

deletePackage [line 1855]

void deletePackage(

$package, [
$channel = 'pear.php.net'])

Parameters:

	`$package`	—
	`$channel`	—

[ Top ]

flushFileMap [line 2134]

void flushFileMap(
)

Force a reload of the filemap

Since: 1.5.0RC3

[ Top ]

getChannel [line 1931]

PEAR_ChannelFile|PEAR_Error getChannel(
string
$channel, [bool
$noaliases = false])

Parameters:

string	`$channel`	—	channel name
bool	`$noaliases`	—	whether to strictly return raw channels (no aliases)

[ Top ]

getChannels [line 2026]

array &getChannels(
string
0)

Return: an array of PEAR_ChannelFile objects representing every installed channel

Parameters:

string 0 — channel name

[ Top ]

getChannelValidator [line 2011]

PEAR_Validate|false &getChannelValidator(
string
$channel)

Parameters:

string $channel — channel name

[ Top ]

getInstalledGroup [line 1971]

array|false getInstalledGroup(
array
$group)

Get PEAR_PackageFile_v[1/2] objects representing the contents of a dependency group that are installed.

This is used at uninstall-time

Parameters:

array $group —

[ Top ]

getPackage [line 1951]

PEAR_PackageFile_v1|PEAR_PackageFile_v2|null &getPackage(
string
$package, [string
$channel = 'pear.php.net'])

Parameters:

string	`$package`	—	package name
string	`$channel`	—	channel name

[ Top ]

hasWriteAccess [line 156]

void hasWriteAccess(
)

[ Top ]

isAlias [line 1618]

bool isAlias(
string
$alias)

Determines whether the parameter is an alias of a channel

Parameters:

string $alias —

[ Top ]

listAllPackages [line 1711]

void listAllPackages(
)

[ Top ]

listChannels [line 1724]

void listChannels(
)

[ Top ]

listPackages [line 1698]

void listPackages(
[
$channel = false])

Parameters:

$channel —

[ Top ]

mirrorExists [line 1600]

bool mirrorExists(
string
$channel, string
$mirror)

Parameters:

string	`$channel`	—	channel name mirror is in
string	`$mirror`	—	mirror name

[ Top ]

packageExists [line 1563]

bool packageExists(
string
$package, [string
$channel = 'pear.php.net'])

Parameters:

string	`$package`	—	Package name
string	`$channel`	—	Channel name

[ Top ]

packageInfo [line 1637]

array|null packageInfo(
[string|null
$package = null], [string|null
$key = null], [string
$channel = 'pear.php.net'])

Parameters:

string\|null	`$package`	—
string\|null	`$key`	—
string	`$channel`	—

[ Top ]

parsedPackageNameToString [line 2339]

string parsedPackageNameToString(
array
$parsed, [
$brief = false])

Parameters:

array	`$parsed`	—
	`$brief`	—

[ Top ]

parsePackageName [line 2167]

array|PEAR_Error parsePackageName(
string|array
$param, [
$defaultchannel = 'pear.php.net'])

Parse a package name, or validate a parsed package name array

Parameters:

string\|array	`$param`	—	pass in an array of format array( 'package' => 'pname', ['channel' => 'channame',] ['version' => 'version',] ['state' => 'state',] ['group' => 'groupname']) or a string of format [channel://][channame/]pname[-version\|-state][/group=groupname]
	`$defaultchannel`	—

[ Top ]

setConfig [line 182]

void setConfig(

&$config, [
$resetInstallDir = true])

Parameters:

	`&$config`	—
	`$resetInstallDir`	—

[ Top ]

setInstallDir [line 143]

void setInstallDir(
[
$pear_install_dir = PEAR_INSTALL_DIR], [
$pear_metadata_dir = ''])

Parameters:

	`$pear_install_dir`	—
	`$pear_metadata_dir`	—

[ Top ]

updateChannel [line 1794]

void updateChannel(
PEAR_ChannelFile
$channel, [
$lastmodified = null])

For future expandibility purposes, separate this

Parameters:

PEAR_ChannelFile	`$channel`	—
	`$lastmodified`	—

[ Top ]

updatePackage [line 1873]

void updatePackage(

$package, 
$info, [
$merge = true])

Parameters:

	`$package`	—
	`$info`	—
	`$merge`	—

[ Top ]

updatePackage2 [line 1899]

void updatePackage2(

$info)

Parameters:

$info —

[ Top ]

_channelDirectoryName [line 626]

string _channelDirectoryName(
string
$channel, string
1)

Get the name of the file where data for a given package is stored.

Return: registry file name
Access: public

Parameters:

string	`1`	—	package name
string	`$channel`	—	channel name, or false if this is a PEAR package

[ Top ]

_packageFileName [line 517]

string _packageFileName(
string
$package, [string
$channel = false])

Get the name of the file where data for a given package is stored.

Return: registry file name
Access: public

Parameters:

string	`$package`	—	channel name, or false if this is a PEAR package
string	`$channel`	—	package name

[ Top ]

Class: PEAR_Registry

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Class: PEAR

Inherited Methods

Class: PEAR

Class Details

Class Variables

$channels = ''

$channelsdir = ''

$filemap = ''

$filemap_cache = array()

$lockfile = ''

$lock_fp = null

$lock_mode = 0

$pkginfo_cache = array()

$statedir = ''

Method Detail

__construct (Constructor) [line 133]

Parameters:

addChannel [line 1833]

Parameters:

addPackage [line 1744]

Parameters:

addPackage2 [line 1770]

Parameters:

apiVersion [line 2147]

channelAlias [line 1687]

Parameters:

channelExists [line 1582]

Parameters:

channelInfo [line 1659]

Parameters:

channelName [line 1674]

Parameters:

checkFileMap [line 2060]

Parameters:

deleteChannel [line 1810]

Parameters:

deletePackage [line 1855]

Parameters:

flushFileMap [line 2134]

getChannel [line 1931]

Parameters:

getChannels [line 2026]

Parameters:

getChannelValidator [line 2011]

Parameters:

getInstalledGroup [line 1971]

Parameters:

getPackage [line 1951]

Parameters:

hasWriteAccess [line 156]

isAlias [line 1618]

Parameters:

listAllPackages [line 1711]

listChannels [line 1724]

listPackages [line 1698]

Parameters:

mirrorExists [line 1600]

Parameters:

packageExists [line 1563]

Parameters:

packageInfo [line 1637]

Parameters:

parsedPackageNameToString [line 2339]

Parameters:

parsePackageName [line 2167]

Parameters:

setConfig [line 182]

Parameters:

setInstallDir [line 143]

Parameters:

updateChannel [line 1794]

Parameters: