array_helper.php 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  1. <?php
  2. /**
  3. * CodeIgniter
  4. *
  5. * An open source application development framework for PHP
  6. *
  7. * This content is released under the MIT License (MIT)
  8. *
  9. * Copyright (c) 2014 - 2019, British Columbia Institute of Technology
  10. *
  11. * 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:
  17. *
  18. * 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
  31. * @copyright Copyright (c) 2008 - 2014, EllisLab, Inc. (https://ellislab.com/)
  32. * @copyright Copyright (c) 2014 - 2019, British Columbia Institute of Technology (https://bcit.ca/)
  33. * @license https://opensource.org/licenses/MIT MIT License
  34. * @link https://codeigniter.com
  35. * @since Version 1.0.0
  36. * @filesource
  37. */
  38. defined('BASEPATH') OR exit('No direct script access allowed');
  39. /**
  40. * CodeIgniter Array Helpers
  41. *
  42. * @package CodeIgniter
  43. * @subpackage Helpers
  44. * @category Helpers
  45. * @author EllisLab Dev Team
  46. * @link https://codeigniter.com/user_guide/helpers/array_helper.html
  47. */
  48. // ------------------------------------------------------------------------
  49. if ( ! function_exists('element'))
  50. {
  51. /**
  52. * Element
  53. *
  54. * Lets you determine whether an array index is set and whether it has a value.
  55. * If the element is empty it returns NULL (or whatever you specify as the default value.)
  56. *
  57. * @param string
  58. * @param array
  59. * @param mixed
  60. * @return mixed depends on what the array contains
  61. */
  62. function element($item, array $array, $default = NULL)
  63. {
  64. return array_key_exists($item, $array) ? $array[$item] : $default;
  65. }
  66. }
  67. // ------------------------------------------------------------------------
  68. if ( ! function_exists('random_element'))
  69. {
  70. /**
  71. * Random Element - Takes an array as input and returns a random element
  72. *
  73. * @param array
  74. * @return mixed depends on what the array contains
  75. */
  76. function random_element($array)
  77. {
  78. return is_array($array) ? $array[array_rand($array)] : $array;
  79. }
  80. }
  81. // --------------------------------------------------------------------
  82. if ( ! function_exists('elements'))
  83. {
  84. /**
  85. * Elements
  86. *
  87. * Returns only the array items specified. Will return a default value if
  88. * it is not set.
  89. *
  90. * @param array
  91. * @param array
  92. * @param mixed
  93. * @return mixed depends on what the array contains
  94. */
  95. function elements($items, array $array, $default = NULL)
  96. {
  97. $return = array();
  98. is_array($items) OR $items = array($items);
  99. foreach ($items as $item)
  100. {
  101. $return[$item] = array_key_exists($item, $array) ? $array[$item] : $default;
  102. }
  103. return $return;
  104. }
  105. }