PEAR
[ class tree: PEAR ] [ index: PEAR ] [ all elements ]
Packages:
PEAR
PEAR_ErrorStack
System
XML_Util


Classes:
OS_Guess
PEAR
PEAR_Autoloader
PEAR_Builder
PEAR_ChannelFile
PEAR_ChannelFile_Parser
PEAR_Command
PEAR_Command_Auth
PEAR_Command_Build
PEAR_Command_Channels
PEAR_Command_Common
PEAR_Command_Config
PEAR_Command_Install
PEAR_Command_Mirror
PEAR_Command_Package
PEAR_Command_Registry
PEAR_Command_Remote
PEAR_Command_Test
PEAR_Common
PEAR_Config
PEAR_Dependency2
PEAR_DependencyDB
PEAR_Downloader
PEAR_Downloader_Package
PEAR_Error
PEAR_Exception
PEAR_Frontend
PEAR_Frontend_CLI
PEAR_Installer
PEAR_Installer_Role
PEAR_Installer_Role_Common
PEAR_Installer_Role_Data
PEAR_Installer_Role_Doc
PEAR_Installer_Role_Ext
PEAR_Installer_Role_Php
PEAR_Installer_Role_Script
PEAR_Installer_Role_Src
PEAR_Installer_Role_Test
PEAR_PackageFile
PEAR_PackageFile_Generator_v1
PEAR_PackageFile_Generator_v2
PEAR_PackageFile_Parser_v1
PEAR_PackageFile_Parser_v2
PEAR_PackageFile_v1
PEAR_PackageFile_v2
PEAR_PackageFile_v2_rw
PEAR_Packager
PEAR_Registry
PEAR_Remote
PEAR_REST
PEAR_REST_10
PEAR_RunTest
PEAR_Task_Common
PEAR_Task_Postinstallscript
PEAR_Task_Postinstallscript_rw
PEAR_Task_Replace
PEAR_Task_Replace_rw
PEAR_Task_Unixeol
PEAR_Task_Unixeol_rw
PEAR_Task_Windowseol
PEAR_Task_Windowseol_rw
PEAR_Validate
PEAR_Validator_PECL
PEAR_XMLParser
Files:
10.php
Auth-init.php
Auth.php
Autoloader.php
Build-init.php
Build.php
Builder.php
ChannelFile.php
Channels-init.php
Channels.php
CLI.php
Command.php
Common.php
Common.php
Common.php
Common.php
Config-init.php
Config.php
Config.php
Data.php
Dependency.php
Dependency2.php
DependencyDB.php
Doc.php
Downloader.php
Exception.php
Ext.php
Frontend.php
Guess.php
Install-init.php
Install.php
Installer.php
Mirror-init.php
Mirror.php
Package-init.php
Package.php
Package.php
PackageFile.php
Packager.php
Parser.php
PEAR.php
pearcmd.php
PECL.php
peclcmd.php
Php.php
Postinstallscript.php
Registry-init.php
Registry.php
Registry.php
Remote-init.php
Remote.php
Remote.php
Replace.php
REST.php
Role.php
RunTest.php
rw.php
rw.php
rw.php
rw.php
rw.php
Script.php
Src.php
Test-init.php
Test.php
Test.php
Unixeol.php
v1.php
v1.php
v1.php
v2.php
v2.php
v2.php
Validate.php
Validator.php
Windowseol.php
XMLParser.php

Class: PEAR_PackageFile

Source Location: /PEAR-1.4.0b1/PEAR/PackageFile.php

Class Overview




Abstraction for the package.xml package description file




Author(s):






        
          
              

Version:


    
  
  • Release: 1.4.0b1
    • 




Copyright:


    
  
  • 1997-2005 The PHP Group
    • 








Methods
















Inherited Variables





Inherited Methods














Class Details



[line 48]

Abstraction for the package.xml package description file









[ Top ]








Method Detail



	
	
PEAR_PackageFile (Constructor)   [line 55]

	

    

    

		PEAR_PackageFile PEAR_PackageFile(

&$config, [
$debug = false], [
$tmpdir = false])
    

    


	
		



        
Parameters:

    

    

          

          
        &$config  
        — 
        
      

          

          
        $debug  
        — 
        
      

          

          
        $tmpdir  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
addTempFile   [line 246]

	

    

    

		void addTempFile(
string
$file)
    

    


	
		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
      

        

    


        
[ Top ]

  

  
  
	
	
factory   [line 99]

	

    

    

		void &factory(

$version)
    

    


	
		



        
Parameters:

    

    

          

          
        $version  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
fromAnyFile   [line 360]

	

    

    

		string &fromAnyFile(

$info, 
$state)
    

    


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


    

  • Access: public
    • 








        
Parameters:

    

    

          

          
        $info  
        — 
        
      

          

          
        $state  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
fromArray   [line 120]

	

    

    

		PEAR_PackageFileManager_v1|PEAR_PackageFileManager_v2 &fromArray(
array
$arr)
    

    


	
		Return a packagefile object 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  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
fromPackageFile   [line 324]

	

    

    

		array &fromPackageFile(
string
$descfile, 
$state, [
$archive = false])
    

    


	
		Returns information about a package file.  Expects the name of  a package xml file as input.


    

  • Return: array with package information
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $descfile  
        — 
        name of package xml file
      

          

          
        $state  
        — 
        
      

          

          
        $archive  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
fromTgzFile   [line 256]

	

    

    

		bool &fromTgzFile(
string
$file, int
$state)
    

    


	
		


    

  • Return: success of parsing
    • 








        
Parameters:

    

    

          

        string  
        $file  
        — 
        contents of package.xml file
      

          

        int  
        $state  
        — 
        package state (one of PEAR_VALIDATE_* constants)
      

        

    


        
[ Top ]

  

  
  
	
	
fromXmlString   [line 151]

	

    

    

		PEAR_PackageFileManager_v1|PEAR_PackageFileManager_v2 &fromXmlString(
string
$data, int
$state, string
$file, [
$archive = false])
    

    


	
		



        
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)
      

          

          
        $archive  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
getClassPrefix   [line 94]

	

    

    

		string getClassPrefix(
)
    

    


	
		For simpler unit-testing




        
[ Top ]

  

  
  
	
	
parserFactory   [line 77]

	

    

    

		void &parserFactory(

$version)
    

    


	
		



        
Parameters:

    

    

          

          
        $version  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
rawReturn   [line 67]

	

    

    

		void rawReturn(
)
    

    


	
		Turn off validation - return a parsed package.xml without checking it
This is used by the package-validate command




        
[ Top ]

  

  
  
	
	
setLogger   [line 72]

	

    

    

		void setLogger(

&$l)
    

    


	
		



        
Parameters:

    

    

          

          
        &$l  
        — 
        
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Mon, 11 Mar 2019 14:15:33 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright ©  PHP Group 2004.