BaseArrayHelper.php 13.7 KB
Newer Older
Qiang Xue committed
1 2 3 4 5 6 7
<?php
/**
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @link http://www.yiiframework.com/
 * @license http://www.yiiframework.com/license/
 */

8
namespace yii\helpers;
Qiang Xue committed
9 10

use Yii;
11
use yii\base\Arrayable;
Qiang Xue committed
12 13 14
use yii\base\InvalidParamException;

/**
15
 * BaseArrayHelper provides concrete implementation for [[ArrayHelper]].
16
 *
17
 * Do not use BaseArrayHelper. Use [[ArrayHelper]] instead.
Qiang Xue committed
18 19 20 21
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
22
class BaseArrayHelper
Qiang Xue committed
23
{
24
	/**
25
	 * Converts an object or an array of objects into an array.
26
	 * @param object|array $object the object to be converted into an array
27 28 29 30
	 * @param array $properties a mapping from object class names to the properties that need to put into the resulting arrays.
	 * The properties specified for each class is an array of the following format:
	 *
	 * ~~~
Alexander Makarov committed
31 32
	 * [
	 *     'app\models\Post' => [
33 34 35 36 37 38 39 40
	 *         'id',
	 *         'title',
	 *         // the key name in array result => property name
	 *         'createTime' => 'create_time',
	 *         // the key name in array result => anonymous function
	 *         'length' => function ($post) {
	 *             return strlen($post->content);
	 *         },
Alexander Makarov committed
41 42
	 *     ],
	 * ]
43 44 45 46 47
	 * ~~~
	 *
	 * The result of `ArrayHelper::toArray($post, $properties)` could be like the following:
	 *
	 * ~~~
Alexander Makarov committed
48
	 * [
49 50 51 52
	 *     'id' => 123,
	 *     'title' => 'test',
	 *     'createTime' => '2013-01-01 12:00AM',
	 *     'length' => 301,
Alexander Makarov committed
53
	 * ]
54 55
	 * ~~~
	 *
56 57 58
	 * @param boolean $recursive whether to recursively converts properties which are objects into arrays.
	 * @return array the array representation of the object
	 */
Alexander Makarov committed
59
	public static function toArray($object, $properties = [], $recursive = true)
60
	{
61 62 63
		if (!empty($properties) && is_object($object)) {
			$className = get_class($object);
			if (!empty($properties[$className])) {
Alexander Makarov committed
64
				$result = [];
65 66 67 68 69 70 71 72 73 74
				foreach ($properties[$className] as $key => $name) {
					if (is_int($key)) {
						$result[$name] = $object->$name;
					} else {
						$result[$key] = static::getValue($object, $name);
					}
				}
				return $result;
			}
		}
75 76 77 78 79 80
		if ($object instanceof Arrayable) {
			$object = $object->toArray();
			if (!$recursive) {
				return $object;
			}
		}
Alexander Makarov committed
81
		$result = [];
82 83 84 85 86 87 88 89 90 91
		foreach ($object as $key => $value) {
			if ($recursive && (is_array($value) || is_object($value))) {
				$result[$key] = static::toArray($value, true);
			} else {
				$result[$key] = $value;
			}
		}
		return $result;
	}

Qiang Xue committed
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
	/**
	 * Merges two or more arrays into one recursively.
	 * If each array has an element with the same string key value, the latter
	 * will overwrite the former (different from array_merge_recursive).
	 * Recursive merging will be conducted if both arrays have an element of array
	 * type and are having the same key.
	 * For integer-keyed elements, the elements from the latter array will
	 * be appended to the former array.
	 * @param array $a array to be merged to
	 * @param array $b array to be merged from. You can specify additional
	 * arrays via third argument, fourth argument etc.
	 * @return array the merged array (the original arrays are not changed.)
	 */
	public static function merge($a, $b)
	{
		$args = func_get_args();
		$res = array_shift($args);
109
		while (!empty($args)) {
Qiang Xue committed
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
			$next = array_shift($args);
			foreach ($next as $k => $v) {
				if (is_integer($k)) {
					isset($res[$k]) ? $res[] = $v : $res[$k] = $v;
				} elseif (is_array($v) && isset($res[$k]) && is_array($res[$k])) {
					$res[$k] = self::merge($res[$k], $v);
				} else {
					$res[$k] = $v;
				}
			}
		}
		return $res;
	}

	/**
	 * Retrieves the value of an array element or object property with the given key or property name.
	 * If the key does not exist in the array, the default value will be returned instead.
	 *
	 * Below are some usage examples,
	 *
	 * ~~~
	 * // working with array
	 * $username = \yii\helpers\ArrayHelper::getValue($_POST, 'username');
	 * // working with object
	 * $username = \yii\helpers\ArrayHelper::getValue($user, 'username');
	 * // working with anonymous function
	 * $fullName = \yii\helpers\ArrayHelper::getValue($user, function($user, $defaultValue) {
	 *     return $user->firstName . ' ' . $user->lastName;
	 * });
	 * ~~~
	 *
	 * @param array|object $array array or object to extract value from
	 * @param string|\Closure $key key name of the array element, or property name of the object,
	 * or an anonymous function returning the value. The anonymous function signature should be:
	 * `function($array, $defaultValue)`.
	 * @param mixed $default the default value to be returned if the specified key does not exist
146
	 * @return mixed the value of the element if found, default value otherwise
Qiang Xue committed
147 148 149 150 151 152 153 154 155 156 157 158
	 */
	public static function getValue($array, $key, $default = null)
	{
		if ($key instanceof \Closure) {
			return $key($array, $default);
		} elseif (is_array($array)) {
			return isset($array[$key]) || array_key_exists($key, $array) ? $array[$key] : $default;
		} else {
			return $array->$key;
		}
	}

159 160 161 162 163 164 165
	/**
	 * Removes an item from an array and returns the value. If the key does not exist in the array, the default value
	 * will be returned instead.
	 *
	 * Usage examples,
	 *
	 * ~~~
Alexander Makarov committed
166
	 * // $array = ['type' => 'A', 'options' => [1, 2]];
167
	 * // working with array
168
	 * $type = \yii\helpers\ArrayHelper::remove($array, 'type');
169
	 * // $array content
Alexander Makarov committed
170
	 * // $array = ['options' => [1, 2]];
171 172 173 174 175 176 177
	 * ~~~
	 *
	 * @param array $array the array to extract value from
	 * @param string $key key name of the array element
	 * @param mixed $default the default value to be returned if the specified key does not exist
	 * @return mixed|null the value of the element if found, default value otherwise
	 */
178
	public static function remove(&$array, $key, $default = null)
179
	{
180 181
		if (is_array($array) && (isset($array[$key]) || array_key_exists($key, $array))) {
			$value = $array[$key];
182 183 184 185 186 187
			unset($array[$key]);
			return $value;
		}
		return $default;
	}

Qiang Xue committed
188 189 190 191 192 193 194 195 196 197 198 199
	/**
	 * Indexes an array according to a specified key.
	 * The input array should be multidimensional or an array of objects.
	 *
	 * The key can be a key name of the sub-array, a property name of object, or an anonymous
	 * function which returns the key value given an array element.
	 *
	 * If a key value is null, the corresponding array element will be discarded and not put in the result.
	 *
	 * For example,
	 *
	 * ~~~
Alexander Makarov committed
200 201 202 203
	 * $array = [
	 *     ['id' => '123', 'data' => 'abc'],
	 *     ['id' => '345', 'data' => 'def'],
	 * ];
Qiang Xue committed
204 205
	 * $result = ArrayHelper::index($array, 'id');
	 * // the result is:
Alexander Makarov committed
206 207 208 209
	 * // [
	 * //     '123' => ['id' => '123', 'data' => 'abc'],
	 * //     '345' => ['id' => '345', 'data' => 'def'],
	 * // ]
Qiang Xue committed
210 211
	 *
	 * // using anonymous function
212
	 * $result = ArrayHelper::index($array, function ($element) {
Qiang Xue committed
213 214 215 216 217 218 219 220 221 222
	 *     return $element['id'];
	 * });
	 * ~~~
	 *
	 * @param array $array the array that needs to be indexed
	 * @param string|\Closure $key the column name or anonymous function whose result will be used to index the array
	 * @return array the indexed array
	 */
	public static function index($array, $key)
	{
Alexander Makarov committed
223
		$result = [];
Qiang Xue committed
224 225 226 227 228 229 230 231 232 233 234 235 236 237
		foreach ($array as $element) {
			$value = static::getValue($element, $key);
			$result[$value] = $element;
		}
		return $result;
	}

	/**
	 * Returns the values of a specified column in an array.
	 * The input array should be multidimensional or an array of objects.
	 *
	 * For example,
	 *
	 * ~~~
Alexander Makarov committed
238 239 240 241
	 * $array = [
	 *     ['id' => '123', 'data' => 'abc'],
	 *     ['id' => '345', 'data' => 'def'],
	 * ];
Qiang Xue committed
242
	 * $result = ArrayHelper::getColumn($array, 'id');
Alexander Makarov committed
243
	 * // the result is: ['123', '345']
Qiang Xue committed
244 245
	 *
	 * // using anonymous function
246
	 * $result = ArrayHelper::getColumn($array, function ($element) {
Qiang Xue committed
247 248 249 250 251 252 253 254 255 256 257 258
	 *     return $element['id'];
	 * });
	 * ~~~
	 *
	 * @param array $array
	 * @param string|\Closure $name
	 * @param boolean $keepKeys whether to maintain the array keys. If false, the resulting array
	 * will be re-indexed with integers.
	 * @return array the list of column values
	 */
	public static function getColumn($array, $name, $keepKeys = true)
	{
Alexander Makarov committed
259
		$result = [];
Qiang Xue committed
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
		if ($keepKeys) {
			foreach ($array as $k => $element) {
				$result[$k] = static::getValue($element, $name);
			}
		} else {
			foreach ($array as $element) {
				$result[] = static::getValue($element, $name);
			}
		}

		return $result;
	}

	/**
	 * Builds a map (key-value pairs) from a multidimensional array or an array of objects.
	 * The `$from` and `$to` parameters specify the key names or property names to set up the map.
	 * Optionally, one can further group the map according to a grouping field `$group`.
	 *
	 * For example,
	 *
	 * ~~~
Alexander Makarov committed
281 282 283 284
	 * $array = [
	 *     ['id' => '123', 'name' => 'aaa', 'class' => 'x'],
	 *     ['id' => '124', 'name' => 'bbb', 'class' => 'x'],
	 *     ['id' => '345', 'name' => 'ccc', 'class' => 'y'],
Qiang Xue committed
285 286 287 288
	 * );
	 *
	 * $result = ArrayHelper::map($array, 'id', 'name');
	 * // the result is:
Alexander Makarov committed
289
	 * // [
Qiang Xue committed
290 291 292
	 * //     '123' => 'aaa',
	 * //     '124' => 'bbb',
	 * //     '345' => 'ccc',
Alexander Makarov committed
293
	 * // ]
Qiang Xue committed
294 295 296
	 *
	 * $result = ArrayHelper::map($array, 'id', 'name', 'class');
	 * // the result is:
Alexander Makarov committed
297 298
	 * // [
	 * //     'x' => [
Qiang Xue committed
299 300
	 * //         '123' => 'aaa',
	 * //         '124' => 'bbb',
Alexander Makarov committed
301 302
	 * //     ],
	 * //     'y' => [
Qiang Xue committed
303
	 * //         '345' => 'ccc',
Alexander Makarov committed
304 305
	 * //     ],
	 * // ]
Qiang Xue committed
306 307 308 309 310 311 312 313 314 315
	 * ~~~
	 *
	 * @param array $array
	 * @param string|\Closure $from
	 * @param string|\Closure $to
	 * @param string|\Closure $group
	 * @return array
	 */
	public static function map($array, $from, $to, $group = null)
	{
Alexander Makarov committed
316
		$result = [];
Qiang Xue committed
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
		foreach ($array as $element) {
			$key = static::getValue($element, $from);
			$value = static::getValue($element, $to);
			if ($group !== null) {
				$result[static::getValue($element, $group)][$key] = $value;
			} else {
				$result[$key] = $value;
			}
		}
		return $result;
	}

	/**
	 * Sorts an array of objects or arrays (with the same structure) by one or several keys.
	 * @param array $array the array to be sorted. The array will be modified after calling this method.
	 * @param string|\Closure|array $key the key(s) to be sorted by. This refers to a key name of the sub-array
	 * elements, a property name of the objects, or an anonymous function returning the values for comparison
	 * purpose. The anonymous function signature should be: `function($item)`.
	 * To sort by multiple keys, provide an array of keys here.
Qiang Xue committed
336 337
	 * @param integer|array $direction the sorting direction. It can be either `SORT_ASC` or `SORT_DESC`.
	 * When sorting by multiple keys with different sorting directions, use an array of sorting directions.
338
	 * @param integer|array $sortFlag the PHP sort flag. Valid values include
339
	 * `SORT_REGULAR`, `SORT_NUMERIC`, `SORT_STRING`, `SORT_LOCALE_STRING`, `SORT_NATURAL` and `SORT_FLAG_CASE`.
340
	 * Please refer to [PHP manual](http://php.net/manual/en/function.sort.php)
341
	 * for more details. When sorting by multiple keys with different sort flags, use an array of sort flags.
slavcopost committed
342
	 * @throws InvalidParamException if the $descending or $sortFlag parameters do not have
Qiang Xue committed
343 344
	 * correct number of elements as that of $key.
	 */
345
	public static function multisort(&$array, $key, $direction = SORT_ASC, $sortFlag = SORT_REGULAR)
Qiang Xue committed
346
	{
Alexander Makarov committed
347
		$keys = is_array($key) ? $key : [$key];
Qiang Xue committed
348 349 350 351
		if (empty($keys) || empty($array)) {
			return;
		}
		$n = count($keys);
Qiang Xue committed
352 353 354
		if (is_scalar($direction)) {
			$direction = array_fill(0, $n, $direction);
		} elseif (count($direction) !== $n) {
slavcopost committed
355
			throw new InvalidParamException('The length of $descending parameter must be the same as that of $keys.');
Qiang Xue committed
356 357 358 359
		}
		if (is_scalar($sortFlag)) {
			$sortFlag = array_fill(0, $n, $sortFlag);
		} elseif (count($sortFlag) !== $n) {
360 361
			throw new InvalidParamException('The length of $sortFlag parameter must be the same as that of $keys.');
		}
Alexander Makarov committed
362
		$args = [];
Qiang Xue committed
363 364
		foreach ($keys as $i => $key) {
			$flag = $sortFlag[$i];
365
			$args[] = static::getColumn($array, $key);
Qiang Xue committed
366
			$args[] = $direction[$i];
Qiang Xue committed
367 368
			$args[] = $flag;
		}
369
		$args[] = &$array;
Qiang Xue committed
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
		call_user_func_array('array_multisort', $args);
	}

	/**
	 * Encodes special characters in an array of strings into HTML entities.
	 * Both the array keys and values will be encoded.
	 * If a value is an array, this method will also encode it recursively.
	 * @param array $data data to be encoded
	 * @param boolean $valuesOnly whether to encode array values only. If false,
	 * both the array keys and array values will be encoded.
	 * @param string $charset the charset that the data is using. If not set,
	 * [[\yii\base\Application::charset]] will be used.
	 * @return array the encoded data
	 * @see http://www.php.net/manual/en/function.htmlspecialchars.php
	 */
	public static function htmlEncode($data, $valuesOnly = true, $charset = null)
	{
		if ($charset === null) {
			$charset = Yii::$app->charset;
		}
Alexander Makarov committed
390
		$d = [];
Qiang Xue committed
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
		foreach ($data as $key => $value) {
			if (!$valuesOnly && is_string($key)) {
				$key = htmlspecialchars($key, ENT_QUOTES, $charset);
			}
			if (is_string($value)) {
				$d[$key] = htmlspecialchars($value, ENT_QUOTES, $charset);
			} elseif (is_array($value)) {
				$d[$key] = static::htmlEncode($value, $charset);
			}
		}
		return $d;
	}

	/**
	 * Decodes HTML entities into the corresponding characters in an array of strings.
	 * Both the array keys and values will be decoded.
	 * If a value is an array, this method will also decode it recursively.
	 * @param array $data data to be decoded
	 * @param boolean $valuesOnly whether to decode array values only. If false,
	 * both the array keys and array values will be decoded.
	 * @return array the decoded data
	 * @see http://www.php.net/manual/en/function.htmlspecialchars-decode.php
	 */
	public static function htmlDecode($data, $valuesOnly = true)
	{
Alexander Makarov committed
416
		$d = [];
Qiang Xue committed
417 418 419 420 421 422 423 424 425 426 427 428
		foreach ($data as $key => $value) {
			if (!$valuesOnly && is_string($key)) {
				$key = htmlspecialchars_decode($key, ENT_QUOTES);
			}
			if (is_string($value)) {
				$d[$key] = htmlspecialchars_decode($value, ENT_QUOTES);
			} elseif (is_array($value)) {
				$d[$key] = static::htmlDecode($value);
			}
		}
		return $d;
	}
Zander Baldwin committed
429
}