PHP Class Components_Component_Base, 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: implements Components_Component
Afficher le fichier Open project: horde/horde Class Usage Examples

Méthodes publiques

Méthode Description
__construct ( Components_Config $config, Components_Component_Factory $factory ) Constructor.
changed ( string $log, Components_Helper_ChangeLog $helper, array $options ) : null Update the component changelog.
currentSentinel ( string $changes, string $app, array $options ) : string Replace the current sentinel.
getChangelog ( Components_Helper_ChangeLog $helper ) : string | null Returns the link to the change log.
getChannel ( ) : string Return the channel of the component.
getData ( ) : array Return a data array with the most relevant information about this component.
getDate ( ) : string Return the last release date of the component.
getDependencies ( ) : array Return the dependencies for the component.
getDependencyList ( ) : Components_Component_DependencyList Return the dependency list for the component.
getDescription ( ) : string Return the component description.
getDocumentOrigin ( ) : string | null Return the path to a DOCS_ORIGIN file within the component.
getLeads ( ) : string Return the package lead developers.
getLicense ( ) : string Return the component license.
getLicenseLocation ( ) : string Return the component license URI.
getName ( ) : string Return the name of the component.
getNotes ( ) : string Return the package notes.
getPreviousVersion ( ) : string Returns the previous version of the component.
getReleaseNotesPath ( ) : string | boolean Return the path to the release notes.
getState ( string $key = 'release' ) : string Return the stability of the release or api.
getSummary ( ) : string Return the component summary.
getVersion ( ) : string Return the version of the component.
hasLocalPackageXml ( ) : boolean Indicate if the component has a local package.xml.
installChannel ( Components_Pear_Environment $env, array $options = [] ) : null Install the channel of this component in the environment.
nextSentinel ( string $changes, string $app, array $options ) : string Set the next sentinel.
nextVersion ( string $version, string $initial_note, string $stability_api = null, string $stability_release = null, array $options = [] ) : null Add the next version to the package.xml.
repositoryRoot ( Components_Helper_Root $helper ) : null Identify the repository root.
tag ( string $tag, string $message, Components_Helper_Commit $commit ) : null Tag the component.
timestampAndSync ( array $options ) : string Timestamp the package.xml file with the current time.
updateComposer ( array $options ) : string Updates the composer.json file.
updatePackageXml ( string $action, array $options ) : null Update the package.xml file for this component.

Méthodes protégées

Méthode Description
_hasCi ( ) : boolean Check if the library has a CI job.
createDestination ( string $destination ) : null Create the specified directory.
getBaseInstallationOptions ( array $options ) : array Derive the basic PEAR install options from the current option set.
getFactory ( ) : Components_Component_Factory Return the factory.
getOptions ( ) : array Return the application options.
getPackageXml ( ) : Horde_Pear_Package_Xml Return a PEAR package representation for the component.

Method Details

__construct() public méthode

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

_hasCi() protected méthode

Check if the library has a CI job.
protected _hasCi ( ) : boolean
Résultat boolean True if a CI job is defined.

changed() public méthode

Update the component changelog.
public changed ( string $log, Components_Helper_ChangeLog $helper, array $options ) : null
$log string The log entry.
$helper Components_Helper_ChangeLog The change log helper.
$options array Options for the operation.
Résultat null

createDestination() protected méthode

Create the specified directory.
protected createDestination ( string $destination ) : null
$destination string The destination path.
Résultat null

currentSentinel() public méthode

Replace the current sentinel.
public currentSentinel ( string $changes, string $app, array $options ) : string
$changes string New version for the CHANGES file.
$app string New version for the Application.php file.
$options array Options for the operation.
Résultat string The success message.

getBaseInstallationOptions() protected méthode

Derive the basic PEAR install options from the current option set.
protected getBaseInstallationOptions ( array $options ) : array
$options array The current options.
Résultat array The installatin options.

getChangelog() public méthode

Returns the link to the change log.
public getChangelog ( Components_Helper_ChangeLog $helper ) : string | null
$helper Components_Helper_ChangeLog The change log helper.
Résultat string | null The link to the change log.

getChannel() public méthode

Return the channel of the component.
public getChannel ( ) : string
Résultat string The component channel.

getData() public méthode

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

getDate() public méthode

Return the last release date of the component.
public getDate ( ) : string
Résultat string The date.

getDependencies() public méthode

Return the dependencies for the component.
public getDependencies ( ) : array
Résultat array The component dependencies.

getDependencyList() public méthode

Return the dependency list for the component.
public getDependencyList ( ) : Components_Component_DependencyList
Résultat Components_Component_DependencyList The dependency list.

getDescription() public méthode

Return the component description.
public getDescription ( ) : string
Résultat string The description of the component.

getDocumentOrigin() public méthode

Return the path to a DOCS_ORIGIN file within the component.
public getDocumentOrigin ( ) : string | null
Résultat string | null The path name or NULL if there is no DOCS_ORIGIN file.

getFactory() protected méthode

Return the factory.
protected getFactory ( ) : Components_Component_Factory
Résultat Components_Component_Factory The factory.

getLeads() public méthode

Return the package lead developers.
public getLeads ( ) : string
Résultat string The package lead developers.

getLicense() public méthode

Return the component license.
public getLicense ( ) : string
Résultat string The component license.

getLicenseLocation() public méthode

Return the component license URI.
public getLicenseLocation ( ) : string
Résultat string The component license URI.

getName() public méthode

Return the name of the component.
public getName ( ) : string
Résultat string The component name.

getNotes() public méthode

Return the package notes.
public getNotes ( ) : string
Résultat string The notes for the current release.

getOptions() protected méthode

Return the application options.
protected getOptions ( ) : array
Résultat array The options.

getPackageXml() protected méthode

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

getPreviousVersion() public méthode

Returns the previous version of the component.
public getPreviousVersion ( ) : string
Résultat string The previous component version.

getReleaseNotesPath() public méthode

Return the path to the release notes.
public getReleaseNotesPath ( ) : string | boolean
Résultat string | boolean The path to the release notes or false.

getState() public méthode

Return the stability of the release or api.
public getState ( string $key = 'release' ) : string
$key string "release" or "api"
Résultat string The stability.

getSummary() public méthode

Return the component summary.
public getSummary ( ) : string
Résultat string The summary of the component.

getVersion() public méthode

Return the version of the component.
public getVersion ( ) : string
Résultat string The component version.

hasLocalPackageXml() public méthode

Indicate if the component has a local package.xml.
public hasLocalPackageXml ( ) : boolean
Résultat boolean True if a package.xml exists.

installChannel() public méthode

Install the channel of this component in the environment.
public installChannel ( Components_Pear_Environment $env, array $options = [] ) : null
$env Components_Pear_Environment The environment to install into.
$options array Install options.
Résultat null

nextSentinel() public méthode

Set the next sentinel.
public nextSentinel ( string $changes, string $app, array $options ) : string
$changes string New version for the CHANGES file.
$app string New version for the Application.php file.
$options array Options for the operation.
Résultat string The success message.

nextVersion() public méthode

Add the next version to the package.xml.
public nextVersion ( string $version, string $initial_note, string $stability_api = null, string $stability_release = null, array $options = [] ) : null
$version string The new version number.
$initial_note string The text for the initial note.
$stability_api string The API stability for the next release.
$stability_release string The stability for the next release.
$options array Options for the operation.
Résultat null

repositoryRoot() public méthode

Identify the repository root.
public repositoryRoot ( Components_Helper_Root $helper ) : null
$helper Components_Helper_Root The root helper.
Résultat null

tag() public méthode

Tag the component.
public tag ( string $tag, string $message, Components_Helper_Commit $commit ) : null
$tag string Tag name.
$message string Tag message.
$commit Components_Helper_Commit The commit helper.
Résultat null

timestampAndSync() public méthode

Timestamp the package.xml file with the current time.
public timestampAndSync ( array $options ) : string
$options array Options for the operation.
Résultat string The success message.

updateComposer() public méthode

Updates the composer.json file.
public updateComposer ( array $options ) : string
$options array Options for the operation.
Résultat string The success message.

updatePackageXml() public méthode

Update the package.xml file for this component.
public updatePackageXml ( string $action, array $options ) : null
$action string The action to perform. Either "update", "diff", or "print".
$options array Options for this operation.
Résultat null