Documentation

Components

Interfaces, Classes, Traits and Enums

Component
Represents a component.
Config
Components_Config:: interface represents a configuration type for the Horde component tool.
Dependencies
The Components_Dependencies:: interface is a central broker for providing the dependencies to the different application parts.
Module
Components_Module:: represents a task for a Horde component.
TaskInterface
Common interface for tasks used in Release, Qc and Pipeline
Wrapper
Interface for the component file wrappers.
Components
The Components:: class is the entry point for the various component actions provided by the package.
File
Config\File:: class provides simple options for the bootstrap process.
Archive
Represents a component archive.
Base
Represents base functionality for a component.
Dependency
Horde\Components\Component\Dependency:: wraps PEAR dependency information.
DependencyList
Horde\Components\Component\Dependencies:: provides dependency handling mechanisms.
Factory
Generates component instances and helpers.
Identify
Identifies the requested component based on an argument and delivers a corresponding component instance.
Matcher
Match an expression against a component.
Remote
Represents a remote component.
Resolver
Horde\Components\Component\Resolver:: resolves component names and dependencies into component representations.
SystemCallResult
Components\Component\Task\SystemCallResult:: Holds Output, Return code etc
Application
Config\Application:: provides a wrapper that provides application specific configuration values by combining defaults and options provided at runtime.
Base
Base:: provides common utilities for the configuration handlers.
Bootstrap
Bootstrap:: class provides simple options for the bootstrap process.
Cli
Config\Cli:: class provides central options for the command line configuration of the components tool.
Configs
Components_Configs:: class represents configuration for the Horde component tool.
Constants
Constants:: provides the constants for this package.
Bootstrap
The Components_Dependencies_Bootstrap:: class provides the Components dependencies specifically for the bootstrapping process.
Injector
The Components_Dependencies_Injector:: class provides the Components dependencies based on the Horde injector.
Pear
This class converts PEAR errors into exceptions for the Components package.
Exception
This class provides the standard error class for the Components package.
ChangeLog
Helper for adding entries to the change log(s).
Commit
Components_Helper_Commit:: helps with collecting for git commit events.
Composer
Dependencies
Components_Helper_Dependencies:: provides a utility that produces a dependency list and records what has already been listed.
DocsOrigin
Components_Helper_DocOrigin:: deals with a DOCS_ORIGIN file.
Git
HordeComponents\Helper\Git:: wraps git operations.
Installer
Components_Helper_Installer:: provides an installation helper.
Root
Components_Helper_Root:: handles the root position for a tree of dependencies and takes the Horde component layout into account.
Template
Components_Helper_Template:: converts a template into a target file.
Directory
Components_Helper_Templates_Directory:: converts template files from a directory into files in a target directory.
RecursiveDirectory
Components_Helper_Templates_RecursiveDirectory:: converts template files recursively from a directory into files in a target directory.
Single
Components_Helper_Templates_Single:: converts a single template file into a target file.
Templates
Components_Helper_Templates:: converts templates into target files.
Version
Converts between different version schemes.
Website
This class is a helper for a horde-web git repository checkout.
Base
Components_Module_Base:: provides core functionality for the different modules.
Change
Components_Module_Change:: records a change log entry.
CiSetup
Components_Module_CiSetup:: generates the configuration for Hudson based continuous integration of a Horde PEAR package.
Composer
Creates a config file for use with PHP Composer.
Dependencies
Components_Module_Dependencies:: generates a dependency listing for the specified package.
Distribute
Components_Module_Distribute:: prepares a distribution package for a component.
Fetchdocs
Components_Module_Fetchdocs:: fetches remote documentation files.
Git
Horde\Components\Module\Git:: Useful git command wrappers for CI
Help
Components_Module_Help:: provides information for a single action.
Init
Horde\Components\Module\Init:: initializes component metadata.
Installer
Components_Module_Installer:: installs a Horde element including its dependencies.
Qc
Components_Module_Qc:: checks the component for quality.
Release
Components_Module_Release:: generates a release.
Snapshot
Components_Module_DevPackage:: generates a development snapshot for the specified package.
Update
Components_Module_Update:: can update the package.xml of a Horde element.
Webdocs
Webdocs:: generates the www.horde.org data for a component.
Output
Components_Output:: handles output from the components application.
Environment
Components_Pear_Environment:: handles a specific PEAR environment.
Factory
Components_Pear_Factory:: generates PEAR specific handlers.
Package
Components_Pear_Package:: provides package handling mechanisms.
Base
Components_Qc_Task_Base:: provides core functionality for qc tasks.
Cpd
Components_Qc_Task_Cpd:: runs a copy/paste check on the component.
Cs
Components_Qc_Task_Cs:: runs a code style check on the component.
Dcd
PHP dead code detection.
Lint
Components_Qc_Task_Lint:: runs a syntax check on the component.
Loc
Measure the size and analyze the structure of a PHP component.
Md
Components_Qc_Task_Md:: runs a mess detection check on the component.
Unit
Components_Qc_Task_Unit:: runs the test suite of the component.
Tasks
Components_Qc_Tasks:: organizes the different tasks required for releasing a package.
Notes
This class deals with the information associated to a release.
Announce
Components_Release_Task_Announce:: announces new releases to the mailing lists.
Base
Components_Release_Task_Base:: provides core functionality for release tasks.
Bugs
Components_Release_Task_Bugs adds the new release to the issue tracker.
Changelog
Components_Release_Task_Changelog updates the change logs in CHANGES and package.xml.
CommitPostRelease
Components_Release_Task_CommitPostRelease:: commits any changes after to the release.
CommitPreRelease
Components_Release_Task_CommitPreRelease:: commits any changes prior to the release.
Composer
Components_Release_Task_Composer:: Update the composer file
CurrentSentinel
Components_Release_Task_CurrentSentinel:: updates the CHANGES and the Application.php/Bundle.php files with the current package version.
GitBranch
Components_Release_Task_GitBranch:: Check or enforce a branch checkout
GitPush
Components_Release_Task_GitPush:: Push any changes to a remote server
NextVersion
Components_Release_Task_NextVersion:: updates the package.xml file with information about the next component version.
Package
Components_Release_Task_Package:: prepares and uploads a release package.
Packagist
Components_Release_Task_Packagist:: Notify Packagist of update
Satis
Components_Release_Task_Satis:: Rebuild a satis repo
Sentinel
Components_Release_Task_Sentinel:: provides base functionality for the sentinel tasks.
TagRelease
Components_Release_Task_TagRelease:: tags the git repository.
Timestamp
Components_Release_Task_Timestamp:: timestamps the package right before the release.
Unit
Components_Release_Task_Unit:: Run Quality Checks and Unit Tests
Website
Components_Release_Task_Website adds the new release to the Horde website.
Tasks
Components_Release_Tasks:: organizes the different tasks required for releasing a package.
Change
Components_Runner_Change:: adds a new change log entry.
CiPrebuild
Components_Runner_CiPrebuild:: prepares a continuous integration setup for a component.
CiSetup
Components_Runner_CiSetup:: prepares a continuous integration setup for a component.
Composer
Generate config file for use with PHP Composer.
Dependencies
Horde\Components\Runner\Dependencies:: lists a tree of dependencies.
Distribute
Components_Runner_Distribute:: prepares a distribution package for a component.
Fetchdocs
Components_Runner_Fetchdocs:: fetches documentation for a component.
Git
Horde\Components\Runner\Git:: runner for git operations.
Init
Horde\Components\Runner\Init:: create new metadata.
Installer
Components_Runner_Installer:: installs a Horde component including its dependencies.
Pipeline
Horde\Components\Runner\Pipeline:: Run clean room pipelines
Qc
Components_Runner_Qc:: checks the component for quality.
Release
Components_Runner_Release:: releases a new version for a package.
Snapshot
Components_Runner_Snapshot:: packages a snapshot.
Update
Components_Runner_Update updates the package files of a Horde component.
Webdocs
Components_Runner_Webdocs:: generates the www.horde.org data for a component.
ApplicationPhp
Wrapper for the Application.php/Bundle.php files.
ChangelogYml
Wrapper for the changelog.yml file.
Changes
Wrapper for the CHANGES file.
ComposerJson
Wrapper for the composer.json file.
HordeYml
Wrapper for the .horde.yml file.
PackageXml
Wrapper for the package.xml file.
Dependencies
Components\Component\Task\Dependencies:: Declare and receive dependencies
SystemCall
Components\Component\Task\SystemCall:: Run system calls from tasks
WrapperTrait
Trait for the component file wrappers.

Table of Contents

PHP_CODESNIFFER_CBF  = false
PHP_CODESNIFFER_VERBOSITY  = false

Constants

PHP_CODESNIFFER_CBF

public mixed PHP_CODESNIFFER_CBF = false

PHP_CODESNIFFER_VERBOSITY

public mixed PHP_CODESNIFFER_VERBOSITY = false

Search results