From 48b19ac37c8494f798f101f1964c6eb9996c2165 Mon Sep 17 00:00:00 2001
From: Tristan Darricau <github@nicofuma.fr>
Date: Sun, 15 Jun 2014 12:18:55 +0200
Subject: [ticket/12715] Update console command cache:purge comments

PHPBB3-12715
---
 phpBB/phpbb/console/command/cache/purge.php | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

(limited to 'phpBB/phpbb/console/command/cache')

diff --git a/phpBB/phpbb/console/command/cache/purge.php b/phpBB/phpbb/console/command/cache/purge.php
index 50953185a4..379d2aa1ca 100644
--- a/phpBB/phpbb/console/command/cache/purge.php
+++ b/phpBB/phpbb/console/command/cache/purge.php
@@ -35,6 +35,16 @@ class purge extends \phpbb\console\command\command
 	/** @var \phpbb\config\config */
 	protected $config;
 
+	/**
+	* Constructor
+	*
+	* @param \phpbb\cache\driver\driver_interface	$cache	Cache instance
+	* @param \phpbb\db\driver\driver_interface		$db		Database connection
+	* @param \phpbb\auth\auth						$auth	Auth instance
+	* @param \phpbb\log\log							$log	Logger instance
+	* @param \phpbb\user							$user	User instance
+	* @param \phpbb\config\config					$config	Config instance
+	*/
 	public function __construct(\phpbb\cache\driver\driver_interface $cache, \phpbb\db\driver\driver_interface $db, \phpbb\auth\auth $auth, \phpbb\log\log $log, \phpbb\user $user, \phpbb\config\config $config)
 	{
 		$this->cache = $cache;
@@ -46,6 +56,9 @@ class purge extends \phpbb\console\command\command
 		parent::__construct();
 	}
 
+	/**
+	* {@inheritdoc}
+	*/
 	protected function configure()
 	{
 		$this
@@ -54,6 +67,16 @@ class purge extends \phpbb\console\command\command
 		;
 	}
 
+	/**
+	* Executes the command cache:purge.
+	*
+	* Purge the cache (including permissions) and increment the asset_version number
+	*
+	* @param InputInterface  $input  An InputInterface instance
+	* @param OutputInterface $output An OutputInterface instance
+	*
+	* @return null
+	*/
 	protected function execute(InputInterface $input, OutputInterface $output)
 	{
 		$this->config->increment('assets_version', 1);
-- 
cgit v1.2.1