Documentation

DependencyList
in package
implements Iterator

Horde\Components\Component\Dependencies:: provides dependency handling mechanisms.

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
category

Horde

author

Gunnar Wrobel wrobel@pardus.de

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Interfaces, Classes, Traits and Enums

Iterator

Table of Contents

$_component  : Component
The component.
$_dependencies  : mixed
The dependency list.
$_factory  : Factory
Factory helper.
__construct()  : mixed
Constructor.
__get()  : Dependency|null
Implementation of the Iterator rewind() method. Rewinds the dependency list.
current()  : Dependency|null
Implementation of the Iterator current(). Returns the current dependency.
key()  : mixed
Implementation of the Iterator key() method. Returns the key of the current dependency.
listAllChannels()  : array<string|int, mixed>
Return all channels required for the component and its dependencies.
next()  : Dependency|null
Implementation of the Iterator next() method. Returns the next dependency.
rewind()  : Dependency|null
Implementation of the Iterator rewind() method. Rewinds the dependency list.
valid()  : bool
Implementation of the Iterator valid() method. Indicates if the current element is a valid element.
_getDependencies()  : array<string|int, Dependency>
Return all dependencies for this package.

Properties

$_dependencies

The dependency list.

private mixed $_dependencies

Methods

__construct()

Constructor.

public __construct(Component $_component, Factory $_factory) : mixed
Parameters
$_component : Component

The component.

$_factory : Factory

Generator for dependency representations.

Return values
mixed

__get()

Implementation of the Iterator rewind() method. Rewinds the dependency list.

public __get(mixed $key) : Dependency|null
Parameters
$key : mixed
Return values
Dependency|null

current()

Implementation of the Iterator current(). Returns the current dependency.

public current() : Dependency|null
Return values
Dependency|null

The current dependency.

key()

Implementation of the Iterator key() method. Returns the key of the current dependency.

public key() : mixed
Return values
mixed

The key for the current position.

listAllChannels()

Return all channels required for the component and its dependencies.

public listAllChannels() : array<string|int, mixed>
Return values
array<string|int, mixed>

The list of channels.

next()

Implementation of the Iterator next() method. Returns the next dependency.

public next() : Dependency|null
Return values
Dependency|null

The next dependency or null if there are no more dependencies.

valid()

Implementation of the Iterator valid() method. Indicates if the current element is a valid element.

public valid() : bool
Return values
bool

Whether the current element is valid

_getDependencies()

Return all dependencies for this package.

private _getDependencies() : array<string|int, Dependency>
Return values
array<string|int, Dependency>

The list of dependencies.

Search results