PHPdocs keywords

List of keywords used in phpdoc attributes.

Keyword	Value	Count
@KevinSMcArthur	/ https://github.com/StormTide	1
@TODO	look into removing the packageIds option, the only place true is used	1
@abstract	must be redefined by extending classes	1
@api	*/	2
@author	Eric Daspet	1
	Serge Smertin	1
	Henrik Bjørnskov	1
	Andreas Schempp	1
	Johannes M. Schmitt	1
	Wissem Riahi	1
	Roshan Gautam	1
	Paul Wenke	1
	John Stevenson	1
	Jordan Alliot	1
	Markus Tacker	1
	Chris Smith	1
	Jonas Renaudot	1
	Artem Lopata	1
	Lars Strojny	1
	Christophe Coevoet	1
	Derrick Nelson	1
	Javier Spagnoletti	1
	Pierre Rudloff	1
	Ben Bieker	1
	Ruben Gonzalez	1
	Yanick Witschi	1
	Theo Tonge	1
	Aleksandr Bezpiatov	1
	Gyula Sallai	1
	Tobias Munk	1
	Pierre du Plessis	1
	Jérémy Romey	1
	Mihai Plasoianu	1
	Justin Rainbow	1
	Fabien Potencier	1
	Joshua Estes	1
	Benoît Merlet	1
	Tiago Ribeiro	1
	Rui Marinho	1
	Kevin Ran	1
	Jérémy Romey	1
	David Neilsen	1
	Davey Shafik	1
	Helmut Hummel	1
	Martin Hasoň	1
	Haralan Dobrev	1
	Jan Prieser	1
	Ryan Weaver	1
	Hector Prats	1
	Lukas Homza	1
	Guilherme Blanco	1
	Jonathan Wage	1
	Roman Borschel	1
	Bernhard Schussek	1
	Jérémy Derussé	1
	Steve Buzonas	1
	Sascha Egerer	1
	James Titcumb	1
	Fabien Potencier	2
	Johann Reinke	2
	BohwaZ	2
	Nicolas Grekas	2
	Pavel Puchkin	2
	Igor Wiedler	3
	Benjamin Eberlei	3
	Samuel Roze	3
	Per Bernhardt	3
	Matt Whittom	3
Jérôme Tamarelle	3
Matthieu Moquet	3
Ryan Weaver	4
Beau Simensen	4
Kirill chEbba Chebunin	4
Niels Keurentjes	5
Till Klampaeckel	6
Robert Schönthal	6
Konstantin Kudryashiv	7
François Pluchino	10
Konstantin Kudryashov	17
Nils Adermann	60
Jordi Boggiano	119
@beta	* * dev-master -> ^2.1@dev (dev version with alias)	1
@code	* "require": {	1
@deprecated	* @private	1
	Use composer/ca-bundle and composer/composer 2.2 if you still need PHP 5 compatibility, this class will be removed in Composer 3.0	1
	Use Composer\MetadataMinifier\MetadataMinifier instead	1
	Use json_encode or JsonFile::encode() with modern JSON_* flags to configure formatting - this class will be removed in 3.0	1
	Since Composer 2.4.0 use the composer/class-map-generator package instead	1
	use PlatformRepository::isPlatformPackage(string $name) instead	1
	Use \JSON_PRETTY_PRINT */	1
	Use \JSON_UNESCAPED_UNICODE */	1
	Use \JSON_UNESCAPED_SLASHES */	1
	use Versions::CHANNELS	1
	Use getAllRawData() instead which returns all datasets for all autoloaders present in the process. getRawData only returns the first dataset loaded, which may not be what you expect.	1
	Use setRunScripts(false) on the EventDispatcher instance being injected instead	1
	Use getContext instead	1
	since Composer 2.3.0 use requireComposer or tryComposer depending on whether you have $required set to true or false	1
	use setPlatformRequirementFilter instead	2
@dev	+ 3.2.99999-dev -> ^3.2@dev	1
@endcode	*	1
@extends	\SplDoublyLinkedList	1
@final	*/	1
@implements	\IteratorAggregate	1
	\Iterator	1
	\Iterator	1
@inheritDoc	* @throws \RuntimeException	1
	* @return array	3
	* @return array	3
	*	7
	*/	394
@inheritdoc	*	1
@internal	* @author François Pluchino	1
	* @author Jordi Boggiano	1
	* @final	1
	* @var string[]	1
	* @return array{0: string, 1: string}	1
	* @param PackageInterface[] $packages	1
	* @param 'format'|'audit-format' $optName	1
	* @author John Stevenson	3
	*	9
	*/	26
@link	getSubscribedEvents} and registers the subscriber as a listener for all	1
	https://github.com/composer/composer/issues/5584	1
	rename}.	1
	https://bugs.php.net/bug.php?id=61548	1
	https://getcomposer.org/doc/02-libraries.md#platform-packages	1
@method	self::ERROR_DEPENDENCY_RESOLUTION_FAILED getCode()	1
@param	IOInterface $io IO instance	1
	array|string|null $localConfig either a configuration array or a filename to read from, if null it will	1
	bool|'local'|'global' $disablePlugins Whether plugins should not be loaded, can be set to local or global to only disable local/global plugins	1
	bool $disableScripts Whether scripts should not be run	1
	bool $fullLoad Whether to initialize everything or only main project stuff (used when loading the global composer)	1
	bool $disablePlugins Whether plugins should not be loaded	1
	bool $disableScripts Whether scripts should not be executed	1
	Repository\RepositoryManager $rm	1
	IO\IOInterface $io	1
	EventDispatcher $eventDispatcher	1
	Config $config The configuration	1
	Downloader\DownloadManager $dm Manager use to download sources	1
	InstalledRepositoryInterface $repo repository to purge packages from	1
	Installer\InstallationManager $im manager to check whether packages are still installed	1
	IOInterface $io IO instance	1
	mixed $config either a configuration array or a filename to read from, if null it will read from	1
	bool $disableScripts Whether scripts should not be run	1
	IOInterface $io IO instance	1
	Config $config Config instance	1
	mixed[] $options Array of options passed directly to HttpDownloader constructor	1
	mixed $fileOrData	1
	JsonFile::*_SCHEMA $schema	1
	string $cacheDir location of the cache	1
	string $allowlist List of characters that are allowed in path names (used in a regex character class)	1
	Filesystem $filesystem optional filesystem instance	1
	bool $readOnly whether the cache is in readOnly mode	1
	bool $useEnvironment Use COMPOSER_ environment variables to replace config settings	1
	?string $baseDir Optional base directory of the config	1
	array{config?: array, repositories?: array} $config	1
	int $flags Options (see class constants)	1
	mixed $configValue	1
	string|mixed $value a config string that can contain {$refs-to-other-config}	1
	int $flags Options (see class constants)	1
	non-empty-string $var	1
	IOInterface $io	1
	mixed[] $repoOptions	1
	string $type	1
	bool $includeDevRequirements	1
	VersionParser $parser Install composer/semver to have access to this class and functionality	1
	string $packageName	1
	string|null $constraint A version constraint to check for, if you pass one you have to make sure composer/semver is required by your package	1
	array[] $data A vendor/composer/installed.php data set	1
	RootPackageInterface&BasePackage $package	1
	array> $aliases	1
	bool $alreadySolved Whether the function is called as part of an update command or independently	1
	array> $rootAliases	1
	RootPackageInterface&BasePackage $rootPackage	1
	Link[] $links	1
	array $constraints	1
	string[] $packages	1
	int $updateAllowTransitiveDependencies One of the UPDATE_ constants on the Request class	1
	bool $errorOnAudit	1
	Auditor::FORMAT_* $auditFormat	1
	string $pharFile The full path to the file to create	1
	string $source A PHP string	1
	array $def	1
	ConstraintInterface[] $packageNameMap package names pointing to constraints	1
	array $acceptableStabilities array of stability => BasePackage::STABILITY_* value	1
	array $stabilityFlags an array of package name => BasePackage::STABILITY_* value	1
	array> $alreadyLoaded an array of package name => package version => package	1
	string $query search query, for SEARCH_NAME and SEARCH_VENDOR regular expressions metacharacters are supported by implementations, and user input should be escaped through preg_quote by callers	1
	int $mode a set of SEARCH_* constants to search on, implementations should do a best effort only, default is SEARCH_FULLTEXT	1
	?string $type The type of package to search for. Defaults to all types of packages	1
	string $packageName package name which must be provided	1
array{package: mixed[]} $config package definition	1
array $overrides	1
array{version: string, name: string} $override	1
string[] $replaces	1
string[] $provides	1
EventDispatcher $eventDispatcher	1
HttpDownloader $httpDownloader	1
array $repoConfigs	1
int|string $index	1
array{url?: string} $repo	1
array $existingRepos	1
bool $devMode Whether dev requirements were included or not in this installation	1
list $bucket Do not pass this in, only used to avoid recursion with circular deps	1
array{url: string, type?: string}&array $repoConfig	1
array>|null $drivers	1
array{name?: string, dist?: array{type: string, url: string, reference: string, shasum: string}, source?: array{type: string, url: string, reference: string}} $data	1
array $packages	1
string|null $packageFilter Package pattern filter which can include "*" as a wildcard	1
string $name package name	1
array $packageNames array of package name => ConstraintInterface|null - if a constraint is provided, only	1
string $name package name (must be lowercased already)	1
array $versionData	1
string $url	1
array{providers?: mixed[], provider-includes?: mixed[]} $data	1
mixed[] $data	1
mixed[] $packages	1
int[] $stabilityFlags an array of package name => BasePackage::STABILITY_* value	1
ConstraintInterface[] $rootRequires an array of package name => constraint from the root package	1
RepositoryInterface $repo A package repository	1
int $flags any of the ALLOW_* constants from this class to tweak what is returned	1
array $packageConstraintMap	1
string[] $names	1
list $ignoredTypes Packages of those types are ignored	1
list|null $allowedTypes Only packages of those types are allowed if set to non-null	1
array[] $aliases	1
array{url: string} $repoConfig	1
string $type repository type	1
array $config repository configuration	1
string $name repository name	1
string $type installation type	1
class-string $class class name of the repo implementation	1
InstalledRepositoryInterface $repository repository instance	1
array{url?: string, options?: array{symlink?: bool, reference?: string, relative?: bool, versions?: array}} $repoConfig	1
array{only?: array, exclude?: array, canonical?: bool} $options	1
ConstraintInterface|string|null $constraint	1
string|string[] $needle The package name(s) to inspect.	1
ConstraintInterface|null $constraint Optional constraint to filter by.	1
bool $invert Whether to invert matches to discover reasons for the package *NOT* to be installed.	1
bool $recurse Whether to recursively expand the requirement tree up to the root package.	1
string[] $packagesFound Used internally when recurring	1
array $packageConstraintMap Map of package name to constraint (can be MatchAllConstraint to fetch all advisories)	1
JsonFile $repositoryFile repository json file	1
?RootPackageInterface $rootPackage Must be provided if $dumpVersions is true	1
array $array	1
array{url: string}&array $repoConfig The repository configuration	1
string $url The URL of content	1
string $command The svn command to run.	1
string $url The SVN URL.	1
string $baseDir The path to trunk/branch/tag	1
int $revision The revision mark to add to identifier	1
string $url The URL of content	1
array $cloneLinks	1
array $configuredDomains	1
array $urlParts	1
string $portNumber	1
string $identifier Any identifier to a specific branch/tag/commit	1
IOInterface $io IO instance	1
Config $config current $config	1
string $url URL to validate/check	1
bool $deep unless true, only shallow checks (url matching typically) should be done	1
array $weights Pre-set weights for some packages to give them more (negative number) or less (positive) weight offsets	1
string $file The path to the file	1
int $arrayLoaderValidationFlags Flags for ArrayLoader validation	1
int $flags Flags for validation	1
mixed $commandOutput the output will be written into this var if passed by ref	1
array $match	1
string[] $credentials	1
ProcessExecutor $process	1
string $command SVN command to run	1
string $url SVN url	1
?string $cwd Working directory	1
?string $path Target for a checkout	1
bool $verbose Output all output to the user	1
string $command SVN command to run	1
string $path Path argument passed thru to the command	1
string $cwd Working directory	1
bool $verbose Output all output to the user	1
string $cmd Usually 'svn ls' or something like that.	1
string $url Repo URL.	1
string $path Target for a checkout	1
string $pattern NO_PROXY pattern	1
null|stdClass $ipdata Set by method if IP address found	1
bool $allowPrefix Whether a CIDR prefix-length is expected	1
int $prefix CIDR prefix-length	1
int $size Byte size of in_addr	1
string $rangeIp IP in_addr	1
int $size Byte size of in_addr	1
int $prefix CIDR prefix-length	1
string $binary in_addr	1
int $size Byte size of in_addr	1
string $ip in_addr	1
int $size Byte size of in_addr	1
null|string $netmask Network mask	1
'prompt'|bool $storeAuth	1
int $statusCode HTTP status code that triggered this call	1
string|null $reason a message/description explaining why this was called	1
string[] $headers	1
int $retryCount the amount of retries already done on this URL	1
string[] $headers	1
string $urlToBitBucketFile URL to a file at bitbucket.org.	1
int|null $mask Error levels to suppress, default value NULL indicates all warnings and below.	1
callable $callable Function to execute.	1
mixed $parameters Function to execute.	1
string $path Path to the file or directory	1
string $path Path to the file or directory	1
string $target The path of the binary file to be symlinked	1
string $link The path where the symlink should be created	1
string $pathname directory path to resolve	1
string $junction Path to check.	1
string $originUrl The host this GitHub instance is located at	1
string $originUrl The host this GitHub instance is located at	1
string $message The reason this authorization is required	1
int $time Timestamp, injectable for mocking	1
string $originUrl The host this Bitbucket instance is located at	1
string $originUrl The host this Bitbucket instance is located at	1
int $index Job id	1
array{warning?: string, info?: string, warning-versions?: string, info-versions?: string, warnings?: array, infos?: array} $data	1
Job $job	1
non-empty-string $name	1
?resource $fd Open file descriptor or null to default to STDOUT	1
non-empty-string $url URL the context is to be used for	1
mixed[] $defaultOptions Options to merge with the default	1
mixed[] $defaultParams Parameters to specify on the context	1
bool $forCurl When true, will not add proxy values as these are handled separately	1
string|string[] $header	1
mixed $certificate X.509 certificate	1
string $hostname Hostname in the URL	1
string $cn Set to the common name of the certificate iff match found	1
mixed $certificate X.509 certificate	1
string $certName CN/SAN	1
non-empty-string $command	1
resource|false $spec	1
resource $pipe	1
mixed $name	1
mixed $output the output will be written into this var if passed by ref	1
string|list $command the command to execute	1
mixed $output	1
string $cwd the working directory	1
int $timeout the timeout in seconds	1
string|false|null $argument The argument that will be escaped	1
string|false|null $argument	1
AuthHelper $authHelper	1
string $fileName the local filename	1
string[] $headers array of returned headers like from getLastHeaders()	1
string $originUrl The origin URL	1
non-empty-string $fileUrl The file URL	1
mixed[] $additionalOptions context options	1
string $fileName the local filename	1
bool $progress Display the progression	1
string $originUrl The origin URL	1
string $fileUrl The file URL	1
resource $context The stream context	1
string[] $responseHeaders	1
int $maxFileSize The maximum allowed file size	1
int $notificationCode The notification code	1
int $severity The severity level	1
string $message The message	1
int $messageCode The message code	1
int $bytesTransferred The loaded size	1
int $bytesMax The total size	1
positive-int $httpStatus	1
string[] $headers	1
mixed[] $additionalOptions	1
mixed[] $additionalOptions	1
int $level Level of the error raised	1
string $message Error message	1
string $file Filename that the error was raised in	1
int $line Line number the error was raised at	1
Loop $loop Loop instance which you can get from $composer->getLoop()	1
DownloaderInterface|DownloadManager $downloader DownloadManager instance or Downloader instance you can get from $composer->getDownloadManager()->getDownloader('zip') for example	1
string $path The installation path for the package	1
PackageInterface $package The package to install	1
PackageInterface|null $prevPackage The previous package if this is an update and not an initial installation	1
Loop $loop Loop instance which you can get from $composer->getLoop()	1
array> $promises	1
ProgressBar|null $progress	1
non-empty-string $requestUrl	1
Request $request	1
list $headers	1
string $name header name (case insensitive)	1
?non-empty-string $url The proxy url, without authorization	1
?non-empty-string $auth Authorization for curl	1
?contextOptions $contextOptions	1
?non-empty-string $status	1
array $sslOptions	1
?string $format Output format specifier	1
array{retryAuthFailure?: bool, redirects?: int<0, max>, retries?: int<0, max>, storeAuth?: 'prompt'|bool, ipResolve?: 4|6|null} $attributes	1
Job $job	1
array{retryAuthFailure?: bool, redirects?: int<0, max>, storeAuth?: 'prompt'|bool, retries?: int<1, max>, ipResolve?: 4|6} $attributes	1
array{retryAuthFailure?: bool, redirects?: int<0, max>, storeAuth?: 'prompt'|bool, retries: int<1, max>, ipResolve?: 4|6} $attributes	1
string $scheme The scheme of the request url	1
string $proxyUrl The value from the environment	1
string $envName The name of the environment variable	1
mixed ...$args	1
string $name Name	1
mixed[]|false $config Configuration	1
bool $append Whether the repo should be appended (true) or prepended (false)	1
mixed $value Value	1
string|string[] $value Value	1
string $type Type (require, require-dev, provide, suggest, replace, conflict)	1
string $value Value	1
string $type Type (require, require-dev, provide, suggest, replace, conflict)	1
string $name Name	1
string $name The event name	1
string[] $args Arguments passed by the user	1
mixed[] $flags Optional flags to pass data not as argument	1
PartialComposer $composer The composer instance	1
IOInterface $io The IOInterface instance	1
ProcessExecutor $process	1
string|null $eventName The event name, required if no $event is provided	1
Event $event An event instance, required if no $eventName is provided	1
string $eventName The constant in ScriptEvents	1
array $additionalArgs Arguments passed by the user	1
array $flags Optional flags to pass data not as argument	1
string $eventName The constant in PackageEvents	1
bool $devMode Whether or not we are in dev mode	1
RepositoryInterface $localRepo The installed repository	1
OperationInterface[] $operations The list of operations	1
OperationInterface $operation The package being installed/updated/removed	1
string $eventName The constant in InstallerEvents	1
bool $devMode Whether or not we are in dev mode	1
bool $executeOperations True if operations will be executed, false in --dry-run	1
Transaction $transaction The transaction contains the list of operations	1
Event $event The event object to pass to the event handlers/listeners.	1
Event $event Event invoking the PHP callable	1
string $eventName The event name - typically a constant	1
callable|string $listener A callable expecting an event argument, or a command string to be executed (same as a composer.json "scripts" entry)	1
int $priority A higher value represents a higher priority	1
callable|object $listener A callable or an object instance for which all listeners should be removed	1
Event $event Event object	1
bool $isFips Set by the method	1
InputInterface $input The input instance	1
OutputInterface $output The output instance	1
HelperSet $helperSet The helperSet instance	1
string $username The username	1
string $password The password	1
string|bool|int|float|null $default The default answer if none is given by the user	1
bool $default The default answer if the user enters nothing	1
string $question The question to ask	1
callable $validator A PHP callback	1
null|int $attempts Max number of times to ask before giving up (default of null means infinite)	1
mixed $default The default answer if none is given by the user	1
string $question The question to ask	1
string[] $choices List of choices to pick from	1
bool|string $default The default answer if the user enters nothing	1
bool|int $attempts Max number of times to ask before giving up (false by default, which means infinite)	1
string $errorMessage Message which will be shown if invalid value from choice list would be picked	1
bool $multiselect Select more than one value separated by comma	1
string $repositoryName The unique name of repository	1
string $username The username	1
null|string $password The password	1
string $name The event name	1
string $command The command about to be executed	1
string $name The event name	1
string $commandName The command name	1
mixed[] $args Arguments passed by the user	1
mixed[] $flags Optional flags to pass data not as argument	1
bool $failOnMissingClasses By default this silently skips plugins that can not be found, but if set to true it fails with an exception	1
bool $isGlobalPlugin Set to true to denote plugins which are installed in the global Composer directory	1
PluginInterface $plugin plugin instance	1
?PackageInterface $sourcePackage Package from which the plugin comes from	1
InstalledRepository $installedRepo Set of local repos	1
array $collected Current state of the map for recursion	1
PackageInterface $package The package to analyze	1
bool $global Whether this is a global package	1
array|bool $allowPluginsConfig	1
'local'|'global' $type	1
string $name The event name	1
mixed $context	1
non-empty-string $processedUrl	1
non-empty-string $processedUrl New processed URL	1
string|null $customCacheKey New cache key	1
string $name The event name	1
string|null $fileName The file name	1
string|null $checksum The checksum	1
string $url The processed url	1
string $type The type (package or metadata).	1
mixed $context Additional context for the download.	1
string $name The event name	1
int[] $acceptableStabilities array of stability => BasePackage::STABILITY_* value	1
int[] $stabilityFlags array of package name => BasePackage::STABILITY_* value	1
array[] $rootAliases array of package => version => [alias, alias_normalized]	1
string[] $rootReferences	1
BasePackage[] $packages	1
BasePackage[] $unacceptableFixedPackages	1
bool $update if true (update) the changes can be stashed and reapplied after an update,	1
string $url package url	1
PackageInterface|null $prevPackage previous package (in case of an update)	1
PackageInterface $target updated package	1
string $fromReference the source reference	1
string $toReference the target reference	1
string $path the package path	1
string[] $urls	1
IOInterface $io The Input Output Interface	1
Filesystem|null $filesystem custom Filesystem object	1
bool $preferDist prefer downloading from dist	1
array $preferences array of preferences by package patterns	1
string $type installation type	1
DownloaderInterface $downloader downloader instance	1
string $type installation type	1
PackageInterface $package package instance	1
PackageInterface $initial initial package version	1
PackageInterface $target target package version	1
string $path download path	1
PackageInterface $initial initial package	1
PackageInterface $target updated package	1
string $baseUrl Base URL of the repository	1
string $command SVN command to run	1
string $url SVN url	1
string $cwd Working directory	1
string $path Target for a checkout	1
IOInterface $io The IO instance	1
Config $config The config	1
HttpDownloader $httpDownloader The remote filesystem	1
EventDispatcher $eventDispatcher The event dispatcher	1
Cache $cache Cache instance	1
Filesystem $filesystem The filesystem	1
PATHINFO_EXTENSION|PATHINFO_BASENAME $component	1
PackageInterface $package package instance	1
non-empty-string $url download url	1
array $headers	1
?int $statusCode	1
array $responseInfo	1
string $file Extracted file	1
string $path Directory	1
string|int $literal	1
int[] $decisionQueue	1
mixed[] $transportOptions	1
array $ruleSeen	1
self::RULE_* $reason A RULE_* constant describing the reason for generating this rule	1
mixed $reasonData	1
RuleSet::TYPE_* $type	1
BasePackage[] $installedMap	1
array $packages An array containing packages or literals	1
Problem[] $problems	1
string[] $missingExtensions	1
Rule[][] $reasonSets	1
string $operator One of Constraint::STR_OP_*	1
array|null $preferredVersions Must be an array of package name => normalized version	1
int[] $literals	1
string $requiredPackage	1
Decisions $decisions The decisions made so far by the solver	1
Rule $rule The rule to wrap	1
int $literal The watched literal that should not be returned	1
int $from The previously watched literal	1
int $to The literal to be watched now	1
self::TYPE_* $type	1
self::TYPE_*|array $types	1
array|self::TYPE_* $types	1
BasePackage[] $unacceptableFixedOrLockedPackages	1
array> $removedVersions	1
array> $removedVersionsByPackage	1
string $name The package name to be searched for	1
string $name The package name to be searched for	1
array $installedMap	1
string $name Name of the package to be matched	1
array $updateAllowList	1
false|self::UPDATE_* $updateAllowTransitiveDependencies	1
non-empty-list $names	1
string $file File to extract	1
string $path Path where to extract file	1
string $name The event name	1
Composer $composer The composer object	1
IOInterface $io The IOInterface object	1
bool $devMode Whether or not we are in dev mode	1
array $args Arguments passed by the user	1
mixed[] $flags Optional flags to pass data not as argument	1
array>>> $identicalDefinitionsPerPackage	1
array> $packageIdenticalDefinitionLookup	1
string $question The question to ask to the user	1
bool $default The default answer to return, true or false	1
non-empty-string $trueAnswerRegex A regex to match the "yes" answer	1
non-empty-string $falseAnswerRegex A regex to match the "no" answer	1
bool $unescapeUnicode Un escape unicode	1
bool $unescapeSlashes Un escape slashes	1
BasePackage $package The package with a requirement	1
BasePackage[] $providers The providers of the requirement	1
mixed $reasonData Any data, e.g. the requirement name, that goes with the reason	1
BasePackage[] $packages The set of packages to choose from	1
Rule::RULE_* $reason A RULE_* constant describing the reason for	1
mixed $reasonData Additional data like the root require or fix request info	1
BasePackage $issuer The package declaring the conflict	1
BasePackage $provider The package causing the conflict	1
mixed $reasonData Any data, e.g. the package name, that goes with the reason	1
RuleSet::TYPE_* $type A TYPE_* constant defining the rule type	1
Rule $newRule The rule about to be added	1
string $path path to a lockfile	1
?HttpDownloader $httpDownloader required for loading http/https json files	1
?IOInterface $io	1
mixed[] $hash writes hash into json file	1
int $options json_encode options	1
mixed $data Decoded JSON data to validate	1
mixed $data Data to encode into a formatted JSON string	1
int $options json_encode options (defaults to JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE)	1
string $indent Indentation string	1
int $code return code of json_last_error function	1
null|string $json json string	1
string $file the json file	1
string $file	1
array|false $config	1
mixed $content	1
mixed $data	1
PackageInterface[] $presentPackages	1
int[] $literals	1
RuleWatchNode $node The rule node to be inserted into the graph	1
int $decidedLiteral The literal which was decided (A in our example)	1
int $level The level at which the decision took place and at which	1
Decisions $decisions Used to check previous decisions and to	1
int $fromLiteral A literal the node used to watch	1
int $toLiteral A literal the node should watch now	1
RuleWatchNode $node The rule node to be moved	1
int<-1, max> $offset	1
array $presentMap	1
array $unlockableMap	1
string $name packageName	1
Rule $rule A rule which is a reason for this problem	1
Rule[] $rules	1
string $id A canonical identifier for the reason	1
Rule $reason The reason descriptor	1
string $version the effective runtime version of the platform package	1
array $versions an array of pretty versions, with normalized versions as keys	1
PackageInterface[] $higherRepoPackages	1
PackageInterface[] $allReposPackages	1
array $rules	1
int $offset The offset to seek to.	1
bool $lock Whether this is an operation on the lock file	1
PackageInterface $target target package (updated)	1
array|null $excluded	1
non-empty-array $packageMap array of array(package, installDir-relative-to-composer.json or null for metapackages)	1
RootPackageInterface $rootPackage root package instance	1
bool|string[] $filteredDevPackages If an array, the list of packages that must be removed. If bool, whether to filter out require-dev packages	1
array $autoloads see parseAutoloads return value	1
array $files	1
bool|'php-only' $checkPlatform	1
string $vendorPathCode unused in this method	1
string $appBaseDirCode unused in this method	1
string $prependAutoloader 'true'|'false'	1
string $vendorPath input for findShortestPathCode	1
string $basePath input for findShortestPathCode	1
string $type one of: 'psr-0'|'psr-4'|'classmap'|'files'	1
string|null $vendorDir	1
array $classMap Class to filename map	1
string $prefix The prefix	1
list|string $paths The PSR-0 root directories	1
string $prefix The prefix/namespace, with trailing '\\'	1
list|string $paths The PSR-4 base directories	1
string $prefix The prefix	1
list|string $paths The PSR-0 base directories	1
string $prefix The prefix/namespace, with trailing '\\'	1
list|string $paths The PSR-4 base directories	1
bool $useIncludePath	1
bool $classMapAuthoritative	1
string|null $apcuPrefix	1
bool $prepend Whether to prepend the autoloader or not	1
string $class The name of the class	1
string $class The name of the class	1
string $class	1
string $ext	1
\Traversable<\SplFileInfo>|string|array<\SplFileInfo> $path The path to search in or an iterator	1
non-empty-string|null $excluded Regex that matches file paths to be excluded from the classmap	1
?IOInterface $io IO object	1
null|string $namespace Optional namespace prefix to filter by	1
null|'psr-0'|'psr-4'|'classmap' $autoloadType psr-0|psr-4 Optional autoload standard to use mapping rules	1
array $scannedFiles	1
\Traversable|array $dirs Directories or a single path to search in	1
string $file The name of the class map file	1
array<'require'|'require-dev', array> $updates	1
string[] $warnings	1
string[] $publishErrors	1
string[] $lockErrors	1
mixed[] $fundings	1
array $requires	1
string[] $aliases	1
string|array|null $repositories	1
array|null $repositories	1
bool $required Should be set to false, or use `requireComposer` instead	1
bool|null $disablePlugins If null, reads --no-plugins as default	1
bool|null $disableScripts If null, reads --no-scripts as default	1
mixed $config either a configuration array or a filename to read from, if null it will read from	1
array $table	1
array $packages	1
ConstraintInterface|string $version	1
string $title	1
array> $arrayTree	1
array>|string|null>|string $package	1
array $packagesInTree	1
string[] $packagesInTree	1
array> $options	1
array $contents	1
array $rawContents	1
array $config	1
bool $inverted Whether to invert matching process (why-not vs why behaviour)	1
array{PackageInterface, Link, mixed}[] $results	1
array{PackageInterface, Link, mixed[]|bool}[] $results Results to be printed at this level.	1
string $prefix Prefix of the current tree level.	1
int $level Current level of recursion.	1
mixed[] $results	1
string $localFilename The composer.phar location	1
string $newFilename The downloaded or backup phar	1
string $backupTarget The filename to use for the backup	1
string $pharFile The downloaded or backup phar	1
null|string $error Set by method on failure	1
string $localFilename The composer.phar location	1
string $newFilename The downloaded or backup phar	1
array $newRequirements	1
array $requirements	1
list $requirementsToUpdate	1
string $token	1
bool|string|string[]|\Exception $result	1
string[] $reqList	1
bool $allowUpperBoundOverride For conflicts we do not want the upper bound to be skipped	1
mixed $boolOrList	1
Filesystem $filesystem	1
Filesystem $filesystem	1
BinaryInstaller $binaryInstaller	1
PackageInterface $initial already installed package version	1
PackageInterface $target updated version	1
string $source Source package which made the suggestion	1
string $target Target package to be suggested	1
string $reason Reason the target package to be suggested	1
int $mode One of the MODE_* constants from this class	1
string $type package type	1
InstalledRepositoryInterface $repo repository in which to add/remove/update packages	1
OperationInterface[] $operations operations to execute	1
bool $devMode whether the install is being run in dev mode	1
bool $runScripts whether to dispatch script events	1
bool $downloadOnly whether to only download packages	1
array> $promises	1
InstallOperation $operation operation instance	1
UpdateOperation $operation operation instance	1
UninstallOperation $operation operation instance	1
MarkAliasInstalledOperation $operation operation instance	1
InstalledRepositoryInterface $repo repository in which to check	1
MarkAliasUninstalledOperation $operation operation instance	1
array $data	1
bool $warningOnly If true, outputs a warning. If false, outputs an error.	1
string[] $ignoreList List of advisory IDs, remote IDs or CVE IDs that reported but not listed as vulnerabilities.	1
self::ABANDONED_* $abandoned	1
array|array $ignoreList List of advisory IDs, remote IDs or CVE IDs that reported but not listed as vulnerabilities.	1
array> $advisories	1
array $packages	1
self::FORMAT_PLAIN|self::FORMAT_TABLE $format	1
string $name The package's name	1
string $version The package's version	1
string[] $binaries	1
string $type	1
string|null $url	1
string $reference	1
string $sha1checksum	1
array $requires A set of package links	1
array $conflicts A set of package links	1
array $provides A set of package links	1
array $replaces A set of package links	1
array $devRequires A set of package links	1
string[] $includePaths List of directories.	1
array{priority?: int, configure-options?: list}|null $phpExt List of directories.	1
string $version The package's normalized version	1
mixed[]|null $mirrors	1
array $links	1
ConstraintInterface $constraint Constraint applying to the target of this link	1
self::TYPE_* $description Used to create a descriptive string representation	1
array $scripts	1
mixed[] $repositories	1
string[] $license	1
string[] $keywords	1
array $authors	1
array{issues?: string, forum?: string, wiki?: string, source?: string, email?: string, irc?: string, docs?: string, rss?: string, chat?: string, security?: string} $support	1
array $funding	1
bool|string $abandoned	1
string[] $excludes	1
CompletePackage $aliasOf The package this package is an alias of	1
string $version The version the alias must report	1
string $prettyVersion The alias's non-normalized version	1
BasePackage $aliasOf The package this package is an alias of	1
Link[] $links	1
Link::TYPE_* $linkType	1
string $composerFileContents The contents of the composer file.	1
JsonFile $lockFile lockfile loader	1
InstallationManager $installationManager installation manager instance	1
string $composerFileContents The contents of the composer file	1
bool $withDevReqs true to retrieve the locked dev packages	1
bool $withDevReqs if true, the platform requirements from the require-dev block are also returned	1
PackageInterface[] $packages array of packages	1
PackageInterface[]|null $devPackages array of dev packages or null if installed without --dev	1
array $platformReqs array of package name => constraint for required platform packages	1
array $platformDevReqs array of package name => constraint for dev-required platform packages	1
string[][] $aliases array of aliases	1
array $stabilityFlags	1
array $platformOverrides	1
bool $write Whether to actually write data to disk, useful in tests and for --dry-run	1
PackageInterface $package The package to scan.	1
bool $provides Whether provided names should be included	1
?string $type source/dist	1
bool $truncate If the source reference is a sha1 hash, truncate it	1
int $displayMode One of the DISPLAY_ constants on this interface determining display of references	1
string $name The package's name	1
non-empty-string $wrap Wrap the cleaned string by the given string	1
non-empty-string $wrap	1
RootPackage $aliasOf The package this package is an alias of	1
Link[] $requires A set of package links	1
Link[] $devRequires A set of package links	1
Link[] $conflicts A set of package links	1
Link[] $provides A set of package links	1
Link[] $replaces A set of package links	1
array $stabilityFlags	1
mixed[] $config	1
DownloadManager $downloadManager A manager used to download package sources	1
bool $overwriteFiles New setting	1
array $parts	1
CompletePackageInterface $package The package to get a name for	1
CompletePackageInterface $package The package to archive	1
string $format The format of the archive (zip, tar, ...)	1
string $targetDir The directory where to build the archive	1
string|null $fileName The relative file name to use for the archive, or null to generate	1
bool $ignoreFilters Ignore filters when looking for files in the package	1
string[] $parts	1
string[] $formats	1
string $sources Path to source files to be archived	1
string[] $excludes Composer's own exclude rules from composer.json	1
bool $ignoreFilters Ignore filters when looking for files	1
string $relativePath The file's path relative to the sourcePath	1
bool $exclude Whether a previous filter wants to exclude this file	1
string[] $lines A set of lines to be parsed	1
callable $lineParser The parser to be used on each line	1
string[] $rules A list of exclude rules in gitignore syntax	1
string $rule An exclude rule in gitignore syntax	1
string $line A line from .gitattributes	1
string[] $excludeRules An array of exclude rules from composer.json	1
string $format The archive format	1
?string $sourceType The source type (git, svn, hg, etc.)	1
string $sources The sources directory	1
string $target The target file	1
string $format The format used for archive	1
string[] $excludes A list of patterns for files to exclude	1
bool $ignoreFilters Whether to ignore filters when looking for files	1
string[] $names The package name(s) to check for stability flags	1
string $path Path to guess into	1
array $packageConfig	1
string[] $branches	1
PlatformRepository $platformRepo If passed in, the versions found will be filtered against their requirements to eliminate any not matching the current platform packages	1
string $targetPackageVersion	1
PlatformRequirementFilterInterface|bool|string[] $platformRequirementFilter	1
IOInterface|null $io If passed, warnings will be output there in case versions cannot be selected due to platform requirements	1
callable(PackageInterface):bool|bool $showWarnings	1
string[] $pairs a set of package/version pairs separated by ":", "=" or " "	1
true $strictName	1
mixed $value	1
string[] $schemes	1
list $errors	1
list $warnings	1
mixed[] $data	1
array> $versions	1
CompletePackage $package	1
mixed[] $config package data	1
array>>> $linkCache	1
mixed[] $config	1
string $source source package name	1
string $sourceVersion source package version (pretty version ideally)	1
string $description link description (e.g. requires, replaces, ..)	1
array $links array of package name => constraint mappings	1
string $source source package name	1
string $sourceVersion source package version (pretty version ideally)	1
Link::TYPE_* $description link description (e.g. requires, replaces, ..)	1
string $target target package name	1
string $prettyConstraint constraint string	1
mixed[] $config the entire package config	1
array $requires	1
array $stabilityFlags	1
string|JsonFile $json A filename, json string or JsonFile instance to load the package from	1
array $keys	1
array $data	1
array $styles Array of "name => FormatterStyle" instances	1
array $matches	1
string $name The argument name	1
int|null $mode The argument mode: self::REQUIRED or self::OPTIONAL	1
string $description A description text	1
string|bool|int|float|string[]|null $default The default value (for self::OPTIONAL mode only)	1
list|\Closure(CompletionInput,CompletionSuggestions):list $suggestedValues The values used for input completion	1
string|string[]|null $shortcut The shortcuts, can be null, a string of shortcuts delimited by | or an array of shortcuts	1
int|null $mode The option mode: One of the VALUE_* constants	1
string|bool|int|float|string[]|null $default The default value (must be null for self::VALUE_NONE)	1
list|\Closure(CompletionInput,CompletionSuggestions):list $suggestedValues The values used for input completionnull for self::VALUE_NONE)	1
list $results	2
string $packageName	2
list $types	2
list|null $types	2
bool|string[] $ignorePlatformReqs	2
string $name package name	2
string|ConstraintInterface $constraint package version or version constraint to match against	2
string[] $devPackageNames	2
array $packages	2
array> $alreadyLoaded	2
array[] $rootAliases	2
string[] $rootReferences an array of package name => source reference	2
array $temporaryConstraints Runtime temporary constraints that will be used to filter packages	2
string $stability one of 'stable', 'RC', 'beta', 'alpha' or 'dev'	2
string $name package name	2
string|\Composer\Semver\Constraint\ConstraintInterface $constraint package version or version constraint to match against	2
RepositoryInterface $repository repository instance	2
array $devPackages	2
non-empty-string $message	2
bool $directories if true, the source/target are considered to be directories	2
string $message The reason this authorization is required	2
string $scheme Scheme used in the origin URL	2
IOInterface $io The IO instance	2
Config $config The config	2
mixed[] $options The options	2
string $to Path to copy to	2
int|null $index For internal use only, the job id	2
string|list $command the command to execute	2
null|string $cwd the working directory	2
string|list $command	2
?int $index job id	2
string $originUrl The origin URL	2
non-empty-string $fileUrl The file URL	2
bool $progress Display the progression	2
mixed[] $options Additional context options	2
string[] $headers array of returned headers like from getLastHeaders()	2
string[] $http_response_header	2
mixed[] $options	2
Job $job	2
mixed[] $array	2
mixed $value	2
mixed[] $arguments	2
string[] $inputs	2
string[]|string $messages	2
int $size The size of line	2
PluginInterface $plugin plugin instance	2
RepositoryInterface $repo Repository to scan for plugins to install	2
class-string $capabilityClassName The fully qualified name of the API interface which the plugin may provide	2
array $ctorArgs Arguments passed to Capability's constructor.	2
string $url package url	2
PackageInterface $initial initial package	2
bool $preferSource prefer downloading from source	2
PackageInterface $package package instance	2
PackageInterface $package package instance	2
Rule::RULE_* $reason A RULE_* constant	2
mixed $reasonData	2
?ConstraintInterface $constraint A constraint that all returned	2
string $file File to extract	2
string $path Path where to extract file	2
list $literals	2
string[] $errors	2
Rule::RULE_* $reason A RULE_* constant describing the reason for generating this rule	2
int $schema a JsonFile::*_SCHEMA constant	2
string|null $schemaFile a path to the schema file	2
array $packages	2
mixed $value	2
PackageInterface[] $resultPackages	2
int[] $acceptableStabilities array of stability => BasePackage::STABILITY_* value	2
int[] $stabilityFlags an array of package name => BasePackage::STABILITY_* value	2
array $installedMap A map of all present packages	2
bool $prepend Whether to prepend the directories	2
bool|null $disablePlugins If null, reads --no-plugins as default	2
bool|null $disableScripts If null, reads --no-scripts as default	2
array $requirements	2
array $versions	2
array{callable, callable} $callbacks Validator and normalizer callbacks	2
array $values	2
array $new	2
PackageInterface $package Package instance	2
InstallerInterface $installer installer instance	2
OperationInterface[] $operations List of operations to execute in this batch	2
OperationInterface[] $allOperations Complete list of operations to be executed in the install job, used for event listeners	2
non-empty-array $sources	2
self::FORMAT_* $format The format that will be used to output audit results.	2
string $prettyVersion The package's non-normalized version	2
mixed[] $extra	2
array $suggests A set of package names/comments	2
array $autoload Mapping of autoloading rules	2
array $devAutoload Mapping of dev autoloading rules	2
string $version The version the alias must report	2
string $prettyVersion The alias's non-normalized version	2
null|list $mirrors	2
array $references	2
string $sourcePath Directory containing sources to be filtered	2
mixed[] $config package data	2
string $class FQCN to be instantiated	2
array $requires	2
array $repoConfig	3
array $packages	3
array|null $acceptableStabilities	3
array|null $stabilityFlags an array of package name => BasePackage::STABILITY_* value	3
string[] $packageNames	3
array $installPaths	3
string $identifier Any identifier to a specific branch/tag/commit	3
non-empty-string $mirrorUrl	3
string $originUrl The host this GitLab instance is located at	3
string|false $result	3
Job $job	3
string $name Name	3
string $repositoryName The unique name of repository	3
string $question The question to ask	3
string $path package directory	3
string $path download path	3
string $targetDir target dir	3
PackageInterface|null $prevPackage previous package instance in case of updates	3
string $targetDir target dir	3
string $path download path	3
Rule $rule The rule to check against	3
int[] $literals	3
OperationInterface[] $operations	3
list $aliases	3
array $versions	3
InstalledRepository|null $installedRepo If passed in, suggested packages which are installed already will be skipped	3
PackageInterface|null $onlyDependentsOf If passed in, only the suggestions from direct dependents of that package, or from the package itself, will be shown	3
array> $advisories	3
bool|'local'|'global' $disablePlugins Whether plugins should not be loaded, can be set to local or global to only disable local/global plugins	4
string $packageName	4
IOInterface $io The IO instance	4
Config $config The composer configuration	4
HttpDownloader $httpDownloader Remote Filesystem, injectable for mocking	4
ProcessExecutor $process Process instance, injectable for mocking	4
string[] $headers Headers from Composer\Downloader\TransportException.	4
string $url URL to download	4
mixed[] $options Stream context options e.g. https://www.php.net/manual/en/context.http.php	4
class-string $class	4
string $path download path	4
array $learnedPool	4
PackageInterface $package package instance	4
InstalledRepositoryInterface $repo repository in which to check	4
BasePackage[] $packages	5
PackageInterface $prevPackage previous package instance in case of an update	5
array $packageMap	5
JsonStructure $json	5
InstalledRepositoryInterface $repo repository in which to check	5
array $packageConfig	5
PackageInterface[] $packages	6
string|string[] $messages The message as an array of lines or a single string	6
bool $newline Whether to add a newline or not	6
int $verbosity Verbosity level from the VERBOSITY_* constants	6
string $type one of install/update/uninstall	6
RepositoryInterface[] $repositories	7
mixed[] $options	7
non-empty-string $url	7
PackageInterface $package package instance	9
PackageInterface $package package instance	12
@private	*/	1
	* @internal	2
@protected	*/	1
@readonly	*/	10
@return	array{highlight: OutputFormatterStyle, warning: OutputFormatterStyle}	1
	Composer|PartialComposer Composer if $fullLoad is true, otherwise PartialComposer	1
	PartialComposer|Composer|null By default PartialComposer, but Composer if $fullLoad is set to true	1
	Archiver\ArchiveManager	1
	Finder	1
	array	1
	string|mixed	1
	string Version constraint usable with composer/semver	1
	string|null If the package is being replaced or provided but is not really installed, null will be returned as reference	1
	string|null If the package is being replaced or provided but is not really installed, null will be returned as install path. Packages of type metapackages also have a null install path.	1
	int 0 on success or a positive error code on failure	1
	int exit code	1
	array>	1
	string The PHP string with the whitespace removed	1
	BasePackage|null	1
	array[] an array of array('name' => '...', 'description' => '...'|null, 'abandoned' => 'string'|true|unset) For SEARCH_VENDOR the name will be in "vendor" form	1
	array	1
	array|mixed	1
	bool true if packages were never installed in this repository	1
	list	1
	AliasPackage|CompleteAliasPackage	1
	0|positive-int Number of packages	1
	array<'tags'|'branches', array>	1
	array{name: string|null, dist: array{type: string, url: string, reference: string, shasum: string}|null, source: array{type: string, url: string, reference: string}}	1
	\Composer\Package\CompletePackage|\Composer\Package\CompleteAliasPackage|null|false null if no cache present, false if the absence of a version was cached	1
	BasePackage|array|null	1
	array{namesFound: array, packages: array}	1
	array<'providers'|'provider-includes'|'packages'|'providers-url'|'notify-batch'|'search'|'mirrors'|'providers-lazy-url'|'metadata-url'|'available-packages'|'available-package-patterns', mixed>|true	1
	array|true	1
	bool true if the package name is present in availablePackages or matched by availablePackagePatterns	1
	ConstraintInterface[] an array of package name => constraint from the root package, platform requirements excluded	1
	array Runtime temporary constraints that will be used to filter packages	1
	array>	1
	?BasePackage	1
	mixed[]|null|false Package version data if found, false to indicate the identifier is known but has no package, null for an unknown identifier	1
	array[] An associative array of arrays as described above.	1
	($allowPartialAdvisories is true ? array{namesFound: string[], advisories: array>} : array{namesFound: string[], advisories: array>})	1
	array{root: array{name: string, pretty_version: string, version: string, reference: string|null, type: string, install_path: string, aliases: string[], dev: bool}, versions: array}	1
	array{pretty_version: string, version: string, reference: string|null, type: string, install_path: string, aliases: string[], dev_requirement: bool}	1
	array{name: string, pretty_version: string, version: string, reference: string|null, type: string, install_path: string, aliases: string[], dev: bool}	1
	array|false	1
	array|null	1
	string The correct type of protocol	1
	Response The result	1
	string Base URL for GitLab API v3	1
	string[] where keys are named references like tags or branches and the value a sha	1
	mixed[]|null Array containing all infos from the composer.json file, or null to denote that no file was present	1
	string Identifier	1
	array Branch names as keys, identifiers as values	1
	array Tag names as keys, identifiers as values	1
	array{type: string, url: string, reference: string, shasum: string}|null	1
	array{type: string, url: string, reference: string}	1
	bool Whether the repository has a composer file for a given identifier.	1
	($packages is non-empty-array ? T : T|null)	1
	array	1
	PackageInterface[] sorted array	1
	array{list, list, list} a triple containing the errors, publishable errors, and warnings	1
	string|null The git version number, if present.	1
	\Composer\Util\Svn	1
	bool|stdClass	1
	null|stdClass Null if the hostname is invalid	1
	bool False if the host contains invalid data	1
	mixed[] in_addr, size	1
	string[] network in_addr, binary mask	1
string Mapped or existing in_addr	1
mixed[] host, port, if there was error	1
array containing retry (bool) and storeAuth (string|bool) keys, if retry is true the request should be	1
string[] updated headers array	1
bool Whether the given URL is a public BitBucket download which requires no authentication.	1
int The old error reporting level.	1
mixed Return value of the callback.	1
bool|null Returns null, when no edge case was hit. Otherwise a bool whether removal was successful	1
ProcessExecutor	1
string resolved path to symbolic link or original pathname (unresolved)	1
array{limit: int|'?', reset: string}	1
array{access_token: non-empty-string, refresh_token: non-empty-string, token_type: non-empty-string, expires_in?: positive-int, created_at: positive-int}	1
bool true on expired token, false if token is fresh or expiration date is not set	1
array{access_token: non-empty-string, refresh_token: non-empty-string, token_type: non-empty-string, expires_in: positive-int, created_at: positive-int}	1
array{Job, PromiseInterface}	1
int number of active (queued or started) jobs	1
?string[]	1
string The formal user home as detected from environment parameters	1
bool Whether the host machine is running on the Windows Subsystem for Linux (WSL)	1
bool Whether the host machine is running a Windows OS	1
int return a guaranteed binary length of the string, regardless of silly mbstring configs	1
bool Whether the current command is for bash completion	1
'NUL'|'/dev/null'	1
resource Default context	1
array formatted as a stream context array	1
array{cn: string, san: string[]}|null	1
non-empty-string the updated URL	1
array{master: string}	1
int number of active (queued or started) jobs	1
int the timeout in seconds	1
string The escaped argument	1
string|null The hg version number, if present.	1
bool true	1
bool|string The content	1
int|null	1
string|false The response contents or false on failure	1
array{0: string|null, 1: string} value, name	1
?contextOptions	1
array	1
array{retry: bool, storeAuth: 'prompt'|bool}	1
array{path: string, version: string, min-php: int, eol?: true}	1
array>	1
string The event name	1
string[] The event arguments	1
mixed[] The event flags	1
bool Whether propagation has been stopped	1
int return code of the executed script if any, for php scripts a false return	1
int return code of the executed script if any, for php scripts a false return	1
int return code of the executed script if any, for php scripts a false return	1
array All listeners: callables and scripts	1
string[] Listeners	1
array> The event names to listen to	1
string[] */	1
string output	1
false|resource stream	1
ProgressBar	1
mixed The user answer	1
bool true if the user has confirmed, false otherwise	1
string|null The answer	1
int|string|list|bool The selected value or values (the key of the choices array)	1
array The map of authentication data	1
array{username: string|null, password: string|null}	1
array plugins	1
array Map of package names to packages	1
string|null Install path	1
null|string The fully qualified class of the implementation or null if Plugin is not of Capable type or does not provide it	1
CapabilityClass[]	1
array|null	1
\Composer\Package\PackageInterface|null The package.	1
int[] array of stability => BasePackage::STABILITY_* value	1
int[] array of package name => BasePackage::STABILITY_* value	1
array[] of package => version => [alias, alias_normalized]	1
\Composer\Command\BaseCommand[]	1
string|null reference or null	1
string "source" or "dist"	1
string file name	1
non-empty-string url	1
?array	1
?int	1
Rule|null A rule on conflict, otherwise null.	1
array{int, int, GenericRule, int}	1
int|string	1
self::RULE_*	1
false */	1
Problem[]	1
array	1
int A literal	1
null|string if a string is returned, it is the commit reference that was checked out if the original could not be found	1
array */	1
array{self::TYPE_PACKAGE, self::TYPE_REQUEST, self::TYPE_LEARNED}	1
BasePackage[] A set of packages	1
array	1
array	1
?LockArrayRepository	1
Pool Optimized pool	1
?BaseEvent	1
ConstraintInterface[]	1
Rule|null The generated rule or null if tautological	1
Rule The generated rule	1
?Rule The generated rule	1
string Encoded json	1
bool true on success	1
array{0: int, 1: Rule} a literal and decision reason	1
array	1
Rule|null If a conflict is found the conflicting rule is returned	1
array{0: int, 1: Rule}|false	1
array> The problem's reasons	1
?string a version string or null if it appears the package was artificially disabled	1
list a list of pretty versions and '...' where versions were removed	1
array{0: string, 1: string}	1
RuleSet::TYPE_*|-1	1
ClassMap	1
non-empty-string|null	1
non-empty-array	1
ClassLoader	1
array|array>|array	1
array Array of classname => path	1
true|null True if loaded, null otherwise	1
string|false The path if found, false otherwise	1
array	1
array A class map array	1
(BasePackage&CompletePackageInterface)|false	1
array{string, string} name version	1
Composer|null	1
IOInterface	1
Composer	1
bool[] An array composed of the preferSource and preferDist values	1
Auditor::FORMAT_*	1
array|string|string[]	1
array{CompletePackageInterface|null, array}	1
array>|string|null>	1
array>|string>>	1
array{name: string, email: string|null}	1
array	1
list	1
int Exit code of the operation.	1
bool Whether the phar is valid and has been moved	1
bool If the operation succeeded	1
bool Whether composer.phar has been updated	1
string|string[]|true	1
mixed|string	1
string[]|true	1
string|\Exception|true	1
string|null absolute path to install to, which MUST not end with a slash, or null if the package does not have anything installed on disk	1
null	1
string configured install path	1
array Suggested packages with source, target and reason keys.	1
string|null absolute path to install to, which does not end with a slash, or null if the package does not have anything installed on disk	1
SecurityAdvisory|PartialSecurityAdvisory	1
array	1
int Amount of packages with vulnerabilities found	1
array{int, int} Count of affected packages and total count of advisories	1
list	1
array	1
array Map of script name to array of handlers	1
mixed[] Repositories	1
string[] The package licenses	1
array	1
array{issues?: string, forum?: string, wiki?: string, source?: string, email?: string, irc?: string, docs?: string, rss?: string, chat?: string, security?: string}	1
array	1
CompletePackage	1
BasePackage	1
\Composer\Package\Link[]	1
string[][]	1
mixed[][]	1
string|null The formatted datetime or null if none was found.	1
string[] An array of strings referring to this package	1
int The previously set package id	1
string The package type	1
?string The package targetDir	1
mixed[] The package extra data	1
?string source/dist	1
?string The repository url	1
?string The repository reference	1
?non-empty-string	1
non-empty-string[]	1
?\DateTimeInterface	1
array A map of package links defining required packages, indexed by the require package's name	1
Link[] An array of package links defining conflicting packages	1
Link[] An array of package links defining provided packages	1
Link[] An array of package links defining replaced packages	1
array A map of package links defining packages required for development, indexed by the require package's name	1
array An array of package suggestions with descriptions	1
array Mapping of autoloading rules	1
array Mapping of dev autoloading rules	1
array{priority?: int, configure-options?: list}|null	1
?RepositoryInterface	1
RootPackage	1
array	1
string A filename without an extension	1
string The path of the created archive	1
bool Whether the file should be excluded	1
array Exclude patterns to be used in filter()	1
array Exclude patterns	1
array{0: non-empty-string, 1: bool, 2: bool} An exclude pattern	1
bool true if the current element is acceptable, otherwise false.	1
array{0: string, 1: bool, 2: bool}|null An exclude pattern for filter()	1
bool true if the format is supported by the archiver	1
string The path to the written archive file	1
bool true if any package name is acceptable	1
array{version: string|null, commit: string|null, pretty_version: string|null, feature_version?: string|null, feature_pretty_version?: string|null}	1
array{version: string, pretty_version: string}|null	1
array{version: string|null, commit: ''|null, pretty_version: string|null, feature_version?: string|null, feature_pretty_version?: string|null}|null	1
array{version: string|null, pretty_version: string|null}	1
array{version: string|null, commit: '', pretty_version: string|null}	1
array{version: string, commit: '', pretty_version: string}|null	1
PackageInterface|false	1
CompletePackage|RootPackage	1
RootPackage|RootAliasPackage|CompletePackage|CompleteAliasPackage	1
string|null normalized version of the branch alias or null if there is none	1
RootPackage|RootAliasPackage	1
array	1
array{changed?: string[], removed?: string[], added?: string[]}|false false if no change	1
string empty string if no changes	1
array>|false	1
?Composer If $required is true then the return value is guaranteed	1
\Symfony\Component\Console\Command\Command[]	1
Command\BaseCommand[]	1
'prompt'|bool	1
array	2
string|null If the package is being replaced or provided but is not really installed, null will be returned as version, use satisfies or getVersionRanges if you need to know if a given version is present	2
array[] an array with the provider name as key and value of array('name' => '...', 'description' => '...', 'type' => '...')	2
string[] Names of dependencies installed through require-dev	2
list	2
array	2
bool true on success	2
bool true on success	2
Response	2
mixed[] Options	2
mixed|null	2
int statuscode	2
string|null	2
bool|string	2
int internal job id	2
int return code of the executed script if any, for php scripts a false return	2
string|null changes or null	2
true true on success	2
OperationInterface[] reordered operation list	2
array	2
array>	2
list	2
string|\Exception	2
false	2
Link[]	2
string package name	2
?string The repository type	2
?list	2
CompletePackage|CompleteAliasPackage|RootPackage|RootAliasPackage	2
int|false	3
array	3
array[]	3
bool|null true if dev requirements were installed, false if --no-dev was used, null if yet unknown	3
($allowPartialAdvisories is true ? array> : array>)	3
mixed[]|null	3
true	3
PromiseInterface	3
int	3
bool true on success	3
bool Whether the rules are equal	3
OperationInterface[]	3
list	3
string version	3
array	4
never	4
DownloadManager	4
list	4
array	4
int[]	4
PackageInterface[]	5
array	5
JsonStructure	5
$this	6
string|true	7
RepositoryInterface[]	8
PromiseInterface|null	9
string|false	10
BasePackage[]	11
non-empty-string	11
mixed[]	11
array	12
mixed	13
?string	14
list	15
string	21
string[]	27
Installer	31
bool	40
void	72
@see	RepositorySet for ways to work with sets of repos	1
	RepositoryUtils for ways to work with single repos	1
	ZipDownloader}).	1
	https://www.php-fig.org/psr/psr-0/	1
	https://www.php-fig.org/psr/psr-4/	1
	https://www.php.net/curl_getinfo	1
	https://github.com/composer/composer/issues/11148	1
	https://docs.github.com/en/rest/overview/other-authentication-methods#authenticating-for-saml-sso	1
	EventSubscriberInterface	1
	createStream	1
	Factory::create()} with the given arguments, taking into account flags and default states for disabling scripts and plugins	1
	BaseCommand::requireComposer()	1
	setRootPackageAlias	1
	getPrettyVersion	1
	https://docs.gitlab.com/ee/api/oauth2.html#resource-owner-password-credentials-flow	2
	Command::complete()	2
@static	* @throws \ErrorException	1
@template	PackageClass of CompletePackage	1
	CapabilityClass of Capability	2
	T of PackageInterface	3
@throws	\InvalidArgumentException if repository for provided type is not registered	1
	\Exception Any exceptions from the callback are rethrown.	1
	\RuntimeException If the user home could not reliably be determined	1
	\RuntimeException if https proxy required and OpenSSL uninstalled	1
	TransportException When the file could not be downloaded	1
	\RuntimeException If the proxy url is invalid	1
	\RuntimeException|\Exception	1
	\RuntimeException If there is no data to read in the input stream	1
	\Exception When any of the validators return an error	1
	\RuntimeException On empty or non-string implementation class name value	1
	\RuntimeException in case the operation must be aborted	1
	\RuntimeException in case the operation must be aborted or the patch does not apply cleanly	1
	\InvalidArgumentException if downloader for provided type is not registered	1
	\InvalidArgumentException if package has no installation source specified	1
	\LogicException if specific downloader used to load package with	1
	\InvalidArgumentException if initial package is not installed	1
	\RuntimeException If any problem with the url	1
	\UnexpectedValueException If can not extract downloaded file to path	1
	\UnexpectedValueException|\Exception	1
	\InvalidArgumentException Throws an exception, if the package has illegal settings.	1
	\RuntimeException When the path is neither an existing file nor directory	1
	\Symfony\Component\Console\Exception\InvalidArgumentException	1
	FilesystemException If the file cannot be moved	1
	\Symfony\Component\Console\Exception\ExceptionInterface	1
	InvalidArgumentException if $initial package is not installed	1
	\InvalidArgumentException if installer for provided type is not registered	1
	InvalidArgumentException If no packages are passed in	1
	\UnexpectedValueException If no pretty constraint was provided	1
	InvalidArgumentException When argument mode is not valid	1
	InvalidArgumentException If option mode is invalid or incompatible	1
	\LogicException	2
	\ReflectionException	2
	\InvalidArgumentException if package have no urls to download from	2
	FilesystemException	2
	JsonValidationException	3
	ParsingException	4
	TransportException|\Exception	5
	\UnexpectedValueException	6
	\Seld\JsonLint\ParsingException	6
	TransportException	8
	\Exception	9
	\InvalidArgumentException	11
	\RuntimeException	42
@tutorial	*	1
@var	RootPackageInterface	1
	Loop	1
	Repository\RepositoryManager	1
	Installer\InstallationManager	1
	ConfigSourceInterface|null */	1
	Downloader\DownloadManager	1
	Plugin\PluginManager	1
	Autoload\AutoloadGenerator	1
	ArchiveManager	1
	mixed[]|null	1
	bool|null	1
	DownloadManager	1
	InstallationManager	1
	AutoloadGenerator	1
	Auditor::FORMAT_* */	1
	non-empty-list|null	1
	Request::UPDATE_* */	1
	?RepositoryInterface	1
	\DateTime */	1
	array */	1
	array	1
	array	1
	Runtime */	1
	HhvmDetector */	1
	?array */	1
	?array indexed by package unique name and used to cache hasPackage calls	1
	?LoaderInterface */	1
	array> */	1
	?VcsDriverInterface */	1
	?VersionCacheInterface */	1
	array<'tags'|'branches', array> */	1
	Cache */	1
	?non-empty-string a URL containing %package% which can be queried to get providers of a given name */	1
	bool Indicates whether a comprehensive list of packages this repository might provide is expressed in the repository root. **/	1
	?array */	1
	?array */	1
	?array> */	1
	mixed[]|true */	1
	?array */	1
	array{metadata: bool, api-url: string|null}|null */	1
	array list of package names which are fresh and can be loaded from the cache directly in case loadPackage is called several times	1
	array list of package names which returned a 404 and should not be re-fetched in case loadPackage is called several times	1
	RepositoryInterface[] */	1
	array{url: string} */	1
	InstalledRepositoryInterface */	1
	list */	1
	array> */	1
	ArrayLoader	1
	array{symlink?: bool, reference?: string, relative?: bool, versions?: array}	1
	RepositoryInterface */	1
	?RootPackageInterface */	1
	array|false|null */	1
	string|false */	1
	\Composer\Util\Svn	1
	?Perforce */	1
	?VcsDriver	1
	string|null if set either git or hg */	1
	array Map of tag name (can be turned to an int by php if it is a numeric name) to identifier */	1
	array Map of branch name (can be turned to an int by php if it is a numeric name) to identifier */	1
	mixed[] Project data returned by GitLab API	1
	array Keeps commits returned by GitLab API as commit id => info	1
	string One of ssh, http	1
	bool defines whether the repo is private or not	1
	bool true if the origin has a port number or a path component in it	1
?array{username: string, password: string}	1
(null|object)[]	1
array Map of origins to message displayed */	1
array Map of URLs and whether they already retried with authentication from Bitbucket */	1
int[] Unpop stack	1
array{access_token: string, expires_in?: int}|null */	1
int|null */	1
array */	1
?CurlDownloader */	1
?RemoteFilesystem */	1
?Filesystem */	1
\Composer\Util\ProcessExecutor	1
ProcessExecutor|null */	1
array>> */	1
?NoProxyPattern */	1
?self */	1
?contextOptions */	1
Job[] */	1
array */	1
array>|null */	1
string This event's name	1
string[] Arguments passed by the user, these will be forwarded to CLI script handlers	1
mixed[] Flags usable in PHP script handlers	1
bool Whether the event should not be passed to more listeners	1
?ClassLoader */	1
array>> */	1
?ExecutableFinder */	1
StringInput */	1
StreamOutput */	1
InputInterface */	1
OutputInterface */	1
HelperSet */	1
array */	1
array */	1
OutputInterface	1
Composer */	1
PartialComposer|null */	1
bool|'local'|'global' */	1
array */	1
array */	1
HttpDownloader	1
Request	1
array[] of package => version => [alias, alias_normalized]	1
array */	1
array	1
array>	1
array Map of package name to cache key	1
array Map of package name to list of paths */	1
array */	1
RuleWatchGraph */	1
Decisions */	1
Perforce|null */	1
Link|BasePackage|ConstraintInterface|string	1
GitUtil	1
array|null */	1
array>> */	1
array> */	1
Rule */	1
array	1
array */	1
0|positive-int */	1
array */	1
array> */	1
array> Map of package name => normalized version => pretty version */	1
array> Map of package object hash => removed normalized versions => removed pretty version */	1
array */	1
ZipArchive|null */	1
?LockArrayRepository */	1
false|self::UPDATE_* */	1
non-empty-list|null */	1
PolicyInterface	1
array	1
array>	1
Composer The composer instance	1
IOInterface The IO instance	1
bool Dev mode flag	1
BaseEvent|null	1
array */	1
?HttpDownloader */	1
array */	1
array	1
PackageInterface[]	1
array	1
array	1
array */	1
?EventDispatcher	1
PoolOptimizer|null	1
array	1
array	1
array{dev: BasePackage[], non-dev: BasePackage[], all: BasePackage[]}	1
array|null	1
array>	1
array */	1
array */	1
RuleSet::TYPE_*|-1 */	1
?bool	1
\Closure(string):void */	1
array>	1
array>	1
array>>	1
array	1
array	1
array	1
?CompositeRepository */	1
RepositorySet[] */	1
Composer|null	1
?RepositorySet */	1
string[] Array with command events	1
string file name */	1
?string contents before modification if the lock file exists */	1
RepositoryInterface	1
OperationInterface The operation instance which is being executed	1
Transaction	1
DownloadManager|null */	1
BinaryInstaller */	1
array	1
array */	1
array */	1
DateTimeImmutable	1
non-empty-array	1
'source'|'dist'|null */	1
?\DateTimeInterface */	1
array{priority?: int, configure-options?: list}|null */	1
CompletePackage */	1
BasePackage */	1
InstallationManager */	1
ArrayDumper */	1
mixed[]|null */	1
array */	1
?RepositoryInterface */	1
RootPackage */	1
array */	1
array Map of script name to array of handlers */	1
array{issues?: string, forum?: string, wiki?: string, source?: string, email?: string, irc?: string, docs?: string, rss?: string, chat?: string, security?: string} */	1
array */	1
bool|string */	1
array Map of package name to stability constant */	1
array Map of package name to reference/commit hash */	1
list */	1
ArchiverInterface[]	1
Finder	1
array array of [$pattern, $negate, $stripLeadingSlash] arrays	1
array */	1
SemverVersionParser	1
RepositorySet */	1
array */	1
array Constraint parsing cache */	1
int One or more of self::CHECK_* constants */	1
mixed[] package config */	1
IOInterface|null	1
string Source directory */	1
string Target directory */	1
array{changed?: string[], removed?: string[], added?: string[]} */	1
?Composer	1
string|false Store the initial working directory at startup time	1
SignalHandler */	1
array */	2
ConfigSourceInterface */	2
RootPackageInterface&BasePackage	2
RepositoryManager	2
Locker	2
list|null */	2
SuggestedPackagesReporter	2
PlatformRequirementFilterInterface	2
array */	2
?string	2
VersionParser	2
RepositoryInterface[]	2
?array */	2
ArrayLoader */	2
int[] array of stability => BasePackage::STABILITY_* value	2
int[] array of package name => BasePackage::STABILITY_* value	2
array	2
VersionGuesser	2
?GitDriver	2
?Cache */	2
\Composer\IO\IOInterface	2
int	2
\Composer\Config	2
?ProcessExecutor */	2
?int */	2
AuthHelper */	2
?ProxyItem */	2
Request */	2
?resource */	2
float */	2
PartialComposer */	2
InputInterface	2
array|null	2
mixed	2
RuleSet */	2
Problem[] */	2
array */	2
bool[]	2
array */	2
list */	2
array */	2
array	2
array>	2
PolicyInterface */	2
OperationInterface[]	2
int[]	2
array> */	2
AliasPackage	2
list	2
JsonConfigSource	2
Composer	2
DownloadManager */	2
ConstraintInterface	2
list|\Closure(CompletionInput,CompletionSuggestions):list	2
bool|null */	3
?bool */	3
EventDispatcher	3
mixed[]	3
Loop */	3
?list */	3
ConstraintInterface[]	3
LoaderInterface */	3
ProcessExecutor	3
JsonFile */	3
string|false|null */	3
?IOInterface */	3
JsonFile	3
non-empty-string	3
Pool */	3
BasePackage[] */	3
array */	3
array */	3
array */	3
array */	4
array */	4
string|null */	4
?EventDispatcher */	4
BasePackage[]	4
array	4
PackageInterface	4
Config	5
array[]	5
array	5
array */	5
Link[] */	5
array */	6
array Map of tag name to identifier */	6
array Map of branch name to identifier */	6
VersionParser */	7
non-empty-string */	7
string[]	8
string|null	8
Filesystem */	9
IOInterface	9
list */	9
string[] */	10
HttpDownloader */	11
mixed[] */	12
bool	12
ProcessExecutor */	13
?non-empty-string */	13
Config */	14
IOInterface */	26
int */	26
?string */	28
string	45
string */	70
bool */	80