Documentation

VcsRepository extends ArrayRepository
in package
implements ConfigurableRepositoryInterface

A repository implementation that simply stores packages in an array

Tags
author

Jordi Boggiano j.boggiano@seld.be

Interfaces, Classes and Traits

ConfigurableRepositoryInterface
Configurable repository interface.

Table of Contents

$branchErrorOccurred  : mixed
$config  : mixed
$io  : mixed
$isVerbose  : mixed
$isVeryVerbose  : mixed
$loader  : mixed
$packageMap  : array<string|int, PackageInterface>
$packageName  : mixed
$packages  : array<string|int, PackageInterface>
$repoConfig  : mixed
$type  : mixed
$url  : mixed
$versionParser  : mixed
$driver  : VcsDriverInterface
$drivers  : mixed
$emptyReferences  : mixed
$versionCache  : VersionCacheInterface
$versionTransportExceptions  : mixed
__construct()  : mixed
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.
getDriver()  : mixed
getEmptyReferences()  : mixed
getPackages()  : mixed
{@inheritDoc}
getRepoConfig()  : mixed
getVersionTransportExceptions()  : mixed
hadInvalidBranches()  : mixed
hasPackage()  : mixed
{@inheritDoc}
removePackage()  : mixed
Removes package from repository.
search()  : mixed
{@inheritDoc}
setLoader()  : mixed
createAliasPackage()  : mixed
initialize()  : mixed
Initializes the packages array. Mostly meant as an extension point.
preProcess()  : mixed
getCachedPackageVersion()  : mixed
validateBranch()  : mixed
validateTag()  : mixed

Properties

$branchErrorOccurred

protected mixed $branchErrorOccurred = false

$versionTransportExceptions

private mixed $versionTransportExceptions = array()

Methods

__construct()

public __construct(array<string|int, mixed> $repoConfig, IOInterface $io, Config $config[, EventDispatcher $dispatcher = null ][, array<string|int, mixed> $drivers = null ][, VersionCacheInterface $versionCache = null ]) : mixed
Parameters
$repoConfig : array<string|int, mixed>
$io : IOInterface
$config : Config
$dispatcher : EventDispatcher = null
$drivers : array<string|int, mixed> = null
$versionCache : VersionCacheInterface = null
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.

getDriver()

public getDriver() : mixed
Return values
mixed —

getEmptyReferences()

public getEmptyReferences() : mixed
Return values
mixed —

getPackages()

{@inheritDoc}

public getPackages() : mixed
Return values
mixed —

getRepoConfig()

public getRepoConfig() : mixed
Return values
mixed —

getVersionTransportExceptions()

public getVersionTransportExceptions() : mixed
Return values
mixed —

hadInvalidBranches()

public hadInvalidBranches() : 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 the packages array. Mostly meant as an extension point.

protected initialize() : mixed
Return values
mixed —

preProcess()

protected preProcess(VcsDriverInterface $driver, array<string|int, mixed> $data, mixed $identifier) : mixed
Parameters
$driver : VcsDriverInterface
$data : array<string|int, mixed>
$identifier : mixed
Return values
mixed —

getCachedPackageVersion()

private getCachedPackageVersion(mixed $version, mixed $identifier, mixed $isVerbose, mixed $isVeryVerbose) : mixed
Parameters
$version : mixed
$identifier : mixed
$isVerbose : mixed
$isVeryVerbose : mixed
Return values
mixed —

validateBranch()

private validateBranch(mixed $branch) : mixed
Parameters
$branch : mixed
Return values
mixed —

validateTag()

private validateTag(mixed $version) : mixed
Parameters
$version : mixed
Return values
mixed —

Search results