Spec-Zone.ru › CakePHP 3.8

Трейт 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

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

  • _unwrap() public
  • append() public
  • appendItem() public
  • avg() public
  • buffered() public
  • cartesianProduct() public
  • chunk() public
  • chunkWithKeys() public
  • combine() public
  • compile() public
  • contains() public
  • count() public
  • countBy() public
  • countKeys() public
  • each() public
  • every() public
  • extract() public
  • filter() public
  • first() public
  • firstMatch() public
  • groupBy() public
  • indexBy() public
  • insert() public
  • isEmpty() public
  • jsonSerialize() public
  • last() public
  • lazy() public
  • listNested() public
  • map() public
  • match() public
  • max() public
  • median() public
  • min() public
  • nest() public
  • newCollection() protected
    Возвращает новый набор.
  • optimizeUnwrap() protected

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

  • prepend() public
  • prependItem() public
  • reduce() public
  • reject() public
  • sample() public
  • shuffle() public
  • skip() public
  • some() public
  • sortBy() public
  • stopWhen() public
  • sumOf() public
  • take() public
  • takeLast() public
  • through() public
  • toArray() public
  • toList() public
  • transpose() public
  • unfold() public
  • unwrap() public
  • zip() public
  • zipWith() public

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

_unwrap()source public

_unwrap( )

append()source public

append( $items )

appendItem()source public

appendItem( $item , $key = null )

avg()source public

avg( $matcher = null )

buffered()source public

buffered( )

Возвращает

Cake\Collection\Iterator\BufferedIterator

cartesianProduct()source public

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

Параметры

callable $operation необязательно null
Операция
callable $filter необязательно null
Фильтр

Возвращает

Cake\Collection\CollectionInterface

Исключения

LogicException

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 )

count()source public

count( )

Возвращает

целое число

countBy()source public

countBy( $callback )

countKeys()source public

countKeys( )

Возвращает

целое число

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 )

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( )

lazy()source public

lazy( )

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' )

newCollection()source protected

newCollection( ... $args )

Возвращает новую коллекцию.

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

Параметры

... $args
$args Аргументы конструктора.

Возвращает

Cake\Collection\CollectionInterface

optimizeUnwrap()source protected

optimizeUnwrap( )

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

Возвращает

Traversable|массив

prepend()source public

prepend( $items )

prependItem()source public

prependItem( $item , $key = null )
END_OF_DOCUMENT_MARKER

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 )

takeLast()source public

takeLast( $howMany )

through()source public

through( callable $handler )

toArray()source public

toArray( $preserveKeys = true )

toList()source public

toList( )

transpose()source public

transpose( )

Возвращает

Cake\Collection\CollectionInterface

Исключения

LogicException

unfold()source public

unfold( callable $transformer = null )

unwrap()source public

unwrap( )

zip()source public

zip( $items )

zipWith()source public

zipWith( $items , $callable )

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

_createMatcherFilter()source protected

_createMatcherFilter( array $conditions )

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

Параметры

массив $conditions

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

Возвращает

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

_extract()source protected

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

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

Параметры

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

Возвращает

смешанное

_propertyExtractor()source protected

_propertyExtractor( string|callable $callback )

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

Параметры

строка или вызываемый объект $callback

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

Возвращает

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

_simpleExtract()source protected

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

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

Параметры

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

Возвращает

смешанное

© 2005–present 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.8/class-Cake.Collection.CollectionTrait.html

Spec-Zone.ru

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