Documentation

CompletePackageInterface extends PackageInterface

in

• Application

Defines package metadata that is not necessarily needed for solving and installing packages

Tags

author

Nils Adermann naderman@naderman.de

Table of Contents

__toString()  : string

Converts the package into a readable and unique string

getArchiveExcludes()  : array<string|int, mixed>

Returns a list of patterns to exclude from package archives

getAuthors()  : array<string|int, mixed>

Returns an array of authors of the package

getAutoload()  : array<string|int, mixed>

Returns an associative array of autoloading rules

getBinaries()  : array<string|int, mixed>

Returns the package binaries

getConflicts()  : array<string|int, Link>

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

getDescription()  : string

Returns the package description

getDevAutoload()  : array<string|int, mixed>

Returns an associative array of dev autoloading rules

getDevRequires()  : array<string|int, Link>

Returns a set of links to packages which are required to develop this package. These are installed if in dev mode.

getDistMirrors()  : array<string|int, mixed>|null

Returns the dist mirrors of this package

getDistReference()  : string

Returns the reference of the distribution archive of this version, e.g. master, 1.0.0 or a commit hash for git

getDistSha1Checksum()  : string

Returns the sha1 checksum for the distribution archive of this version

getDistType()  : string

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

getDistUrl()  : string

Returns the url of the distribution archive of this version

getDistUrls()  : array<string|int, mixed>

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

getExtra()  : array<string|int, mixed>

Returns the package extra data

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()  : array<string|int, mixed>

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

getInstallationSource()  : string

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

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

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()  : string

Returns the package notification url

getPrettyName()  : string

Returns the package's pretty (i.e. with proper case) name

getPrettyString()  : string

Converts the package into a pretty readable string

getPrettyVersion()  : string

Returns the pretty (i.e. non-normalized) version string of this package

getProvides()  : array<string|int, Link>

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

getReleaseDate()  : DateTime

Returns the release date of the package

getReplacementPackage()  : string

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

getReplaces()  : array<string|int, Link>

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

getRepositories()  : array<string|int, mixed>

Returns an array of repositories

getRepository()  : RepositoryInterface

Returns a reference to the repository that owns the package

getRequires()  : array<string|int, Link>

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

getScripts()  : array<string|int, mixed>

Returns the scripts of this package

getSourceMirrors()  : array<string|int, mixed>|null

Returns the source mirrors of this package

getSourceReference()  : string

Returns the repository reference of this package, e.g. master, 1.0.0 or a commit hash for git

getSourceType()  : string

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

getSourceUrl()  : string

Returns the repository url of this package, e.g. git://github.com/naderman/composer.git

getSourceUrls()  : array<string|int, mixed>

Returns the repository urls of this package including mirrors, e.g. git://github.com/naderman/composer.git

getStability()  : string

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

getSuggests()  : array<string|int, mixed>

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

getSupport()  : array<string|int, mixed>

Returns the support information

getTargetDir()  : string

Returns the package targetDir property

getTransportOptions()  : array<string|int, mixed>

Returns a list of options to download package dist files

getType()  : string

Returns the package type, e.g. library

getUniqueName()  : string

Returns package unique name, constructed from name and version.

getVersion()  : string

Returns the version of this package

isAbandoned()  : bool

Returns if the package is abandoned or not

isDev()  : bool

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

setDistReference()  : void

setDistType()  : void

setDistUrl()  : void

setId()  : mixed

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

setInstallationSource()  : mixed

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

setRepository()  : mixed

Stores a reference to the repository that owns the package

setSourceReference()  : void