From d0bc7eb366610ad2e68d5921b363c665ccda1ff3 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Thu, 9 Jan 2014 17:37:06 +0200
Subject: Add documentation for raw data, increment(), decrement() in Cache
 library

Follows: 43d7fa73534c07d10a88ec120c0938d0d00a184e
---
 user_guide_src/source/libraries/caching.rst | 36 ++++++++++++++++++++++++++++-
 1 file changed, 35 insertions(+), 1 deletion(-)

(limited to 'user_guide_src')

diff --git a/user_guide_src/source/libraries/caching.rst b/user_guide_src/source/libraries/caching.rst
index 709171dd3..5a9742378 100644
--- a/user_guide_src/source/libraries/caching.rst
+++ b/user_guide_src/source/libraries/caching.rst
@@ -84,11 +84,12 @@ Class Reference
 
 			$foo = $this->cache->get('my_cached_item');
 
-	.. method:: save($id, $data[, $ttl = 60])
+	.. method:: save($id, $data[, $ttl = 60[, $raw = FALSE]])
 
 		:param string $id: name of the cached item
 		:param mixed $data: the data to save
 		:param int $ttl: Time To Live, in seconds (default 60)
+		:param bool $raw: Whether to store the raw value
 		:returns: TRUE on success, FALSE on failure
 
 		This method will save an item to the cache store. If saving fails, the
@@ -97,6 +98,9 @@ Class Reference
 
 			$this->cache->save('cache_item_id', 'data_to_cache');
 
+		.. note:: The ``$raw`` parameter is only utilized by APC and Memcache,
+			in order to allow usage of ``increment()`` and ``decrement()``.
+
 	.. method:: delete($id)
 
 		:param string $id: name of cached item
@@ -108,6 +112,36 @@ Class Reference
 
 			$this->cache->delete('cache_item_id');
 
+	.. method:: increment($id[, $offset = 1])
+
+		:param string $id: Cache ID
+		:param int $offset: Step/value to add
+		:returns: New value on success, FALSE on failure
+
+		Performs atomic incrementation of a raw stored value.
+		::
+
+			// 'iterator' has a value of 2
+
+			$this->cache->increment('iterator'); // 'iterator' is now 3
+
+			$this->cache->increment('iterator', 3); // 'iterator' is now 6
+
+	.. method:: decrement($id[, $offset = 1])
+
+		:param string $id: Cache ID
+		:param int $offset: Step/value to reduce by
+		:returns: New value on success, FALSE on failure
+
+		Performs atomic decrementation of a raw stored value.
+		::
+
+			// 'iterator' has a value of 6
+
+			$this->cache->decrement('iterator'); // 'iterator' is now 5
+
+			$this->cache->decrement('iterator', 2); // 'iterator' is now 3
+
 	.. method:: clean()
 
 		:returns: TRUE if deleted, FALSE if the deletion fails
-- 
cgit v1.2.3-24-g4f1b