Класс InsertIterator
Этот итератор вставит значения в свойство каждого из записей, возвращаемых. Значения для вставки берутся из другого объекта обхода. Это полезно, когда у вас есть две отдельные коллекции, и вы хотите объединить их, помещая каждое из значений одной коллекции в свойство другой коллекции.
- IteratorIterator реализует Iterator, Traversable, OuterIterator
-
Cake\Collection\Collection реализует Cake\Collection\CollectionInterface, Serializable использует Cake\Collection\CollectionTrait -
Cake\Collection\Iterator\InsertIterator
Резюме свойств
-
$_pathprotectedarrayМассив, содержащий каждое из свойств, которые необходимо обойти, чтобы добраться до точки, где следует вставить значения.
-
$_targetprotectedИмя свойства, которому будут назначены значенияstring -
$_validValuesprotectedУказывает, все ли значения коллекции остаются действительными. (есть ли еще записи)boolean - Коллекция, из которой извлекаются значения для вставки
$_valuesprotected
Резюме методов
- __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( )
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
Возвращает
arraycount()source public
count( )
Выбрасывает исключение.
Вызов подсчета в Collection может иметь множество побочных эффектов, некоторые из которых могут сделать Collection неиспользуемым после операции подсчета.
Исключения
LogicExceptionserialize()source public
serialize( )
Возвращает строковое представление этого объекта, которое можно использовать для его восстановления
Возвращает
stringРеализация
Serializable::serialize() unserialize()source public
unserialize( string $collection )
Десериализует переданную строку и восстанавливает экземпляр Collection
Параметры
- string
$collection - Десериализованная коллекция
Реализация
Serializable::unserialize() Методы, используемые из Cake\Collection\CollectionTrait
_unwrap()source public
_unwrap( )
Обработчик для unwrap() с обратной совместимостью
Устарело
Возвращает
Iteratorappend()source public
append( $items )
chunk()source public
chunk( $chunkSize )
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 )
min()source public
min( $callback , $type SORT_NUMERIC )
nest()source public
nest( $idPath , $parentPath )
reduce()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 )
unwrap()source public
unwrap( )
zip()source public
zip( $items )
zipWith()source public
zipWith( $items , $callable )
Подробности свойств
$_pathsource
protected массив
Массив, содержащий каждое из свойств, которые необходимо пройти, чтобы добраться до точки, где значения должны быть вставлены.
$_validValuessource
protected булево
Указывает, являются ли значения коллекции по-прежнему допустимыми. (есть ли ещё записи)
true
$_valuessource
protected Cake\Collection\Collection
Коллекция, из которой извлекать значения для вставки
© 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.2/class-Cake.Collection.Iterator.InsertIterator.html