Spec-Zone.ru › CakePHP 3.4

Класс SortIterator

Итератор, который возвращает переданные элементы в определённом порядке. Порядок определяется значением, возвращаемым функцией обратного вызова, которая сопоставляет каждый из элементов.

Пример:

$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;
}

Этот итератор не сохраняет ключи, переданные в исходных элементах.

IteratorIterator реализует Iterator, Traversable, OuterIterator
Extended by Cake\Collection\Collection реализует Cake\Collection\CollectionInterface, Serializable использует Cake\Collection\CollectionTrait
Extended by Cake\Collection\Iterator\SortIterator
Пространство имён: Cake\Collection\Iterator
Расположение: Collection/Iterator/SortIterator.php

Краткое описание методов

  • __construct() public

    Оборачивает этот итератор вокруг переданных элементов, так что при итерировании они возвращаются в порядке.

  • unwrap() public

Подробное описание методов

__construct()source public

__construct( array|Traversable $items , callable|string $callback , integer $dir SORT_DESC , integer $type SORT_NUMERIC )

Оборачивает этот итератор вокруг переданных элементов, так что при итерировании они возвращаются в порядке.

Функция обратного вызова примет в качестве первого аргумента каждый из элементов в $items, значение, возвращённое в функции обратного вызова, будет использоваться в качестве значения для сортировки такого элемента. Обратите внимание, что функция обратного вызова может вызываться более одного раза на элемент.

Параметры

массив|Traversable $items
Значения для сортировки
функция|строка $callback

Функция, используемая для возвращения фактического значения для сравнения. Это также может быть строка, представляющая путь для извлечения столбца или свойства в каждом элементе

целое число $dir необязательно SORT_DESC
либо SORT_DESC, либо SORT_ASC
целое число $type необязательно SORT_NUMERIC

Тип сравнения, который необходимо выполнить, либо SORT_STRING, SORT_NUMERIC или SORT_NATURAL

Исключения

InvalidArgumentException
Если передан неверный тип для элементов.

Переопределяет

Cake\Collection\Collection::__construct()

unwrap()source public

unwrap( )

Возвращает

Iterator

Переопределяет

Cake\Collection\CollectionTrait::unwrap()

Наследуемые методы из Cake\Collection\Collection

__debugInfo()source public

__debugInfo( )

Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.

Возвращает

массив

count()source public

count( )

Выбрасывает исключение.

Выдача подсчёта в Collection может иметь много побочных эффектов, некоторые из которых делают Collection непригодной для использования после операции подсчёта.

Исключения

LogicException

serialize()source public

serialize( )

Возвращает строковое представление этого объекта, которое можно использовать для его реконструкции

Возвращает

строка

Реализация

Serializable::serialize()

unserialize()source public

unserialize( string $collection )

Десериализует переданную строку и восстанавливает экземпляр Collection

Параметры

строка $collection
Сериализованная коллекция

Реализация

Serializable::unserialize()

Используемые методы из Cake\Collection\CollectionTrait

_unwrap()source public

_unwrap( )

append()source public

append( $items )

avg()source public

avg( $matcher null )

buffered()source public

buffered( )

Возвращает

Cake\Collection\Iterator\BufferedIterator

cartesianProduct()source public

cartesianProduct( callable $operation null , callable $filter null )

Возвращает

Cake\Collection\CollectionInterface

chunk()source public

chunk( $chunkSize )

chunkWithKeys()source public

chunkWithKeys( $chunkSize , $preserveKeys true )

combine()source public

combine( $keyPath , $valuePath , $groupPath null )

compile()source public

compile( $preserveKeys true )

contains()source public

contains( $value )

countBy()source public

countBy( $callback )

each()source public

each( callable $c )

every()source public

every( callable $c )

extract()source public

extract( $matcher )

filter()source public

filter( callable $c null )

Возвращает

Cake\Collection\Iterator\FilterIterator

first()source public

first( )

firstMatch()source public

firstMatch( array $conditions )

groupBy()source public

groupBy( $callback )
END_OF_DOCUMENT_MARKER

indexBy()source public

indexBy( $callback )

insert()source public

insert( $path , $values )

Возвращает

Cake\Collection\Iterator\InsertIterator

isEmpty()source public

isEmpty( )

jsonSerialize()source public

jsonSerialize( )

last()source public

last( )

listNested()source public

listNested( $dir 'desc' , $nestingKey 'children' )

Возвращает

Cake\Collection\Iterator\TreeIterator

map()source public

map( callable $c )

Возвращает

Cake\Collection\Iterator\ReplaceIterator

match()source public

match( array $conditions )

max()source public

max( $callback , $type SORT_NUMERIC )

median()source public

median( $matcher null )

min()source public

min( $callback , $type SORT_NUMERIC )

nest()source public

nest( $idPath , $parentPath , $nestingKey 'children' )

optimizeUnwrap()source protected

optimizeUnwrap( )

Разворачивает этот итератор и возвращает наиболее простой перебираемый объект, который можно использовать для извлечения данных

Возвращает

Traversable|array

reduce()source public

reduce( callable $c , $zero null )

reject()source public

reject( callable $c )

Возвращает

Cake\Collection\Iterator\FilterIterator

sample()source public

sample( $size 10 )

shuffle()source public

shuffle( )

skip()source public

skip( $howMany )

some()source public

some( callable $c )

sortBy()source public

sortBy( $callback , $dir SORT_DESC , $type SORT_NUMERIC )

stopWhen()source public

stopWhen( $condition )

Возвращает

Cake\Collection\Iterator\StoppableIterator

sumOf()source public

sumOf( $matcher null )

take()source public

take( $size 1 , $from 0 )

through()source public

through( callable $handler )

toArray()source public

toArray( $preserveKeys true )

toList()source public

toList( )

transpose()source public

transpose( )

Возвращает

Cake\Collection\CollectionInterface

unfold()source public

unfold( callable $transformer null )

zip()source public

zip( $items )

zipWith()source public

zipWith( $items , $callable )

© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.4/class-Cake.Collection.Iterator.SortIterator.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API