tims-todo/system/helpers/array_helper.php

116 lines
3.4 KiB
PHP
Raw Permalink Normal View History

<?php
2014-08-08 15:41:59 -04:00
/**
* CodeIgniter
*
* An open source application development framework for PHP
2014-08-08 15:41:59 -04:00
*
* This content is released under the MIT License (MIT)
*
* Copyright (c) 2014 - 2019, British Columbia Institute of Technology
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
* @package CodeIgniter
* @author EllisLab Dev Team
* @copyright Copyright (c) 2008 - 2014, EllisLab, Inc. (https://ellislab.com/)
* @copyright Copyright (c) 2014 - 2019, British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 1.0.0
2014-08-08 15:41:59 -04:00
* @filesource
*/
defined('BASEPATH') OR exit('No direct script access allowed');
2014-08-08 15:41:59 -04:00
/**
* CodeIgniter Array Helpers
*
* @package CodeIgniter
* @subpackage Helpers
* @category Helpers
* @author EllisLab Dev Team
* @link https://codeigniter.com/user_guide/helpers/array_helper.html
2014-08-08 15:41:59 -04:00
*/
// ------------------------------------------------------------------------
if ( ! function_exists('element'))
{
/**
* Element
*
* Lets you determine whether an array index is set and whether it has a value.
* If the element is empty it returns NULL (or whatever you specify as the default value.)
*
* @param string
* @param array
* @param mixed
* @return mixed depends on what the array contains
*/
function element($item, array $array, $default = NULL)
2014-08-08 15:41:59 -04:00
{
return array_key_exists($item, $array) ? $array[$item] : $default;
2014-08-08 15:41:59 -04:00
}
}
// ------------------------------------------------------------------------
if ( ! function_exists('random_element'))
{
/**
* Random Element - Takes an array as input and returns a random element
*
* @param array
* @return mixed depends on what the array contains
*/
2014-08-08 15:41:59 -04:00
function random_element($array)
{
return is_array($array) ? $array[array_rand($array)] : $array;
2014-08-08 15:41:59 -04:00
}
}
// --------------------------------------------------------------------
if ( ! function_exists('elements'))
{
/**
* Elements
*
* Returns only the array items specified. Will return a default value if
* it is not set.
*
* @param array
* @param array
* @param mixed
* @return mixed depends on what the array contains
*/
function elements($items, array $array, $default = NULL)
2014-08-08 15:41:59 -04:00
{
$return = array();
is_array($items) OR $items = array($items);
2014-08-08 15:41:59 -04:00
foreach ($items as $item)
{
$return[$item] = array_key_exists($item, $array) ? $array[$item] : $default;
2014-08-08 15:41:59 -04:00
}
return $return;
}
}