Documentation

PackageRepository extends ArrayRepository
in package

Package repository.

Tags
author

Jordi Boggiano j.boggiano@seld.be

Table of Contents

$packageMap  : array<string|int, PackageInterface>
$packages  : array<string|int, PackageInterface>
$config  : mixed
__construct()  : mixed
Initializes filesystem repository.
addPackage()  : mixed
Adds a new package to the repository
count()  : int
Returns the number of packages in this repository
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}
hasPackage()  : mixed
{@inheritDoc}
removePackage()  : mixed
Removes package from repository.
search()  : mixed
{@inheritDoc}
createAliasPackage()  : mixed
initialize()  : mixed
Initializes repository (reads file, or remote address).

Properties

Methods

__construct()

Initializes filesystem repository.

public __construct(array<string|int, mixed> $config) : mixed
Parameters
$config : array<string|int, mixed>

package definition

Return values
mixed —

count()

Returns the number of packages in this repository

public count() : int
Return values
int —

Number of packages

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.

getPackages()

{@inheritDoc}

public getPackages() : mixed
Return values
mixed —

search()

{@inheritDoc}

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

initialize()

Initializes repository (reads file, or remote address).

protected initialize() : mixed
Return values
mixed —

Search results