blob: 3d4a496bef2aa5c8fd2c5a20555118ec2aeeda57 [file] [log] [blame]
Andrey Andreevc5536aa2012-11-01 17:33:58 +02001<?php
Derek Allard2067d1a2008-11-13 22:59:24 +00002/**
3 * CodeIgniter
4 *
Andrey Andreevfe9309d2015-01-09 17:48:58 +02005 * An open source application development framework for PHP
Derek Allard2067d1a2008-11-13 22:59:24 +00006 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +02007 * This content is released under the MIT License (MIT)
Andrey Andreeve5617332012-03-13 12:22:17 +02008 *
Andrey Andreevcce6bd12018-01-09 11:32:02 +02009 * Copyright (c) 2014 - 2018, British Columbia Institute of Technology
Andrey Andreeve5617332012-03-13 12:22:17 +020010 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020011 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
Derek Jonesf4a4bd82011-10-20 12:18:42 -050017 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020018 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27 * THE SOFTWARE.
28 *
29 * @package CodeIgniter
30 * @author EllisLab Dev Team
Andrey Andreev1924e872016-01-11 12:55:34 +020031 * @copyright Copyright (c) 2008 - 2014, EllisLab, Inc. (https://ellislab.com/)
Andrey Andreevcce6bd12018-01-09 11:32:02 +020032 * @copyright Copyright (c) 2014 - 2018, British Columbia Institute of Technology (http://bcit.ca/)
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020033 * @license http://opensource.org/licenses/MIT MIT License
Andrey Andreevbd202c92016-01-11 12:50:18 +020034 * @link https://codeigniter.com
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020035 * @since Version 1.0.0
Derek Allard2067d1a2008-11-13 22:59:24 +000036 * @filesource
37 */
Andrey Andreevc5536aa2012-11-01 17:33:58 +020038defined('BASEPATH') OR exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +000039
Derek Allard2067d1a2008-11-13 22:59:24 +000040/**
41 * CodeIgniter Array Helpers
42 *
43 * @package CodeIgniter
44 * @subpackage Helpers
45 * @category Helpers
Derek Jonesf4a4bd82011-10-20 12:18:42 -050046 * @author EllisLab Dev Team
Andrey Andreevbd202c92016-01-11 12:50:18 +020047 * @link https://codeigniter.com/user_guide/helpers/array_helper.html
Derek Allard2067d1a2008-11-13 22:59:24 +000048 */
49
50// ------------------------------------------------------------------------
51
Derek Allard2067d1a2008-11-13 22:59:24 +000052if ( ! function_exists('element'))
53{
Timothy Warren01b129a2012-04-27 11:36:50 -040054 /**
55 * Element
56 *
57 * Lets you determine whether an array index is set and whether it has a value.
vlakoff0cd55352012-07-02 15:20:42 +020058 * If the element is empty it returns NULL (or whatever you specify as the default value.)
Timothy Warren01b129a2012-04-27 11:36:50 -040059 *
60 * @param string
61 * @param array
62 * @param mixed
63 * @return mixed depends on what the array contains
64 */
Andrey Andreevaaca76c2015-04-14 15:51:29 +030065 function element($item, array $array, $default = NULL)
Derek Allard2067d1a2008-11-13 22:59:24 +000066 {
Phil Sturgeon6801d042012-07-04 14:43:36 +020067 return array_key_exists($item, $array) ? $array[$item] : $default;
Barry Mienydd671972010-10-04 16:33:58 +020068 }
Derek Allard2067d1a2008-11-13 22:59:24 +000069}
70
71// ------------------------------------------------------------------------
72
Derek Allard2067d1a2008-11-13 22:59:24 +000073if ( ! function_exists('random_element'))
74{
Timothy Warren01b129a2012-04-27 11:36:50 -040075 /**
76 * Random Element - Takes an array as input and returns a random element
77 *
78 * @param array
79 * @return mixed depends on what the array contains
80 */
Derek Allard2067d1a2008-11-13 22:59:24 +000081 function random_element($array)
82 {
Andrey Andreeve5617332012-03-13 12:22:17 +020083 return is_array($array) ? $array[array_rand($array)] : $array;
Barry Mienydd671972010-10-04 16:33:58 +020084 }
Derek Allard2067d1a2008-11-13 22:59:24 +000085}
86
Derek Jones3a082fd2010-10-07 09:38:55 -050087// --------------------------------------------------------------------
88
Derek Jones3a082fd2010-10-07 09:38:55 -050089if ( ! function_exists('elements'))
90{
Timothy Warren01b129a2012-04-27 11:36:50 -040091 /**
92 * Elements
93 *
94 * Returns only the array items specified. Will return a default value if
95 * it is not set.
96 *
97 * @param array
98 * @param array
99 * @param mixed
100 * @return mixed depends on what the array contains
101 */
Andrey Andreevaaca76c2015-04-14 15:51:29 +0300102 function elements($items, array $array, $default = NULL)
Derek Jones3a082fd2010-10-07 09:38:55 -0500103 {
104 $return = array();
Andrey Andreeve5617332012-03-13 12:22:17 +0200105
106 is_array($items) OR $items = array($items);
107
Derek Jones3a082fd2010-10-07 09:38:55 -0500108 foreach ($items as $item)
109 {
Phil Sturgeon6801d042012-07-04 14:43:36 +0200110 $return[$item] = array_key_exists($item, $array) ? $array[$item] : $default;
Derek Jones3a082fd2010-10-07 09:38:55 -0500111 }
112
113 return $return;
114 }
115}