Factory
in package
Components_Pear_Factory:: generates PEAR specific handlers.
Copyright 2010-2020 Horde LLC (http://www.horde.org/)
See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Tags
Table of Contents
- $_dependencies : Dependencies
- The dependency broker.
- __construct() : mixed
- Constructor.
- createEnvironment() : Environment
- Create a representation for a PEAR environment.
- createPackageForDefaultLocation() : Package
- Create a package representation for the default PEAR environment.
- createPackageForEnvironment() : Package
- Create a package representation for a specific PEAR environment.
- createPackageForPearConfig() : Package
- Create a package representation for a specific PEAR environment.
- createTgzPackageForEnvironment() : Package
- Create a package representation for a specific PEAR environment based on a *.tgz archive.
- getPackageFile() : PEAR_PackageFile_v2
- Return the PEAR Package representation.
- getPackageFileFromTgz() : PEAR_PackageFile
- Return the PEAR Package representation based on a local *.tgz archive.
- _createPackage() : Package
- Create a generic package representation for a specific PEAR environment.
Properties
$_dependencies read-only
The dependency broker.
private
Dependencies
$_dependencies
Methods
__construct()
Constructor.
public
__construct(Dependencies $_dependencies) : mixed
Parameters
- $_dependencies : Dependencies
-
The dependency broker.
Return values
mixed —createEnvironment()
Create a representation for a PEAR environment.
public
createEnvironment(string $environment, string $config_file) : Environment
Parameters
- $environment : string
-
The path to the PEAR environment.
- $config_file : string
-
The path to the configuration file.
Return values
Environment —The PEAR environment
createPackageForDefaultLocation()
Create a package representation for the default PEAR environment.
public
createPackageForDefaultLocation(string $package_file) : Package
Parameters
- $package_file : string
-
The path of the package XML file.
Return values
Package —The PEAR package.
createPackageForEnvironment()
Create a package representation for a specific PEAR environment.
public
createPackageForEnvironment(string $package_file, Environment $environment) : Package
Parameters
- $package_file : string
-
The path of the package XML file.
- $environment : Environment
-
The PEAR environment.
Return values
Package —The PEAR package.
createPackageForPearConfig()
Create a package representation for a specific PEAR environment.
public
createPackageForPearConfig(string $package_file, string $config_file) : Package
Parameters
- $package_file : string
-
The path of the package XML file.
- $config_file : string
-
The path to the configuration file.
Return values
Package —The PEAR package.
createTgzPackageForEnvironment()
Create a package representation for a specific PEAR environment based on a *.tgz archive.
public
createTgzPackageForEnvironment(string $package_file, Environment $environment) : Package
Parameters
- $package_file : string
-
The path of the package *.tgz file.
- $environment : Environment
-
The environment for the package file.
Return values
Package —The PEAR package.
getPackageFile()
Return the PEAR Package representation.
public
getPackageFile(string $package_xml_path, Environment $environment) : PEAR_PackageFile_v2
Parameters
- $package_xml_path : string
-
Path to the package.xml file.
- $environment : Environment
-
The PEAR environment.
Return values
PEAR_PackageFile_v2 —getPackageFileFromTgz()
Return the PEAR Package representation based on a local *.tgz archive.
public
getPackageFileFromTgz(string $package_tgz_path, Environment $environment) : PEAR_PackageFile
Parameters
- $package_tgz_path : string
-
Path to the *.tgz file.
- $environment : Environment
-
The PEAR environment.
Return values
PEAR_PackageFile —_createPackage()
Create a generic package representation for a specific PEAR environment.
private
_createPackage(Environment $environment) : Package
Parameters
- $environment : Environment
-
The PEAR environment.
Return values
Package —The generic PEAR package.