Merge branch 'develop-ascraeus' into develop

* develop-ascraeus:
  [ticket/12655] Set register_container_commands as public
  [ticket/12655] Don't try to restore the definition in the help
  [ticket/12655] Fix coding style
  [ticket/12655] Make the --shell option available only for phpbbcli.php
  [ticket/12655] Fix coding style in \phpbb\console\application
  [ticket/12655] Set the arguments of \phpbb\console\application as required
  [ticket/12655] Don't require acp/common again in the commands
  [ticket/12655] Run the shell when --shell is used
This commit is contained in:
Andreas Fischer 2014-06-06 19:49:30 +02:00
commit 9e00aef34a
5 changed files with 86 additions and 4 deletions

View file

@ -39,6 +39,9 @@ $phpbb_container = phpbb_create_update_container($phpbb_root_path, $phpEx, "$php
$phpbb_container->get('request')->enable_super_globals(); $phpbb_container->get('request')->enable_super_globals();
require($phpbb_root_path . 'includes/compatibility_globals.' . $phpEx); require($phpbb_root_path . 'includes/compatibility_globals.' . $phpEx);
$application = new \phpbb\console\application('phpBB Console', PHPBB_VERSION); $user = $phpbb_container->get('user');
$user->add_lang('acp/common');
$application = new \phpbb\console\application('phpBB Console', PHPBB_VERSION, $user);
$application->register_container_commands($phpbb_container); $application->register_container_commands($phpbb_container);
$application->run(); $application->run();

View file

@ -227,6 +227,8 @@ $lang = array_merge($lang, array(
'CLI_DESCRIPTION_CRON_RUN' => 'Runs all ready cron tasks.', 'CLI_DESCRIPTION_CRON_RUN' => 'Runs all ready cron tasks.',
'CLI_DESCRIPTION_CRON_RUN_ARGUMENT_1' => 'Name of the task to be run', 'CLI_DESCRIPTION_CRON_RUN_ARGUMENT_1' => 'Name of the task to be run',
'CLI_DESCRIPTION_OPTION_SHELL' => 'Launch the shell.',
'COLOUR_SWATCH' => 'Web-safe colour swatch', 'COLOUR_SWATCH' => 'Web-safe colour swatch',
'CONFIG_UPDATED' => 'Configuration updated successfully.', 'CONFIG_UPDATED' => 'Configuration updated successfully.',
'CRON_LOCK_ERROR' => 'Could not obtain cron lock.', 'CRON_LOCK_ERROR' => 'Could not obtain cron lock.',

View file

@ -13,15 +13,93 @@
namespace phpbb\console; namespace phpbb\console;
use Symfony\Component\Console\Shell;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\DependencyInjection\TaggedContainerInterface; use Symfony\Component\DependencyInjection\TaggedContainerInterface;
class application extends \Symfony\Component\Console\Application class application extends \Symfony\Component\Console\Application
{ {
function register_container_commands(TaggedContainerInterface $container, $tag = 'console.command') /**
* @var bool Indicates whether or not we are in a shell
*/
protected $in_shell = false;
/**
* @var \phpbb\user User object
*/
protected $user;
/**
* @param string $name The name of the application
* @param string $version The version of the application
* @param \phpbb\user $user The user which runs the application (used for translation)
*/
public function __construct($name, $version, \phpbb\user $user)
{
parent::__construct($name, $version);
$this->user = $user;
}
/**
* Gets the help message.
*
* It's a hack of the default help message to display the --shell
* option only for the application and not for all the commands.
*
* @return string A help message.
*/
public function getHelp()
{
// If we are already in a shell
// we do not want to have the --shell option available
if ($this->in_shell)
{
return parent::getHelp();
}
$this->getDefinition()->addOption(new InputOption(
'--shell',
'-s',
InputOption::VALUE_NONE,
$this->user->lang('CLI_DESCRIPTION_OPTION_SHELL')
));
return parent::getHelp();
}
/**
* Register a set of commands from the container
*
* @param TaggedContainerInterface $container The container
* @param string $tag The tag used to register the commands
*/
public function register_container_commands(TaggedContainerInterface $container, $tag = 'console.command')
{ {
foreach($container->findTaggedServiceIds($tag) as $id => $void) foreach($container->findTaggedServiceIds($tag) as $id => $void)
{ {
$this->add($container->get($id)); $this->add($container->get($id));
} }
} }
/**
* {@inheritdoc}
*/
public function doRun(InputInterface $input, OutputInterface $output)
{
// Run a shell if the --shell (or -s) option is set and if no command name is specified
// Also, we do not want to have the --shell option available if we are already in a shell
if (!$this->in_shell && $this->getCommandName($input) === null && $input->hasParameterOption(array('--shell', '-s')))
{
$shell = new Shell($this);
$this->in_shell = true;
$shell->run();
return 0;
}
return parent::doRun($input, $output);
}
} }

View file

@ -43,7 +43,6 @@ class purge extends \phpbb\console\command\command
$this->log = $log; $this->log = $log;
$this->user = $user; $this->user = $user;
$this->config = $config; $this->config = $config;
$this->user->add_lang(array('acp/common'));
parent::__construct(); parent::__construct();
} }

View file

@ -43,7 +43,7 @@ class migrate extends \phpbb\console\command\command
$this->cache = $cache; $this->cache = $cache;
$this->log = $log; $this->log = $log;
$this->user = $user; $this->user = $user;
$this->user->add_lang(array('common', 'acp/common', 'install', 'migrator')); $this->user->add_lang(array('common', 'install', 'migrator'));
parent::__construct(); parent::__construct();
} }