Public Member Functions
	__construct ()
	_fromArray ($data)
	_getErrorMessage ()
	_makeFunctionsXml ($functions, $indent, $rest=false)
	_makeMirrorsXml ($channelInfo)
	_makeRestXml ($info, $indent)
	_unIndent ($str)
	_validateError ($code, $params=array())
	_validateFunctions ($protocol, $functions, $parent='')
	_validateWarning ($code, $params=array())
	addFunction ($type, $version, $name='', $mirror=false)
	addMirror ($server, $port=null)
	addMirrorFunction ($mirror, $type, $version, $name='')
	fromAny ($info)
	fromXmlFile ($descfile)
	fromXmlString ($data)
	getAlias ()
	getBaseURL ($resourceType, $mirror=false)
	getErrors ($purge=false)
	getFunction ($type, $name=null, $mirror=false)
	getFunctions ($protocol, $mirror=false)
	getMirror ($server)
	getMirrors ()
	getName ()
	getPort ($mirror=false)
	getServer ()
	getSSL ($mirror=false)
	getSummary ()
&	getValidationObject ($package=false)
	getValidationPackage ()
	isIncludeable ($path)
	lastModified ()
	resetFunctions ($type, $mirror=false)
	resetREST ($mirror=false)
	setAlias ($alias, $local=false)
	setBaseURL ($resourceType, $url, $mirror=false)
	setDefaultPEARProtocols ($version='1.0', $mirror=false)
	setName ($name)
	setPort ($port, $mirror=false)
	setServer ($server, $mirror=false)
	setSSL ($ssl=true, $mirror=false)
	setSummary ($summary)
	setValidationPackage ($validateclass, $version)
	supports ($type, $name=null, $mirror=false, $version='1.0')
	supportsREST ($mirror=false)
	toArray ()
	toXml ()
	validate ()
	validChannelServer ($server)

Static Public Member Functions
static &	fromArray ( $data, $compatibility=false, $stackClass='PEAR_ErrorStack')
static &	fromArrayWithErrors ( $data, $compatibility=false, $stackClass='PEAR_ErrorStack')

Data Fields
	$_channelInfo
	$_isValid = false
	$_mirrorIndex
	$_stack
	$_subchannelIndex
	$_supportedVersions = array('1.0')

Detailed Description

Definition at line 152 of file ChannelFile.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Definition at line 196 of file ChannelFile.php.

    {
        $this->_stack = new PEAR_ErrorStack('PEAR_ChannelFile');
        $this->_stack->setErrorMessageTemplate($this->_getErrorMessage());
        $this->_isValid = false;
    }

References _getErrorMessage().

Here is the call graph for this function:

Member Function Documentation

◆ _fromArray()

_fromArray ( $data )

Parameters

array @access private

Definition at line 342 of file ChannelFile.php.

    {
        $this->_channelInfo = $data;
    }

◆ _getErrorMessage()

_getErrorMessage ( )

Returns: array @access protected

Definition at line 207 of file ChannelFile.php.

    {
        return
            array(
                PEAR_CHANNELFILE_ERROR_INVALID_VERSION =>
                    'While parsing channel.xml, an invalid version number "%version% was passed in, expecting one of %versions%',
                PEAR_CHANNELFILE_ERROR_NO_VERSION =>
                    'No version number found in <channel> tag',
                PEAR_CHANNELFILE_ERROR_NO_XML_EXT =>
                    '%error%',
                PEAR_CHANNELFILE_ERROR_CANT_MAKE_PARSER =>
                    'Unable to create XML parser',
                PEAR_CHANNELFILE_ERROR_PARSER_ERROR =>
                    '%error%',
                PEAR_CHANNELFILE_ERROR_NO_NAME =>
                    'Missing channel name',
                PEAR_CHANNELFILE_ERROR_INVALID_NAME =>
                    'Invalid channel %tag% "%name%"',
                PEAR_CHANNELFILE_ERROR_NO_SUMMARY =>
                    'Missing channel summary',
                PEAR_CHANNELFILE_ERROR_MULTILINE_SUMMARY =>
                    'Channel summary should be on one line, but is multi-line',
                PEAR_CHANNELFILE_ERROR_NO_HOST =>
                    'Missing channel server for %type% server',
                PEAR_CHANNELFILE_ERROR_INVALID_HOST =>
                    'Server name "%server%" is invalid for %type% server',
                PEAR_CHANNELFILE_ERROR_INVALID_MIRROR =>
                    'Invalid mirror name "%name%", mirror type %type%',
                PEAR_CHANNELFILE_ERROR_INVALID_MIRRORTYPE =>
                    'Invalid mirror type "%type%"',
                PEAR_CHANNELFILE_ERROR_INVALID =>
                    'Cannot generate xml, contents are invalid',
                PEAR_CHANNELFILE_ERROR_EMPTY_REGEX =>
                    'packagenameregex cannot be empty',
                PEAR_CHANNELFILE_ERROR_NO_FUNCTIONVERSION =>
                    '%parent% %protocol% function has no version',
                PEAR_CHANNELFILE_ERROR_NO_FUNCTIONNAME =>
                    '%parent% %protocol% function has no name',
                PEAR_CHANNELFILE_ERROR_NOBASEURLTYPE =>
                    '%parent% rest baseurl has no type',
                PEAR_CHANNELFILE_ERROR_NOVALIDATE_NAME =>
                    'Validation package has no name in <validatepackage> tag',
                PEAR_CHANNELFILE_ERROR_NOVALIDATE_VERSION =>
                    'Validation package "%package%" has no version',
                PEAR_CHANNELFILE_ERROR_MIRROR_NOT_FOUND =>
                    'Mirror "%mirror%" does not exist',
                PEAR_CHANNELFILE_ERROR_INVALID_PORT =>
                    'Port "%port%" must be numeric',
                PEAR_CHANNELFILE_ERROR_NO_STATICVERSION =>
                    '<static> tag must contain version attribute',
                PEAR_CHANNELFILE_URI_CANT_MIRROR =>
                    'The __uri pseudo-channel cannot have mirrors',
                PEAR_CHANNELFILE_ERROR_INVALID_SSL =>
                    '%server% has invalid ssl attribute "%ssl%" can only be yes or not present',
            );
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ _makeFunctionsXml()

_makeFunctionsXml	(	$functions,
		$indent,
		$rest = false )

Generate the <functions> tag @access private

Definition at line 551 of file ChannelFile.php.

    {
        $ret = '';
        if (!isset($functions[0])) {
            $functions = array($functions);
        }
        foreach ($functions as $function) {
            $ret .= "$indent<function version=\"" . $function['attribs']['version'] . "\"";
            if ($rest) {
                $ret .= ' uri="' . $function['attribs']['uri'] . '"';
            }
            $ret .= ">" . $function['_content'] . "</function>\n";
        }
        return $ret;
    }

◆ _makeMirrorsXml()

_makeMirrorsXml ( $channelInfo )

Generate the <mirrors> tag @access private

Definition at line 520 of file ChannelFile.php.

    {
        $ret = "";
        if (!isset($channelInfo['servers']['mirror'][0])) {
            $channelInfo['servers']['mirror'] = array($channelInfo['servers']['mirror']);
        }
        foreach ($channelInfo['servers']['mirror'] as $mirror) {
            $ret .= '  <mirror host="' . $mirror['attribs']['host'] . '"';
            if (isset($mirror['attribs']['port'])) {
                $ret .= ' port="' . $mirror['attribs']['port'] . '"';
            }
            if (isset($mirror['attribs']['ssl'])) {
                $ret .= ' ssl="' . $mirror['attribs']['ssl'] . '"';
            }
            $ret .= ">\n";
            if (isset($mirror['rest'])) {
                if (isset($mirror['rest'])) {
                    $ret .= $this->_makeRestXml($mirror['rest'], '   ');
                }
                $ret .= "  </mirror>\n";
            } else {
                $ret .= "/>\n";
            }
        }
        return $ret;
    }

References _makeRestXml().

Referenced by toXml().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _makeRestXml()

_makeRestXml	(		$info,
			$indent )

Generate the <rest> tag @access private

Definition at line 499 of file ChannelFile.php.

    {
        $ret = $indent . "<rest>\n";
        if (isset($info['baseurl']) && !isset($info['baseurl'][0])) {
            $info['baseurl'] = array($info['baseurl']);
        }
 
        if (isset($info['baseurl'])) {
            foreach ($info['baseurl'] as $url) {
                $ret .= "$indent <baseurl type=\"" . $url['attribs']['type'] . "\"";
                $ret .= ">" . $url['_content'] . "</baseurl>\n";
            }
        }
        $ret .= $indent . "</rest>\n";
        return $ret;
    }

Referenced by _makeMirrorsXml(), and toXml().

Here is the caller graph for this function:

◆ _unIndent()

_unIndent ( $str )

Unindent given string (?)

Parameters

string $str The string that has to be unindented.

Returns: string @access private

Definition at line 364 of file ChannelFile.php.

    {
        // remove leading newlines
        $str = preg_replace('/^[\r\n]+/', '', $str);
        // find whitespace at the beginning of the first line
        $indent_len = strspn($str, " \t");
        $indent = substr($str, 0, $indent_len);
        $data = '';
        // remove the same amount of whitespace from following lines
        foreach (explode("\n", $str) as $line) {
            if (substr($line, 0, $indent_len) == $indent) {
                $data .= substr($line, $indent_len) . "\n";
            }
        }
        return $data;
    }

◆ _validateError()

_validateError	(		$code,
			$params = array() )

Validation error. Also marks the object contents as invalid

Parameters

error	code
array	error information @access private

Definition at line 573 of file ChannelFile.php.

    {
        $this->_stack->push($code, 'error', $params);
        $this->_isValid = false;
    }

Referenced by _validateFunctions(), addMirrorFunction(), setAlias(), setBaseURL(), setPort(), setServer(), setSSL(), setSummary(), toXml(), and validate().

Here is the caller graph for this function:

◆ _validateFunctions()

_validateFunctions	(	$protocol,
		$functions,
		$parent = '' )

Parameters

string	rest - protocol name this function applies to
array	the functions
string	the name of the parent element (mirror name, for instance)

Definition at line 689 of file ChannelFile.php.

    {
        if (!isset($functions[0])) {
            $functions = array($functions);
        }
 
        foreach ($functions as $function) {
            if (!isset($function['_content']) || empty($function['_content'])) {
                $this->_validateError(PEAR_CHANNELFILE_ERROR_NO_FUNCTIONNAME,
                    array('parent' => $parent, 'protocol' => $protocol));
            }
 
            if ($protocol == 'rest') {
                if (!isset($function['attribs']['type']) ||
                      empty($function['attribs']['type'])) {
                    $this->_validateError(PEAR_CHANNELFILE_ERROR_NOBASEURLTYPE,
                        array('parent' => $parent, 'protocol' => $protocol));
                }
            } else {
                if (!isset($function['attribs']['version']) ||
                      empty($function['attribs']['version'])) {
                    $this->_validateError(PEAR_CHANNELFILE_ERROR_NO_FUNCTIONVERSION,
                        array('parent' => $parent, 'protocol' => $protocol));
                }
            }
        }
    }

References _validateError(), PEAR_CHANNELFILE_ERROR_NO_FUNCTIONNAME, PEAR_CHANNELFILE_ERROR_NO_FUNCTIONVERSION, and PEAR_CHANNELFILE_ERROR_NOBASEURLTYPE.

Referenced by validate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _validateWarning()

_validateWarning	(		$code,
			$params = array() )

Validation warning. Does not mark the object contents invalid.

Parameters

error	code
array	error information @access private

Definition at line 585 of file ChannelFile.php.

    {
        $this->_stack->push($code, 'warning', $params);
    }

Referenced by setSummary(), and validate().

Here is the caller graph for this function:

◆ addFunction()

addFunction	(	$type,
		$version,
		$name = '',
		$mirror = false )

Add a protocol to the provides section

Parameters

string	protocol type
string	protocol version
string	protocol name, if any
string	mirror name, if this is a mirror's protocol

Returns: bool

Definition at line 1302 of file ChannelFile.php.

    {
        if ($mirror) {
            return $this->addMirrorFunction($mirror, $type, $version, $name);
        }
 
        $set = array('attribs' => array('version' => $version), '_content' => $name);
        if (!isset($this->_channelInfo['servers']['primary'][$type]['function'])) {
            if (!isset($this->_channelInfo['servers'])) {
                $this->_channelInfo['servers'] = array('primary' =>
                    array($type => array()));
            } elseif (!isset($this->_channelInfo['servers']['primary'])) {
                $this->_channelInfo['servers']['primary'] = array($type => array());
            }
 
            $this->_channelInfo['servers']['primary'][$type]['function'] = $set;
            $this->_isValid = false;
            return true;
        } elseif (!isset($this->_channelInfo['servers']['primary'][$type]['function'][0])) {
            $this->_channelInfo['servers']['primary'][$type]['function'] = array(
                $this->_channelInfo['servers']['primary'][$type]['function']);
        }
 
        $this->_channelInfo['servers']['primary'][$type]['function'][] = $set;
        return true;
    }

References addMirrorFunction().

Here is the call graph for this function:

◆ addMirror()

addMirror	(		$server,
			$port = null )

Parameters

string	mirror server
int	mirror http port

Returns: boolean

Definition at line 1439 of file ChannelFile.php.

    {
        if ($this->_channelInfo['name'] == '__uri') {
            return false; // the __uri channel cannot have mirrors by definition
        }
 
        $set = array('attribs' => array('host' => $server));
        if (is_numeric($port)) {
            $set['attribs']['port'] = $port;
        }
 
        if (!isset($this->_channelInfo['servers']['mirror'])) {
            $this->_channelInfo['servers']['mirror'] = $set;
            return true;
        }
 
        if (!isset($this->_channelInfo['servers']['mirror'][0])) {
            $this->_channelInfo['servers']['mirror'] =
                array($this->_channelInfo['servers']['mirror']);
        }
 
        $this->_channelInfo['servers']['mirror'][] = $set;
        return true;
    }

References $port.

◆ addMirrorFunction()

addMirrorFunction	(	$mirror,
		$type,
		$version,
		$name = '' )

Add a protocol to a mirror's provides section

Parameters

string	mirror name (server)
string	protocol type
string	protocol version
string	protocol name, if any

Definition at line 1335 of file ChannelFile.php.

    {
        if (!isset($this->_channelInfo['servers']['mirror'])) {
            $this->_validateError(PEAR_CHANNELFILE_ERROR_MIRROR_NOT_FOUND,
                array('mirror' => $mirror));
            return false;
        }
 
        $setmirror = false;
        if (isset($this->_channelInfo['servers']['mirror'][0])) {
            foreach ($this->_channelInfo['servers']['mirror'] as $i => $mir) {
                if ($mirror == $mir['attribs']['host']) {
                    $setmirror = &$this->_channelInfo['servers']['mirror'][$i];
                    break;
                }
            }
        } else {
            if ($this->_channelInfo['servers']['mirror']['attribs']['host'] == $mirror) {
                $setmirror = &$this->_channelInfo['servers']['mirror'];
            }
        }
 
        if (!$setmirror) {
            $this->_validateError(PEAR_CHANNELFILE_ERROR_MIRROR_NOT_FOUND,
                array('mirror' => $mirror));
            return false;
        }
 
        $set = array('attribs' => array('version' => $version), '_content' => $name);
        if (!isset($setmirror[$type]['function'])) {
            $setmirror[$type]['function'] = $set;
            $this->_isValid = false;
            return true;
        } elseif (!isset($setmirror[$type]['function'][0])) {
            $setmirror[$type]['function'] = array($setmirror[$type]['function']);
        }
 
        $setmirror[$type]['function'][] = $set;
        $this->_isValid = false;
        return true;
    }

References _validateError(), and PEAR_CHANNELFILE_ERROR_MIRROR_NOT_FOUND.

Referenced by addFunction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fromAny()

fromAny ( $info )

Parse channel information from different sources

This method is able to extract information about a channel from an .xml file or a string

@access public

Parameters

string Filename of the source or the source itself

Returns: bool

Definition at line 413 of file ChannelFile.php.

    {
        if (is_string($info) && file_exists($info) && strlen($info) < 255) {
            $tmp = substr($info, -4);
            if ($tmp == '.xml') {
                $info = $this->fromXmlFile($info);
            } else {
                $fp = fopen($info, "r");
                $test = fread($fp, 5);
                fclose($fp);
                if ($test == "<?xml") {
                    $info = $this->fromXmlFile($info);
                }
            }
            if (PEAR::isError($info)) {
                require_once 'PEAR.php';
                return PEAR::raiseError($info);
            }
        }
        if (is_string($info)) {
            $info = $this->fromXmlString($info);
        }
        return $info;
    }

References fromXmlFile(), and fromXmlString().

Here is the call graph for this function:

◆ fromArray()

& fromArray	(	$data,
		$compatibility = false,
		$stackClass = 'PEAR_ErrorStack' )

static

Parameters

array

Returns: PEAR_ChannelFile|false false if invalid

Definition at line 311 of file ChannelFile.php.

      {
        $a = new PEAR_ChannelFile($compatibility, $stackClass);
        $a->_fromArray($data);
        if (!$a->validate()) {
            $a = false;
            return $a;
        }
        return $a;
    }

Referenced by PEAR_ChannelFile_Parser\parse().

Here is the caller graph for this function:

◆ fromArrayWithErrors()

& fromArrayWithErrors	(	$data,
		$compatibility = false,
		$stackClass = 'PEAR_ErrorStack' )

static

Unlike fromArray() this does not do any validation

Parameters

array

Returns: PEAR_ChannelFile

Definition at line 330 of file ChannelFile.php.

      {
        $a = new PEAR_ChannelFile($compatibility, $stackClass);
        $a->_fromArray($data);
        return $a;
    }

Referenced by PEAR_Registry\_getChannel().

Here is the caller graph for this function:

◆ fromXmlFile()

fromXmlFile ( $descfile )

Parse a channel.xml file. Expects the name of a channel xml file as input.

Parameters

string $descfile name of channel xml file

Returns: bool success of parsing

Definition at line 388 of file ChannelFile.php.

    {
        if (!file_exists($descfile) || !is_file($descfile) || !is_readable($descfile) ||
             (!$fp = fopen($descfile, 'r'))) {
            require_once 'PEAR.php';
            return PEAR::raiseError("Unable to open $descfile");
        }
 
        // read the whole thing so we only get one cdata callback
        // for each block of cdata
        fclose($fp);
        $data = file_get_contents($descfile);
        return $this->fromXmlString($data);
    }

References fromXmlString().

Referenced by fromAny().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fromXmlString()

fromXmlString ( $data )

Parameters

string contents of package.xml file

Returns: bool success of parsing

Definition at line 268 of file ChannelFile.php.

    {
        if (preg_match('/<channel\s+version="([0-9]+\.[0-9]+)"/', $data, $channelversion)) {
            if (!in_array($channelversion[1], $this->_supportedVersions)) {
                $this->_stack->push(PEAR_CHANNELFILE_ERROR_INVALID_VERSION, 'error',
                    array('version' => $channelversion[1]));
                return false;
            }
            $parser = new PEAR_XMLParser;
            $result = $parser->parse($data);
            if ($result !== true) {
                if ($result->getCode() == 1) {
                    $this->_stack->push(PEAR_CHANNELFILE_ERROR_NO_XML_EXT, 'error',
                        array('error' => $result->getMessage()));
                } else {
                    $this->_stack->push(PEAR_CHANNELFILE_ERROR_CANT_MAKE_PARSER, 'error');
                }
                return false;
            }
            $this->_channelInfo = $parser->getData();
            return true;
        } else {
            $this->_stack->push(PEAR_CHANNELFILE_ERROR_NO_VERSION, 'error', array('xml' => $data));
            return false;
        }
    }

References $result, PEAR_CHANNELFILE_ERROR_CANT_MAKE_PARSER, PEAR_CHANNELFILE_ERROR_INVALID_VERSION, PEAR_CHANNELFILE_ERROR_NO_VERSION, and PEAR_CHANNELFILE_ERROR_NO_XML_EXT.

Referenced by PEAR_Command_Channels\doInfo(), PEAR_Command_Channels\doUpdate(), fromAny(), and fromXmlFile().

Here is the caller graph for this function:

◆ getAlias()

getAlias ( )

Returns: string

Definition at line 1264 of file ChannelFile.php.

    {
        if (isset($this->_channelInfo['localalias'])) {
            return $this->_channelInfo['localalias'];
        }
        if (isset($this->_channelInfo['suggestedalias'])) {
            return $this->_channelInfo['suggestedalias'];
        }
        if (isset($this->_channelInfo['name'])) {
            return $this->_channelInfo['name'];
        }
        return '';
    }

◆ getBaseURL()

getBaseURL	(		$resourceType,
			$mirror = false )

Get the URL to access a base resource.

Hyperlinks in the returned xml will be used to retrieve the proper information needed. This allows extreme extensibility and flexibility in implementation

Parameters

string Resource Type to retrieve

Definition at line 943 of file ChannelFile.php.

    {
        if ($mirror == $this->_channelInfo['name']) {
            $mirror = false;
        }
 
        if ($mirror) {
            $mir = $this->getMirror($mirror);
            if (!$mir) {
                return false;
            }
 
            $rest = $mir['rest'];
        } else {
            $rest = $this->_channelInfo['servers']['primary']['rest'];
        }
 
        if (!isset($rest['baseurl'][0])) {
            $rest['baseurl'] = array($rest['baseurl']);
        }
 
        foreach ($rest['baseurl'] as $baseurl) {
            if (strtolower($baseurl['attribs']['type']) == strtolower($resourceType)) {
                return $baseurl['_content'];
            }
        }
 
        return false;
    }

References getMirror().

Here is the call graph for this function:

◆ getErrors()

getErrors ( $purge = false )

Wrapper to PEAR_ErrorStack::getErrors()

Parameters

boolean determines whether to purge the error stack after retrieving

Returns: array

Definition at line 352 of file ChannelFile.php.

    {
        return $this->_stack->getErrors($purge);
    }

◆ getFunction()

getFunction	(	$type,
		$name = null,
		$mirror = false )

Parameters

string	Protocol type
string	Function name (null to return the first protocol of the type requested)
string	Mirror name, if any

Returns: array

Definition at line 858 of file ChannelFile.php.

     {
        $protocols = $this->getFunctions($type, $mirror);
        if (!$protocols) {
            return false;
        }
 
        foreach ($protocols as $protocol) {
            if ($name === null) {
                return $protocol;
            }
 
            if ($protocol['_content'] != $name) {
                continue;
            }
 
            return $protocol;
        }
 
        return false;
     }

References getFunctions().

Here is the call graph for this function:

◆ getFunctions()

getFunctions	(		$protocol,
			$mirror = false )

Parameters

string	protocol type
string	Mirror name

Returns: array|false

Definition at line 827 of file ChannelFile.php.

    {
        if ($this->getName() == '__uri') {
            return false;
        }
 
        $function = $protocol == 'rest' ? 'baseurl' : 'function';
        if ($mirror) {
            if ($mir = $this->getMirror($mirror)) {
                if (isset($mir[$protocol][$function])) {
                    return $mir[$protocol][$function];
                }
            }
 
            return false;
        }
 
        if (isset($this->_channelInfo['servers']['primary'][$protocol][$function])) {
            return $this->_channelInfo['servers']['primary'][$protocol][$function];
        }
 
        return false;
    }

References getMirror(), and getName().

Referenced by getFunction(), and supports().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMirror()

getMirror ( $server )

Get the unserialized XML representing a mirror

Returns: array|false

Definition at line 1065 of file ChannelFile.php.

    {
        foreach ($this->getMirrors() as $mirror) {
            if ($mirror['attribs']['host'] == $server) {
                return $mirror;
            }
        }
 
        return false;
    }

References getMirrors().

Referenced by getBaseURL(), getFunctions(), getPort(), getSSL(), and supportsREST().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMirrors()

getMirrors ( )

Returns: array

Definition at line 1047 of file ChannelFile.php.

    {
        if (isset($this->_channelInfo['servers']['mirror'])) {
            $mirrors = $this->_channelInfo['servers']['mirror'];
            if (!isset($mirrors[0])) {
                $mirrors = array($mirrors);
            }
 
            return $mirrors;
        }
 
        return array();
    }

Referenced by getMirror().

Here is the caller graph for this function:

◆ getName()

getName ( )

Returns: string|false

Definition at line 733 of file ChannelFile.php.

    {
        if (isset($this->_channelInfo['name'])) {
            return $this->_channelInfo['name'];
        }
 
        return false;
    }

Referenced by getFunctions().

Here is the caller graph for this function:

◆ getPort()

getPort ( $mirror = false )

Returns: int|80 port number to connect to

Definition at line 757 of file ChannelFile.php.

    {
        if ($mirror) {
            if ($mir = $this->getMirror($mirror)) {
                if (isset($mir['attribs']['port'])) {
                    return $mir['attribs']['port'];
                }
 
                if ($this->getSSL($mirror)) {
                    return 443;
                }
 
                return 80;
            }
 
            return false;
        }
 
        if (isset($this->_channelInfo['servers']['primary']['attribs']['port'])) {
            return $this->_channelInfo['servers']['primary']['attribs']['port'];
        }
 
        if ($this->getSSL()) {
            return 443;
        }
 
        return 80;
    }

References getMirror(), and getSSL().

Here is the call graph for this function:

◆ getServer()

getServer ( )

Returns: string|false

Definition at line 745 of file ChannelFile.php.

    {
        if (isset($this->_channelInfo['name'])) {
            return $this->_channelInfo['name'];
        }
 
        return false;
    }

◆ getSSL()

getSSL ( $mirror = false )

Returns: bool Determines whether secure sockets layer (SSL) is used to connect to this channel

Definition at line 789 of file ChannelFile.php.

    {
        if ($mirror) {
            if ($mir = $this->getMirror($mirror)) {
                if (isset($mir['attribs']['ssl'])) {
                    return true;
                }
 
                return false;
            }
 
            return false;
        }
 
        if (isset($this->_channelInfo['servers']['primary']['attribs']['ssl'])) {
            return true;
        }
 
        return false;
    }

References getMirror().

Referenced by getPort().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSummary()

getSummary ( )

Returns: string|false

Definition at line 813 of file ChannelFile.php.

    {
        if (isset($this->_channelInfo['summary'])) {
            return $this->_channelInfo['summary'];
        }
 
        return false;
    }

◆ getValidationObject()

& getValidationObject ( $package = false )

Retrieve the object that can be used for custom validation

Parameters

string|false the name of the package to validate. If the package is the channel validation package, PEAR_Validate is returned

Returns: PEAR_Validate|false false is returned if the validation package cannot be located

Definition at line 1489 of file ChannelFile.php.

    {
        if (!class_exists('PEAR_Validate')) {
            require_once 'PEAR/Validate.php';
        }
 
        if (!$this->_isValid) {
            if (!$this->validate()) {
                $a = false;
                return $a;
            }
        }
 
        if (isset($this->_channelInfo['validatepackage'])) {
            if ($package == $this->_channelInfo['validatepackage']) {
                // channel validation packages are always validated by PEAR_Validate
                $val = new PEAR_Validate;
                return $val;
            }
 
            if (!class_exists(str_replace('.', '_',
                  $this->_channelInfo['validatepackage']['_content']))) {
                if ($this->isIncludeable(str_replace('_', '/',
                      $this->_channelInfo['validatepackage']['_content']) . '.php')) {
                    include_once str_replace('_', '/',
                        $this->_channelInfo['validatepackage']['_content']) . '.php';
                    $vclass = str_replace('.', '_',
                        $this->_channelInfo['validatepackage']['_content']);
                    $val = new $vclass;
                } else {
                    $a = false;
                    return $a;
                }
            } else {
                $vclass = str_replace('.', '_',
                    $this->_channelInfo['validatepackage']['_content']);
                $val = new $vclass;
            }
        } else {
            $val = new PEAR_Validate;
        }
 
        return $val;
    }

References isIncludeable(), and validate().

Here is the call graph for this function:

◆ getValidationPackage()

getValidationPackage ( )

Retrieve the name of the validation package for this channel

Returns: string|false

Definition at line 1468 of file ChannelFile.php.

    {
        if (!$this->_isValid && !$this->validate()) {
            return false;
        }
 
        if (!isset($this->_channelInfo['validatepackage'])) {
            return array('attribs' => array('version' => 'default'),
                '_content' => 'PEAR_Validate');
        }
 
        return $this->_channelInfo['validatepackage'];
    }

References validate().

Here is the call graph for this function:

◆ isIncludeable()

isIncludeable ( $path )

Definition at line 1534 of file ChannelFile.php.

    {
        $possibilities = explode(PATH_SEPARATOR, ini_get('include_path'));
        foreach ($possibilities as $dir) {
            if (file_exists($dir . DIRECTORY_SEPARATOR . $path)
                  && is_readable($dir . DIRECTORY_SEPARATOR . $path)) {
                return true;
            }
        }
 
        return false;
    }

Referenced by getValidationObject().

Here is the caller graph for this function:

◆ lastModified()

lastModified ( )

This function is used by the channel updater and retrieves a value set by the registry, or the current time if it has not been set

Returns: string

Definition at line 1552 of file ChannelFile.php.

    {
        if (isset($this->_channelInfo['_lastmodified'])) {
            return $this->_channelInfo['_lastmodified'];
        }
 
        return time();
    }

◆ resetFunctions()

resetFunctions	(		$type,
			$mirror = false )

Empty all protocol definitions

Parameters

string	protocol type
string\|false	mirror name, if any

Definition at line 988 of file ChannelFile.php.

    {
        if ($mirror) {
            if (isset($this->_channelInfo['servers']['mirror'])) {
                $mirrors = $this->_channelInfo['servers']['mirror'];
                if (!isset($mirrors[0])) {
                    $mirrors = array($mirrors);
                }
 
                foreach ($mirrors as $i => $mir) {
                    if ($mir['attribs']['host'] == $mirror) {
                        if (isset($this->_channelInfo['servers']['mirror'][$i][$type])) {
                            unset($this->_channelInfo['servers']['mirror'][$i][$type]);
                        }
 
                        return true;
                    }
                }
 
                return false;
            }
 
            return false;
        }
 
        if (isset($this->_channelInfo['servers']['primary'][$type])) {
            unset($this->_channelInfo['servers']['primary'][$type]);
        }
 
        return true;
    }

Referenced by resetREST().

Here is the caller graph for this function:

◆ resetREST()

resetREST ( $mirror = false )

Since REST does not implement RPC, provide this as a logical wrapper around resetFunctions for REST

Parameters

string|false mirror name, if any

Definition at line 978 of file ChannelFile.php.

    {
        return $this->resetFunctions('rest', $mirror);
    }

References resetFunctions().

Referenced by setDefaultPEARProtocols().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAlias()

setAlias	(		$alias,
			$local = false )

Parameters

string
boolean	determines whether the alias is in channel.xml or local

Returns: boolean success

Definition at line 1244 of file ChannelFile.php.

    {
        if (!$this->validChannelServer($alias)) {
            $this->_validateError(PEAR_CHANNELFILE_ERROR_INVALID_NAME,
                array('tag' => 'suggestedalias', 'name' => $alias));
            return false;
        }
 
        if ($local) {
            $this->_channelInfo['localalias'] = $alias;
        } else {
            $this->_channelInfo['suggestedalias'] = $alias;
        }
 
        return true;
    }

References _validateError(), PEAR_CHANNELFILE_ERROR_INVALID_NAME, and validChannelServer().

Referenced by PEAR_Registry\_initializeChannelDirs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setBaseURL()

setBaseURL	(	$resourceType,
		$url,
		$mirror = false )

Parameters

string	Resource Type this url links to
string	URL
string\|false	mirror name, if this is not a primary server REST base URL

Definition at line 1382 of file ChannelFile.php.

    {
        if ($mirror) {
            if (!isset($this->_channelInfo['servers']['mirror'])) {
                $this->_validateError(PEAR_CHANNELFILE_ERROR_MIRROR_NOT_FOUND,
                    array('mirror' => $mirror));
                return false;
            }
 
            $setmirror = false;
            if (isset($this->_channelInfo['servers']['mirror'][0])) {
                foreach ($this->_channelInfo['servers']['mirror'] as $i => $mir) {
                    if ($mirror == $mir['attribs']['host']) {
                        $setmirror = &$this->_channelInfo['servers']['mirror'][$i];
                        break;
                    }
                }
            } else {
                if ($this->_channelInfo['servers']['mirror']['attribs']['host'] == $mirror) {
                    $setmirror = &$this->_channelInfo['servers']['mirror'];
                }
            }
        } else {
            $setmirror = &$this->_channelInfo['servers']['primary'];
        }
 
        $set = array('attribs' => array('type' => $resourceType), '_content' => $url);
        if (!isset($setmirror['rest'])) {
            $setmirror['rest'] = array();
        }
 
        if (!isset($setmirror['rest']['baseurl'])) {
            $setmirror['rest']['baseurl'] = $set;
            $this->_isValid = false;
            return true;
        } elseif (!isset($setmirror['rest']['baseurl'][0])) {
            $setmirror['rest']['baseurl'] = array($setmirror['rest']['baseurl']);
        }
 
        foreach ($setmirror['rest']['baseurl'] as $i => $url) {
            if ($url['attribs']['type'] == $resourceType) {
                $this->_isValid = false;
                $setmirror['rest']['baseurl'][$i] = $set;
                return true;
            }
        }
 
        $setmirror['rest']['baseurl'][] = $set;
        $this->_isValid = false;
        return true;
    }

References _validateError(), and PEAR_CHANNELFILE_ERROR_MIRROR_NOT_FOUND.

Here is the call graph for this function:

◆ setDefaultPEARProtocols()

setDefaultPEARProtocols	(		$version = '1.0',
			$mirror = false )

Set a channel's protocols to the protocols supported by pearweb

Definition at line 1023 of file ChannelFile.php.

    {
        switch ($version) {
            case '1.0' :
                $this->resetREST($mirror);
 
                if (!isset($this->_channelInfo['servers'])) {
                    $this->_channelInfo['servers'] = array('primary' =>
                        array('rest' => array()));
                } elseif (!isset($this->_channelInfo['servers']['primary'])) {
                    $this->_channelInfo['servers']['primary'] = array('rest' => array());
                }
 
                return true;
            break;
            default :
                return false;
            break;
        }
    }

References resetREST().

Here is the call graph for this function:

◆ setName()

setName ( $name )

Parameters

string

Returns: string|false @error PEAR_CHANNELFILE_ERROR_NO_NAME @error PEAR_CHANNELFILE_ERROR_INVALID_NAME

Definition at line 1082 of file ChannelFile.php.

    {
        return $this->setServer($name);
    }

References setServer().

Referenced by PEAR_Registry\_getChannel(), and PEAR_Registry\_initializeChannelDirs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPort()

setPort	(		$port,
			$mirror = false )

Set the socket number (port) that is used to connect to this channel

Parameters

integer
string\|false	name of the mirror server, or false for the primary

Definition at line 1092 of file ChannelFile.php.

    {
        if ($mirror) {
            if (!isset($this->_channelInfo['servers']['mirror'])) {
                $this->_validateError(PEAR_CHANNELFILE_ERROR_MIRROR_NOT_FOUND,
                    array('mirror' => $mirror));
                return false;
            }
 
            if (isset($this->_channelInfo['servers']['mirror'][0])) {
                foreach ($this->_channelInfo['servers']['mirror'] as $i => $mir) {
                    if ($mirror == $mir['attribs']['host']) {
                        $this->_channelInfo['servers']['mirror'][$i]['attribs']['port'] = $port;
                        return true;
                    }
                }
 
                return false;
            } elseif ($this->_channelInfo['servers']['mirror']['attribs']['host'] == $mirror) {
                $this->_channelInfo['servers']['mirror']['attribs']['port'] = $port;
                $this->_isValid = false;
                return true;
            }
        }
 
        $this->_channelInfo['servers']['primary']['attribs']['port'] = $port;
        $this->_isValid = false;
        return true;
    }

References $port, _validateError(), and PEAR_CHANNELFILE_ERROR_MIRROR_NOT_FOUND.

Here is the call graph for this function:

◆ setServer()

setServer	(		$server,
			$mirror = false )

Parameters

string

Returns: string|false @error PEAR_CHANNELFILE_ERROR_NO_SERVER @error PEAR_CHANNELFILE_ERROR_INVALID_SERVER

Definition at line 1185 of file ChannelFile.php.

    {
        if (empty($server)) {
            $this->_validateError(PEAR_CHANNELFILE_ERROR_NO_SERVER);
            return false;
        } elseif (!$this->validChannelServer($server)) {
            $this->_validateError(PEAR_CHANNELFILE_ERROR_INVALID_NAME,
                array('tag' => 'name', 'name' => $server));
            return false;
        }
 
        if ($mirror) {
            $found = false;
            foreach ($this->_channelInfo['servers']['mirror'] as $i => $mir) {
                if ($mirror == $mir['attribs']['host']) {
                    $found = true;
                    break;
                }
            }
 
            if (!$found) {
                $this->_validateError(PEAR_CHANNELFILE_ERROR_MIRROR_NOT_FOUND,
                    array('mirror' => $mirror));
                return false;
            }
 
            $this->_channelInfo['mirror'][$i]['attribs']['host'] = $server;
            return true;
        }
 
        $this->_channelInfo['name'] = $server;
        return true;
    }

References _validateError(), PEAR_CHANNELFILE_ERROR_INVALID_NAME, PEAR_CHANNELFILE_ERROR_MIRROR_NOT_FOUND, and validChannelServer().

Referenced by PEAR_Registry\_getChannel(), and setName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSSL()

setSSL	(		$ssl = true,
			$mirror = false )

Set the socket number (port) that is used to connect to this channel

Parameters

bool	Determines whether to turn on SSL support or turn it off
string\|false	name of the mirror server, or false for the primary

Definition at line 1127 of file ChannelFile.php.

    {
        if ($mirror) {
            if (!isset($this->_channelInfo['servers']['mirror'])) {
                $this->_validateError(PEAR_CHANNELFILE_ERROR_MIRROR_NOT_FOUND,
                    array('mirror' => $mirror));
                return false;
            }
 
            if (isset($this->_channelInfo['servers']['mirror'][0])) {
                foreach ($this->_channelInfo['servers']['mirror'] as $i => $mir) {
                    if ($mirror == $mir['attribs']['host']) {
                        if (!$ssl) {
                            if (isset($this->_channelInfo['servers']['mirror'][$i]
                                  ['attribs']['ssl'])) {
                                unset($this->_channelInfo['servers']['mirror'][$i]['attribs']['ssl']);
                            }
                        } else {
                            $this->_channelInfo['servers']['mirror'][$i]['attribs']['ssl'] = 'yes';
                        }
 
                        return true;
                    }
                }
 
                return false;
            } elseif ($this->_channelInfo['servers']['mirror']['attribs']['host'] == $mirror) {
                if (!$ssl) {
                    if (isset($this->_channelInfo['servers']['mirror']['attribs']['ssl'])) {
                        unset($this->_channelInfo['servers']['mirror']['attribs']['ssl']);
                    }
                } else {
                    $this->_channelInfo['servers']['mirror']['attribs']['ssl'] = 'yes';
                }
 
                $this->_isValid = false;
                return true;
            }
        }
 
        if ($ssl) {
            $this->_channelInfo['servers']['primary']['attribs']['ssl'] = 'yes';
        } else {
            if (isset($this->_channelInfo['servers']['primary']['attribs']['ssl'])) {
                unset($this->_channelInfo['servers']['primary']['attribs']['ssl']);
            }
        }
 
        $this->_isValid = false;
        return true;
    }

References _validateError(), and PEAR_CHANNELFILE_ERROR_MIRROR_NOT_FOUND.

Here is the call graph for this function:

◆ setSummary()

setSummary ( $summary )

Parameters

string

Returns: boolean success @error PEAR_CHANNELFILE_ERROR_NO_SUMMARY

Warning: PEAR_CHANNELFILE_ERROR_MULTILINE_SUMMARY

Definition at line 1225 of file ChannelFile.php.

    {
        if (empty($summary)) {
            $this->_validateError(PEAR_CHANNELFILE_ERROR_NO_SUMMARY);
            return false;
        } elseif (strpos(trim($summary), "\n") !== false) {
            $this->_validateWarning(PEAR_CHANNELFILE_ERROR_MULTILINE_SUMMARY,
                array('summary' => $summary));
        }
 
        $this->_channelInfo['summary'] = $summary;
        return true;
    }

References _validateError(), _validateWarning(), PEAR_CHANNELFILE_ERROR_MULTILINE_SUMMARY, and PEAR_CHANNELFILE_ERROR_NO_SUMMARY.

Here is the call graph for this function:

◆ setValidationPackage()

setValidationPackage	(		$validateclass,
			$version )

Set the package validation object if it differs from PEAR's default The class must be includeable via changing _ in the classname to path separator, but no checking of this is made.

Parameters

string|false pass in false to reset to the default packagename regex

Returns: boolean success

Definition at line 1285 of file ChannelFile.php.

    {
        if (empty($validateclass)) {
            unset($this->_channelInfo['validatepackage']);
        }
        $this->_channelInfo['validatepackage'] = array('_content' => $validateclass);
        $this->_channelInfo['validatepackage']['attribs'] = array('version' => $version);
    }

◆ supports()

supports	(	$type,
		$name = null,
		$mirror = false,
		$version = '1.0' )

Parameters

string	protocol type
string	protocol name
string	version
string	mirror name

Returns: boolean

Definition at line 887 of file ChannelFile.php.

    {
        $protocols = $this->getFunctions($type, $mirror);
        if (!$protocols) {
            return false;
        }
 
        foreach ($protocols as $protocol) {
            if ($protocol['attribs']['version'] != $version) {
                continue;
            }
 
            if ($name === null) {
                return true;
            }
 
            if ($protocol['_content'] != $name) {
                continue;
            }
 
            return true;
        }
 
        return false;
    }

References getFunctions().

Here is the call graph for this function:

◆ supportsREST()

supportsREST ( $mirror = false )

Determines whether a channel supports Representational State Transfer (REST) protocols for retrieving channel information

Parameters

string

Returns: bool

Definition at line 919 of file ChannelFile.php.

    {
        if ($mirror == $this->_channelInfo['name']) {
            $mirror = false;
        }
 
        if ($mirror) {
            if ($mir = $this->getMirror($mirror)) {
                return isset($mir['rest']);
            }
 
            return false;
        }
 
        return isset($this->_channelInfo['servers']['primary']['rest']);
    }

References getMirror().

Here is the call graph for this function:

◆ toArray()

toArray ( )

Returns: array

Definition at line 298 of file ChannelFile.php.

    {
        if (!$this->_isValid && !$this->validate()) {
            return false;
        }
        return $this->_channelInfo;
    }

References $_channelInfo, and validate().

Here is the call graph for this function:

◆ toXml()

toXml ( )

Return an XML document based on previous parsing and modifications

Returns: string XML data

@access public

Definition at line 445 of file ChannelFile.php.

    {
        if (!$this->_isValid && !$this->validate()) {
            $this->_validateError(PEAR_CHANNELFILE_ERROR_INVALID);
            return false;
        }
        if (!isset($this->_channelInfo['attribs']['version'])) {
            $this->_channelInfo['attribs']['version'] = '1.0';
        }
        $channelInfo = $this->_channelInfo;
        $ret = "<?xml version=\"1.0\" encoding=\"ISO-8859-1\" ?>\n";
        $ret .= "<channel version=\"" .
            $channelInfo['attribs']['version'] . "\" xmlns=\"http://pear.php.net/channel-1.0\"
  xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"
  xsi:schemaLocation=\"http://pear.php.net/dtd/channel-"
            . $channelInfo['attribs']['version'] . " http://pear.php.net/dtd/channel-" .
            $channelInfo['attribs']['version'] . ".xsd\">
 <name>$channelInfo[name]</name>
 <summary>" . htmlspecialchars($channelInfo['summary'])."</summary>
";
        if (isset($channelInfo['suggestedalias'])) {
            $ret .= ' <suggestedalias>' . $channelInfo['suggestedalias'] . "</suggestedalias>\n";
        }
        if (isset($channelInfo['validatepackage'])) {
            $ret .= ' <validatepackage version="' .
                $channelInfo['validatepackage']['attribs']['version']. '">' .
                htmlspecialchars($channelInfo['validatepackage']['_content']) .
                "</validatepackage>\n";
        }
        $ret .= " <servers>\n";
        $ret .= '  <primary';
        if (isset($channelInfo['servers']['primary']['attribs']['ssl'])) {
            $ret .= ' ssl="' . $channelInfo['servers']['primary']['attribs']['ssl'] . '"';
        }
        if (isset($channelInfo['servers']['primary']['attribs']['port'])) {
            $ret .= ' port="' . $channelInfo['servers']['primary']['attribs']['port'] . '"';
        }
        $ret .= ">\n";
        if (isset($channelInfo['servers']['primary']['rest'])) {
            $ret .= $this->_makeRestXml($channelInfo['servers']['primary']['rest'], '   ');
        }
        $ret .= "  </primary>\n";
        if (isset($channelInfo['servers']['mirror'])) {
            $ret .= $this->_makeMirrorsXml($channelInfo);
        }
        $ret .= " </servers>\n";
        $ret .= "</channel>";
        return str_replace("\r", "\n", str_replace("\r\n", "\n", $ret));
    }

References $_channelInfo, _makeMirrorsXml(), _makeRestXml(), _validateError(), PEAR_CHANNELFILE_ERROR_INVALID, and validate().

Here is the call graph for this function:

◆ validate()

validate ( )

Validate parsed file.

@access public

Returns: boolean

Definition at line 596 of file ChannelFile.php.

    {
        $this->_isValid = true;
        $info = $this->_channelInfo;
        if (empty($info['name'])) {
            $this->_validateError(PEAR_CHANNELFILE_ERROR_NO_NAME);
        } elseif (!$this->validChannelServer($info['name'])) {
            if ($info['name'] != '__uri') {
                $this->_validateError(PEAR_CHANNELFILE_ERROR_INVALID_NAME, array('tag' => 'name',
                    'name' => $info['name']));
            }
        }
        if (empty($info['summary'])) {
            $this->_validateError(PEAR_CHANNELFILE_ERROR_NO_SUMMARY);
        } elseif (strpos(trim($info['summary']), "\n") !== false) {
            $this->_validateWarning(PEAR_CHANNELFILE_ERROR_MULTILINE_SUMMARY,
                array('summary' => $info['summary']));
        }
        if (isset($info['suggestedalias'])) {
            if (!$this->validChannelServer($info['suggestedalias'])) {
                $this->_validateError(PEAR_CHANNELFILE_ERROR_INVALID_NAME,
                    array('tag' => 'suggestedalias', 'name' =>$info['suggestedalias']));
            }
        }
        if (isset($info['localalias'])) {
            if (!$this->validChannelServer($info['localalias'])) {
                $this->_validateError(PEAR_CHANNELFILE_ERROR_INVALID_NAME,
                    array('tag' => 'localalias', 'name' =>$info['localalias']));
            }
        }
        if (isset($info['validatepackage'])) {
            if (!isset($info['validatepackage']['_content'])) {
                $this->_validateError(PEAR_CHANNELFILE_ERROR_NOVALIDATE_NAME);
            }
            if (!isset($info['validatepackage']['attribs']['version'])) {
                $content = isset($info['validatepackage']['_content']) ?
                    $info['validatepackage']['_content'] :
                    null;
                $this->_validateError(PEAR_CHANNELFILE_ERROR_NOVALIDATE_VERSION,
                    array('package' => $content));
            }
        }
 
        if (isset($info['servers']['primary']['attribs'], $info['servers']['primary']['attribs']['port']) &&
              !is_numeric($info['servers']['primary']['attribs']['port'])) {
            $this->_validateError(PEAR_CHANNELFILE_ERROR_INVALID_PORT,
                array('port' => $info['servers']['primary']['attribs']['port']));
        }
 
        if (isset($info['servers']['primary']['attribs'], $info['servers']['primary']['attribs']['ssl']) &&
              $info['servers']['primary']['attribs']['ssl'] != 'yes') {
            $this->_validateError(PEAR_CHANNELFILE_ERROR_INVALID_SSL,
                array('ssl' => $info['servers']['primary']['attribs']['ssl'],
                    'server' => $info['name']));
        }
 
        if (isset($info['servers']['primary']['rest']) &&
              isset($info['servers']['primary']['rest']['baseurl'])) {
            $this->_validateFunctions('rest', $info['servers']['primary']['rest']['baseurl']);
        }
        if (isset($info['servers']['mirror'])) {
            if ($this->_channelInfo['name'] == '__uri') {
                $this->_validateError(PEAR_CHANNELFILE_URI_CANT_MIRROR);
            }
            if (!isset($info['servers']['mirror'][0])) {
                $info['servers']['mirror'] = array($info['servers']['mirror']);
            }
            foreach ($info['servers']['mirror'] as $mirror) {
                if (!isset($mirror['attribs']['host'])) {
                    $this->_validateError(PEAR_CHANNELFILE_ERROR_NO_HOST,
                      array('type' => 'mirror'));
                } elseif (!$this->validChannelServer($mirror['attribs']['host'])) {
                    $this->_validateError(PEAR_CHANNELFILE_ERROR_INVALID_HOST,
                        array('server' => $mirror['attribs']['host'], 'type' => 'mirror'));
                }
                if (isset($mirror['attribs']['ssl']) && $mirror['attribs']['ssl'] != 'yes') {
                    $this->_validateError(PEAR_CHANNELFILE_ERROR_INVALID_SSL,
                        array('ssl' => $info['ssl'], 'server' => $mirror['attribs']['host']));
                }
                if (isset($mirror['rest'])) {
                    $this->_validateFunctions('rest', $mirror['rest']['baseurl'],
                        $mirror['attribs']['host']);
                }
            }
        }
        return $this->_isValid;
    }

References $_channelInfo, $_isValid, _validateError(), _validateFunctions(), _validateWarning(), PEAR_CHANNELFILE_ERROR_INVALID_HOST, PEAR_CHANNELFILE_ERROR_INVALID_NAME, PEAR_CHANNELFILE_ERROR_INVALID_PORT, PEAR_CHANNELFILE_ERROR_INVALID_SSL, PEAR_CHANNELFILE_ERROR_MULTILINE_SUMMARY, PEAR_CHANNELFILE_ERROR_NO_HOST, PEAR_CHANNELFILE_ERROR_NO_NAME, PEAR_CHANNELFILE_ERROR_NO_SUMMARY, PEAR_CHANNELFILE_ERROR_NOVALIDATE_NAME, PEAR_CHANNELFILE_ERROR_NOVALIDATE_VERSION, PEAR_CHANNELFILE_URI_CANT_MIRROR, and validChannelServer().

Referenced by getValidationObject(), getValidationPackage(), toArray(), and toXml().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validChannelServer()

validChannelServer ( $server )

Test whether a string contains a valid channel server.

Parameters

string $ver the package version to test

Returns: bool

Definition at line 722 of file ChannelFile.php.

    {
        if ($server == '__uri') {
            return true;
        }
        return (bool) preg_match(PEAR_CHANNELS_SERVER_PREG, $server);
    }

References PEAR_CHANNELS_SERVER_PREG.

Referenced by setAlias(), setServer(), and validate().

Here is the caller graph for this function:

Field Documentation

◆ $_channelInfo

$_channelInfo

Definition at line 173 of file ChannelFile.php.

Referenced by toArray(), toXml(), and validate().

◆ $_isValid

$_isValid = false

Definition at line 194 of file ChannelFile.php.

Referenced by validate().

◆ $_mirrorIndex

$_mirrorIndex

Definition at line 187 of file ChannelFile.php.

◆ $_stack

$_stack

Definition at line 159 of file ChannelFile.php.

◆ $_subchannelIndex

$_subchannelIndex

Definition at line 180 of file ChannelFile.php.

◆ $_supportedVersions

$_supportedVersions = array('1.0')

Definition at line 166 of file ChannelFile.php.

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

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

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _fromArray()

◆ _getErrorMessage()

◆ _makeFunctionsXml()

◆ _makeMirrorsXml()

◆ _makeRestXml()

◆ _unIndent()

◆ _validateError()

◆ _validateFunctions()

◆ _validateWarning()

◆ addFunction()

◆ addMirror()

◆ addMirrorFunction()

◆ fromAny()

◆ fromArray()

◆ fromArrayWithErrors()

◆ fromXmlFile()

◆ fromXmlString()

◆ getAlias()

◆ getBaseURL()

◆ getErrors()

◆ getFunction()

◆ getFunctions()

◆ getMirror()

◆ getMirrors()

◆ getName()

◆ getPort()

◆ getServer()

◆ getSSL()

◆ getSummary()

◆ getValidationObject()

◆ getValidationPackage()

◆ isIncludeable()

◆ lastModified()

◆ resetFunctions()

◆ resetREST()

◆ setAlias()

◆ setBaseURL()

◆ setDefaultPEARProtocols()

◆ setName()

◆ setPort()

◆ setServer()

◆ setSSL()

◆ setSummary()

◆ setValidationPackage()

◆ supports()

◆ supportsREST()

◆ toArray()

◆ toXml()

◆ validate()

◆ validChannelServer()

Field Documentation

◆ $_channelInfo

◆ $_isValid

◆ $_mirrorIndex

◆ $_stack

◆ $_subchannelIndex

◆ $_supportedVersions