Package
in package
Components_Pear_Package:: provides package handling mechanisms.
Copyright 2010-2020 Horde LLC (http://www.horde.org/)
See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Tags
Table of Contents
- $_environment : mixed
- The PEAR environment for the package.
- $_factory : mixed
- The factory for PEAR class instances.
- $_output : Output
- The output handler.
- $_package_file : mixed
- The package representation.
- $_package_tgz_path : mixed
- The path to the package *.tgz file.
- $_package_xml_path : mixed
- The path to the package XML file.
- __construct() : mixed
- Constructor.
- getChannel() : string
- Return the channel for the package.
- getComponentDirectory() : string
- Return the base directory of the component.
- getDependencies() : array<string|int, mixed>
- Return the dependencies for the package.
- getDescription() : string
- Return the description for this package.
- getEnvironment() : Environment
- Return the PEAR environment for this package.
- getInstallationFilelist() : array<string|int, mixed>
- 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() : void
- Define the surrounding PEAR environment for the package.
- setFactory() : null
- Define the factory that creates our PEAR dependencies.
- setPackageTgz() : void
- Define the package to work on.
- setPackageXml() : void
- Define the package to work on.
- _checkSetup() : void
- 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.
Properties
$_environment
The PEAR environment for the package.
private
mixed
$_environment
$_factory
The factory for PEAR class instances.
private
mixed
$_factory
$_output read-only
The output handler.
private
Output
$_output
$_package_file
The package representation.
private
mixed
$_package_file
$_package_tgz_path
The path to the package *.tgz file.
private
mixed
$_package_tgz_path
$_package_xml_path
The path to the package XML file.
private
mixed
$_package_xml_path
Methods
__construct()
Constructor.
public
__construct(Output $_output) : mixed
Parameters
- $_output : Output
-
The output handler.
Return values
mixed —getChannel()
Return the channel for the package.
public
getChannel() : string
Return values
string —The package channel.
getComponentDirectory()
Return the base directory of the component.
public
getComponentDirectory() : string
Return values
string —getDependencies()
Return the dependencies for the package.
public
getDependencies() : array<string|int, mixed>
Return values
array<string|int, mixed> —The list of dependencies.
getDescription()
Return the description for this package.
public
getDescription() : string
Return values
string —The package description.
getEnvironment()
Return the PEAR environment for this package.
public
getEnvironment() : Environment
Return values
Environment —getInstallationFilelist()
Return the list of files that should be installed for this package.
public
getInstallationFilelist() : array<string|int, mixed>
Return values
array<string|int, mixed> —The file list.
getLeads()
Return the leads for this package.
public
getLeads() : string
Return values
string —The package leads.
getLicense()
Return the license for this package.
public
getLicense() : string
Return values
string —The package license.
getLicenseLocation()
Return the license location for this package.
public
getLicenseLocation() : string
Return values
string —The package license location.
getMaintainers()
Return the maintainers for this package.
public
getMaintainers() : string
Return values
string —The package maintainers.
getName()
Return the name for this package.
public
getName() : string
Return values
string —The package name.
getPackageXml()
Return the path to the package.xml.
public
getPackageXml() : string
Return values
string —getSummary()
Return the summary for this package.
public
getSummary() : string
Return values
string —The package summary.
getVersion()
Return the version for this package.
public
getVersion() : string
Return values
string —The package version.
setEnvironment()
Define the surrounding PEAR environment for the package.
public
setEnvironment(Environment $environment) : void
Parameters
- $environment : Environment
Return values
void —setFactory()
Define the factory that creates our PEAR dependencies.
public
setFactory(Factory $factory) : null
Parameters
- $factory : Factory
Return values
null —setPackageTgz()
Define the package to work on.
public
setPackageTgz(string $package_tgz_path) : void
Parameters
- $package_tgz_path : string
-
Path to the *.tgz file.
Return values
void —setPackageXml()
Define the package to work on.
public
setPackageXml(string $package_xml_path) : void
Parameters
- $package_xml_path : string
-
Path to the package.xml file.
Return values
void —_checkSetup()
Validate that the required parameters for providing the package definition are set.
private
_checkSetup() : void
Tags
Return values
void —_getPackageFile()
Return the PEAR Package representation.
private
_getPackageFile() : PEAR_PackageFile
Return values
PEAR_PackageFile —_getPackageXml()
Return the package.xml handler.
private
_getPackageXml() : Horde_Pear_Package_Xml