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_Pickle
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
Pickle-init.php
Pickle.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_Downloader_Package

Source Location: /PEAR-1.4.1/PEAR/Downloader/Package.php

Class Overview




Coordinates download parameters and manages their dependencies  prior to downloading them.




Author(s):






        
          
              

Version:


    
  
  • Release: 1.4.1
    • 




Copyright:


    
  
  • 1997-2005 The PHP Group
    • 








Methods
















Inherited Variables





Inherited Methods














Class Details



[line 51]

Coordinates download parameters and manages their dependencies  prior to downloading them.
Input can come from three sources:
  • local files (archives or package.xml)
  • remote files (downloadable urls)
  • abstract package names
  The first two elements are handled cleanly by PEAR_PackageFile, but the third requires  accessing pearweb's xml-rpc interface to determine necessary dependencies, and the  format returned of dependencies is slightly different from that used in package.xml.
This class hides the differences between these elements, and makes automatic  dependency resolution a piece of cake.  It also manages conflicts when  two classes depend on incompatible dependencies, or differing versions of the same  package dependency.  In addition, download will not be attempted if the php version is  not supported, PEAR installer version is not supported, or non-PECL extensions are not  installed.









[ Top ]








Method Detail



	
	
PEAR_Downloader_Package (Constructor)   [line 122]

	

    

    

		PEAR_Downloader_Package PEAR_Downloader_Package(
PEAR_Config
&$downloader)
    

    


	
		



        
Parameters:

    

    

          

        PEAR_Config  
        &$downloader  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
alreadyValidated   [line 328]

	

    

    

		void alreadyValidated(
)
    

    


	
		



        
[ Top ]

  

  
  
	
	
canDefault   [line 791]

	

    

    

		void canDefault(
)
    

    


	
		



        
[ Top ]

  

  
  
	
	
detectDependencies   [line 298]

	

    

    

		void detectDependencies(

$params)
    

    


	
		



        
Parameters:

    

    

          

          
        $params  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
download   [line 205]

	

    

    

		PEAR_PackageFile_v1|PEAR_PackageFile_v2|PEAR_Error &download(
)
    

    


	
		Retrieve any non-local packages




        
[ Top ]

  

  
  
	
	
explicitState   [line 1139]

	

    

    

		void explicitState(
)
    

    


	
		



        
[ Top ]

  

  
  
	
	
fromDepURL   [line 263]

	

    

    

		void fromDepURL(

$dep)
    

    


	
		Like initialize(), but operates on a dependency




        
Parameters:

    

    

          

          
        $dep  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
getChannel   [line 857]

	

    

    

		void getChannel(
)
    

    


	
		



        
[ Top ]

  

  
  
	
	
getDeps   [line 926]

	

    

    

		void getDeps(
)
    

    


	
		



        
[ Top ]

  

  
  
	
	
getDownloader   [line 250]

	

    

    

		void &getDownloader(
)
    

    


	
		



        
[ Top ]

  

  
  
	
	
getDownloadURL   [line 786]

	

    

    

		void getDownloadURL(
)
    

    


	
		



        
[ Top ]

  

  
  
	
	
getGroup   [line 906]

	

    

    

		void getGroup(
)
    

    


	
		



        
[ Top ]

  

  
  
	
	
getPackage   [line 801]

	

    

    

		void getPackage(
)
    

    


	
		



        
[ Top ]

  

  
  
	
	
getPackageFile   [line 245]

	

    

    

		void &getPackageFile(
)
    

    


	
		



        
[ Top ]

  

  
  
	
	
getPackagefileObject   [line 1277]

	

    

    

		void &getPackagefileObject(
PEAR_Config
&$c, int
$d, [string
$t = false])
    

    


	
		For simpler unit-testing




        
Parameters:

    

    

          

        PEAR_Config  
        &$c  
        — 
        
      

          

        int  
        $d  
        — 
        
      

          

        string  
        $t  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
getPackageType   [line 826]

	

    

    

		void getPackageType(
)
    

    


	
		



        
[ Top ]

  

  
  
	
	
getPackageXmlVersion   [line 846]

	

    

    

		void getPackageXmlVersion(
)
    

    


	
		



        
[ Top ]

  

  
  
	
	
getParsedPackage   [line 776]

	

    

    

		void getParsedPackage(
)
    

    


	
		



        
[ Top ]

  

  
  
	
	
getShortName   [line 770]

	

    

    

		void getShortName(
)
    

    


	
		



        
[ Top ]

  

  
  
	
	
getType   [line 255]

	

    

    

		void getType(
)
    

    


	
		



        
[ Top ]

  

  
  
	
	
getURI   [line 868]

	

    

    

		void getURI(
)
    

    


	
		



        
[ Top ]

  

  
  
	
	
getVersion   [line 879]

	

    

    

		void getVersion(
)
    

    


	
		



        
[ Top ]

  

  
  
	
	
initialize   [line 139]

	

    

    

		void|PEAR_Error initialize(
string
$param)
    

    


	
		Parse the input and determine whether this is a local file, a remote uri, or an  abstract package name.
This is the heart of the PEAR_Downloader_Package(), and is used in  PEAR_Downloader::download()




        
Parameters:

    

    

          

        string  
        $param  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
isBundle   [line 837]

	

    

    

		void isBundle(
)
    

    


	
		



        
[ Top ]

  

  
  
	
	
isCompatible   [line 890]

	

    

    

		void isCompatible(

$pf)
    

    


	
		



        
Parameters:

    

    

          

          
        $pf  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
isEqual   [line 949]

	

    

    

		void isEqual(
array
$param)
    

    


	
		



        
Parameters:

    

    

          

        array  
        $param  
        — 
        Parsed array from PEAR_Registry::parsePackageName() or a dependency                      returned from getDepDownloadURL()
      

        

    


        
[ Top ]

  

  
  
	
	
isExtension   [line 915]

	

    

    

		void isExtension(

$name)
    

    


	
		



        
Parameters:

    

    

          

          
        $name  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
isInstalled   [line 1027]

	

    

    

		void isInstalled(

$dep, [
$oper = '=='])
    

    


	
		



        
Parameters:

    

    

          

          
        $dep  
        — 
        
      

          

          
        $oper  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
isSubpackage   [line 815]

	

    

    

		void isSubpackage(
PEAR_PackageFile_v1|PEAR_PackageFile_v2
&$pf)
    

    


	
		



        
Parameters:

    

    

          

        PEAR_PackageFile_v1|PEAR_PackageFile_v2  
        &$pf  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
mergeDependencies   [line 1152]

	

    

    

		void mergeDependencies(

&$params)
    

    


	
		



        
Parameters:

    

    

          

          
        &$params  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
removeDuplicates   [line 1097]

	

    

    

		void removeDuplicates(
array
&$params)
    

    


	
		



        
Parameters:

    

    

          

        array  
        &$params  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
removeInstalled   [line 338]

	

    

    

		void removeInstalled(
array
&$params)
    

    


	
		Remove packages to be downloaded that are already installed




        
Parameters:

    

    

          

        array  
        &$params  
        — 
        of PEAR_Downloader_Package objects
      

        

    


        
[ Top ]

  

  
  
	
	
setDownloadURL   [line 755]

	

    

    

		void setDownloadURL(

$pkg)
    

    


	
		



        
Parameters:

    

    

          

          
        $pkg  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
setExplicitState   [line 1144]

	

    

    

		void setExplicitState(

$s)
    

    


	
		



        
Parameters:

    

    

          

          
        $s  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
setGroup   [line 901]

	

    

    

		void setGroup(

$group)
    

    


	
		



        
Parameters:

    

    

          

          
        $group  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
setPackageFile   [line 765]

	

    

    

		void setPackageFile(

&$pkg, PEAR_PackageFile_v1|PEAR_PackageFile_v2
$pkg)
    

    


	
		Set the package.xml object for this downloaded package




        
Parameters:

    

    

          

        PEAR_PackageFile_v1|PEAR_PackageFile_v2  
        $pkg  
        — 
        
      

          

          
        &$pkg  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
setValidated   [line 323]

	

    

    

		void setValidated(
)
    

    


	
		



        
[ Top ]

  

  
  
	
	
willDownload   [line 1258]

	

    

    

		void willDownload(

$param, 
$params)
    

    


	
		



        
Parameters:

    

    

          

          
        $param  
        — 
        
      

          

          
        $params  
        — 
        
      

        

    


        
[ Top ]

  

  
  



        

		    

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