PEAR_Registry Class Reference

Inheritance diagram for PEAR_Registry:

Collaboration diagram for PEAR_Registry:

Public Member Functions
	__construct ($pear_install_dir=PEAR_INSTALL_DIR, $pear_channel=false, $pecl_channel=false, $pear_metadata_dir='')
	_addChannel ($channel, $update=false, $lastmodified=false)
	_addPackage ($package, $info)
	_addPackage2 ($info)
	_assertChannelDir ()
	_assertChannelStateDir ($channel)
	_assertStateDir ($channel=false)
	_channelDirectoryName ($channel)
	_channelExists ($channel, $noaliases=false)
	_channelFileName ($channel, $noaliases=false)
	_channelInfo ($channel, $noaliases=false)
	_closeChannelFile ($fp)
	_closePackageFile ($fp)
	_deleteChannel ($channel)
	_getAlias ($channel)
&	_getChannel ($channel, $noaliases=false)
	_getChannelAliasFileName ($alias)
	_getChannelFromAlias ($channel)
&	_getPackage ($package, $channel='pear.php.net')
	_initializeChannelDirs ()
	_initializeDepDB ()
	_initializeDirs ()
	_isChannelAlias ($alias)
	_listAllPackages ()
	_listChannelPackages ($channel)
	_listChannels ()
	_listPackages ($channel=false)
	_lock ($mode=LOCK_EX)
	_mirrorExists ($channel, $mirror)
	_openChannelFile ($channel, $mode)
	_openPackageFile ($package, $mode, $channel=false)
	_packageExists ($package, $channel=false)
	_packageFileName ($package, $channel=false)
	_packageInfo ($package=null, $key=null, $channel='pear.php.net')
	_PEAR_Registry ()
	_readFileMap ()
	_rebuildFileMap ()
	_unlock ()
	_updatePackage ($package, $info, $merge=true)
	_updatePackage2 ($info)
	addChannel ($channel, $lastmodified=false, $update=false)
	addPackage ($package, $info)
	addPackage2 ($info)
	apiVersion ()
	channelAlias ($channel)
	channelExists ($channel, $noaliases=false)
	channelInfo ($channel=null, $noaliases=false)
	channelName ($channel)
	checkFileMap ($path, $package=false, $api='1.0', $attrs=false)
	deleteChannel ($channel)
	deletePackage ($package, $channel='pear.php.net')
	flushFileMap ()
	getChannel ($channel, $noaliases=false)
&	getChannels ()
&	getChannelValidator ($channel)
	getInstalledGroup ($group)
&	getPackage ($package, $channel='pear.php.net')
	hasWriteAccess ()
	isAlias ($alias)
	listAllPackages ()
	listChannels ()
	listPackages ($channel=false)
	mirrorExists ($channel, $mirror)
	packageExists ($package, $channel='pear.php.net')
	packageInfo ($package=null, $key=null, $channel='pear.php.net')
	parsedPackageNameToString ($parsed, $brief=false)
	parsePackageName ($param, $defaultchannel='pear.php.net')
	setConfig (&$config, $resetInstallDir=true)
	setInstallDir ($pear_install_dir=PEAR_INSTALL_DIR, $pear_metadata_dir='')
	updateChannel ($channel, $lastmodified=null)
	updatePackage ($package, $info, $merge=true)
	updatePackage2 ($info)
Public Member Functions inherited from PEAR
	__call ($method, $arguments)
	__construct ($error_class=null)
	_checkDelExpect ($error_code)
	_PEAR ()
	delExpect ($error_code)
	expectError ($code=' *')
	PEAR ($error_class=null)
	popExpect ()

Data Fields
	$_config
	$_dependencyDB
	$_docChannel
	$_pearChannel
	$_peclChannel
	$channels = ''
	$channelsdir = ''
	$filemap = ''
	$filemap_cache = array()
	$lock_fp = null
	$lock_mode = 0
	$lockfile = ''
	$pkginfo_cache = array()
	$statedir = ''
Data Fields inherited from PEAR
	$_debug = false
	$_default_error_handler = ''
	$_default_error_mode = null
	$_default_error_options = null
	$_error_class = 'PEAR_Error'
	$_expected_errors = array()

Additional Inherited Members
Static Public Member Functions inherited from PEAR
static	__callStatic ($method, $arguments)
static	getSourceDateEpoch ()
static &	getStaticProperty ($class, $var)
static	isError ($data, $code=null)
static	loadExtension ($ext)
static	registerShutdownFunc ($func, $args=array())
static	staticPopErrorHandling ()
static	staticPushErrorHandling ($mode, $options=null)
Static Protected Member Functions inherited from PEAR
static	_popErrorHandling ($object)
static	_pushErrorHandling ($object, $mode, $options=null)
static	_raiseError ($object, $message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false)
static	_setErrorHandling ( $object, $mode=null, $options=null)
static	_throwError ($object, $message=null, $code=null, $userinfo=null)
Static Protected Attributes inherited from PEAR
static	$bivalentMethods

Detailed Description

Definition at line 43 of file Registry.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$pear_install_dir = PEAR_INSTALL_DIR,
			$pear_channel = false,
			$pecl_channel = false,
			$pear_metadata_dir = '' )

PEAR_Registry constructor.

Parameters

string	(optional) PEAR install directory (for .php files)
PEAR_ChannelFile	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	PEAR_ChannelFile object representing the PECL channel, if default values are not desired. Only used the very first time a PEAR repository is initialized

@access public

Definition at line 133 of file Registry.php.

    {
        parent::__construct();
        $this->setInstallDir($pear_install_dir, $pear_metadata_dir);
        $this->_pearChannel = $pear_channel;
        $this->_peclChannel = $pecl_channel;
        $this->_config      = false;
    }

References setInstallDir().

Here is the call graph for this function:

Member Function Documentation

_addChannel()

_addChannel	(		$channel,
			$update = false,
			$lastmodified = false )

Parameters

PEAR_ChannelFile	Channel object
donotuse
string	Last-Modified HTTP tag from remote request

Returns

boolean|PEAR_Error True on creation, false if it already exists

Definition at line 943 of file Registry.php.

    {
        if (!is_a($channel, 'PEAR_ChannelFile')) {
            return false;
        }
 
        if (!$channel->validate()) {
            return false;
        }
 
        if (file_exists($this->_channelFileName($channel->getName()))) {
            if (!$update) {
                return false;
            }
 
            $checker = $this->_getChannel($channel->getName());
            if (PEAR::isError($checker)) {
                return $checker;
            }
 
            if ($channel->getAlias() != $checker->getAlias()) {
                if (file_exists($this->_getChannelAliasFileName($checker->getAlias()))) {
                    @unlink($this->_getChannelAliasFileName($checker->getAlias()));
                }
            }
        } else {
            if ($update && !in_array($channel->getName(), array('pear.php.net', 'pecl.php.net', 'doc.php.net'))) {
                return false;
            }
        }
 
        $ret = $this->_assertChannelDir();
        if (PEAR::isError($ret)) {
            return $ret;
        }
 
        $ret = $this->_assertChannelStateDir($channel->getName());
        if (PEAR::isError($ret)) {
            return $ret;
        }
 
        if ($channel->getAlias() != $channel->getName()) {
            if (file_exists($this->_getChannelAliasFileName($channel->getAlias())) &&
                  $this->_getChannelFromAlias($channel->getAlias()) != $channel->getName()) {
                $channel->setAlias($channel->getName());
            }
 
            if (!$this->hasWriteAccess()) {
                return false;
            }
 
            $fp = @fopen($this->_getChannelAliasFileName($channel->getAlias()), 'w');
            if (!$fp) {
                return false;
            }
 
            fwrite($fp, $channel->getName());
            fclose($fp);
        }
 
        if (!$this->hasWriteAccess()) {
            return false;
        }
 
        $fp = @fopen($this->_channelFileName($channel->getName()), 'wb');
        if (!$fp) {
            return false;
        }
 
        $info = $channel->toArray();
        if ($lastmodified) {
            $info['_lastmodified'] = $lastmodified;
        } else {
            $info['_lastmodified'] = self::getSourceDateEpoch();
        }
 
        fwrite($fp, serialize($info));
        fclose($fp);
        return true;
    }

References _assertChannelDir(), _assertChannelStateDir(), _channelFileName(), _getChannel(), _getChannelAliasFileName(), PEAR\getSourceDateEpoch(), hasWriteAccess(), and PEAR\isError().

Referenced by _initializeChannelDirs(), and addChannel().

Here is the call graph for this function:

Here is the caller graph for this function:

_addPackage()

_addPackage	(		$package,
			$info )

Add an installed package to the registry

Parameters

string	package name
array	package info (parsed by PEAR_Common::infoFrom*() methods)

Returns

bool success of saving @access private

Definition at line 1298 of file Registry.php.

    {
        if ($this->_packageExists($package)) {
            return false;
        }
 
        $fp = $this->_openPackageFile($package, 'wb');
        if ($fp === null) {
            return false;
        }
 
        $info['_lastmodified'] = self::getSourceDateEpoch();
        fwrite($fp, serialize($info));
        $this->_closePackageFile($fp);
        if (isset($info['filelist'])) {
            $this->_rebuildFileMap();
        }
 
        return true;
    }

References _closePackageFile(), _openPackageFile(), _packageExists(), _rebuildFileMap(), and PEAR\getSourceDateEpoch().

Referenced by addPackage().

Here is the call graph for this function:

Here is the caller graph for this function:

_addPackage2()

_addPackage2

(

$info

)

Parameters

PEAR_PackageFile_v1|PEAR_PackageFile_v2

Returns

bool @access private

Definition at line 1324 of file Registry.php.

    {
        if (!is_a($info, 'PEAR_PackageFile_v1') && !is_a($info, 'PEAR_PackageFile_v2')) {
            return false;
        }
 
        if (!$info->validate()) {
            if (class_exists('PEAR_Common')) {
                $ui = PEAR_Frontend::singleton();
                if ($ui) {
                    foreach ($info->getValidationWarnings() as $err) {
                        $ui->log($err['message'], true);
                    }
                }
            }
            return false;
        }
 
        $channel = $info->getChannel();
        $package = $info->getPackage();
        $save = $info;
        if ($this->_packageExists($package, $channel)) {
            return false;
        }
 
        if (!$this->_channelExists($channel, true)) {
            return false;
        }
 
        $info = $info->toArray(true);
        if (!$info) {
            return false;
        }
 
        $fp = $this->_openPackageFile($package, 'wb', $channel);
        if ($fp === null) {
            return false;
        }
 
        $info['_lastmodified'] = self::getSourceDateEpoch();
        fwrite($fp, serialize($info));
        $this->_closePackageFile($fp);
        $this->_rebuildFileMap();
        return true;
    }

References $ui, _channelExists(), _closePackageFile(), _openPackageFile(), _packageExists(), _rebuildFileMap(), PEAR\getSourceDateEpoch(), and PEAR_Frontend\singleton().

Referenced by addPackage2().

Here is the call graph for this function:

Here is the caller graph for this function:

_assertChannelDir()

_assertChannelDir

(

)

Make sure the directory where we keep registry files for channels exists

Returns

bool TRUE if directory exists, FALSE if it could not be created

@access private

Definition at line 474 of file Registry.php.

    {
        if (!file_exists($this->channelsdir)) {
            if (!$this->hasWriteAccess()) {
                return false;
            }
 
            require_once 'System.php';
            if (!System::mkdir(array('-p', $this->channelsdir))) {
                return $this->raiseError("could not create directory '{$this->channelsdir}'");
            }
        } elseif (!is_dir($this->channelsdir)) {
            return $this->raiseError("could not create directory '{$this->channelsdir}" .
                "', it already exists and is not a directory");
        }
 
        if (!file_exists($this->channelsdir . DIRECTORY_SEPARATOR . '.alias')) {
            if (!$this->hasWriteAccess()) {
                return false;
            }
 
            require_once 'System.php';
            if (!System::mkdir(array('-p', $this->channelsdir . DIRECTORY_SEPARATOR . '.alias'))) {
                return $this->raiseError("could not create directory '{$this->channelsdir}/.alias'");
            }
        } elseif (!is_dir($this->channelsdir . DIRECTORY_SEPARATOR . '.alias')) {
            return $this->raiseError("could not create directory '{$this->channelsdir}" .
                "/.alias', it already exists and is not a directory");
        }
 
        return true;
    }

References hasWriteAccess().

Referenced by _addChannel(), and _openChannelFile().

Here is the call graph for this function:

Here is the caller graph for this function:

_assertChannelStateDir()

_assertChannelStateDir

(

$channel

)

Make sure the directory where we keep registry files exists for a non-standard channel.

Parameters

string

channel name

Returns

bool TRUE if directory exists, FALSE if it could not be created

@access private

Definition at line 432 of file Registry.php.

    {
        $ds = DIRECTORY_SEPARATOR;
        if (!$channel || $this->_getChannelFromAlias($channel) == 'pear.php.net') {
            if (!file_exists($this->channelsdir . $ds . 'pear.php.net.reg')) {
                $this->_initializeChannelDirs();
            }
            return $this->_assertStateDir($channel);
        }
 
        $channelDir = $this->_channelDirectoryName($channel);
        if (!is_dir($this->channelsdir) ||
              !file_exists($this->channelsdir . $ds . 'pear.php.net.reg')) {
            $this->_initializeChannelDirs();
        }
 
        if (!file_exists($channelDir)) {
            if (!$this->hasWriteAccess()) {
                return false;
            }
 
            require_once 'System.php';
            if (!System::mkdir(array('-p', $channelDir))) {
                return $this->raiseError("could not create directory '" . $channelDir .
                    "'");
            }
        } elseif (!is_dir($channelDir)) {
            return $this->raiseError("could not create directory '" . $channelDir .
                "', already exists and is not a directory");
        }
 
        return true;
    }

References _assertStateDir(), _channelDirectoryName(), _getChannelFromAlias(), _initializeChannelDirs(), and hasWriteAccess().

Referenced by _addChannel(), and _assertStateDir().

Here is the call graph for this function:

Here is the caller graph for this function:

_assertStateDir()

_assertStateDir

(

$channel = false

)

Make sure the directory where we keep registry files exists.

Returns

bool TRUE if directory exists, FALSE if it could not be created

@access private

Definition at line 373 of file Registry.php.

    {
        if ($channel && $this->_getChannelFromAlias($channel) != 'pear.php.net') {
            return $this->_assertChannelStateDir($channel);
        }
 
        static $init = false;
        if (!file_exists($this->statedir)) {
            if (!$this->hasWriteAccess()) {
                return false;
            }
 
            require_once 'System.php';
            if (!System::mkdir(array('-p', $this->statedir))) {
                return $this->raiseError("could not create directory '{$this->statedir}'");
            }
            $init = true;
        } elseif (!is_dir($this->statedir)) {
            return $this->raiseError('Cannot create directory ' . $this->statedir . ', ' .
                'it already exists and is not a directory');
        }
 
        $ds = DIRECTORY_SEPARATOR;
        if (!file_exists($this->channelsdir)) {
            if (!file_exists($this->channelsdir . $ds . 'pear.php.net.reg') ||
                  !file_exists($this->channelsdir . $ds . 'pecl.php.net.reg') ||
                  !file_exists($this->channelsdir . $ds . 'doc.php.net.reg') ||
                  !file_exists($this->channelsdir . $ds . '__uri.reg')) {
                $init = true;
            }
        } elseif (!is_dir($this->channelsdir)) {
            return $this->raiseError('Cannot create directory ' . $this->channelsdir . ', ' .
                'it already exists and is not a directory');
        }
 
        if ($init) {
            static $running = false;
            if (!$running) {
                $running = true;
                $this->_initializeDirs();
                $running = false;
                $init = false;
            }
        } else {
            $this->_initializeDepDB();
        }
 
        return true;
    }

References _assertChannelStateDir(), _getChannelFromAlias(), _initializeDepDB(), _initializeDirs(), and hasWriteAccess().

Referenced by _assertChannelStateDir(), _lock(), _openPackageFile(), and _rebuildFileMap().

Here is the call graph for this function:

Here is the caller graph for this function:

_channelDirectoryName()

_channelDirectoryName

(

$channel

)

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

Parameters

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

Returns

string registry file name

@access public

Definition at line 626 of file Registry.php.

    {
        if (!$channel || $this->_getChannelFromAlias($channel) == 'pear.php.net') {
            return $this->statedir;
        }
 
        $ch = $this->_getChannelFromAlias($channel);
        if (!$ch) {
            $ch = $channel;
        }
 
        return $this->statedir . DIRECTORY_SEPARATOR . strtolower('.channel.' .
            str_replace('/', '_', $ch));
    }

References $statedir, and _getChannelFromAlias().

Referenced by _assertChannelStateDir(), _deleteChannel(), _listChannelPackages(), and _packageFileName().

Here is the call graph for this function:

Here is the caller graph for this function:

_channelExists()

_channelExists	(		$channel,
			$noaliases = false )

Determine whether a channel exists in the registry

Parameters

string	Channel name
bool	if true, then aliases will be ignored

Returns

boolean

Definition at line 895 of file Registry.php.

    {
        $a = file_exists($this->_channelFileName($channel, $noaliases));
        if (!$a && $channel == 'pear.php.net') {
            return true;
        }
 
        if (!$a && $channel == 'pecl.php.net') {
            return true;
        }
 
        if (!$a && $channel == 'doc.php.net') {
            return true;
        }
 
        return $a;
    }

References _channelFileName().

Referenced by _addPackage2(), _channelInfo(), _deleteChannel(), _getAlias(), _getChannel(), _getChannelFromAlias(), and channelExists().

Here is the call graph for this function:

Here is the caller graph for this function:

_channelFileName()

_channelFileName	(		$channel,
			$noaliases = false )

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

Parameters

string

channel name

Returns

string registry file name

Definition at line 532 of file Registry.php.

    {
        if (!$noaliases) {
            if (file_exists($this->_getChannelAliasFileName($channel))) {
                $channel = implode('', file($this->_getChannelAliasFileName($channel)));
            }
        }
        return $this->channelsdir . DIRECTORY_SEPARATOR . str_replace('/', '_',
            strtolower($channel)) . '.reg';
    }

References _getChannelAliasFileName().

Referenced by _addChannel(), _channelExists(), _channelInfo(), _deleteChannel(), and _openChannelFile().

Here is the call graph for this function:

Here is the caller graph for this function:

_channelInfo()

_channelInfo	(		$channel,
			$noaliases = false )

Parameters

string	Channel name
bool	whether to strictly retrieve info of channels, not just aliases

Returns

array|null

Definition at line 1168 of file Registry.php.

    {
        if (!$this->_channelExists($channel, $noaliases)) {
            return null;
        }
 
        $fp = $this->_openChannelFile($channel, 'r');
        if ($fp === null) {
            return null;
        }
 
        clearstatcache();
        $this->_closeChannelFile($fp);
        $data = file_get_contents($this->_channelFileName($channel));
        $data = unserialize($data);
        return $data;
    }

References _channelExists(), _channelFileName(), _closeChannelFile(), and _openChannelFile().

Referenced by _getChannel(), _mirrorExists(), and channelInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

_closeChannelFile()

_closeChannelFile

(

$fp

)

Definition at line 692 of file Registry.php.

    {
        fclose($fp);
    }

Referenced by _channelInfo().

Here is the caller graph for this function:

_closePackageFile()

_closePackageFile

(

$fp

)

Definition at line 664 of file Registry.php.

    {
        fclose($fp);
    }

Referenced by _addPackage(), _addPackage2(), _packageInfo(), _updatePackage(), and _updatePackage2().

Here is the caller graph for this function:

_deleteChannel()

_deleteChannel

(

$channel

)

Deletion fails if there are any packages installed from the channel

Parameters

string|PEAR_ChannelFile

channel name

Returns

boolean|PEAR_Error True on deletion, false if it doesn't exist

Definition at line 1029 of file Registry.php.

    {
        if (!is_string($channel)) {
            if (!is_a($channel, 'PEAR_ChannelFile')) {
                return false;
            }
 
            if (!$channel->validate()) {
                return false;
            }
            $channel = $channel->getName();
        }
 
        if ($this->_getChannelFromAlias($channel) == '__uri') {
            return false;
        }
 
        if ($this->_getChannelFromAlias($channel) == 'pecl.php.net') {
            return false;
        }
 
        if ($this->_getChannelFromAlias($channel) == 'doc.php.net') {
            return false;
        }
 
        if (!$this->_channelExists($channel)) {
            return false;
        }
 
        if (!$channel || $this->_getChannelFromAlias($channel) == 'pear.php.net') {
            return false;
        }
 
        $channel = $this->_getChannelFromAlias($channel);
        if ($channel == 'pear.php.net') {
            return false;
        }
 
        $test = $this->_listChannelPackages($channel);
        if (count($test)) {
            return false;
        }
 
        $test = @rmdir($this->_channelDirectoryName($channel));
        if (!$test) {
            return false;
        }
 
        $file = $this->_getChannelAliasFileName($this->_getAlias($channel));
        if (file_exists($file)) {
            $test = @unlink($file);
            if (!$test) {
                return false;
            }
        }
 
        $file = $this->_channelFileName($channel);
        $ret = true;
        if (file_exists($file)) {
            $ret = @unlink($file);
        }
 
        return $ret;
    }

References _channelDirectoryName(), _channelExists(), _channelFileName(), _getAlias(), _getChannelAliasFileName(), _getChannelFromAlias(), and _listChannelPackages().

Referenced by deleteChannel().

Here is the call graph for this function:

Here is the caller graph for this function:

_getAlias()

_getAlias

(

$channel

)

Get the alias of a channel from its alias or its name

Definition at line 590 of file Registry.php.

    {
        if (!$this->_channelExists($channel)) {
            if ($channel == 'pear.php.net') {
                return 'pear';
            }
 
            if ($channel == 'pecl.php.net') {
                return 'pecl';
            }
 
            if ($channel == 'doc.php.net') {
                return 'phpdocs';
            }
 
            return false;
        }
 
        $channel = $this->_getChannel($channel);
        if (PEAR::isError($channel)) {
            return $channel;
        }
 
        return $channel->getAlias();
    }

References _channelExists(), _getChannel(), and PEAR\isError().

Referenced by _deleteChannel(), and channelAlias().

Here is the call graph for this function:

Here is the caller graph for this function:

_getChannel()

& _getChannel	(		$channel,
			$noaliases = false )

Parameters

string	channel name
bool	whether to strictly retrieve channel names

Returns

PEAR_ChannelFile|PEAR_Error @access private

Definition at line 1468 of file Registry.php.

    {
        $ch = false;
        if ($this->_channelExists($channel, $noaliases)) {
            $chinfo = $this->_channelInfo($channel, $noaliases);
            if ($chinfo) {
                if (!class_exists('PEAR_ChannelFile')) {
                    require_once 'PEAR/ChannelFile.php';
                }
 
                $ch = &PEAR_ChannelFile::fromArrayWithErrors($chinfo);
            }
        }
 
        if ($ch) {
            if ($ch->validate()) {
                return $ch;
            }
 
            foreach ($ch->getErrors(true) as $err) {
                $message = $err['message'] . "\n";
            }
 
            $ch = PEAR::raiseError($message);
            return $ch;
        }
 
        if ($this->_getChannelFromAlias($channel) == 'pear.php.net') {
            // the registry is not properly set up, so use defaults
            if (!class_exists('PEAR_ChannelFile')) {
                require_once 'PEAR/ChannelFile.php';
            }
 
            $pear_channel = new PEAR_ChannelFile;
            $pear_channel->setServer('pear.php.net');
            $pear_channel->setAlias('pear');
            $pear_channel->setSummary('PHP Extension and Application Repository');
            $pear_channel->setDefaultPEARProtocols();
            $pear_channel->setBaseURL('REST1.0', 'https://pear.php.net/rest/');
            $pear_channel->setBaseURL('REST1.1', 'https://pear.php.net/rest/');
            $pear_channel->setBaseURL('REST1.3', 'https://pear.php.net/rest/');
            return $pear_channel;
        }
 
        if ($this->_getChannelFromAlias($channel) == 'pecl.php.net') {
            // the registry is not properly set up, so use defaults
            if (!class_exists('PEAR_ChannelFile')) {
                require_once 'PEAR/ChannelFile.php';
            }
            $pear_channel = new PEAR_ChannelFile;
            $pear_channel->setServer('pecl.php.net');
            $pear_channel->setAlias('pecl');
            $pear_channel->setSummary('PHP Extension Community Library');
            $pear_channel->setDefaultPEARProtocols();
            $pear_channel->setBaseURL('REST1.0', 'https://pecl.php.net/rest/');
            $pear_channel->setBaseURL('REST1.1', 'https://pecl.php.net/rest/');
            $pear_channel->setValidationPackage('PEAR_Validator_PECL', '1.0');
            return $pear_channel;
        }
 
        if ($this->_getChannelFromAlias($channel) == 'doc.php.net') {
            // the registry is not properly set up, so use defaults
            if (!class_exists('PEAR_ChannelFile')) {
                require_once 'PEAR/ChannelFile.php';
            }
 
            $doc_channel = new PEAR_ChannelFile;
            $doc_channel->setServer('doc.php.net');
            $doc_channel->setAlias('phpdocs');
            $doc_channel->setSummary('PHP Documentation Team');
            $doc_channel->setDefaultPEARProtocols();
            $doc_channel->setBaseURL('REST1.0', 'https://doc.php.net/rest/');
            $doc_channel->setBaseURL('REST1.1', 'https://doc.php.net/rest/');
            $doc_channel->setBaseURL('REST1.3', 'https://doc.php.net/rest/');
            return $doc_channel;
        }
 
 
        if ($this->_getChannelFromAlias($channel) == '__uri') {
            // the registry is not properly set up, so use defaults
            if (!class_exists('PEAR_ChannelFile')) {
                require_once 'PEAR/ChannelFile.php';
            }
 
            $private = new PEAR_ChannelFile;
            $private->setName('__uri');
            $private->setDefaultPEARProtocols();
            $private->setBaseURL('REST1.0', '****');
            $private->setSummary('Pseudo-channel for static packages');
            return $private;
        }
 
        return $ch;
    }

References _channelExists(), _channelInfo(), _getChannelFromAlias(), PEAR_ChannelFile\fromArrayWithErrors(), PEAR_ChannelFile\setName(), and PEAR_ChannelFile\setServer().

Referenced by _addChannel(), _getAlias(), getChannel(), and getChannels().

Here is the call graph for this function:

Here is the caller graph for this function:

_getChannelAliasFileName()

_getChannelAliasFileName

(

$alias

)

Parameters

string

Returns

string

Definition at line 547 of file Registry.php.

    {
        return $this->channelsdir . DIRECTORY_SEPARATOR . '.alias' .
              DIRECTORY_SEPARATOR . str_replace('/', '_', strtolower($alias)) . '.txt';
    }

Referenced by _addChannel(), _channelFileName(), _deleteChannel(), _getChannelFromAlias(), and _isChannelAlias().

Here is the caller graph for this function:

_getChannelFromAlias()

_getChannelFromAlias

(

$channel

)

Get the name of a channel from its alias

Definition at line 556 of file Registry.php.

    {
        if (!$this->_channelExists($channel)) {
            if ($channel == 'pear.php.net') {
                return 'pear.php.net';
            }
 
            if ($channel == 'pecl.php.net') {
                return 'pecl.php.net';
            }
 
            if ($channel == 'doc.php.net') {
                return 'doc.php.net';
            }
 
            if ($channel == '__uri') {
                return '__uri';
            }
 
            return false;
        }
 
        $channel = strtolower($channel);
        if (file_exists($this->_getChannelAliasFileName($channel))) {
            // translate an alias to an actual channel
            return implode('', file($this->_getChannelAliasFileName($channel)));
        }
 
        return $channel;
    }

References _channelExists(), and _getChannelAliasFileName().

Referenced by _assertChannelStateDir(), _assertStateDir(), _channelDirectoryName(), _deleteChannel(), _getChannel(), _listPackages(), _packageFileName(), and channelName().

Here is the call graph for this function:

Here is the caller graph for this function:

_getPackage()

& _getPackage	(		$package,
			$channel = 'pear.php.net' )

Parameters

string	Package name
string	Channel name

Returns

PEAR_PackageFile_v1|PEAR_PackageFile_v2|null @access private

Definition at line 1440 of file Registry.php.

    {
        $info = $this->_packageInfo($package, null, $channel);
        if ($info === null) {
            return $info;
        }
 
        $a = $this->_config;
        if (!$a) {
            $this->_config = new PEAR_Config;
            $this->_config->set('php_dir', $this->statedir);
        }
 
        if (!class_exists('PEAR_PackageFile')) {
            require_once 'PEAR/PackageFile.php';
        }
 
        $pkg = new PEAR_PackageFile($this->_config);
        $pf = &$pkg->fromArray($info);
        return $pf;
    }

References $_config, and _packageInfo().

Referenced by getPackage().

Here is the call graph for this function:

Here is the caller graph for this function:

_initializeChannelDirs()

_initializeChannelDirs

(

)

Definition at line 190 of file Registry.php.

    {
        static $running = false;
        if (!$running) {
            $running = true;
            $ds = DIRECTORY_SEPARATOR;
            if (!is_dir($this->channelsdir) ||
                  !file_exists($this->channelsdir . $ds . 'pear.php.net.reg') ||
                  !file_exists($this->channelsdir . $ds . 'pecl.php.net.reg') ||
                  !file_exists($this->channelsdir . $ds . 'doc.php.net.reg') ||
                  !file_exists($this->channelsdir . $ds . '__uri.reg')) {
                if (!file_exists($this->channelsdir . $ds . 'pear.php.net.reg')) {
                    $pear_channel = $this->_pearChannel;
                    if (!is_a($pear_channel, 'PEAR_ChannelFile') || !$pear_channel->validate()) {
                        if (!class_exists('PEAR_ChannelFile')) {
                            require_once 'PEAR/ChannelFile.php';
                        }
 
                        $pear_channel = new PEAR_ChannelFile;
                        $pear_channel->setAlias('pear');
                        $pear_channel->setServer('pear.php.net');
                        $pear_channel->setSummary('PHP Extension and Application Repository');
                        $pear_channel->setDefaultPEARProtocols();
                        $pear_channel->setBaseURL('REST1.0', 'https://pear.php.net/rest/');
                        $pear_channel->setBaseURL('REST1.1', 'https://pear.php.net/rest/');
                        $pear_channel->setBaseURL('REST1.3', 'https://pear.php.net/rest/');
                        //$pear_channel->setBaseURL('REST1.4', 'https://pear.php.net/rest/');
                    } else {
                        $pear_channel->setServer('pear.php.net');
                        $pear_channel->setAlias('pear');
                    }
 
                    $pear_channel->validate();
                    $this->_addChannel($pear_channel);
                }
 
                if (!file_exists($this->channelsdir . $ds . 'pecl.php.net.reg')) {
                    $pecl_channel = $this->_peclChannel;
                    if (!is_a($pecl_channel, 'PEAR_ChannelFile') || !$pecl_channel->validate()) {
                        if (!class_exists('PEAR_ChannelFile')) {
                            require_once 'PEAR/ChannelFile.php';
                        }
 
                        $pecl_channel = new PEAR_ChannelFile;
                        $pecl_channel->setAlias('pecl');
                        $pecl_channel->setServer('pecl.php.net');
                        $pecl_channel->setSummary('PHP Extension Community Library');
                        $pecl_channel->setDefaultPEARProtocols();
                        $pecl_channel->setBaseURL('REST1.0', 'https://pecl.php.net/rest/');
                        $pecl_channel->setBaseURL('REST1.1', 'https://pecl.php.net/rest/');
                        $pecl_channel->setValidationPackage('PEAR_Validator_PECL', '1.0');
                    } else {
                        $pecl_channel->setServer('pecl.php.net');
                        $pecl_channel->setAlias('pecl');
                    }
 
                    $pecl_channel->validate();
                    $this->_addChannel($pecl_channel);
                }
 
                if (!file_exists($this->channelsdir . $ds . 'doc.php.net.reg')) {
                    $doc_channel = $this->_docChannel;
                    if (!is_a($doc_channel, 'PEAR_ChannelFile') || !$doc_channel->validate()) {
                        if (!class_exists('PEAR_ChannelFile')) {
                            require_once 'PEAR/ChannelFile.php';
                        }
 
                        $doc_channel = new PEAR_ChannelFile;
                        $doc_channel->setAlias('phpdocs');
                        $doc_channel->setServer('doc.php.net');
                        $doc_channel->setSummary('PHP Documentation Team');
                        $doc_channel->setDefaultPEARProtocols();
                        $doc_channel->setBaseURL('REST1.0', 'https://doc.php.net/rest/');
                        $doc_channel->setBaseURL('REST1.1', 'https://doc.php.net/rest/');
                        $doc_channel->setBaseURL('REST1.3', 'https://doc.php.net/rest/');
                    } else {
                        $doc_channel->setServer('doc.php.net');
                        $doc_channel->setAlias('doc');
                    }
 
                    $doc_channel->validate();
                    $this->_addChannel($doc_channel);
                }
 
                if (!file_exists($this->channelsdir . $ds . '__uri.reg')) {
                    if (!class_exists('PEAR_ChannelFile')) {
                        require_once 'PEAR/ChannelFile.php';
                    }
 
                    $private = new PEAR_ChannelFile;
                    $private->setName('__uri');
                    $private->setDefaultPEARProtocols();
                    $private->setBaseURL('REST1.0', '****');
                    $private->setSummary('Pseudo-channel for static packages');
                    $this->_addChannel($private);
                }
                $this->_rebuildFileMap();
            }
 
            $running = false;
        }
    }

References $_docChannel, $_pearChannel, $_peclChannel, _addChannel(), _rebuildFileMap(), PEAR_ChannelFile\setAlias(), and PEAR_ChannelFile\setName().

Referenced by _assertChannelStateDir(), and _initializeDirs().

Here is the call graph for this function:

Here is the caller graph for this function:

_initializeDepDB()

_initializeDepDB

(

)

Definition at line 316 of file Registry.php.

    {
        if (!isset($this->_dependencyDB)) {
            static $initializing = false;
            if (!$initializing) {
                $initializing = true;
                if (!$this->_config) { // never used?
                    $file = OS_WINDOWS ? 'pear.ini' : '.pearrc';
                    $this->_config = new PEAR_Config($this->statedir . DIRECTORY_SEPARATOR .
                        $file);
                    $this->_config->setRegistry($this);
                    $this->_config->set('php_dir', $this->install_dir);
                }
 
                $this->_dependencyDB = &PEAR_DependencyDB::singleton($this->_config);
                if (PEAR::isError($this->_dependencyDB)) {
                    // attempt to recover by removing the dep db
                    if (file_exists($this->_config->get('metadata_dir', null, 'pear.php.net') .
                        DIRECTORY_SEPARATOR . '.depdb')) {
                        @unlink($this->_config->get('metadata_dir', null, 'pear.php.net') .
                            DIRECTORY_SEPARATOR . '.depdb');
                    }
 
                    $this->_dependencyDB = &PEAR_DependencyDB::singleton($this->_config);
                    if (PEAR::isError($this->_dependencyDB)) {
                        echo $this->_dependencyDB->getMessage();
                        echo 'Unrecoverable error';
                        exit(1);
                    }
                }
 
                $initializing = false;
            }
        }
    }

References exit, PEAR\isError(), and PEAR_DependencyDB\singleton().

Referenced by _assertStateDir(), and _initializeDirs().

Here is the call graph for this function:

Here is the caller graph for this function:

_initializeDirs()

_initializeDirs

(

)

Definition at line 293 of file Registry.php.

    {
        $ds = DIRECTORY_SEPARATOR;
        // XXX Compatibility code should be removed in the future
        // rename all registry files if any to lowercase
        if (!OS_WINDOWS && file_exists($this->statedir) && is_dir($this->statedir) &&
              $handle = opendir($this->statedir)) {
            $dest = $this->statedir . $ds;
            while (false !== ($file = readdir($handle))) {
                if (preg_match('/^.*[A-Z].*\.reg\\z/', $file)) {
                    rename($dest . $file, $dest . strtolower($file));
                }
            }
            closedir($handle);
        }
 
        $this->_initializeChannelDirs();
        if (!file_exists($this->filemap)) {
            $this->_rebuildFileMap();
        }
        $this->_initializeDepDB();
    }

References _initializeChannelDirs(), _initializeDepDB(), and _rebuildFileMap().

Referenced by _assertStateDir().

Here is the call graph for this function:

Here is the caller graph for this function:

_isChannelAlias()

_isChannelAlias

(

$alias

)

Determine whether a channel exists in the registry

Parameters

string

Channel Alias

Returns

boolean

Definition at line 1099 of file Registry.php.

    {
        return file_exists($this->_getChannelAliasFileName($alias));
    }

References _getChannelAliasFileName().

Referenced by isAlias().

Here is the call graph for this function:

Here is the caller graph for this function:

_listAllPackages()

_listAllPackages

(

)

Definition at line 1281 of file Registry.php.

    {
        $ret = array();
        foreach ($this->_listChannels() as $channel) {
            $ret[$channel] = $this->_listPackages($channel);
        }
 
        return $ret;
    }

References _listChannels(), and _listPackages().

Referenced by _rebuildFileMap(), and listAllPackages().

Here is the call graph for this function:

Here is the caller graph for this function:

_listChannelPackages()

_listChannelPackages

(

$channel

)

Definition at line 1257 of file Registry.php.

    {
        $pkglist = array();
        if (!file_exists($this->_channelDirectoryName($channel)) ||
              !is_dir($this->_channelDirectoryName($channel))) {
            return array();
        }
 
        $dp = opendir($this->_channelDirectoryName($channel));
        if (!$dp) {
            return $pkglist;
        }
 
        while ($ent = readdir($dp)) {
            if ($ent[0] == '.' || substr($ent, -4) != '.reg') {
                continue;
            }
            $pkglist[] = substr($ent, 0, -4);
        }
 
        closedir($dp);
        return $pkglist;
    }

References _channelDirectoryName().

Referenced by _deleteChannel(), and _listPackages().

Here is the call graph for this function:

Here is the caller graph for this function:

_listChannels()

_listChannels

(

)

Definition at line 1186 of file Registry.php.

    {
        $channellist = array();
        if (!file_exists($this->channelsdir) || !is_dir($this->channelsdir)) {
            return array('pear.php.net', 'pecl.php.net', 'doc.php.net', '__uri');
        }
 
        $dp = opendir($this->channelsdir);
        while ($ent = readdir($dp)) {
            if ($ent[0] == '.' || substr($ent, -4) != '.reg') {
                continue;
            }
 
            if ($ent == '__uri.reg') {
                $channellist[] = '__uri';
                continue;
            }
 
            $channellist[] = str_replace('_', '/', substr($ent, 0, -4));
        }
 
        closedir($dp);
        if (!in_array('pear.php.net', $channellist)) {
            $channellist[] = 'pear.php.net';
        }
 
        if (!in_array('pecl.php.net', $channellist)) {
            $channellist[] = 'pecl.php.net';
        }
 
        if (!in_array('doc.php.net', $channellist)) {
            $channellist[] = 'doc.php.net';
        }
 
 
        if (!in_array('__uri', $channellist)) {
            $channellist[] = '__uri';
        }
 
        natsort($channellist);
        return $channellist;
    }

Referenced by _listAllPackages(), _packageInfo(), getChannels(), and listChannels().

Here is the caller graph for this function:

_listPackages()

_listPackages

(

$channel = false

)

Definition at line 1229 of file Registry.php.

    {
        if ($channel && $this->_getChannelFromAlias($channel) != 'pear.php.net') {
            return $this->_listChannelPackages($channel);
        }
 
        if (!file_exists($this->statedir) || !is_dir($this->statedir)) {
            return array();
        }
 
        $pkglist = array();
        $dp = opendir($this->statedir);
        if (!$dp) {
            return $pkglist;
        }
 
        while ($ent = readdir($dp)) {
            if ($ent[0] == '.' || substr($ent, -4) != '.reg') {
                continue;
            }
 
            $pkglist[] = substr($ent, 0, -4);
        }
        closedir($dp);
        sort($pkglist);
        return $pkglist;
    }

References _getChannelFromAlias(), and _listChannelPackages().

Referenced by _listAllPackages(), _packageInfo(), and listPackages().

Here is the call graph for this function:

Here is the caller graph for this function:

_lock()

_lock

(

$mode = LOCK_EX

)

Lock the registry.

Parameters

integer

lock mode, one of LOCK_EX, LOCK_SH or LOCK_UN. See flock manual for more information.

Returns

bool TRUE on success, FALSE if locking failed, or a PEAR error if some other error occurs (such as the lock file not being writable).

@access private

Definition at line 816 of file Registry.php.

    {
        if (stristr(php_uname(), 'Windows 9')) {
            return true;
        }
 
        if ($mode != LOCK_UN && is_resource($this->lock_fp)) {
            // XXX does not check type of lock (LOCK_SH/LOCK_EX)
            return true;
        }
 
        if (!$this->_assertStateDir()) {
            if ($mode == LOCK_EX) {
                return $this->raiseError('Registry directory is not writeable by the current user');
            }
 
            return true;
        }
 
        $open_mode = 'w';
        // XXX People reported problems with LOCK_SH and 'w'
        if ($mode === LOCK_SH || $mode === LOCK_UN) {
            if (!file_exists($this->lockfile)) {
                touch($this->lockfile);
            }
            $open_mode = 'r';
        }
 
        if (!is_resource($this->lock_fp)) {
            $this->lock_fp = @fopen($this->lockfile, $open_mode);
        }
 
        if (!is_resource($this->lock_fp)) {
            $this->lock_fp = null;
            return $this->raiseError("could not create lock file" .
                                     (isset($php_errormsg) ? ": " . $php_errormsg : ""));
        }
 
        if (!(int)flock($this->lock_fp, $mode)) {
            switch ($mode) {
                case LOCK_SH: $str = 'shared';    break;
                case LOCK_EX: $str = 'exclusive'; break;
                case LOCK_UN: $str = 'unlock';    break;
                default:      $str = 'unknown';   break;
            }
 
            //is resource at this point, close it on error.
            fclose($this->lock_fp);
            $this->lock_fp = null;
            return $this->raiseError("could not acquire $str lock ($this->lockfile)",
                                     PEAR_REGISTRY_ERROR_LOCK);
        }
 
        return true;
    }

References _assertStateDir(), and PEAR_REGISTRY_ERROR_LOCK.

Referenced by _unlock(), addChannel(), addPackage(), addPackage2(), channelAlias(), channelExists(), channelInfo(), channelName(), checkFileMap(), deleteChannel(), deletePackage(), getChannel(), getChannels(), getPackage(), isAlias(), listAllPackages(), listChannels(), listPackages(), mirrorExists(), packageExists(), packageInfo(), updatePackage(), and updatePackage2().

Here is the call graph for this function:

Here is the caller graph for this function:

_mirrorExists()

_mirrorExists	(		$channel,
			$mirror )

Determine whether a mirror exists within the default channel in the registry

Parameters

string	Channel name
string	Mirror name

Returns

boolean

Definition at line 921 of file Registry.php.

    {
        $data = $this->_channelInfo($channel);
        if (!isset($data['servers']['mirror'])) {
            return false;
        }
 
        foreach ($data['servers']['mirror'] as $m) {
            if ($m['attribs']['host'] == $mirror) {
                return true;
            }
        }
 
        return false;
    }

References _channelInfo().

Referenced by mirrorExists().

Here is the call graph for this function:

Here is the caller graph for this function:

_openChannelFile()

_openChannelFile	(		$channel,
			$mode )

Definition at line 669 of file Registry.php.

    {
        if (!$this->_assertChannelDir()) {
            return null;
        }
 
        if (!in_array($mode, array('r', 'rb')) && !$this->hasWriteAccess()) {
            return null;
        }
 
        $file = $this->_channelFileName($channel);
        if (!file_exists($file) && $mode == 'r' || $mode == 'rb') {
            return null;
        }
 
        $fp = @fopen($file, $mode);
        if (!$fp) {
            return null;
        }
 
        return $fp;
    }

References _assertChannelDir(), _channelFileName(), and hasWriteAccess().

Referenced by _channelInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

_openPackageFile()

_openPackageFile	(		$package,
			$mode,
			$channel = false )

Definition at line 641 of file Registry.php.

    {
        if (!$this->_assertStateDir($channel)) {
            return null;
        }
 
        if (!in_array($mode, array('r', 'rb')) && !$this->hasWriteAccess()) {
            return null;
        }
 
        $file = $this->_packageFileName($package, $channel);
        if (!file_exists($file) && $mode == 'r' || $mode == 'rb') {
            return null;
        }
 
        $fp = @fopen($file, $mode);
        if (!$fp) {
            return null;
        }
 
        return $fp;
    }

References _assertStateDir(), _packageFileName(), and hasWriteAccess().

Referenced by _addPackage(), _addPackage2(), _packageInfo(), _updatePackage(), and _updatePackage2().

Here is the call graph for this function:

Here is the caller graph for this function:

_packageExists()

_packageExists	(		$package,
			$channel = false )

Definition at line 883 of file Registry.php.

    {
        return file_exists($this->_packageFileName($package, $channel));
    }

References _packageFileName().

Referenced by _addPackage(), _addPackage2(), _updatePackage2(), and packageExists().

Here is the call graph for this function:

Here is the caller graph for this function:

_packageFileName()

_packageFileName	(		$package,
			$channel = false )

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

Parameters

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

Returns

string registry file name

@access public

Definition at line 517 of file Registry.php.

    {
        if ($channel && $this->_getChannelFromAlias($channel) != 'pear.php.net') {
            return $this->_channelDirectoryName($channel) . DIRECTORY_SEPARATOR .
                strtolower($package) . '.reg';
        }
 
        return $this->statedir . DIRECTORY_SEPARATOR . strtolower($package) . '.reg';
    }

References _channelDirectoryName(), and _getChannelFromAlias().

Referenced by _openPackageFile(), _packageExists(), _packageInfo(), and deletePackage().

Here is the call graph for this function:

Here is the caller graph for this function:

_packageInfo()

_packageInfo	(		$package = null,
			$key = null,
			$channel = 'pear.php.net' )

Parameters

string|null
string|null
string|null

Returns

array|null @access private

Definition at line 1111 of file Registry.php.

    {
        if ($package === null) {
            if ($channel === null) {
                $channels = $this->_listChannels();
                $ret = array();
                foreach ($channels as $channel) {
                    $channel = strtolower($channel);
                    $ret[$channel] = array();
                    $packages = $this->_listPackages($channel);
                    foreach ($packages as $package) {
                        $ret[$channel][] = $this->_packageInfo($package, null, $channel);
                    }
                }
 
                return $ret;
            }
 
            $ps = $this->_listPackages($channel);
            if (!count($ps)) {
                return array();
            }
            return array_map(array(&$this, '_packageInfo'),
                             $ps, array_fill(0, count($ps), null),
                             array_fill(0, count($ps), $channel));
        }
 
        $fp = $this->_openPackageFile($package, 'r', $channel);
        if ($fp === null) {
            return null;
        }
 
        clearstatcache();
        $this->_closePackageFile($fp);
        $data = file_get_contents($this->_packageFileName($package, $channel));
        $data = @unserialize($data);
        if ($key === null) {
            return $data;
        }
 
        // compatibility for package.xml version 2.0
        if (isset($data['old'][$key])) {
            return $data['old'][$key];
        }
 
        if (isset($data[$key])) {
            return $data[$key];
        }
 
        return null;
    }

References $channels, _closePackageFile(), _listChannels(), _listPackages(), _openPackageFile(), _packageFileName(), and _packageInfo().

Referenced by _getPackage(), _packageInfo(), _rebuildFileMap(), _updatePackage(), and packageInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

_PEAR_Registry()

_PEAR_Registry

(

)

PEAR_Registry destructor. Makes sure no locks are forgotten.

@access private

Definition at line 357 of file Registry.php.

    {
        parent::_PEAR();
        if (is_resource($this->lock_fp)) {
            $this->_unlock();
        }
    }

References _unlock().

Here is the call graph for this function:

_readFileMap()

_readFileMap

(

)

Definition at line 775 of file Registry.php.

    {
        if (!file_exists($this->filemap)) {
            return array();
        }
 
        $fp = @fopen($this->filemap, 'r');
        if (!$fp) {
            $last_errormsg = '';
            $last_error = error_get_last();
            if (!empty($last_error['message'])) {
                $last_errormsg = $last_error['message'];
            }
            return $this->raiseError('PEAR_Registry: could not open filemap "' . $this->filemap . '"', PEAR_REGISTRY_ERROR_FILE, null, null, $last_errormsg);
        }
 
        clearstatcache();
        $fsize = filesize($this->filemap);
        fclose($fp);
        $data = file_get_contents($this->filemap);
        $tmp = unserialize($data);
        if (!$tmp && $fsize > 7) {
            return $this->raiseError('PEAR_Registry: invalid filemap data', PEAR_REGISTRY_ERROR_FORMAT, null, null, $data);
        }
 
        $this->filemap_cache = $tmp;
        return true;
    }

References PEAR_REGISTRY_ERROR_FILE, and PEAR_REGISTRY_ERROR_FORMAT.

Referenced by checkFileMap().

Here is the caller graph for this function:

_rebuildFileMap()

_rebuildFileMap

(

)

Definition at line 697 of file Registry.php.

    {
        if (!class_exists('PEAR_Installer_Role')) {
            require_once 'PEAR/Installer/Role.php';
        }
 
        $channels = $this->_listAllPackages();
        $files = array();
        foreach ($channels as $channel => $packages) {
            foreach ($packages as $package) {
                $version = $this->_packageInfo($package, 'version', $channel);
                $filelist = $this->_packageInfo($package, 'filelist', $channel);
                if (!is_array($filelist)) {
                    continue;
                }
 
                foreach ($filelist as $name => $attrs) {
                    if (isset($attrs['attribs'])) {
                        $attrs = $attrs['attribs'];
                    }
 
                    // it is possible for conflicting packages in different channels to
                    // conflict with data files/doc files
                    if ($name == 'dirtree') {
                        continue;
                    }
 
                    if (isset($attrs['role']) && !in_array($attrs['role'],
                          PEAR_Installer_Role::getInstallableRoles())) {
                        // these are not installed
                        continue;
                    }
 
                    if (isset($attrs['role']) && !in_array($attrs['role'],
                          PEAR_Installer_Role::getBaseinstallRoles())) {
                        $attrs['baseinstalldir'] = $package;
                    }
 
                    if (isset($attrs['baseinstalldir'])) {
                        $file = $attrs['baseinstalldir'].DIRECTORY_SEPARATOR.$name;
                    } else {
                        $file = $name;
                    }
 
                    $file = preg_replace(',^/+,', '', $file);
                    if ($channel != 'pear.php.net') {
                        if (!isset($files[$attrs['role']])) {
                            $files[$attrs['role']] = array();
                        }
                        $files[$attrs['role']][$file] = array(strtolower($channel),
                            strtolower($package));
                    } else {
                        if (!isset($files[$attrs['role']])) {
                            $files[$attrs['role']] = array();
                        }
                        $files[$attrs['role']][$file] = strtolower($package);
                    }
                }
            }
        }
 
 
        $this->_assertStateDir();
        if (!$this->hasWriteAccess()) {
            return false;
        }
 
        $fp = @fopen($this->filemap, 'wb');
        if (!$fp) {
            return false;
        }
 
        $this->filemap_cache = $files;
        fwrite($fp, serialize($files));
        fclose($fp);
        return true;
    }

References $channels, _assertStateDir(), _listAllPackages(), _packageInfo(), PEAR_Installer_Role\getBaseinstallRoles(), PEAR_Installer_Role\getInstallableRoles(), and hasWriteAccess().

Referenced by _addPackage(), _addPackage2(), _initializeChannelDirs(), _initializeDirs(), _updatePackage(), _updatePackage2(), and deletePackage().

Here is the call graph for this function:

Here is the caller graph for this function:

_unlock()

_unlock

(

)

Definition at line 872 of file Registry.php.

    {
        $ret = $this->_lock(LOCK_UN);
        if (is_resource($this->lock_fp)) {
            fclose($this->lock_fp);
        }
 
        $this->lock_fp = null;
        return $ret;
    }

References _lock().

Referenced by _PEAR_Registry(), addChannel(), addPackage(), addPackage2(), channelAlias(), channelExists(), channelInfo(), channelName(), checkFileMap(), deleteChannel(), deletePackage(), getChannel(), getChannels(), getPackage(), isAlias(), listAllPackages(), listChannels(), listPackages(), mirrorExists(), packageExists(), packageInfo(), updatePackage(), and updatePackage2().

Here is the call graph for this function:

Here is the caller graph for this function:

_updatePackage()

_updatePackage	(		$package,
			$info,
			$merge = true )

Parameters

string	Package name
array	parsed package.xml 1.0
bool	this parameter is only here for BC. Don't use it. @access private

Definition at line 1376 of file Registry.php.

    {
        $oldinfo = $this->_packageInfo($package);
        if (empty($oldinfo)) {
            return false;
        }
 
        $fp = $this->_openPackageFile($package, 'w');
        if ($fp === null) {
            return false;
        }
 
        if (is_object($info)) {
            $info = $info->toArray();
        }
        $info['_lastmodified'] = self::getSourceDateEpoch();
 
        $newinfo = $info;
        if ($merge) {
            $info = array_merge($oldinfo, $info);
        } else {
            $diff = $info;
        }
 
        fwrite($fp, serialize($info));
        $this->_closePackageFile($fp);
        if (isset($newinfo['filelist'])) {
            $this->_rebuildFileMap();
        }
 
        return true;
    }

References _closePackageFile(), _openPackageFile(), _packageInfo(), _rebuildFileMap(), and PEAR\getSourceDateEpoch().

Referenced by updatePackage().

Here is the call graph for this function:

Here is the caller graph for this function:

_updatePackage2()

_updatePackage2

(

$info

)

Parameters

PEAR_PackageFile_v1|PEAR_PackageFile_v2

Returns

bool @access private

Definition at line 1414 of file Registry.php.

    {
        if (!$this->_packageExists($info->getPackage(), $info->getChannel())) {
            return false;
        }
 
        $fp = $this->_openPackageFile($info->getPackage(), 'w', $info->getChannel());
        if ($fp === null) {
            return false;
        }
 
        $save = $info;
        $info = $save->getArray(true);
        $info['_lastmodified'] = self::getSourceDateEpoch();
        fwrite($fp, serialize($info));
        $this->_closePackageFile($fp);
        $this->_rebuildFileMap();
        return true;
    }

References _closePackageFile(), _openPackageFile(), _packageExists(), _rebuildFileMap(), and PEAR\getSourceDateEpoch().

Referenced by updatePackage2().

Here is the call graph for this function:

Here is the caller graph for this function:

addChannel()

addChannel	(		$channel,
			$lastmodified = false,
			$update = false )

Parameters

PEAR_ChannelFile	Channel object
string	Last-Modified header from HTTP for caching

Returns

boolean|PEAR_Error True on creation, false if it already exists

Definition at line 1838 of file Registry.php.

    {
        if (!is_a($channel, 'PEAR_ChannelFile') || !$channel->validate()) {
            return false;
        }
 
        if (PEAR::isError($e = $this->_lock(LOCK_EX))) {
            return $e;
        }
 
        $ret = $this->_addChannel($channel, $update, $lastmodified);
        $this->_unlock();
        if (!$update && $ret && is_a($this->_config, 'PEAR_Config')) {
            $this->_config->setChannels($this->listChannels());
        }
 
        return $ret;
    }

References _addChannel(), _lock(), _unlock(), PEAR\isError(), and listChannels().

Referenced by updateChannel().

Here is the call graph for this function:

Here is the caller graph for this function:

addPackage()

addPackage	(		$package,
			$info )

Add an installed package to the registry

Parameters

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

Returns

bool success of saving

Definition at line 1749 of file Registry.php.

    {
        if (is_object($info)) {
            return $this->addPackage2($info);
        }
        if (PEAR::isError($e = $this->_lock(LOCK_EX))) {
            return $e;
        }
        $ret = $this->_addPackage($package, $info);
        $this->_unlock();
        if ($ret) {
            if (!class_exists('PEAR_PackageFile_v1')) {
                require_once 'PEAR/PackageFile/v1.php';
            }
            $pf = new PEAR_PackageFile_v1;
            $pf->setConfig($this->_config);
            $pf->fromArray($info);
            $this->_dependencyDB->uninstallPackage($pf);
            $this->_dependencyDB->installPackage($pf);
        }
        return $ret;
    }

References _addPackage(), _lock(), _unlock(), addPackage2(), PEAR\isError(), and PEAR_PackageFile_v1\setConfig().

Referenced by addPackage2().

Here is the call graph for this function:

Here is the caller graph for this function:

addPackage2()

addPackage2

(

$info

)

Definition at line 1775 of file Registry.php.

    {
        if (!is_object($info)) {
            return $this->addPackage($info['package'], $info);
        }
        if (PEAR::isError($e = $this->_lock(LOCK_EX))) {
            return $e;
        }
        $ret = $this->_addPackage2($info);
        $this->_unlock();
        if ($ret) {
            $this->_dependencyDB->uninstallPackage($info);
            $this->_dependencyDB->installPackage($info);
        }
        return $ret;
    }

References _addPackage2(), _lock(), _unlock(), addPackage(), and PEAR\isError().

Referenced by addPackage().

Here is the call graph for this function:

Here is the caller graph for this function:

apiVersion()

apiVersion

(

)

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

Returns

string

Definition at line 2152 of file Registry.php.

    {
        return '1.1';
    }

channelAlias()

channelAlias

(

$channel

)

Parameters

string

Definition at line 1692 of file Registry.php.

    {
        if (PEAR::isError($e = $this->_lock(LOCK_SH))) {
            return $e;
        }
        $ret = $this->_getAlias($channel);
        $this->_unlock();
        return $ret;
    }

References _getAlias(), _lock(), _unlock(), and PEAR\isError().

Referenced by parsedPackageNameToString().

Here is the call graph for this function:

Here is the caller graph for this function:

channelExists()

channelExists	(		$channel,
			$noaliases = false )

Parameters

string	channel name
bool	if true, then aliases will be ignored

Returns

bool

Definition at line 1587 of file Registry.php.

    {
        if (PEAR::isError($e = $this->_lock(LOCK_SH))) {
            return $e;
        }
        $ret = $this->_channelExists($channel, $noaliases);
        $this->_unlock();
        return $ret;
    }

References _channelExists(), _lock(), _unlock(), and PEAR\isError().

Referenced by parsePackageName().

Here is the call graph for this function:

Here is the caller graph for this function:

channelInfo()

channelInfo	(		$channel = null,
			$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 name
bool	whether to strictly retrieve information only on non-aliases

Returns

array|null|PEAR_Error

Definition at line 1664 of file Registry.php.

    {
        if (PEAR::isError($e = $this->_lock(LOCK_SH))) {
            return $e;
        }
        $ret = $this->_channelInfo($channel, $noaliases);
        $this->_unlock();
        return $ret;
    }

References _channelInfo(), _lock(), _unlock(), and PEAR\isError().

Here is the call graph for this function:

channelName()

channelName

(

$channel

)

Parameters

string

Definition at line 1679 of file Registry.php.

    {
        if (PEAR::isError($e = $this->_lock(LOCK_SH))) {
            return $e;
        }
        $ret = $this->_getChannelFromAlias($channel);
        $this->_unlock();
        return $ret;
    }

References _getChannelFromAlias(), _lock(), _unlock(), and PEAR\isError().

Here is the call graph for this function:

checkFileMap()

checkFileMap	(		$path,
			$package = false,
			$api = '1.0',
			$attrs = false )

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

If an array is passed in

Parameters

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

Returns

array|false 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

Definition at line 2065 of file Registry.php.

    {
        if (is_array($path)) {
            static $notempty;
            if (empty($notempty)) {
                if (!class_exists('PEAR_Installer_Role')) {
                    require_once 'PEAR/Installer/Role.php';
                }
                $notempty = function($a) { return !empty($a); };
            }
            $package = is_array($package) ? array(strtolower($package[0]), strtolower($package[1]))
                : strtolower($package);
            $pkgs = array();
            foreach ($path as $name => $attrs) {
                if (is_array($attrs)) {
                    if (isset($attrs['install-as'])) {
                        $name = $attrs['install-as'];
                    }
                    if (!in_array($attrs['role'], PEAR_Installer_Role::getInstallableRoles())) {
                        // these are not installed
                        continue;
                    }
                    if (!in_array($attrs['role'], PEAR_Installer_Role::getBaseinstallRoles())) {
                        $attrs['baseinstalldir'] = is_array($package) ? $package[1] : $package;
                    }
                    if (isset($attrs['baseinstalldir'])) {
                        $name = $attrs['baseinstalldir'] . DIRECTORY_SEPARATOR . $name;
                    }
                }
                $pkgs[$name] = $this->checkFileMap($name, $package, $api, $attrs);
                if (PEAR::isError($pkgs[$name])) {
                    return $pkgs[$name];
                }
            }
            return array_filter($pkgs, $notempty);
        }
        if (empty($this->filemap_cache)) {
            if (PEAR::isError($e = $this->_lock(LOCK_SH))) {
                return $e;
            }
            $err = $this->_readFileMap();
            $this->_unlock();
            if (PEAR::isError($err)) {
                return $err;
            }
        }
        if (!$attrs) {
            $attrs = array('role' => 'php'); // any old call would be for PHP role only
        }
        if (isset($this->filemap_cache[$attrs['role']][$path])) {
            if ($api >= '1.1' && $this->filemap_cache[$attrs['role']][$path] == $package) {
                return false;
            }
            return $this->filemap_cache[$attrs['role']][$path];
        }
        $l = strlen($this->install_dir);
        if (substr($path, 0, $l) == $this->install_dir) {
            $path = preg_replace('!^'.DIRECTORY_SEPARATOR.'+!', '', substr($path, $l));
        }
        if (isset($this->filemap_cache[$attrs['role']][$path])) {
            if ($api >= '1.1' && $this->filemap_cache[$attrs['role']][$path] == $package) {
                return false;
            }
            return $this->filemap_cache[$attrs['role']][$path];
        }
        return false;
    }

References _lock(), _readFileMap(), _unlock(), checkFileMap(), PEAR_Installer_Role\getBaseinstallRoles(), PEAR_Installer_Role\getInstallableRoles(), and PEAR\isError().

Referenced by checkFileMap().

Here is the call graph for this function:

Here is the caller graph for this function:

deleteChannel()

deleteChannel

(

$channel

)

Deletion fails if there are any packages installed from the channel

Parameters

string|PEAR_ChannelFile

channel name

Returns

boolean|PEAR_Error True on deletion, false if it doesn't exist

Definition at line 1815 of file Registry.php.

    {
        if (PEAR::isError($e = $this->_lock(LOCK_EX))) {
            return $e;
        }
 
        $ret = $this->_deleteChannel($channel);
        $this->_unlock();
        if ($ret && is_a($this->_config, 'PEAR_Config')) {
            $this->_config->setChannels($this->listChannels());
        }
 
        return $ret;
    }

References _deleteChannel(), _lock(), _unlock(), PEAR\isError(), and listChannels().

Here is the call graph for this function:

deletePackage()

deletePackage	(		$package,
			$channel = 'pear.php.net' )

Definition at line 1860 of file Registry.php.

    {
        if (PEAR::isError($e = $this->_lock(LOCK_EX))) {
            return $e;
        }
 
        $file = $this->_packageFileName($package, $channel);
        $ret  = file_exists($file) ? @unlink($file) : false;
        $this->_rebuildFileMap();
        $this->_unlock();
        $p = array('channel' => $channel, 'package' => $package);
        $this->_dependencyDB->uninstallPackage($p);
        return $ret;
    }

References _lock(), _packageFileName(), _rebuildFileMap(), _unlock(), and PEAR\isError().

Here is the call graph for this function:

flushFileMap()

flushFileMap

(

)

Force a reload of the filemap

Since

1.5.0RC3

Definition at line 2139 of file Registry.php.

    {
        $this->filemap_cache = null;
        clearstatcache(); // ensure that the next read gets the full, current filemap
    }

getChannel()

getChannel	(		$channel,
			$noaliases = false )

Parameters

string	channel name
bool	whether to strictly return raw channels (no aliases)

Returns

PEAR_ChannelFile|PEAR_Error

Definition at line 1936 of file Registry.php.

    {
        if (PEAR::isError($e = $this->_lock(LOCK_SH))) {
            return $e;
        }
        $ret = $this->_getChannel($channel, $noaliases);
        $this->_unlock();
        if (!$ret) {
            return PEAR::raiseError('Unknown channel: ' . $channel);
        }
        return $ret;
    }

References _getChannel(), _lock(), _unlock(), and PEAR\isError().

Referenced by getChannelValidator(), and parsePackageName().

Here is the call graph for this function:

Here is the caller graph for this function:

getChannels()

& getChannels

(

)

Parameters

string

channel name

Returns

array an array of PEAR_ChannelFile objects representing every installed channel

Definition at line 2031 of file Registry.php.

    {
        $ret = array();
        if (PEAR::isError($e = $this->_lock(LOCK_SH))) {
            return $e;
        }
        foreach ($this->_listChannels() as $channel) {
            $e = &$this->_getChannel($channel);
            if (!$e || PEAR::isError($e)) {
                continue;
            }
            $ret[] = $e;
        }
        $this->_unlock();
        return $ret;
    }

References _getChannel(), _listChannels(), _lock(), _unlock(), and PEAR\isError().

Here is the call graph for this function:

getChannelValidator()

& getChannelValidator

(

$channel

)

Parameters

string

channel name

Returns

PEAR_Validate|false

Definition at line 2016 of file Registry.php.

    {
        $chan = $this->getChannel($channel);
        if (PEAR::isError($chan)) {
            return $chan;
        }
        $val = $chan->getValidationObject();
        return $val;
    }

References getChannel(), and PEAR\isError().

Here is the call graph for this function:

getInstalledGroup()

getInstalledGroup

(

$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

Returns

array|false

Definition at line 1976 of file Registry.php.

    {
        $ret = array();
        if (isset($group['package'])) {
            if (!isset($group['package'][0])) {
                $group['package'] = array($group['package']);
            }
            foreach ($group['package'] as $package) {
                $depchannel = isset($package['channel']) ? $package['channel'] : '__uri';
                $p = &$this->getPackage($package['name'], $depchannel);
                if ($p) {
                    $save = &$p;
                    $ret[] = &$save;
                }
            }
        }
        if (isset($group['subpackage'])) {
            if (!isset($group['subpackage'][0])) {
                $group['subpackage'] = array($group['subpackage']);
            }
            foreach ($group['subpackage'] as $package) {
                $depchannel = isset($package['channel']) ? $package['channel'] : '__uri';
                $p = &$this->getPackage($package['name'], $depchannel);
                if ($p) {
                    $save = &$p;
                    $ret[] = &$save;
                }
            }
        }
        if (!count($ret)) {
            return false;
        }
        return $ret;
    }

References getPackage().

Here is the call graph for this function:

getPackage()

& getPackage	(		$package,
			$channel = 'pear.php.net' )

Parameters

string	package name
string	channel name

Returns

PEAR_PackageFile_v1|PEAR_PackageFile_v2|null

Definition at line 1956 of file Registry.php.

    {
        if (PEAR::isError($e = $this->_lock(LOCK_SH))) {
            return $e;
        }
        $pf = &$this->_getPackage($package, $channel);
        $this->_unlock();
        return $pf;
    }

References _getPackage(), _lock(), _unlock(), and PEAR\isError().

Referenced by getInstalledGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

hasWriteAccess()

hasWriteAccess

(

)

Definition at line 156 of file Registry.php.

    {
        if (!file_exists($this->install_dir)) {
            $dir = $this->install_dir;
            while ($dir && $dir != '.') {
                $olddir = $dir;
                $dir    = dirname($dir);
                if ($dir != '.' && file_exists($dir)) {
                    if (is_writeable($dir)) {
                        return true;
                    }
 
                    return false;
                }
 
                if ($dir == $olddir) { // this can happen in safe mode
                    return @is_writable($dir);
                }
            }
 
            return false;
        }
 
        return is_writeable($this->install_dir);
    }

Referenced by _addChannel(), _assertChannelDir(), _assertChannelStateDir(), _assertStateDir(), _openChannelFile(), _openPackageFile(), and _rebuildFileMap().

Here is the caller graph for this function:

isAlias()

isAlias

(

$alias

)

Determines whether the parameter is an alias of a channel

Parameters

string

Returns

bool

Definition at line 1623 of file Registry.php.

    {
        if (PEAR::isError($e = $this->_lock(LOCK_SH))) {
            return $e;
        }
        $ret = $this->_isChannelAlias($alias);
        $this->_unlock();
        return $ret;
    }

References _isChannelAlias(), _lock(), _unlock(), and PEAR\isError().

Here is the call graph for this function:

listAllPackages()

listAllPackages

(

)

Definition at line 1716 of file Registry.php.

    {
        if (PEAR::isError($e = $this->_lock(LOCK_SH))) {
            return $e;
        }
        $ret = $this->_listAllPackages();
        $this->_unlock();
        return $ret;
    }

References _listAllPackages(), _lock(), _unlock(), and PEAR\isError().

Here is the call graph for this function:

listChannels()

listChannels

(

)

Definition at line 1729 of file Registry.php.

    {
        if (PEAR::isError($e = $this->_lock(LOCK_SH))) {
            return $e;
        }
        $ret = $this->_listChannels();
        $this->_unlock();
        return $ret;
    }

References _listChannels(), _lock(), _unlock(), and PEAR\isError().

Referenced by addChannel(), and deleteChannel().

Here is the call graph for this function:

Here is the caller graph for this function:

listPackages()

listPackages

(

$channel = false

)

Definition at line 1703 of file Registry.php.

    {
        if (PEAR::isError($e = $this->_lock(LOCK_SH))) {
            return $e;
        }
        $ret = $this->_listPackages($channel);
        $this->_unlock();
        return $ret;
    }

References _listPackages(), _lock(), _unlock(), and PEAR\isError().

Here is the call graph for this function:

mirrorExists()

mirrorExists	(		$channel,
			$mirror )

Parameters

string	channel name mirror is in
string	mirror name

Returns

bool

Definition at line 1605 of file Registry.php.

    {
        if (PEAR::isError($e = $this->_lock(LOCK_SH))) {
            return $e;
        }
 
        $ret = $this->_mirrorExists($channel, $mirror);
        $this->_unlock();
        return $ret;
    }

References _lock(), _mirrorExists(), _unlock(), and PEAR\isError().

Here is the call graph for this function:

packageExists()

packageExists	(		$package,
			$channel = 'pear.php.net' )

Parameters

string	Package name
string	Channel name

Returns

bool

Definition at line 1568 of file Registry.php.

    {
        if (PEAR::isError($e = $this->_lock(LOCK_SH))) {
            return $e;
        }
        $ret = $this->_packageExists($package, $channel);
        $this->_unlock();
        return $ret;
    }

References _lock(), _packageExists(), _unlock(), and PEAR\isError().

Here is the call graph for this function:

packageInfo()

packageInfo	(		$package = null,
			$key = null,
			$channel = 'pear.php.net' )

Parameters

string|null
string|null
string

Returns

array|null

Definition at line 1642 of file Registry.php.

    {
        if (PEAR::isError($e = $this->_lock(LOCK_SH))) {
            return $e;
        }
        $ret = $this->_packageInfo($package, $key, $channel);
        $this->_unlock();
        return $ret;
    }

References _lock(), _packageInfo(), _unlock(), and PEAR\isError().

Referenced by updatePackage().

Here is the call graph for this function:

Here is the caller graph for this function:

parsedPackageNameToString()

parsedPackageNameToString	(		$parsed,
			$brief = false )

Parameters

array

Returns

string

Definition at line 2344 of file Registry.php.

    {
        if (is_string($parsed)) {
            return $parsed;
        }
        if (is_object($parsed)) {
            $p = $parsed;
            $parsed = array(
                'package' => $p->getPackage(),
                'channel' => $p->getChannel(),
                'version' => $p->getVersion(),
            );
        }
        if (isset($parsed['uri'])) {
            return $parsed['uri'];
        }
        if ($brief) {
            if ($channel = $this->channelAlias($parsed['channel'])) {
                return $channel . '/' . $parsed['package'];
            }
        }
        $upass = '';
        if (isset($parsed['user'])) {
            $upass = $parsed['user'];
            if (isset($parsed['pass'])) {
                $upass .= ':' . $parsed['pass'];
            }
            $upass = "$upass@";
        }
        $ret = 'channel://' . $upass . $parsed['channel'] . '/' . $parsed['package'];
        if (isset($parsed['version']) || isset($parsed['state'])) {
            $ver = isset($parsed['version']) ? $parsed['version'] : '';
            $ver .= isset($parsed['state']) ? $parsed['state'] : '';
            $ret .= '-' . $ver;
        }
        if (isset($parsed['extension'])) {
            $ret .= '.' . $parsed['extension'];
        }
        if (isset($parsed['opts'])) {
            $ret .= '?';
            foreach ($parsed['opts'] as $name => $value) {
                $parsed['opts'][$name] = "$name=$value";
            }
            $ret .= implode('&', $parsed['opts']);
        }
        if (isset($parsed['group'])) {
            $ret .= '#' . $parsed['group'];
        }
        return $ret;
    }

References channelAlias().

Referenced by parsePackageName().

Here is the call graph for this function:

Here is the caller graph for this function:

parsePackageName()

parsePackageName	(		$param,
			$defaultchannel = 'pear.php.net' )

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

Parameters

string|array

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]

Returns

array|PEAR_Error

Definition at line 2172 of file Registry.php.

    {
        $saveparam = $param;
        if (is_array($param)) {
            // convert to string for error messages
            $saveparam = $this->parsedPackageNameToString($param);
            // process the array
            if (!isset($param['package'])) {
                return PEAR::raiseError('parsePackageName(): array $param ' .
                    'must contain a valid package name in index "param"',
                    'package', null, null, $param);
            }
            if (!isset($param['uri'])) {
                if (!isset($param['channel'])) {
                    $param['channel'] = $defaultchannel;
                }
            } else {
                $param['channel'] = '__uri';
            }
        } else {
            $components = @parse_url((string) $param);
            if (isset($components['scheme'])) {
                if ($components['scheme'] == 'http') {
                    // uri package
                    $param = array('uri' => $param, 'channel' => '__uri');
                } elseif($components['scheme'] != 'channel') {
                    return PEAR::raiseError('parsePackageName(): only channel:// uris may ' .
                        'be downloaded, not "' . $param . '"', 'invalid', null, null, $param);
                }
            }
            if (!isset($components['path'])) {
                return PEAR::raiseError('parsePackageName(): array $param ' .
                    'must contain a valid package name in "' . $param . '"',
                    'package', null, null, $param);
            }
            if (isset($components['host'])) {
                // remove the leading "/"
                $components['path'] = substr($components['path'], 1);
            }
            if (!isset($components['scheme'])) {
                if (strpos($components['path'], '/') !== false) {
                    if ($components['path'][0] == '/') {
                        return PEAR::raiseError('parsePackageName(): this is not ' .
                            'a package name, it begins with "/" in "' . $param . '"',
                            'invalid', null, null, $param);
                    }
                    $parts = explode('/', $components['path']);
                    $components['host'] = array_shift($parts);
                    if (count($parts) > 1) {
                        $components['path'] = array_pop($parts);
                        $components['host'] .= '/' . implode('/', $parts);
                    } else {
                        $components['path'] = implode('/', $parts);
                    }
                } else {
                    $components['host'] = $defaultchannel;
                }
            } else {
                if (strpos($components['path'], '/')) {
                    $parts = explode('/', $components['path']);
                    $components['path'] = array_pop($parts);
                    $components['host'] .= '/' . implode('/', $parts);
                }
            }
 
            if (is_array($param)) {
                $param['package'] = $components['path'];
            } else {
                $param = array(
                    'package' => $components['path']
                    );
                if (isset($components['host'])) {
                    $param['channel'] = $components['host'];
                }
            }
            if (isset($components['fragment'])) {
                $param['group'] = $components['fragment'];
            }
            if (isset($components['user'])) {
                $param['user'] = $components['user'];
            }
            if (isset($components['pass'])) {
                $param['pass'] = $components['pass'];
            }
            if (isset($components['query'])) {
                parse_str($components['query'], $param['opts']);
            }
            // check for extension
            $pathinfo = pathinfo($param['package']);
            if (isset($pathinfo['extension']) &&
                  in_array(strtolower($pathinfo['extension']), array('tgz', 'tar'))) {
                $param['extension'] = $pathinfo['extension'];
                $param['package'] = substr($pathinfo['basename'], 0,
                    strlen($pathinfo['basename']) - 4);
            }
            // check for version
            if (strpos($param['package'], '-')) {
                $test = explode('-', $param['package']);
                if (count($test) != 2) {
                    return PEAR::raiseError('parsePackageName(): only one version/state ' .
                        'delimiter "-" is allowed in "' . $saveparam . '"',
                        'version', null, null, $param);
                }
                list($param['package'], $param['version']) = $test;
            }
        }
        // validation
        $info = $this->channelExists($param['channel']);
        if (PEAR::isError($info)) {
            return $info;
        }
        if (!$info) {
            return PEAR::raiseError('unknown channel "' . $param['channel'] .
                '" in "' . $saveparam . '"', 'channel', null, null, $param);
        }
        $chan = $this->getChannel($param['channel']);
        if (PEAR::isError($chan)) {
            return $chan;
        }
        if (!$chan) {
            return PEAR::raiseError("Exception: corrupt registry, could not " .
                "retrieve channel " . $param['channel'] . " information",
                'registry', null, null, $param);
        }
        $param['channel'] = $chan->getName();
        $validate = $chan->getValidationObject();
        $vpackage = $chan->getValidationPackage();
        // validate package name
        if (!$validate->validPackageName($param['package'], $vpackage['_content'])) {
            return PEAR::raiseError('parsePackageName(): invalid package name "' .
                $param['package'] . '" in "' . $saveparam . '"',
                'package', null, null, $param);
        }
        if (isset($param['group'])) {
            if (!PEAR_Validate::validGroupName($param['group'])) {
                return PEAR::raiseError('parsePackageName(): dependency group "' . $param['group'] .
                    '" is not a valid group name in "' . $saveparam . '"', 'group', null, null,
                    $param);
            }
        }
        if (isset($param['state'])) {
            if (!in_array(strtolower($param['state']), $validate->getValidStates())) {
                return PEAR::raiseError('parsePackageName(): state "' . $param['state']
                    . '" is not a valid state in "' . $saveparam . '"',
                    'state', null, null, $param);
            }
        }
        if (isset($param['version'])) {
            if (isset($param['state'])) {
                return PEAR::raiseError('parsePackageName(): cannot contain both ' .
                    'a version and a stability (state) in "' . $saveparam . '"',
                    'version/state', null, null, $param);
            }
            // check whether version is actually a state
            if (in_array(strtolower($param['version']), $validate->getValidStates())) {
                $param['state'] = strtolower($param['version']);
                unset($param['version']);
            } else {
                if (!$validate->validVersion($param['version'])) {
                    return PEAR::raiseError('parsePackageName(): "' . $param['version'] .
                        '" is neither a valid version nor a valid state in "' .
                        $saveparam . '"', 'version/state', null, null, $param);
                }
            }
        }
        return $param;
    }

References channelExists(), getChannel(), PEAR\isError(), parsedPackageNameToString(), and PEAR_Validate\validGroupName().

Here is the call graph for this function:

setConfig()

setConfig	(	&	$config,
			$resetInstallDir = true )

Definition at line 182 of file Registry.php.

    {
        $this->_config = &$config;
        if ($resetInstallDir) {
            $this->setInstallDir($config->get('php_dir'), $config->get('metadata_dir'));
        }
    }

References $config, and setInstallDir().

Here is the call graph for this function:

setInstallDir()

setInstallDir	(		$pear_install_dir = PEAR_INSTALL_DIR,
			$pear_metadata_dir = '' )

Definition at line 143 of file Registry.php.

    {
        $ds = DIRECTORY_SEPARATOR;
        $this->install_dir = $pear_install_dir;
        if (!$pear_metadata_dir) {
            $pear_metadata_dir = $pear_install_dir;
        }
        $this->channelsdir = $pear_metadata_dir.$ds.'.channels';
        $this->statedir    = $pear_metadata_dir.$ds.'.registry';
        $this->filemap     = $pear_metadata_dir.$ds.'.filemap';
        $this->lockfile    = $pear_metadata_dir.$ds.'.lock';
    }

Referenced by __construct(), and setConfig().

Here is the caller graph for this function:

updateChannel()

updateChannel	(		$channel,
			$lastmodified = null )

For future expandibility purposes, separate this

Parameters

PEAR_ChannelFile

Definition at line 1799 of file Registry.php.

    {
        if ($channel->getName() == '__uri') {
            return false;
        }
        return $this->addChannel($channel, $lastmodified, true);
    }

References addChannel().

Here is the call graph for this function:

updatePackage()

updatePackage	(		$package,
			$info,
			$merge = true )

Definition at line 1878 of file Registry.php.

    {
        if (is_object($info)) {
            return $this->updatePackage2($info, $merge);
        }
        if (PEAR::isError($e = $this->_lock(LOCK_EX))) {
            return $e;
        }
        $ret = $this->_updatePackage($package, $info, $merge);
        $this->_unlock();
        if ($ret) {
            if (!class_exists('PEAR_PackageFile_v1')) {
                require_once 'PEAR/PackageFile/v1.php';
            }
            $pf = new PEAR_PackageFile_v1;
            $pf->setConfig($this->_config);
            $pf->fromArray($this->packageInfo($package));
            $this->_dependencyDB->uninstallPackage($pf);
            $this->_dependencyDB->installPackage($pf);
        }
        return $ret;
    }

References _lock(), _unlock(), _updatePackage(), PEAR\isError(), packageInfo(), PEAR_PackageFile_v1\setConfig(), and updatePackage2().

Referenced by updatePackage2().

Here is the call graph for this function:

Here is the caller graph for this function:

updatePackage2()

updatePackage2

(

$info

)

Definition at line 1904 of file Registry.php.

    {
 
        if (!is_object($info)) {
            return $this->updatePackage($info['package'], $info, $merge);
        }
 
        if (!$info->validate(PEAR_VALIDATE_DOWNLOADING)) {
            return false;
        }
 
        if (PEAR::isError($e = $this->_lock(LOCK_EX))) {
            return $e;
        }
 
        $ret = $this->_updatePackage2($info);
        $this->_unlock();
        if ($ret) {
            $this->_dependencyDB->uninstallPackage($info);
            $this->_dependencyDB->installPackage($info);
        }
 
        return $ret;
    }

References _lock(), _unlock(), _updatePackage2(), PEAR\isError(), PEAR_VALIDATE_DOWNLOADING, and updatePackage().

Referenced by updatePackage().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$_config

$_config

Definition at line 118 of file Registry.php.

Referenced by _getPackage().

$_dependencyDB

$_dependencyDB

Definition at line 113 of file Registry.php.

$_docChannel

$_docChannel

Definition at line 108 of file Registry.php.

Referenced by _initializeChannelDirs().

$_pearChannel

$_pearChannel

Definition at line 98 of file Registry.php.

Referenced by _initializeChannelDirs().

$_peclChannel

$_peclChannel

Definition at line 103 of file Registry.php.

Referenced by _initializeChannelDirs().

$channels

$channels = ''

Definition at line 49 of file Registry.php.

Referenced by _packageInfo(), and _rebuildFileMap().

$channelsdir

$channelsdir = ''

Definition at line 64 of file Registry.php.

$filemap

$filemap = ''

Definition at line 59 of file Registry.php.

$filemap_cache

$filemap_cache = array()

Definition at line 93 of file Registry.php.

$lock_fp

$lock_fp = null

Definition at line 74 of file Registry.php.

$lock_mode

$lock_mode = 0

Definition at line 79 of file Registry.php.

$lockfile

$lockfile = ''

Definition at line 69 of file Registry.php.

$pkginfo_cache

$pkginfo_cache = array()

Definition at line 87 of file Registry.php.

$statedir

$statedir = ''

Definition at line 54 of file Registry.php.

Referenced by _channelDirectoryName().

---

The documentation for this class was generated from the following file:

• E:/Bearsampp-development/sandbox/core/libs/php/pear/pear/PEAR/Registry.php