Documentation

Dependency
in package

Horde\Components\Component\Dependency:: wraps PEAR dependency information.

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

Table of Contents

$_channel  : string
The channel of the dependency.
$_dependency  : mixed
$_factory  : Factory
$_name  : string
The name of the dependency.
$_optional  : bool
Indicates if this is an optional dependency.
$_package  : bool
Indicates if this is a package dependency.
$_type  : string
The type of the dependency.
__construct()  : mixed
Constructor.
channelOrType()  : string
Return the package channel or the type description for the dependency.
getChannel()  : string
Return the package channel for the dependency
getComponent()  : Component
Return the dependency in its component representation.
getDependencyInformation()  : array<string|int, mixed>
Return the original dependency information.
getName()  : string
Return the package name for the dependency
isExtension()  : boolen
Is this a PHP extension dependency?
isHorde()  : boolen
Is the dependency a Horde dependency?
isPackage()  : boolen
Is this a package dependency?
isPearBase()  : boolen
Is the dependency the PEAR base package?
isPhp()  : boolen
Is this the PHP dependency?
isRequired()  : boolen
Is the dependency required?
key()  : string
Return the key for the dependency

Properties

$_channel

The channel of the dependency.

private string $_channel = ''

$_name

The name of the dependency.

private string $_name = ''

$_optional

Indicates if this is an optional dependency.

private bool $_optional = true

$_package

Indicates if this is a package dependency.

private bool $_package = false

$_type

The type of the dependency.

private string $_type = ''

Methods

__construct()

Constructor.

public __construct(array<string|int, mixed> $_dependency, Factory $_factory) : mixed
Parameters
$_dependency : array<string|int, mixed>

The dependency information.

$_factory : Factory

Helper factory.

Return values
mixed

channelOrType()

Return the package channel or the type description for the dependency.

public channelOrType() : string
Return values
string

The package channel.

getChannel()

Return the package channel for the dependency

public getChannel() : string
Return values
string

The package channel.

getComponent()

Return the dependency in its component representation.

public getComponent([array<string|int, mixed> $options = [] ]) : Component
Parameters
$options : array<string|int, mixed> = []

The options for resolving the component.

Return values
Component

The component.

getDependencyInformation()

Return the original dependency information.

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

The original dependency information.

getName()

Return the package name for the dependency

public getName() : string
Return values
string

The package name.

isExtension()

Is this a PHP extension dependency?

public isExtension() : boolen
Return values
boolen

True if it is a PHP extension dependency.

isHorde()

Is the dependency a Horde dependency?

public isHorde() : boolen
Return values
boolen

True if it is a Horde dependency.

isPackage()

Is this a package dependency?

public isPackage() : boolen
Return values
boolen

True if the dependency is a package.

isPearBase()

Is the dependency the PEAR base package?

public isPearBase() : boolen
Return values
boolen

True if it is the PEAR base package.

isPhp()

Is this the PHP dependency?

public isPhp() : boolen
Return values
boolen

True if it is the PHP dependency.

isRequired()

Is the dependency required?

public isRequired() : boolen
Return values
boolen

True if the dependency is required.

key()

Return the key for the dependency

public key() : string
Return values
string

The uniqe key for this dependency.

Search results