class Application
Same name in this branch
- 11.1.x vendor/phpunit/phpunit/src/TextUI/Application.php \PHPUnit\TextUI\Application
- 11.1.x vendor/phar-io/manifest/src/values/Application.php \PharIo\Manifest\Application
- 11.1.x vendor/symfony/console/Application.php \Symfony\Component\Console\Application
The console application that handles the commands
@author Ryan Weaver <ryan@knplabs.com> @author Jordi Boggiano <j.boggiano@seld.be> @author François Pluchino <francois.pluchino@opendisplay.com>
Hierarchy
- class \Symfony\Component\Console\Application implements \Symfony\Contracts\Service\ResetInterface
- class \Composer\Console\Application extends \Symfony\Component\Console\Application
Expanded class hierarchy of Application
1 file declares its use of Application
- BaseCommand.php in vendor/
composer/ composer/ src/ Composer/ Command/ BaseCommand.php
4 string references to 'Application'
- ManifestDocumentMapper::mapType in vendor/
phar-io/ manifest/ src/ ManifestDocumentMapper.php - ManifestSerializer::addContains in vendor/
phar-io/ manifest/ src/ ManifestSerializer.php - SMimeEncrypter::encrypt in vendor/
symfony/ mime/ Crypto/ SMimeEncrypter.php - Status::reportNoRestart in vendor/
composer/ xdebug-handler/ src/ Status.php - No restart status message
File
-
vendor/
composer/ composer/ src/ Composer/ Console/ Application.php, line 53
Namespace
Composer\ConsoleView source
class Application extends BaseApplication {
/**
* @var ?Composer
*/
protected $composer;
/**
* @var IOInterface
*/
protected $io;
/** @var string */
private static $logo = ' ______
/ ____/___ ____ ___ ____ ____ ________ _____
/ / / __ \\/ __ `__ \\/ __ \\/ __ \\/ ___/ _ \\/ ___/
/ /___/ /_/ / / / / / / /_/ / /_/ (__ ) __/ /
\\____/\\____/_/ /_/ /_/ .___/\\____/____/\\___/_/
/_/
';
/** @var bool */
private $hasPluginCommands = false;
/** @var bool */
private $disablePluginsByDefault = false;
/** @var bool */
private $disableScriptsByDefault = false;
/**
* @var string|false Store the initial working directory at startup time
*/
private $initialWorkingDirectory;
public function __construct(string $name = 'Composer', string $version = '') {
if (method_exists($this, 'setCatchErrors')) {
$this->setCatchErrors(true);
}
static $shutdownRegistered = false;
if ($version === '') {
$version = Composer::getVersion();
}
if (function_exists('ini_set') && extension_loaded('xdebug')) {
ini_set('xdebug.show_exception_trace', '0');
ini_set('xdebug.scream', '0');
}
if (function_exists('date_default_timezone_set') && function_exists('date_default_timezone_get')) {
date_default_timezone_set(Silencer::call('date_default_timezone_get'));
}
$this->io = new NullIO();
if (!$shutdownRegistered) {
$shutdownRegistered = true;
register_shutdown_function(static function () : void {
$lastError = error_get_last();
if ($lastError && $lastError['message'] && (strpos($lastError['message'], 'Allowed memory') !== false || strpos($lastError['message'], 'exceeded memory') !== false)) {
echo "\n" . 'Check https://getcomposer.org/doc/articles/troubleshooting.md#memory-limit-errors for more info on how to handle out of memory errors.';
}
});
}
$this->initialWorkingDirectory = getcwd();
parent::__construct($name, $version);
}
public function __destruct() {
}
public function run(?InputInterface $input = null, ?OutputInterface $output = null) : int {
if (null === $output) {
$output = Factory::createOutput();
}
return parent::run($input, $output);
}
public function doRun(InputInterface $input, OutputInterface $output) : int {
$this->disablePluginsByDefault = $input->hasParameterOption('--no-plugins');
$this->disableScriptsByDefault = $input->hasParameterOption('--no-scripts');
static $stdin = null;
if (null === $stdin) {
$stdin = defined('STDIN') ? STDIN : fopen('php://stdin', 'r');
}
if (Platform::getEnv('COMPOSER_TESTS_ARE_RUNNING') !== '1' && (Platform::getEnv('COMPOSER_NO_INTERACTION') || $stdin === false || !Platform::isTty($stdin))) {
$input->setInteractive(false);
}
$io = $this->io = new ConsoleIO($input, $output, new HelperSet([
new QuestionHelper(),
]));
// Register error handler again to pass it the IO instance
ErrorHandler::register($io);
if ($input->hasParameterOption('--no-cache')) {
$io->writeError('Disabling cache usage', true, IOInterface::DEBUG);
Platform::putEnv('COMPOSER_CACHE_DIR', Platform::isWindows() ? 'nul' : '/dev/null');
}
// switch working dir
$newWorkDir = $this->getNewWorkingDir($input);
if (null !== $newWorkDir) {
$oldWorkingDir = Platform::getCwd(true);
chdir($newWorkDir);
$this->initialWorkingDirectory = $newWorkDir;
$cwd = Platform::getCwd(true);
$io->writeError('Changed CWD to ' . ($cwd !== '' ? $cwd : $newWorkDir), true, IOInterface::DEBUG);
}
// determine command name to be executed without including plugin commands
$commandName = '';
if ($name = $this->getCommandName($input)) {
try {
$commandName = $this->find($name)
->getName();
} catch (CommandNotFoundException $e) {
// we'll check command validity again later after plugins are loaded
$commandName = false;
} catch (\InvalidArgumentException $e) {
}
}
// prompt user for dir change if no composer.json is present in current dir
if (null === $newWorkDir && !in_array($commandName, [
'',
'list',
'init',
'about',
'help',
'diagnose',
'self-update',
'global',
'create-project',
'outdated',
], true) && !file_exists(Factory::getComposerFile()) && ($useParentDirIfNoJsonAvailable = $this->getUseParentDirConfigValue()) !== false && ($commandName !== 'config' || $input->hasParameterOption('--file', true) === false && $input->hasParameterOption('-f', true) === false) && $input->hasParameterOption('--help', true) === false && $input->hasParameterOption('-h', true) === false) {
$dir = dirname(Platform::getCwd(true));
$home = realpath((Platform::getEnv('HOME') ?: Platform::getEnv('USERPROFILE')) ?: '/');
// abort when we reach the home dir or top of the filesystem
while (dirname($dir) !== $dir && $dir !== $home) {
if (file_exists($dir . '/' . Factory::getComposerFile())) {
if ($useParentDirIfNoJsonAvailable !== true && !$io->isInteractive()) {
$io->writeError('<info>No composer.json in current directory, to use the one at ' . $dir . ' run interactively or set config.use-parent-dir to true</info>');
break;
}
if ($useParentDirIfNoJsonAvailable === true || $io->askConfirmation('<info>No composer.json in current directory, do you want to use the one at ' . $dir . '?</info> [<comment>Y,n</comment>]? ')) {
if ($useParentDirIfNoJsonAvailable === true) {
$io->writeError('<info>No composer.json in current directory, changing working directory to ' . $dir . '</info>');
}
else {
$io->writeError('<info>Always want to use the parent dir? Use "composer config --global use-parent-dir true" to change the default.</info>');
}
$oldWorkingDir = Platform::getCwd(true);
chdir($dir);
}
break;
}
$dir = dirname($dir);
}
unset($dir, $home);
}
$needsSudoCheck = !Platform::isWindows() && function_exists('exec') && !Platform::getEnv('COMPOSER_ALLOW_SUPERUSER') && !Platform::isDocker();
$isNonAllowedRoot = false;
// Clobber sudo credentials if COMPOSER_ALLOW_SUPERUSER is not set before loading plugins
if ($needsSudoCheck) {
$isNonAllowedRoot = $this->isRunningAsRoot();
if ($isNonAllowedRoot) {
if ($uid = (int) Platform::getEnv('SUDO_UID')) {
// Silently clobber any sudo credentials on the invoking user to avoid privilege escalations later on
// ref. https://github.com/composer/composer/issues/5119
Silencer::call('exec', "sudo -u \\#{$uid} sudo -K > /dev/null 2>&1");
}
}
// Silently clobber any remaining sudo leases on the current user as well to avoid privilege escalations
Silencer::call('exec', 'sudo -K > /dev/null 2>&1');
}
// avoid loading plugins/initializing the Composer instance earlier than necessary if no plugin command is needed
// if showing the version, we never need plugin commands
$mayNeedPluginCommand = false === $input->hasParameterOption([
'--version',
'-V',
]) && (false === $commandName || in_array($commandName, [
'',
'list',
'help',
], true) || $commandName === '_complete' && !$isNonAllowedRoot);
if ($mayNeedPluginCommand && !$this->disablePluginsByDefault && !$this->hasPluginCommands) {
// at this point plugins are needed, so if we are running as root and it is not allowed we need to prompt
// if interactive, and abort otherwise
if ($isNonAllowedRoot) {
$io->writeError('<warning>Do not run Composer as root/super user! See https://getcomposer.org/root for details</warning>');
if ($io->isInteractive() && $io->askConfirmation('<info>Continue as root/super user</info> [<comment>yes</comment>]? ')) {
// avoid a second prompt later
$isNonAllowedRoot = false;
}
else {
$io->writeError('<warning>Aborting as no plugin should be loaded if running as super user is not explicitly allowed</warning>');
return 1;
}
}
try {
foreach ($this->getPluginCommands() as $command) {
if ($this->has($command->getName())) {
$io->writeError('<warning>Plugin command ' . $command->getName() . ' (' . get_class($command) . ') would override a Composer command and has been skipped</warning>');
}
else {
$this->add($command);
}
}
} catch (NoSslException $e) {
// suppress these as they are not relevant at this point
} catch (ParsingException $e) {
$details = $e->getDetails();
$file = realpath(Factory::getComposerFile());
$line = null;
if ($details && isset($details['line'])) {
$line = $details['line'];
}
$ghe = new GithubActionError($this->io);
$ghe->emit($e->getMessage(), $file, $line);
throw $e;
}
$this->hasPluginCommands = true;
}
if (!$this->disablePluginsByDefault && $isNonAllowedRoot && !$io->isInteractive()) {
$io->writeError('<error>Composer plugins have been disabled for safety in this non-interactive session.</error>');
$io->writeError('<error>Set COMPOSER_ALLOW_SUPERUSER=1 if you want to allow plugins to run as root/super user.</error>');
$this->disablePluginsByDefault = true;
}
// determine command name to be executed incl plugin commands, and check if it's a proxy command
$isProxyCommand = false;
if ($name = $this->getCommandName($input)) {
try {
$command = $this->find($name);
$commandName = $command->getName();
$isProxyCommand = $command instanceof Command\BaseCommand && $command->isProxyCommand();
} catch (\InvalidArgumentException $e) {
}
}
if (!$isProxyCommand) {
$io->writeError(sprintf('Running %s (%s) with %s on %s', Composer::getVersion(), Composer::RELEASE_DATE, defined('HHVM_VERSION') ? 'HHVM ' . HHVM_VERSION : 'PHP ' . PHP_VERSION, function_exists('php_uname') ? php_uname('s') . ' / ' . php_uname('r') : 'Unknown OS'), true, IOInterface::DEBUG);
if (\PHP_VERSION_ID < 70205) {
$io->writeError('<warning>Composer supports PHP 7.2.5 and above, you will most likely encounter problems with your PHP ' . PHP_VERSION . '. Upgrading is strongly recommended but you can use Composer 2.2.x LTS as a fallback.</warning>');
}
if (XdebugHandler::isXdebugActive() && !Platform::getEnv('COMPOSER_DISABLE_XDEBUG_WARN')) {
$io->writeError('<warning>Composer is operating slower than normal because you have Xdebug enabled. See https://getcomposer.org/xdebug</warning>');
}
if (defined('COMPOSER_DEV_WARNING_TIME') && $commandName !== 'self-update' && $commandName !== 'selfupdate' && time() > COMPOSER_DEV_WARNING_TIME) {
$io->writeError(sprintf('<warning>Warning: This development build of Composer is over 60 days old. It is recommended to update it by running "%s self-update" to get the latest version.</warning>', $_SERVER['PHP_SELF']));
}
if ($isNonAllowedRoot) {
if ($commandName !== 'self-update' && $commandName !== 'selfupdate' && $commandName !== '_complete') {
$io->writeError('<warning>Do not run Composer as root/super user! See https://getcomposer.org/root for details</warning>');
if ($io->isInteractive()) {
if (!$io->askConfirmation('<info>Continue as root/super user</info> [<comment>yes</comment>]? ')) {
return 1;
}
}
}
}
// Check system temp folder for usability as it can cause weird runtime issues otherwise
Silencer::call(static function () use ($io) : void {
$pid = function_exists('getmypid') ? getmypid() . '-' : '';
$tempfile = sys_get_temp_dir() . '/temp-' . $pid . bin2hex(random_bytes(5));
if (!(file_put_contents($tempfile, __FILE__) && file_get_contents($tempfile) === __FILE__ && unlink($tempfile) && !file_exists($tempfile))) {
$io->writeError(sprintf('<error>PHP temp directory (%s) does not exist or is not writable to Composer. Set sys_temp_dir in your php.ini</error>', sys_get_temp_dir()));
}
});
// add non-standard scripts as own commands
$file = Factory::getComposerFile();
if (is_file($file) && Filesystem::isReadable($file) && is_array($composer = json_decode(file_get_contents($file), true))) {
if (isset($composer['scripts']) && is_array($composer['scripts'])) {
foreach ($composer['scripts'] as $script => $dummy) {
if (!defined('Composer\\Script\\ScriptEvents::' . str_replace('-', '_', strtoupper($script)))) {
if ($this->has($script)) {
$io->writeError('<warning>A script named ' . $script . ' would override a Composer command and has been skipped</warning>');
}
else {
$description = null;
if (isset($composer['scripts-descriptions'][$script])) {
$description = $composer['scripts-descriptions'][$script];
}
$aliases = $composer['scripts-aliases'][$script] ?? [];
$this->add(new Command\ScriptAliasCommand($script, $description, $aliases));
}
}
}
}
}
}
try {
if ($input->hasParameterOption('--profile')) {
$startTime = microtime(true);
$this->io
->enableDebugging($startTime);
}
$result = parent::doRun($input, $output);
if (true === $input->hasParameterOption([
'--version',
'-V',
], true)) {
$io->writeError(sprintf('<info>PHP</info> version <comment>%s</comment> (%s)', \PHP_VERSION, \PHP_BINARY));
$io->writeError('Run the "diagnose" command to get more detailed diagnostics output.');
}
// chdir back to $oldWorkingDir if set
if (isset($oldWorkingDir) && '' !== $oldWorkingDir) {
Silencer::call('chdir', $oldWorkingDir);
}
if (isset($startTime)) {
$io->writeError('<info>Memory usage: ' . round(memory_get_usage() / 1024 / 1024, 2) . 'MiB (peak: ' . round(memory_get_peak_usage() / 1024 / 1024, 2) . 'MiB), time: ' . round(microtime(true) - $startTime, 2) . 's</info>');
}
return $result;
} catch (ScriptExecutionException $e) {
if ($this->getDisablePluginsByDefault() && $this->isRunningAsRoot() && !$this->io
->isInteractive()) {
$io->writeError('<error>Plugins have been disabled automatically as you are running as root, this may be the cause of the script failure.</error>', true, IOInterface::QUIET);
$io->writeError('<error>See also https://getcomposer.org/root</error>', true, IOInterface::QUIET);
}
return $e->getCode();
} catch (\Throwable $e) {
$ghe = new GithubActionError($this->io);
$ghe->emit($e->getMessage());
$this->hintCommonErrors($e, $output);
// symfony/console <6.4 does not handle \Error subtypes so we have to renderThrowable ourselves
// instead of rethrowing those for consumption by the parent class
// can be removed when Composer supports PHP 8.1+
if (!method_exists($this, 'setCatchErrors') && !$e instanceof \Exception) {
if ($output instanceof ConsoleOutputInterface) {
$this->renderThrowable($e, $output->getErrorOutput());
}
else {
$this->renderThrowable($e, $output);
}
return max(1, $e->getCode());
}
// override TransportException's code for the purpose of parent::run() using it as process exit code
// as http error codes are all beyond the 255 range of permitted exit codes
if ($e instanceof TransportException) {
$reflProp = new \ReflectionProperty($e, 'code');
$reflProp->setAccessible(true);
$reflProp->setValue($e, Installer::ERROR_TRANSPORT_EXCEPTION);
}
throw $e;
} finally {
restore_error_handler();
}
}
/**
* @throws \RuntimeException
* @return ?string
*/
private function getNewWorkingDir(InputInterface $input) : ?string {
/** @var string|null $workingDir */
$workingDir = $input->getParameterOption([
'--working-dir',
'-d',
], null, true);
if (null !== $workingDir && !is_dir($workingDir)) {
throw new \RuntimeException('Invalid working directory specified, ' . $workingDir . ' does not exist.');
}
return $workingDir;
}
private function hintCommonErrors(\Throwable $exception, OutputInterface $output) : void {
$io = $this->getIO();
if ((get_class($exception) === LogicException::class || $exception instanceof \Error) && $output->getVerbosity() < OutputInterface::VERBOSITY_VERBOSE) {
$output->setVerbosity(OutputInterface::VERBOSITY_VERBOSE);
}
Silencer::suppress();
try {
$composer = $this->getComposer(false, true);
if (null !== $composer && function_exists('disk_free_space')) {
$config = $composer->getConfig();
$minSpaceFree = 100 * 1024 * 1024;
if (($df = disk_free_space($dir = $config->get('home'))) !== false && $df < $minSpaceFree || ($df = disk_free_space($dir = $config->get('vendor-dir'))) !== false && $df < $minSpaceFree || ($df = disk_free_space($dir = sys_get_temp_dir())) !== false && $df < $minSpaceFree) {
$io->writeError('<error>The disk hosting ' . $dir . ' has less than 100MiB of free space, this may be the cause of the following exception</error>', true, IOInterface::QUIET);
}
}
} catch (\Exception $e) {
}
Silencer::restore();
if ($exception instanceof TransportException && str_contains($exception->getMessage(), 'Unable to use a proxy')) {
$io->writeError('<error>The following exception indicates your proxy is misconfigured</error>', true, IOInterface::QUIET);
$io->writeError('<error>Check https://getcomposer.org/doc/faqs/how-to-use-composer-behind-a-proxy.md for details</error>', true, IOInterface::QUIET);
}
if (Platform::isWindows() && false !== strpos($exception->getMessage(), 'The system cannot find the path specified')) {
$io->writeError('<error>The following exception may be caused by a stale entry in your cmd.exe AutoRun</error>', true, IOInterface::QUIET);
$io->writeError('<error>Check https://getcomposer.org/doc/articles/troubleshooting.md#-the-system-cannot-find-the-path-specified-windows- for details</error>', true, IOInterface::QUIET);
}
if (false !== strpos($exception->getMessage(), 'fork failed - Cannot allocate memory')) {
$io->writeError('<error>The following exception is caused by a lack of memory or swap, or not having swap configured</error>', true, IOInterface::QUIET);
$io->writeError('<error>Check https://getcomposer.org/doc/articles/troubleshooting.md#proc-open-fork-failed-errors for details</error>', true, IOInterface::QUIET);
}
if ($exception instanceof ProcessTimedOutException) {
$io->writeError('<error>The following exception is caused by a process timeout</error>', true, IOInterface::QUIET);
$io->writeError('<error>Check https://getcomposer.org/doc/06-config.md#process-timeout for details</error>', true, IOInterface::QUIET);
}
if ($this->getDisablePluginsByDefault() && $this->isRunningAsRoot() && !$this->io
->isInteractive()) {
$io->writeError('<error>Plugins have been disabled automatically as you are running as root, this may be the cause of the following exception. See also https://getcomposer.org/root</error>', true, IOInterface::QUIET);
}
elseif ($exception instanceof CommandNotFoundException && $this->getDisablePluginsByDefault()) {
$io->writeError('<error>Plugins have been disabled, which may be why some commands are missing, unless you made a typo</error>', true, IOInterface::QUIET);
}
$hints = HttpDownloader::getExceptionHints($exception);
if (null !== $hints && count($hints) > 0) {
foreach ($hints as $hint) {
$io->writeError($hint, true, IOInterface::QUIET);
}
}
}
/**
* @throws JsonValidationException
* @throws \InvalidArgumentException
* @return ?Composer If $required is true then the return value is guaranteed
*/
public function getComposer(bool $required = true, ?bool $disablePlugins = null, ?bool $disableScripts = null) : ?Composer {
if (null === $disablePlugins) {
$disablePlugins = $this->disablePluginsByDefault;
}
if (null === $disableScripts) {
$disableScripts = $this->disableScriptsByDefault;
}
if (null === $this->composer) {
try {
$this->composer = Factory::create(Platform::isInputCompletionProcess() ? new NullIO() : $this->io, null, $disablePlugins, $disableScripts);
} catch (\InvalidArgumentException $e) {
if ($required) {
$this->io
->writeError($e->getMessage());
if ($this->areExceptionsCaught()) {
exit(1);
}
throw $e;
}
} catch (JsonValidationException $e) {
if ($required) {
throw $e;
}
} catch (RuntimeException $e) {
if ($required) {
throw $e;
}
}
}
return $this->composer;
}
/**
* Removes the cached composer instance
*/
public function resetComposer() : void {
$this->composer = null;
if (method_exists($this->getIO(), 'resetAuthentications')) {
$this->getIO()
->resetAuthentications();
}
}
public function getIO() : IOInterface {
return $this->io;
}
public function getHelp() : string {
return self::$logo . parent::getHelp();
}
/**
* Initializes all the composer commands.
* @return \Symfony\Component\Console\Command\Command[]
*/
protected function getDefaultCommands() : array {
$commands = array_merge(parent::getDefaultCommands(), [
new Command\AboutCommand(),
new Command\ConfigCommand(),
new Command\DependsCommand(),
new Command\ProhibitsCommand(),
new Command\InitCommand(),
new Command\InstallCommand(),
new Command\CreateProjectCommand(),
new Command\UpdateCommand(),
new Command\SearchCommand(),
new Command\ValidateCommand(),
new Command\AuditCommand(),
new Command\ShowCommand(),
new Command\SuggestsCommand(),
new Command\RequireCommand(),
new Command\DumpAutoloadCommand(),
new Command\StatusCommand(),
new Command\ArchiveCommand(),
new Command\DiagnoseCommand(),
new Command\RunScriptCommand(),
new Command\LicensesCommand(),
new Command\GlobalCommand(),
new Command\ClearCacheCommand(),
new Command\RemoveCommand(),
new Command\HomeCommand(),
new Command\ExecCommand(),
new Command\OutdatedCommand(),
new Command\CheckPlatformReqsCommand(),
new Command\FundCommand(),
new Command\ReinstallCommand(),
new Command\BumpCommand(),
]);
if (strpos(__FILE__, 'phar:') === 0 || '1' === Platform::getEnv('COMPOSER_TESTS_ARE_RUNNING')) {
$commands[] = new Command\SelfUpdateCommand();
}
return $commands;
}
public function getLongVersion() : string {
$branchAliasString = '';
if (Composer::BRANCH_ALIAS_VERSION && Composer::BRANCH_ALIAS_VERSION !== '@package_branch_alias_version' . '@') {
$branchAliasString = sprintf(' (%s)', Composer::BRANCH_ALIAS_VERSION);
}
return sprintf('<info>%s</info> version <comment>%s%s</comment> %s', $this->getName(), $this->getVersion(), $branchAliasString, Composer::RELEASE_DATE);
}
protected function getDefaultInputDefinition() : InputDefinition {
$definition = parent::getDefaultInputDefinition();
$definition->addOption(new InputOption('--profile', null, InputOption::VALUE_NONE, 'Display timing and memory usage information'));
$definition->addOption(new InputOption('--no-plugins', null, InputOption::VALUE_NONE, 'Whether to disable plugins.'));
$definition->addOption(new InputOption('--no-scripts', null, InputOption::VALUE_NONE, 'Skips the execution of all scripts defined in composer.json file.'));
$definition->addOption(new InputOption('--working-dir', '-d', InputOption::VALUE_REQUIRED, 'If specified, use the given directory as working directory.'));
$definition->addOption(new InputOption('--no-cache', null, InputOption::VALUE_NONE, 'Prevent use of the cache'));
return $definition;
}
/**
* @return Command\BaseCommand[]
*/
private function getPluginCommands() : array {
$commands = [];
$composer = $this->getComposer(false, false);
if (null === $composer) {
$composer = Factory::createGlobal($this->io, $this->disablePluginsByDefault, $this->disableScriptsByDefault);
}
if (null !== $composer) {
$pm = $composer->getPluginManager();
foreach ($pm->getPluginCapabilities('Composer\\Plugin\\Capability\\CommandProvider', [
'composer' => $composer,
'io' => $this->io,
]) as $capability) {
$newCommands = $capability->getCommands();
if (!is_array($newCommands)) {
throw new \UnexpectedValueException('Plugin capability ' . get_class($capability) . ' failed to return an array from getCommands');
}
foreach ($newCommands as $command) {
if (!$command instanceof Command\BaseCommand) {
throw new \UnexpectedValueException('Plugin capability ' . get_class($capability) . ' returned an invalid value, we expected an array of Composer\\Command\\BaseCommand objects');
}
}
$commands = array_merge($commands, $newCommands);
}
}
return $commands;
}
/**
* Get the working directory at startup time
*
* @return string|false
*/
public function getInitialWorkingDirectory() {
return $this->initialWorkingDirectory;
}
public function getDisablePluginsByDefault() : bool {
return $this->disablePluginsByDefault;
}
public function getDisableScriptsByDefault() : bool {
return $this->disableScriptsByDefault;
}
/**
* @return 'prompt'|bool
*/
private function getUseParentDirConfigValue() {
$config = Factory::createConfig($this->io);
return $config->get('use-parent-dir');
}
private function isRunningAsRoot() : bool {
return function_exists('posix_getuid') && posix_getuid() === 0;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
Application::$alarmInterval | private | property | |||
Application::$autoExit | private | property | |||
Application::$catchErrors | private | property | |||
Application::$catchExceptions | private | property | |||
Application::$commandLoader | private | property | |||
Application::$commands | private | property | |||
Application::$composer | protected | property | |||
Application::$defaultCommand | private | property | |||
Application::$definition | private | property | |||
Application::$disablePluginsByDefault | private | property | @var bool | ||
Application::$disableScriptsByDefault | private | property | @var bool | ||
Application::$dispatcher | private | property | |||
Application::$hasPluginCommands | private | property | @var bool | ||
Application::$helperSet | private | property | |||
Application::$initialized | private | property | |||
Application::$initialWorkingDirectory | private | property | |||
Application::$io | protected | property | |||
Application::$logo | private static | property | @var string | ||
Application::$runningCommand | private | property | |||
Application::$signalRegistry | private | property | |||
Application::$signalsToDispatchEvent | private | property | |||
Application::$singleCommand | private | property | |||
Application::$terminal | private | property | |||
Application::$wantHelps | private | property | |||
Application::add | public | function | Adds a command object. | ||
Application::addCommands | public | function | Adds an array of command objects. | ||
Application::all | public | function | Gets the commands (registered in the given namespace if provided). | ||
Application::areExceptionsCaught | public | function | Gets whether to catch exceptions or not during commands execution. | ||
Application::complete | public | function | Adds suggestions to $suggestions for the current completion input (e.g. option or argument). | ||
Application::configureIO | protected | function | Configures the input and output instances based on the user arguments and options. | ||
Application::doRenderThrowable | protected | function | |||
Application::doRun | public | function | Runs the current application. | Overrides Application::doRun | |
Application::doRunCommand | protected | function | Runs the current command. | ||
Application::extractAllNamespaces | private | function | Returns all namespaces of the command name. | ||
Application::extractNamespace | public | function | Returns the namespace part of the command name. | ||
Application::find | public | function | Finds a command by name or alias. | ||
Application::findAlternatives | private | function | Finds alternative of $name among $collection, if nothing is found in $collection, try in $abbrevs. |
||
Application::findNamespace | public | function | Finds a registered namespace by a name or an abbreviation. | ||
Application::get | public | function | Returns a registered command by name or alias. | ||
Application::getAbbreviations | public static | function | Returns an array of possible abbreviations given a set of names. | ||
Application::getAbbreviationSuggestions | private | function | Returns abbreviated suggestions in string format. | ||
Application::getAlarmInterval | public | function | Gets the interval in seconds on which a SIGALRM signal is dispatched. | ||
Application::getCommandName | protected | function | Gets the name of the command based on input. | 2 | |
Application::getComposer | public | function | |||
Application::getDefaultCommands | protected | function | Initializes all the composer commands. | Overrides Application::getDefaultCommands | |
Application::getDefaultHelperSet | protected | function | Gets the default helper set with the helpers that should always be available. | ||
Application::getDefaultInputDefinition | protected | function | Gets the default input definition. | Overrides Application::getDefaultInputDefinition | |
Application::getDefinition | public | function | Gets the InputDefinition related to this Application. | 2 | |
Application::getDisablePluginsByDefault | public | function | |||
Application::getDisableScriptsByDefault | public | function | |||
Application::getHelp | public | function | Gets the help message. | Overrides Application::getHelp | |
Application::getHelperSet | public | function | Get the helper set associated with the command. | ||
Application::getInitialWorkingDirectory | public | function | Get the working directory at startup time | ||
Application::getIO | public | function | |||
Application::getLongVersion | public | function | Returns the long version of the application. | Overrides Application::getLongVersion | |
Application::getName | public | function | Gets the name of the application. | ||
Application::getNamespaces | public | function | Returns an array of all unique namespaces used by currently registered commands. | ||
Application::getNewWorkingDir | private | function | |||
Application::getPluginCommands | private | function | |||
Application::getSignalRegistry | public | function | |||
Application::getUseParentDirConfigValue | private | function | |||
Application::getVersion | public | function | Gets the application version. | ||
Application::has | public | function | Returns true if the command exists, false otherwise. | ||
Application::hintCommonErrors | private | function | |||
Application::init | private | function | |||
Application::isAutoExitEnabled | public | function | Gets whether to automatically exit after a command execution or not. | ||
Application::isRunningAsRoot | private | function | |||
Application::isSingleCommand | public | function | @internal | ||
Application::register | public | function | Registers a new command. | ||
Application::renderThrowable | public | function | |||
Application::reset | public | function | Overrides ResetInterface::reset | ||
Application::resetComposer | public | function | Removes the cached composer instance | ||
Application::run | public | function | Runs the current application. | Overrides Application::run | |
Application::scheduleAlarm | private | function | |||
Application::setAlarmInterval | public | function | Sets the interval to schedule a SIGALRM signal in seconds. | ||
Application::setAutoExit | public | function | Sets whether to automatically exit after a command execution or not. | ||
Application::setCatchErrors | public | function | Sets whether to catch errors or not during commands execution. | ||
Application::setCatchExceptions | public | function | Sets whether to catch exceptions or not during commands execution. | ||
Application::setCommandLoader | public | function | |||
Application::setDefaultCommand | public | function | Sets the default Command name. | ||
Application::setDefinition | public | function | |||
Application::setDispatcher | public | function | @final | ||
Application::setHelperSet | public | function | |||
Application::setName | public | function | Sets the application name. | ||
Application::setSignalsToDispatchEvent | public | function | |||
Application::setVersion | public | function | Sets the application version. | ||
Application::splitStringByWidth | private | function | |||
Application::__construct | public | function | Overrides Application::__construct | ||
Application::__destruct | public | function |