Класс NestIterator

__constructsource public

__construct( array|Traversable $items , string|callable $nestKey )

Конструктор

Параметры

array|Traversable $items

Элементы коллекции.

string|callable $nestKey

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

Исключения

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

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

Cake\Collection\Collection::__construct()

getChildrensource public

getChildren( )

Возвращает коллекцию, содержащую дочерние элементы для текущего элемента.

Возвращает

Traversable
\Traversable

Реализация

RecursiveIterator::getChildren()

hasChildrensource public

hasChildren( )

Возвращает true, если для текущего элемента в конфигурированном ключе вложенности хранится массив или объект Traversable.

Возвращает

boolean
bool

Реализация

RecursiveIterator::hasChildren()

__debugInfosource public

__debugInfo( )

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

Возвращает

array
array

countsource public

count( )

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

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

Исключения

LogicException
\LogicException

serializesource public

serialize( )

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

Возвращает

string
string

Реализация

Serializable::serialize()

unserializesource public

unserialize( string $collection )

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

Параметры

string $collection

Сериализованная коллекция.

Реализация

Serializable::unserialize()

_unwrapsource public

_unwrap( )

Обработчик для обратной совместимости с unwrap()

Устарело

Возвращает

Iterator
\Iterator

appendsource public

append( mixed $items )

Реализация

Cake\Collection\CollectionInterface::append()

bufferedsource public

buffered( )

Возвращает

Cake\Collection\Iterator\BufferedIterator
\Cake\Collection\Iterator\BufferedIterator

Реализация

Cake\Collection\CollectionInterface::buffered()

chunksource public

chunk( mixed $chunkSize )

Реализация

Cake\Collection\CollectionInterface::chunk()

combinesource public

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

Реализация

Cake\Collection\CollectionInterface::combine()

compilesource public

compile( mixed $preserveKeys true )

Реализация

Cake\Collection\CollectionInterface::compile()

containssource public

contains( mixed $value )

Реализация

Cake\Collection\CollectionInterface::contains()

countBysource public

countBy( mixed $callback )

Реализация

Cake\Collection\CollectionInterface::countBy()

eachsource public

each( callable $c )

Реализация

Cake\Collection\CollectionInterface::each()

everysource public

every( callable $c )

Реализация

Cake\Collection\CollectionInterface::every()

extractsource public

extract( mixed $matcher )

Реализация

Cake\Collection\CollectionInterface::extract()

filtersource public

filter( callable $c null )

Возвращает

Cake\Collection\Iterator\FilterIterator
\Cake\Collection\Iterator\FilterIterator

Реализация

Cake\Collection\CollectionInterface::filter()

firstsource public

first( )

Реализация

Cake\Collection\CollectionInterface::first()

firstMatchsource public

firstMatch( array $conditions )

Реализация

Cake\Collection\CollectionInterface::firstMatch()

groupBysource public

groupBy( mixed $callback )

Реализация

Cake\Collection\CollectionInterface::groupBy()

indexBysource public

indexBy( mixed $callback )

Реализация

Cake\Collection\CollectionInterface::indexBy()

insertsource public

insert( mixed $path , mixed $values )

Возвращает

Cake\Collection\Iterator\InsertIterator
\Cake\Collection\Iterator\InsertIterator

Реализация

Cake\Collection\CollectionInterface::insert()

isEmptysource public

isEmpty( )

Реализация

Cake\Collection\CollectionInterface::isEmpty()

jsonSerializesource public

jsonSerialize( )

Реализация

Cake\Collection\CollectionInterface::jsonSerialize()

lastsource public

last( )

Реализация

Cake\Collection\CollectionInterface::last()

listNestedsource public

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

Возвращает

Cake\Collection\Iterator\TreeIterator
\Cake\Collection\Iterator\TreeIterator

Реализация

Cake\Collection\CollectionInterface::listNested()

mapsource public

map( callable $c )

Возвращает

Cake\Collection\Iterator\ReplaceIterator
\Cake\Collection\Iterator\ReplaceIterator

Реализация

Cake\Collection\CollectionInterface::map()

matchsource public

match( array $conditions )

Реализация

Cake\Collection\CollectionInterface::match()

maxsource public

max( mixed $callback , mixed $type SORT_NUMERIC )

Реализация

Cake\Collection\CollectionInterface::max()

minsource public

min( mixed $callback , mixed $type SORT_NUMERIC )

Реализация

Cake\Collection\CollectionInterface::min()

nestsource public

nest( mixed $idPath , mixed $parentPath )

Реализация

Cake\Collection\CollectionInterface::nest()

reducesource public

reduce( callable $c , mixed $zero null )

Реализация

Cake\Collection\CollectionInterface::reduce()

rejectsource public

reject( callable $c )

Возвращает

Cake\Collection\Iterator\FilterIterator
\Cake\Collection\Iterator\FilterIterator

Реализация

Cake\Collection\CollectionInterface::reject()

samplesource public

sample( mixed $size 10 )

Реализация

Cake\Collection\CollectionInterface::sample()

shufflesource public

shuffle( )

Реализация

Cake\Collection\CollectionInterface::shuffle()

skipsource public

skip( mixed $howMany )

Реализация

Cake\Collection\CollectionInterface::skip()

somesource public

some( callable $c )

Реализация

Cake\Collection\CollectionInterface::some()

sortBysource public

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

Реализация

Cake\Collection\CollectionInterface::sortBy()

stopWhensource public

stopWhen( mixed $condition )

Возвращает

Cake\Collection\Iterator\StoppableIterator
\Cake\Collection\Iterator\StoppableIterator

Реализация

Cake\Collection\CollectionInterface::stopWhen()

sumOfsource public

sumOf( mixed $matcher null )

Реализация

Cake\Collection\CollectionInterface::sumOf()

takesource public

take( mixed $size 1 , mixed $from 0 )

Реализация

Cake\Collection\CollectionInterface::take()

throughsource public

through( callable $handler )

Реализация

Cake\Collection\CollectionInterface::through()

toArraysource public

toArray( mixed $preserveKeys true )

Реализация

Cake\Collection\CollectionInterface::toArray()

toListsource public

toList( )

Реализация

Cake\Collection\CollectionInterface::toList()

unfoldsource public

unfold( callable $transformer null )

Реализация

Cake\Collection\CollectionInterface::unfold()

unwrapsource public

unwrap( )

Реализация

Cake\Collection\CollectionInterface::unwrap()

zipsource public

zip( mixed $items )

Реализация

Cake\Collection\CollectionInterface::zip()

zipWithsource public

zipWith( mixed $items , mixed $callable )

Реализация

Cake\Collection\CollectionInterface::zipWith()

_createMatcherFiltersource protected

_createMatcherFilter( array $conditions )

Возвращает вызываемый объект, который принимает значение и возвращает, соответствует ли оно определённому условию.

Параметры

массив $conditions

Список пар «ключ-значение» условий для соответствия, где ключ — путь к свойству для извлечения из текущего элемента, а значение — значение, с которым сравнивается элемент.

Возвращает

callable
вызываемый объект

_extractsource protected

_extract( array|ArrayAccess $data , array $path )

Возвращает столбец из $data, который можно извлечь, перебирая имена столбцов, содержащиеся в $path. Он будет возвращать массивы для элементов, представленных {*}

Параметры

array|ArrayAccess $data

Данные.

array $path

Путь для извлечения.

Возвращаемое значение

mixed
смешанный тип

_propertyExtractorsource protected

_propertyExtractor( string|callable $callback )

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

Параметры

string|callable $callback

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

Возвращаемое значение

callable
вызываемый объект

_simpleExtractsource protected

_simpleExtract( array|ArrayAccess $data , array $path )

Возвращает столбец из $data, который можно извлечь, перебирая имена столбцов, содержащиеся в $path

Параметры

array|ArrayAccess $data

Данные.

array $path

Путь для извлечения.

Возвращаемое значение

mixed
смешанный тип