11 files changed, 95 insertions, 167 deletions
diff --git a/phpBB/phpbb/cache/driver/apc.php b/phpBB/phpbb/cache/driver/apc.php
index ce72ec6134..77b7b11181 100644
--- a/phpBB/phpbb/cache/driver/apc.php
+++ b/phpBB/phpbb/cache/driver/apc.php
@@ -10,14 +10,6 @@
 namespace phpbb\cache\driver;
 
 /**
-* @ignore
-*/
-if (!defined('IN_PHPBB'))
-{
-	exit;
-}
-
-/**
 * ACM for APC
 * @package acm
 */
@@ -26,9 +18,7 @@ class apc extends \phpbb\cache\driver\memory
 	var $extension = 'apc';
 
 	/**
-	* Purge cache data
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
diff --git a/phpBB/phpbb/cache/driver/base.php b/phpBB/phpbb/cache/driver/base.php
index 90185a00d2..feaca25a5b 100644
--- a/phpBB/phpbb/cache/driver/base.php
+++ b/phpBB/phpbb/cache/driver/base.php
@@ -10,14 +10,6 @@
 namespace phpbb\cache\driver;
 
 /**
-* @ignore
-*/
-if (!defined('IN_PHPBB'))
-{
-	exit;
-}
-
-/**
 * @package acm
 */
 abstract class base implements \phpbb\cache\driver\driver_interface
diff --git a/phpBB/phpbb/cache/driver/driver_interface.php b/phpBB/phpbb/cache/driver/driver_interface.php
index 34c60b5935..8929647411 100644
--- a/phpBB/phpbb/cache/driver/driver_interface.php
+++ b/phpBB/phpbb/cache/driver/driver_interface.php
@@ -10,14 +10,6 @@
 namespace phpbb\cache\driver;
 
 /**
-* @ignore
-*/
-if (!defined('IN_PHPBB'))
-{
-	exit;
-}
-
-/**
 * An interface that all cache drivers must implement
 *
 * @package acm
@@ -26,46 +18,73 @@ interface driver_interface
 {
 	/**
 	* Load global cache
+	*
+	* @return mixed False if an error was encountered, otherwise the data type of the cached data
 	*/
 	public function load();
 
 	/**
 	* Unload cache object
+	*
+	* @return null
 	*/
 	public function unload();
 
 	/**
 	* Save modified objects
+	*
+	* @return null
 	*/
 	public function save();
 
 	/**
 	* Tidy cache
+	*
+	* @return null
 	*/
 	public function tidy();
 
 	/**
 	* Get saved cache object
+	*
+	* @param string $var_name 		Cache key
+	* @return mixed 				False if an error was encountered, otherwise the saved cached object
 	*/
 	public function get($var_name);
 
 	/**
 	* Put data into cache
+	*
+	* @param string $var_name 		Cache key
+	* @param mixed $var 			Cached data to store
+	* @param int $ttl 				Time-to-live of cached data
+	* @return null
 	*/
 	public function put($var_name, $var, $ttl = 0);
 
 	/**
 	* Purge cache data
+	*
+	* @return null
 	*/
 	public function purge();
 
 	/**
 	* Destroy cache data
+	*
+	* @param string $var_name 		Cache key
+	* @param string $table 			Table name
+	* @return null
 	*/
 	public function destroy($var_name, $table = '');
 
 	/**
 	* Check if a given cache entry exists
+	*
+	* @param string $var_name 		Cache key
+	*
+	* @return bool 					True if cache file exists and has not expired.
+	*								False otherwise.
 	*/
 	public function _exists($var_name);
 
@@ -87,7 +106,7 @@ interface driver_interface
 	* result to persistent storage. In other words, there is no need
 	* to call save() afterwards.
 	*
-	* @param \phpbb\db\driver\driver $db	Database connection
+	* @param \phpbb\db\driver\driver_interface $db	Database connection
 	* @param string $query			SQL query, should be used for generating storage key
 	* @param mixed $query_result	The result from \dbal::sql_query, to be passed to
 	* 								\dbal::sql_fetchrow to get all rows and store them
@@ -98,7 +117,7 @@ interface driver_interface
 	* 								representing the query should be returned. Otherwise
 	* 								the original $query_result should be returned.
 	*/
-	public function sql_save(\phpbb\db\driver\driver $db, $query, $query_result, $ttl);
+	public function sql_save(\phpbb\db\driver\driver_interface $db, $query, $query_result, $ttl);
 
 	/**
 	* Check if result for a given SQL query exists in cache.
diff --git a/phpBB/phpbb/cache/driver/eaccelerator.php b/phpBB/phpbb/cache/driver/eaccelerator.php
index 72c0d77d02..d1ad69ef6d 100644
--- a/phpBB/phpbb/cache/driver/eaccelerator.php
+++ b/phpBB/phpbb/cache/driver/eaccelerator.php
@@ -10,14 +10,6 @@
 namespace phpbb\cache\driver;
 
 /**
-* @ignore
-*/
-if (!defined('IN_PHPBB'))
-{
-	exit;
-}
-
-/**
 * ACM for eAccelerator
 * @package acm
 * @todo Missing locks from destroy() talk with David
@@ -30,9 +22,7 @@ class eaccelerator extends \phpbb\cache\driver\memory
 	var $serialize_header = '#phpbb-serialized#';
 
 	/**
-	* Purge cache data
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
@@ -47,10 +37,8 @@ class eaccelerator extends \phpbb\cache\driver\memory
 	}
 
 	/**
-	 * Perform cache garbage collection
-	 *
-	 * @return null
-	 */
+	* {@inheritDoc}
+	*/
 	function tidy()
 	{
 		eaccelerator_gc();
diff --git a/phpBB/phpbb/cache/driver/file.php b/phpBB/phpbb/cache/driver/file.php
index a64232400b..286ba328c3 100644
--- a/phpBB/phpbb/cache/driver/file.php
+++ b/phpBB/phpbb/cache/driver/file.php
@@ -10,14 +10,6 @@
 namespace phpbb\cache\driver;
 
 /**
-* @ignore
-*/
-if (!defined('IN_PHPBB'))
-{
-	exit;
-}
-
-/**
 * ACM File Based Caching
 * @package acm
 */
@@ -41,7 +33,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Load global cache
+	* {@inheritDoc}
 	*/
 	function load()
 	{
@@ -49,7 +41,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Unload cache object
+	* {@inheritDoc}
 	*/
 	function unload()
 	{
@@ -66,7 +58,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Save modified objects
+	* {@inheritDoc}
 	*/
 	function save()
 	{
@@ -101,7 +93,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Tidy cache
+	* {@inheritDoc}
 	*/
 	function tidy()
 	{
@@ -163,7 +155,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Get saved cache object
+	* {@inheritDoc}
 	*/
 	function get($var_name)
 	{
@@ -185,7 +177,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Put data into cache
+	* {@inheritDoc}
 	*/
 	function put($var_name, $var, $ttl = 31536000)
 	{
@@ -202,7 +194,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Purge cache data
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
@@ -288,7 +280,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Destroy cache data
+	* {@inheritDoc}
 	*/
 	function destroy($var_name, $table = '')
 	{
@@ -367,7 +359,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Check if a given cache entry exist
+	* {@inheritDoc}
 	*/
 	function _exists($var_name)
 	{
@@ -393,7 +385,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Load cached sql query
+	* {@inheritDoc}
 	*/
 	function sql_load($query)
 	{
@@ -415,7 +407,7 @@ class file extends \phpbb\cache\driver\base
 	/**
 	* {@inheritDoc}
 	*/
-	function sql_save(\phpbb\db\driver\driver $db, $query, $query_result, $ttl)
+	function sql_save(\phpbb\db\driver\driver_interface $db, $query, $query_result, $ttl)
 	{
 		// Remove extra spaces and tabs
 		$query = preg_replace('/[\n\r\s\t]+/', ' ', $query);
@@ -439,7 +431,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Ceck if a given sql query exist in cache
+	* {@inheritDoc}
 	*/
 	function sql_exists($query_id)
 	{
@@ -447,7 +439,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Fetch row from cache (database)
+	* {@inheritDoc}
 	*/
 	function sql_fetchrow($query_id)
 	{
@@ -460,7 +452,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Fetch a field from the current row of a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_fetchfield($query_id, $field)
 	{
@@ -473,7 +465,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Seek a specific row in an a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_rowseek($rownum, $query_id)
 	{
@@ -487,7 +479,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Free memory used for a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_freeresult($query_id)
 	{
@@ -766,6 +758,10 @@ class file extends \phpbb\cache\driver\base
 
 	/**
 	* Removes/unlinks file
+	*
+	* @param string $filename Filename to remove
+	* @param bool $check Check file permissions
+	* @return bool True if the file was successfully removed, otherwise false
 	*/
 	function remove_file($filename, $check = false)
 	{
diff --git a/phpBB/phpbb/cache/driver/memcache.php b/phpBB/phpbb/cache/driver/memcache.php
index 84fe68ae49..eb3fced973 100644
--- a/phpBB/phpbb/cache/driver/memcache.php
+++ b/phpBB/phpbb/cache/driver/memcache.php
@@ -9,14 +9,6 @@
 
 namespace phpbb\cache\driver;
 
-/**
-* @ignore
-*/
-if (!defined('IN_PHPBB'))
-{
-	exit;
-}
-
 if (!defined('PHPBB_ACM_MEMCACHE_PORT'))
 {
 	define('PHPBB_ACM_MEMCACHE_PORT', 11211);
@@ -64,9 +56,7 @@ class memcache extends \phpbb\cache\driver\memory
 	}
 
 	/**
-	* Unload the cache resources
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function unload()
 	{
@@ -76,9 +66,7 @@ class memcache extends \phpbb\cache\driver\memory
 	}
 
 	/**
-	* Purge cache data
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
diff --git a/phpBB/phpbb/cache/driver/memory.php b/phpBB/phpbb/cache/driver/memory.php
index 5a9861913f..d5404455d1 100644
--- a/phpBB/phpbb/cache/driver/memory.php
+++ b/phpBB/phpbb/cache/driver/memory.php
@@ -10,14 +10,6 @@
 namespace phpbb\cache\driver;
 
 /**
-* @ignore
-*/
-if (!defined('IN_PHPBB'))
-{
-	exit;
-}
-
-/**
 * ACM Abstract Memory Class
 * @package acm
 */
@@ -58,7 +50,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Load global cache
+	* {@inheritDoc}
 	*/
 	function load()
 	{
@@ -74,7 +66,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Unload cache object
+	* {@inheritDoc}
 	*/
 	function unload()
 	{
@@ -89,7 +81,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Save modified objects
+	* {@inheritDoc}
 	*/
 	function save()
 	{
@@ -104,7 +96,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Tidy cache
+	* {@inheritDoc}
 	*/
 	function tidy()
 	{
@@ -114,7 +106,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Get saved cache object
+	* {@inheritDoc}
 	*/
 	function get($var_name)
 	{
@@ -134,7 +126,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Put data into cache
+	* {@inheritDoc}
 	*/
 	function put($var_name, $var, $ttl = 2592000)
 	{
@@ -150,7 +142,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Purge cache data
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
@@ -191,7 +183,7 @@ abstract class memory extends \phpbb\cache\driver\base
 
 
 	/**
-	* Destroy cache data
+	* {@inheritDoc}
 	*/
 	function destroy($var_name, $table = '')
 	{
@@ -245,7 +237,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Check if a given cache entry exist
+	* {@inheritDoc}
 	*/
 	function _exists($var_name)
 	{
@@ -265,7 +257,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Load cached sql query
+	* {@inheritDoc}
 	*/
 	function sql_load($query)
 	{
@@ -287,7 +279,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	/**
 	* {@inheritDoc}
 	*/
-	function sql_save(\phpbb\db\driver\driver $db, $query, $query_result, $ttl)
+	function sql_save(\phpbb\db\driver\driver_interface $db, $query, $query_result, $ttl)
 	{
 		// Remove extra spaces and tabs
 		$query = preg_replace('/[\n\r\s\t]+/', ' ', $query);
@@ -343,7 +335,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Ceck if a given sql query exist in cache
+	* {@inheritDoc}
 	*/
 	function sql_exists($query_id)
 	{
@@ -351,7 +343,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Fetch row from cache (database)
+	* {@inheritDoc}
 	*/
 	function sql_fetchrow($query_id)
 	{
@@ -364,7 +356,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Fetch a field from the current row of a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_fetchfield($query_id, $field)
 	{
@@ -377,7 +369,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Seek a specific row in an a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_rowseek($rownum, $query_id)
 	{
@@ -391,7 +383,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Free memory used for a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_freeresult($query_id)
 	{
@@ -408,6 +400,10 @@ abstract class memory extends \phpbb\cache\driver\base
 
 	/**
 	* Removes/unlinks file
+	*
+	* @param string $filename Filename to remove
+	* @param bool $check Check file permissions
+	* @return bool True if the file was successfully removed, otherwise false
 	*/
 	function remove_file($filename, $check = false)
 	{
diff --git a/phpBB/phpbb/cache/driver/null.php b/phpBB/phpbb/cache/driver/null.php
index c03319ad61..99cfe454e0 100644
--- a/phpBB/phpbb/cache/driver/null.php
+++ b/phpBB/phpbb/cache/driver/null.php
@@ -10,14 +10,6 @@
 namespace phpbb\cache\driver;
 
 /**
-* @ignore
-*/
-if (!defined('IN_PHPBB'))
-{
-	exit;
-}
-
-/**
 * ACM Null Caching
 * @package acm
 */
@@ -31,7 +23,7 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Load global cache
+	* {@inheritDoc}
 	*/
 	function load()
 	{
@@ -39,21 +31,21 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Unload cache object
+	* {@inheritDoc}
 	*/
 	function unload()
 	{
 	}
 
 	/**
-	* Save modified objects
+	* {@inheritDoc}
 	*/
 	function save()
 	{
 	}
 
 	/**
-	* Tidy cache
+	* {@inheritDoc}
 	*/
 	function tidy()
 	{
@@ -62,7 +54,7 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Get saved cache object
+	* {@inheritDoc}
 	*/
 	function get($var_name)
 	{
@@ -70,28 +62,28 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Put data into cache
+	* {@inheritDoc}
 	*/
 	function put($var_name, $var, $ttl = 0)
 	{
 	}
 
 	/**
-	* Purge cache data
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
 	}
 
 	/**
-	* Destroy cache data
+	* {@inheritDoc}
 	*/
 	function destroy($var_name, $table = '')
 	{
 	}
 
 	/**
-	* Check if a given cache entry exist
+	* {@inheritDoc}
 	*/
 	function _exists($var_name)
 	{
@@ -99,7 +91,7 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Load cached sql query
+	* {@inheritDoc}
 	*/
 	function sql_load($query)
 	{
@@ -109,13 +101,13 @@ class null extends \phpbb\cache\driver\base
 	/**
 	* {@inheritDoc}
 	*/
-	function sql_save(\phpbb\db\driver\driver $db, $query, $query_result, $ttl)
+	function sql_save(\phpbb\db\driver\driver_interface $db, $query, $query_result, $ttl)
 	{
 		return $query_result;
 	}
 
 	/**
-	* Ceck if a given sql query exist in cache
+	* {@inheritDoc}
 	*/
 	function sql_exists($query_id)
 	{
@@ -123,7 +115,7 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Fetch row from cache (database)
+	* {@inheritDoc}
 	*/
 	function sql_fetchrow($query_id)
 	{
@@ -131,7 +123,7 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Fetch a field from the current row of a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_fetchfield($query_id, $field)
 	{
@@ -139,7 +131,7 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Seek a specific row in an a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_rowseek($rownum, $query_id)
 	{
@@ -147,7 +139,7 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Free memory used for a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_freeresult($query_id)
 	{
diff --git a/phpBB/phpbb/cache/driver/redis.php b/phpBB/phpbb/cache/driver/redis.php
index 317d07428a..2f2a32a12d 100644
--- a/phpBB/phpbb/cache/driver/redis.php
+++ b/phpBB/phpbb/cache/driver/redis.php
@@ -9,14 +9,6 @@
 
 namespace phpbb\cache\driver;
 
-/**
-* @ignore
-*/
-if (!defined('IN_PHPBB'))
-{
-	exit;
-}
-
 if (!defined('PHPBB_ACM_REDIS_PORT'))
 {
 	define('PHPBB_ACM_REDIS_PORT', 6379);
@@ -100,9 +92,7 @@ class redis extends \phpbb\cache\driver\memory
 	}
 
 	/**
-	* Unload the cache resources
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function unload()
 	{
@@ -112,9 +102,7 @@ class redis extends \phpbb\cache\driver\memory
 	}
 
 	/**
-	* Purge cache data
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
@@ -165,4 +153,3 @@ class redis extends \phpbb\cache\driver\memory
 		return false;
 	}
 }
-
diff --git a/phpBB/phpbb/cache/driver/wincache.php b/phpBB/phpbb/cache/driver/wincache.php
index a0b24e4a1f..d0f636d9cb 100644
--- a/phpBB/phpbb/cache/driver/wincache.php
+++ b/phpBB/phpbb/cache/driver/wincache.php
@@ -10,14 +10,6 @@
 namespace phpbb\cache\driver;
 
 /**
-* @ignore
-*/
-if (!defined('IN_PHPBB'))
-{
-	exit;
-}
-
-/**
 * ACM for WinCache
 * @package acm
 */
@@ -26,9 +18,7 @@ class wincache extends \phpbb\cache\driver\memory
 	var $extension = 'wincache';
 
 	/**
-	* Purge cache data
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
diff --git a/phpBB/phpbb/cache/driver/xcache.php b/phpBB/phpbb/cache/driver/xcache.php
index fdcbf7e4b5..6c9323ec83 100644
--- a/phpBB/phpbb/cache/driver/xcache.php
+++ b/phpBB/phpbb/cache/driver/xcache.php
@@ -10,14 +10,6 @@
 namespace phpbb\cache\driver;
 
 /**
-* @ignore
-*/
-if (!defined('IN_PHPBB'))
-{
-	exit;
-}
-
-/**
 * ACM for XCache
 * @package acm
 *
@@ -41,9 +33,7 @@ class xcache extends \phpbb\cache\driver\memory
 	}
 
 	/**
-	* Purge cache data
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function purge()
 	{