class InstalledArrayRepository extends WritableArrayRepository implements InstalledRepositoryInterface (View source)

Installed array repository.

This is used for serving the RootPackage inside an in-memory InstalledRepository

Properties

protected PackageInterface[] $packages from ArrayRepository

Methods

array
getDependents(string|string[] $needle, ConstraintInterface|null $constraint = null, bool $invert = false, bool $recurse = true, string[] $packagesFound = null)

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.

__construct(array $packages = array())

No description

findPackage(string $name, string|ConstraintInterface $constraint)

Searches for the first match of a package by name and version.

findPackages(string $name, string|ConstraintInterface $constraint = null)

Searches for all packages matching a name and optionally a version.

array[]
search(string $query, int $mode = 0, $type = null)

Searches the repository for packages containing the query

bool
hasPackage(PackageInterface $package)

Checks if specified package registered (installed).

addPackage(PackageInterface $package)

Adds a new package to the repository

createAliasPackage(PackageInterface $package, $alias, $prettyAlias)

No description

removePackage(PackageInterface $package)

Removes package from repository.

getPackages()

Returns list of registered packages.

int
count()

Returns the number of packages in this repository

initialize()

Initializes the packages array. Mostly meant as an extension point.

write()

Writes repository (f.e. to the disc).

reload()

Forces a reload of all packages.

getCanonicalPackages()

Get unique packages (at most one package of each name), with aliases resolved and removed.

Details

array getDependents(string|string[] $needle, ConstraintInterface|null $constraint = null, bool $invert = false, bool $recurse = true, string[] $packagesFound = null)

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.

Parameters

string|string[] $needle The package name(s) to inspect.
ConstraintInterface|null $constraint Optional constraint to filter by.
bool $invert Whether to invert matches to discover reasons for the package NOT to be installed.
bool $recurse Whether to recursively expand the requirement tree up to the root package.
string[] $packagesFound Used internally when recurring

Return Value

array An associative array of arrays as described above.

__construct(array $packages = array())

Parameters

array $packages

PackageInterface|null findPackage(string $name, string|ConstraintInterface $constraint)

Searches for the first match of a package by name and version.

Parameters

string $name package name
string|ConstraintInterface $constraint package version or version constraint to match against

Return Value

PackageInterface|null

PackageInterface[] findPackages(string $name, string|ConstraintInterface $constraint = null)

Searches for all packages matching a name and optionally a version.

Parameters

string $name package name
string|ConstraintInterface $constraint package version or version constraint to match against

Return Value

PackageInterface[]

Searches the repository for packages containing the query

Parameters

string $query search query
int $mode a set of SEARCH_* constants to search on, implementations should do a best effort only
$type

Return Value

array[] an array of array('name' => '...', 'description' => '...')

bool hasPackage(PackageInterface $package)

Checks if specified package registered (installed).

Parameters

PackageInterface $package package instance

Return Value

bool

addPackage(PackageInterface $package)

Adds a new package to the repository

Parameters

PackageInterface $package

protected createAliasPackage(PackageInterface $package, $alias, $prettyAlias)

Parameters

PackageInterface $package
$alias
$prettyAlias

removePackage(PackageInterface $package)

Removes package from repository.

Parameters

PackageInterface $package package instance

PackageInterface[] getPackages()

Returns list of registered packages.

Return Value

PackageInterface[]

int count()

Returns the number of packages in this repository

Return Value

int Number of packages

protected initialize()

Initializes the packages array. Mostly meant as an extension point.

write()

Writes repository (f.e. to the disc).

reload()

Forces a reload of all packages.

PackageInterface[] getCanonicalPackages()

Get unique packages (at most one package of each name), with aliases resolved and removed.

Return Value

PackageInterface[]