Composer API
Class

Composer\Package\RootAliasPackage

class RootAliasPackage extends AliasPackage implements RootPackageInterface

Constants

STABILITY_STABLE

STABILITY_RC

STABILITY_BETA

STABILITY_ALPHA

STABILITY_DEV

Properties

static $supportedLinkTypes
static $stabilities
int $id READ-ONLY: The package id, public for fast access in dependency solver

Methods

__construct(RootPackageInterface $aliasOf, string $version, string $prettyVersion)

All descendants' constructors should call this parent constructor

string getName()

Returns the package's name without version info, thus not a unique identifier

from BasePackage
string getPrettyName()

Returns the package's pretty (i.e.

from BasePackage
array getNames()

Returns a set of names that could refer to this package

from BasePackage
setId(int $id)

Allows the solver to set an id for this package to refer to it.

from BasePackage
int getId()

Retrieves the package's id set through setId

from BasePackage
setRepository(RepositoryInterface $repository)

Stores a reference to the repository that owns the package

from BasePackage
RepositoryInterface getRepository()

Returns a reference to the repository that owns the package

from BasePackage
array getTransportOptions()

Returns a list of options to download package dist files

from AliasPackage
setTransportOptions(array $options)

Configures the list of options to download package dist files

from AliasPackage
bool isPlatform()

checks if this package is a platform package

from BasePackage
string getUniqueName()

Returns package unique name, constructed from name and version.

from BasePackage
equals(PackageInterface $package)

from BasePackage
string __toString()

Converts the package into a readable and unique string

from AliasPackage
string getPrettyString()

Converts the package into a pretty readable string

from BasePackage
string getFullPrettyVersion(bool $truncate = true)

Returns the pretty version string plus a git or hg commit hash of this package

from BasePackage
getStabilityPriority()

from BasePackage
__clone()

PackageInterface getAliasOf()

from AliasPackage
string getVersion()

Returns the version of this package

from AliasPackage
string getStability()

Returns the stability of this package: one of (dev, alpha, beta, RC, stable)

from AliasPackage
string getPrettyVersion()

Returns the pretty (i.e.

from AliasPackage
bool isDev()

Returns whether the package is a development virtual package or a concrete one

from AliasPackage
Link[] getRequires()

Returns a set of links to packages which need to be installed before this package can be installed

from AliasPackage
Link[] getConflicts()

Returns a set of links to packages which must not be installed at the same time as this package

from AliasPackage
Link[] getProvides()

Returns a set of links to virtual packages that are provided through this package

from AliasPackage
Link[] getReplaces()

Returns a set of links to packages which can alternatively be satisfied by installing this package

from AliasPackage
Link[] getDevRequires()

Returns a set of links to packages which are required to develop this package.

from AliasPackage
mixed setRootPackageAlias(bool $value)

Stores whether this is an alias created by an aliasing in the requirements of the root package or not

from AliasPackage
bool isRootPackageAlias()

from AliasPackage
string getType()

Returns the package type, e.g.

from AliasPackage
string getTargetDir()

Returns the package targetDir property

from AliasPackage
array getExtra()

Returns the package extra data

from AliasPackage
setInstallationSource(string $type)

Sets source from which this package was installed (source/dist).

from AliasPackage
string getInstallationSource()

Returns source from which this package was installed (source/dist).

from AliasPackage
string getSourceType()

Returns the repository type of this package, e.g.

from AliasPackage
string getSourceUrl()

Returns the repository url of this package, e.g.

from AliasPackage
array getSourceUrls()

Returns the repository urls of this package including mirrors, e.g.

from AliasPackage
string getSourceReference()

Returns the repository reference of this package, e.g.

from AliasPackage
setSourceReference($reference)

from AliasPackage
setSourceMirrors($mirrors)

from AliasPackage
array|null getSourceMirrors()

Returns the source mirrors of this package

from AliasPackage
string getDistType()

Returns the type of the distribution archive of this version, e.g.

from AliasPackage
string getDistUrl()

Returns the url of the distribution archive of this version

from AliasPackage
array getDistUrls()

Returns the urls of the distribution archive of this version, including mirrors

from AliasPackage
string getDistReference()

Returns the reference of the distribution archive of this version, e.g.

from AliasPackage
setDistReference($reference)

from AliasPackage
string getDistSha1Checksum()

Returns the sha1 checksum for the distribution archive of this version

from AliasPackage
setDistMirrors($mirrors)

from AliasPackage
array|null getDistMirrors()

Returns the dist mirrors of this package

from AliasPackage
array getScripts()

Returns the scripts of this package

from AliasPackage
array getLicense()

Returns the package license, e.g.

from AliasPackage
array getAutoload()

Returns an associative array of autoloading rules

from AliasPackage
array getDevAutoload()

Returns an associative array of dev autoloading rules

from AliasPackage
array getIncludePaths()

Returns a list of directories which should get added to PHP's include path.

from AliasPackage
array getRepositories()

Returns an array of repositories

from AliasPackage
DateTime getReleaseDate()

Returns the release date of the package

from AliasPackage
array getBinaries()

Returns the package binaries

from AliasPackage
array getKeywords()

Returns an array of keywords relating to the package

from AliasPackage
string getDescription()

Returns the package description

from AliasPackage
string getHomepage()

Returns the package homepage

from AliasPackage
array getSuggests()

Returns a set of package names and reasons why they are useful in combination with this package.

from AliasPackage
array getAuthors()

Returns an array of authors of the package

from AliasPackage
array getSupport()

Returns the support information

from AliasPackage
string getNotificationUrl()

Returns the package notification url

from AliasPackage
array getArchiveExcludes()

Returns a list of patterns to exclude from package archives

from AliasPackage
bool isAbandoned()

Returns if the package is abandoned or not

from AliasPackage
string getReplacementPackage()

If the package is abandoned and has a suggested replacement, this method returns it

from AliasPackage
array getAliases()

Returns a set of package names and their aliases

string getMinimumStability()

Returns the minimum stability of the package

array getStabilityFlags()

Returns the stability flags to apply to dependencies

array getReferences()

Returns a set of package names and source references that must be enforced on them

bool getPreferStable()

Returns true if the root package prefers picking stable packages over unstable ones

array getConfig()

Returns the root package's configuration

setRequires(array $require)

Set the required packages

setDevRequires(array $devRequire)

Set the recommended packages

setConflicts(array $conflicts)

Set the conflicting packages

setProvides(array $provides)

Set the provided virtual packages

setReplaces(array $replaces)

Set the packages this one replaces

setRepositories(array $repositories)

Set the repositories

setAutoload(array $autoload)

Set the autoload mapping

setDevAutoload(array $devAutoload)

Set the dev autoload mapping

setStabilityFlags(array $stabilityFlags)

Set the stabilityFlags

setSuggests(array $suggests)

Set the suggested packages

setExtra(array $extra)

Details

at line 20
public __construct(RootPackageInterface $aliasOf, string $version, string $prettyVersion)

All descendants' constructors should call this parent constructor

Parameters

RootPackageInterface $aliasOf The package this package is an alias of
string $version The version the alias must report
string $prettyVersion The alias's non-normalized version

in BasePackage at line 75
public string getName()

Returns the package's name without version info, thus not a unique identifier

Return Value

string package name

in BasePackage at line 83
public string getPrettyName()

Returns the package's pretty (i.e.

with proper case) name

Return Value

string package name

in BasePackage at line 91
public array getNames()

Returns a set of names that could refer to this package

No version or release type information should be included in any of the names. Provided or replaced package names need to be returned as well.

Return Value

array An array of strings referring to this package

in BasePackage at line 111
public setId(int $id)

Allows the solver to set an id for this package to refer to it.

Parameters

int $id

in BasePackage at line 119
public int getId()

Retrieves the package's id set through setId

Return Value

int The previously set package id

in BasePackage at line 127
public setRepository(RepositoryInterface $repository)

Stores a reference to the repository that owns the package

Parameters

RepositoryInterface $repository

in BasePackage at line 138
public RepositoryInterface getRepository()

Returns a reference to the repository that owns the package

Return Value

RepositoryInterface

in AliasPackage at line 295
public array getTransportOptions()

Returns a list of options to download package dist files

Return Value

array

in AliasPackage at line 290
public setTransportOptions(array $options)

Configures the list of options to download package dist files

Parameters

array $options

in BasePackage at line 166
public bool isPlatform()

checks if this package is a platform package

Return Value

bool

in BasePackage at line 176
public string getUniqueName()

Returns package unique name, constructed from name and version.

Return Value

string

in BasePackage at line 181
public equals(PackageInterface $package)

Parameters

PackageInterface $package

in AliasPackage at line 400
public string __toString()

Converts the package into a readable and unique string

Return Value

string

in BasePackage at line 204
public string getPrettyString()

Converts the package into a pretty readable string

Return Value

string

in BasePackage at line 212
public string getFullPrettyVersion(bool $truncate = true)

Returns the pretty version string plus a git or hg commit hash of this package

Parameters

bool $truncate If the source reference is a sha1 hash, truncate it

Return Value

string version

in BasePackage at line 226
public getStabilityPriority()

at line 168
public __clone()

in AliasPackage at line 68
public PackageInterface getAliasOf()

Return Value

PackageInterface

in AliasPackage at line 76
public string getVersion()

Returns the version of this package

Return Value

string version

in AliasPackage at line 84
public string getStability()

Returns the stability of this package: one of (dev, alpha, beta, RC, stable)

Return Value

string

in AliasPackage at line 92
public string getPrettyVersion()

Returns the pretty (i.e.

non-normalized) version string of this package

Return Value

string version

in AliasPackage at line 100
public bool isDev()

Returns whether the package is a development virtual package or a concrete one

Return Value

bool

in AliasPackage at line 108
public Link[] getRequires()

Returns a set of links to packages which need to be installed before this package can be installed

Return Value

Link[] An array of package links defining required packages

in AliasPackage at line 116
public Link[] getConflicts()

Returns a set of links to packages which must not be installed at the same time as this package

Return Value

Link[] An array of package links defining conflicting packages

in AliasPackage at line 124
public Link[] getProvides()

Returns a set of links to virtual packages that are provided through this package

Return Value

Link[] An array of package links defining provided packages

in AliasPackage at line 132
public Link[] getReplaces()

Returns a set of links to packages which can alternatively be satisfied by installing this package

Return Value

Link[] An array of package links defining replaced packages

in AliasPackage at line 140
public Link[] getDevRequires()

Returns a set of links to packages which are required to develop this package.

These are installed if in dev mode.

Return Value

Link[] An array of package links defining packages required for development

in AliasPackage at line 154
public mixed setRootPackageAlias(bool $value)

Stores whether this is an alias created by an aliasing in the requirements of the root package or not

Use by the policy for sorting manually aliased packages first, see #576

Parameters

bool $value

Return Value

mixed

in AliasPackage at line 163
public bool isRootPackageAlias()

Return Value

bool

See also

setRootPackageAlias

in AliasPackage at line 200
public string getType()

Returns the package type, e.g.

library

Return Value

string The package type

in AliasPackage at line 205
public string getTargetDir()

Returns the package targetDir property

Return Value

string The package targetDir

in AliasPackage at line 210
public array getExtra()

Returns the package extra data

Return Value

array The package extra data

in AliasPackage at line 215
public setInstallationSource(string $type)

Sets source from which this package was installed (source/dist).

Parameters

string $type source/dist

in AliasPackage at line 220
public string getInstallationSource()

Returns source from which this package was installed (source/dist).

Return Value

string source/dist

in AliasPackage at line 225
public string getSourceType()

Returns the repository type of this package, e.g.

git, svn

Return Value

string The repository type

in AliasPackage at line 230
public string getSourceUrl()

Returns the repository url of this package, e.g.

git://github.com/naderman/composer.git

Return Value

string The repository url

in AliasPackage at line 235
public array getSourceUrls()

Returns the repository urls of this package including mirrors, e.g.

git://github.com/naderman/composer.git

Return Value

array

in AliasPackage at line 240
public string getSourceReference()

Returns the repository reference of this package, e.g.

master, 1.0.0 or a commit hash for git

Return Value

string The repository reference

in AliasPackage at line 245
public setSourceReference($reference)

Parameters

$reference

in AliasPackage at line 250
public setSourceMirrors($mirrors)

Parameters

$mirrors

in AliasPackage at line 255
public array|null getSourceMirrors()

Returns the source mirrors of this package

Return Value

array|null

in AliasPackage at line 260
public string getDistType()

Returns the type of the distribution archive of this version, e.g.

zip, tarball

Return Value

string The repository type

in AliasPackage at line 265
public string getDistUrl()

Returns the url of the distribution archive of this version

Return Value

string

in AliasPackage at line 270
public array getDistUrls()

Returns the urls of the distribution archive of this version, including mirrors

Return Value

array

in AliasPackage at line 275
public string getDistReference()

Returns the reference of the distribution archive of this version, e.g.

master, 1.0.0 or a commit hash for git

Return Value

string

in AliasPackage at line 280
public setDistReference($reference)

Parameters

$reference

in AliasPackage at line 285
public string getDistSha1Checksum()

Returns the sha1 checksum for the distribution archive of this version

Return Value

string

in AliasPackage at line 300
public setDistMirrors($mirrors)

Parameters

$mirrors

in AliasPackage at line 305
public array|null getDistMirrors()

Returns the dist mirrors of this package

Return Value

array|null

in AliasPackage at line 310
public array getScripts()

Returns the scripts of this package

Return Value

array array('script name' => array('listeners'))

in AliasPackage at line 315
public array getLicense()

Returns the package license, e.g.

MIT, BSD, GPL

Return Value

array The package licenses

in AliasPackage at line 320
public array getAutoload()

Returns an associative array of autoloading rules

{"": {"<namespace": ""}}

Type is either "psr-4", "psr-0", "classmap" or "files". Namespaces are mapped to directories for autoloading using the type specified.

Return Value

array Mapping of autoloading rules

in AliasPackage at line 325
public array getDevAutoload()

Returns an associative array of dev autoloading rules

{"": {"<namespace": ""}}

Type is either "psr-4", "psr-0", "classmap" or "files". Namespaces are mapped to directories for autoloading using the type specified.

Return Value

array Mapping of dev autoloading rules

in AliasPackage at line 330
public array getIncludePaths()

Returns a list of directories which should get added to PHP's include path.

Return Value

array

in AliasPackage at line 335
public array getRepositories()

Returns an array of repositories

{"": {}}

Return Value

array Repositories

in AliasPackage at line 340
public DateTime getReleaseDate()

Returns the release date of the package

Return Value

DateTime

in AliasPackage at line 345
public array getBinaries()

Returns the package binaries

Return Value

array

in AliasPackage at line 350
public array getKeywords()

Returns an array of keywords relating to the package

Return Value

array

in AliasPackage at line 355
public string getDescription()

Returns the package description

Return Value

string

in AliasPackage at line 360
public string getHomepage()

Returns the package homepage

Return Value

string

in AliasPackage at line 365
public array getSuggests()

Returns a set of package names and reasons why they are useful in combination with this package.

Return Value

array An array of package suggestions with descriptions

in AliasPackage at line 370
public array getAuthors()

Returns an array of authors of the package

Each item can contain name/homepage/email keys

Return Value

array

in AliasPackage at line 375
public array getSupport()

Returns the support information

Return Value

array

in AliasPackage at line 380
public string getNotificationUrl()

Returns the package notification url

Return Value

string

in AliasPackage at line 385
public array getArchiveExcludes()

Returns a list of patterns to exclude from package archives

Return Value

array

in AliasPackage at line 390
public bool isAbandoned()

Returns if the package is abandoned or not

Return Value

bool

in AliasPackage at line 395
public string getReplacementPackage()

If the package is abandoned and has a suggested replacement, this method returns it

Return Value

string

at line 28
public array getAliases()

Returns a set of package names and their aliases

Return Value

array

at line 36
public string getMinimumStability()

Returns the minimum stability of the package

Return Value

string

at line 44
public array getStabilityFlags()

Returns the stability flags to apply to dependencies

array('foo/bar' => 'dev')

Return Value

array

at line 52
public array getReferences()

Returns a set of package names and source references that must be enforced on them

array('foo/bar' => 'abcd1234')

Return Value

array

at line 60
public bool getPreferStable()

Returns true if the root package prefers picking stable packages over unstable ones

Return Value

bool

at line 68
public array getConfig()

Returns the root package's configuration

Return Value

array

at line 76
public setRequires(array $require)

Set the required packages

Parameters

array $require

at line 86
public setDevRequires(array $devRequire)

Set the recommended packages

Parameters

array $devRequire

at line 96
public setConflicts(array $conflicts)

Set the conflicting packages

Parameters

array $conflicts A set of package links

at line 105
public setProvides(array $provides)

Set the provided virtual packages

Parameters

array $provides A set of package links

at line 114
public setReplaces(array $replaces)

Set the packages this one replaces

Parameters

array $replaces A set of package links

at line 123
public setRepositories(array $repositories)

Set the repositories

Parameters

array $repositories

at line 131
public setAutoload(array $autoload)

Set the autoload mapping

Parameters

array $autoload Mapping of autoloading rules

at line 139
public setDevAutoload(array $devAutoload)

Set the dev autoload mapping

Parameters

array $devAutoload Mapping of dev autoloading rules

at line 147
public setStabilityFlags(array $stabilityFlags)

Set the stabilityFlags

Parameters

array $stabilityFlags

at line 155
public setSuggests(array $suggests)

Set the suggested packages

Parameters

array $suggests A set of package names/comments

at line 163
public setExtra(array $extra)

Parameters

array $extra