diff options
| author | Matt Friedman <maf675@gmail.com> | 2014-03-22 08:23:18 -0700 |
|---|---|---|
| committer | Matt Friedman <maf675@gmail.com> | 2014-03-22 08:23:18 -0700 |
| commit | b87fc1e56cb3701a89db2b6012f37bd75f52f29d (patch) | |
| tree | ed88efc1851f863c77131dc3eb30273ab7b9122f | |
| parent | 60e5757fa104c875de084fbb3740d97bafa19070 (diff) | |
| download | forums-b87fc1e56cb3701a89db2b6012f37bd75f52f29d.tar forums-b87fc1e56cb3701a89db2b6012f37bd75f52f29d.tar.gz forums-b87fc1e56cb3701a89db2b6012f37bd75f52f29d.tar.bz2 forums-b87fc1e56cb3701a89db2b6012f37bd75f52f29d.tar.xz forums-b87fc1e56cb3701a89db2b6012f37bd75f52f29d.zip | |
[ticket/11230] Update cache driver dock blocks
PHPBB3-12230
| -rw-r--r-- | phpBB/phpbb/cache/driver/driver_interface.php | 24 | ||||
| -rw-r--r-- | phpBB/phpbb/cache/driver/file.php | 4 | ||||
| -rw-r--r-- | phpBB/phpbb/cache/driver/memory.php | 4 |
3 files changed, 32 insertions, 0 deletions
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); diff --git a/phpBB/phpbb/cache/driver/file.php b/phpBB/phpbb/cache/driver/file.php index e0f5d37af9..a57a805193 100644 --- a/phpBB/phpbb/cache/driver/file.php +++ b/phpBB/phpbb/cache/driver/file.php @@ -758,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/memory.php b/phpBB/phpbb/cache/driver/memory.php index aab180f26a..b618b0f3e6 100644 --- a/phpBB/phpbb/cache/driver/memory.php +++ b/phpBB/phpbb/cache/driver/memory.php @@ -400,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) { |