primo commit
This commit is contained in:
1282
libraries/vendor/joomla/console/src/Application.php
vendored
Normal file
1282
libraries/vendor/joomla/console/src/Application.php
vendored
Normal file
File diff suppressed because it is too large
Load Diff
580
libraries/vendor/joomla/console/src/Command/AbstractCommand.php
vendored
Normal file
580
libraries/vendor/joomla/console/src/Command/AbstractCommand.php
vendored
Normal file
@ -0,0 +1,580 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Part of the Joomla Framework Console Package
|
||||
*
|
||||
* @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
|
||||
* @license GNU General Public License version 2 or later; see LICENSE
|
||||
*/
|
||||
|
||||
namespace Joomla\Console\Command;
|
||||
|
||||
use Joomla\Console\Application;
|
||||
use Symfony\Component\Console\Helper\HelperSet;
|
||||
use Symfony\Component\Console\Input\InputArgument;
|
||||
use Symfony\Component\Console\Input\InputDefinition;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Input\InputOption;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
|
||||
/**
|
||||
* Base command class for a Joomla! command line application.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
abstract class AbstractCommand
|
||||
{
|
||||
/**
|
||||
* The default command name
|
||||
*
|
||||
* @var string|null
|
||||
* @since 2.0.0
|
||||
*/
|
||||
protected static $defaultName;
|
||||
|
||||
/**
|
||||
* The command's aliases.
|
||||
*
|
||||
* @var string[]
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $aliases = [];
|
||||
|
||||
/**
|
||||
* The application running this command.
|
||||
*
|
||||
* @var Application|null
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $application;
|
||||
|
||||
/**
|
||||
* Flag tracking whether the application definition has been merged to this command.
|
||||
*
|
||||
* @var boolean
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $applicationDefinitionMerged = false;
|
||||
|
||||
/**
|
||||
* Flag tracking whether the application definition with arguments has been merged to this command.
|
||||
*
|
||||
* @var boolean
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $applicationDefinitionMergedWithArgs = false;
|
||||
|
||||
/**
|
||||
* The command's input definition.
|
||||
*
|
||||
* @var InputDefinition
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $definition;
|
||||
|
||||
/**
|
||||
* The command's description.
|
||||
*
|
||||
* @var string
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $description = '';
|
||||
|
||||
/**
|
||||
* The command's help.
|
||||
*
|
||||
* @var string
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $help = '';
|
||||
|
||||
/**
|
||||
* The command's input helper set.
|
||||
*
|
||||
* @var HelperSet|null
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $helperSet;
|
||||
|
||||
/**
|
||||
* Flag tracking whether the command is hidden from the command listing.
|
||||
*
|
||||
* @var boolean
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $hidden = false;
|
||||
|
||||
/**
|
||||
* The command's name.
|
||||
*
|
||||
* @var string
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $name;
|
||||
|
||||
/**
|
||||
* The command's synopses.
|
||||
*
|
||||
* @var string[]
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $synopsis = [];
|
||||
|
||||
/**
|
||||
* Command constructor.
|
||||
*
|
||||
* @param string|null $name The name of the command; if the name is empty and no default is set, a name must be set in the configure() method
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function __construct(?string $name = null)
|
||||
{
|
||||
$this->definition = new InputDefinition();
|
||||
|
||||
if ($name !== null || null !== $name = static::getDefaultName()) {
|
||||
$this->setName($name);
|
||||
}
|
||||
|
||||
$this->configure();
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds an argument to the input definition.
|
||||
*
|
||||
* @param string $name The argument name
|
||||
* @param ?integer $mode The argument mode: InputArgument::REQUIRED or InputArgument::OPTIONAL
|
||||
* @param string $description A description text
|
||||
* @param mixed $default The default value (for InputArgument::OPTIONAL mode only)
|
||||
*
|
||||
* @return $this
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function addArgument(string $name, ?int $mode = null, string $description = '', $default = null): self
|
||||
{
|
||||
$this->definition->addArgument(new InputArgument($name, $mode, $description, $default));
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds an option to the input definition.
|
||||
*
|
||||
* @param string $name The option name
|
||||
* @param string|array $shortcut The shortcuts, can be null, a string of shortcuts delimited by | or an array of shortcuts
|
||||
* @param ?integer $mode The option mode: One of the VALUE_* constants
|
||||
* @param string $description A description text
|
||||
* @param ?mixed $default The default value (must be null for InputOption::VALUE_NONE)
|
||||
*
|
||||
* @return $this
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function addOption(string $name, $shortcut = null, ?int $mode = null, $description = '', $default = null): self
|
||||
{
|
||||
$this->definition->addOption(new InputOption($name, $shortcut, $mode, $description, $default));
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Configure the command.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
protected function configure(): void
|
||||
{
|
||||
}
|
||||
|
||||
/**
|
||||
* Internal function to execute the command.
|
||||
*
|
||||
* @param InputInterface $input The input to inject into the command.
|
||||
* @param OutputInterface $output The output to inject into the command.
|
||||
*
|
||||
* @return integer The command exit code
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
abstract protected function doExecute(InputInterface $input, OutputInterface $output): int;
|
||||
|
||||
/**
|
||||
* Executes the command.
|
||||
*
|
||||
* @param InputInterface $input The input to inject into the command.
|
||||
* @param OutputInterface $output The output to inject into the command.
|
||||
*
|
||||
* @return integer The command exit code
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function execute(InputInterface $input, OutputInterface $output): int
|
||||
{
|
||||
// Force the creation of the synopsis before the merge with the app definition
|
||||
$this->getSynopsis(true);
|
||||
$this->getSynopsis(false);
|
||||
|
||||
// Add the application arguments and options
|
||||
$this->mergeApplicationDefinition();
|
||||
|
||||
// Bind the input against the command specific arguments/options
|
||||
$input->bind($this->getDefinition());
|
||||
|
||||
$this->initialise($input, $output);
|
||||
|
||||
// Ensure that the command has a `command` argument so it does not fail validation
|
||||
if ($input->hasArgument('command') && $input->getArgument('command') === null) {
|
||||
$input->setArgument('command', $this->getName());
|
||||
}
|
||||
|
||||
$input->validate();
|
||||
|
||||
return $this->doExecute($input, $output);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the command's aliases.
|
||||
*
|
||||
* @return string[]
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function getAliases(): array
|
||||
{
|
||||
return $this->aliases;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the application object.
|
||||
*
|
||||
* @return Application The application object.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @throws \UnexpectedValueException if the application has not been set.
|
||||
*/
|
||||
public function getApplication(): Application
|
||||
{
|
||||
if ($this->application) {
|
||||
return $this->application;
|
||||
}
|
||||
|
||||
throw new \UnexpectedValueException('Application not set in ' . \get_class($this));
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the default command name for this class.
|
||||
*
|
||||
* This allows a command name to defined and referenced without instantiating the full command class.
|
||||
*
|
||||
* @return string|null
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public static function getDefaultName(): ?string
|
||||
{
|
||||
$class = \get_called_class();
|
||||
$r = new \ReflectionProperty($class, 'defaultName');
|
||||
|
||||
return $class === $r->class ? static::$defaultName : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the InputDefinition attached to this command.
|
||||
*
|
||||
* @return InputDefinition
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function getDefinition(): InputDefinition
|
||||
{
|
||||
return $this->definition;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the command's description.
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function getDescription(): string
|
||||
{
|
||||
return $this->description;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the command's help.
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function getHelp(): string
|
||||
{
|
||||
return $this->help;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the command's input helper set.
|
||||
*
|
||||
* @return HelperSet|null
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function getHelperSet(): ?HelperSet
|
||||
{
|
||||
return $this->helperSet;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the command's name.
|
||||
*
|
||||
* @return string|null
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function getName(): ?string
|
||||
{
|
||||
return $this->name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the processed help for the command.
|
||||
*
|
||||
* This method is used to replace placeholders in commands with the real values.
|
||||
* By default, this supports `%command.name%` and `%command.full_name`.
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function getProcessedHelp(): string
|
||||
{
|
||||
$name = $this->getName();
|
||||
|
||||
$placeholders = [
|
||||
'%command.name%',
|
||||
'%command.full_name%',
|
||||
];
|
||||
|
||||
$replacements = [
|
||||
$name,
|
||||
$_SERVER['PHP_SELF'] . ' ' . $name,
|
||||
];
|
||||
|
||||
return str_replace($placeholders, $replacements, $this->getHelp() ?: $this->getDescription());
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the command's synopsis.
|
||||
*
|
||||
* @param boolean $short Flag indicating whether the short or long version of the synopsis should be returned
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function getSynopsis(bool $short = false): string
|
||||
{
|
||||
$key = $short ? 'short' : 'long';
|
||||
|
||||
if (!isset($this->synopsis[$key])) {
|
||||
$this->synopsis[$key] = trim(sprintf('%s %s', $this->getName(), $this->getDefinition()->getSynopsis($short)));
|
||||
}
|
||||
|
||||
return $this->synopsis[$key];
|
||||
}
|
||||
|
||||
/**
|
||||
* Internal hook to initialise the command after the input has been bound and before the input is validated.
|
||||
*
|
||||
* @param InputInterface $input The input to inject into the command.
|
||||
* @param OutputInterface $output The output to inject into the command.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
protected function initialise(InputInterface $input, OutputInterface $output): void
|
||||
{
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the command is enabled in this environment.
|
||||
*
|
||||
* @return boolean
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function isEnabled(): bool
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the command is hidden from the command listing.
|
||||
*
|
||||
* @return boolean
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function isHidden(): bool
|
||||
{
|
||||
return $this->hidden;
|
||||
}
|
||||
|
||||
/**
|
||||
* Merges the application definition with the command definition.
|
||||
*
|
||||
* @param boolean $mergeArgs Flag indicating whether the application's definition arguments should be merged
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @internal This method should not be relied on as part of the public API
|
||||
*/
|
||||
final public function mergeApplicationDefinition(bool $mergeArgs = true): void
|
||||
{
|
||||
if (!$this->application || ($this->applicationDefinitionMerged && ($this->applicationDefinitionMergedWithArgs || !$mergeArgs))) {
|
||||
return;
|
||||
}
|
||||
|
||||
$this->getDefinition()->addOptions($this->getApplication()->getDefinition()->getOptions());
|
||||
|
||||
$this->applicationDefinitionMerged = true;
|
||||
|
||||
if ($mergeArgs) {
|
||||
$currentArguments = $this->getDefinition()->getArguments();
|
||||
$this->getDefinition()->setArguments($this->getApplication()->getDefinition()->getArguments());
|
||||
$this->getDefinition()->addArguments($currentArguments);
|
||||
|
||||
$this->applicationDefinitionMergedWithArgs = true;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the command's aliases.
|
||||
*
|
||||
* @param string[] $aliases The command aliases
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function setAliases(array $aliases): void
|
||||
{
|
||||
$this->aliases = $aliases;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the command's application.
|
||||
*
|
||||
* @param ?Application $application The command's application
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function setApplication(?Application $application = null): void
|
||||
{
|
||||
$this->application = $application;
|
||||
|
||||
if ($application) {
|
||||
$this->setHelperSet($application->getHelperSet());
|
||||
} else {
|
||||
$this->helperSet = null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the input definition for the command.
|
||||
*
|
||||
* @param array|InputDefinition $definition Either an InputDefinition object or an array of objects to write to the definition.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function setDefinition($definition): void
|
||||
{
|
||||
if ($definition instanceof InputDefinition) {
|
||||
$this->definition = $definition;
|
||||
} else {
|
||||
$this->definition->setDefinition($definition);
|
||||
}
|
||||
|
||||
$this->applicationDefinitionMerged = false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the description for the command.
|
||||
*
|
||||
* @param string $description The description for the command
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function setDescription(string $description): void
|
||||
{
|
||||
$this->description = $description;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the help for the command.
|
||||
*
|
||||
* @param string $help The help for the command
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function setHelp(string $help): void
|
||||
{
|
||||
$this->help = $help;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the command's input helper set.
|
||||
*
|
||||
* @param HelperSet $helperSet The helper set.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function setHelperSet(HelperSet $helperSet): void
|
||||
{
|
||||
$this->helperSet = $helperSet;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set whether this command is hidden from the command listing.
|
||||
*
|
||||
* @param boolean $hidden Flag if this command is hidden.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function setHidden(bool $hidden): void
|
||||
{
|
||||
$this->hidden = $hidden;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the command's name.
|
||||
*
|
||||
* @param string $name The command name
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function setName(string $name): void
|
||||
{
|
||||
$this->name = $name;
|
||||
}
|
||||
}
|
||||
103
libraries/vendor/joomla/console/src/Command/HelpCommand.php
vendored
Normal file
103
libraries/vendor/joomla/console/src/Command/HelpCommand.php
vendored
Normal file
@ -0,0 +1,103 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Part of the Joomla Framework Console Package
|
||||
*
|
||||
* @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
|
||||
* @license GNU General Public License version 2 or later; see LICENSE
|
||||
*/
|
||||
|
||||
namespace Joomla\Console\Command;
|
||||
|
||||
use Joomla\Console\Helper\DescriptorHelper;
|
||||
use Symfony\Component\Console\Input\InputArgument;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
|
||||
/**
|
||||
* Command to render a command's help data.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
class HelpCommand extends AbstractCommand
|
||||
{
|
||||
/**
|
||||
* The default command name
|
||||
*
|
||||
* @var string
|
||||
* @since 2.0.0
|
||||
*/
|
||||
protected static $defaultName = 'help';
|
||||
|
||||
/**
|
||||
* The command to process help for
|
||||
*
|
||||
* @var AbstractCommand|null
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $command;
|
||||
|
||||
/**
|
||||
* Configure the command.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
protected function configure(): void
|
||||
{
|
||||
$this->setDescription('Show the help for a command');
|
||||
$this->setHelp(
|
||||
<<<'EOF'
|
||||
The <info>%command.name%</info> command displays a command's help information:
|
||||
|
||||
<info>php %command.full_name% list</info>
|
||||
|
||||
To display the list of available commands, please use the <info>list</info> command.
|
||||
EOF
|
||||
);
|
||||
|
||||
$this->addArgument('command_name', InputArgument::OPTIONAL, 'The command name', 'help');
|
||||
}
|
||||
|
||||
/**
|
||||
* Internal function to execute the command.
|
||||
*
|
||||
* @param InputInterface $input The input to inject into the command.
|
||||
* @param OutputInterface $output The output to inject into the command.
|
||||
*
|
||||
* @return integer The command exit code
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
protected function doExecute(InputInterface $input, OutputInterface $output): int
|
||||
{
|
||||
if (!$this->command) {
|
||||
$this->command = $this->getApplication()->getCommand($input->getArgument('command_name'));
|
||||
}
|
||||
|
||||
$descriptor = new DescriptorHelper();
|
||||
|
||||
if ($this->getHelperSet() !== null) {
|
||||
$this->getHelperSet()->set($descriptor);
|
||||
}
|
||||
|
||||
$descriptor->describe($output, $this->command);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the command whose help is being presented.
|
||||
*
|
||||
* @param AbstractCommand $command The command to process help for.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function setCommand(AbstractCommand $command): void
|
||||
{
|
||||
$this->command = $command;
|
||||
}
|
||||
}
|
||||
80
libraries/vendor/joomla/console/src/Command/ListCommand.php
vendored
Normal file
80
libraries/vendor/joomla/console/src/Command/ListCommand.php
vendored
Normal file
@ -0,0 +1,80 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Part of the Joomla Framework Console Package
|
||||
*
|
||||
* @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
|
||||
* @license GNU General Public License version 2 or later; see LICENSE
|
||||
*/
|
||||
|
||||
namespace Joomla\Console\Command;
|
||||
|
||||
use Joomla\Console\Helper\DescriptorHelper;
|
||||
use Symfony\Component\Console\Input\InputArgument;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
|
||||
/**
|
||||
* Command listing all available commands.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
class ListCommand extends AbstractCommand
|
||||
{
|
||||
/**
|
||||
* The default command name
|
||||
*
|
||||
* @var string
|
||||
* @since 2.0.0
|
||||
*/
|
||||
protected static $defaultName = 'list';
|
||||
|
||||
/**
|
||||
* Configure the command.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
protected function configure(): void
|
||||
{
|
||||
$this->setDescription("List the application's available commands");
|
||||
$this->addArgument('namespace', InputArgument::OPTIONAL, 'The namespace name');
|
||||
$this->setHelp(
|
||||
<<<'EOF'
|
||||
The <info>%command.name%</info> command lists all of the application's commands:
|
||||
|
||||
<info>php %command.full_name%</info>
|
||||
EOF
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Internal function to execute the command.
|
||||
*
|
||||
* @param InputInterface $input The input to inject into the command.
|
||||
* @param OutputInterface $output The output to inject into the command.
|
||||
*
|
||||
* @return integer The command exit code
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
protected function doExecute(InputInterface $input, OutputInterface $output): int
|
||||
{
|
||||
$descriptor = new DescriptorHelper();
|
||||
|
||||
if ($this->getHelperSet() !== null) {
|
||||
$this->getHelperSet()->set($descriptor);
|
||||
}
|
||||
|
||||
$descriptor->describe(
|
||||
$output,
|
||||
$this->getApplication(),
|
||||
[
|
||||
'namespace' => $input->getArgument('namespace'),
|
||||
]
|
||||
);
|
||||
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
60
libraries/vendor/joomla/console/src/ConsoleEvents.php
vendored
Normal file
60
libraries/vendor/joomla/console/src/ConsoleEvents.php
vendored
Normal file
@ -0,0 +1,60 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Part of the Joomla Framework Console Package
|
||||
*
|
||||
* @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
|
||||
* @license GNU General Public License version 2 or later; see LICENSE
|
||||
*/
|
||||
|
||||
namespace Joomla\Console;
|
||||
|
||||
/**
|
||||
* Class defining the events available in the console application.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
final class ConsoleEvents
|
||||
{
|
||||
/**
|
||||
* The APPLICATION_ERROR event is an event triggered when an uncaught Throwable is received at the main application executor.
|
||||
*
|
||||
* This event allows developers to handle the Throwable.
|
||||
*
|
||||
* @var string
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public const APPLICATION_ERROR = 'console.application_error';
|
||||
|
||||
/**
|
||||
* The BEFORE_COMMAND_EXECUTE event is an event triggered before a command is executed.
|
||||
*
|
||||
* This event allows developers to modify information about the command or the command's
|
||||
* dependencies prior to the command being executed.
|
||||
*
|
||||
* @var string
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public const BEFORE_COMMAND_EXECUTE = 'console.before_command_execute';
|
||||
|
||||
/**
|
||||
* The COMMAND_ERROR event is an event triggered when an uncaught Throwable from a command is received.
|
||||
*
|
||||
* This event allows developers to handle the Throwable.
|
||||
*
|
||||
* @var string
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public const COMMAND_ERROR = 'console.command_error';
|
||||
|
||||
/**
|
||||
* The TERMINATE event is an event triggered immediately before the application is exited.
|
||||
*
|
||||
* This event allows developers to perform any post-process actions and to manipulate
|
||||
* the process' exit code.
|
||||
*
|
||||
* @var string
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public const TERMINATE = 'console.terminate';
|
||||
}
|
||||
235
libraries/vendor/joomla/console/src/Descriptor/ApplicationDescription.php
vendored
Normal file
235
libraries/vendor/joomla/console/src/Descriptor/ApplicationDescription.php
vendored
Normal file
@ -0,0 +1,235 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Part of the Joomla Framework Console Package
|
||||
*
|
||||
* @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
|
||||
* @license GNU General Public License version 2 or later; see LICENSE
|
||||
*/
|
||||
|
||||
namespace Joomla\Console\Descriptor;
|
||||
|
||||
use Joomla\Console\Application;
|
||||
use Joomla\Console\Command\AbstractCommand;
|
||||
use Symfony\Component\Console\Exception\CommandNotFoundException;
|
||||
|
||||
/**
|
||||
* Describes an application.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
final class ApplicationDescription
|
||||
{
|
||||
/**
|
||||
* Placeholder for commands in the global namespace.
|
||||
*
|
||||
* @var string
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public const GLOBAL_NAMESPACE = '_global';
|
||||
|
||||
/**
|
||||
* The application's aliased commands.
|
||||
*
|
||||
* @var AbstractCommand[]
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $aliases;
|
||||
|
||||
/**
|
||||
* The application being described.
|
||||
*
|
||||
* @var Application
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $application;
|
||||
|
||||
/**
|
||||
* The application's commands.
|
||||
*
|
||||
* @var AbstractCommand[]
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $commands;
|
||||
|
||||
/**
|
||||
* The command namespace to process.
|
||||
*
|
||||
* @var string
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $namespace = '';
|
||||
|
||||
/**
|
||||
* The application's command namespaces.
|
||||
*
|
||||
* @var array[]
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $namespaces;
|
||||
|
||||
/**
|
||||
* Flag indicating hidden commands should be displayed.
|
||||
*
|
||||
* @var boolean
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $showHidden;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param Application $application The application being described.
|
||||
* @param string $namespace The command namespace to process.
|
||||
* @param boolean $showHidden Flag indicating hidden commands should be displayed.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function __construct(Application $application, string $namespace = '', bool $showHidden = false)
|
||||
{
|
||||
$this->application = $application;
|
||||
$this->namespace = $namespace;
|
||||
$this->showHidden = $showHidden;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the application's command namespaces.
|
||||
*
|
||||
* @return array[]
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function getNamespaces(): array
|
||||
{
|
||||
if ($this->namespaces === null) {
|
||||
$this->inspectApplication();
|
||||
}
|
||||
|
||||
return $this->namespaces;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the application's commands.
|
||||
*
|
||||
* @return AbstractCommand[]
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function getCommands(): array
|
||||
{
|
||||
if ($this->commands === null) {
|
||||
$this->inspectApplication();
|
||||
}
|
||||
|
||||
return $this->commands;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a command by name.
|
||||
*
|
||||
* @param string $name The name of the command to retrieve.
|
||||
*
|
||||
* @return AbstractCommand
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @throws CommandNotFoundException
|
||||
*/
|
||||
public function getCommand(string $name): AbstractCommand
|
||||
{
|
||||
if (!isset($this->commands[$name]) && !isset($this->aliases[$name])) {
|
||||
throw new CommandNotFoundException(sprintf('Command %s does not exist.', $name));
|
||||
}
|
||||
|
||||
return $this->commands[$name] ?? $this->aliases[$name];
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the namespace part of the command name.
|
||||
*
|
||||
* @param string $name The command name to process
|
||||
* @param ?integer $limit The maximum number of parts of the namespace
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private function extractNamespace(string $name, ?int $limit = null): string
|
||||
{
|
||||
$parts = explode(':', $name);
|
||||
array_pop($parts);
|
||||
|
||||
return implode(':', $limit === null ? $parts : \array_slice($parts, 0, $limit));
|
||||
}
|
||||
|
||||
/**
|
||||
* Inspects the application.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private function inspectApplication(): void
|
||||
{
|
||||
$this->commands = [];
|
||||
$this->namespaces = [];
|
||||
|
||||
$all = $this->application->getAllCommands($this->namespace ? $this->application->findNamespace($this->namespace) : '');
|
||||
|
||||
foreach ($this->sortCommands($all) as $namespace => $commands) {
|
||||
$names = [];
|
||||
|
||||
foreach ($commands as $name => $command) {
|
||||
if (!$command->getName() || (!$this->showHidden && $command->isHidden())) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($command->getName() === $name) {
|
||||
$this->commands[$name] = $command;
|
||||
} else {
|
||||
$this->aliases[$name] = $command;
|
||||
}
|
||||
|
||||
$names[] = $name;
|
||||
}
|
||||
|
||||
$this->namespaces[$namespace] = ['id' => $namespace, 'commands' => $names];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Sort a set of commands.
|
||||
*
|
||||
* @param AbstractCommand[] $commands The commands to sort.
|
||||
*
|
||||
* @return AbstractCommand[][]
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private function sortCommands(array $commands): array
|
||||
{
|
||||
$namespacedCommands = [];
|
||||
$globalCommands = [];
|
||||
|
||||
foreach ($commands as $name => $command) {
|
||||
$key = $this->extractNamespace($name, 1);
|
||||
|
||||
if (!$key) {
|
||||
$globalCommands[self::GLOBAL_NAMESPACE][$name] = $command;
|
||||
} else {
|
||||
$namespacedCommands[$key][$name] = $command;
|
||||
}
|
||||
}
|
||||
|
||||
ksort($namespacedCommands);
|
||||
$namespacedCommands = array_merge($globalCommands, $namespacedCommands);
|
||||
|
||||
foreach ($namespacedCommands as &$commandsSet) {
|
||||
ksort($commandsSet);
|
||||
}
|
||||
|
||||
// Unset reference to keep scope clear
|
||||
unset($commandsSet);
|
||||
|
||||
return $namespacedCommands;
|
||||
}
|
||||
}
|
||||
262
libraries/vendor/joomla/console/src/Descriptor/TextDescriptor.php
vendored
Normal file
262
libraries/vendor/joomla/console/src/Descriptor/TextDescriptor.php
vendored
Normal file
@ -0,0 +1,262 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Part of the Joomla Framework Console Package
|
||||
*
|
||||
* @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
|
||||
* @license GNU General Public License version 2 or later; see LICENSE
|
||||
*/
|
||||
|
||||
namespace Joomla\Console\Descriptor;
|
||||
|
||||
use Joomla\Console\Application;
|
||||
use Joomla\Console\Command\AbstractCommand;
|
||||
use Joomla\String\StringHelper;
|
||||
use Symfony\Component\Console\Descriptor\TextDescriptor as SymfonyTextDescriptor;
|
||||
use Symfony\Component\Console\Input\InputDefinition;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
|
||||
/**
|
||||
* Text object descriptor.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
final class TextDescriptor extends SymfonyTextDescriptor
|
||||
{
|
||||
/**
|
||||
* Describes an object.
|
||||
*
|
||||
* @param OutputInterface $output The output object to use.
|
||||
* @param object $object The object to describe.
|
||||
* @param array $options Descriptor options.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function describe(OutputInterface $output, object $object, array $options = []): void
|
||||
{
|
||||
$this->output = $output;
|
||||
|
||||
switch (true) {
|
||||
case $object instanceof Application:
|
||||
$this->describeJoomlaApplication($object, $options);
|
||||
|
||||
break;
|
||||
|
||||
case $object instanceof AbstractCommand:
|
||||
$this->describeConsoleCommand($object, $options);
|
||||
|
||||
break;
|
||||
|
||||
default:
|
||||
parent::describe($output, $object, $options);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Formats command aliases to show them in the command description.
|
||||
*
|
||||
* @param AbstractCommand $command The command to process
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private function getCommandAliasesText(AbstractCommand $command): string
|
||||
{
|
||||
$text = '';
|
||||
$aliases = $command->getAliases();
|
||||
|
||||
if ($aliases) {
|
||||
$text = '[' . implode('|', $aliases) . '] ';
|
||||
}
|
||||
|
||||
return $text;
|
||||
}
|
||||
|
||||
/**
|
||||
* Describes a command.
|
||||
*
|
||||
* @param AbstractCommand $command The command being described.
|
||||
* @param array $options Descriptor options.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private function describeConsoleCommand(AbstractCommand $command, array $options): void
|
||||
{
|
||||
$command->getSynopsis(true);
|
||||
$command->getSynopsis(false);
|
||||
$command->mergeApplicationDefinition(false);
|
||||
|
||||
$this->writeText('<comment>Usage:</comment>', $options);
|
||||
|
||||
foreach (array_merge([$command->getSynopsis(true)], $command->getAliases()) as $usage) {
|
||||
$this->writeText("\n");
|
||||
$this->writeText(' ' . $usage, $options);
|
||||
}
|
||||
|
||||
$this->writeText("\n");
|
||||
|
||||
$definition = $command->getDefinition();
|
||||
|
||||
if ($definition->getOptions() || $definition->getArguments()) {
|
||||
$this->writeText("\n");
|
||||
$this->describeInputDefinition($definition, $options);
|
||||
$this->writeText("\n");
|
||||
}
|
||||
|
||||
if ($help = $command->getProcessedHelp()) {
|
||||
$this->writeText("\n");
|
||||
$this->writeText('<comment>Help:</comment>', $options);
|
||||
$this->writeText("\n");
|
||||
$this->writeText(' ' . str_replace("\n", "\n ", $help), $options);
|
||||
$this->writeText("\n");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Describes an application.
|
||||
*
|
||||
* @param Application $app The application being described.
|
||||
* @param array $options Descriptor options.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private function describeJoomlaApplication(Application $app, array $options): void
|
||||
{
|
||||
$describedNamespace = $options['namespace'] ?? '';
|
||||
$description = new ApplicationDescription($app, $describedNamespace);
|
||||
|
||||
$version = $app->getLongVersion();
|
||||
|
||||
if ($version !== '') {
|
||||
$this->writeText("$version\n\n", $options);
|
||||
}
|
||||
|
||||
$this->writeText("<comment>Usage:</comment>\n");
|
||||
$this->writeText(" command [options] [arguments]\n\n");
|
||||
|
||||
$this->describeInputDefinition(new InputDefinition($app->getDefinition()->getOptions()), $options);
|
||||
|
||||
$this->writeText("\n");
|
||||
$this->writeText("\n");
|
||||
|
||||
$commands = $description->getCommands();
|
||||
$namespaces = $description->getNamespaces();
|
||||
|
||||
if ($describedNamespace && $namespaces) {
|
||||
// Ensure all aliased commands are included when describing a specific namespace
|
||||
$describedNamespaceInfo = reset($namespaces);
|
||||
|
||||
foreach ($describedNamespaceInfo['commands'] as $name) {
|
||||
$commands[$name] = $description->getCommand($name);
|
||||
}
|
||||
}
|
||||
|
||||
$width = $this->getColumnWidth(
|
||||
\call_user_func_array(
|
||||
'array_merge',
|
||||
array_map(
|
||||
function ($namespace) use ($commands) {
|
||||
return array_intersect($namespace['commands'], array_keys($commands));
|
||||
},
|
||||
array_values($namespaces)
|
||||
)
|
||||
)
|
||||
);
|
||||
|
||||
if ($describedNamespace) {
|
||||
$this->writeText(sprintf('<comment>Available commands for the "%s" namespace:</comment>', $describedNamespace), $options);
|
||||
} else {
|
||||
$this->writeText('<comment>Available commands:</comment>', $options);
|
||||
}
|
||||
|
||||
foreach ($namespaces as $namespace) {
|
||||
$namespace['commands'] = array_filter(
|
||||
$namespace['commands'],
|
||||
function ($name) use ($commands) {
|
||||
return isset($commands[$name]);
|
||||
}
|
||||
);
|
||||
|
||||
if (!$namespace['commands']) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (!$describedNamespace && $namespace['id'] !== ApplicationDescription::GLOBAL_NAMESPACE) {
|
||||
$this->writeText("\n");
|
||||
$this->writeText(' <comment>' . $namespace['id'] . '</comment>', $options);
|
||||
}
|
||||
|
||||
foreach ($namespace['commands'] as $name) {
|
||||
$this->writeText("\n");
|
||||
$spacingWidth = $width - StringHelper::strlen($name);
|
||||
$command = $commands[$name];
|
||||
$commandAliases = $name === $command->getName() ? $this->getCommandAliasesText($command) : '';
|
||||
|
||||
$this->writeText(
|
||||
sprintf(
|
||||
' <info>%s</info>%s%s',
|
||||
$name,
|
||||
str_repeat(' ', $spacingWidth),
|
||||
$commandAliases . $command->getDescription()
|
||||
),
|
||||
$options
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
$this->writeText("\n");
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculate the column width for a group of commands.
|
||||
*
|
||||
* @param AbstractCommand[]|string[] $commands The commands to use for processing a width.
|
||||
*
|
||||
* @return integer
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private function getColumnWidth(array $commands): int
|
||||
{
|
||||
$widths = [];
|
||||
|
||||
foreach ($commands as $command) {
|
||||
if ($command instanceof AbstractCommand) {
|
||||
$widths[] = StringHelper::strlen($command->getName());
|
||||
|
||||
foreach ($command->getAliases() as $alias) {
|
||||
$widths[] = StringHelper::strlen($alias);
|
||||
}
|
||||
} else {
|
||||
$widths[] = StringHelper::strlen($command);
|
||||
}
|
||||
}
|
||||
|
||||
return $widths ? max($widths) + 2 : 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes text to the output.
|
||||
*
|
||||
* @param string $content The message.
|
||||
* @param array $options The options to use for formatting the output.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private function writeText($content, array $options = []): void
|
||||
{
|
||||
$this->write(
|
||||
isset($options['raw_text']) && $options['raw_text'] ? strip_tags($content) : $content,
|
||||
isset($options['raw_output']) ? !$options['raw_output'] : true
|
||||
);
|
||||
}
|
||||
}
|
||||
110
libraries/vendor/joomla/console/src/Event/ApplicationErrorEvent.php
vendored
Normal file
110
libraries/vendor/joomla/console/src/Event/ApplicationErrorEvent.php
vendored
Normal file
@ -0,0 +1,110 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Part of the Joomla Framework Console Package
|
||||
*
|
||||
* @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
|
||||
* @license GNU General Public License version 2 or later; see LICENSE
|
||||
*/
|
||||
|
||||
namespace Joomla\Console\Event;
|
||||
|
||||
use Joomla\Console\Application;
|
||||
use Joomla\Console\Command\AbstractCommand;
|
||||
use Joomla\Console\ConsoleEvents;
|
||||
|
||||
/**
|
||||
* Event triggered when an uncaught Throwable is received by the application.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
class ApplicationErrorEvent extends ConsoleEvent
|
||||
{
|
||||
/**
|
||||
* The Throwable object with the error data.
|
||||
*
|
||||
* @var \Throwable
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $error;
|
||||
|
||||
/**
|
||||
* The exit code to use for the application.
|
||||
*
|
||||
* @var integer|null
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $exitCode;
|
||||
|
||||
/**
|
||||
* Event constructor.
|
||||
*
|
||||
* @param \Throwable $error The Throwable object with the error data.
|
||||
* @param Application $application The active application.
|
||||
* @param AbstractCommand|null $command The command being executed.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function __construct(\Throwable $error, Application $application, ?AbstractCommand $command = null)
|
||||
{
|
||||
parent::__construct(ConsoleEvents::APPLICATION_ERROR, $application, $command);
|
||||
|
||||
$this->error = $error;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the error object.
|
||||
*
|
||||
* @return \Throwable
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function getError(): \Throwable
|
||||
{
|
||||
return $this->error;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the exit code.
|
||||
*
|
||||
* @return integer
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function getExitCode(): int
|
||||
{
|
||||
return $this->exitCode ?: (\is_int($this->error->getCode()) && $this->error->getCode() !== 0 ? $this->error->getCode() : 1);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the error object.
|
||||
*
|
||||
* @param \Throwable $error The error object to set to the event.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function setError(\Throwable $error): void
|
||||
{
|
||||
$this->error = $error;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the exit code.
|
||||
*
|
||||
* @param integer $exitCode The command exit code.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function setExitCode(int $exitCode): void
|
||||
{
|
||||
$this->exitCode = $exitCode;
|
||||
|
||||
$r = new \ReflectionProperty($this->error, 'code');
|
||||
$r->setAccessible(true);
|
||||
$r->setValue($this->error, $this->exitCode);
|
||||
}
|
||||
}
|
||||
91
libraries/vendor/joomla/console/src/Event/BeforeCommandExecuteEvent.php
vendored
Normal file
91
libraries/vendor/joomla/console/src/Event/BeforeCommandExecuteEvent.php
vendored
Normal file
@ -0,0 +1,91 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Part of the Joomla Framework Console Package
|
||||
*
|
||||
* @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
|
||||
* @license GNU General Public License version 2 or later; see LICENSE
|
||||
*/
|
||||
|
||||
namespace Joomla\Console\Event;
|
||||
|
||||
use Joomla\Console\Application;
|
||||
use Joomla\Console\Command\AbstractCommand;
|
||||
use Joomla\Console\ConsoleEvents;
|
||||
|
||||
/**
|
||||
* Event triggered before a command is executed.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
class BeforeCommandExecuteEvent extends ConsoleEvent
|
||||
{
|
||||
/**
|
||||
* The return code for a command disabled by this event.
|
||||
*
|
||||
* @var integer
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public const RETURN_CODE_DISABLED = 113;
|
||||
|
||||
/**
|
||||
* Flag indicating the command is enabled
|
||||
*
|
||||
* @var boolean
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $commandEnabled = true;
|
||||
|
||||
/**
|
||||
* Event constructor.
|
||||
*
|
||||
* @param Application $application The active application.
|
||||
* @param AbstractCommand|null $command The command being executed.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function __construct(Application $application, ?AbstractCommand $command = null)
|
||||
{
|
||||
parent::__construct(ConsoleEvents::BEFORE_COMMAND_EXECUTE, $application, $command);
|
||||
|
||||
if ($command) {
|
||||
$this->commandEnabled = $command->isEnabled();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Disable the command.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function disableCommand(): void
|
||||
{
|
||||
$this->commandEnabled = false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enable the command.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function enableCommand(): void
|
||||
{
|
||||
$this->commandEnabled = false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the command is enabled.
|
||||
*
|
||||
* @return boolean
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function isCommandEnabled(): bool
|
||||
{
|
||||
return $this->commandEnabled;
|
||||
}
|
||||
}
|
||||
114
libraries/vendor/joomla/console/src/Event/CommandErrorEvent.php
vendored
Normal file
114
libraries/vendor/joomla/console/src/Event/CommandErrorEvent.php
vendored
Normal file
@ -0,0 +1,114 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Part of the Joomla Framework Console Package
|
||||
*
|
||||
* @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
|
||||
* @license GNU General Public License version 2 or later; see LICENSE
|
||||
*/
|
||||
|
||||
namespace Joomla\Console\Event;
|
||||
|
||||
use Joomla\Console\Application;
|
||||
use Joomla\Console\Command\AbstractCommand;
|
||||
use Joomla\Console\ConsoleEvents;
|
||||
|
||||
/**
|
||||
* Event triggered when an uncaught Throwable is received by the application from a command.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
class CommandErrorEvent extends ConsoleEvent
|
||||
{
|
||||
/**
|
||||
* The Throwable object with the error data.
|
||||
*
|
||||
* @var \Throwable
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $error;
|
||||
|
||||
/**
|
||||
* The exit code to use for the application.
|
||||
*
|
||||
* @var integer|null
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $exitCode;
|
||||
|
||||
/**
|
||||
* Event constructor.
|
||||
*
|
||||
* @param \Throwable $error The Throwable object with the error data.
|
||||
* @param Application $application The active application.
|
||||
* @param AbstractCommand|null $command The command being executed.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function __construct(\Throwable $error, Application $application, ?AbstractCommand $command = null)
|
||||
{
|
||||
parent::__construct(ConsoleEvents::COMMAND_ERROR, $application, $command);
|
||||
|
||||
$this->error = $error;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the error object.
|
||||
*
|
||||
* @return \Throwable
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function getError(): \Throwable
|
||||
{
|
||||
return $this->error;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the exit code.
|
||||
*
|
||||
* @return integer
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function getExitCode(): int
|
||||
{
|
||||
if ($this->exitCode !== null) {
|
||||
return $this->exitCode;
|
||||
}
|
||||
|
||||
return \is_int($this->error->getCode()) && $this->error->getCode() !== 0 ? $this->error->getCode() : 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the error object.
|
||||
*
|
||||
* @param \Throwable $error The error object to set to the event.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function setError(\Throwable $error): void
|
||||
{
|
||||
$this->error = $error;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the exit code.
|
||||
*
|
||||
* @param integer $exitCode The command exit code.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function setExitCode(int $exitCode): void
|
||||
{
|
||||
$this->exitCode = $exitCode;
|
||||
|
||||
$r = new \ReflectionProperty($this->error, 'code');
|
||||
$r->setAccessible(true);
|
||||
$r->setValue($this->error, $this->exitCode);
|
||||
}
|
||||
}
|
||||
79
libraries/vendor/joomla/console/src/Event/ConsoleEvent.php
vendored
Normal file
79
libraries/vendor/joomla/console/src/Event/ConsoleEvent.php
vendored
Normal file
@ -0,0 +1,79 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Part of the Joomla Framework Console Package
|
||||
*
|
||||
* @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
|
||||
* @license GNU General Public License version 2 or later; see LICENSE
|
||||
*/
|
||||
|
||||
namespace Joomla\Console\Event;
|
||||
|
||||
use Joomla\Console\Application;
|
||||
use Joomla\Console\Command\AbstractCommand;
|
||||
use Joomla\Event\Event;
|
||||
|
||||
/**
|
||||
* Base event class for console events.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
class ConsoleEvent extends Event
|
||||
{
|
||||
/**
|
||||
* The active application.
|
||||
*
|
||||
* @var Application
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $application;
|
||||
|
||||
/**
|
||||
* The command being executed.
|
||||
*
|
||||
* @var AbstractCommand|null
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $command;
|
||||
|
||||
/**
|
||||
* Event constructor.
|
||||
*
|
||||
* @param string $name The event name.
|
||||
* @param Application $application The active application.
|
||||
* @param AbstractCommand|null $command The command being executed.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function __construct(string $name, Application $application, ?AbstractCommand $command = null)
|
||||
{
|
||||
parent::__construct($name);
|
||||
|
||||
$this->application = $application;
|
||||
$this->command = $command;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the active application.
|
||||
*
|
||||
* @return Application
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function getApplication(): Application
|
||||
{
|
||||
return $this->application;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the command being executed.
|
||||
*
|
||||
* @return AbstractCommand|null
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function getCommand(): ?AbstractCommand
|
||||
{
|
||||
return $this->command;
|
||||
}
|
||||
}
|
||||
72
libraries/vendor/joomla/console/src/Event/TerminateEvent.php
vendored
Normal file
72
libraries/vendor/joomla/console/src/Event/TerminateEvent.php
vendored
Normal file
@ -0,0 +1,72 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Part of the Joomla Framework Console Package
|
||||
*
|
||||
* @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
|
||||
* @license GNU General Public License version 2 or later; see LICENSE
|
||||
*/
|
||||
|
||||
namespace Joomla\Console\Event;
|
||||
|
||||
use Joomla\Console\Application;
|
||||
use Joomla\Console\Command\AbstractCommand;
|
||||
use Joomla\Console\ConsoleEvents;
|
||||
|
||||
/**
|
||||
* Event triggered immediately before the process is terminated.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
class TerminateEvent extends ConsoleEvent
|
||||
{
|
||||
/**
|
||||
* The exit code to use for the application.
|
||||
*
|
||||
* @var integer
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $exitCode;
|
||||
|
||||
/**
|
||||
* Event constructor.
|
||||
*
|
||||
* @param integer $exitCode The Throwable object with the error data.
|
||||
* @param Application $application The active application.
|
||||
* @param AbstractCommand|null $command The command being executed.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function __construct(int $exitCode, Application $application, ?AbstractCommand $command = null)
|
||||
{
|
||||
parent::__construct(ConsoleEvents::TERMINATE, $application, $command);
|
||||
|
||||
$this->exitCode = $exitCode;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the exit code.
|
||||
*
|
||||
* @return integer
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function getExitCode(): int
|
||||
{
|
||||
return $this->exitCode;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the exit code.
|
||||
*
|
||||
* @param integer $exitCode The command exit code.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function setExitCode(int $exitCode): void
|
||||
{
|
||||
$this->exitCode = $exitCode;
|
||||
}
|
||||
}
|
||||
21
libraries/vendor/joomla/console/src/Exception/NamespaceNotFoundException.php
vendored
Normal file
21
libraries/vendor/joomla/console/src/Exception/NamespaceNotFoundException.php
vendored
Normal file
@ -0,0 +1,21 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Part of the Joomla Framework Console Package
|
||||
*
|
||||
* @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
|
||||
* @license GNU General Public License version 2 or later; see LICENSE
|
||||
*/
|
||||
|
||||
namespace Joomla\Console\Exception;
|
||||
|
||||
use Symfony\Component\Console\Exception\CommandNotFoundException;
|
||||
|
||||
/**
|
||||
* Exception indicating a missing command namespace.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
class NamespaceNotFoundException extends CommandNotFoundException
|
||||
{
|
||||
}
|
||||
50
libraries/vendor/joomla/console/src/Helper/DescriptorHelper.php
vendored
Normal file
50
libraries/vendor/joomla/console/src/Helper/DescriptorHelper.php
vendored
Normal file
@ -0,0 +1,50 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Part of the Joomla Framework Console Package
|
||||
*
|
||||
* @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
|
||||
* @license GNU General Public License version 2 or later; see LICENSE
|
||||
*/
|
||||
|
||||
namespace Joomla\Console\Helper;
|
||||
|
||||
use Joomla\Console\Descriptor\TextDescriptor;
|
||||
use Symfony\Component\Console\Helper\Helper;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
|
||||
/**
|
||||
* Describes an object.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
class DescriptorHelper extends Helper
|
||||
{
|
||||
/**
|
||||
* Describes an object if supported.
|
||||
*
|
||||
* @param OutputInterface $output The output object to use.
|
||||
* @param object $object The object to describe.
|
||||
* @param array $options Options for the descriptor.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function describe(OutputInterface $output, $object, array $options = [])
|
||||
{
|
||||
(new TextDescriptor())->describe($output, $object, $options);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the canonical name of this helper.
|
||||
*
|
||||
* @return string The canonical name
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function getName()
|
||||
{
|
||||
return 'descriptor';
|
||||
}
|
||||
}
|
||||
97
libraries/vendor/joomla/console/src/Loader/ContainerLoader.php
vendored
Normal file
97
libraries/vendor/joomla/console/src/Loader/ContainerLoader.php
vendored
Normal file
@ -0,0 +1,97 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Part of the Joomla Framework Console Package
|
||||
*
|
||||
* @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
|
||||
* @license GNU General Public License version 2 or later; see LICENSE
|
||||
*/
|
||||
|
||||
namespace Joomla\Console\Loader;
|
||||
|
||||
use Joomla\Console\Command\AbstractCommand;
|
||||
use Psr\Container\ContainerInterface;
|
||||
use Symfony\Component\Console\Exception\CommandNotFoundException;
|
||||
|
||||
/**
|
||||
* PSR-11 compatible command loader.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
final class ContainerLoader implements LoaderInterface
|
||||
{
|
||||
/**
|
||||
* The service container.
|
||||
*
|
||||
* @var ContainerInterface
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $container;
|
||||
|
||||
/**
|
||||
* The command name to service ID map.
|
||||
*
|
||||
* @var string[]
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $commandMap;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param ContainerInterface $container A container from which to load command services.
|
||||
* @param array $commandMap An array with command names as keys and service IDs as values.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function __construct(ContainerInterface $container, array $commandMap)
|
||||
{
|
||||
$this->container = $container;
|
||||
$this->commandMap = $commandMap;
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads a command.
|
||||
*
|
||||
* @param string $name The command to load.
|
||||
*
|
||||
* @return AbstractCommand
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @throws CommandNotFoundException
|
||||
*/
|
||||
public function get(string $name): AbstractCommand
|
||||
{
|
||||
if (!$this->has($name)) {
|
||||
throw new CommandNotFoundException(sprintf('Command "%s" does not exist.', $name));
|
||||
}
|
||||
|
||||
return $this->container->get($this->commandMap[$name]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the names of the registered commands.
|
||||
*
|
||||
* @return string[]
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function getNames(): array
|
||||
{
|
||||
return array_keys($this->commandMap);
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if a command exists.
|
||||
*
|
||||
* @param string $name The command to check.
|
||||
*
|
||||
* @return boolean
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function has($name): bool
|
||||
{
|
||||
return isset($this->commandMap[$name]) && $this->container->has($this->commandMap[$name]);
|
||||
}
|
||||
}
|
||||
53
libraries/vendor/joomla/console/src/Loader/LoaderInterface.php
vendored
Normal file
53
libraries/vendor/joomla/console/src/Loader/LoaderInterface.php
vendored
Normal file
@ -0,0 +1,53 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Part of the Joomla Framework Console Package
|
||||
*
|
||||
* @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
|
||||
* @license GNU General Public License version 2 or later; see LICENSE
|
||||
*/
|
||||
|
||||
namespace Joomla\Console\Loader;
|
||||
|
||||
use Joomla\Console\Command\AbstractCommand;
|
||||
use Symfony\Component\Console\Exception\CommandNotFoundException;
|
||||
|
||||
/**
|
||||
* Interface defining a command loader.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
interface LoaderInterface
|
||||
{
|
||||
/**
|
||||
* Loads a command.
|
||||
*
|
||||
* @param string $name The command to load.
|
||||
*
|
||||
* @return AbstractCommand
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @throws CommandNotFoundException
|
||||
*/
|
||||
public function get(string $name): AbstractCommand;
|
||||
|
||||
/**
|
||||
* Get the names of the registered commands.
|
||||
*
|
||||
* @return string[]
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function getNames(): array;
|
||||
|
||||
/**
|
||||
* Checks if a command exists.
|
||||
*
|
||||
* @param string $name The command to check.
|
||||
*
|
||||
* @return boolean
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function has($name): bool;
|
||||
}
|
||||
Reference in New Issue
Block a user