makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-27 21:58:52 +00:00
Code Issues Projects Releases Packages Wiki Activity

[ticket/12715] Update console command config:* comments

Browse source 
PHPBB3-12715
This commit is contained in:
Tristan Darricau 2014-06-15 12:19:24 +02:00
parent 48b19ac37c
commit 413754af1f
5 changed files with 71 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
phpBB/phpbb/console/command/config/delete.php
View file

@ -14,11 +14,13 @@ namespace phpbb\console\command\config;
use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Output\OutputInterface;
class delete extends command class delete extends command
{ {
/**
* {@inheritdoc}
*/
protected function configure() protected function configure()
{ {
$this $this
@ -32,6 +34,17 @@ class delete extends command
; ;
} }
/**
* Executes the command config:delete.
*
* Removes a configuration option
*
* @param InputInterface $input An InputInterface instance
* @param OutputInterface $output An OutputInterface instance
*
* @return null
* @see \phpbb\config\config::delete()
*/
protected function execute(InputInterface $input, OutputInterface $output) protected function execute(InputInterface $input, OutputInterface $output)
{ {
$key = $input->getArgument('key'); $key = $input->getArgument('key');

14
phpBB/phpbb/console/command/config/get.php
View file

@ -19,6 +19,9 @@ use Symfony\Component\Console\Output\OutputInterface;
class get extends command class get extends command
{ {
/**
* {@inheritdoc}
*/
protected function configure() protected function configure()
{ {
$this $this
@ -38,6 +41,17 @@ class get extends command
; ;
} }
/**
* Executes the command config:get.
*
* Retrieves a configuration value.
*
* @param InputInterface $input An InputInterface instance
* @param OutputInterface $output An OutputInterface instance
*
* @return null
* @see \phpbb\config\config::offsetGet()
*/
protected function execute(InputInterface $input, OutputInterface $output) protected function execute(InputInterface $input, OutputInterface $output)
{ {
$key = $input->getArgument('key'); $key = $input->getArgument('key');

14
phpBB/phpbb/console/command/config/increment.php
View file

@ -19,6 +19,9 @@ use Symfony\Component\Console\Output\OutputInterface;
class increment extends command class increment extends command
{ {
/**
* {@inheritdoc}
*/
protected function configure() protected function configure()
{ {
$this $this
@ -43,6 +46,17 @@ class increment extends command
; ;
} }
/**
* Executes the command config:increment.
*
* Increments an integer configuration value.
*
* @param InputInterface $input An InputInterface instance
* @param OutputInterface $output An OutputInterface instance
*
* @return null
* @see \phpbb\config\config::increment()
*/
protected function execute(InputInterface $input, OutputInterface $output) protected function execute(InputInterface $input, OutputInterface $output)
{ {
$key = $input->getArgument('key'); $key = $input->getArgument('key');

14
phpBB/phpbb/console/command/config/set.php
View file

@ -19,6 +19,9 @@ use Symfony\Component\Console\Output\OutputInterface;
class set extends command class set extends command
{ {
/**
* {@inheritdoc}
*/
protected function configure() protected function configure()
{ {
$this $this
@ -43,6 +46,17 @@ class set extends command
; ;
} }
/**
* Executes the command config:set.
*
* Sets a configuration option's value.
*
* @param InputInterface $input An InputInterface instance
* @param OutputInterface $output An OutputInterface instance
*
* @return null
* @see \phpbb\config\config::set()
*/
protected function execute(InputInterface $input, OutputInterface $output) protected function execute(InputInterface $input, OutputInterface $output)
{ {
$key = $input->getArgument('key'); $key = $input->getArgument('key');

15
phpBB/phpbb/console/command/config/set_atomic.php
View file

@ -19,6 +19,9 @@ use Symfony\Component\Console\Output\OutputInterface;
class set_atomic extends command class set_atomic extends command
{ {
/**
* {@inheritdoc}
*/
protected function configure() protected function configure()
{ {
$this $this
@ -48,6 +51,18 @@ class set_atomic extends command
; ;
} }
/**
* Executes the command config:set-atomic.
*
* Sets a configuration option's value only if the old_value matches the
* current configuration value or the configuration value does not exist yet.
*
* @param InputInterface $input An InputInterface instance
* @param OutputInterface $output An OutputInterface instance
*
* @return bool True if the value was changed, false otherwise.
* @see \phpbb\config\config::set_atomic()
*/
protected function execute(InputInterface $input, OutputInterface $output) protected function execute(InputInterface $input, OutputInterface $output)
{ {
$key = $input->getArgument('key'); $key = $input->getArgument('key');