Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. CompletePackage.php

class CompletePackage

Package containing additional metadata that is not used by the solver

@author Nils Adermann <naderman@naderman.de>

Hierarchy

  • class \Composer\Package\BasePackage implements \Composer\Package\PackageInterface
    • class \Composer\Package\Package extends \Composer\Package\BasePackage
      • class \Composer\Package\CompletePackage extends \Composer\Package\Package implements \Composer\Package\CompletePackageInterface

Expanded class hierarchy of CompletePackage

10 files declare their use of CompletePackage
ArrayLoader.php in vendor/composer/composer/src/Composer/Package/Loader/ArrayLoader.php
ArrayRepository.php in vendor/composer/composer/src/Composer/Repository/ArrayRepository.php
ComposerRepository.php in vendor/composer/composer/src/Composer/Repository/ComposerRepository.php
Installer.php in vendor/composer/composer/src/Composer/Installer.php
JsonLoader.php in vendor/composer/composer/src/Composer/Package/Loader/JsonLoader.php

... See full list

File

vendor/composer/composer/src/Composer/Package/CompletePackage.php, line 20

Namespace

Composer\Package
View source
class CompletePackage extends Package implements CompletePackageInterface {
    
    /** @var mixed[] */
    protected $repositories = [];
    
    /** @var string[] */
    protected $license = [];
    
    /** @var string[] */
    protected $keywords = [];
    
    /** @var array<array{name?: string, homepage?: string, email?: string, role?: string}> */
    protected $authors = [];
    
    /** @var ?string */
    protected $description = null;
    
    /** @var ?string */
    protected $homepage = null;
    
    /** @var array<string, string[]> Map of script name to array of handlers */
    protected $scripts = [];
    
    /** @var array{issues?: string, forum?: string, wiki?: string, source?: string, email?: string, irc?: string, docs?: string, rss?: string, chat?: string, security?: string} */
    protected $support = [];
    
    /** @var array<array{url?: string, type?: string}> */
    protected $funding = [];
    
    /** @var bool|string */
    protected $abandoned = false;
    
    /** @var ?string */
    protected $archiveName = null;
    
    /** @var string[] */
    protected $archiveExcludes = [];
    
    /**
     * @inheritDoc
     */
    public function setScripts(array $scripts) : void {
        $this->scripts = $scripts;
    }
    
    /**
     * @inheritDoc
     */
    public function getScripts() : array {
        return $this->scripts;
    }
    
    /**
     * @inheritDoc
     */
    public function setRepositories(array $repositories) : void {
        $this->repositories = $repositories;
    }
    
    /**
     * @inheritDoc
     */
    public function getRepositories() : array {
        return $this->repositories;
    }
    
    /**
     * @inheritDoc
     */
    public function setLicense(array $license) : void {
        $this->license = $license;
    }
    
    /**
     * @inheritDoc
     */
    public function getLicense() : array {
        return $this->license;
    }
    
    /**
     * @inheritDoc
     */
    public function setKeywords(array $keywords) : void {
        $this->keywords = $keywords;
    }
    
    /**
     * @inheritDoc
     */
    public function getKeywords() : array {
        return $this->keywords;
    }
    
    /**
     * @inheritDoc
     */
    public function setAuthors(array $authors) : void {
        $this->authors = $authors;
    }
    
    /**
     * @inheritDoc
     */
    public function getAuthors() : array {
        return $this->authors;
    }
    
    /**
     * @inheritDoc
     */
    public function setDescription(?string $description) : void {
        $this->description = $description;
    }
    
    /**
     * @inheritDoc
     */
    public function getDescription() : ?string {
        return $this->description;
    }
    
    /**
     * @inheritDoc
     */
    public function setHomepage(?string $homepage) : void {
        $this->homepage = $homepage;
    }
    
    /**
     * @inheritDoc
     */
    public function getHomepage() : ?string {
        return $this->homepage;
    }
    
    /**
     * @inheritDoc
     */
    public function setSupport(array $support) : void {
        $this->support = $support;
    }
    
    /**
     * @inheritDoc
     */
    public function getSupport() : array {
        return $this->support;
    }
    
    /**
     * @inheritDoc
     */
    public function setFunding(array $funding) : void {
        $this->funding = $funding;
    }
    
    /**
     * @inheritDoc
     */
    public function getFunding() : array {
        return $this->funding;
    }
    
    /**
     * @inheritDoc
     */
    public function isAbandoned() : bool {
        return (bool) $this->abandoned;
    }
    
    /**
     * @inheritDoc
     */
    public function setAbandoned($abandoned) : void {
        $this->abandoned = $abandoned;
    }
    
    /**
     * @inheritDoc
     */
    public function getReplacementPackage() : ?string {
        return \is_string($this->abandoned) ? $this->abandoned : null;
    }
    
    /**
     * @inheritDoc
     */
    public function setArchiveName(?string $name) : void {
        $this->archiveName = $name;
    }
    
    /**
     * @inheritDoc
     */
    public function getArchiveName() : ?string {
        return $this->archiveName;
    }
    
    /**
     * @inheritDoc
     */
    public function setArchiveExcludes(array $excludes) : void {
        $this->archiveExcludes = $excludes;
    }
    
    /**
     * @inheritDoc
     */
    public function getArchiveExcludes() : array {
        return $this->archiveExcludes;
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
BasePackage::$id public property READ-ONLY: The package id, public for fast access in dependency solver
@internal
BasePackage::$name protected property @var string
BasePackage::$prettyName protected property @var string
BasePackage::$repository protected property @var ?RepositoryInterface
BasePackage::$stabilities Deprecated public static property @phpstan-ignore property.readOnlyByPhpDocDefaultValue
BasePackage::$supportedLinkTypes public static property @phpstan-var array&lt;non-empty-string, array{description: string, method: Link::TYPE_*}&gt;
@internal
BasePackage::equals public function
BasePackage::getFullPrettyVersion public function @inheritDoc Overrides PackageInterface::getFullPrettyVersion
BasePackage::getId public function @inheritDoc Overrides PackageInterface::getId
BasePackage::getName public function @inheritDoc Overrides PackageInterface::getName
BasePackage::getNames public function @inheritDoc Overrides PackageInterface::getNames
BasePackage::getPrettyName public function @inheritDoc Overrides PackageInterface::getPrettyName
BasePackage::getPrettyString public function Converts the package into a pretty readable string Overrides PackageInterface::getPrettyString
BasePackage::getRepository public function @inheritDoc Overrides PackageInterface::getRepository
BasePackage::getStabilityPriority public function @phpstan-return self::STABILITY_*
BasePackage::getUniqueName public function Returns package unique name, constructed from name, version and release type. Overrides PackageInterface::getUniqueName
BasePackage::isPlatform public function checks if this package is a platform package
BasePackage::packageNamesToRegexp public static function Build a regexp from package names, expanding * globs as required
BasePackage::packageNameToRegexp public static function Build a regexp from a package name, expanding * globs as required
BasePackage::setId public function @inheritDoc Overrides PackageInterface::setId
BasePackage::setRepository public function @inheritDoc Overrides PackageInterface::setRepository
BasePackage::STABILITIES public constant
BasePackage::STABILITY_ALPHA public constant
BasePackage::STABILITY_BETA public constant
BasePackage::STABILITY_DEV public constant
BasePackage::STABILITY_RC public constant
BasePackage::STABILITY_STABLE public constant
BasePackage::__clone public function 1
BasePackage::__toString public function Converts the package into a readable and unique string Overrides PackageInterface::__toString 1
CompletePackage::$abandoned protected property @var bool|string
CompletePackage::$archiveExcludes protected property @var string[]
CompletePackage::$archiveName protected property @var ?string
CompletePackage::$authors protected property @var array&lt;array{name?: string, homepage?: string, email?: string, role?: string}&gt;
CompletePackage::$description protected property @var ?string
CompletePackage::$funding protected property @var array&lt;array{url?: string, type?: string}&gt;
CompletePackage::$homepage protected property @var ?string
CompletePackage::$keywords protected property @var string[]
CompletePackage::$license protected property @var string[]
CompletePackage::$repositories protected property @var mixed[]
CompletePackage::$scripts protected property @var array&lt;string, string[]&gt; Map of script name to array of handlers
CompletePackage::$support protected property @var array{issues?: string, forum?: string, wiki?: string, source?: string, email?: string, irc?: string, docs?: string, rss?: string, chat?: string, security?: string}
CompletePackage::getArchiveExcludes public function @inheritDoc Overrides CompletePackageInterface::getArchiveExcludes
CompletePackage::getArchiveName public function @inheritDoc Overrides CompletePackageInterface::getArchiveName
CompletePackage::getAuthors public function @inheritDoc Overrides CompletePackageInterface::getAuthors
CompletePackage::getDescription public function @inheritDoc Overrides CompletePackageInterface::getDescription
CompletePackage::getFunding public function @inheritDoc Overrides CompletePackageInterface::getFunding
CompletePackage::getHomepage public function @inheritDoc Overrides CompletePackageInterface::getHomepage
CompletePackage::getKeywords public function @inheritDoc Overrides CompletePackageInterface::getKeywords
CompletePackage::getLicense public function @inheritDoc Overrides CompletePackageInterface::getLicense
CompletePackage::getReplacementPackage public function @inheritDoc Overrides CompletePackageInterface::getReplacementPackage
CompletePackage::getRepositories public function @inheritDoc Overrides CompletePackageInterface::getRepositories
CompletePackage::getScripts public function @inheritDoc Overrides CompletePackageInterface::getScripts
CompletePackage::getSupport public function @inheritDoc Overrides CompletePackageInterface::getSupport
CompletePackage::isAbandoned public function @inheritDoc Overrides CompletePackageInterface::isAbandoned
CompletePackage::setAbandoned public function @inheritDoc Overrides CompletePackageInterface::setAbandoned
CompletePackage::setArchiveExcludes public function @inheritDoc Overrides CompletePackageInterface::setArchiveExcludes
CompletePackage::setArchiveName public function @inheritDoc Overrides CompletePackageInterface::setArchiveName
CompletePackage::setAuthors public function @inheritDoc Overrides CompletePackageInterface::setAuthors
CompletePackage::setDescription public function @inheritDoc Overrides CompletePackageInterface::setDescription
CompletePackage::setFunding public function @inheritDoc Overrides CompletePackageInterface::setFunding
CompletePackage::setHomepage public function @inheritDoc Overrides CompletePackageInterface::setHomepage
CompletePackage::setKeywords public function @inheritDoc Overrides CompletePackageInterface::setKeywords
CompletePackage::setLicense public function @inheritDoc Overrides CompletePackageInterface::setLicense
CompletePackage::setRepositories public function @inheritDoc Overrides CompletePackageInterface::setRepositories
CompletePackage::setScripts public function @inheritDoc Overrides CompletePackageInterface::setScripts
CompletePackage::setSupport public function @inheritDoc Overrides CompletePackageInterface::setSupport
Package::$autoload protected property @phpstan-var AutoloadRules
Package::$binaries protected property @var string[]
Package::$conflicts protected property @var array&lt;string, Link&gt;
Package::$dev protected property @var bool
Package::$devAutoload protected property @phpstan-var DevAutoloadRules
Package::$devRequires protected property @var array&lt;string, Link&gt;
Package::$distMirrors protected property @var ?list&lt;array{url: non-empty-string, preferred: bool}&gt;
Package::$distReference protected property @var ?string
Package::$distSha1Checksum protected property @var ?string
Package::$distType protected property @var ?non-empty-string
Package::$distUrl protected property @var ?non-empty-string
Package::$extra protected property @var mixed[]
Package::$includePaths protected property @var string[]
Package::$installationSource protected property @var &#039;source&#039;|&#039;dist&#039;|null
Package::$isDefaultBranch protected property @var bool
Package::$notificationUrl protected property @var ?string
Package::$phpExt protected property @var array{priority?: int, configure-options?: list&lt;array{name: string, description?: string}&gt;}|null
Package::$prettyVersion protected property @var string
Package::$provides protected property @var array&lt;string, Link&gt;
Package::$releaseDate protected property @var ?\DateTimeInterface
Package::$replaces protected property @var array&lt;string, Link&gt;
Package::$requires protected property @var array&lt;string, Link&gt;
Package::$sourceMirrors protected property @var ?list&lt;array{url: non-empty-string, preferred: bool}&gt;
Package::$sourceReference protected property @var ?string
Package::$sourceType protected property @var ?string
Package::$sourceUrl protected property @var ?string
Package::$stability protected property @phpstan-var &#039;stable&#039;|&#039;RC&#039;|&#039;beta&#039;|&#039;alpha&#039;|&#039;dev&#039;
Package::$suggests protected property @var array&lt;string, string&gt;
Package::$targetDir protected property @var ?string
Package::$transportOptions protected property @var mixed[]
Package::$type protected property @var string
Package::$version protected property @var string
Package::convertLinksToMap private function
Package::getAutoload public function @inheritDoc Overrides PackageInterface::getAutoload
Package::getBinaries public function @inheritDoc Overrides PackageInterface::getBinaries
Package::getConflicts public function @inheritDoc Overrides PackageInterface::getConflicts
Package::getDevAutoload public function @inheritDoc Overrides PackageInterface::getDevAutoload
Package::getDevRequires public function @inheritDoc Overrides PackageInterface::getDevRequires
Package::getDistMirrors public function @inheritDoc Overrides PackageInterface::getDistMirrors
Package::getDistReference public function @inheritDoc Overrides PackageInterface::getDistReference
Package::getDistSha1Checksum public function @inheritDoc Overrides PackageInterface::getDistSha1Checksum
Package::getDistType public function @inheritDoc Overrides PackageInterface::getDistType
Package::getDistUrl public function @inheritDoc Overrides PackageInterface::getDistUrl
Package::getDistUrls public function @inheritDoc Overrides PackageInterface::getDistUrls
Package::getExtra public function @inheritDoc Overrides PackageInterface::getExtra
Package::getIncludePaths public function @inheritDoc Overrides PackageInterface::getIncludePaths
Package::getInstallationSource public function @inheritDoc Overrides PackageInterface::getInstallationSource
Package::getNotificationUrl public function @inheritDoc Overrides PackageInterface::getNotificationUrl
Package::getPhpExt public function @inheritDoc Overrides PackageInterface::getPhpExt
Package::getPrettyVersion public function @inheritDoc Overrides PackageInterface::getPrettyVersion
Package::getProvides public function @inheritDoc Overrides PackageInterface::getProvides
Package::getReleaseDate public function @inheritDoc Overrides PackageInterface::getReleaseDate
Package::getReplaces public function @inheritDoc Overrides PackageInterface::getReplaces
Package::getRequires public function @inheritDoc Overrides PackageInterface::getRequires
Package::getSourceMirrors public function @inheritDoc Overrides PackageInterface::getSourceMirrors
Package::getSourceReference public function @inheritDoc Overrides PackageInterface::getSourceReference
Package::getSourceType public function @inheritDoc Overrides PackageInterface::getSourceType
Package::getSourceUrl public function @inheritDoc Overrides PackageInterface::getSourceUrl
Package::getSourceUrls public function @inheritDoc Overrides PackageInterface::getSourceUrls
Package::getStability public function @inheritDoc Overrides PackageInterface::getStability
Package::getSuggests public function @inheritDoc Overrides PackageInterface::getSuggests
Package::getTargetDir public function @inheritDoc Overrides PackageInterface::getTargetDir
Package::getTransportOptions public function @inheritDoc Overrides PackageInterface::getTransportOptions
Package::getType public function @inheritDoc Overrides PackageInterface::getType
Package::getUrls protected function @phpstan-param list&lt;array{url: non-empty-string, preferred: bool}&gt;|null $mirrors
Package::getVersion public function @inheritDoc Overrides PackageInterface::getVersion
Package::isDefaultBranch public function @inheritDoc Overrides PackageInterface::isDefaultBranch
Package::isDev public function @inheritDoc Overrides PackageInterface::isDev
Package::replaceVersion public function Replaces current version and pretty version with passed values.
It also sets stability.
Package::setAutoload public function Set the autoload mapping
Package::setBinaries public function
Package::setConflicts public function Set the conflicting packages
Package::setDevAutoload public function Set the dev autoload mapping
Package::setDevRequires public function Set the recommended packages
Package::setDistMirrors public function Overrides PackageInterface::setDistMirrors
Package::setDistReference public function Overrides PackageInterface::setDistReference
Package::setDistSha1Checksum public function
Package::setDistType public function Overrides PackageInterface::setDistType
Package::setDistUrl public function Overrides PackageInterface::setDistUrl
Package::setExtra public function
Package::setIncludePaths public function Sets the list of paths added to PHP&#039;s include path.
Package::setInstallationSource public function @inheritDoc Overrides PackageInterface::setInstallationSource
Package::setIsDefaultBranch public function
Package::setNotificationUrl public function Sets the notification URL
Package::setPhpExt public function Sets the list of paths added to PHP&#039;s include path.
Package::setProvides public function Set the provided virtual packages
Package::setReleaseDate public function
Package::setReplaces public function Set the packages this one replaces
Package::setRequires public function Set the required packages
Package::setSourceDistReferences public function @inheritDoc Overrides PackageInterface::setSourceDistReferences
Package::setSourceMirrors public function Overrides PackageInterface::setSourceMirrors
Package::setSourceReference public function Overrides PackageInterface::setSourceReference
Package::setSourceType public function
Package::setSourceUrl public function
Package::setSuggests public function Set the suggested packages
Package::setTargetDir public function
Package::setTransportOptions public function @inheritDoc Overrides PackageInterface::setTransportOptions
Package::setType public function
Package::__construct public function Creates a new in memory package. Overrides BasePackage::__construct
PackageInterface::DISPLAY_DIST_REF public constant
PackageInterface::DISPLAY_SOURCE_REF public constant
PackageInterface::DISPLAY_SOURCE_REF_IF_DEV public constant

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal