PEAR
[ class tree: PEAR ] [ index: PEAR ] [ all elements ]

Class: PEAR_Downloader_Package

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

Class Overview


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


Author(s):

Version:

  • Release: 1.4.6

Copyright:

  • 1997-2006 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 127]

PEAR_Downloader_Package PEAR_Downloader_Package( PEAR_Downloader &$downloader)


Parameters:

PEAR_Downloader   &$downloader   — 

[ Top ]

alreadyValidated   [line 341]

void alreadyValidated( )


[ Top ]

canDefault   [line 824]

void canDefault( )


[ Top ]

detectDependencies   [line 311]

void detectDependencies( $params)


Parameters:

   $params   — 

[ Top ]

download   [line 218]

PEAR_PackageFile_v1|PEAR_PackageFile_v2|PEAR_Error &download( )

Retrieve any non-local packages

[ Top ]

explicitState   [line 1172]

void explicitState( )


[ Top ]

fromDepURL   [line 276]

void fromDepURL( $dep)

Like initialize(), but operates on a dependency

Parameters:

   $dep   — 

[ Top ]

getChannel   [line 890]

void getChannel( )


[ Top ]

getDeps   [line 959]

void getDeps( )


[ Top ]

getDownloader   [line 263]

void &getDownloader( )


[ Top ]

getDownloadURL   [line 819]

void getDownloadURL( )


[ Top ]

getGroup   [line 939]

void getGroup( )


[ Top ]

getPackage   [line 834]

void getPackage( )


[ Top ]

getPackageFile   [line 258]

void &getPackageFile( )


[ Top ]

getPackagefileObject   [line 1310]

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 859]

void getPackageType( )


[ Top ]

getPackageXmlVersion   [line 879]

void getPackageXmlVersion( )


[ Top ]

getParsedPackage   [line 809]

void getParsedPackage( )


[ Top ]

getShortName   [line 803]

void getShortName( )


[ Top ]

getType   [line 268]

void getType( )


[ Top ]

getURI   [line 901]

void getURI( )


[ Top ]

getVersion   [line 912]

void getVersion( )


[ Top ]

initialize   [line 152]

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 870]

void isBundle( )


[ Top ]

isCompatible   [line 923]

void isCompatible( $pf)


Parameters:

   $pf   — 

[ Top ]

isEqual   [line 982]

void isEqual( array $param)


Parameters:

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

[ Top ]

isExtension   [line 948]

void isExtension( $name)


Parameters:

   $name   — 

[ Top ]

isInstalled   [line 1060]

void isInstalled( $dep, [ $oper = '=='])


Parameters:

   $dep   — 
   $oper   — 

[ Top ]

isSubpackage   [line 848]

void isSubpackage( PEAR_PackageFile_v1|PEAR_PackageFile_v2 &$pf)


Parameters:


[ Top ]

mergeDependencies   [line 1185]

void mergeDependencies( &$params)


Parameters:

   &$params   — 

[ Top ]

removeDuplicates   [line 1130]

void removeDuplicates( array &$params)


Parameters:

array   &$params   — 

[ Top ]

removeInstalled   [line 351]

void removeInstalled( array &$params)

Remove packages to be downloaded that are already installed

Parameters:

array   &$params   —  of PEAR_Downloader_Package objects

[ Top ]

setDownloadURL   [line 788]

void setDownloadURL( $pkg)


Parameters:

   $pkg   — 

[ Top ]

setExplicitState   [line 1177]

void setExplicitState( $s)


Parameters:

   $s   — 

[ Top ]

setGroup   [line 934]

void setGroup( $group)


Parameters:

   $group   — 

[ Top ]

setPackageFile   [line 798]

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 336]

void setValidated( )


[ Top ]

willDownload   [line 1291]

void willDownload( $param, $params)


Parameters:

   $param   — 
   $params   — 

[ Top ]


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