• Home
  • Components_Pear_Package

PHP Class Components_Pear_Package, horde

Copyright 2010-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])
Show file Open project: horde/horde

Public Methods

Method Description
__construct ( Components_Output $output ) Constructor.
getChannel ( ) : string Return the channel for the package.
getComponentDirectory ( ) : string Return the base directory of the component.
getDependencies ( ) : array Return the dependencies for the package.
getDescription ( ) : string Return the description for this package.
getEnvironment ( ) : Components_Pear_Environment Return the PEAR environment for this package.
getInstallationFilelist ( ) : array Return the list of files that should be installed for this package.
getLeads ( ) : string Return the leads for this package.
getLicense ( ) : string Return the license for this package.
getLicenseLocation ( ) : string Return the license location for this package.
getMaintainers ( ) : string Return the maintainers for this package.
getName ( ) : string Return the name for this package.
getPackageXml ( ) : string Return the path to the package.xml.
getSummary ( ) : string Return the summary for this package.
getVersion ( ) : string Return the version for this package.
setEnvironment ( Components_Pear_Environment $environment ) : null Define the surrounding PEAR environment for the package.
setFactory ( Components_Pear_Factory $factory ) : null Define the factory that creates our PEAR dependencies.
setPackageTgz ( string $package_tgz_path ) : null Define the package to work on.
setPackageXml ( string $package_xml_path ) : null Define the package to work on.

Private Methods

Method Description
_checkSetup ( ) : null Validate that the required parameters for providing the package definition are set.
_getPackageFile ( ) : PEAR_PackageFile Return the PEAR Package representation.
_getPackageXml ( ) : Horde_Pear_Package_Xml Return the package.xml handler.

Method Details

__construct() public method

Constructor.
public __construct ( Components_Output $output )
$output Components_Output The output handler.

getChannel() public method

Return the channel for the package.
public getChannel ( ) : string
return string The package channel.

getComponentDirectory() public method

Return the base directory of the component.
public getComponentDirectory ( ) : string
return string

getDependencies() public method

Return the dependencies for the package.
public getDependencies ( ) : array
return array The list of dependencies.

getDescription() public method

Return the description for this package.
public getDescription ( ) : string
return string The package description.

getEnvironment() public method

Return the PEAR environment for this package.
public getEnvironment ( ) : Components_Pear_Environment
return Components_Pear_Environment

getInstallationFilelist() public method

Return the list of files that should be installed for this package.
public getInstallationFilelist ( ) : array
return array The file list.

getLeads() public method

Return the leads for this package.
public getLeads ( ) : string
return string The package leads.

getLicense() public method

Return the license for this package.
public getLicense ( ) : string
return string The package license.

getLicenseLocation() public method

Return the license location for this package.
public getLicenseLocation ( ) : string
return string The package license location.

getMaintainers() public method

Return the maintainers for this package.
public getMaintainers ( ) : string
return string The package maintainers.

getName() public method

Return the name for this package.
public getName ( ) : string
return string The package name.

getPackageXml() public method

Return the path to the package.xml.
public getPackageXml ( ) : string
return string

getSummary() public method

Return the summary for this package.
public getSummary ( ) : string
return string The package summary.

getVersion() public method

Return the version for this package.
public getVersion ( ) : string
return string The package version.

setEnvironment() public method

Define the surrounding PEAR environment for the package.
public setEnvironment ( Components_Pear_Environment $environment ) : null
$environment Components_Pear_Environment
return null

setFactory() public method

Define the factory that creates our PEAR dependencies.
public setFactory ( Components_Pear_Factory $factory ) : null
$factory Components_Pear_Factory
return null

setPackageTgz() public method

Define the package to work on.
public setPackageTgz ( string $package_tgz_path ) : null
$package_tgz_path string Path to the *.tgz file.
return null

setPackageXml() public method

Define the package to work on.
public setPackageXml ( string $package_xml_path ) : null
$package_xml_path string Path to the package.xml file.
return null