• Home
  • Components_Component_Archive

PHP Class Components_Component_Archive, 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.
See link: http://pear.horde.org/index.php?package=Components
Author: Gunnar Wrobel ([email protected])
Author: Fabien Potencier ([email protected])
Inheritance: extends Components_Component_Base
Show file Open project: horde/horde

Public Methods

Method Description
__construct ( $archive, Components_Config $config, Components_Component_Factory $factory ) Constructor.
install ( Components_Pear_Environment $env, array $options = [], string $reason = '' ) : null Install a component.
placeArchive ( string $destination, array $options = [] ) : array Place the component source archive at the specified location.

Protected Methods

Method Description
getPackageXml ( ) : Horde_Pear_Package_Xml Return a PEAR package representation for the component.

Private Methods

Method Description
_loadPackageFromArchive ( ) : string Return the package.xml file from the archive.

Method Details

__construct() public method

Constructor.
public __construct ( $archive, Components_Config $config, Components_Component_Factory $factory )
$config Components_Config The configuration for the current job.
$factory Components_Component_Factory Generator for additional helpers.

getPackageXml() protected method

Return a PEAR package representation for the component.
protected getPackageXml ( ) : Horde_Pear_Package_Xml
return Horde_Pear_Package_Xml The package representation.

install() public method

Install a component.
public install ( Components_Pear_Environment $env, array $options = [], string $reason = '' ) : null
$env Components_Pear_Environment The environment to install into.
$options array Install options.
$reason string Optional reason for adding the package.
return null

placeArchive() public method

Place the component source archive at the specified location.
public placeArchive ( string $destination, array $options = [] ) : array
$destination string The path to write the archive to.
$options array Options for the operation.
return array An array with at least [0] the path to the resulting archive, optionally [1] an array of error strings, and [2] PEAR output.