3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * Provides a collection of static methods for array manipulation.
32 * @copyright CiviCRM LLC (c) 2004-2019
34 class CRM_Utils_Array
{
37 * Returns $list[$key] if such element exists, or a default value otherwise.
39 * If $list is not actually an array at all, then the default value is
44 * Key value to look up in the array.
46 * Array from which to look up a value.
47 * @param mixed $default
48 * (optional) Value to return $list[$key] does not exist.
51 * Can return any type, since $list might contain anything.
53 public static function value($key, $list, $default = NULL) {
54 if (is_array($list)) {
55 return array_key_exists($key, $list) ?
$list[$key] : $default;
61 * Recursively searches an array for a key, returning the first value found.
63 * If $params[$key] does not exist and $params contains arrays, descend into
64 * each array in a depth-first manner, in array iteration order.
66 * @param array $params
67 * The array to be searched.
69 * The key to search for.
72 * The value of the key, or null if the key is not found.
74 public static function retrieveValueRecursive(&$params, $key) {
75 if (!is_array($params)) {
78 elseif ($value = CRM_Utils_Array
::value($key, $params)) {
82 foreach ($params as $subParam) {
83 if (is_array($subParam) &&
84 $value = self
::retrieveValueRecursive($subParam, $key)
94 * Wraps and slightly changes the behavior of PHP's array_search().
96 * This function reproduces the behavior of array_search() from PHP prior to
97 * version 4.2.0, which was to return NULL on failure. This function also
98 * checks that $list is an array before attempting to search it.
101 * @param mixed $value
102 * The value to search for.
104 * The array to be searched.
106 * @return int|string|null
107 * Returns the key, which could be an int or a string, or NULL on failure.
109 public static function key($value, $list) {
110 if (is_array($list)) {
111 $key = array_search($value, $list);
113 // array_search returns key if found, false otherwise
114 // it may return values like 0 or empty string which
115 // evaluates to false
116 // hence we must use identical comparison operator
117 return ($key === FALSE) ?
NULL : $key;
123 * Builds an XML fragment representing an array.
125 * Depending on the nature of the keys of the array (and its sub-arrays,
126 * if any) the XML fragment may not be valid.
129 * The array to be serialized.
131 * (optional) Indentation depth counter.
132 * @param string $seperator
133 * (optional) String to be appended after open/close tags.
136 * XML fragment representing $list.
138 public static function &xml(&$list, $depth = 1, $seperator = "\n") {
140 foreach ($list as $name => $value) {
141 $xml .= str_repeat(' ', $depth * 4);
142 if (is_array($value)) {
143 $xml .= "<{$name}>{$seperator}";
144 $xml .= self
::xml($value, $depth +
1, $seperator);
145 $xml .= str_repeat(' ', $depth * 4);
146 $xml .= "</{$name}>{$seperator}";
149 // make sure we escape value
150 $value = self
::escapeXML($value);
151 $xml .= "<{$name}>$value</{$name}>{$seperator}";
158 * Sanitizes a string for serialization in CRM_Utils_Array::xml().
160 * Replaces '&', '<', and '>' with their XML escape sequences. Replaces '^A'
163 * @param string $value
164 * String to be sanitized.
167 * Sanitized version of $value.
169 public static function escapeXML($value) {
174 $src = ['&', '<', '>', '\ 1'];
175 $dst = ['&', '<', '>', ','];
178 return str_replace($src, $dst, $value);
182 * Converts a nested array to a flat array.
184 * The nested structure is preserved in the string values of the keys of the
187 * Example nested array:
212 * Corresponding flattened array:
218 * [asdf.merp] => bleep
219 * [asdf.quack.0] => 1
220 * [asdf.quack.1] => 2
221 * [asdf.quack.2] => 3
226 * Array to be flattened.
229 * @param string $prefix
230 * (optional) String to prepend to keys.
231 * @param string $seperator
232 * (optional) String that separates the concatenated keys.
234 public static function flatten(&$list, &$flat, $prefix = '', $seperator = ".") {
235 foreach ($list as $name => $value) {
236 $newPrefix = ($prefix) ?
$prefix . $seperator . $name : $name;
237 if (is_array($value)) {
238 self
::flatten($value, $flat, $newPrefix, $seperator);
241 $flat[$newPrefix] = $value;
247 * Converts an array with path-like keys into a tree of arrays.
249 * This function is the inverse of CRM_Utils_Array::flatten().
251 * @param string $delim
254 * A one-dimensional array indexed by string keys
259 public function unflatten($delim, &$arr) {
261 foreach ($arr as $key => $value) {
262 $path = explode($delim, $key);
264 while (count($path) > 1) {
265 $key = array_shift($path);
266 if (!isset($node[$key])) {
269 $node = &$node[$key];
272 $key = array_shift($path);
273 $node[$key] = $value;
281 * If $a1[foo] and $a2[foo] both exist and are both arrays, the merge
282 * process recurses into those sub-arrays. If $a1[foo] and $a2[foo] both
283 * exist but they are not both arrays, the value from $a1 overrides the
284 * value from $a2 and the value from $a2 is discarded.
287 * First array to be merged.
289 * Second array to be merged.
294 public static function crmArrayMerge($a1, $a2) {
304 foreach ($a1 as $key => $value) {
305 if (array_key_exists($key, $a2) &&
306 is_array($a2[$key]) && is_array($a1[$key])
308 $a3[$key] = array_merge($a1[$key], $a2[$key]);
311 $a3[$key] = $a1[$key];
315 foreach ($a2 as $key => $value) {
316 if (array_key_exists($key, $a1)) {
317 // already handled in above loop
320 $a3[$key] = $a2[$key];
327 * Determines whether an array contains any sub-arrays.
330 * The array to inspect.
333 * True if $list contains at least one sub-array, false otherwise.
335 public static function isHierarchical(&$list) {
336 foreach ($list as $n => $v) {
345 * Is array A a subset of array B.
347 * @param array $subset
348 * @param array $superset
351 * TRUE if $subset is a subset of $superset
353 public static function isSubset($subset, $superset) {
354 foreach ($subset as $expected) {
355 if (!in_array($expected, $superset)) {
363 * Searches an array recursively in an optionally case-insensitive manner.
365 * @param string $value
366 * Value to search for.
367 * @param array $params
368 * Array to search within.
369 * @param bool $caseInsensitive
370 * (optional) Whether to search in a case-insensitive manner.
373 * True if $value was found, false otherwise.
375 public static function crmInArray($value, $params, $caseInsensitive = TRUE) {
376 foreach ($params as $item) {
377 if (is_array($item)) {
378 $ret = crmInArray($value, $item, $caseInsensitive);
381 $ret = ($caseInsensitive) ?
strtolower($item) == strtolower($value) : $item == $value;
391 * Convert associative array names to values and vice-versa.
393 * This function is used by by import functions and some webforms.
395 * @param array $defaults
396 * @param string $property
402 public static function lookupValue(&$defaults, $property, $lookup, $reverse) {
403 $id = $property . '_id';
405 $src = $reverse ?
$property : $id;
406 $dst = $reverse ?
$id : $property;
408 if (!array_key_exists(strtolower($src), array_change_key_case($defaults, CASE_LOWER
))) {
412 $look = $reverse ?
array_flip($lookup) : $lookup;
414 // trim lookup array, ignore . ( fix for CRM-1514 ), eg for prefix/suffix make sure Dr. and Dr both are valid
416 foreach ($look as $k => $v) {
417 $newLook[trim($k, ".")] = $v;
422 if (is_array($look)) {
423 if (!array_key_exists(trim(strtolower($defaults[strtolower($src)]), '.'), array_change_key_case($look, CASE_LOWER
))) {
428 $tempLook = array_change_key_case($look, CASE_LOWER
);
430 $defaults[$dst] = $tempLook[trim(strtolower($defaults[strtolower($src)]), '.')];
435 * Checks whether an array is empty.
437 * An array is empty if its values consist only of NULL and empty sub-arrays.
438 * Containing a non-NULL value or non-empty array makes an array non-empty.
440 * If something other than an array is passed, it is considered to be empty.
442 * If nothing is passed at all, the default value provided is empty.
444 * @param array $array
445 * (optional) Array to be checked for emptiness.
448 * True if the array is empty.
450 public static function crmIsEmptyArray($array = []) {
451 if (!is_array($array)) {
454 foreach ($array as $element) {
455 if (is_array($element)) {
456 if (!self
::crmIsEmptyArray($element)) {
460 elseif (isset($element)) {
468 * Sorts an associative array of arrays by an attribute using strnatcmp().
470 * @param array $array
471 * Array to be sorted.
472 * @param string|array $field
473 * Name of the attribute used for sorting.
478 public static function crmArraySortByField($array, $field) {
479 $fields = (array) $field;
480 uasort($array, function ($a, $b) use ($fields) {
481 foreach ($fields as $f) {
482 $v = strnatcmp($a[$f], $b[$f]);
493 * Recursively removes duplicate values from a multi-dimensional array.
495 * @param array $array
496 * The input array possibly containing duplicate values.
499 * The input array with duplicate values removed.
501 public static function crmArrayUnique($array) {
502 $result = array_map("unserialize", array_unique(array_map("serialize", $array)));
503 foreach ($result as $key => $value) {
504 if (is_array($value)) {
505 $result[$key] = self
::crmArrayUnique($value);
512 * Sorts an array and maintains index association (with localization).
514 * Uses Collate from the PECL "intl" package, if available, for UTF-8
515 * sorting (e.g. list of countries). Otherwise calls PHP's asort().
517 * On Debian/Ubuntu: apt-get install php5-intl
519 * @param array $array
520 * (optional) Array to be sorted.
525 public static function asort($array = []) {
526 $lcMessages = CRM_Utils_System
::getUFLocale();
528 if ($lcMessages && $lcMessages != 'en_US' && class_exists('Collator')) {
529 $collator = new Collator($lcMessages . '.utf8');
530 $collator->asort($array);
533 // This calls PHP's built-in asort().
541 * Unsets an arbitrary list of array elements from an associative array.
543 * @param array $items
544 * The array from which to remove items.
547 * When passed a string, unsets $items[$key].
548 * When passed an array of strings, unsets $items[$k] for each string $k in the array.
550 public static function remove(&$items) {
551 foreach (func_get_args() as $n => $key) {
552 // Skip argument 0 ($items) by testing $n for truth.
553 if ($n && is_array($key)) {
554 foreach ($key as $k) {
565 * Builds an array-tree which indexes the records in an array.
567 * @param string[] $keys
568 * Properties by which to index.
569 * @param object|array $records
572 * Multi-dimensional array, with one layer for each key.
574 public static function index($keys, $records) {
575 $final_key = array_pop($keys);
578 foreach ($records as $record) {
580 foreach ($keys as $key) {
581 if (is_array($record)) {
582 $keyvalue = isset($record[$key]) ?
$record[$key] : NULL;
585 $keyvalue = isset($record->{$key}) ?
$record->{$key} : NULL;
587 if (isset($node[$keyvalue]) && !is_array($node[$keyvalue])) {
588 $node[$keyvalue] = [];
590 $node = &$node[$keyvalue];
592 if (is_array($record)) {
593 $node[$record[$final_key]] = $record;
596 $node[$record->{$final_key}] = $record;
603 * Iterates over a list of records and returns the value of some property.
605 * @param string $prop
606 * Property to retrieve.
607 * @param array|object $records
611 * Keys are the original keys of $records; values are the $prop values.
613 public static function collect($prop, $records) {
615 if (is_array($records)) {
616 foreach ($records as $key => $record) {
617 if (is_object($record)) {
618 $result[$key] = $record->{$prop};
621 $result[$key] = self
::value($prop, $record);
629 * Iterates over a list of objects and executes some method on each.
632 * - This is like array_map(), except it executes the objects' method
633 * instead of a free-form callable.
634 * - This is like Array::collect(), except it uses a method
635 * instead of a property.
637 * @param string $method
638 * The method to execute.
639 * @param array|Traversable $objects
642 * An optional list of arguments to pass to the method.
645 * Keys are the original keys of $objects; values are the method results.
647 public static function collectMethod($method, $objects, $args = []) {
649 if (is_array($objects)) {
650 foreach ($objects as $key => $object) {
651 $result[$key] = call_user_func_array([$object, $method], $args);
658 * Trims delimiters from a string and then splits it using explode().
660 * This method works mostly like PHP's built-in explode(), except that
661 * surrounding delimiters are trimmed before explode() is called.
663 * Also, if an array or NULL is passed as the $values parameter, the value is
664 * returned unmodified rather than being passed to explode().
666 * @param array|null|string $values
667 * The input string (or an array, or NULL).
668 * @param string $delim
669 * (optional) The boundary string.
672 * An array of strings produced by explode(), or the unmodified input
675 public static function explodePadded($values, $delim = CRM_Core_DAO
::VALUE_SEPARATOR
) {
676 if ($values === NULL) {
679 // If we already have an array, no need to continue
680 if (is_array($values)) {
683 // Empty string -> empty array
684 if ($values === '') {
687 return explode($delim, trim((string) $values, $delim));
691 * Joins array elements with a string, adding surrounding delimiters.
693 * This method works mostly like PHP's built-in implode(), but the generated
694 * string is surrounded by delimiter characters. Also, if NULL is passed as
695 * the $values parameter, NULL is returned.
697 * @param mixed $values
698 * Array to be imploded. If a non-array is passed, it will be cast to an
700 * @param string $delim
701 * Delimiter to be used for implode() and which will surround the output
704 * @return string|NULL
705 * The generated string, or NULL if NULL was passed as $values parameter.
707 public static function implodePadded($values, $delim = CRM_Core_DAO
::VALUE_SEPARATOR
) {
708 if ($values === NULL) {
711 // If we already have a string, strip $delim off the ends so it doesn't get added twice
712 if (is_string($values)) {
713 $values = trim($values, $delim);
715 return $delim . implode($delim, (array) $values) . $delim;
719 * Modifies a key in an array while preserving the key order.
721 * By default when an element is added to an array, it is added to the end.
722 * This method allows for changing an existing key while preserving its
723 * position in the array.
725 * The array is both modified in-place and returned.
727 * @param array $elementArray
728 * Array to manipulate.
729 * @param string $oldKey
730 * Old key to be replaced.
731 * @param string $newKey
732 * Replacement key string.
735 * Throws a generic Exception if $oldKey is not found in $elementArray.
738 * The manipulated array.
740 public static function crmReplaceKey(&$elementArray, $oldKey, $newKey) {
741 $keys = array_keys($elementArray);
742 if (FALSE === $index = array_search($oldKey, $keys)) {
743 throw new Exception(sprintf('key "%s" does not exit', $oldKey));
745 $keys[$index] = $newKey;
746 $elementArray = array_combine($keys, array_values($elementArray));
747 return $elementArray;
751 * Searches array keys by regex, returning the value of the first match.
753 * Given a regular expression and an array, this method searches the keys
754 * of the array using the regular expression. The first match is then used
755 * to index into the array, and the associated value is retrieved and
756 * returned. If no matches are found, or if something other than an array
757 * is passed, then a default value is returned. Unless otherwise specified,
758 * the default value is NULL.
760 * @param string $regexKey
761 * The regular expression to use when searching for matching keys.
763 * The array whose keys will be searched.
764 * @param mixed $default
765 * (optional) The default value to return if the regex does not match an
766 * array key, or if something other than an array is passed.
771 public static function valueByRegexKey($regexKey, $list, $default = NULL) {
772 if (is_array($list) && $regexKey) {
773 $matches = preg_grep($regexKey, array_keys($list));
774 $key = reset($matches);
775 return ($key && array_key_exists($key, $list)) ?
$list[$key] : $default;
781 * Generates the Cartesian product of zero or more vectors.
783 * @param array $dimensions
784 * List of dimensions to multiply.
785 * Each key is a dimension name; each value is a vector.
786 * @param array $template
787 * (optional) A base set of values included in every output.
790 * Each item is a distinct combination of values from $dimensions.
792 * For example, the product of
795 * bg => {white, black}
799 * {fg => red, bg => white},
800 * {fg => red, bg => black},
801 * {fg => blue, bg => white},
802 * {fg => blue, bg => black}
805 public static function product($dimensions, $template = []) {
806 if (empty($dimensions)) {
810 foreach ($dimensions as $key => $value) {
812 $firstValues = $value;
815 unset($dimensions[$key]);
818 foreach ($firstValues as $firstValue) {
819 foreach (self
::product($dimensions, $template) as $result) {
820 $result[$firstKey] = $firstValue;
821 $results[] = $result;
829 * Get the first element of an array.
831 * @param array $array
834 public static function first($array) {
835 foreach ($array as $value) {
842 * Extract any $keys from $array and copy to a new array.
844 * Note: If a $key does not appear in $array, then it will
845 * not appear in the result.
847 * @param array $array
849 * List of keys to copy.
852 public static function subset($array, $keys) {
854 foreach ($keys as $key) {
855 if (isset($array[$key])) {
856 $result[$key] = $array[$key];
863 * Transform an associative array of key=>value pairs into a non-associative array of arrays.
864 * This is necessary to preserve sort order when sending an array through json_encode.
866 * @param array $associative
867 * Ex: ['foo' => 'bar'].
868 * @param string $keyName
870 * @param string $valueName
873 * Ex: [0 => ['key' => 'foo', 'value' => 'bar']].
875 public static function makeNonAssociative($associative, $keyName = 'key', $valueName = 'value') {
877 foreach ($associative as $key => $val) {
878 $output[] = [$keyName => $key, $valueName => $val];
884 * Diff multidimensional arrays
885 * (array_diff does not support multidimensional array)
887 * @param array $array1
888 * @param array $array2
891 public static function multiArrayDiff($array1, $array2) {
893 foreach ($array1 as $mKey => $mValue) {
894 if (array_key_exists($mKey, $array2)) {
895 if (is_array($mValue)) {
896 $recursiveDiff = self
::multiArrayDiff($mValue, $array2[$mKey]);
897 if (count($recursiveDiff)) {
898 $arrayDiff[$mKey] = $recursiveDiff;
902 if ($mValue != $array2[$mKey]) {
903 $arrayDiff[$mKey] = $mValue;
908 $arrayDiff[$mKey] = $mValue;
915 * Given a 2-dimensional matrix, create a new matrix with a restricted list of columns.
917 * @param array $matrix
918 * All matrix data, as a list of rows.
919 * @param array $columns
920 * List of column names.
923 public static function filterColumns($matrix, $columns) {
925 foreach ($matrix as $pos => $oldRow) {
927 foreach ($columns as $column) {
928 $newRow[$column] = CRM_Utils_Array
::value($column, $oldRow);
930 $newRows[$pos] = $newRow;
936 * Rewrite the keys in an array.
938 * @param array $array
939 * @param string|callable $indexBy
940 * Either the value to key by, or a function($key, $value) that returns the new key.
943 public static function rekey($array, $indexBy) {
945 foreach ($array as $key => $value) {
946 $newKey = is_callable($indexBy) ?
$indexBy($key, $value) : $value[$indexBy];
947 $result[$newKey] = $value;
953 * Copy all properties of $other into $array (recursively).
955 * @param array|ArrayAccess $array
956 * @param array $other
958 public static function extend(&$array, $other) {
959 foreach ($other as $key => $value) {
960 if (is_array($value)) {
961 self
::extend($array[$key], $value);
964 $array[$key] = $value;
970 * Get a single value from an array-tree.
972 * @param array $values
973 * Ex: ['foo' => ['bar' => 123]].
975 * Ex: ['foo', 'bar'].
976 * @param mixed $default
980 public static function pathGet($values, $path, $default = NULL) {
981 foreach ($path as $key) {
982 if (!is_array($values) ||
!isset($values[$key])) {
985 $values = $values[$key];
991 * Check if a key isset which may be several layers deep.
993 * This is a helper for when the calling function does not know how many layers deep
994 * the path array is so cannot easily check.
996 * @param array $values
1000 public static function pathIsset($values, $path) {
1001 foreach ($path as $key) {
1002 if (!is_array($values) ||
!isset($values[$key])) {
1005 $values = $values[$key];
1011 * Set a single value in an array tree.
1013 * @param array $values
1014 * Ex: ['foo' => ['bar' => 123]].
1015 * @param array $pathParts
1016 * Ex: ['foo', 'bar'].
1020 public static function pathSet(&$values, $pathParts, $value) {
1022 $last = array_pop($pathParts);
1023 foreach ($pathParts as $part) {
1024 if (!isset($r[$part])) {
1033 * Convert a simple dictionary into separate key+value records.
1035 * @param array $array
1036 * Ex: array('foo' => 'bar').
1037 * @param string $keyField
1039 * @param string $valueField
1044 public static function toKeyValueRows($array, $keyField = 'key', $valueField = 'value') {
1045 return self
::makeNonAssociative($array, $keyField, $valueField);
1049 * Convert array where key(s) holds the actual value and value(s) as 1 into array of actual values
1050 * Ex: array('foobar' => 1, 4 => 1) formatted into array('foobar', 4)
1052 * @deprecated use convertCheckboxInputToArray instead (after testing)
1053 * https://github.com/civicrm/civicrm-core/pull/8169
1055 * @param array $array
1057 public static function formatArrayKeys(&$array) {
1058 if (!is_array($array)) {
1061 $keys = array_keys($array, 1);
1062 if (count($keys) > 1 ||
1063 (count($keys) == 1 &&
1064 (current($keys) > 1 ||
1065 is_string(current($keys)) ||
1066 // handle (0 => 4), (1 => 1)
1067 (current($keys) == 1 && $array[1] == 1)
1076 * Convert the data format coming in from checkboxes to an array of values.
1078 * The input format from check boxes looks like
1079 * array('value1' => 1, 'value2' => 1). This function converts those values to
1080 * array(''value1', 'value2).
1082 * The function will only alter the array if all values are equal to 1.
1084 * @param array $input
1088 public static function convertCheckboxFormatToArray($input) {
1089 if (isset($input[0])) {
1092 $keys = array_keys($input, 1);
1093 if ((count($keys) == count($input))) {
1100 * Ensure that array is encoded in utf8 format.
1102 * @param array $array
1104 * @return array $array utf8-encoded.
1106 public static function encode_items($array) {
1107 foreach ($array as $key => $value) {
1108 if (is_array($value)) {
1109 $array[$key] = self
::encode_items($value);
1111 elseif (is_string($value)) {
1112 $array[$key] = mb_convert_encoding($value, mb_detect_encoding($value, mb_detect_order(), TRUE), 'UTF-8');
1115 $array[$key] = $value;
1122 * Build tree of elements.
1124 * @param array $elements
1125 * @param int|null $parentId
1129 public static function buildTree($elements, $parentId = NULL) {
1132 foreach ($elements as $element) {
1133 if ($element['parent_id'] == $parentId) {
1134 $children = self
::buildTree($elements, $element['id']);
1136 $element['children'] = $children;
1138 $branch[] = $element;
1146 * Find search string in tree.
1148 * @param string $search
1149 * @param array $tree
1150 * @param string $field
1152 * @return array|null
1154 public static function findInTree($search, $tree, $field = 'id') {
1155 foreach ($tree as $item) {
1156 if ($item[$field] == $search) {
1159 if (!empty($item['children'])) {
1160 $found = self
::findInTree($search, $item['children']);