Composer API
Class

Composer\Package\Package

class Package extends BasePackage

Core package definitions that are needed to resolve dependencies and install packages

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(string $name, string $version, string $prettyVersion)

Creates a new in memory package.

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 BasePackage
setTransportOptions(array $options)

Configures the list of options to download package dist files

from BasePackage
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 BasePackage
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()

from BasePackage
bool isDev()

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

setType(string $type)

string getType()

Returns the package type, e.g.

string getStability()

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

setTargetDir(string $targetDir)

string getTargetDir()

Returns the package targetDir property

setExtra(array $extra)

array getExtra()

Returns the package extra data

setBinaries(array $binaries)

array getBinaries()

Returns the package binaries

setInstallationSource(string $type)

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

string getInstallationSource()

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

setSourceType(string $type)

string getSourceType()

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

setSourceUrl(string $url)

string getSourceUrl()

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

setSourceReference(string $reference)

string getSourceReference()

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

setSourceMirrors(array|null $mirrors)

array|null getSourceMirrors()

Returns the source mirrors of this package

array getSourceUrls()

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

setDistType(string $type)

string getDistType()

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

setDistUrl(string $url)

string getDistUrl()

Returns the url of the distribution archive of this version

setDistReference(string $reference)

string getDistReference()

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

setDistSha1Checksum(string $sha1checksum)

string getDistSha1Checksum()

Returns the sha1 checksum for the distribution archive of this version

setDistMirrors(array|null $mirrors)

array|null getDistMirrors()

Returns the dist mirrors of this package

array getDistUrls()

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

string getVersion()

Returns the version of this package

string getPrettyVersion()

Returns the pretty (i.e.

setReleaseDate(DateTime $releaseDate)

Set the releaseDate

DateTime getReleaseDate()

Returns the release date of the package

setRequires(array $requires)

Set the required packages

Link[] getRequires()

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

setConflicts(array $conflicts)

Set the conflicting packages

Link[] getConflicts()

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

setProvides(array $provides)

Set the provided virtual packages

Link[] getProvides()

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

setReplaces(array $replaces)

Set the packages this one replaces

Link[] getReplaces()

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

setDevRequires(array $devRequires)

Set the recommended packages

Link[] getDevRequires()

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

setSuggests(array $suggests)

Set the suggested packages

array getSuggests()

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

setAutoload(array $autoload)

Set the autoload mapping

array getAutoload()

Returns an associative array of autoloading rules

setDevAutoload(array $devAutoload)

Set the dev autoload mapping

array getDevAutoload()

Returns an associative array of dev autoloading rules

setIncludePaths(array $includePaths)

Sets the list of paths added to PHP's include path.

array getIncludePaths()

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

setNotificationUrl(string $notificationUrl)

Sets the notification URL

string getNotificationUrl()

Returns the package notification url

setArchiveExcludes(array $excludes)

Sets a list of patterns to be excluded from archives

array getArchiveExcludes()

Returns a list of patterns to exclude from package archives

replaceVersion(string $version, string $prettyVersion)

Replaces current version and pretty version with passed values.

Details

at line 69
public __construct(string $name, string $version, string $prettyVersion)

Creates a new in memory package.

Parameters

string $name The package's name
string $version The package's version
string $prettyVersion The package'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 BasePackage at line 146
public array getTransportOptions()

Returns a list of options to download package dist files

Return Value

array

in BasePackage at line 156
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 BasePackage at line 199
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()

in BasePackage at line 231
public __clone()

at line 83
public bool isDev()

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

Return Value

bool

at line 91
public setType(string $type)

Parameters

string $type

at line 99
public string getType()

Returns the package type, e.g.

library

Return Value

string The package type

at line 107
public string getStability()

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

Return Value

string

at line 115
public setTargetDir(string $targetDir)

Parameters

string $targetDir

at line 123
public string getTargetDir()

Returns the package targetDir property

Return Value

string The package targetDir

at line 135
public setExtra(array $extra)

Parameters

array $extra

at line 143
public array getExtra()

Returns the package extra data

Return Value

array The package extra data

at line 151
public setBinaries(array $binaries)

Parameters

array $binaries

at line 159
public array getBinaries()

Returns the package binaries

Return Value

array

at line 167
public setInstallationSource(string $type)

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

Parameters

string $type source/dist

at line 175
public string getInstallationSource()

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

Return Value

string source/dist

at line 183
public setSourceType(string $type)

Parameters

string $type

at line 191
public string getSourceType()

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

git, svn

Return Value

string The repository type

at line 199
public setSourceUrl(string $url)

Parameters

string $url

at line 207
public string getSourceUrl()

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

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

Return Value

string The repository url

at line 215
public setSourceReference(string $reference)

Parameters

string $reference

at line 223
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

at line 231
public setSourceMirrors(array|null $mirrors)

Parameters

array|null $mirrors

at line 239
public array|null getSourceMirrors()

Returns the source mirrors of this package

Return Value

array|null

at line 247
public array getSourceUrls()

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

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

Return Value

array

at line 255
public setDistType(string $type)

Parameters

string $type

at line 263
public string getDistType()

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

zip, tarball

Return Value

string The repository type

at line 271
public setDistUrl(string $url)

Parameters

string $url

at line 279
public string getDistUrl()

Returns the url of the distribution archive of this version

Return Value

string

at line 287
public setDistReference(string $reference)

Parameters

string $reference

at line 295
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

at line 303
public setDistSha1Checksum(string $sha1checksum)

Parameters

string $sha1checksum

at line 311
public string getDistSha1Checksum()

Returns the sha1 checksum for the distribution archive of this version

Return Value

string

at line 319
public setDistMirrors(array|null $mirrors)

Parameters

array|null $mirrors

at line 327
public array|null getDistMirrors()

Returns the dist mirrors of this package

Return Value

array|null

at line 335
public array getDistUrls()

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

Return Value

array

at line 343
public string getVersion()

Returns the version of this package

Return Value

string version

at line 351
public string getPrettyVersion()

Returns the pretty (i.e.

non-normalized) version string of this package

Return Value

string version

at line 361
public setReleaseDate(DateTime $releaseDate)

Set the releaseDate

Parameters

DateTime $releaseDate

at line 369
public DateTime getReleaseDate()

Returns the release date of the package

Return Value

DateTime

at line 379
public setRequires(array $requires)

Set the required packages

Parameters

array $requires A set of package links

at line 387
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

at line 397
public setConflicts(array $conflicts)

Set the conflicting packages

Parameters

array $conflicts A set of package links

at line 405
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

at line 415
public setProvides(array $provides)

Set the provided virtual packages

Parameters

array $provides A set of package links

at line 423
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

at line 433
public setReplaces(array $replaces)

Set the packages this one replaces

Parameters

array $replaces A set of package links

at line 441
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

at line 451
public setDevRequires(array $devRequires)

Set the recommended packages

Parameters

array $devRequires A set of package links

at line 459
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

at line 469
public setSuggests(array $suggests)

Set the suggested packages

Parameters

array $suggests A set of package names/comments

at line 477
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

at line 487
public setAutoload(array $autoload)

Set the autoload mapping

Parameters

array $autoload Mapping of autoloading rules

at line 495
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

at line 505
public setDevAutoload(array $devAutoload)

Set the dev autoload mapping

Parameters

array $devAutoload Mapping of dev autoloading rules

at line 513
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

at line 523
public setIncludePaths(array $includePaths)

Sets the list of paths added to PHP's include path.

Parameters

array $includePaths List of directories.

at line 531
public array getIncludePaths()

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

Return Value

array

at line 541
public setNotificationUrl(string $notificationUrl)

Sets the notification URL

Parameters

string $notificationUrl

at line 549
public string getNotificationUrl()

Returns the package notification url

Return Value

string

at line 559
public setArchiveExcludes(array $excludes)

Sets a list of patterns to be excluded from archives

Parameters

array $excludes

at line 567
public array getArchiveExcludes()

Returns a list of patterns to exclude from package archives

Return Value

array

at line 579
public replaceVersion(string $version, string $prettyVersion)

Replaces current version and pretty version with passed values.

It also sets stability.

Parameters

string $version The package's normalized version
string $prettyVersion The package's non-normalized version