diff options
| author | Joas Schilling <nickvergessen@gmx.de> | 2014-03-28 17:27:14 +0100 |
|---|---|---|
| committer | Joas Schilling <nickvergessen@gmx.de> | 2014-03-28 17:27:14 +0100 |
| commit | 968da05e51b25d49c1cf383dfb0823acba661b3b (patch) | |
| tree | 85d352385f5cd322acfa25f02e5456a7a59aaa9c /phpBB/phpbb/cache/driver/driver_interface.php | |
| parent | 6af942740cb534e4db6ad12bef1d1e9f297fd84e (diff) | |
| parent | dab35589fec70018ac18aef355823e4cf9287fb4 (diff) | |
| download | forums-968da05e51b25d49c1cf383dfb0823acba661b3b.tar forums-968da05e51b25d49c1cf383dfb0823acba661b3b.tar.gz forums-968da05e51b25d49c1cf383dfb0823acba661b3b.tar.bz2 forums-968da05e51b25d49c1cf383dfb0823acba661b3b.tar.xz forums-968da05e51b25d49c1cf383dfb0823acba661b3b.zip | |
Merge remote-tracking branch 'vsephpbb/ticket/11230' into develop-ascraeus
* vsephpbb/ticket/11230:
[ticket/11230] Add missing last returns to dock block
[ticket/11230] Update cache driver dock blocks
[ticket/11230] Use inheritdoc in docblocks in cache drivers
Diffstat (limited to 'phpBB/phpbb/cache/driver/driver_interface.php')
| -rw-r--r-- | phpBB/phpbb/cache/driver/driver_interface.php | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/phpBB/phpbb/cache/driver/driver_interface.php b/phpBB/phpbb/cache/driver/driver_interface.php index 0715a4b934..8444028115 100644 --- a/phpBB/phpbb/cache/driver/driver_interface.php +++ b/phpBB/phpbb/cache/driver/driver_interface.php @@ -18,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); |