PHP Класс Components_Pear_Environment, 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.
Автор: Gunnar Wrobel ([email protected])
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
__construct ( Components_Output $output ) Constructor.
addChannel ( string $channel, array $options = [], string $reason = '' ) : null Add a channel within the install location.
addComponent ( string $component, string $install, array $options, string $info, string $reason = '', array $warnings = [] ) : null Add a component to the environemnt.
channelExists ( string $channel ) : boolean Test if a channel exists within the install location.
createPearConfig ( )
getPearConfig ( )
linkPackageFromSource ( string $package, string $reason = '' ) : null Add a package based on a source directory.
provideChannel ( string $channel, array $options = [], string $reason = '' ) : null Ensure the specified channel exists within the install location.
setChannelDirectory ( &$options ) : null Set the path to the channel directory.
setFactory ( Components_Pear_Factory $factory ) : null Define the factory that creates our PEAR dependencies.
setLocation ( string $base_directory, string $config_file ) : null Set the path to the install location.
setResourceDirectories ( &$options ) : null Set the paths to the resource directories.
setSourceDirectory ( &$options ) : null Set the path to the source directory.

Приватные методы

Метод Описание
_checkSetup ( ) : null Validate that the required instance parameters are set.
getInstallationHandler ( ) : PEAR_Command_Install Provide the PEAR specific installer.

Описание методов

__construct() публичный Метод

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

addChannel() публичный Метод

Add a channel within the install location.
public addChannel ( string $channel, array $options = [], string $reason = '' ) : null
$channel string The channel name.
$options array Install options.
$reason string Optional reason for adding the channel.
Результат null

addComponent() публичный Метод

Add a component to the environemnt.
public addComponent ( string $component, string $install, array $options, string $info, string $reason = '', array $warnings = [] ) : null
$component string The name of the component that should be installed.
$install string The package that should be installed.
$options array PEAR specific installation opions.
$info string Installation details.
$reason string Optional reason for adding the package.
$warnings array Optional warnings that should be displayed to the user.
Результат null

channelExists() публичный Метод

Test if a channel exists within the install location.
public channelExists ( string $channel ) : boolean
$channel string The channel name.
Результат boolean True if the channel exists.

createPearConfig() публичный Метод

public createPearConfig ( )

getPearConfig() публичный Метод

public getPearConfig ( )

linkPackageFromSource() публичный Метод

Add a package based on a source directory.
public linkPackageFromSource ( string $package, string $reason = '' ) : null
$package string The path to the package.xml in the source directory.
$reason string Optional reason for adding the package.
Результат null

provideChannel() публичный Метод

Ensure the specified channel exists within the install location.
public provideChannel ( string $channel, array $options = [], string $reason = '' ) : null
$channel string The channel name.
$options array Install options.
$reason string Optional reason for adding the channel.
Результат null

setChannelDirectory() публичный Метод

Set the path to the channel directory.
public setChannelDirectory ( &$options ) : null
Результат null

setFactory() публичный Метод

Define the factory that creates our PEAR dependencies.
public setFactory ( Components_Pear_Factory $factory ) : null
$factory Components_Pear_Factory
Результат null

setLocation() публичный Метод

Set the path to the install location.
public setLocation ( string $base_directory, string $config_file ) : null
$base_directory string The base directory for the PEAR install location.
$config_file string The name of the configuration file.
Результат null

setResourceDirectories() публичный Метод

Set the paths to the resource directories.
public setResourceDirectories ( &$options ) : null
Результат null

setSourceDirectory() публичный Метод

Set the path to the source directory.
public setSourceDirectory ( &$options ) : null
Результат null