From b87fc1e56cb3701a89db2b6012f37bd75f52f29d Mon Sep 17 00:00:00 2001
From: Matt Friedman <maf675@gmail.com>
Date: Sat, 22 Mar 2014 08:23:18 -0700
Subject: [ticket/11230] Update cache driver dock blocks

PHPBB3-12230
---
 phpBB/phpbb/cache/driver/driver_interface.php | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

(limited to 'phpBB/phpbb/cache/driver/driver_interface.php')

diff --git a/phpBB/phpbb/cache/driver/driver_interface.php b/phpBB/phpbb/cache/driver/driver_interface.php
index 0715a4b934..d4569bb314 100644
--- a/phpBB/phpbb/cache/driver/driver_interface.php
+++ b/phpBB/phpbb/cache/driver/driver_interface.php
@@ -18,6 +18,8 @@ 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();
 
@@ -28,36 +30,58 @@ interface driver_interface
 
 	/**
 	* 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
 	*/
 	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);
 
-- 
cgit v1.2.1


From dab35589fec70018ac18aef355823e4cf9287fb4 Mon Sep 17 00:00:00 2001
From: Matt Friedman <maf675@gmail.com>
Date: Fri, 28 Mar 2014 09:12:42 -0700
Subject: [ticket/11230] Add missing last returns to dock block

PHPBB3-11230
---
 phpBB/phpbb/cache/driver/driver_interface.php | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'phpBB/phpbb/cache/driver/driver_interface.php')

diff --git a/phpBB/phpbb/cache/driver/driver_interface.php b/phpBB/phpbb/cache/driver/driver_interface.php
index d4569bb314..8444028115 100644
--- a/phpBB/phpbb/cache/driver/driver_interface.php
+++ b/phpBB/phpbb/cache/driver/driver_interface.php
@@ -25,6 +25,8 @@ interface driver_interface
 
 	/**
 	* Unload cache object
+	*
+	* @return null
 	*/
 	public function unload();
 
@@ -56,6 +58,7 @@ interface driver_interface
 	* @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);
 
-- 
cgit v1.2.1