Installer
in package
Components_Helper_Installer:: provides an installation helper.
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 : Environment
- The environment the helper installs into.
- $_installed_components : array<string|int, mixed>
- The list of components already installed.
- $_output : mixed
- The output handler.
- $_per_component_options : array<string|int, mixed>
- Per component options.
- __construct() : mixed
- Constructor.
- installTree() : void
- Install a component with its dependencies into the environment.
- _deletePrevious() : mixed
- _getPerComponentOptions() : array<string|int, mixed>
- Identify the per component options.
- _installComponent() : void
- Ensure that the component is available within the installation environment.
- _installDependencies() : void
- Install the dependencies of a component.
Properties
$_environment
The environment the helper installs into.
private
Environment
$_environment
$_installed_components
The list of components already installed.
private
array<string|int, mixed>
$_installed_components
= []
$_output
The output handler.
private
mixed
$_output
$_per_component_options
Per component options.
private
array<string|int, mixed>
$_per_component_options
= []
Methods
__construct()
Constructor.
public
__construct(Output $output) : mixed
Parameters
- $output : Output
-
The output handler.
Return values
mixed —installTree()
Install a component with its dependencies into the environment.
public
installTree(Environment $environment, Component $component[, array<string|int, mixed> $options = [] ][, string $reason = '' ]) : void
Parameters
- $environment : Environment
-
The environment we install into.
- $component : Component
-
The component that should be installed.
- $options : array<string|int, mixed> = []
-
Install options.
- $reason : string = ''
-
Optional reason for adding the package.
Return values
void —_deletePrevious()
private
_deletePrevious(mixed $key, mixed $options, mixed $previous) : mixed
Parameters
- $key : mixed
- $options : mixed
- $previous : mixed
Return values
mixed —_getPerComponentOptions()
Identify the per component options.
private
_getPerComponentOptions(mixed $component, array<string|int, mixed> $options) : array<string|int, mixed>
Parameters
- $component : mixed
-
The component.
- $options : array<string|int, mixed>
-
The global options.
Return values
array<string|int, mixed> —The specific options for the component.
_installComponent()
Ensure that the component is available within the installation environment.
private
_installComponent(Environment $environment, Component $component[, array<string|int, mixed> $options = [] ][, string $reason = '' ]) : void
Parameters
- $environment : Environment
-
The environment we install into.
- $component : Component
-
The component that should be installed.
- $options : array<string|int, mixed> = []
-
Install options.
- $reason : string = ''
-
Optional reason for adding the package.
Return values
void —_installDependencies()
Install the dependencies of a component.
private
_installDependencies(Environment $environment, Component $component[, array<string|int, mixed> $options = [] ][, string $reason = '' ]) : void
Parameters
- $environment : Environment
-
The environment we install into.
- $component : Component
-
The component that should be installed.
- $options : array<string|int, mixed> = []
-
Install options.
- $reason : string = ''
-
Optional reason for adding the package.