diff options
Diffstat (limited to 'user_guide_src/source/libraries')
| -rw-r--r-- | user_guide_src/source/libraries/caching.rst | 38 | ||||
| -rw-r--r-- | user_guide_src/source/libraries/migration.rst | 7 | ||||
| -rw-r--r-- | user_guide_src/source/libraries/output.rst | 7 | ||||
| -rw-r--r-- | user_guide_src/source/libraries/pagination.rst | 7 | ||||
| -rw-r--r-- | user_guide_src/source/libraries/parser.rst | 7 | ||||
| -rw-r--r-- | user_guide_src/source/libraries/security.rst | 7 | ||||
| -rw-r--r-- | user_guide_src/source/libraries/sessions.rst | 9 | ||||
| -rw-r--r-- | user_guide_src/source/libraries/table.rst | 8 | ||||
| -rw-r--r-- | user_guide_src/source/libraries/trackback.rst | 4 | ||||
| -rw-r--r-- | user_guide_src/source/libraries/typography.rst | 4 | ||||
| -rw-r--r-- | user_guide_src/source/libraries/uri.rst | 7 | ||||
| -rw-r--r-- | user_guide_src/source/libraries/user_agent.rst | 4 | ||||
| -rw-r--r-- | user_guide_src/source/libraries/xmlrpc.rst | 4 | ||||
| -rw-r--r-- | user_guide_src/source/libraries/zip.rst | 4 |
14 files changed, 73 insertions, 44 deletions
diff --git a/user_guide_src/source/libraries/caching.rst b/user_guide_src/source/libraries/caching.rst index 55fdabca3..709171dd3 100644 --- a/user_guide_src/source/libraries/caching.rst +++ b/user_guide_src/source/libraries/caching.rst @@ -54,17 +54,15 @@ Class Reference .. class:: CI_Cache - .. method:: is_supported ( $driver ) + .. method:: is_supported($driver) :param string $driver: the name of the caching driver :returns: TRUE if supported, FALSE if not - :rtype: Boolean This method is automatically called when accessing drivers via - $this->cache->get(). However, if the individual drivers are used, make - sure to call this method to ensure the driver is supported in the + ``$this->cache->get()``. However, if the individual drivers are used, + make sure to call this method to ensure the driver is supported in the hosting environment. - :: if ($this->cache->apc->is_supported() @@ -75,71 +73,56 @@ Class Reference } } - - .. method:: get ( $id ) + .. method:: get($id) :param string $id: name of cached item :returns: The item if it exists, FALSE if it does not - :rtype: Mixed This method will attempt to fetch an item from the cache store. If the item does not exist, the method will return FALSE. - :: $foo = $this->cache->get('my_cached_item'); - - .. method:: save ( $id , $data [, $ttl = 60]) + .. method:: save($id, $data[, $ttl = 60]) :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) :returns: TRUE on success, FALSE on failure - :rtype: Boolean This method will save an item to the cache store. If saving fails, the method will return FALSE. - :: $this->cache->save('cache_item_id', 'data_to_cache'); - - .. method:: delete ( $id ) + .. method:: delete($id) :param string $id: name of cached item :returns: TRUE if deleted, FALSE if the deletion fails - :rtype: Boolean This method will delete a specific item from the cache store. If item deletion fails, the method will return FALSE. - :: $this->cache->delete('cache_item_id'); - - .. method:: clean ( ) + .. method:: clean() :returns: TRUE if deleted, FALSE if the deletion fails - :rtype: Boolean This method will 'clean' the entire cache. If the deletion of the cache files fails, the method will return FALSE. - :: $this->cache->clean(); - - .. method:: cache_info ( ) + .. method:: cache_info() :returns: information on the entire cache - :rtype: Mixed This method will return information on the entire cache. - :: var_dump($this->cache->cache_info()); @@ -147,16 +130,13 @@ Class Reference .. note:: The information returned and the structure of the data is dependent on which adapter is being used. - - .. method:: get_metadata ( $id ) + .. method:: get_metadata($id) :param string $id: name of cached item :returns: metadadta for the cached item - :rtype: Mixed This method will return detailed information on a specific item in the cache. - :: var_dump($this->cache->get_metadata('my_cached_item')); diff --git a/user_guide_src/source/libraries/migration.rst b/user_guide_src/source/libraries/migration.rst index a007d5be7..128796c4d 100644 --- a/user_guide_src/source/libraries/migration.rst +++ b/user_guide_src/source/libraries/migration.rst @@ -13,6 +13,13 @@ run so all you have to do is update your application files and call ``$this->migration->current()`` to work out which migrations should be run. The current version is found in **application/config/migration.php**. +.. contents:: + :local: + +.. raw:: html + + <div class="custom-index container"></div> + ******************** Migration file names ******************** diff --git a/user_guide_src/source/libraries/output.rst b/user_guide_src/source/libraries/output.rst index a518f853d..76197bdc1 100644 --- a/user_guide_src/source/libraries/output.rst +++ b/user_guide_src/source/libraries/output.rst @@ -18,6 +18,13 @@ automatically by CodeIgniter at the end of system execution. It is possible, however, for you to manually intervene with the output if you need to. +.. contents:: + :local: + +.. raw:: html + + <div class="custom-index container"></div> + *************** Class Reference *************** diff --git a/user_guide_src/source/libraries/pagination.rst b/user_guide_src/source/libraries/pagination.rst index 06627cfeb..34ca22141 100644 --- a/user_guide_src/source/libraries/pagination.rst +++ b/user_guide_src/source/libraries/pagination.rst @@ -5,6 +5,13 @@ Pagination Class CodeIgniter's Pagination class is very easy to use, and it is 100% customizable, either dynamically or via stored preferences. +.. contents:: + :local: + +.. raw:: html + + <div class="custom-index container"></div> + If you are not familiar with the term "pagination", it refers to links that allows you to navigate from page to page, like this:: diff --git a/user_guide_src/source/libraries/parser.rst b/user_guide_src/source/libraries/parser.rst index 5c184be58..50bde82c7 100644 --- a/user_guide_src/source/libraries/parser.rst +++ b/user_guide_src/source/libraries/parser.rst @@ -35,6 +35,13 @@ representations that allow you to eliminate PHP from your templates template parsing solution. We've kept it very lean on purpose in order to maintain maximum performance. +.. contents:: + :local: + +.. raw:: html + + <div class="custom-index container"></div> + Initializing the Class ====================== diff --git a/user_guide_src/source/libraries/security.rst b/user_guide_src/source/libraries/security.rst index 3d0697bbe..8d7ccb1ab 100644 --- a/user_guide_src/source/libraries/security.rst +++ b/user_guide_src/source/libraries/security.rst @@ -5,6 +5,13 @@ Security Class The Security Class contains methods that help you create a secure application, processing input data for security. +.. contents:: + :local: + +.. raw:: html + + <div class="custom-index container"></div> + XSS Filtering ============= diff --git a/user_guide_src/source/libraries/sessions.rst b/user_guide_src/source/libraries/sessions.rst index b3de2252c..8e117bee6 100644 --- a/user_guide_src/source/libraries/sessions.rst +++ b/user_guide_src/source/libraries/sessions.rst @@ -9,6 +9,13 @@ which supports usage of the native PHP Session mechanism. In addition, you may create your own `Custom Drivers`_ to store session data however you wish, while still taking advantage of the features of the Session class. +.. contents:: + :local: + +.. raw:: html + + <div class="custom-index container"></div> + Initializing a Session ====================== @@ -27,7 +34,7 @@ use the ``$this->load->driver`` function:: Once loaded, the Sessions library object will be available using:: -$this->session + $this->session How do Sessions work? ===================== diff --git a/user_guide_src/source/libraries/table.rst b/user_guide_src/source/libraries/table.rst index 25927800e..bfe457993 100644 --- a/user_guide_src/source/libraries/table.rst +++ b/user_guide_src/source/libraries/table.rst @@ -5,12 +5,12 @@ HTML Table Class The Table Class provides functions that enable you to auto-generate HTML tables from arrays or database result sets. -.. content:: - :local: +.. contents:: + :local: .. raw:: html - <div class="custom-index container"></div> + <div class="custom-index container"></div> ********************* Using the Table Class @@ -280,4 +280,4 @@ Class Reference $this->table->add_row('Mary', 'Monday', 'Air'); $this->table->add_row('John', 'Saturday', 'Overnight'); - echo $this->table->generate(); + echo $this->table->generate();
\ No newline at end of file diff --git a/user_guide_src/source/libraries/trackback.rst b/user_guide_src/source/libraries/trackback.rst index 72958934c..a1667c79c 100644 --- a/user_guide_src/source/libraries/trackback.rst +++ b/user_guide_src/source/libraries/trackback.rst @@ -9,11 +9,11 @@ If you are not familiar with Trackbacks you'll find more information `here <http://en.wikipedia.org/wiki/Trackback>`_. .. content:: - :local: + :local: .. raw:: html - <div class="custom-index container"></div> + <div class="custom-index container"></div> ************************* Using the Trackback Class diff --git a/user_guide_src/source/libraries/typography.rst b/user_guide_src/source/libraries/typography.rst index 8dab053ba..006e77d56 100644 --- a/user_guide_src/source/libraries/typography.rst +++ b/user_guide_src/source/libraries/typography.rst @@ -5,11 +5,11 @@ Typography Class The Typography Class provides methods that help you format text. .. content:: - :local: + :local: .. raw:: html - <div class="custom-index container"></div> + <div class="custom-index container"></div> ************************** Using the Typography Class diff --git a/user_guide_src/source/libraries/uri.rst b/user_guide_src/source/libraries/uri.rst index 1256afdef..f0fa04005 100644 --- a/user_guide_src/source/libraries/uri.rst +++ b/user_guide_src/source/libraries/uri.rst @@ -9,6 +9,13 @@ information about the re-routed segments. .. note:: This class is initialized automatically by the system so there is no need to do it manually. +.. contents:: + :local: + +.. raw:: html + + <div class="custom-index container"></div> + *************** Class Reference *************** diff --git a/user_guide_src/source/libraries/user_agent.rst b/user_guide_src/source/libraries/user_agent.rst index 3662cf3ad..9f9676828 100644 --- a/user_guide_src/source/libraries/user_agent.rst +++ b/user_guide_src/source/libraries/user_agent.rst @@ -8,11 +8,11 @@ addition you can get referrer information as well as language and supported character-set information. .. contents:: - :local: + :local: .. raw:: html - <div class="custom-index container"></div> + <div class="custom-index container"></div> ************************** Using the User Agent Class diff --git a/user_guide_src/source/libraries/xmlrpc.rst b/user_guide_src/source/libraries/xmlrpc.rst index c79f8bed9..c89c69c46 100644 --- a/user_guide_src/source/libraries/xmlrpc.rst +++ b/user_guide_src/source/libraries/xmlrpc.rst @@ -6,11 +6,11 @@ CodeIgniter's XML-RPC classes permit you to send requests to another server, or set up your own XML-RPC server to receive requests. .. contents:: - :local: + :local: .. raw:: html - <div class="custom-index container"></div> + <div class="custom-index container"></div> **************** What is XML-RPC? diff --git a/user_guide_src/source/libraries/zip.rst b/user_guide_src/source/libraries/zip.rst index e0955e3d6..ea5b46bac 100644 --- a/user_guide_src/source/libraries/zip.rst +++ b/user_guide_src/source/libraries/zip.rst @@ -7,11 +7,11 @@ archives. Archives can be downloaded to your desktop or saved to a directory. .. contents:: - :local: + :local: .. raw:: html - <div class="custom-index container"></div> + <div class="custom-index container"></div> **************************** Using the Zip Encoding Class |