Documentation

CompositeRepository extends BaseRepository
in package

Composite repository.

Tags
author

Beau Simensen beau@dflydev.com

Table of Contents

$repositories  : array<string|int, mixed>
List of repositories
__construct()  : mixed
Constructor
addRepository()  : mixed
Add a repository.
count()  : mixed
{@inheritdoc}
findPackage()  : mixed
{@inheritdoc}
findPackages()  : mixed
{@inheritdoc}
getDependents()  : array<string|int, mixed>
Returns a list of links causing the requested needle packages to be installed, as an associative array with the dependent's name as key, and an array containing in order the PackageInterface and Link describing the relationship as values. If recursive lookup was requested a third value is returned containing an identically formed array up to the root package. That third value will be false in case a circular recursion was detected.
getPackages()  : mixed
{@inheritdoc}
getRepositories()  : array<string|int, mixed>
Returns all the wrapped repositories
hasPackage()  : mixed
{@inheritdoc}
removePackage()  : mixed
{@inheritdoc}
search()  : mixed
{@inheritdoc}

Properties

Methods

__construct()

Constructor

public __construct(array<string|int, mixed> $repositories) : mixed
Parameters
$repositories : array<string|int, mixed>
Return values
mixed

findPackage()

{@inheritdoc}

public findPackage(mixed $name, mixed $constraint) : mixed
Parameters
$name : mixed
$constraint : mixed
Return values
mixed

findPackages()

{@inheritdoc}

public findPackages(mixed $name[, mixed $constraint = null ]) : mixed
Parameters
$name : mixed
$constraint : mixed = null
Return values
mixed

getDependents()

Returns a list of links causing the requested needle packages to be installed, as an associative array with the dependent's name as key, and an array containing in order the PackageInterface and Link describing the relationship as values. If recursive lookup was requested a third value is returned containing an identically formed array up to the root package. That third value will be false in case a circular recursion was detected.

public getDependents(string|array<string|int, string> $needle[, ConstraintInterface|null $constraint = null ][, bool $invert = false ][, bool $recurse = true ][, array<string|int, string> $packagesFound = null ]) : array<string|int, mixed>
Parameters
$needle : string|array<string|int, string>

The package name(s) to inspect.

$constraint : ConstraintInterface|null = null

Optional constraint to filter by.

$invert : bool = false

Whether to invert matches to discover reasons for the package NOT to be installed.

$recurse : bool = true

Whether to recursively expand the requirement tree up to the root package.

$packagesFound : array<string|int, string> = null

Used internally when recurring

Return values
array<string|int, mixed>

An associative array of arrays as described above.

getRepositories()

Returns all the wrapped repositories

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

{@inheritdoc}

public search(mixed $query, mixed $mode[, mixed $type = null ]) : mixed
Parameters
$query : mixed
$mode : mixed
$type : mixed = null
Return values
mixed

Search results