Spec-Zone.ru › CakePHP 3.8

Класс ZipIterator

Создаёт итератор, возвращающий элементы, сгруппированные по парам

Пример

$iterator = new ZipIterator([[1, 2], [3, 4]]);
 $iterator->toList(); // Returns [[1, 3], [2, 4]]

Вы также можете выбрать пользовательскую функцию для объединения элементов, например, для подсчета сумм по индексу:

Пример

$iterator = new ZipIterator([[1, 2], [3, 4]], function ($a, $b) {
   return $a + $b;
 });
 $iterator->toList(); // Returns [4, 6]
MultipleIterator реализует Iterator, Traversable
Расширенный Cake\Collection\Iterator\ZipIterator реализует Cake\Collection\CollectionInterface, Serializable использует Cake\Collection\CollectionTrait
Пространство имён: Cake\Collection\Iterator
Расположение: Collection/Iterator/ZipIterator.php

Наследованные константы

  • MIT_KEYS_ASSOC, MIT_KEYS_NUMERIC, MIT_NEED_ALL, MIT_NEED_ANY

Резюме свойств

  • $_callback protected
    callable
    Функция, используемая для объединения элементов
  • $_iterators protected
    array
    Содержит исходные объекты итераторов, которые были добавлены

Резюме методов

  • __construct() public

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

  • current() public

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

  • serialize() public

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

  • unserialize() public
    Десериализует переданную строку и восстанавливает экземпляр ZipIterator

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

__construct()source public

__construct( array $sets , callable|null $callable = null )

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

Параметры

массив $sets
Список массивов или итераторов, которые нужно объединить.
обратная функция|null $callable необязательно null
Функция, используемая для объединения элементов каждого итератора.

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

MultipleIterator::__construct()

current()source public

current( )

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

Возвращает

mixed

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

MultipleIterator::current()

Реализация

Iterator::current()

serialize()source public

serialize( )

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

Возвращает

строка

Реализация

Serializable::serialize()

unserialize()source public

unserialize( string $iterators )

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

Параметры

строка $iterators
Десериализованные итераторы

Реализация

Serializable::unserialize()

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

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

Параметры

обратная функция $operation необязательно null
Операция
обратная функция $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
END_OF_DOCUMENT_MARKER

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

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

Возвращает

Итерируемый объект|массив

prepend()source public

prepend( $items )

prependItem()source public

prependItem( $item , $key = null )

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
END_OF_DOCUMENT_MARKER

unfold()source public

unfold( callable $transformer = null )

unwrap()source public

unwrap( )

zip()source public

zip( $items )

zipWith()source public

zipWith( $items , $callable )

Магические методы, унаследованные от Cake\Collection\CollectionInterface

cartesianProduct()

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

$_callbacksource

protected callable

Функция, используемая для объединения элементов

$_iteratorssource

protected array

Содержит исходные объекты итератора, которые были прикреплены

[]

© 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.Iterator.ZipIterator.html

Spec-Zone.ru

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