Factory
in package
Generates component instances and helpers.
Tags
Table of Contents
- $_client : Horde_Http_Client
- $_config : Config
- $_factory : Factory
- $_first_source : Component
- The first source component generated
- $_git_root : Root
- The git root path.
- $_notes : Notes
- $_output : Output
- $_resolver : Resolver
- The resolver instance.
- __construct() : mixed
- Constructor.
- createArchive() : Archive
- Create a representation for a component archive.
- createChangelog() : ChangeLog
- Creates a changelog helper.
- createContentList() : Horde_Pear_Package_Contents_List
- Creates a new content listing.
- createDependency() : Dependency
- Create a component dependency representation.
- createDependencyList() : DependencyList
- Create a component dependency list.
- createGitRoot() : Root
- Create the repository root helper.
- createPackageFile() : void
- Creates a new package.xml.
- createPackageXml() : Horde_Pear_Package_Xml
- Return the package.xml handler.
- createRemote() : Remote
- Create a representation for a remote component.
- createRemoteChannel() : Horde_Pear_Remote
- Create a remote PEAR server handler for a specific channel.
- createResolver() : Resolver
- Create a component resolver.
- createSentinel() : Horde_Release_Sentinel
- Create the sentinel helper.
- createSource() : Source
- Create a representation for a source component.
- createThemeContentList() : Horde_Pear_Package_Contents_List
- Creates a new content listing for a theme.
- createThemePackageFile() : void
- Creates a new package.xml for a theme.
- getGitRoot() : Root
- Return the repository root helper.
- getResolver() : Resolver
- Get the component resolver.
- pear() : Factory
- Provide access to the PEAR helper factory.
Properties
$_client
protected
Horde_Http_Client
$_client
$_config
protected
Config
$_config
$_factory
protected
Factory
$_factory
$_first_source
The first source component generated
protected
Component
$_first_source
$_git_root
The git root path.
protected
Root
$_git_root
$_notes
protected
Notes
$_notes
$_output
protected
Output
$_output
$_resolver
The resolver instance.
protected
Resolver
$_resolver
Methods
__construct()
Constructor.
public
__construct(Config $_config, Factory $_factory, Horde_Http_Client $_client, Output $_output, Notes $_notes) : mixed
Parameters
- $_config : Config
-
The configuration for the current job.
- $_factory : Factory
-
Generator for all required PEAR components.
- $_client : Horde_Http_Client
-
The HTTP client for remote access.
- $_output : Output
-
The output handler.
- $_notes : Notes
-
The release notes.
Return values
mixed —createArchive()
Create a representation for a component archive.
public
createArchive(string $archive) : Archive
Parameters
- $archive : string
-
The path to the component archive.
Return values
Archive —The archive component.
createChangelog()
Creates a changelog helper.
public
createChangelog(Source $component) : ChangeLog
Parameters
- $component : Source
-
The component.
Return values
ChangeLog —Changelog helper.
createContentList()
Creates a new content listing.
public
createContentList(string $package_xml_dir) : Horde_Pear_Package_Contents_List
Parameters
- $package_xml_dir : string
-
Path to the parent directory of the new package.xml file.
Tags
Return values
Horde_Pear_Package_Contents_List —createDependency()
Create a component dependency representation.
public
createDependency(array<string|int, mixed> $dependencies) : Dependency
Parameters
- $dependencies : array<string|int, mixed>
-
The dependency information.
Return values
Dependency —The dependency.
createDependencyList()
Create a component dependency list.
public
createDependencyList(Component $component) : DependencyList
Parameters
- $component : Component
-
The component.
Return values
DependencyList —The dependency list.
createGitRoot()
Create the repository root helper.
public
createGitRoot() : Root
Return values
Root —The helper.
createPackageFile()
Creates a new package.xml.
public
createPackageFile(string $package_xml_dir) : void
Parameters
- $package_xml_dir : string
-
Path to the parent directory of the new package.xml file.
Tags
Return values
void —createPackageXml()
Return the package.xml handler.
public
createPackageXml(string $package_xml_path) : Horde_Pear_Package_Xml
Parameters
- $package_xml_path : string
-
Path to the package.xml file.
Return values
Horde_Pear_Package_Xml —createRemote()
Create a representation for a remote component.
public
createRemote(string $name, string $stability, string $channel, Horde_Pear_Remote $remote) : Remote
Parameters
- $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 values
Remote —The remote component.
createRemoteChannel()
Create a remote PEAR server handler for a specific channel.
public
createRemoteChannel(string $channel) : Horde_Pear_Remote
Parameters
- $channel : string
-
The channel name.
Return values
Horde_Pear_Remote —The remote handler.
createResolver()
Create a component resolver.
public
createResolver() : Resolver
Return values
Resolver —The component resolver.
createSentinel()
Create the sentinel helper.
public
createSentinel(string $directory) : Horde_Release_Sentinel
Parameters
- $directory : string
-
The directory the sentinel should act in.
Return values
Horde_Release_Sentinel —The sentinel helper.
createSource()
Create a representation for a source component.
public
createSource(string $directory) : Source
Parameters
- $directory : string
-
The directory of the component.
Return values
Source —The source component.
createThemeContentList()
Creates a new content listing for a theme.
public
createThemeContentList(string $package_xml_dir) : Horde_Pear_Package_Contents_List
Parameters
- $package_xml_dir : string
-
Path to the parent directory of the new package.xml file.
Tags
Return values
Horde_Pear_Package_Contents_List —createThemePackageFile()
Creates a new package.xml for a theme.
public
createThemePackageFile(string $package_xml_dir) : void
Parameters
- $package_xml_dir : string
-
Path to the parent directory of the new package.xml file.
Tags
Return values
void —getGitRoot()
Return the repository root helper.
public
getGitRoot() : Root
Return values
Root —The helper.
getResolver()
Get the component resolver.
public
getResolver() : Resolver
Return values
Resolver —The component resolver.
pear()
Provide access to the PEAR helper factory.
public
pear() : Factory
Return values
Factory —The PEAR factory.