3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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-2016
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 = array('&', '<', '>', '\ 1');
175 $dst = array('&', '<', '>', ',');
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 if (!empty($value)) {
242 $flat[$newPrefix] = $value;
249 * Converts an array with path-like keys into a tree of arrays.
251 * This function is the inverse of CRM_Utils_Array::flatten().
253 * @param string $delim
256 * A one-dimensional array indexed by string keys
261 public function unflatten($delim, &$arr) {
263 foreach ($arr as $key => $value) {
264 $path = explode($delim, $key);
266 while (count($path) > 1) {
267 $key = array_shift($path);
268 if (!isset($node[$key])) {
269 $node[$key] = array();
271 $node = &$node[$key];
274 $key = array_shift($path);
275 $node[$key] = $value;
283 * If $a1[foo] and $a2[foo] both exist and are both arrays, the merge
284 * process recurses into those sub-arrays. If $a1[foo] and $a2[foo] both
285 * exist but they are not both arrays, the value from $a1 overrides the
286 * value from $a2 and the value from $a2 is discarded.
289 * First array to be merged.
291 * Second array to be merged.
296 public static function crmArrayMerge($a1, $a2) {
306 foreach ($a1 as $key => $value) {
307 if (array_key_exists($key, $a2) &&
308 is_array($a2[$key]) && is_array($a1[$key])
310 $a3[$key] = array_merge($a1[$key], $a2[$key]);
313 $a3[$key] = $a1[$key];
317 foreach ($a2 as $key => $value) {
318 if (array_key_exists($key, $a1)) {
319 // already handled in above loop
322 $a3[$key] = $a2[$key];
329 * Determines whether an array contains any sub-arrays.
332 * The array to inspect.
335 * True if $list contains at least one sub-array, false otherwise.
337 public static function isHierarchical(&$list) {
338 foreach ($list as $n => $v) {
347 * Is array A a subset of array B.
349 * @param array $subset
350 * @param array $superset
353 * TRUE if $subset is a subset of $superset
355 public static function isSubset($subset, $superset) {
356 foreach ($subset as $expected) {
357 if (!in_array($expected, $superset)) {
365 * Searches an array recursively in an optionally case-insensitive manner.
367 * @param string $value
368 * Value to search for.
369 * @param array $params
370 * Array to search within.
371 * @param bool $caseInsensitive
372 * (optional) Whether to search in a case-insensitive manner.
375 * True if $value was found, false otherwise.
377 public static function crmInArray($value, $params, $caseInsensitive = TRUE) {
378 foreach ($params as $item) {
379 if (is_array($item)) {
380 $ret = crmInArray($value, $item, $caseInsensitive);
383 $ret = ($caseInsensitive) ?
strtolower($item) == strtolower($value) : $item == $value;
393 * Convert associative array names to values and vice-versa.
395 * This function is used by both the web form layer and the api. Note that
396 * the api needs the name => value conversion, also the view layer typically
397 * requires value => name conversion
399 * @param array $defaults
400 * @param string $property
406 public static function lookupValue(&$defaults, $property, $lookup, $reverse) {
407 $id = $property . '_id';
409 $src = $reverse ?
$property : $id;
410 $dst = $reverse ?
$id : $property;
412 if (!array_key_exists(strtolower($src), array_change_key_case($defaults, CASE_LOWER
))) {
416 $look = $reverse ?
array_flip($lookup) : $lookup;
418 // trim lookup array, ignore . ( fix for CRM-1514 ), eg for prefix/suffix make sure Dr. and Dr both are valid
420 foreach ($look as $k => $v) {
421 $newLook[trim($k, ".")] = $v;
426 if (is_array($look)) {
427 if (!array_key_exists(trim(strtolower($defaults[strtolower($src)]), '.'), array_change_key_case($look, CASE_LOWER
))) {
432 $tempLook = array_change_key_case($look, CASE_LOWER
);
434 $defaults[$dst] = $tempLook[trim(strtolower($defaults[strtolower($src)]), '.')];
439 * Checks whether an array is empty.
441 * An array is empty if its values consist only of NULL and empty sub-arrays.
442 * Containing a non-NULL value or non-empty array makes an array non-empty.
444 * If something other than an array is passed, it is considered to be empty.
446 * If nothing is passed at all, the default value provided is empty.
448 * @param array $array
449 * (optional) Array to be checked for emptiness.
452 * True if the array is empty.
454 public static function crmIsEmptyArray($array = array()) {
455 if (!is_array($array)) {
458 foreach ($array as $element) {
459 if (is_array($element)) {
460 if (!self
::crmIsEmptyArray($element)) {
464 elseif (isset($element)) {
472 * Sorts an associative array of arrays by an attribute using strnatcmp().
474 * @param array $array
475 * Array to be sorted.
476 * @param string $field
477 * Name of the attribute used for sorting.
482 public static function crmArraySortByField($array, $field) {
483 $code = "return strnatcmp(\$a['$field'], \$b['$field']);";
484 uasort($array, create_function('$a,$b', $code));
489 * Recursively removes duplicate values from a multi-dimensional array.
491 * @param array $array
492 * The input array possibly containing duplicate values.
495 * The input array with duplicate values removed.
497 public static function crmArrayUnique($array) {
498 $result = array_map("unserialize", array_unique(array_map("serialize", $array)));
499 foreach ($result as $key => $value) {
500 if (is_array($value)) {
501 $result[$key] = self
::crmArrayUnique($value);
508 * Sorts an array and maintains index association (with localization).
510 * Uses Collate from the PECL "intl" package, if available, for UTF-8
511 * sorting (e.g. list of countries). Otherwise calls PHP's asort().
513 * On Debian/Ubuntu: apt-get install php5-intl
515 * @param array $array
516 * (optional) Array to be sorted.
521 public static function asort($array = array()) {
522 $lcMessages = CRM_Utils_System
::getUFLocale();
524 if ($lcMessages && $lcMessages != 'en_US' && class_exists('Collator')) {
525 $collator = new Collator($lcMessages . '.utf8');
526 $collator->asort($array);
529 // This calls PHP's built-in asort().
537 * Unsets an arbitrary list of array elements from an associative array.
539 * @param array $items
540 * The array from which to remove items.
543 * When passed a string, unsets $items[$key].
544 * When passed an array of strings, unsets $items[$k] for each string $k in the array.
546 public static function remove(&$items) {
547 foreach (func_get_args() as $n => $key) {
548 // Skip argument 0 ($items) by testing $n for truth.
549 if ($n && is_array($key)) {
550 foreach ($key as $k) {
561 * Builds an array-tree which indexes the records in an array.
563 * @param string[] $keys
564 * Properties by which to index.
565 * @param object|array $records
568 * Multi-dimensional array, with one layer for each key.
570 public static function index($keys, $records) {
571 $final_key = array_pop($keys);
574 foreach ($records as $record) {
576 foreach ($keys as $key) {
577 if (is_array($record)) {
578 $keyvalue = isset($record[$key]) ?
$record[$key] : NULL;
581 $keyvalue = isset($record->{$key}) ?
$record->{$key} : NULL;
583 if (isset($node[$keyvalue]) && !is_array($node[$keyvalue])) {
584 $node[$keyvalue] = array();
586 $node = &$node[$keyvalue];
588 if (is_array($record)) {
589 $node[$record[$final_key]] = $record;
592 $node[$record->{$final_key}] = $record;
599 * Iterates over a list of records and returns the value of some property.
601 * @param string $prop
602 * Property to retrieve.
603 * @param array|object $records
607 * Keys are the original keys of $records; values are the $prop values.
609 public static function collect($prop, $records) {
611 if (is_array($records)) {
612 foreach ($records as $key => $record) {
613 if (is_object($record)) {
614 $result[$key] = $record->{$prop};
617 $result[$key] = $record[$prop];
625 * Iterates over a list of objects and executes some method on each.
628 * - This is like array_map(), except it executes the objects' method
629 * instead of a free-form callable.
630 * - This is like Array::collect(), except it uses a method
631 * instead of a property.
633 * @param string $method
634 * The method to execute.
635 * @param array|Traversable $objects
638 * An optional list of arguments to pass to the method.
641 * Keys are the original keys of $objects; values are the method results.
643 public static function collectMethod($method, $objects, $args = array()) {
645 if (is_array($objects)) {
646 foreach ($objects as $key => $object) {
647 $result[$key] = call_user_func_array(array($object, $method), $args);
654 * Trims delimiters from a string and then splits it using explode().
656 * This method works mostly like PHP's built-in explode(), except that
657 * surrounding delimiters are trimmed before explode() is called.
659 * Also, if an array or NULL is passed as the $values parameter, the value is
660 * returned unmodified rather than being passed to explode().
662 * @param array|null|string $values
663 * The input string (or an array, or NULL).
664 * @param string $delim
665 * (optional) The boundary string.
668 * An array of strings produced by explode(), or the unmodified input
671 public static function explodePadded($values, $delim = CRM_Core_DAO
::VALUE_SEPARATOR
) {
672 if ($values === NULL) {
675 // If we already have an array, no need to continue
676 if (is_array($values)) {
679 // Empty string -> empty array
680 if ($values === '') {
683 return explode($delim, trim((string) $values, $delim));
687 * Joins array elements with a string, adding surrounding delimiters.
689 * This method works mostly like PHP's built-in implode(), but the generated
690 * string is surrounded by delimiter characters. Also, if NULL is passed as
691 * the $values parameter, NULL is returned.
693 * @param mixed $values
694 * Array to be imploded. If a non-array is passed, it will be cast to an
696 * @param string $delim
697 * Delimiter to be used for implode() and which will surround the output
700 * @return string|NULL
701 * The generated string, or NULL if NULL was passed as $values parameter.
703 public static function implodePadded($values, $delim = CRM_Core_DAO
::VALUE_SEPARATOR
) {
704 if ($values === NULL) {
707 // If we already have a string, strip $delim off the ends so it doesn't get added twice
708 if (is_string($values)) {
709 $values = trim($values, $delim);
711 return $delim . implode($delim, (array) $values) . $delim;
715 * Modifies a key in an array while preserving the key order.
717 * By default when an element is added to an array, it is added to the end.
718 * This method allows for changing an existing key while preserving its
719 * position in the array.
721 * The array is both modified in-place and returned.
723 * @param array $elementArray
724 * Array to manipulate.
725 * @param string $oldKey
726 * Old key to be replaced.
727 * @param string $newKey
728 * Replacement key string.
731 * Throws a generic Exception if $oldKey is not found in $elementArray.
734 * The manipulated array.
736 public static function crmReplaceKey(&$elementArray, $oldKey, $newKey) {
737 $keys = array_keys($elementArray);
738 if (FALSE === $index = array_search($oldKey, $keys)) {
739 throw new Exception(sprintf('key "%s" does not exit', $oldKey));
741 $keys[$index] = $newKey;
742 $elementArray = array_combine($keys, array_values($elementArray));
743 return $elementArray;
747 * Searches array keys by regex, returning the value of the first match.
749 * Given a regular expression and an array, this method searches the keys
750 * of the array using the regular expression. The first match is then used
751 * to index into the array, and the associated value is retrieved and
752 * returned. If no matches are found, or if something other than an array
753 * is passed, then a default value is returned. Unless otherwise specified,
754 * the default value is NULL.
756 * @param string $regexKey
757 * The regular expression to use when searching for matching keys.
759 * The array whose keys will be searched.
760 * @param mixed $default
761 * (optional) The default value to return if the regex does not match an
762 * array key, or if something other than an array is passed.
767 public static function valueByRegexKey($regexKey, $list, $default = NULL) {
768 if (is_array($list) && $regexKey) {
769 $matches = preg_grep($regexKey, array_keys($list));
770 $key = reset($matches);
771 return ($key && array_key_exists($key, $list)) ?
$list[$key] : $default;
777 * Generates the Cartesian product of zero or more vectors.
779 * @param array $dimensions
780 * List of dimensions to multiply.
781 * Each key is a dimension name; each value is a vector.
782 * @param array $template
783 * (optional) A base set of values included in every output.
786 * Each item is a distinct combination of values from $dimensions.
788 * For example, the product of
791 * bg => {white, black}
795 * {fg => red, bg => white},
796 * {fg => red, bg => black},
797 * {fg => blue, bg => white},
798 * {fg => blue, bg => black}
801 public static function product($dimensions, $template = array()) {
802 if (empty($dimensions)) {
803 return array($template);
806 foreach ($dimensions as $key => $value) {
808 $firstValues = $value;
811 unset($dimensions[$key]);
814 foreach ($firstValues as $firstValue) {
815 foreach (self
::product($dimensions, $template) as $result) {
816 $result[$firstKey] = $firstValue;
817 $results[] = $result;
825 * Get the first element of an array.
827 * @param array $array
830 public static function first($array) {
831 foreach ($array as $value) {
838 * Extract any $keys from $array and copy to a new array.
840 * Note: If a $key does not appear in $array, then it will
841 * not appear in the result.
843 * @param array $array
845 * List of keys to copy.
848 public static function subset($array, $keys) {
850 foreach ($keys as $key) {
851 if (isset($array[$key])) {
852 $result[$key] = $array[$key];
859 * Transform an associative array of key=>value pairs into a non-associative array of arrays.
860 * This is necessary to preserve sort order when sending an array through json_encode.
862 * @param array $associative
863 * @param string $keyName
864 * @param string $valueName
867 public static function makeNonAssociative($associative, $keyName = 'key', $valueName = 'value') {
869 foreach ($associative as $key => $val) {
870 $output[] = array($keyName => $key, $valueName => $val);
876 * Diff multidimensional arrays
877 * (array_diff does not support multidimensional array)
879 * @param array $array1
880 * @param array $array2
883 public static function multiArrayDiff($array1, $array2) {
884 $arrayDiff = array();
885 foreach ($array1 as $mKey => $mValue) {
886 if (array_key_exists($mKey, $array2)) {
887 if (is_array($mValue)) {
888 $recursiveDiff = self
::multiArrayDiff($mValue, $array2[$mKey]);
889 if (count($recursiveDiff)) {
890 $arrayDiff[$mKey] = $recursiveDiff;
894 if ($mValue != $array2[$mKey]) {
895 $arrayDiff[$mKey] = $mValue;
900 $arrayDiff[$mKey] = $mValue;
907 * Given a 2-dimensional matrix, create a new matrix with a restricted list of columns.
909 * @param array $matrix
910 * All matrix data, as a list of rows.
911 * @param array $columns
912 * List of column names.
915 public static function filterColumns($matrix, $columns) {
917 foreach ($matrix as $pos => $oldRow) {
919 foreach ($columns as $column) {
920 $newRow[$column] = CRM_Utils_Array
::value($column, $oldRow);
922 $newRows[$pos] = $newRow;
928 * Rewrite the keys in an array by filtering through a function.
930 * @param array $array
931 * @param callable $func
932 * Function($key, $value). Returns the new key.
935 public static function rekey($array, $func) {
937 foreach ($array as $key => $value) {
938 $newKey = $func($key, $value);
939 $result[$newKey] = $value;
945 * Copy all properties of $other into $array (recursively).
947 * @param array|ArrayAccess $array
948 * @param array $other
950 public static function extend(&$array, $other) {
951 foreach ($other as $key => $value) {
952 if (is_array($value)) {
953 self
::extend($array[$key], $value);
956 $array[$key] = $value;
962 * Get a single value from an array-tre.
965 * Ex: array('foo'=>array('bar'=>123)).
966 * @param array $pathParts
967 * Ex: array('foo',bar').
971 public static function pathGet($arr, $pathParts) {
973 foreach ($pathParts as $part) {
974 if (!isset($r[$part])) {
983 * Set a single value in an array tree.
986 * Ex: array('foo'=>array('bar'=>123)).
987 * @param array $pathParts
988 * Ex: array('foo',bar').
992 public static function pathSet(&$arr, $pathParts, $value) {
994 $last = array_pop($pathParts);
995 foreach ($pathParts as $part) {
996 if (!isset($r[$part])) {
1005 * Convert a simple dictionary into separate key+value records.
1007 * @param array $array
1008 * Ex: array('foo' => 'bar').
1009 * @param string $keyField
1011 * @param string $valueField
1015 * 0 => array('key' => 'foo', 'value' => 'bar')
1018 public static function toKeyValueRows($array, $keyField = 'key', $valueField = 'value') {
1020 foreach ($array as $key => $value) {
1023 $valueField => $value,
1030 * Convert array where key(s) holds the actual value and value(s) as 1 into array of actual values
1031 * Ex: array('foobar' => 1, 4 => 1) formatted into array('foobar', 4)
1033 * @deprecated use convertCheckboxInputToArray instead (after testing)
1034 * https://github.com/civicrm/civicrm-core/pull/8169
1036 * @param array $array
1038 public static function formatArrayKeys(&$array) {
1039 if (!is_array($array)) {
1042 $keys = array_keys($array, 1);
1043 if (count($keys) > 1 ||
1044 (count($keys) == 1 &&
1045 (current($keys) > 1 ||
1046 is_string(current($keys)) ||
1047 (current($keys) == 1 && $array[1] == 1) // handle (0 => 4), (1 => 1)
1056 * Convert the data format coming in from checkboxes to an array of values.
1058 * The input format from check boxes looks like
1059 * array('value1' => 1, 'value2' => 1). This function converts those values to
1060 * array(''value1', 'value2).
1062 * The function will only alter the array if all values are equal to 1.
1064 * @param array $input
1068 public static function convertCheckboxFormatToArray($input) {
1069 if (isset($input[0])) {
1072 $keys = array_keys($input, 1);
1073 if ((count($keys) == count($input))) {
1080 * Ensure that array is encoded in utf8 format.
1082 * @param array $array
1084 * @return array $array utf8-encoded.
1086 public static function encode_items($array) {
1087 foreach ($array as $key => $value) {
1088 if (is_array($value)) {
1089 $array[$key] = self
::encode_items($value);
1091 elseif (is_string($value)) {
1092 $array[$key] = mb_convert_encoding($value, mb_detect_encoding($value, mb_detect_order(), TRUE), 'UTF-8');
1095 $array[$key] = $value;