• Home
  • Components_Component_Remote

PHP Class Components_Component_Remote, 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])
Inheritance: extends Components_Component_Base
Show file Open project: horde/horde

Public Methods

Method Description
__construct ( string $name, string $stability, string $channel, Horde_Pear_Remote $remote, Horde_Http_Client $client, Components_Config $config, Components_Component_Factory $factory ) Constructor.
getChannel ( ) : string Return the channel of the component.
getData ( ) : array Return a data array with the most relevant information about this component.
getDependencies ( ) : array Return the dependencies for the component.
getName ( ) : string Return the name of the component.
getPreviousVersion ( ) : string Returns the previous version of the component.
getVersion ( ) : string Return the version of the component.
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
_getDownloadUri ( ) : string Return the download URI of the component.

Method Details

__construct() public method

Constructor.
public __construct ( string $name, string $stability, string $channel, Horde_Pear_Remote $remote, Horde_Http_Client $client, Components_Config $config, Components_Component_Factory $factory )
$name string Component name.
$stability string Component stability.
$channel string Component channel.
$remote Horde_Pear_Remote Remote channel handler.
$client Horde_Http_Client The HTTP client for remote access.
$config Components_Config The configuration for the current job.
$factory Components_Component_Factory Generator for additional helpers.

getChannel() public method

Return the channel of the component.
public getChannel ( ) : string
return string The component channel.

getData() public method

Return a data array with the most relevant information about this component.
public getData ( ) : array
return array Information about this component.

getDependencies() public method

Return the dependencies for the component.
public getDependencies ( ) : array
return array The component dependencies.

getName() public method

Return the name of the component.
public getName ( ) : string
return string The component name.

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.

getPreviousVersion() public method

Returns the previous version of the component.
public getPreviousVersion ( ) : string
return string The previous component version.

getVersion() public method

Return the version of the component.
public getVersion ( ) : string
return string The component version.

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.