Spec-Zone.ru › CakePHP 3.1

Трейт CollectionTrait

Предлагает набор методов для работы с итераторами

Cake\Collection\CollectionTrait использует Cake\Collection\ExtractTrait

Прямые известные пользователи

Cake\Collection\Collection, Cake\Collection\Iterator\TreeIterator, Cake\Collection\Iterator\TreePrinter, Cake\Collection\Iterator\ZipIterator, Cake\ORM\ResultSet

Косвенные известные пользователи

Cake\Collection\Iterator\BufferedIterator, Cake\Collection\Iterator\ExtractIterator, Cake\Collection\Iterator\FilterIterator, Cake\Collection\Iterator\InsertIterator, Cake\Collection\Iterator\NestIterator, Cake\Collection\Iterator\NoChildrenIterator, Cake\Collection\Iterator\ReplaceIterator, Cake\Collection\Iterator\SortIterator, Cake\Datasource\ResultSetDecorator
Пространство имён: Cake\Collection
Расположено в Collection/CollectionTrait.php

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

_unwrapsource public

_unwrap( )

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

Устаревшее

Возвращает

Iterator
\Iterator

appendsource public

append( mixed $items )

bufferedsource public

buffered( )

Возвращает

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

chunksource public

chunk( mixed $chunkSize )

combinesource public

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

compilesource public

compile( mixed $preserveKeys true )

containssource public

contains( mixed $value )

countBysource public

countBy( mixed $callback )

eachsource public

each( callable $c )

everysource public

every( callable $c )

extractsource public

extract( mixed $matcher )

filtersource public

filter( callable $c null )

Возвращает

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

firstsource public

first( )

firstMatchsource public

firstMatch( array $conditions )

groupBysource public

groupBy( mixed $callback )

indexBysource public

indexBy( mixed $callback )

insertsource public

insert( mixed $path , mixed $values )

Возвращает

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

isEmptysource public

isEmpty( )

jsonSerializesource public

jsonSerialize( )

lastsource public

last( )

listNestedsource public

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

Возвращает

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

mapsource public

map( callable $c )

Возвращает

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

matchsource public

match( array $conditions )

maxsource public

max( mixed $callback , mixed $type SORT_NUMERIC )

minsource public

min( mixed $callback , mixed $type SORT_NUMERIC )

nestsource public

nest( mixed $idPath , mixed $parentPath )

reducesource public

reduce( callable $c , mixed $zero null )

rejectsource public

reject( callable $c )

Возвращает

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

samplesource public

sample( mixed $size 10 )
END_OF_DOCUMENT_MARKER

shufflesource public

shuffle( )

skipsource public

skip( mixed $howMany )

somesource public

some( callable $c )

sortBysource public

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

stopWhensource public

stopWhen( mixed $condition )

Возвращает

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

sumOfsource public

sumOf( mixed $matcher null )

takesource public

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

throughsource public

through( callable $handler )

toArraysource public

toArray( mixed $preserveKeys true )

toListsource public

toList( )

unfoldsource public

unfold( callable $transformer null )

unwrapsource public

unwrap( )

zipsource public

zip( mixed $items )

zipWithsource public

zipWith( mixed $items , mixed $callable )

Методы, используемые из Cake\Collection\ExtractTrait

_createMatcherFiltersource protected

_createMatcherFilter( array $conditions )

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

Параметры

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

Возвращает

callable
callable

_extractsource protected

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

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

Параметры

массив или ArrayAccess $data
Данные.
массив $path
Путь для извлечения.

Возвращает

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

_propertyExtractorsource protected

_propertyExtractor( string|callable $callback )

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

Параметры

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

Возвращает

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

_simpleExtractsource protected

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

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

Параметры

массив или ArrayAccess $data
Данные.
массив $path
Путь для извлечения.

Возвращает

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

© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Collection.CollectionTrait.html

Spec-Zone.ru

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