RootAliasPackage
extends AliasPackage
in package
implements
RootPackageInterface
Base class for packages providing name storage and default match implementation
Tags
Interfaces, Classes and Traits
- RootPackageInterface
- Defines additional fields that are only needed for the root package
Table of Contents
- STABILITY_ALPHA = 15
- STABILITY_BETA = 10
- STABILITY_DEV = 20
- STABILITY_RC = 5
- STABILITY_STABLE = 0
- $id : int
- READ-ONLY: The package id, public for fast access in dependency solver
- $stabilities : mixed
- $supportedLinkTypes : mixed
- $aliasOf : PackageInterface
- $conflicts : array<string|int, Link>
- $dev : mixed
- $devRequires : array<string|int, Link>
- $name : string
- $prettyName : string
- $prettyVersion : mixed
- $provides : array<string|int, Link>
- $replaces : array<string|int, Link>
- $repository : RepositoryInterface
- $requires : array<string|int, Link>
- $rootPackageAlias : mixed
- $stability : mixed
- $transportOptions : array<string|int, mixed>
- $version : mixed
- __clone() : mixed
- __construct() : mixed
- All descendants' constructors should call this parent constructor
- __toString() : string
- Converts the package into a readable and unique string
- equals() : mixed
- getAliases() : array<string|int, mixed>
- Returns a set of package names and their aliases
- getAliasOf() : PackageInterface
- getArchiveExcludes() : mixed
- getAuthors() : array<string|int, mixed>
- Returns an array of authors of the package
- getAutoload() : mixed
- getBinaries() : mixed
- getConfig() : array<string|int, mixed>
- Returns the root package's configuration
- getConflicts() : mixed
- {@inheritDoc}
- getDescription() : string
- Returns the package description
- getDevAutoload() : mixed
- getDevRequires() : mixed
- {@inheritDoc}
- getDistMirrors() : mixed
- getDistReference() : mixed
- getDistSha1Checksum() : mixed
- getDistType() : mixed
- getDistUrl() : mixed
- getDistUrls() : mixed
- getExtra() : mixed
- getFullPrettyVersion() : string
- Returns the pretty version string plus a git or hg commit hash of this package
- getFunding() : array<string|int, mixed>
- Returns an array of funding options for the package
- getHomepage() : string
- Returns the package homepage
- getId() : int
- Retrieves the package's id set through setId
- getIncludePaths() : mixed
- getInstallationSource() : mixed
- getKeywords() : array<string|int, mixed>
- Returns an array of keywords relating to the package
- getLicense() : array<string|int, mixed>
- Returns the package license, e.g. MIT, BSD, GPL
- getMinimumStability() : string
- Returns the minimum stability of the package
- getName() : string
- Returns the package's name without version info, thus not a unique identifier
- getNames() : array<string|int, mixed>
- Returns a set of names that could refer to this package
- getNotificationUrl() : mixed
- getPreferStable() : bool
- Returns true if the root package prefers picking stable packages over unstable ones
- getPrettyName() : string
- Returns the package's pretty (i.e. with proper case) name
- getPrettyString() : string
- Converts the package into a pretty readable string
- getPrettyVersion() : mixed
- {@inheritDoc}
- getProvides() : mixed
- {@inheritDoc}
- getReferences() : array<string|int, mixed>
- Returns a set of package names and source references that must be enforced on them
- getReleaseDate() : mixed
- getReplacementPackage() : string
- If the package is abandoned and has a suggested replacement, this method returns it
- getReplaces() : mixed
- {@inheritDoc}
- getRepositories() : array<string|int, mixed>
- Returns an array of repositories
- getRepository() : RepositoryInterface
- Returns a reference to the repository that owns the package
- getRequires() : mixed
- {@inheritDoc}
- getScripts() : array<string|int, mixed>
- Returns the scripts of this package
- getSourceMirrors() : mixed
- getSourceReference() : mixed
- getSourceType() : mixed
- getSourceUrl() : mixed
- getSourceUrls() : mixed
- getStability() : mixed
- {@inheritDoc}
- getStabilityFlags() : array<string|int, mixed>
- Returns the stability flags to apply to dependencies
- getStabilityPriority() : mixed
- getSuggests() : mixed
- getSupport() : array<string|int, mixed>
- Returns the support information
- getTargetDir() : mixed
- getTransportOptions() : array<string|int, mixed>
- Returns a list of options to download package dist files
- getType() : mixed
- getUniqueName() : string
- Returns package unique name, constructed from name, version and release type.
- getVersion() : mixed
- {@inheritDoc}
- isAbandoned() : bool
- Returns if the package is abandoned or not
- isDev() : mixed
- {@inheritDoc}
- isPlatform() : bool
- checks if this package is a platform package
- isRootPackageAlias() : bool
- packageNameToRegexp() : string
- Build a regexp from a package name, expanding * globs as required
- setAutoload() : mixed
- Set the autoload mapping
- setConflicts() : mixed
- Set the conflicting packages
- setDevAutoload() : mixed
- Set the dev autoload mapping
- setDevRequires() : mixed
- Set the recommended packages
- setDistMirrors() : mixed
- setDistReference() : mixed
- setDistType() : mixed
- setDistUrl() : mixed
- setExtra() : mixed
- setId() : mixed
- Allows the solver to set an id for this package to refer to it.
- setInstallationSource() : mixed
- setProvides() : mixed
- Set the provided virtual packages
- setReplaces() : mixed
- Set the packages this one replaces
- setRepositories() : mixed
- Set the repositories
- setRepository() : mixed
- Stores a reference to the repository that owns the package
- setRequires() : mixed
- Set the required packages
- setRootPackageAlias() : mixed
- Stores whether this is an alias created by an aliasing in the requirements of the root package or not
- setSourceMirrors() : mixed
- setSourceReference() : mixed
- setStabilityFlags() : mixed
- Set the stabilityFlags
- setSuggests() : mixed
- Set the suggested packages
- setTransportOptions() : mixed
- Configures the list of options to download package dist files
- replaceSelfVersionDependencies() : array<string|int, Link>
Constants
STABILITY_ALPHA
public
mixed
STABILITY_ALPHA
= 15
STABILITY_BETA
public
mixed
STABILITY_BETA
= 10
STABILITY_DEV
public
mixed
STABILITY_DEV
= 20
STABILITY_RC
public
mixed
STABILITY_RC
= 5
STABILITY_STABLE
public
mixed
STABILITY_STABLE
= 0
Properties
$id
READ-ONLY: The package id, public for fast access in dependency solver
public
int
$id
$stabilities
public
static mixed
$stabilities
= array('stable' => self::STABILITY_STABLE, 'RC' => self::STABILITY_RC, 'beta' => self::STABILITY_BETA, 'alpha' => self::STABILITY_ALPHA, 'dev' => self::STABILITY_DEV)
$supportedLinkTypes
public
static mixed
$supportedLinkTypes
= array('require' => array('description' => 'requires', 'method' => 'requires'), 'conflict' => array('description' => 'conflicts', 'method' => 'conflicts'), 'provide' => array('description' => 'provides', 'method' => 'provides'), 'replace' => array('description' => 'replaces', 'method' => 'replaces'), 'require-dev' => array('description' => 'requires (for development)', 'method' => 'devRequires'))
$aliasOf
protected
PackageInterface
$aliasOf
$conflicts
protected
array<string|int, Link>
$conflicts
$dev
protected
mixed
$dev
$devRequires
protected
array<string|int, Link>
$devRequires
$name
protected
string
$name
$prettyName
protected
string
$prettyName
$prettyVersion
protected
mixed
$prettyVersion
$provides
protected
array<string|int, Link>
$provides
$replaces
protected
array<string|int, Link>
$replaces
$repository
protected
RepositoryInterface
$repository
$requires
protected
array<string|int, Link>
$requires
$rootPackageAlias
protected
mixed
$rootPackageAlias
= false
$stability
protected
mixed
$stability
$transportOptions
protected
array<string|int, mixed>
$transportOptions
= array()
$version
protected
mixed
$version
Methods
__clone()
public
__clone() : mixed
Return values
mixed —__construct()
All descendants' constructors should call this parent constructor
public
__construct(RootPackageInterface $aliasOf, mixed $version, mixed $prettyVersion) : mixed
Parameters
- $aliasOf : RootPackageInterface
-
The package this package is an alias of
- $version : mixed
-
The version the alias must report
- $prettyVersion : mixed
-
The alias's non-normalized version
Return values
mixed —__toString()
Converts the package into a readable and unique string
public
__toString() : string
Return values
string —equals()
public
equals(PackageInterface $package) : mixed
Parameters
- $package : PackageInterface
Return values
mixed —getAliases()
Returns a set of package names and their aliases
public
getAliases() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAliasOf()
public
getAliasOf() : PackageInterface
Return values
PackageInterface —getArchiveExcludes()
public
getArchiveExcludes() : mixed
Return values
mixed —getAuthors()
Returns an array of authors of the package
public
getAuthors() : array<string|int, mixed>
Each item can contain name/homepage/email keys
Return values
array<string|int, mixed> —getAutoload()
public
getAutoload() : mixed
Return values
mixed —getBinaries()
public
getBinaries() : mixed
Return values
mixed —getConfig()
Returns the root package's configuration
public
getConfig() : array<string|int, mixed>
Return values
array<string|int, mixed> —getConflicts()
{@inheritDoc}
public
getConflicts() : mixed
Return values
mixed —getDescription()
Returns the package description
public
getDescription() : string
Return values
string —getDevAutoload()
public
getDevAutoload() : mixed
Return values
mixed —getDevRequires()
{@inheritDoc}
public
getDevRequires() : mixed
Return values
mixed —getDistMirrors()
public
getDistMirrors() : mixed
Return values
mixed —getDistReference()
public
getDistReference() : mixed
Return values
mixed —getDistSha1Checksum()
public
getDistSha1Checksum() : mixed
Return values
mixed —getDistType()
public
getDistType() : mixed
Return values
mixed —getDistUrl()
public
getDistUrl() : mixed
Return values
mixed —getDistUrls()
public
getDistUrls() : mixed
Return values
mixed —getExtra()
public
getExtra() : mixed
Return values
mixed —getFullPrettyVersion()
Returns the pretty version string plus a git or hg commit hash of this package
public
getFullPrettyVersion([mixed $truncate = true ]) : string
Parameters
- $truncate : mixed = true
-
If the source reference is a sha1 hash, truncate it
Return values
string —version
getFunding()
Returns an array of funding options for the package
public
getFunding() : array<string|int, mixed>
Each item will contain type and url keys
Return values
array<string|int, mixed> —getHomepage()
Returns the package homepage
public
getHomepage() : string
Return values
string —getId()
Retrieves the package's id set through setId
public
getId() : int
Return values
int —The previously set package id
getIncludePaths()
public
getIncludePaths() : mixed
Return values
mixed —getInstallationSource()
public
getInstallationSource() : mixed
Return values
mixed —getKeywords()
Returns an array of keywords relating to the package
public
getKeywords() : array<string|int, mixed>
Return values
array<string|int, mixed> —getLicense()
Returns the package license, e.g. MIT, BSD, GPL
public
getLicense() : array<string|int, mixed>
Return values
array<string|int, mixed> —The package licenses
getMinimumStability()
Returns the minimum stability of the package
public
getMinimumStability() : string
Return values
string —getName()
Returns the package's name without version info, thus not a unique identifier
public
getName() : string
Return values
string —package name
getNames()
Returns a set of names that could refer to this package
public
getNames() : array<string|int, mixed>
Return values
array<string|int, mixed> —An array of strings referring to this package
getNotificationUrl()
public
getNotificationUrl() : mixed
Return values
mixed —getPreferStable()
Returns true if the root package prefers picking stable packages over unstable ones
public
getPreferStable() : bool
Return values
bool —getPrettyName()
Returns the package's pretty (i.e. with proper case) name
public
getPrettyName() : string
Return values
string —package name
getPrettyString()
Converts the package into a pretty readable string
public
getPrettyString() : string
Return values
string —getPrettyVersion()
{@inheritDoc}
public
getPrettyVersion() : mixed
Return values
mixed —getProvides()
{@inheritDoc}
public
getProvides() : mixed
Return values
mixed —getReferences()
Returns a set of package names and source references that must be enforced on them
public
getReferences() : array<string|int, mixed>
Return values
array<string|int, mixed> —getReleaseDate()
public
getReleaseDate() : mixed
Return values
mixed —getReplacementPackage()
If the package is abandoned and has a suggested replacement, this method returns it
public
getReplacementPackage() : string
Return values
string —getReplaces()
{@inheritDoc}
public
getReplaces() : mixed
Return values
mixed —getRepositories()
Returns an array of repositories
public
getRepositories() : array<string|int, mixed>
{"
Return values
array<string|int, mixed> —Repositories
getRepository()
Returns a reference to the repository that owns the package
public
getRepository() : RepositoryInterface
Return values
RepositoryInterface —getRequires()
{@inheritDoc}
public
getRequires() : mixed
Return values
mixed —getScripts()
Returns the scripts of this package
public
getScripts() : array<string|int, mixed>
Return values
array<string|int, mixed> —array('script name' => array('listeners'))
getSourceMirrors()
public
getSourceMirrors() : mixed
Return values
mixed —getSourceReference()
public
getSourceReference() : mixed
Return values
mixed —getSourceType()
public
getSourceType() : mixed
Return values
mixed —getSourceUrl()
public
getSourceUrl() : mixed
Return values
mixed —getSourceUrls()
public
getSourceUrls() : mixed
Return values
mixed —getStability()
{@inheritDoc}
public
getStability() : mixed
Return values
mixed —getStabilityFlags()
Returns the stability flags to apply to dependencies
public
getStabilityFlags() : array<string|int, mixed>
Return values
array<string|int, mixed> —getStabilityPriority()
public
getStabilityPriority() : mixed
Return values
mixed —getSuggests()
public
getSuggests() : mixed
Return values
mixed —getSupport()
Returns the support information
public
getSupport() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTargetDir()
public
getTargetDir() : mixed
Return values
mixed —getTransportOptions()
Returns a list of options to download package dist files
public
getTransportOptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —getType()
public
getType() : mixed
Return values
mixed —getUniqueName()
Returns package unique name, constructed from name, version and release type.
public
getUniqueName() : string
Return values
string —getVersion()
{@inheritDoc}
public
getVersion() : mixed
Return values
mixed —isAbandoned()
Returns if the package is abandoned or not
public
isAbandoned() : bool
Return values
bool —isDev()
{@inheritDoc}
public
isDev() : mixed
Return values
mixed —isPlatform()
checks if this package is a platform package
public
isPlatform() : bool
Return values
bool —isRootPackageAlias()
public
isRootPackageAlias() : bool
Tags
Return values
bool —packageNameToRegexp()
Build a regexp from a package name, expanding * globs as required
public
static packageNameToRegexp(string $allowListPattern[, string $wrap = '{^%s$}i' ]) : string
Parameters
- $allowListPattern : string
- $wrap : string = '{^%s$}i'
-
Wrap the cleaned string by the given string
Return values
string —setAutoload()
Set the autoload mapping
public
setAutoload(array<string|int, mixed> $autoload) : mixed
Parameters
- $autoload : array<string|int, mixed>
-
Mapping of autoloading rules
Return values
mixed —setConflicts()
Set the conflicting packages
public
setConflicts(array<string|int, mixed> $conflicts) : mixed
Parameters
- $conflicts : array<string|int, mixed>
-
A set of package links
Return values
mixed —setDevAutoload()
Set the dev autoload mapping
public
setDevAutoload(array<string|int, mixed> $devAutoload) : mixed
Parameters
- $devAutoload : array<string|int, mixed>
-
Mapping of dev autoloading rules
Return values
mixed —setDevRequires()
Set the recommended packages
public
setDevRequires(array<string|int, mixed> $devRequire) : mixed
Parameters
- $devRequire : array<string|int, mixed>
Return values
mixed —setDistMirrors()
public
setDistMirrors(mixed $mirrors) : mixed
Parameters
- $mirrors : mixed
Return values
mixed —setDistReference()
public
setDistReference(mixed $reference) : mixed
Parameters
- $reference : mixed
Return values
mixed —setDistType()
public
setDistType(mixed $type) : mixed
Parameters
- $type : mixed
Return values
mixed —setDistUrl()
public
setDistUrl(mixed $url) : mixed
Parameters
- $url : mixed
Return values
mixed —setExtra()
public
setExtra(array<string|int, mixed> $extra) : mixed
Parameters
- $extra : array<string|int, mixed>
Return values
mixed —setId()
Allows the solver to set an id for this package to refer to it.
public
setId(mixed $id) : mixed
Parameters
- $id : mixed
Return values
mixed —setInstallationSource()
public
setInstallationSource(mixed $type) : mixed
Parameters
- $type : mixed
Return values
mixed —setProvides()
Set the provided virtual packages
public
setProvides(array<string|int, mixed> $provides) : mixed
Parameters
- $provides : array<string|int, mixed>
-
A set of package links
Return values
mixed —setReplaces()
Set the packages this one replaces
public
setReplaces(array<string|int, mixed> $replaces) : mixed
Parameters
- $replaces : array<string|int, mixed>
-
A set of package links
Return values
mixed —setRepositories()
Set the repositories
public
setRepositories(mixed $repositories) : mixed
Parameters
- $repositories : mixed
Return values
mixed —setRepository()
Stores a reference to the repository that owns the package
public
setRepository(RepositoryInterface $repository) : mixed
Parameters
- $repository : RepositoryInterface
Return values
mixed —setRequires()
Set the required packages
public
setRequires(array<string|int, mixed> $require) : mixed
Parameters
- $require : array<string|int, mixed>
Return values
mixed —setRootPackageAlias()
Stores whether this is an alias created by an aliasing in the requirements of the root package or not
public
setRootPackageAlias(bool $value) : mixed
Use by the policy for sorting manually aliased packages first, see #576
Parameters
- $value : bool
Return values
mixed —setSourceMirrors()
public
setSourceMirrors(mixed $mirrors) : mixed
Parameters
- $mirrors : mixed
Return values
mixed —setSourceReference()
public
setSourceReference(mixed $reference) : mixed
Parameters
- $reference : mixed
Return values
mixed —setStabilityFlags()
Set the stabilityFlags
public
setStabilityFlags(array<string|int, mixed> $stabilityFlags) : mixed
Parameters
- $stabilityFlags : array<string|int, mixed>
Return values
mixed —setSuggests()
Set the suggested packages
public
setSuggests(array<string|int, mixed> $suggests) : mixed
Parameters
- $suggests : array<string|int, mixed>
-
A set of package names/comments
Return values
mixed —setTransportOptions()
Configures the list of options to download package dist files
public
setTransportOptions(array<string|int, mixed> $options) : mixed
Parameters
- $options : array<string|int, mixed>
Return values
mixed —replaceSelfVersionDependencies()
protected
replaceSelfVersionDependencies(array<string|int, Link> $links, string $linkType) : array<string|int, Link>
Parameters
- $links : array<string|int, Link>
- $linkType : string