PHP Class Components_Pear_Factory, horde

Copyright 2010-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Show file Open project: horde/horde Class Usage Examples

Public Methods

Method Description
__construct ( Components_Dependencies $dependencies ) Constructor.
createEnvironment ( string $environment, string $config_file ) : Components_Pear_Environment Create a representation for a PEAR environment.
createPackageForDefaultLocation ( string $package_file ) : Components_Pear_Package Create a package representation for the default PEAR environment.
createPackageForEnvironment ( string $package_file, Components_Pear_Environment $environment ) : Components_Pear_Package Create a package representation for a specific PEAR environment.
createPackageForPearConfig ( string $package_file, string $config_file ) : Components_Pear_Package Create a package representation for a specific PEAR environment.
createTgzPackageForEnvironment ( string $package_file, Components_Pear_Environment $environment ) : Components_Pear_Package Create a package representation for a specific PEAR environment based on a *.tgz archive.
getPackageFile ( string $package_xml_path, Components_Pear_Environment $environment ) : PEAR_PackageFile Return the PEAR Package representation.
getPackageFileFromTgz ( string $package_tgz_path, Components_Pear_Environment $environment ) : PEAR_PackageFile Return the PEAR Package representation based on a local *.tgz archive.

Private Methods

Method Description
_createPackage ( Components_Pear_Environment $environment ) : Components_Pear_Package Create a generic package representation for a specific PEAR environment.

Method Details

__construct() public method

Constructor.
public __construct ( Components_Dependencies $dependencies )
$dependencies Components_Dependencies The dependency broker.

createEnvironment() public method

Create a representation for a PEAR environment.
public createEnvironment ( string $environment, string $config_file ) : Components_Pear_Environment
$environment string The path to the PEAR environment.
$config_file string The path to the configuration file.
return Components_Pear_Environment The PEAR environment

createPackageForDefaultLocation() public method

Create a package representation for the default PEAR environment.
public createPackageForDefaultLocation ( string $package_file ) : Components_Pear_Package
$package_file string The path of the package XML file.
return Components_Pear_Package The PEAR package.

createPackageForEnvironment() public method

Create a package representation for a specific PEAR environment.
public createPackageForEnvironment ( string $package_file, Components_Pear_Environment $environment ) : Components_Pear_Package
$package_file string The path of the package XML file.
$environment Components_Pear_Environment The PEAR environment.
return Components_Pear_Package The PEAR package.

createPackageForPearConfig() public method

Create a package representation for a specific PEAR environment.
public createPackageForPearConfig ( string $package_file, string $config_file ) : Components_Pear_Package
$package_file string The path of the package XML file.
$config_file string The path to the configuration file.
return Components_Pear_Package The PEAR package.

createTgzPackageForEnvironment() public method

Create a package representation for a specific PEAR environment based on a *.tgz archive.
public createTgzPackageForEnvironment ( string $package_file, Components_Pear_Environment $environment ) : Components_Pear_Package
$package_file string The path of the package *.tgz file.
$environment Components_Pear_Environment The environment for the package file.
return Components_Pear_Package The PEAR package.

getPackageFile() public method

Return the PEAR Package representation.
public getPackageFile ( string $package_xml_path, Components_Pear_Environment $environment ) : PEAR_PackageFile
$package_xml_path string Path to the package.xml file.
$environment Components_Pear_Environment The PEAR environment.
return PEAR_PackageFile

getPackageFileFromTgz() public method

Return the PEAR Package representation based on a local *.tgz archive.
public getPackageFileFromTgz ( string $package_tgz_path, Components_Pear_Environment $environment ) : PEAR_PackageFile
$package_tgz_path string Path to the *.tgz file.
$environment Components_Pear_Environment The PEAR environment.
return PEAR_PackageFile