class Application in Zircon Profile 8
Same name and namespace in other branches
- 8.0 vendor/symfony/console/Application.php \Symfony\Component\Console\Application
An Application is the container for a collection of commands.
It is the main entry point of a Console application.
This class is optimized for a standard CLI environment.
Usage:
$app = new Application('myapp', '1.0 (stable)'); $app->add(new SimpleCommand()); $app->run();
@author Fabien Potencier <fabien@symfony.com>
Hierarchy
- class \Symfony\Component\Console\Application
Expanded class hierarchy of Application
22 files declare their use of Application
- AbstractDescriptorTest.php in vendor/
symfony/ console/ Tests/ Descriptor/ AbstractDescriptorTest.php - ApplicationDescription.php in vendor/
symfony/ console/ Descriptor/ ApplicationDescription.php - ApplicationTest.php in vendor/
symfony/ console/ Tests/ ApplicationTest.php - ApplicationTester.php in vendor/
symfony/ console/ Tester/ ApplicationTester.php - ApplicationTesterTest.php in vendor/
symfony/ console/ Tests/ Tester/ ApplicationTesterTest.php
File
- vendor/
symfony/ console/ Application.php, line 58
Namespace
Symfony\Component\ConsoleView source
class Application {
private $commands = array();
private $wantHelps = false;
private $runningCommand;
private $name;
private $version;
private $catchExceptions = true;
private $autoExit = true;
private $definition;
private $helperSet;
private $dispatcher;
private $terminalDimensions;
private $defaultCommand;
/**
* Constructor.
*
* @param string $name The name of the application
* @param string $version The version of the application
*/
public function __construct($name = 'UNKNOWN', $version = 'UNKNOWN') {
$this->name = $name;
$this->version = $version;
$this->defaultCommand = 'list';
$this->helperSet = $this
->getDefaultHelperSet();
$this->definition = $this
->getDefaultInputDefinition();
foreach ($this
->getDefaultCommands() as $command) {
$this
->add($command);
}
}
public function setDispatcher(EventDispatcherInterface $dispatcher) {
$this->dispatcher = $dispatcher;
}
/**
* Runs the current application.
*
* @param InputInterface $input An Input instance
* @param OutputInterface $output An Output instance
*
* @return int 0 if everything went fine, or an error code
*
* @throws \Exception When doRun returns Exception
*/
public function run(InputInterface $input = null, OutputInterface $output = null) {
if (null === $input) {
$input = new ArgvInput();
}
if (null === $output) {
$output = new ConsoleOutput();
}
$this
->configureIO($input, $output);
try {
$exitCode = $this
->doRun($input, $output);
} catch (\Exception $e) {
if (!$this->catchExceptions) {
throw $e;
}
if ($output instanceof ConsoleOutputInterface) {
$this
->renderException($e, $output
->getErrorOutput());
}
else {
$this
->renderException($e, $output);
}
$exitCode = $e
->getCode();
if (is_numeric($exitCode)) {
$exitCode = (int) $exitCode;
if (0 === $exitCode) {
$exitCode = 1;
}
}
else {
$exitCode = 1;
}
}
if ($this->autoExit) {
if ($exitCode > 255) {
$exitCode = 255;
}
exit($exitCode);
}
return $exitCode;
}
/**
* Runs the current application.
*
* @param InputInterface $input An Input instance
* @param OutputInterface $output An Output instance
*
* @return int 0 if everything went fine, or an error code
*/
public function doRun(InputInterface $input, OutputInterface $output) {
if (true === $input
->hasParameterOption(array(
'--version',
'-V',
))) {
$output
->writeln($this
->getLongVersion());
return 0;
}
$name = $this
->getCommandName($input);
if (true === $input
->hasParameterOption(array(
'--help',
'-h',
))) {
if (!$name) {
$name = 'help';
$input = new ArrayInput(array(
'command' => 'help',
));
}
else {
$this->wantHelps = true;
}
}
if (!$name) {
$name = $this->defaultCommand;
$input = new ArrayInput(array(
'command' => $this->defaultCommand,
));
}
// the command name MUST be the first element of the input
$command = $this
->find($name);
$this->runningCommand = $command;
$exitCode = $this
->doRunCommand($command, $input, $output);
$this->runningCommand = null;
return $exitCode;
}
/**
* Set a helper set to be used with the command.
*
* @param HelperSet $helperSet The helper set
*/
public function setHelperSet(HelperSet $helperSet) {
$this->helperSet = $helperSet;
}
/**
* Get the helper set associated with the command.
*
* @return HelperSet The HelperSet instance associated with this command
*/
public function getHelperSet() {
return $this->helperSet;
}
/**
* Set an input definition set to be used with this application.
*
* @param InputDefinition $definition The input definition
*/
public function setDefinition(InputDefinition $definition) {
$this->definition = $definition;
}
/**
* Gets the InputDefinition related to this Application.
*
* @return InputDefinition The InputDefinition instance
*/
public function getDefinition() {
return $this->definition;
}
/**
* Gets the help message.
*
* @return string A help message.
*/
public function getHelp() {
return $this
->getLongVersion();
}
/**
* Sets whether to catch exceptions or not during commands execution.
*
* @param bool $boolean Whether to catch exceptions or not during commands execution
*/
public function setCatchExceptions($boolean) {
$this->catchExceptions = (bool) $boolean;
}
/**
* Sets whether to automatically exit after a command execution or not.
*
* @param bool $boolean Whether to automatically exit after a command execution or not
*/
public function setAutoExit($boolean) {
$this->autoExit = (bool) $boolean;
}
/**
* Gets the name of the application.
*
* @return string The application name
*/
public function getName() {
return $this->name;
}
/**
* Sets the application name.
*
* @param string $name The application name
*/
public function setName($name) {
$this->name = $name;
}
/**
* Gets the application version.
*
* @return string The application version
*/
public function getVersion() {
return $this->version;
}
/**
* Sets the application version.
*
* @param string $version The application version
*/
public function setVersion($version) {
$this->version = $version;
}
/**
* Returns the long version of the application.
*
* @return string The long application version
*/
public function getLongVersion() {
if ('UNKNOWN' !== $this
->getName() && 'UNKNOWN' !== $this
->getVersion()) {
return sprintf('<info>%s</info> version <comment>%s</comment>', $this
->getName(), $this
->getVersion());
}
return '<info>Console Tool</info>';
}
/**
* Registers a new command.
*
* @param string $name The command name
*
* @return Command The newly created command
*/
public function register($name) {
return $this
->add(new Command($name));
}
/**
* Adds an array of command objects.
*
* @param Command[] $commands An array of commands
*/
public function addCommands(array $commands) {
foreach ($commands as $command) {
$this
->add($command);
}
}
/**
* Adds a command object.
*
* If a command with the same name already exists, it will be overridden.
*
* @param Command $command A Command object
*
* @return Command The registered command
*/
public function add(Command $command) {
$command
->setApplication($this);
if (!$command
->isEnabled()) {
$command
->setApplication(null);
return;
}
if (null === $command
->getDefinition()) {
throw new \LogicException(sprintf('Command class "%s" is not correctly initialized. You probably forgot to call the parent constructor.', get_class($command)));
}
$this->commands[$command
->getName()] = $command;
foreach ($command
->getAliases() as $alias) {
$this->commands[$alias] = $command;
}
return $command;
}
/**
* Returns a registered command by name or alias.
*
* @param string $name The command name or alias
*
* @return Command A Command object
*
* @throws \InvalidArgumentException When command name given does not exist
*/
public function get($name) {
if (!isset($this->commands[$name])) {
throw new \InvalidArgumentException(sprintf('The command "%s" does not exist.', $name));
}
$command = $this->commands[$name];
if ($this->wantHelps) {
$this->wantHelps = false;
$helpCommand = $this
->get('help');
$helpCommand
->setCommand($command);
return $helpCommand;
}
return $command;
}
/**
* Returns true if the command exists, false otherwise.
*
* @param string $name The command name or alias
*
* @return bool true if the command exists, false otherwise
*/
public function has($name) {
return isset($this->commands[$name]);
}
/**
* Returns an array of all unique namespaces used by currently registered commands.
*
* It does not returns the global namespace which always exists.
*
* @return array An array of namespaces
*/
public function getNamespaces() {
$namespaces = array();
foreach ($this->commands as $command) {
$namespaces = array_merge($namespaces, $this
->extractAllNamespaces($command
->getName()));
foreach ($command
->getAliases() as $alias) {
$namespaces = array_merge($namespaces, $this
->extractAllNamespaces($alias));
}
}
return array_values(array_unique(array_filter($namespaces)));
}
/**
* Finds a registered namespace by a name or an abbreviation.
*
* @param string $namespace A namespace or abbreviation to search for
*
* @return string A registered namespace
*
* @throws \InvalidArgumentException When namespace is incorrect or ambiguous
*/
public function findNamespace($namespace) {
$allNamespaces = $this
->getNamespaces();
$expr = preg_replace_callback('{([^:]+|)}', function ($matches) {
return preg_quote($matches[1]) . '[^:]*';
}, $namespace);
$namespaces = preg_grep('{^' . $expr . '}', $allNamespaces);
if (empty($namespaces)) {
$message = sprintf('There are no commands defined in the "%s" namespace.', $namespace);
if ($alternatives = $this
->findAlternatives($namespace, $allNamespaces)) {
if (1 == count($alternatives)) {
$message .= "\n\nDid you mean this?\n ";
}
else {
$message .= "\n\nDid you mean one of these?\n ";
}
$message .= implode("\n ", $alternatives);
}
throw new \InvalidArgumentException($message);
}
$exact = in_array($namespace, $namespaces, true);
if (count($namespaces) > 1 && !$exact) {
throw new \InvalidArgumentException(sprintf('The namespace "%s" is ambiguous (%s).', $namespace, $this
->getAbbreviationSuggestions(array_values($namespaces))));
}
return $exact ? $namespace : reset($namespaces);
}
/**
* Finds a command by name or alias.
*
* Contrary to get, this command tries to find the best
* match if you give it an abbreviation of a name or alias.
*
* @param string $name A command name or a command alias
*
* @return Command A Command instance
*
* @throws \InvalidArgumentException When command name is incorrect or ambiguous
*/
public function find($name) {
$allCommands = array_keys($this->commands);
$expr = preg_replace_callback('{([^:]+|)}', function ($matches) {
return preg_quote($matches[1]) . '[^:]*';
}, $name);
$commands = preg_grep('{^' . $expr . '}', $allCommands);
if (empty($commands) || count(preg_grep('{^' . $expr . '$}', $commands)) < 1) {
if (false !== ($pos = strrpos($name, ':'))) {
// check if a namespace exists and contains commands
$this
->findNamespace(substr($name, 0, $pos));
}
$message = sprintf('Command "%s" is not defined.', $name);
if ($alternatives = $this
->findAlternatives($name, $allCommands)) {
if (1 == count($alternatives)) {
$message .= "\n\nDid you mean this?\n ";
}
else {
$message .= "\n\nDid you mean one of these?\n ";
}
$message .= implode("\n ", $alternatives);
}
throw new \InvalidArgumentException($message);
}
// filter out aliases for commands which are already on the list
if (count($commands) > 1) {
$commandList = $this->commands;
$commands = array_filter($commands, function ($nameOrAlias) use ($commandList, $commands) {
$commandName = $commandList[$nameOrAlias]
->getName();
return $commandName === $nameOrAlias || !in_array($commandName, $commands);
});
}
$exact = in_array($name, $commands, true);
if (count($commands) > 1 && !$exact) {
$suggestions = $this
->getAbbreviationSuggestions(array_values($commands));
throw new \InvalidArgumentException(sprintf('Command "%s" is ambiguous (%s).', $name, $suggestions));
}
return $this
->get($exact ? $name : reset($commands));
}
/**
* Gets the commands (registered in the given namespace if provided).
*
* The array keys are the full names and the values the command instances.
*
* @param string $namespace A namespace name
*
* @return Command[] An array of Command instances
*/
public function all($namespace = null) {
if (null === $namespace) {
return $this->commands;
}
$commands = array();
foreach ($this->commands as $name => $command) {
if ($namespace === $this
->extractNamespace($name, substr_count($namespace, ':') + 1)) {
$commands[$name] = $command;
}
}
return $commands;
}
/**
* Returns an array of possible abbreviations given a set of names.
*
* @param array $names An array of names
*
* @return array An array of abbreviations
*/
public static function getAbbreviations($names) {
$abbrevs = array();
foreach ($names as $name) {
for ($len = strlen($name); $len > 0; --$len) {
$abbrev = substr($name, 0, $len);
$abbrevs[$abbrev][] = $name;
}
}
return $abbrevs;
}
/**
* Returns a text representation of the Application.
*
* @param string $namespace An optional namespace name
* @param bool $raw Whether to return raw command list
*
* @return string A string representing the Application
*
* @deprecated since version 2.3, to be removed in 3.0.
*/
public function asText($namespace = null, $raw = false) {
@trigger_error('The ' . __METHOD__ . ' method is deprecated since version 2.3 and will be removed in 3.0.', E_USER_DEPRECATED);
$descriptor = new TextDescriptor();
$output = new BufferedOutput(BufferedOutput::VERBOSITY_NORMAL, !$raw);
$descriptor
->describe($output, $this, array(
'namespace' => $namespace,
'raw_output' => true,
));
return $output
->fetch();
}
/**
* Returns an XML representation of the Application.
*
* @param string $namespace An optional namespace name
* @param bool $asDom Whether to return a DOM or an XML string
*
* @return string|\DOMDocument An XML string representing the Application
*
* @deprecated since version 2.3, to be removed in 3.0.
*/
public function asXml($namespace = null, $asDom = false) {
@trigger_error('The ' . __METHOD__ . ' method is deprecated since version 2.3 and will be removed in 3.0.', E_USER_DEPRECATED);
$descriptor = new XmlDescriptor();
if ($asDom) {
return $descriptor
->getApplicationDocument($this, $namespace);
}
$output = new BufferedOutput();
$descriptor
->describe($output, $this, array(
'namespace' => $namespace,
));
return $output
->fetch();
}
/**
* Renders a caught exception.
*
* @param \Exception $e An exception instance
* @param OutputInterface $output An OutputInterface instance
*/
public function renderException($e, $output) {
do {
$title = sprintf(' [%s] ', get_class($e));
$len = $this
->stringWidth($title);
$width = $this
->getTerminalWidth() ? $this
->getTerminalWidth() - 1 : PHP_INT_MAX;
// HHVM only accepts 32 bits integer in str_split, even when PHP_INT_MAX is a 64 bit integer: https://github.com/facebook/hhvm/issues/1327
if (defined('HHVM_VERSION') && $width > 1 << 31) {
$width = 1 << 31;
}
$formatter = $output
->getFormatter();
$lines = array();
foreach (preg_split('/\\r?\\n/', $e
->getMessage()) as $line) {
foreach ($this
->splitStringByWidth($line, $width - 4) as $line) {
// pre-format lines to get the right string length
$lineLength = $this
->stringWidth(preg_replace('/\\[[^m]*m/', '', $formatter
->format($line))) + 4;
$lines[] = array(
$line,
$lineLength,
);
$len = max($lineLength, $len);
}
}
$messages = array(
'',
'',
);
$messages[] = $emptyLine = $formatter
->format(sprintf('<error>%s</error>', str_repeat(' ', $len)));
$messages[] = $formatter
->format(sprintf('<error>%s%s</error>', $title, str_repeat(' ', max(0, $len - $this
->stringWidth($title)))));
foreach ($lines as $line) {
$messages[] = $formatter
->format(sprintf('<error> %s %s</error>', $line[0], str_repeat(' ', $len - $line[1])));
}
$messages[] = $emptyLine;
$messages[] = '';
$messages[] = '';
$output
->writeln($messages, OutputInterface::OUTPUT_RAW);
if (OutputInterface::VERBOSITY_VERBOSE <= $output
->getVerbosity()) {
$output
->writeln('<comment>Exception trace:</comment>');
// exception related properties
$trace = $e
->getTrace();
array_unshift($trace, array(
'function' => '',
'file' => $e
->getFile() !== null ? $e
->getFile() : 'n/a',
'line' => $e
->getLine() !== null ? $e
->getLine() : 'n/a',
'args' => array(),
));
for ($i = 0, $count = count($trace); $i < $count; ++$i) {
$class = isset($trace[$i]['class']) ? $trace[$i]['class'] : '';
$type = isset($trace[$i]['type']) ? $trace[$i]['type'] : '';
$function = $trace[$i]['function'];
$file = isset($trace[$i]['file']) ? $trace[$i]['file'] : 'n/a';
$line = isset($trace[$i]['line']) ? $trace[$i]['line'] : 'n/a';
$output
->writeln(sprintf(' %s%s%s() at <info>%s:%s</info>', $class, $type, $function, $file, $line));
}
$output
->writeln('');
$output
->writeln('');
}
} while ($e = $e
->getPrevious());
if (null !== $this->runningCommand) {
$output
->writeln(sprintf('<info>%s</info>', sprintf($this->runningCommand
->getSynopsis(), $this
->getName())));
$output
->writeln('');
$output
->writeln('');
}
}
/**
* Tries to figure out the terminal width in which this application runs.
*
* @return int|null
*/
protected function getTerminalWidth() {
$dimensions = $this
->getTerminalDimensions();
return $dimensions[0];
}
/**
* Tries to figure out the terminal height in which this application runs.
*
* @return int|null
*/
protected function getTerminalHeight() {
$dimensions = $this
->getTerminalDimensions();
return $dimensions[1];
}
/**
* Tries to figure out the terminal dimensions based on the current environment.
*
* @return array Array containing width and height
*/
public function getTerminalDimensions() {
if ($this->terminalDimensions) {
return $this->terminalDimensions;
}
if ('\\' === DIRECTORY_SEPARATOR) {
// extract [w, H] from "wxh (WxH)"
if (preg_match('/^(\\d+)x\\d+ \\(\\d+x(\\d+)\\)$/', trim(getenv('ANSICON')), $matches)) {
return array(
(int) $matches[1],
(int) $matches[2],
);
}
// extract [w, h] from "wxh"
if (preg_match('/^(\\d+)x(\\d+)$/', $this
->getConsoleMode(), $matches)) {
return array(
(int) $matches[1],
(int) $matches[2],
);
}
}
if ($sttyString = $this
->getSttyColumns()) {
// extract [w, h] from "rows h; columns w;"
if (preg_match('/rows.(\\d+);.columns.(\\d+);/i', $sttyString, $matches)) {
return array(
(int) $matches[2],
(int) $matches[1],
);
}
// extract [w, h] from "; h rows; w columns"
if (preg_match('/;.(\\d+).rows;.(\\d+).columns/i', $sttyString, $matches)) {
return array(
(int) $matches[2],
(int) $matches[1],
);
}
}
return array(
null,
null,
);
}
/**
* Sets terminal dimensions.
*
* Can be useful to force terminal dimensions for functional tests.
*
* @param int $width The width
* @param int $height The height
*
* @return Application The current application
*/
public function setTerminalDimensions($width, $height) {
$this->terminalDimensions = array(
$width,
$height,
);
return $this;
}
/**
* Configures the input and output instances based on the user arguments and options.
*
* @param InputInterface $input An InputInterface instance
* @param OutputInterface $output An OutputInterface instance
*/
protected function configureIO(InputInterface $input, OutputInterface $output) {
if (true === $input
->hasParameterOption(array(
'--ansi',
))) {
$output
->setDecorated(true);
}
elseif (true === $input
->hasParameterOption(array(
'--no-ansi',
))) {
$output
->setDecorated(false);
}
if (true === $input
->hasParameterOption(array(
'--no-interaction',
'-n',
))) {
$input
->setInteractive(false);
}
elseif (function_exists('posix_isatty') && $this
->getHelperSet()
->has('question')) {
$inputStream = $this
->getHelperSet()
->get('question')
->getInputStream();
if (!@posix_isatty($inputStream) && false === getenv('SHELL_INTERACTIVE')) {
$input
->setInteractive(false);
}
}
if (true === $input
->hasParameterOption(array(
'--quiet',
'-q',
))) {
$output
->setVerbosity(OutputInterface::VERBOSITY_QUIET);
}
else {
if ($input
->hasParameterOption('-vvv') || $input
->hasParameterOption('--verbose=3') || $input
->getParameterOption('--verbose') === 3) {
$output
->setVerbosity(OutputInterface::VERBOSITY_DEBUG);
}
elseif ($input
->hasParameterOption('-vv') || $input
->hasParameterOption('--verbose=2') || $input
->getParameterOption('--verbose') === 2) {
$output
->setVerbosity(OutputInterface::VERBOSITY_VERY_VERBOSE);
}
elseif ($input
->hasParameterOption('-v') || $input
->hasParameterOption('--verbose=1') || $input
->hasParameterOption('--verbose') || $input
->getParameterOption('--verbose')) {
$output
->setVerbosity(OutputInterface::VERBOSITY_VERBOSE);
}
}
}
/**
* Runs the current command.
*
* If an event dispatcher has been attached to the application,
* events are also dispatched during the life-cycle of the command.
*
* @param Command $command A Command instance
* @param InputInterface $input An Input instance
* @param OutputInterface $output An Output instance
*
* @return int 0 if everything went fine, or an error code
*
* @throws \Exception when the command being run threw an exception
*/
protected function doRunCommand(Command $command, InputInterface $input, OutputInterface $output) {
foreach ($command
->getHelperSet() as $helper) {
if ($helper instanceof InputAwareInterface) {
$helper
->setInput($input);
}
}
if (null === $this->dispatcher) {
return $command
->run($input, $output);
}
$event = new ConsoleCommandEvent($command, $input, $output);
$this->dispatcher
->dispatch(ConsoleEvents::COMMAND, $event);
if ($event
->commandShouldRun()) {
try {
$exitCode = $command
->run($input, $output);
} catch (\Exception $e) {
$event = new ConsoleExceptionEvent($command, $input, $output, $e, $e
->getCode());
$this->dispatcher
->dispatch(ConsoleEvents::EXCEPTION, $event);
$e = $event
->getException();
$event = new ConsoleTerminateEvent($command, $input, $output, $e
->getCode());
$this->dispatcher
->dispatch(ConsoleEvents::TERMINATE, $event);
throw $e;
}
}
else {
$exitCode = ConsoleCommandEvent::RETURN_CODE_DISABLED;
}
$event = new ConsoleTerminateEvent($command, $input, $output, $exitCode);
$this->dispatcher
->dispatch(ConsoleEvents::TERMINATE, $event);
return $event
->getExitCode();
}
/**
* Gets the name of the command based on input.
*
* @param InputInterface $input The input interface
*
* @return string The command name
*/
protected function getCommandName(InputInterface $input) {
return $input
->getFirstArgument();
}
/**
* Gets the default input definition.
*
* @return InputDefinition An InputDefinition instance
*/
protected function getDefaultInputDefinition() {
return new InputDefinition(array(
new InputArgument('command', InputArgument::REQUIRED, 'The command to execute'),
new InputOption('--help', '-h', InputOption::VALUE_NONE, 'Display this help message'),
new InputOption('--quiet', '-q', InputOption::VALUE_NONE, 'Do not output any message'),
new InputOption('--verbose', '-v|vv|vvv', InputOption::VALUE_NONE, 'Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug'),
new InputOption('--version', '-V', InputOption::VALUE_NONE, 'Display this application version'),
new InputOption('--ansi', '', InputOption::VALUE_NONE, 'Force ANSI output'),
new InputOption('--no-ansi', '', InputOption::VALUE_NONE, 'Disable ANSI output'),
new InputOption('--no-interaction', '-n', InputOption::VALUE_NONE, 'Do not ask any interactive question'),
));
}
/**
* Gets the default commands that should always be available.
*
* @return Command[] An array of default Command instances
*/
protected function getDefaultCommands() {
return array(
new HelpCommand(),
new ListCommand(),
);
}
/**
* Gets the default helper set with the helpers that should always be available.
*
* @return HelperSet A HelperSet instance
*/
protected function getDefaultHelperSet() {
return new HelperSet(array(
new FormatterHelper(),
new DialogHelper(false),
new ProgressHelper(false),
new TableHelper(false),
new DebugFormatterHelper(),
new ProcessHelper(),
new QuestionHelper(),
));
}
/**
* Runs and parses stty -a if it's available, suppressing any error output.
*
* @return string
*/
private function getSttyColumns() {
if (!function_exists('proc_open')) {
return;
}
$descriptorspec = array(
1 => array(
'pipe',
'w',
),
2 => array(
'pipe',
'w',
),
);
$process = proc_open('stty -a | grep columns', $descriptorspec, $pipes, null, null, array(
'suppress_errors' => true,
));
if (is_resource($process)) {
$info = stream_get_contents($pipes[1]);
fclose($pipes[1]);
fclose($pipes[2]);
proc_close($process);
return $info;
}
}
/**
* Runs and parses mode CON if it's available, suppressing any error output.
*
* @return string <width>x<height> or null if it could not be parsed
*/
private function getConsoleMode() {
if (!function_exists('proc_open')) {
return;
}
$descriptorspec = array(
1 => array(
'pipe',
'w',
),
2 => array(
'pipe',
'w',
),
);
$process = proc_open('mode CON', $descriptorspec, $pipes, null, null, array(
'suppress_errors' => true,
));
if (is_resource($process)) {
$info = stream_get_contents($pipes[1]);
fclose($pipes[1]);
fclose($pipes[2]);
proc_close($process);
if (preg_match('/--------+\\r?\\n.+?(\\d+)\\r?\\n.+?(\\d+)\\r?\\n/', $info, $matches)) {
return $matches[2] . 'x' . $matches[1];
}
}
}
/**
* Returns abbreviated suggestions in string format.
*
* @param array $abbrevs Abbreviated suggestions to convert
*
* @return string A formatted string of abbreviated suggestions
*/
private function getAbbreviationSuggestions($abbrevs) {
return sprintf('%s, %s%s', $abbrevs[0], $abbrevs[1], count($abbrevs) > 2 ? sprintf(' and %d more', count($abbrevs) - 2) : '');
}
/**
* Returns the namespace part of the command name.
*
* This method is not part of public API and should not be used directly.
*
* @param string $name The full name of the command
* @param string $limit The maximum number of parts of the namespace
*
* @return string The namespace of the command
*/
public function extractNamespace($name, $limit = null) {
$parts = explode(':', $name);
array_pop($parts);
return implode(':', null === $limit ? $parts : array_slice($parts, 0, $limit));
}
/**
* Finds alternative of $name among $collection,
* if nothing is found in $collection, try in $abbrevs.
*
* @param string $name The string
* @param array|\Traversable $collection The collection
*
* @return array A sorted array of similar string
*/
private function findAlternatives($name, $collection) {
$threshold = 1000.0;
$alternatives = array();
$collectionParts = array();
foreach ($collection as $item) {
$collectionParts[$item] = explode(':', $item);
}
foreach (explode(':', $name) as $i => $subname) {
foreach ($collectionParts as $collectionName => $parts) {
$exists = isset($alternatives[$collectionName]);
if (!isset($parts[$i]) && $exists) {
$alternatives[$collectionName] += $threshold;
continue;
}
elseif (!isset($parts[$i])) {
continue;
}
$lev = levenshtein($subname, $parts[$i]);
if ($lev <= strlen($subname) / 3 || '' !== $subname && false !== strpos($parts[$i], $subname)) {
$alternatives[$collectionName] = $exists ? $alternatives[$collectionName] + $lev : $lev;
}
elseif ($exists) {
$alternatives[$collectionName] += $threshold;
}
}
}
foreach ($collection as $item) {
$lev = levenshtein($name, $item);
if ($lev <= strlen($name) / 3 || false !== strpos($item, $name)) {
$alternatives[$item] = isset($alternatives[$item]) ? $alternatives[$item] - $lev : $lev;
}
}
$alternatives = array_filter($alternatives, function ($lev) use ($threshold) {
return $lev < 2 * $threshold;
});
asort($alternatives);
return array_keys($alternatives);
}
/**
* Sets the default Command name.
*
* @param string $commandName The Command name
*/
public function setDefaultCommand($commandName) {
$this->defaultCommand = $commandName;
}
private function stringWidth($string) {
if (!function_exists('mb_strwidth')) {
return strlen($string);
}
if (false === ($encoding = mb_detect_encoding($string))) {
return strlen($string);
}
return mb_strwidth($string, $encoding);
}
private function splitStringByWidth($string, $width) {
// str_split is not suitable for multi-byte characters, we should use preg_split to get char array properly.
// additionally, array_slice() is not enough as some character has doubled width.
// we need a function to split string not by character count but by string width
if (!function_exists('mb_strwidth')) {
return str_split($string, $width);
}
if (false === ($encoding = mb_detect_encoding($string))) {
return str_split($string, $width);
}
$utf8String = mb_convert_encoding($string, 'utf8', $encoding);
$lines = array();
$line = '';
foreach (preg_split('//u', $utf8String) as $char) {
// test if $char could be appended to current line
if (mb_strwidth($line . $char, 'utf8') <= $width) {
$line .= $char;
continue;
}
// if not, push current line to array and make new line
$lines[] = str_pad($line, $width);
$line = $char;
}
if ('' !== $line) {
$lines[] = count($lines) ? str_pad($line, $width) : $line;
}
mb_convert_variables($encoding, 'utf8', $lines);
return $lines;
}
/**
* Returns all namespaces of the command name.
*
* @param string $name The full name of the command
*
* @return array The namespaces of the command
*/
private function extractAllNamespaces($name) {
// -1 as third argument is needed to skip the command short name when exploding
$parts = explode(':', $name, -1);
$namespaces = array();
foreach ($parts as $part) {
if (count($namespaces)) {
$namespaces[] = end($namespaces) . ':' . $part;
}
else {
$namespaces[] = $part;
}
}
return $namespaces;
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
Application:: |
private | property | ||
|
Application:: |
private | property | ||
|
Application:: |
private | property | ||
|
Application:: |
private | property | ||
|
Application:: |
private | property | ||
|
Application:: |
private | property | ||
|
Application:: |
private | property | ||
|
Application:: |
private | property | ||
|
Application:: |
private | property | ||
|
Application:: |
private | property | ||
|
Application:: |
private | property | ||
|
Application:: |
private | property | ||
|
Application:: |
public | function | Adds a command object. | |
|
Application:: |
public | function | Adds an array of command objects. | |
|
Application:: |
public | function | Gets the commands (registered in the given namespace if provided). | |
|
Application:: |
public | function | Returns a text representation of the Application. | |
|
Application:: |
public | function | Returns an XML representation of the Application. | |
|
Application:: |
protected | function | Configures the input and output instances based on the user arguments and options. | |
|
Application:: |
public | function | Runs the current application. | |
|
Application:: |
protected | function | Runs the current command. | |
|
Application:: |
private | function | Returns all namespaces of the command name. | |
|
Application:: |
public | function | Returns the namespace part of the command name. | |
|
Application:: |
public | function | Finds a command by name or alias. | |
|
Application:: |
private | function | Finds alternative of $name among $collection, if nothing is found in $collection, try in $abbrevs. | |
|
Application:: |
public | function | Finds a registered namespace by a name or an abbreviation. | |
|
Application:: |
public | function | Returns a registered command by name or alias. | |
|
Application:: |
public static | function | Returns an array of possible abbreviations given a set of names. | |
|
Application:: |
private | function | Returns abbreviated suggestions in string format. | |
|
Application:: |
protected | function | Gets the name of the command based on input. | 2 |
|
Application:: |
private | function | Runs and parses mode CON if it's available, suppressing any error output. | |
|
Application:: |
protected | function | Gets the default commands that should always be available. | 3 |
|
Application:: |
protected | function | Gets the default helper set with the helpers that should always be available. | 1 |
|
Application:: |
protected | function | Gets the default input definition. | 1 |
|
Application:: |
public | function | Gets the InputDefinition related to this Application. | 2 |
|
Application:: |
public | function | Gets the help message. | |
|
Application:: |
public | function | Get the helper set associated with the command. | |
|
Application:: |
public | function | Returns the long version of the application. | |
|
Application:: |
public | function | Gets the name of the application. | |
|
Application:: |
public | function | Returns an array of all unique namespaces used by currently registered commands. | |
|
Application:: |
private | function | Runs and parses stty -a if it's available, suppressing any error output. | |
|
Application:: |
public | function | Tries to figure out the terminal dimensions based on the current environment. | |
|
Application:: |
protected | function | Tries to figure out the terminal height in which this application runs. | |
|
Application:: |
protected | function | Tries to figure out the terminal width in which this application runs. | |
|
Application:: |
public | function | Gets the application version. | |
|
Application:: |
public | function | Returns true if the command exists, false otherwise. | |
|
Application:: |
public | function | Registers a new command. | |
|
Application:: |
public | function | Renders a caught exception. | |
|
Application:: |
public | function | Runs the current application. | |
|
Application:: |
public | function | Sets whether to automatically exit after a command execution or not. | |
|
Application:: |
public | function | Sets whether to catch exceptions or not during commands execution. | |
|
Application:: |
public | function | Sets the default Command name. | |
|
Application:: |
public | function | Set an input definition set to be used with this application. | |
|
Application:: |
public | function | ||
|
Application:: |
public | function | Set a helper set to be used with the command. | |
|
Application:: |
public | function | Sets the application name. | |
|
Application:: |
public | function | Sets terminal dimensions. | |
|
Application:: |
public | function | Sets the application version. | |
|
Application:: |
private | function | ||
|
Application:: |
private | function | ||
|
Application:: |
public | function | Constructor. | 4 |