summaryrefslogtreecommitdiffstats
path: root/user_guide_src
diff options
context:
space:
mode:
authorDerek Jones <derek.jones@ellislab.com>2013-07-20 01:14:38 +0200
committerDerek Jones <derek.jones@ellislab.com>2013-07-20 01:14:38 +0200
commite07b4e7e6c26e3aa5c4c8e57b2842e1ba818517e (patch)
tree0a7290193db8487d53fa8af63a37a5d717aa2b55 /user_guide_src
parentb8c283a695c8074a57d8c3dfa00934312638931d (diff)
Updating Array Helper docs
Diffstat (limited to 'user_guide_src')
-rw-r--r--user_guide_src/source/helpers/array_helper.rst141
1 files changed, 72 insertions, 69 deletions
diff --git a/user_guide_src/source/helpers/array_helper.rst b/user_guide_src/source/helpers/array_helper.rst
index 90ead2942..20f5864a6 100644
--- a/user_guide_src/source/helpers/array_helper.rst
+++ b/user_guide_src/source/helpers/array_helper.rst
@@ -5,7 +5,12 @@ Array Helper
The Array Helper file contains functions that assist in working with
arrays.
-.. contents:: Page Contents
+.. contents::
+ :local:
+
+.. raw:: html
+
+ <div class="custom-index container"></div>
Loading this Helper
===================
@@ -14,114 +19,112 @@ This helper is loaded using the following code::
$this->load->helper('array');
+
+Available Functions
+===================
+
The following functions are available:
-element()
-=========
-.. function:: element($item, $array, $default = NULL)
+.. function:: element($item, $array[, $default = NULL])
:param string $item: Item to fetch from the array
:param array $array: Input array
:param bool $default: What to return if the array isn't valid
:returns: NULL on failure or the array item.
-Lets you fetch an item from an array. The function tests whether the
-array index is set and whether it has a value. If a value exists it is
-returned. If a value does not exist it returns NULL, or whatever you've
-specified as the default value via the third parameter.
+ Lets you fetch an item from an array. The function tests whether the
+ array index is set and whether it has a value. If a value exists it is
+ returned. If a value does not exist it returns NULL, or whatever you've
+ specified as the default value via the third parameter.
-Example::
+ Example::
- $array = array(
- 'color' => 'red',
- 'shape' => 'round',
- 'size' => ''
- );
+ $array = array(
+ 'color' => 'red',
+ 'shape' => 'round',
+ 'size' => ''
+ );
- echo element('color', $array); // returns "red"
- echo element('size', $array, 'foobar'); // returns "foobar"
+ echo element('color', $array); // returns "red"
+ echo element('size', $array, 'foobar'); // returns "foobar"
-elements()
-==========
-.. function:: elements($items, $array, $default = NULL)
+.. function:: elements($items, $array[, $default = NULL])
:param string $item: Item to fetch from the array
:param array $array: Input array
:param bool $default: What to return if the array isn't valid
:returns: NULL on failure or the array item.
-Lets you fetch a number of items from an array. The function tests
-whether each of the array indices is set. If an index does not exist it
-is set to NULL, or whatever you've specified as the default value via
-the third parameter.
+ Lets you fetch a number of items from an array. The function tests
+ whether each of the array indices is set. If an index does not exist it
+ is set to NULL, or whatever you've specified as the default value via
+ the third parameter.
-Example::
+ Example::
- $array = array(
- 'color' => 'red',
- 'shape' => 'round',
- 'radius' => '10',
- 'diameter' => '20'
- );
+ $array = array(
+ 'color' => 'red',
+ 'shape' => 'round',
+ 'radius' => '10',
+ 'diameter' => '20'
+ );
- $my_shape = elements(array('color', 'shape', 'height'), $array);
+ $my_shape = elements(array('color', 'shape', 'height'), $array);
-The above will return the following array::
+ The above will return the following array::
- array(
- 'color' => 'red',
- 'shape' => 'round',
- 'height' => NULL
- );
+ array(
+ 'color' => 'red',
+ 'shape' => 'round',
+ 'height' => NULL
+ );
-You can set the third parameter to any default value you like.
-::
+ You can set the third parameter to any default value you like.
+ ::
- $my_shape = elements(array('color', 'shape', 'height'), $array, 'foobar');
+ $my_shape = elements(array('color', 'shape', 'height'), $array, 'foobar');
-The above will return the following array::
+ The above will return the following array::
- array(     
- 'color' => 'red',
- 'shape' => 'round',
- 'height' => 'foobar'
- );
+ array(     
+ 'color' => 'red',
+ 'shape' => 'round',
+ 'height' => 'foobar'
+ );
-This is useful when sending the ``$_POST`` array to one of your Models.
-This prevents users from sending additional POST data to be entered into
-your tables.
+ This is useful when sending the ``$_POST`` array to one of your Models.
+ This prevents users from sending additional POST data to be entered into
+ your tables.
-::
+ ::
- $this->load->model('post_model');
- $this->post_model->update(
- elements(array('id', 'title', 'content'), $_POST)
- );
+ $this->load->model('post_model');
+ $this->post_model->update(
+ elements(array('id', 'title', 'content'), $_POST)
+ );
-This ensures that only the id, title and content fields are sent to be
-updated.
+ This ensures that only the id, title and content fields are sent to be
+ updated.
-random_element()
-================
.. function:: random_element($array)
:param array $array: Input array
:returns: string (a random element from the array)
-Takes an array as input and returns a random element from it.
+ Takes an array as input and returns a random element from it.
-Usage example::
+ Usage example::
- $quotes = array(
- "I find that the harder I work, the more luck I seem to have. - Thomas Jefferson",
- "Don't stay in bed, unless you can make money in bed. - George Burns",
- "We didn't lose the game; we just ran out of time. - Vince Lombardi",
- "If everything seems under control, you're not going fast enough. - Mario Andretti",
- "Reality is merely an illusion, albeit a very persistent one. - Albert Einstein",
- "Chance favors the prepared mind - Louis Pasteur"
- );
+ $quotes = array(
+ "I find that the harder I work, the more luck I seem to have. - Thomas Jefferson",
+ "Don't stay in bed, unless you can make money in bed. - George Burns",
+ "We didn't lose the game; we just ran out of time. - Vince Lombardi",
+ "If everything seems under control, you're not going fast enough. - Mario Andretti",
+ "Reality is merely an illusion, albeit a very persistent one. - Albert Einstein",
+ "Chance favors the prepared mind - Louis Pasteur"
+ );
- echo random_element($quotes); \ No newline at end of file
+ echo random_element($quotes); \ No newline at end of file