Класс ExtractIterator
Создаёт итератор из другого итератора, извлекающего запрошенную колонку или свойство на основе пути.
- IteratorIterator реализует Iterator, Traversable, OuterIterator
-
Cake\Collection\Collection реализует Cake\Collection\CollectionInterface, Serializable использует Cake\Collection\CollectionTrait
-
Cake\Collection\Iterator\ExtractIterator
Краткое описание свойств
-
$_extractorprotectedcallableВызываемый объект, отвечающий за извлечение одного значения для каждого элемента в коллекции.
Краткое описание методов
- __construct() public
Создаёт итератор, который будет возвращать запрошенное свойство для каждого значения в коллекции, выраженного в $path.
- current() public
Возвращает значение колонки, определённое в $path, или null, если путь не может быть пройден.
- unwrap() public
Подробное описание методов
__construct()source public
__construct( array|Traversable $items , string $path )
Создаёт итератор, который будет возвращать запрошенное свойство для каждого значения в коллекции, выраженного в $path.
Пример:
Извлечь имя пользователя для всех комментариев в массиве:
$items = [ ['comment' => ['body' => 'cool', 'user' => ['name' => 'Mark']], ['comment' => ['body' => 'very cool', 'user' => ['name' => 'Renan']] ]; $extractor = new ExtractIterator($items, 'comment.user.name'');
Параметры
- массив|Traversable
$items - Список значений для итерации
- строка
$path Строка, разделённая точками, обозначающая путь для следования внутри иерархии каждого значения, чтобы извлечь колонку.
Исключения
InvalidArgumentExceptionЕсли передан неверный тип для элементов.
Переопределяет
Cake\Collection\Collection::__construct() current()source public
current( )
Возвращает значение колонки, определённое в $path, или null, если путь не может быть пройден.
Возвращает
смешанноеПереопределяет
IteratorIterator::current() unwrap()source public
unwrap( )
Здесь проводится анализ строгости, чтобы полностью обойти логику итератора.
Возвращает
IteratorПереопределяет
Cake\Collection\CollectionTrait::unwrap() Наследуемые методы из Cake\Collection\Collection
__debugInfo()source public
__debugInfo( )
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
Возвращает
массивcount()source public
count( )
Выбрасывает исключение.
Вызов count для Collection может иметь много побочных эффектов, некоторые из которых делают Collection непригодным для использования после операции подсчёта.
Исключения
LogicExceptionserialize()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 )
cartesianProduct()source public
cartesianProduct( callable $operation null , callable $filter null )
Возвращает
Cake\Collection\CollectionInterfacechunk()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 )
first()source public
first( )
firstMatch()source public
firstMatch( array $conditions )
groupBy()source public
groupBy( $callback )
indexBy()source public
indexBy( $callback )
isEmpty()source public
isEmpty( )
jsonSerialize()source public
jsonSerialize( )
last()source public
last( )
listNested()source public
listNested( $dir 'desc' , $nestingKey 'children' )
Возвращает
Cake\Collection\Iterator\TreeIteratormatch()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|arrayreduce()source public
reduce( callable $c , $zero null )
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\StoppableIteratorsumOf()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( )
unfold()source public
unfold( callable $transformer null )
zip()source public
zip( $items )
zipWith()source public
zipWith( $items , $callable )
Подробное описание свойств
$_extractorsource
protected 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.ExtractIterator.html