Method | Description | |
---|---|---|
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 component lead developers. | |
getLicense ( ) : string | Return the component license. | |
getLicenseLocation ( ) : string | Return the component license URI. | |
getName ( ) : string | Return the name of the component. | |
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. | |
install ( Components_Pear_Environment $env, array $options = [], string $reason = '' ) : null | Install a component. | |
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. | |
placeArchive ( string $destination, array $options = [] ) : array | Place the component source archive at the specified location. | |
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. |
public getChangelog ( Components_Helper_ChangeLog $helper ) : string | null | ||
$helper | Components_Helper_ChangeLog | The change log helper. |
return | string | null | The link to the change log. |
public getChannel ( ) : string | ||
return | string | The component channel. |
public getDependencies ( ) : array | ||
return | array | The component dependencies. |
public getDependencyList ( ) : Components_Component_DependencyList | ||
return | Components_Component_DependencyList | The dependency list. |
public getDescription ( ) : string | ||
return | string | The description of the component. |
public getDocumentOrigin ( ) : string | null | ||
return | string | null | The path name or NULL if there is no DOCS_ORIGIN file. |
public getLicense ( ) : string | ||
return | string | The component license. |
public getLicenseLocation ( ) : string | ||
return | string | The component license URI. |
public getPreviousVersion ( ) : string | ||
return | string | The previous component version. |
public getReleaseNotesPath ( ) : string | boolean | ||
return | string | boolean | The path to the release notes or false. |
public getSummary ( ) : string | ||
return | string | The summary of the component. |
public getVersion ( ) : string | ||
return | string | The component version. |
public hasLocalPackageXml ( ) : boolean | ||
return | boolean | True if a package.xml exists. |
public installChannel ( Components_Pear_Environment $env, array $options = [] ) : null | ||
$env | Components_Pear_Environment | The environment to install into. |
$options | array | Install options. |
return | null |
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. |
return | null |
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. |
public repositoryRoot ( Components_Helper_Root $helper ) : null | ||
$helper | Components_Helper_Root | The root helper. |
return | null |
public timestampAndSync ( array $options ) : string | ||
$options | array | Options for the operation. |
return | string | The success message. |
public updateComposer ( array $options ) : string | ||
$options | array | Options for the operation. |
return | string | The success message. |