Documentation

Link
in package

Represents a link between two packages, represented by their names

Tags
author

Nils Adermann naderman@naderman.de

Table of Contents

$constraint  : ConstraintInterface|null
$description  : string
$prettyConstraint  : string|null
$source  : string
$target  : string
__construct()  : mixed
Creates a new package link.
__toString()  : string
getConstraint()  : ConstraintInterface|null
getDescription()  : string
getPrettyConstraint()  : string
getPrettyString()  : string
getSource()  : string
getTarget()  : string

Properties

$description

protected string $description

$prettyConstraint

protected string|null $prettyConstraint

$source

protected string $source

$target

protected string $target

Methods

__construct()

Creates a new package link.

public __construct(string $source, string $target[, ConstraintInterface|null $constraint = null ][, string $description = 'relates to' ][, string|null $prettyConstraint = null ]) : mixed
Parameters
$source : string
$target : string
$constraint : ConstraintInterface|null = null

Constraint applying to the target of this link

$description : string = 'relates to'

Used to create a descriptive string representation

$prettyConstraint : string|null = null
Return values
mixed

__toString()

public __toString() : string
Return values
string

getDescription()

public getDescription() : string
Return values
string

getPrettyConstraint()

public getPrettyConstraint() : string
Tags
throws
UnexpectedValueException

If no pretty constraint was provided

Return values
string

getSource()

public getSource() : string
Return values
string

getTarget()

public getTarget() : string
Return values
string

Search results