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

Breadcrumb

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

class SingleCommandApplication

@author Grégoire Pineau <lyrixx@lyrixx.info>

Hierarchy

  • class \Symfony\Component\Console\Command\Command
    • class \Symfony\Component\Console\SingleCommandApplication extends \Symfony\Component\Console\Command\Command

Expanded class hierarchy of SingleCommandApplication

File

vendor/symfony/console/SingleCommandApplication.php, line 21

Namespace

Symfony\Component\Console
View source
class SingleCommandApplication extends Command {
    private string $version = 'UNKNOWN';
    private bool $autoExit = true;
    private bool $running = false;
    
    /**
     * @return $this
     */
    public function setVersion(string $version) : static {
        $this->version = $version;
        return $this;
    }
    
    /**
     * @final
     *
     * @return $this
     */
    public function setAutoExit(bool $autoExit) : static {
        $this->autoExit = $autoExit;
        return $this;
    }
    public function run(?InputInterface $input = null, ?OutputInterface $output = null) : int {
        if ($this->running) {
            return parent::run($input, $output);
        }
        // We use the command name as the application name
        $application = new Application($this->getName() ?: 'UNKNOWN', $this->version);
        $application->setAutoExit($this->autoExit);
        // Fix the usage of the command displayed with "--help"
        $this->setName($_SERVER['argv'][0]);
        $application->add($this);
        $application->setDefaultCommand($this->getName(), true);
        $this->running = true;
        try {
            $ret = $application->run($input, $output);
        } finally {
            $this->running = false;
        }
        return $ret;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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::complete public function Supplies suggestions when resolving possible completion options for input (e.g. option or argument). 5
Command::configure protected function Configures the current command. 50
Command::execute protected function Executes the current command. 51
Command::FAILURE public constant
Command::getAliases public function Returns the aliases for the command.
Command::getApplication public function Gets the application instance for this command. 2
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::initialize protected function Initializes the command after the input has been bound and before the input
is validated.
4
Command::interact protected function Interacts with the user. 5
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::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
SingleCommandApplication::$autoExit private property
SingleCommandApplication::$running private property
SingleCommandApplication::$version private property
SingleCommandApplication::run public function Runs the command. Overrides Command::run
SingleCommandApplication::setAutoExit public function @final
SingleCommandApplication::setVersion public function

API Navigation

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