diff options
| author | LEZY Thomas <thomas.gif.91@gmail.com> | 2014-05-28 12:20:02 +0200 |
|---|---|---|
| committer | LEZY Thomas <thomas.gif.91@gmail.com> | 2014-05-28 12:20:02 +0200 |
| commit | 8a1e189970c57364a3192296546717d70fbdd2d4 (patch) | |
| tree | e86c9870b54b432ef2071cae427132beb0bb3286 /phpBB/phpbb/console/command/cron | |
| parent | 50cb9d583845bb99c94355266705e25994770622 (diff) | |
| download | forums-8a1e189970c57364a3192296546717d70fbdd2d4.tar forums-8a1e189970c57364a3192296546717d70fbdd2d4.tar.gz forums-8a1e189970c57364a3192296546717d70fbdd2d4.tar.bz2 forums-8a1e189970c57364a3192296546717d70fbdd2d4.tar.xz forums-8a1e189970c57364a3192296546717d70fbdd2d4.zip | |
[ticket/12597] Add doc blocs in execute_all.php
PHPBB3-12597
Diffstat (limited to 'phpBB/phpbb/console/command/cron')
| -rw-r--r-- | phpBB/phpbb/console/command/cron/execute_all.php | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/phpBB/phpbb/console/command/cron/execute_all.php b/phpBB/phpbb/console/command/cron/execute_all.php index 6f061212ae..bc46fbe81b 100644 --- a/phpBB/phpbb/console/command/cron/execute_all.php +++ b/phpBB/phpbb/console/command/cron/execute_all.php @@ -23,6 +23,14 @@ class execute_all extends \phpbb\console\command\command /** @var \phpbb\user */ protected $user; + /** + * Construct method + * + * @param \phpbb\cron\manager $cron_manager The cron manager containing + * the cron tasks to be executed. + * @param \phpbb\lock\db $lock_db The lock for accessing database. + * @param \phobb\user $user The user object (used to get language information) + */ public function __construct(\phpbb\cron\manager $cron_manager, \phpbb\lock\db $lock_db, \phpbb\user $user) { $this->cron_manager = $cron_manager; @@ -31,6 +39,11 @@ class execute_all extends \phpbb\console\command\command parent::__construct(); } + /** + * Sets the command name and description + * + * @return null + */ protected function configure() { $this @@ -39,6 +52,16 @@ class execute_all extends \phpbb\console\command\command ; } + /** + * Executes the function. Each cron tasks is executed. + * If option "--verbose" is not seted, there will be no output in case of + * successful execution. + * + * @param InputInterface input The input stream, unused here + * @param OutputInterface output The output stream, used for printig verbose-mode + * and error information. + * @return null + */ protected function execute(InputInterface $input, OutputInterface $output) { if ($this->lock_db->acquire()) |