Dependencies
in package
Components_Helper_Dependencies:: provides a utility that produces a dependency list and records what has already been listed.
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
- $_displayed_dependencies : array<string|int, mixed>
- The list of dependencies already displayed.
- $_output : Output
- The output handler.
- $_short_list : array<string|int, mixed>
- The list of elements in case we are producing condensed output.
- __construct() : mixed
- Constructor.
- listTree() : void
- List the dependency tree for this package.
- _element() : void
- List a single element.
- _finish() : void
- Wrap up the listing. This will produce a condensed list of packages in case quiet Output was requested.
- _listComponent() : bool
- List a Horde component as dependency.
- _listExternal() : void
- List an external package as dependency.
- _listLevel() : string
- Produces an amount of whitespace depending on the specified level.
- _listTree() : void
- List the dependency tree for this package.
Properties
$_displayed_dependencies
The list of dependencies already displayed.
private
array<string|int, mixed>
$_displayed_dependencies
= []
$_output read-only
The output handler.
private
Output
$_output
$_short_list
The list of elements in case we are producing condensed output.
private
array<string|int, mixed>
$_short_list
= []
Methods
__construct()
Constructor.
public
__construct(Output $_output) : mixed
Parameters
- $_output : Output
-
The output handler.
Return values
mixed —listTree()
List the dependency tree for this package.
public
listTree(Component $component, array<string|int, mixed> $options) : void
Parameters
- $component : Component
-
The component for which the dependency tree should be shown.
- $options : array<string|int, mixed>
-
Options for generating the list.
Return values
void —_element()
List a single element.
private
_element(mixed $color, mixed $level, mixed $key, mixed $name, mixed $channel, mixed $info, mixed $options) : void
Parameters
- $color : mixed
- $level : mixed
- $key : mixed
- $name : mixed
- $channel : mixed
- $info : mixed
- $options : mixed
Return values
void —_finish()
Wrap up the listing. This will produce a condensed list of packages in case quiet Output was requested.
private
_finish() : void
Return values
void —_listComponent()
List a Horde component as dependency.
private
_listComponent(Component $component, int $level, string $parent, array<string|int, mixed> $options) : bool
Parameters
- $component : Component
-
The component for which the dependency tree should be shown
- $level : int
-
The current list level.
- $parent : string
-
Name of the parent element.
- $options : array<string|int, mixed>
-
Options for generating the list.
Return values
bool —True in case listing should continue.
_listExternal()
List an external package as dependency.
private
_listExternal(Dependency $dependency, int $level, array<string|int, mixed> $options) : void
Parameters
- $dependency : Dependency
-
The package dependencies.
- $level : int
-
The current list level.
- $options : array<string|int, mixed>
-
tbd
Return values
void —_listLevel()
Produces an amount of whitespace depending on the specified level.
private
_listLevel(int $level) : string
Parameters
- $level : int
-
The level of indentation.
Return values
string —Whitespace.
_listTree()
List the dependency tree for this package.
private
_listTree(Component $component, array<string|int, mixed> $options, int $level[, string $parent = '' ]) : void
Parameters
- $component : Component
-
The component for which the dependency tree should be shown.
- $options : array<string|int, mixed>
-
Options for generating the list.
- $level : int
-
The current list level.
- $parent : string = ''
-
The name of the parent element.