PHP Class Components_Component_Factory, horde

Copyright 2011-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.
Mostra file Open project: horde/horde Class Usage Examples

Public Methods

Method Description
__construct ( Components_Config $config, Components_Pear_Factory $factory, Horde_Http_Client $client ) Constructor.
createArchive ( string $archive ) : Components_Component_Archive Create a representation for a component archive.
createContentList ( string $package_xml_dir ) : Horde_Pear_Package_Contents_List Create a new content listing.
createDependency ( array $dependencies ) : Components_Component_Dependency Create a component dependency representation.
createDependencyList ( Components_Component $component ) : Components_Component_DependencyList Create a component dependency list.
createGitRoot ( ) : Components_Helper_Root Create the repository root helper.
createPackageFile ( string $package_xml_dir ) : PEAR_PackageFile Create a new PEAR Package representation.
createPackageXml ( string $package_xml_path ) : Horde_Pear_Package_Xml Return the package.xml handler.
createRemote ( string $name, string $stability, string $channel, Horde_Pear_Remote $remote ) : Components_Component_Remote Create a representation for a remote component.
createRemoteChannel ( string $channel ) : Horde_Pear_Remote Create a remote PEAR server handler for a specific channel.
createResolver ( ) : Components_Component_Resolver Create a component resolver.
createSentinel ( string $directory ) : Horde_Release_Sentinel Create the sentinel helper.
createSource ( string $directory ) : Components_Component_Source Create a representation for a source component.
getGitRoot ( ) : Components_Helper_Root Return the repository root helper.
getResolver ( ) : Components_Component_Resolver Get the component resolver.
pear ( ) : Components_Pear_Factory Provide access to the PEAR helper factory.

Method Details

__construct() public method

Constructor.
public __construct ( Components_Config $config, Components_Pear_Factory $factory, Horde_Http_Client $client )
$config Components_Config The configuration for the current job.
$factory Components_Pear_Factory Generator for all required PEAR components.
$client Horde_Http_Client The HTTP client for remote access.

createArchive() public method

Create a representation for a component archive.
public createArchive ( string $archive ) : Components_Component_Archive
$archive string The path to the component archive.
return Components_Component_Archive The archive component.

createContentList() public method

Create a new content listing.
public createContentList ( string $package_xml_dir ) : Horde_Pear_Package_Contents_List
$package_xml_dir string Path to the parent directory of the new package.xml file.
return Horde_Pear_Package_Contents_List

createDependency() public method

Create a component dependency representation.
public createDependency ( array $dependencies ) : Components_Component_Dependency
$dependencies array The dependency information.
return Components_Component_Dependency The dependency.

createDependencyList() public method

Create a component dependency list.
public createDependencyList ( Components_Component $component ) : Components_Component_DependencyList
$component Components_Component The component.
return Components_Component_DependencyList The dependency list.

createGitRoot() public method

Create the repository root helper.
public createGitRoot ( ) : Components_Helper_Root
return Components_Helper_Root The helper.

createPackageFile() public method

Create a new PEAR Package representation.
public createPackageFile ( string $package_xml_dir ) : PEAR_PackageFile
$package_xml_dir string Path to the parent directory of the new package.xml file.
return PEAR_PackageFile

createPackageXml() public method

Return the package.xml handler.
public createPackageXml ( string $package_xml_path ) : Horde_Pear_Package_Xml
$package_xml_path string Path to the package.xml file.
return Horde_Pear_Package_Xml

createRemote() public method

Create a representation for a remote component.
public createRemote ( string $name, string $stability, string $channel, Horde_Pear_Remote $remote ) : Components_Component_Remote
$name string The name of the component.
$stability string The stability of the component.
$channel string The component channel.
$remote Horde_Pear_Remote The remote server handler.
return Components_Component_Remote The remote component.

createRemoteChannel() public method

Create a remote PEAR server handler for a specific channel.
public createRemoteChannel ( string $channel ) : Horde_Pear_Remote
$channel string The channel name.
return Horde_Pear_Remote The remote handler.

createResolver() public method

Create a component resolver.
public createResolver ( ) : Components_Component_Resolver
return Components_Component_Resolver The component resolver.

createSentinel() public method

Create the sentinel helper.
public createSentinel ( string $directory ) : Horde_Release_Sentinel
$directory string The directory the sentinel should act in.
return Horde_Release_Sentinel The sentinel helper.

createSource() public method

Create a representation for a source component.
public createSource ( string $directory ) : Components_Component_Source
$directory string The directory of the component.
return Components_Component_Source The source component.

getGitRoot() public method

Return the repository root helper.
public getGitRoot ( ) : Components_Helper_Root
return Components_Helper_Root The helper.

getResolver() public method

Get the component resolver.
public getResolver ( ) : Components_Component_Resolver
return Components_Component_Resolver The component resolver.

pear() public method

Provide access to the PEAR helper factory.
public pear ( ) : Components_Pear_Factory
return Components_Pear_Factory The PEAR factory.