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

Breadcrumb

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

interface RootPackageInterface

Defines additional fields that are only needed for the root package

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 Jordi Boggiano <j.boggiano@seld.be>

@phpstan-import-type AutoloadRules from PackageInterface @phpstan-import-type DevAutoloadRules from PackageInterface

Hierarchy

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

Expanded class hierarchy of RootPackageInterface

All classes that implement RootPackageInterface

15 files declare their use of RootPackageInterface
ArchiveManager.php in vendor/composer/composer/src/Composer/Package/Archiver/ArchiveManager.php
ArrayDumper.php in vendor/composer/composer/src/Composer/Package/Dumper/ArrayDumper.php
AutoloadGenerator.php in vendor/composer/composer/src/Composer/Autoload/AutoloadGenerator.php
Config.php in composer/Plugin/VendorHardening/Config.php
Factory.php in vendor/composer/composer/src/Composer/Factory.php

... See full list

File

vendor/composer/composer/src/Composer/Package/RootPackageInterface.php, line 25

Namespace

Composer\Package
View source
interface RootPackageInterface extends CompletePackageInterface {
    
    /**
     * Returns a set of package names and their aliases
     *
     * @return list<array{package: string, version: string, alias: string, alias_normalized: string}>
     */
    public function getAliases() : array;
    
    /**
     * Returns the minimum stability of the package
     *
     * @return key-of<BasePackage::STABILITIES>
     */
    public function getMinimumStability() : string;
    
    /**
     * Returns the stability flags to apply to dependencies
     *
     * array('foo/bar' => 'dev')
     *
     * @return array<string, BasePackage::STABILITY_*>
     */
    public function getStabilityFlags() : array;
    
    /**
     * Returns a set of package names and source references that must be enforced on them
     *
     * array('foo/bar' => 'abcd1234')
     *
     * @return array<string, string>
     */
    public function getReferences() : array;
    
    /**
     * Returns true if the root package prefers picking stable packages over unstable ones
     */
    public function getPreferStable() : bool;
    
    /**
     * Returns the root package's configuration
     *
     * @return mixed[]
     */
    public function getConfig() : array;
    
    /**
     * Set the required packages
     *
     * @param Link[] $requires A set of package links
     */
    public function setRequires(array $requires) : void;
    
    /**
     * Set the recommended packages
     *
     * @param Link[] $devRequires A set of package links
     */
    public function setDevRequires(array $devRequires) : void;
    
    /**
     * Set the conflicting packages
     *
     * @param Link[] $conflicts A set of package links
     */
    public function setConflicts(array $conflicts) : void;
    
    /**
     * Set the provided virtual packages
     *
     * @param Link[] $provides A set of package links
     */
    public function setProvides(array $provides) : void;
    
    /**
     * Set the packages this one replaces
     *
     * @param Link[] $replaces A set of package links
     */
    public function setReplaces(array $replaces) : void;
    
    /**
     * Set the autoload mapping
     *
     * @param array $autoload Mapping of autoloading rules
     * @phpstan-param AutoloadRules $autoload
     */
    public function setAutoload(array $autoload) : void;
    
    /**
     * Set the dev autoload mapping
     *
     * @param array $devAutoload Mapping of dev autoloading rules
     * @phpstan-param DevAutoloadRules $devAutoload
     */
    public function setDevAutoload(array $devAutoload) : void;
    
    /**
     * Set the stabilityFlags
     *
     * @phpstan-param array<string, BasePackage::STABILITY_*> $stabilityFlags
     */
    public function setStabilityFlags(array $stabilityFlags) : void;
    
    /**
     * Set the minimumStability
     *
     * @phpstan-param key-of<BasePackage::STABILITIES> $minimumStability
     */
    public function setMinimumStability(string $minimumStability) : void;
    
    /**
     * Set the preferStable
     */
    public function setPreferStable(bool $preferStable) : void;
    
    /**
     * Set the config
     *
     * @param mixed[] $config
     */
    public function setConfig(array $config) : void;
    
    /**
     * Set the references
     *
     * @param array<string, string> $references
     */
    public function setReferences(array $references) : void;
    
    /**
     * Set the aliases
     *
     * @param list<array{package: string, version: string, alias: string, alias_normalized: string}> $aliases
     */
    public function setAliases(array $aliases) : void;
    
    /**
     * Set the suggested packages
     *
     * @param array<string, string> $suggests A set of package names/comments
     */
    public function setSuggests(array $suggests) : void;
    
    /**
     * @param mixed[] $extra
     */
    public function setExtra(array $extra) : 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
RootPackageInterface::getAliases public function Returns a set of package names and their aliases 2
RootPackageInterface::getConfig public function Returns the root package&#039;s configuration 2
RootPackageInterface::getMinimumStability public function Returns the minimum stability of the package 2
RootPackageInterface::getPreferStable public function Returns true if the root package prefers picking stable packages over unstable ones 2
RootPackageInterface::getReferences public function Returns a set of package names and source references that must be enforced on them 2
RootPackageInterface::getStabilityFlags public function Returns the stability flags to apply to dependencies 2
RootPackageInterface::setAliases public function Set the aliases 2
RootPackageInterface::setAutoload public function Set the autoload mapping 1
RootPackageInterface::setConfig public function Set the config 2
RootPackageInterface::setConflicts public function Set the conflicting packages 1
RootPackageInterface::setDevAutoload public function Set the dev autoload mapping 1
RootPackageInterface::setDevRequires public function Set the recommended packages 1
RootPackageInterface::setExtra public function 1
RootPackageInterface::setMinimumStability public function Set the minimumStability 2
RootPackageInterface::setPreferStable public function Set the preferStable 2
RootPackageInterface::setProvides public function Set the provided virtual packages 1
RootPackageInterface::setReferences public function Set the references 2
RootPackageInterface::setReplaces public function Set the packages this one replaces 1
RootPackageInterface::setRequires public function Set the required packages 1
RootPackageInterface::setStabilityFlags public function Set the stabilityFlags 2
RootPackageInterface::setSuggests public function Set the suggested packages 1

API Navigation

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