summaryrefslogtreecommitdiffstats
path: root/user_guide_src/source/libraries/caching.rst
diff options
context:
space:
mode:
authorAhmad Anbar <aanbar@gmail.com>2015-02-04 18:20:01 +0100
committerAhmad Anbar <aanbar@gmail.com>2015-02-04 18:20:01 +0100
commite5454f9b28f123a5549971f580255a065b2f8cc2 (patch)
treec4927e7b7afb0bf242976034630cc60f2f1db00f /user_guide_src/source/libraries/caching.rst
parent6db62ab0ad0e223806a1367e12b1884b48dc65d7 (diff)
parenteccac6e6a73a4d1a5b40f383ce64359c2c94ae12 (diff)
Merge remote-tracking branch 'upstream/develop' into develop
Diffstat (limited to 'user_guide_src/source/libraries/caching.rst')
-rw-r--r--user_guide_src/source/libraries/caching.rst20
1 files changed, 10 insertions, 10 deletions
diff --git a/user_guide_src/source/libraries/caching.rst b/user_guide_src/source/libraries/caching.rst
index caece1aee..86439b4ee 100644
--- a/user_guide_src/source/libraries/caching.rst
+++ b/user_guide_src/source/libraries/caching.rst
@@ -52,9 +52,9 @@ to avoid collisions when you're running multiple applications on the same enviro
Class Reference
***************
-.. class:: CI_Cache
+.. php:class:: CI_Cache
- .. method:: is_supported($driver)
+ .. php:method:: is_supported($driver)
:param string $driver: the name of the caching driver
:returns: TRUE if supported, FALSE if not
@@ -74,7 +74,7 @@ Class Reference
}
}
- .. method:: get($id)
+ .. php:method:: get($id)
:param string $id: Cache item name
:returns: Item value or FALSE if not found
@@ -86,7 +86,7 @@ Class Reference
$foo = $this->cache->get('my_cached_item');
- .. method:: save($id, $data[, $ttl = 60[, $raw = FALSE]])
+ .. php:method:: save($id, $data[, $ttl = 60[, $raw = FALSE]])
:param string $id: Cache item name
:param mixed $data: the data to save
@@ -104,7 +104,7 @@ Class Reference
.. note:: The ``$raw`` parameter is only utilized by APC and Memcache,
in order to allow usage of ``increment()`` and ``decrement()``.
- .. method:: delete($id)
+ .. php:method:: delete($id)
:param string $id: name of cached item
:returns: TRUE on success, FALSE on failure
@@ -116,7 +116,7 @@ Class Reference
$this->cache->delete('cache_item_id');
- .. method:: increment($id[, $offset = 1])
+ .. php:method:: increment($id[, $offset = 1])
:param string $id: Cache ID
:param int $offset: Step/value to add
@@ -132,7 +132,7 @@ Class Reference
$this->cache->increment('iterator', 3); // 'iterator' is now 6
- .. method:: decrement($id[, $offset = 1])
+ .. php:method:: decrement($id[, $offset = 1])
:param string $id: Cache ID
:param int $offset: Step/value to reduce by
@@ -148,7 +148,7 @@ Class Reference
$this->cache->decrement('iterator', 2); // 'iterator' is now 3
- .. method:: clean()
+ .. php:method:: clean()
:returns: TRUE on success, FALSE on failure
:rtype: bool
@@ -159,7 +159,7 @@ Class Reference
$this->cache->clean();
- .. method:: cache_info()
+ .. php:method:: cache_info()
:returns: Information on the entire cache database
:rtype: mixed
@@ -172,7 +172,7 @@ Class Reference
.. note:: The information returned and the structure of the data is dependent
on which adapter is being used.
- .. method:: get_metadata($id)
+ .. php:method:: get_metadata($id)
:param string $id: Cache item name
:returns: Metadata for the cached item