[ticket/12039] Add config:* to the command line interface tool

PHPBB3-12039

phpBB/config/console.yml

@@ -1,4 +1,32 @@
 services:
+    console.command.config.delete:
+        class: phpbb\console\command\config\delete
+        arguments:
+            - @config
+        tags:
+            - { name: console.command }
+
+    console.command.config.increment:
+        class: phpbb\console\command\config\increment
+        arguments:
+            - @config
+        tags:
+            - { name: console.command }
+
+    console.command.config.set:
+        class: phpbb\console\command\config\set
+        arguments:
+            - @config
+        tags:
+            - { name: console.command }
+
+    console.command.config.set_atomic:
+        class: phpbb\console\command\config\set_atomic
+        arguments:
+            - @config
+        tags:
+            - { name: console.command }
+
     console.command.extension.disable:
         class: phpbb\console\command\extension\disable
         arguments:

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

@@ -0,0 +1,56 @@
+<?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\Output\OutputInterface;
+
+class delete extends \phpbb\console\command\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')
+			->addArgument(
+				'config-key',
+				InputArgument::REQUIRED,
+				'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');
+		$use_cache = $input->getArgument('use-cache');
+		$use_cache = (strtolower($use_cache) !== 'false' && $use_cache);
+
+		$this->config->delete($key, $use_cache);
+
+		$output->writeln("<info>Successfully deleted config $key</info>");
+	}
+}

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

@@ -0,0 +1,62 @@
+<?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\Output\OutputInterface;
+
+class increment extends \phpbb\console\command\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')
+			->addArgument(
+				'config-key',
+				InputArgument::REQUIRED,
+				'The configuration option\'s name'
+			)
+			->addArgument(
+				'increment',
+				InputArgument::REQUIRED,
+				'Amount to increment by'
+			)
+			->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');
+		$increment = $input->getArgument('increment');
+		$use_cache = $input->getArgument('use-cache');
+		$use_cache = (strtolower($use_cache) !== 'false' && $use_cache);
+
+		$this->config->increment($key, $increment, $use_cache);
+
+		$output->writeln("<info>Successfully incremented config $key</info>");
+	}
+}

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

@@ -0,0 +1,62 @@
+<?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\Output\OutputInterface;
+
+class set extends \phpbb\console\command\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')
+			->addArgument(
+				'config-key',
+				InputArgument::REQUIRED,
+				'The configuration option\'s name'
+			)
+			->addArgument(
+				'config-value',
+				InputArgument::REQUIRED,
+				'New configuration value'
+			)
+			->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');
+		$value = $input->getArgument('config-value');
+		$use_cache = $input->getArgument('use-cache');
+		$use_cache = (strtolower($use_cache) !== 'false' && $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

@@ -0,0 +1,75 @@
+<?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\Output\OutputInterface;
+
+class set_atomic extends \phpbb\console\command\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')
+			->addArgument(
+				'config-key',
+				InputArgument::REQUIRED,
+				'The configuration option\'s name'
+			)
+			->addArgument(
+				'old-value',
+				InputArgument::REQUIRED,
+				'Current configuration value'
+			)
+			->addArgument(
+				'new-value',
+				InputArgument::REQUIRED,
+				'New configuration value'
+			)
+			->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');
+		$old_value = $input->getArgument('old-value');
+		$new_value = $input->getArgument('new-value');
+		$use_cache = $input->getArgument('use-cache');
+		$use_cache = (strtolower($use_cache) !== 'false' && $use_cache);
+
+		if ($this->config->set_atomic($key, $old_value, $new_value, $use_cache))
+		{
+			$output->writeln("<info>Successfully set config $key</info>");
+			return 0;
+		}
+		else
+		{
+			$output->writeln("<error>Could not set config $key</error>");
+			return 1;
+		}
+	}
+}