You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
92 lines
3.0 KiB
92 lines
3.0 KiB
<?php
|
|
/**
|
|
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
|
|
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
|
|
*
|
|
* Licensed under The MIT License
|
|
* For full copyright and license information, please see the LICENSE.txt
|
|
* Redistributions of files must retain the above copyright notice.
|
|
*
|
|
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
|
|
* @link https://cakephp.org CakePHP(tm) Project
|
|
* @since 3.0.0
|
|
* @license https://opensource.org/licenses/mit-license.php MIT License
|
|
*/
|
|
namespace Cake\Collection\Iterator;
|
|
|
|
use Cake\Collection\Collection;
|
|
use DateTimeInterface;
|
|
|
|
/**
|
|
* An iterator that will return the passed items in order. The order is given by
|
|
* the value returned in a callback function that maps each of the elements.
|
|
*
|
|
* ### Example:
|
|
*
|
|
* ```
|
|
* $items = [$user1, $user2, $user3];
|
|
* $sorted = new SortIterator($items, function ($user) {
|
|
* return $user->age;
|
|
* });
|
|
*
|
|
* // output all user name order by their age in descending order
|
|
* foreach ($sorted as $user) {
|
|
* echo $user->name;
|
|
* }
|
|
* ```
|
|
*
|
|
* This iterator does not preserve the keys passed in the original elements.
|
|
*/
|
|
class SortIterator extends Collection
|
|
{
|
|
/**
|
|
* Wraps this iterator around the passed items so when iterated they are returned
|
|
* in order.
|
|
*
|
|
* The callback will receive as first argument each of the elements in $items,
|
|
* the value returned in the callback will be used as the value for sorting such
|
|
* element. Please note that the callback function could be called more than once
|
|
* per element.
|
|
*
|
|
* @param array|\Traversable $items The values to sort
|
|
* @param callable|string $callback A function used to return the actual value to
|
|
* be compared. It can also be a string representing the path to use to fetch a
|
|
* column or property in each element
|
|
* @param int $dir either SORT_DESC or SORT_ASC
|
|
* @param int $type the type of comparison to perform, either SORT_STRING
|
|
* SORT_NUMERIC or SORT_NATURAL
|
|
*/
|
|
public function __construct($items, $callback, $dir = \SORT_DESC, $type = \SORT_NUMERIC)
|
|
{
|
|
if (!is_array($items)) {
|
|
$items = iterator_to_array((new Collection($items))->unwrap(), false);
|
|
}
|
|
|
|
$callback = $this->_propertyExtractor($callback);
|
|
$results = [];
|
|
foreach ($items as $key => $val) {
|
|
$val = $callback($val);
|
|
if ($val instanceof DateTimeInterface && $type === \SORT_NUMERIC) {
|
|
$val = $val->format('U');
|
|
}
|
|
$results[$key] = $val;
|
|
}
|
|
|
|
$dir === SORT_DESC ? arsort($results, $type) : asort($results, $type);
|
|
|
|
foreach (array_keys($results) as $key) {
|
|
$results[$key] = $items[$key];
|
|
}
|
|
parent::__construct($results);
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*
|
|
* @return \Iterator
|
|
*/
|
|
public function unwrap()
|
|
{
|
|
return $this->getInnerIterator();
|
|
}
|
|
}
|
|
|