Public Member Functions
	__construct (&$config, $debug=false)
	_extractErrors ($err=null)
&	factory ($version)
&	fromAnyFile ($info, $state)
&	fromArray ($arr)
&	fromPackageFile ($descfile, $state, $archive=false)
&	fromTgzFile ($file, $state)
&	fromXmlString ($data, $state, $file, $archive=false)
	getClassPrefix ()
&	parserFactory ($version)
	rawReturn ()
	setLogger (&$l)

Static Public Member Functions
static	addTempFile ($file)

Data Fields
	$_config
	$_debug
	$_extractErrors = array()
	$_logger = false
	$_rawReturn = false

Detailed Description

Definition at line 41 of file PackageFile.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	&	$config,
			$debug = false )

Parameters

PEAR_Config	$config
	?	$debug
	string	@tmpdir Optional temporary directory for uncompressing files

Definition at line 69 of file PackageFile.php.

    {
        $this->_config = $config;
        $this->_debug = $debug;
    }

References $config.

Member Function Documentation

◆ _extractErrors()

_extractErrors ( $err = null )

helper callback for extracting Archive_Tar errors

Parameters

PEAR_Error | null $err

Returns: array @access private

Definition at line 388 of file PackageFile.php.

    {
        static $errors = array();
        if ($err === null) {
            $e = $errors;
            $errors = array();
            return $e;
        }
        $errors[] = $err->getMessage();
    }

Referenced by fromTgzFile().

Here is the caller graph for this function:

◆ addTempFile()

addTempFile ( $file )

static

Register a temporary file or directory. When the destructor is executed, all registered temporary files and directories are removed.

Parameters

string $file name of file or directory

Returns: void

Definition at line 286 of file PackageFile.php.

    {
        $GLOBALS['_PEAR_Common_tempfiles'][] = $file;
    }

References $GLOBALS.

Referenced by fromTgzFile().

Here is the caller graph for this function:

◆ factory()

& factory ( $version )

Create a PEAR_PackageFile_v* of a given version.

Parameters

int $version

Returns: PEAR_PackageFile_v1|PEAR_PackageFile_v1

Definition at line 123 of file PackageFile.php.

    {
        if (!in_array($version[0], array('1', '2'))) {
            $a = false;
            return $a;
        }
 
        include_once 'PEAR/PackageFile/v' . $version[0] . '.php';
        $version = $version[0];
        $class = $this->getClassPrefix() . $version;
        $a = new $class;
        return $a;
    }

References getClassPrefix().

Referenced by fromArray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fromAnyFile()

& fromAnyFile	(		$info,
			$state )

Create a PEAR_PackageFile_v* from a .tgz archive or package.xml file.

This method is able to extract information about a package from a .tgz archive or from a XML package definition file.

@access public

Parameters

string	$info	file name
int	$state	package state (one of PEAR_VALIDATE_* constants)

Returns: PEAR_PackageFile_v1|PEAR_PackageFile_v2 @uses fromPackageFile() if the file appears to be XML @uses fromTgzFile() to load all non-XML files

Definition at line 445 of file PackageFile.php.

    {
        if (is_dir($info)) {
            $dir_name = realpath($info);
            if (file_exists($dir_name . '/package.xml')) {
                $info = PEAR_PackageFile::fromPackageFile($dir_name .  '/package.xml', $state);
            } elseif (file_exists($dir_name .  '/package2.xml')) {
                $info = PEAR_PackageFile::fromPackageFile($dir_name .  '/package2.xml', $state);
            } else {
                $info = PEAR::raiseError("No package definition found in '$info' directory");
            }
 
            return $info;
        }
 
        $fp = false;
        if (is_string($info) && strlen($info) < 255 &&
             (file_exists($info) || ($fp = @fopen($info, 'r')))
        ) {
 
            if ($fp) {
                fclose($fp);
            }
 
            $tmp = substr($info, -4);
            if ($tmp == '.xml') {
                $info = &PEAR_PackageFile::fromPackageFile($info, $state);
            } elseif ($tmp == '.tar' || $tmp == '.tgz') {
                $info = &PEAR_PackageFile::fromTgzFile($info, $state);
            } else {
                $fp   = fopen($info, 'r');
                $test = fread($fp, 5);
                fclose($fp);
                if ($test == '<?xml') {
                    $info = &PEAR_PackageFile::fromPackageFile($info, $state);
                } else {
                    $info = &PEAR_PackageFile::fromTgzFile($info, $state);
                }
            }
 
            return $info;
        }
 
        $info = PEAR::raiseError("Cannot open '$info' for parsing");
        return $info;
    }

References fromPackageFile(), and fromTgzFile().

Here is the call graph for this function:

◆ fromArray()

& fromArray ( $arr )

Create a PEAR_PackageFile_v* from its toArray() method

WARNING: no validation is performed, the array is assumed to be valid, always parse from xml if you want validation.

Parameters

array $arr

Returns: PEAR_PackageFileManager_v1|PEAR_PackageFileManager_v2 @uses factory() to construct the returned object.

Definition at line 146 of file PackageFile.php.

    {
        if (isset($arr['xsdversion'])) {
            $obj = &$this->factory($arr['xsdversion']);
            if ($this->_logger) {
                $obj->setLogger($this->_logger);
            }
 
            $obj->setConfig($this->_config);
            $obj->fromArray($arr);
            return $obj;
        }
 
        if (isset($arr['package']['attribs']['version'])) {
            $obj = &$this->factory($arr['package']['attribs']['version']);
        } else {
            $obj = &$this->factory('1.0');
        }
 
        if ($this->_logger) {
            $obj->setLogger($this->_logger);
        }
 
        $obj->setConfig($this->_config);
        $obj->fromArray($arr);
        return $obj;
    }

References factory().

Here is the call graph for this function:

◆ fromPackageFile()

& fromPackageFile	(	$descfile,
		$state,
		$archive = false )

Create a PEAR_PackageFile_v* from a package.xml file.

@access public

Parameters

string	$descfile	name of package xml file
int	$state	package state (one of PEAR_VALIDATE_* constants)
string \| false	$archive	name of the archive this package.xml came from, if any

Returns: PEAR_PackageFile_v1|PEAR_PackageFile_v2 @uses PEAR_PackageFile\fromXmlString to create the oject after the XML is loaded from the package.xml file.

Definition at line 411 of file PackageFile.php.

    {
        $fp = false;
        if (is_string($descfile) && strlen($descfile) < 255 &&
             (
              !file_exists($descfile) || !is_file($descfile) || !is_readable($descfile)
              || (!$fp = @fopen($descfile, 'r'))
             )
        ) {
            $a = PEAR::raiseError("Unable to open $descfile");
            return $a;
        }
 
        // read the whole thing so we only get one cdata callback
        // for each block of cdata
        fclose($fp);
        $data = file_get_contents($descfile);
        $ret = &PEAR_PackageFile::fromXmlString($data, $state, $descfile, $archive);
        return $ret;
    }

References fromXmlString().

Referenced by fromAnyFile(), and fromTgzFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fromTgzFile()

& fromTgzFile	(		$file,
			$state )

Create a PEAR_PackageFile_v* from a compressed Tar or Tgz file. @access public

Parameters

string	contents of package.xml file
int	package state (one of PEAR_VALIDATE_* constants)

Returns: PEAR_PackageFile_v1|PEAR_PackageFile_v2 @using Archive_Tar to extract the files @using fromPackageFile() to load the package after the package.xml file is extracted.

Definition at line 301 of file PackageFile.php.

    {
        if (!class_exists('Archive_Tar')) {
            require_once 'Archive/Tar.php';
        }
 
        $tar = new Archive_Tar($file);
        if ($this->_debug <= 1) {
            $tar->pushErrorHandling(PEAR_ERROR_RETURN);
        }
 
        $content = $tar->listContent();
        if ($this->_debug <= 1) {
            $tar->popErrorHandling();
        }
 
        if (!is_array($content)) {
            if (is_string($file) && strlen($file) < 255 &&
                  (!file_exists($file) || !@is_file($file))) {
                $ret = PEAR::raiseError("could not open file \"$file\"");
                return $ret;
            }
 
            $file = realpath($file);
            $ret = PEAR::raiseError("Could not get contents of package \"$file\"".
                                     '. Invalid tgz file.');
            return $ret;
        }
 
        if (!count($content) && !@is_file($file)) {
            $ret = PEAR::raiseError("could not open file \"$file\"");
            return $ret;
        }
 
        $xml      = null;
        $origfile = $file;
        foreach ($content as $file) {
            $name = $file['filename'];
            if ($name == 'package2.xml') { // allow a .tgz to distribute both versions
                $xml = $name;
                break;
            }
 
            if ($name == 'package.xml') {
                $xml = $name;
                break;
            } elseif (preg_match('/package.xml$/', $name, $match)) {
                $xml = $name;
                break;
            }
        }
 
        $tmpdir = System::mktemp('-t "' . $this->_config->get('temp_dir') . '" -d pear');
        if ($tmpdir === false) {
            $ret = PEAR::raiseError("there was a problem with getting the configured temp directory");
            return $ret;
        }
 
        PEAR_PackageFile::addTempFile($tmpdir);
 
        $this->_extractErrors();
        PEAR::staticPushErrorHandling(PEAR_ERROR_CALLBACK, array($this, '_extractErrors'));
 
        if (!$xml || !$tar->extractList(array($xml), $tmpdir)) {
            $extra = implode("\n", $this->_extractErrors());
            if ($extra) {
                $extra = ' ' . $extra;
            }
 
            PEAR::staticPopErrorHandling();
            $ret = PEAR::raiseError('could not extract the package.xml file from "' .
                $origfile . '"' . $extra);
            return $ret;
        }
 
        PEAR::staticPopErrorHandling();
        $ret = &PEAR_PackageFile::fromPackageFile("$tmpdir/$xml", $state, $origfile);
        return $ret;
    }

References _extractErrors(), addTempFile(), fromPackageFile(), PEAR_ERROR_CALLBACK, and PEAR_ERROR_RETURN.

Referenced by fromAnyFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fromXmlString()

& fromXmlString	(	$data,
		$state,
		$file,
		$archive = false )

Create a PEAR_PackageFile_v* from an XML string. @access public

Parameters

string	$data	contents of package.xml file
int	$state	package state (one of PEAR_VALIDATE_* constants)
string	$file	full path to the package.xml file (and the files it references)
string	$archive	optional name of the archive that the XML was extracted from, if any

Returns: PEAR_PackageFile_v1|PEAR_PackageFile_v2 @uses parserFactory() to construct a parser to load the package.

Definition at line 186 of file PackageFile.php.

    {
        if (preg_match('/<package[^>]+version=[\'"]([0-9]+\.[0-9]+)[\'"]/', $data, $packageversion)) {
            if (!in_array($packageversion[1], array('1.0', '2.0', '2.1'))) {
                return PEAR::raiseError('package.xml version "' . $packageversion[1] .
                    '" is not supported, only 1.0, 2.0, and 2.1 are supported.');
            }
 
            $object = &$this->parserFactory($packageversion[1]);
            if ($this->_logger) {
                $object->setLogger($this->_logger);
            }
 
            $object->setConfig($this->_config);
            $pf = $object->parse($data, $file, $archive);
            if (PEAR::isError($pf)) {
                return $pf;
            }
 
            if ($this->_rawReturn) {
                return $pf;
            }
 
            if (!$pf->validate($state)) {;
                if ($this->_config->get('verbose') > 0
                    && $this->_logger && $pf->getValidationWarnings(false)
                ) {
                    foreach ($pf->getValidationWarnings(false) as $warning) {
                        $this->_logger->log(0, 'ERROR: ' . $warning['message']);
                    }
                }
 
                $a = PEAR::raiseError('Parsing of package.xml from file "' . $file . '" failed',
                    2, null, null, $pf->getValidationWarnings());
                return $a;
            }
 
            if ($this->_logger && $pf->getValidationWarnings(false)) {
                foreach ($pf->getValidationWarnings() as $warning) {
                    $this->_logger->log(0, 'WARNING: ' . $warning['message']);
                }
            }
 
            if (method_exists($pf, 'flattenFilelist')) {
                $pf->flattenFilelist(); // for v2
            }
 
            return $pf;
        } elseif (preg_match('/<package[^>]+version=[\'"]([^"\']+)[\'"]/', $data, $packageversion)) {
            $a = PEAR::raiseError('package.xml file "' . $file .
                '" has unsupported package.xml <package> version "' . $packageversion[1] . '"');
            return $a;
        } else {
            if (!class_exists('PEAR_ErrorStack')) {
                require_once 'PEAR/ErrorStack.php';
            }
 
            PEAR_ErrorStack::staticPush('PEAR_PackageFile',
                PEAR_PACKAGEFILE_ERROR_NO_PACKAGEVERSION,
                'warning', array('xml' => $data), 'package.xml "' . $file .
                    '" has no package.xml <package> version');
            $object = &$this->parserFactory('1.0');
            $object->setConfig($this->_config);
            $pf = $object->parse($data, $file, $archive);
            if (PEAR::isError($pf)) {
                return $pf;
            }
 
            if ($this->_rawReturn) {
                return $pf;
            }
 
            if (!$pf->validate($state)) {
                $a = PEAR::raiseError('Parsing of package.xml from file "' . $file . '" failed',
                    2, null, null, $pf->getValidationWarnings());
                return $a;
            }
 
            if ($this->_logger && $pf->getValidationWarnings(false)) {
                foreach ($pf->getValidationWarnings() as $warning) {
                    $this->_logger->log(0, 'WARNING: ' . $warning['message']);
                }
            }
 
            if (method_exists($pf, 'flattenFilelist')) {
                $pf->flattenFilelist(); // for v2
            }
 
            return $pf;
        }
    }

References parserFactory(), and PEAR_PACKAGEFILE_ERROR_NO_PACKAGEVERSION.

Referenced by fromPackageFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getClassPrefix()

getClassPrefix ( )

For simpler unit-testing

Returns: string

Definition at line 113 of file PackageFile.php.

    {
        return 'PEAR_PackageFile_v';
    }

Referenced by factory().

Here is the caller graph for this function:

◆ parserFactory()

& parserFactory ( $version )

Create a PEAR_PackageFile_Parser_v* of a given version.

Parameters

int $version

Returns: PEAR_PackageFile_Parser_v1|PEAR_PackageFile_Parser_v1

Definition at line 95 of file PackageFile.php.

    {
        if (!in_array($version[0], array('1', '2'))) {
            $a = false;
            return $a;
        }
 
        include_once 'PEAR/PackageFile/Parser/v' . $version[0] . '.php';
        $version = $version[0];
        $class = "PEAR_PackageFile_Parser_v$version";
        $a = new $class;
        return $a;
    }

Referenced by fromXmlString().

Here is the caller graph for this function:

◆ rawReturn()

rawReturn ( )

Turn off validation - return a parsed package.xml without checking it

This is used by the package-validate command

Definition at line 80 of file PackageFile.php.

    {
        $this->_rawReturn = true;
    }

◆ setLogger()

setLogger ( & $l )

Definition at line 85 of file PackageFile.php.

    {
        $this->_logger = &$l;
    }

Field Documentation

◆ $_config

$_config

Definition at line 46 of file PackageFile.php.

◆ $_debug

$_debug

Definition at line 47 of file PackageFile.php.

◆ $_extractErrors

$_extractErrors = array()

Definition at line 60 of file PackageFile.php.

◆ $_logger

$_logger = false

Definition at line 49 of file PackageFile.php.

◆ $_rawReturn

$_rawReturn = false

Definition at line 53 of file PackageFile.php.

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

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

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _extractErrors()

◆ addTempFile()

◆ factory()

◆ fromAnyFile()

◆ fromArray()

◆ fromPackageFile()

◆ fromTgzFile()

◆ fromXmlString()

◆ getClassPrefix()

◆ parserFactory()

◆ rawReturn()

◆ setLogger()

Field Documentation

◆ $_config

◆ $_debug

◆ $_extractErrors

◆ $_logger

◆ $_rawReturn