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

Breadcrumb

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

interface CompletePackageInterface

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

PackageInterface & derivatives are considered internal, you may use them in type hints but extending/implementing them is not recommended and not supported. Things may change without notice.

@author Nils Adermann <naderman@naderman.de>

Hierarchy

  • interface \Composer\Package\PackageInterface
    • interface \Composer\Package\CompletePackageInterface extends \Composer\Package\PackageInterface

Expanded class hierarchy of CompletePackageInterface

All classes that implement CompletePackageInterface

18 files declare their use of CompletePackageInterface
ArchiveCommand.php in vendor/composer/composer/src/Composer/Command/ArchiveCommand.php
ArchiveManager.php in vendor/composer/composer/src/Composer/Package/Archiver/ArchiveManager.php
ArrayDumper.php in vendor/composer/composer/src/Composer/Package/Dumper/ArrayDumper.php
ArrayLoader.php in vendor/composer/composer/src/Composer/Package/Loader/ArrayLoader.php
ArrayRepository.php in vendor/composer/composer/src/Composer/Repository/ArrayRepository.php

... See full list

File

vendor/composer/composer/src/Composer/Package/CompletePackageInterface.php, line 22

Namespace

Composer\Package
View source
interface CompletePackageInterface extends PackageInterface {
    
    /**
     * Returns the scripts of this package
     *
     * @return array<string, string[]> Map of script name to array of handlers
     */
    public function getScripts() : array;
    
    /**
     * @param  array<string, string[]> $scripts
     */
    public function setScripts(array $scripts) : void;
    
    /**
     * Returns an array of repositories
     *
     * @return mixed[] Repositories
     */
    public function getRepositories() : array;
    
    /**
     * Set the repositories
     *
     * @param  mixed[] $repositories
     */
    public function setRepositories(array $repositories) : void;
    
    /**
     * Returns the package license, e.g. MIT, BSD, GPL
     *
     * @return string[] The package licenses
     */
    public function getLicense() : array;
    
    /**
     * Set the license
     *
     * @param  string[] $license
     */
    public function setLicense(array $license) : void;
    
    /**
     * Returns an array of keywords relating to the package
     *
     * @return string[]
     */
    public function getKeywords() : array;
    
    /**
     * Set the keywords
     *
     * @param  string[] $keywords
     */
    public function setKeywords(array $keywords) : void;
    
    /**
     * Returns the package description
     *
     * @return ?string
     */
    public function getDescription() : ?string;
    
    /**
     * Set the description
     */
    public function setDescription(string $description) : void;
    
    /**
     * Returns the package homepage
     *
     * @return ?string
     */
    public function getHomepage() : ?string;
    
    /**
     * Set the homepage
     */
    public function setHomepage(string $homepage) : void;
    
    /**
     * Returns an array of authors of the package
     *
     * Each item can contain name/homepage/email keys
     *
     * @return array<array{name?: string, homepage?: string, email?: string, role?: string}>
     */
    public function getAuthors() : array;
    
    /**
     * Set the authors
     *
     * @param  array<array{name?: string, homepage?: string, email?: string, role?: string}> $authors
     */
    public function setAuthors(array $authors) : void;
    
    /**
     * Returns the support information
     *
     * @return array{issues?: string, forum?: string, wiki?: string, source?: string, email?: string, irc?: string, docs?: string, rss?: string, chat?: string, security?: string}
     */
    public function getSupport() : array;
    
    /**
     * Set the support information
     *
     * @param  array{issues?: string, forum?: string, wiki?: string, source?: string, email?: string, irc?: string, docs?: string, rss?: string, chat?: string, security?: string} $support
     */
    public function setSupport(array $support) : void;
    
    /**
     * Returns an array of funding options for the package
     *
     * Each item will contain type and url keys
     *
     * @return array<array{type?: string, url?: string}>
     */
    public function getFunding() : array;
    
    /**
     * Set the funding
     *
     * @param  array<array{type?: string, url?: string}> $funding
     */
    public function setFunding(array $funding) : void;
    
    /**
     * Returns if the package is abandoned or not
     */
    public function isAbandoned() : bool;
    
    /**
     * If the package is abandoned and has a suggested replacement, this method returns it
     */
    public function getReplacementPackage() : ?string;
    
    /**
     * @param  bool|string $abandoned
     */
    public function setAbandoned($abandoned) : void;
    
    /**
     * Returns default base filename for archive
     *
     * @return ?string
     */
    public function getArchiveName() : ?string;
    
    /**
     * Sets default base filename for archive
     */
    public function setArchiveName(string $name) : void;
    
    /**
     * Returns a list of patterns to exclude from package archives
     *
     * @return string[]
     */
    public function getArchiveExcludes() : array;
    
    /**
     * Sets a list of patterns to be excluded from archives
     *
     * @param  string[] $excludes
     */
    public function setArchiveExcludes(array $excludes) : void;

}

Members

Title Sort descending Modifiers Object type Summary Overrides
CompletePackageInterface::getArchiveExcludes public function Returns a list of patterns to exclude from package archives 2
CompletePackageInterface::getArchiveName public function Returns default base filename for archive 2
CompletePackageInterface::getAuthors public function Returns an array of authors of the package 2
CompletePackageInterface::getDescription public function Returns the package description 2
CompletePackageInterface::getFunding public function Returns an array of funding options for the package 2
CompletePackageInterface::getHomepage public function Returns the package homepage 2
CompletePackageInterface::getKeywords public function Returns an array of keywords relating to the package 2
CompletePackageInterface::getLicense public function Returns the package license, e.g. MIT, BSD, GPL 2
CompletePackageInterface::getReplacementPackage public function If the package is abandoned and has a suggested replacement, this method returns it 2
CompletePackageInterface::getRepositories public function Returns an array of repositories 2
CompletePackageInterface::getScripts public function Returns the scripts of this package 2
CompletePackageInterface::getSupport public function Returns the support information 2
CompletePackageInterface::isAbandoned public function Returns if the package is abandoned or not 2
CompletePackageInterface::setAbandoned public function 2
CompletePackageInterface::setArchiveExcludes public function Sets a list of patterns to be excluded from archives 2
CompletePackageInterface::setArchiveName public function Sets default base filename for archive 2
CompletePackageInterface::setAuthors public function Set the authors 2
CompletePackageInterface::setDescription public function Set the description 2
CompletePackageInterface::setFunding public function Set the funding 2
CompletePackageInterface::setHomepage public function Set the homepage 2
CompletePackageInterface::setKeywords public function Set the keywords 2
CompletePackageInterface::setLicense public function Set the license 2
CompletePackageInterface::setRepositories public function Set the repositories 2
CompletePackageInterface::setScripts public function 2
CompletePackageInterface::setSupport public function Set the support information 2
PackageInterface::DISPLAY_DIST_REF public constant
PackageInterface::DISPLAY_SOURCE_REF public constant
PackageInterface::DISPLAY_SOURCE_REF_IF_DEV public constant
PackageInterface::getAutoload public function Returns an associative array of autoloading rules 2
PackageInterface::getBinaries public function Returns the package binaries 2
PackageInterface::getConflicts public function Returns a set of links to packages which must not be installed at the
same time as this package
2
PackageInterface::getDevAutoload public function Returns an associative array of dev autoloading rules 2
PackageInterface::getDevRequires public function Returns a set of links to packages which are required to develop
this package. These are installed if in dev mode.
2
PackageInterface::getDistMirrors public function Returns the dist mirrors of this package 2
PackageInterface::getDistReference public function Returns the reference of the distribution archive of this version, e.g. master, 1.0.0 or a commit hash for git 2
PackageInterface::getDistSha1Checksum public function Returns the sha1 checksum for the distribution archive of this version 2
PackageInterface::getDistType public function Returns the type of the distribution archive of this version, e.g. zip, tarball 2
PackageInterface::getDistUrl public function Returns the url of the distribution archive of this version 2
PackageInterface::getDistUrls public function Returns the urls of the distribution archive of this version, including mirrors 2
PackageInterface::getExtra public function Returns the package extra data 2
PackageInterface::getFullPrettyVersion public function Returns the pretty version string plus a git or hg commit hash of this package 1
PackageInterface::getId public function Retrieves the package&#039;s id set through setId 1
PackageInterface::getIncludePaths public function Returns a list of directories which should get added to PHP&#039;s
include path.
2
PackageInterface::getInstallationSource public function Returns source from which this package was installed (source/dist). 2
PackageInterface::getName public function Returns the package&#039;s name without version info, thus not a unique identifier 1
PackageInterface::getNames public function Returns a set of names that could refer to this package 1
PackageInterface::getNotificationUrl public function Returns the package notification url 2
PackageInterface::getPhpExt public function Returns the settings for php extension packages 2
PackageInterface::getPrettyName public function Returns the package&#039;s pretty (i.e. with proper case) name 1
PackageInterface::getPrettyString public function Converts the package into a pretty readable string 1
PackageInterface::getPrettyVersion public function Returns the pretty (i.e. non-normalized) version string of this package 2
PackageInterface::getProvides public function Returns a set of links to virtual packages that are provided through
this package
2
PackageInterface::getReleaseDate public function Returns the release date of the package 2
PackageInterface::getReplaces public function Returns a set of links to packages which can alternatively be
satisfied by installing this package
2
PackageInterface::getRepository public function Returns a reference to the repository that owns the package 1
PackageInterface::getRequires public function Returns a set of links to packages which need to be installed before
this package can be installed
2
PackageInterface::getSourceMirrors public function Returns the source mirrors of this package 2
PackageInterface::getSourceReference public function Returns the repository reference of this package, e.g. master, 1.0.0 or a commit hash for git 2
PackageInterface::getSourceType public function Returns the repository type of this package, e.g. git, svn 2
PackageInterface::getSourceUrl public function Returns the repository url of this package, e.g. git://github.com/naderman/composer.git 2
PackageInterface::getSourceUrls public function Returns the repository urls of this package including mirrors, e.g. git://github.com/naderman/composer.git 2
PackageInterface::getStability public function Returns the stability of this package: one of (dev, alpha, beta, RC, stable) 2
PackageInterface::getSuggests public function Returns a set of package names and reasons why they are useful in
combination with this package.
2
PackageInterface::getTargetDir public function Returns the package targetDir property 2
PackageInterface::getTransportOptions public function Returns a list of options to download package dist files 2
PackageInterface::getType public function Returns the package type, e.g. library 2
PackageInterface::getUniqueName public function Returns package unique name, constructed from name and version. 1
PackageInterface::getVersion public function Returns the version of this package 2
PackageInterface::isDefaultBranch public function 2
PackageInterface::isDev public function Returns whether the package is a development virtual package or a concrete one 2
PackageInterface::setDistMirrors public function 2
PackageInterface::setDistReference public function 2
PackageInterface::setDistType public function 2
PackageInterface::setDistUrl public function 2
PackageInterface::setId public function Allows the solver to set an id for this package to refer to it. 1
PackageInterface::setInstallationSource public function Sets source from which this package was installed (source/dist). 2
PackageInterface::setRepository public function Stores a reference to the repository that owns the package 1
PackageInterface::setSourceDistReferences public function Set dist and source references and update dist URL for ones that contain a reference 2
PackageInterface::setSourceMirrors public function 2
PackageInterface::setSourceReference public function 2
PackageInterface::setTransportOptions public function Configures the list of options to download package dist files 2
PackageInterface::__toString public function Converts the package into a readable and unique string 1

API Navigation

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