Spec-Zone.ru › CakePHP 3.4

Класс InsertIterator

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

IteratorIterator реализует Iterator, Traversable, OuterIterator
Extended by Cake\Collection\Collection реализует Cake\Collection\CollectionInterface, Serializable использует Cake\Collection\CollectionTrait
Extended by Cake\Collection\Iterator\InsertIterator
Пространство имен: Cake\Collection\Iterator
Расположение: Collection/Iterator/InsertIterator.php

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

  • $_path protected
    array

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

  • $_target protected
    string
    Имя свойства, которому будут назначены значения
  • $_validValues protected
    boolean
    Указывает, является ли коллекция значений по-прежнему действительной. (есть ли еще записи)
  • $_values protected
    Cake\Collection\Collection
    Коллекция, из которой извлекаются значения для вставки

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

  • __construct() public

    Создает новую коллекцию, которая будет динамически добавлять свойства к ней из значений, найденных в $values.

  • current() public

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

  • next() public
    Перемещает курсор к следующей записи
  • rewind() public
    Сбрасывает указатель коллекции.

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

__construct()source public

__construct( array|Traversable $into , string $path , array|Traversable $values )

Создает новую коллекцию, которая будет динамически добавлять свойства к ней из значений, найденных в $values.

Параметры

array|Traversable $into

Целевая коллекция, в которую значения будут вставлены по указанному пути.

string $path

Список свойств, разделенных точкой, которые необходимо пройти, чтобы вставить значение в целевую коллекцию.

array|Traversable $values

Исходная коллекция, из которой значения будут вставлены по указанному пути.

Исключения

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

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

Cake\Collection\Collection::__construct()

current()source public

current( )

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

Возвращает

mixed

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

IteratorIterator::current()

next()source public

next( )

Перемещает курсор к следующей записи

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

IteratorIterator::next()

rewind()source public

rewind( )

Сбрасывает указатель коллекции.

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

IteratorIterator::rewind()

Методы, унаследованные от Cake\Collection\Collection

__debugInfo()source public

__debugInfo( )

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

Возвращает

array

count()source public

count( )

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

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

Исключения

LogicException

serialize()source public

serialize( )

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

Возвращает

string

Реализация

Serializable::serialize()

unserialize()source public

unserialize( string $collection )

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

Параметры

string $collection
Сериализованная коллекция

Реализация

Serializable::unserialize()

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

_unwrap()source public

_unwrap( )

append()source public

append( $items )

avg()source public

avg( $matcher null )

buffered()source public

buffered( )

Возвращает

Cake\Collection\Iterator\BufferedIterator

cartesianProduct()source public

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

Возвращает

Cake\Collection\CollectionInterface

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 )

countBy()source public

countBy( $callback )
END_OF_DOCUMENT_MARKER

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

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

optimizeUnwrap()source protected

optimizeUnwrap( )

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

Возвращает

Traversable|array

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 )

through()source public

through( callable $handler )

toArray()source public

toArray( $preserveKeys true )

toList()source public

toList( )

transpose()source public

transpose( )

Возвращает

Cake\Collection\CollectionInterface

unfold()source public

unfold( callable $transformer null )
END_OF_DOCUMENT_MARKER

unwrap()source public

unwrap( )

zip()source public

zip( $items )

zipWith()source public

zipWith( $items , $callable )

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

$_pathsource

protected массив

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

$_targetsource

protected строка

Имя свойства, которому будут назначены значения.

$_validValuessource

protected логическое

Указывает, всё ли ещё действителен набор значений. (есть ли ещё записи).

true

$_valuessource

protected Cake\Collection\Collection

Набор, из которого извлекаются значения для вставки

© 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.InsertIterator.html

Spec-Zone.ru

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