PHPDocs for cache, Format

This commit is contained in:
Anton Terekhov
2012-11-19 18:40:04 +04:00
parent 2d02f25e22
commit 1e0d1aaa38
5 changed files with 58 additions and 48 deletions

35
cache/Cache.php vendored
View File

@ -11,72 +11,71 @@
abstract class Cache
{
/**
* Add an item to the cache
*
*
* @param string $key
* @param mixed $value
* @param int $expire
* @return bool
*/
abstract public function add($key, $value, $expire = 0);
/**
* Decrement item's value
*
*
* @param string $key
* @param int $decrement
* @return bool
*/
abstract public function decrement($key, $decrement = 1);
/**
* Delete item from the cache
*
*
* @param string $key
* @param int $value
* @return bool
*/
abstract public function del($key);
/**
* Flush all existing items
*
*
* @return bool
*/
abstract public function flush();
/**
* Retrieve item from the cache
*
*
* @param mixed $key
* @return mixed
*/
abstract public function get($key);
/**
* Increment item's value
*
*
* @param string $key
* @param int $increment
* @return bool
*/
abstract public function increment($key, $increment = 1);
/**
* Replace value of the existing item
*
*
* @param string $key
* @param mixed $var
* @param mixed $value
* @param int $expire
* @return bool
*/
abstract public function replace($key, $value, $expire = 0);
/**
* Store data in the cache
*
*
* @param string $key
* @param mixed $value
* @param int $expire