From 71e647782764184e3aab4faffe6d99176758979f Mon Sep 17 00:00:00 2001 From: Andrey Andreev Date: Thu, 22 Mar 2018 16:48:55 +0200 Subject: [ci skip] 3.1.8 release --- user_guide_src/source/helpers/array_helper.rst | 133 ------------------------- 1 file changed, 133 deletions(-) delete mode 100644 user_guide_src/source/helpers/array_helper.rst (limited to 'user_guide_src/source/helpers/array_helper.rst') diff --git a/user_guide_src/source/helpers/array_helper.rst b/user_guide_src/source/helpers/array_helper.rst deleted file mode 100644 index d6b48773f..000000000 --- a/user_guide_src/source/helpers/array_helper.rst +++ /dev/null @@ -1,133 +0,0 @@ -############ -Array Helper -############ - -The Array Helper file contains functions that assist in working with -arrays. - -.. contents:: - :local: - -.. raw:: html - -
- -Loading this Helper -=================== - -This helper is loaded using the following code:: - - $this->load->helper('array'); - - -Available Functions -=================== - -The following functions are available: - - -.. php: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. - :rtype: mixed - - 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:: - - $array = array( - 'color' => 'red', - 'shape' => 'round', - 'size' => '' - ); - - echo element('color', $array); // returns "red" - echo element('size', $array, 'foobar'); // returns "foobar" - - -.. php: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. - :rtype: mixed - - 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:: - - $array = array( - 'color' => 'red', - 'shape' => 'round', - 'radius' => '10', - 'diameter' => '20' - ); - - $my_shape = elements(array('color', 'shape', 'height'), $array); - - The above will return the following array:: - - array( - 'color' => 'red', - 'shape' => 'round', - 'height' => NULL - ); - - You can set the third parameter to any default value you like. - :: - - $my_shape = elements(array('color', 'shape', 'height'), $array, 'foobar'); - - The above will return the following array:: - - 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->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. - - -.. php:function:: random_element($array) - - :param array $array: Input array - :returns: A random element from the array - :rtype: mixed - - Takes an array as input and returns a random element from it. - - 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" - ); - - echo random_element($quotes); \ No newline at end of file -- cgit v1.2.3-24-g4f1b