[ticket/12039] Use an abstract class and some more minor adjustments

PHPBB3-12039

phpBB/config/console.yml

@@ -13,6 +13,13 @@ services:
         tags:
             - { name: console.command }
 
+    console.command.config.get:
+        class: phpbb\console\command\config\get
+        arguments:
+            - @config
+        tags:
+            - { name: console.command }
+
     console.command.config.set:
         class: phpbb\console\command\config\set
         arguments:

phpBB/phpbb/console/command/config/command.php

@@ -0,0 +1,22 @@
+<?php
+/**
+*
+* @package phpBB3
+* @copyright (c) 2013 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+namespace phpbb\console\command\config;
+
+abstract class command extends \phpbb\console\command\command
+{
+	/** @var \phpbb\config\config */
+	protected $config;
+
+	function __construct(\phpbb\config\config $config)
+	{
+		$this->config = $config;
+
+		parent::__construct();
+	}
+}

phpBB/phpbb/console/command/config/delete.php

@@ -10,46 +10,29 @@ namespace phpbb\console\command\config;
 
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
-class delete extends \phpbb\console\command\command
+class delete extends command
 {
-	/** @var \phpbb\config\config */
-	protected $config;
-
-	function __construct(\phpbb\config\config $config)
-	{
-		$this->config = $config;
-
-		parent::__construct();
-	}
-
 	protected function configure()
 	{
 		$this
 			->setName('config:delete')
-			->setDescription('Sets a configuration option\'s value')
+			->setDescription("Sets a configuration option's value")
 			->addArgument(
-				'config-key',
+				'key',
 				InputArgument::REQUIRED,
-				'The configuration option\'s name'
+				"The configuration option's name"
-			)
-			->addArgument(
-				'use-cache',
-				InputArgument::OPTIONAL,
-				'Whether this variable should be cached or if it changes too frequently to be efficiently cached.',
-				true
 			)
 		;
 	}
 
 	protected function execute(InputInterface $input, OutputInterface $output)
 	{
-		$key = $input->getArgument('config-key');
+		$key = $input->getArgument('key');
-		$use_cache = $input->getArgument('use-cache');
-		$use_cache = (strtolower($use_cache) !== 'false' && $use_cache);
 
-		$this->config->delete($key, $use_cache);
+		$this->config->delete($key);
 
 		$output->writeln("<info>Successfully deleted config $key</info>");
 	}

phpBB/phpbb/console/command/config/get.php

@@ -0,0 +1,44 @@
+<?php
+/**
+*
+* @package phpBB3
+* @copyright (c) 2013 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+namespace phpbb\console\command\config;
+
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class get extends command
+{
+	protected function configure()
+	{
+		$this
+			->setName('config:get')
+			->setDescription("Gets a configuration option's value")
+			->addArgument(
+				'key',
+				InputArgument::REQUIRED,
+				"The configuration option's name"
+			)
+		;
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output)
+	{
+		$key = $input->getArgument('key');
+
+		if (isset($this->config[$key]))
+		{
+			$output->writeln("<info>{$this->config[$key]}</info>");
+		}
+		else
+		{
+			$output->writeln("<error>Could not get config $key</error>");
+		}
+	}
+}

phpBB/phpbb/console/command/config/increment.php

@@ -10,50 +10,40 @@ namespace phpbb\console\command\config;
 
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
-class increment extends \phpbb\console\command\command
+class increment extends command
 {
-	/** @var \phpbb\config\config */
-	protected $config;
-
-	function __construct(\phpbb\config\config $config)
-	{
-		$this->config = $config;
-
-		parent::__construct();
-	}
-
 	protected function configure()
 	{
 		$this
 			->setName('config:increment')
-			->setDescription('Sets a configuration option\'s value')
+			->setDescription("Sets a configuration option's value")
 			->addArgument(
-				'config-key',
+				'key',
 				InputArgument::REQUIRED,
-				'The configuration option\'s name'
+				"The configuration option's name"
 			)
 			->addArgument(
 				'increment',
 				InputArgument::REQUIRED,
 				'Amount to increment by'
 			)
-			->addArgument(
+			->addOption(
-				'use-cache',
+				'dynamic',
-				InputArgument::OPTIONAL,
+				'd',
-				'Whether this variable should be cached or if it changes too frequently to be efficiently cached.',
+				InputOption::VALUE_NONE,
-				true
+				'Set this option if the configuration option changes too frequently to be efficiently cached.'
 			)
 		;
 	}
 
 	protected function execute(InputInterface $input, OutputInterface $output)
 	{
-		$key = $input->getArgument('config-key');
+		$key = $input->getArgument('key');
 		$increment = $input->getArgument('increment');
-		$use_cache = $input->getArgument('use-cache');
+		$use_cache = !$input->getOption('dynamic');
-		$use_cache = (strtolower($use_cache) !== 'false' && $use_cache);
 
 		$this->config->increment($key, $increment, $use_cache);
 

phpBB/phpbb/console/command/config/set.php

@@ -10,51 +10,42 @@ namespace phpbb\console\command\config;
 
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
-class set extends \phpbb\console\command\command
+class set extends command
 {
-	/** @var \phpbb\config\config */
-	protected $config;
-
-	function __construct(\phpbb\config\config $config)
-	{
-		$this->config = $config;
-
-		parent::__construct();
-	}
-
 	protected function configure()
 	{
 		$this
 			->setName('config:set')
-			->setDescription('Sets a configuration option\'s value')
+			->setDescription("Sets a configuration option's value")
 			->addArgument(
-				'config-key',
+				'key',
 				InputArgument::REQUIRED,
-				'The configuration option\'s name'
+				"The configuration option's name"
 			)
 			->addArgument(
-				'config-value',
+				'value',
 				InputArgument::REQUIRED,
-				'New configuration value'
+				'New configuration value, use 0 and 1 to specify boolean values'
 			)
-			->addArgument(
+			->addOption(
-				'use-cache',
+				'dynamic',
-				InputArgument::OPTIONAL,
+				'd',
-				'Whether this variable should be cached or if it changes too frequently to be efficiently cached.',
+				InputOption::VALUE_NONE,
-				true
+				'Set this option if the configuration option changes too frequently to be efficiently cached.'
 			)
 		;
 	}
 
 	protected function execute(InputInterface $input, OutputInterface $output)
 	{
-		$key = $input->getArgument('config-key');
+		$key = $input->getArgument('key');
-		$value = $input->getArgument('config-value');
+		$value = $input->getArgument('value');
-		$use_cache = $input->getArgument('use-cache');
+		$use_cache = !$input->getOption('dynamic');
-		$use_cache = (strtolower($use_cache) !== 'false' && $use_cache);
 
+		var_dump($key, $value, $use_cache);
 		$this->config->set($key, $value, $use_cache);
 
 		$output->writeln("<info>Successfully set config $key</info>");

phpBB/phpbb/console/command/config/set_atomic.php

@@ -10,56 +10,46 @@ namespace phpbb\console\command\config;
 
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
-class set_atomic extends \phpbb\console\command\command
+class set_atomic extends command
 {
-	/** @var \phpbb\config\config */
-	protected $config;
-
-	function __construct(\phpbb\config\config $config)
-	{
-		$this->config = $config;
-
-		parent::__construct();
-	}
-
 	protected function configure()
 	{
 		$this
 			->setName('config:set-atomic')
-			->setDescription('Sets a configuration option\'s value')
+			->setDescription("Sets a configuration option's value")
 			->addArgument(
-				'config-key',
+				'key',
 				InputArgument::REQUIRED,
-				'The configuration option\'s name'
+				"The configuration option's name"
 			)
 			->addArgument(
-				'old-value',
+				'old',
 				InputArgument::REQUIRED,
-				'Current configuration value'
+				'Current configuration value, use 0 and 1 to specify boolean values'
 			)
 			->addArgument(
-				'new-value',
+				'new',
 				InputArgument::REQUIRED,
-				'New configuration value'
+				'New configuration value, use 0 and 1 to specify boolean values'
 			)
-			->addArgument(
+			->addOption(
-				'use-cache',
+				'dynamic',
-				InputArgument::OPTIONAL,
+				'd',
-				'Whether this variable should be cached or if it changes too frequently to be efficiently cached.',
+				InputOption::VALUE_NONE,
-				true
+				'Set this option if the configuration option changes too frequently to be efficiently cached.'
 			)
 		;
 	}
 
 	protected function execute(InputInterface $input, OutputInterface $output)
 	{
-		$key = $input->getArgument('config-key');
+		$key = $input->getArgument('key');
-		$old_value = $input->getArgument('old-value');
+		$old_value = $input->getArgument('old');
-		$new_value = $input->getArgument('new-value');
+		$new_value = $input->getArgument('new');
-		$use_cache = $input->getArgument('use-cache');
+		$use_cache = !$input->getOption('dynamic');
-		$use_cache = (strtolower($use_cache) !== 'false' && $use_cache);
 
 		if ($this->config->set_atomic($key, $old_value, $new_value, $use_cache))
 		{