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

Breadcrumb

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

class ExecCommand

@author Davey Shafik <me@daveyshafik.com>

Hierarchy

  • class \Symfony\Component\Console\Command\Command
    • class \Composer\Command\BaseCommand extends \Symfony\Component\Console\Command\Command
      • class \Composer\Command\ExecCommand extends \Composer\Command\BaseCommand

Expanded class hierarchy of ExecCommand

File

vendor/composer/composer/src/Composer/Command/ExecCommand.php, line 23

Namespace

Composer\Command
View source
class ExecCommand extends BaseCommand {
    
    /**
     * @return void
     */
    protected function configure() {
        $this->setName('exec')
            ->setDescription('Executes a vendored binary/script')
            ->setDefinition([
            new InputOption('list', 'l', InputOption::VALUE_NONE),
            new InputArgument('binary', InputArgument::OPTIONAL, 'The binary to run, e.g. phpunit', null, function () {
                return $this->getBinaries(false);
            }),
            new InputArgument('args', InputArgument::IS_ARRAY | InputArgument::OPTIONAL, 'Arguments to pass to the binary. Use <info>--</info> to separate from composer arguments'),
        ])
            ->setHelp(<<<EOT
Executes a vendored binary/script.

Read more at https://getcomposer.org/doc/03-cli.md#exec
EOT
);
    }
    protected function interact(InputInterface $input, OutputInterface $output) : void {
        $binaries = $this->getBinaries(false);
        if (count($binaries) === 0) {
            return;
        }
        if ($input->getArgument('binary') !== null || $input->getOption('list')) {
            return;
        }
        $io = $this->getIO();
        
        /** @var int $binary */
        $binary = $io->select('Binary to run: ', $binaries, '', 1, 'Invalid binary name "%s"');
        $input->setArgument('binary', $binaries[$binary]);
    }
    protected function execute(InputInterface $input, OutputInterface $output) : int {
        $composer = $this->requireComposer();
        if ($input->getOption('list') || null === $input->getArgument('binary')) {
            $bins = $this->getBinaries(true);
            if ([] === $bins) {
                $binDir = $composer->getConfig()
                    ->get('bin-dir');
                throw new \RuntimeException("No binaries found in composer.json or in bin-dir ({$binDir})");
            }
            $this->getIO()
                ->write(<<<EOT
<comment>Available binaries:</comment>
EOT
);
            foreach ($bins as $bin) {
                $this->getIO()
                    ->write(<<<EOT
<info>- {<span class="php-variable">$bin</span>}</info>
EOT
);
            }
            return 0;
        }
        $binary = $input->getArgument('binary');
        $dispatcher = $composer->getEventDispatcher();
        $dispatcher->addListener('__exec_command', $binary);
        // If the CWD was modified, we restore it to what it was initially, as it was
        // most likely modified by the global command, and we want exec to run in the local working directory
        // not the global one
        if (getcwd() !== $this->getApplication()
            ->getInitialWorkingDirectory() && $this->getApplication()
            ->getInitialWorkingDirectory() !== false) {
            try {
                chdir($this->getApplication()
                    ->getInitialWorkingDirectory());
            } catch (\Exception $e) {
                throw new \RuntimeException('Could not switch back to working directory "' . $this->getApplication()
                    ->getInitialWorkingDirectory() . '"', 0, $e);
            }
        }
        return $dispatcher->dispatchScript('__exec_command', true, $input->getArgument('args'));
    }
    
    /**
     * @return list<string>
     */
    private function getBinaries(bool $forDisplay) : array {
        $composer = $this->requireComposer();
        $binDir = $composer->getConfig()
            ->get('bin-dir');
        $bins = glob($binDir . '/*');
        $localBins = $composer->getPackage()
            ->getBinaries();
        if ($forDisplay) {
            $localBins = array_map(static function ($e) {
                return "{$e} (local)";
            }, $localBins);
        }
        $binaries = [];
        foreach (array_merge($bins, $localBins) as $bin) {
            // skip .bat copies
            if (isset($previousBin) && $bin === $previousBin . '.bat') {
                continue;
            }
            $previousBin = $bin;
            $binaries[] = basename($bin);
        }
        return $binaries;
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
BaseCommand::$composer private property
BaseCommand::$io private property
BaseCommand::complete public function @inheritdoc Overrides Command::complete 1
BaseCommand::createComposerInstance protected function Calls {
BaseCommand::formatRequirements protected function
BaseCommand::getApplication public function Gets the application instance for this command. Overrides Command::getApplication
BaseCommand::getAuditFormat protected function @internal
BaseCommand::getComposer Deprecated public function
BaseCommand::getIO public function
BaseCommand::getPlatformRequirementFilter protected function
BaseCommand::getPreferredInstallOptions protected function Returns preferSource and preferDist values based on the configuration.
BaseCommand::getTerminalWidth protected function
BaseCommand::initialize protected function @inheritDoc Overrides Command::initialize 1
BaseCommand::isProxyCommand public function Whether or not this command is meant to call another command. 2
BaseCommand::normalizeRequirements protected function
BaseCommand::renderTable protected function
BaseCommand::requireComposer public function Retrieves the default Composer\Composer instance or throws
BaseCommand::resetComposer public function Removes the cached composer instance
BaseCommand::setComposer public function
BaseCommand::setIO public function
BaseCommand::tryComposer public function Retrieves the default Composer\Composer instance or null
Command::$aliases private property 1
Command::$application private property
Command::$code private property
Command::$definition private property
Command::$description private property 1
Command::$fullDefinition private property
Command::$help private property
Command::$helperSet private property
Command::$hidden private property
Command::$ignoreValidationErrors private property 2
Command::$name private property
Command::$processTitle private property
Command::$synopsis private property
Command::$usages private property
Command::addArgument public function Adds an argument. 2
Command::addOption public function Adds an option. 2
Command::addUsage public function Add a command usage example, it&#039;ll be prefixed with the command name. 2
Command::FAILURE public constant
Command::getAliases public function Returns the aliases for the command.
Command::getDefaultDescription public static function
Command::getDefaultName public static function
Command::getDefinition public function Gets the InputDefinition attached to this Command. 2
Command::getDescription public function Returns the description for the command.
Command::getHelp public function Returns the help for the command. 2
Command::getHelper public function Gets a helper instance by name. 2
Command::getHelperSet public function Gets the helper set. 1
Command::getName public function Returns the command name.
Command::getNativeDefinition public function Gets the InputDefinition to be used to create representations of this Command. 2
Command::getProcessedHelp public function Returns the processed help for the command replacing the %command.name% and
%command.full_name% patterns with the real values dynamically.
2
Command::getSynopsis public function Returns the synopsis for the command. 2
Command::getUsages public function Returns alternative usages of the command. 2
Command::ignoreValidationErrors public function Ignores validation errors. 2
Command::INVALID public constant
Command::isEnabled public function Checks whether the command is enabled or not in the current environment. 2
Command::isHidden public function
Command::mergeApplicationDefinition public function Merges the application definition with the command definition. 2
Command::run public function Runs the command. 4
Command::setAliases public function Sets the aliases for the command.
Command::setApplication public function 2
Command::setCode public function Sets the code to execute when running this command. 2
Command::setDefinition public function Sets an array of argument and option instances. 2
Command::setDescription public function Sets the description for the command.
Command::setHelp public function Sets the help for the command. 2
Command::setHelperSet public function 2
Command::setHidden public function
Command::setName public function Sets the name of the command.
Command::setProcessTitle public function Sets the process title of the command. 2
Command::SUCCESS public constant
Command::validateName private function Validates a command name.
Command::__construct public function 15
ExecCommand::configure protected function Overrides Command::configure
ExecCommand::execute protected function Executes the current command. Overrides Command::execute
ExecCommand::getBinaries private function
ExecCommand::interact protected function Interacts with the user. Overrides Command::interact

API Navigation

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