Fr3nch13/CakePHP Utilities

InsertIterator extends Collection
in package

Application

This iterator will insert values into a property of each of the records returned.

The values to be inserted come out of another traversal object. This is useful when you have two separate collections and want to merge them together by placing each of the values from one collection into a property inside the other collection.

Properties

$_path : array<string|int, string>: An array containing each of the properties to be traversed to reach the point where the values should be inserted.
$_target : string: The property name to which values will be assigned
$_validValues : bool: Holds whether the values collection is still valid. (has more records)
$_values : Collection: The collection from which to extract the values to be inserted

Methods

__construct() : mixed: Constructs a new collection that will dynamically add properties to it out of the values found in $values.
__debugInfo() : array<string, mixed>: Returns an array that can be used to describe the internal state of this object.
__serialize() : array<string|int, mixed>: Returns an array for serializing this of this object.
__unserialize() : void: Rebuilds the Collection instance.
append() : CollectionInterface
appendItem() : CollectionInterface
avg() : mixed
buffered() : CollectionInterface
cartesianProduct() : CollectionInterface: {@inheritDoc}
chunk() : CollectionInterface
chunkWithKeys() : CollectionInterface
combine() : CollectionInterface
compile() : CollectionInterface
contains() : bool
count() : int: Returns the amount of elements in the collection.
countBy() : CollectionInterface
countKeys() : int: Returns the number of unique keys in this iterator. This is the same as the number of elements the collection will contain after calling `toArray()`
current() : mixed: Returns the current element in the target collection after inserting the value from the source collection into the specified path.
each() : mixed
every() : bool
extract() : CollectionInterface
filter() : CollectionInterface
first() : mixed
firstMatch() : mixed
groupBy() : CollectionInterface
indexBy() : CollectionInterface
insert() : CollectionInterface
isEmpty() : bool
jsonSerialize() : array<string|int, mixed>
last() : mixed
lazy() : CollectionInterface
listNested() : CollectionInterface
map() : CollectionInterface
match() : CollectionInterface
max() : mixed
median() : mixed
min() : mixed
nest() : CollectionInterface
next() : void: Advances the cursor to the next record
prepend() : CollectionInterface
prependItem() : CollectionInterface
reduce() : mixed
reject() : CollectionInterface
rewind() : void: Resets the collection pointer.
sample() : CollectionInterface
serialize() : string: Returns a string representation of this object that can be used to reconstruct it
shuffle() : CollectionInterface
skip() : CollectionInterface
some() : bool
sortBy() : CollectionInterface
stopWhen() : CollectionInterface
sumOf() : mixed
take() : CollectionInterface
takeLast() : CollectionInterface
through() : CollectionInterface
toArray() : array<string|int, mixed>
toList() : array<string|int, mixed>
transpose() : CollectionInterface: {@inheritDoc}
unfold() : CollectionInterface
unserialize() : void: Unserializes the passed string and rebuilds the Collection instance
unwrap() : Traversable
zip() : CollectionInterface
zipWith() : CollectionInterface
newCollection() : CollectionInterface: Returns a new collection.
optimizeUnwrap() : iterable<string|int, mixed>: Unwraps this iterator and returns the simplest traversable that can be used for getting the data out

$_path

An array containing each of the properties to be traversed to reach the point where the values should be inserted.


    protected
        array<string|int, string>
    $_path

$_target

The property name to which values will be assigned


    protected
        string
    $_target

$_validValues

Holds whether the values collection is still valid. (has more records)


    protected
        bool
    $_validValues
     = true

$_values

The collection from which to extract the values to be inserted


    protected
        Collection
    $_values

__construct()

Constructs a new collection that will dynamically add properties to it out of the values found in $values.


    public
                    __construct(iterable<string|int, mixed> $into, string $path, iterable<string|int, mixed> $values) : mixed

Parameters

$into : iterable<string|int, mixed>: The target collection to which the values will be inserted at the specified path.
$path : string: A dot separated list of properties that need to be traversed to insert the value into the target collection.
$values : iterable<string|int, mixed>: The source collection from which the values will be inserted at the specified path.

__debugInfo()

Returns an array that can be used to describe the internal state of this object.


    public
                    __debugInfo() : array<string, mixed>

Return values

array<string, mixed>

__serialize()

Returns an array for serializing this of this object.


    public
                    __serialize() : array<string|int, mixed>

Return values

array<string|int, mixed>

__unserialize()

Rebuilds the Collection instance.


    public
                    __unserialize(array<string|int, mixed> $data) : void

Parameters

$data : array<string|int, mixed>: Data array.

append()


    public
                    append(mixed $items) : CollectionInterface

Parameters

$items : mixed

Return values

CollectionInterface

appendItem()


    public
                    appendItem(mixed $item[, mixed $key = null ]) : CollectionInterface

Parameters

$item : mixed
$key : mixed = null

Return values

CollectionInterface

avg()


    public
                    avg([mixed $path = null ]) : mixed

Parameters

$path : mixed = null

buffered()


    public
                    buffered() : CollectionInterface

Return values

CollectionInterface

cartesianProduct()

{@inheritDoc}


    public
                    cartesianProduct([callable|null $operation = null ][, callable|null $filter = null ]) : CollectionInterface

Parameters

$operation : callable|null = null: A callable that allows you to customize the product result.
$filter : callable|null = null: A filtering callback that must return true for a result to be part of the final results.

Return values

CollectionInterface

chunk()


    public
                    chunk(int $chunkSize) : CollectionInterface

Parameters

$chunkSize : int

Return values

CollectionInterface

chunkWithKeys()


    public
                    chunkWithKeys(int $chunkSize[, bool $keepKeys = true ]) : CollectionInterface

Parameters

$chunkSize : int
$keepKeys : bool = true

Return values

CollectionInterface

combine()


    public
                    combine(mixed $keyPath, mixed $valuePath[, mixed $groupPath = null ]) : CollectionInterface

Parameters

$keyPath : mixed
$valuePath : mixed
$groupPath : mixed = null

Return values

CollectionInterface

compile()


    public
                    compile([bool $keepKeys = true ]) : CollectionInterface

Parameters

$keepKeys : bool = true

Return values

CollectionInterface

contains()


    public
                    contains(mixed $value) : bool

Parameters

$value : mixed

Return values

bool

count()

Returns the amount of elements in the collection.


    public
                    count() : int

Return values

int

countBy()


    public
                    countBy(mixed $path) : CollectionInterface

Parameters

$path : mixed

Return values

CollectionInterface

countKeys()

Returns the number of unique keys in this iterator. This is the same as the number of elements the collection will contain after calling `toArray()`


    public
                    countKeys() : int

Return values

int

current()

Returns the current element in the target collection after inserting the value from the source collection into the specified path.


    public
                    current() : mixed

#[ReturnTypeWillChange]

each()


    public
                    each(callable $callback) : mixed

Parameters

$callback : callable

every()


    public
                    every(callable $callback) : bool

Parameters

$callback : callable

Return values

bool

extract()


    public
                    extract(mixed $path) : CollectionInterface

Parameters

$path : mixed

Return values

CollectionInterface

filter()


    public
                    filter([callable|null $callback = null ]) : CollectionInterface

Parameters

$callback : callable|null = null

Return values

CollectionInterface

first()


    public
                    first() : mixed

firstMatch()


    public
                    firstMatch(array<string|int, mixed> $conditions) : mixed

Parameters

$conditions : array<string|int, mixed>

groupBy()


    public
                    groupBy(mixed $path) : CollectionInterface

Parameters

$path : mixed

Return values

CollectionInterface

indexBy()


    public
                    indexBy(mixed $path) : CollectionInterface

Parameters

$path : mixed

Return values

CollectionInterface

insert()


    public
                    insert(string $path, mixed $values) : CollectionInterface

Parameters

$path : string
$values : mixed

Return values

CollectionInterface

isEmpty()


    public
                    isEmpty() : bool

Return values

bool

jsonSerialize()


    public
                    jsonSerialize() : array<string|int, mixed>

Return values

array<string|int, mixed>

last()


    public
                    last() : mixed

lazy()


    public
                    lazy() : CollectionInterface

Return values

CollectionInterface

listNested()


    public
                    listNested([mixed $order = 'desc' ][, mixed $nestingKey = 'children' ]) : CollectionInterface

Parameters

$order : mixed = 'desc'
$nestingKey : mixed = 'children'

Return values

CollectionInterface

map()


    public
                    map(callable $callback) : CollectionInterface

Parameters

$callback : callable

Return values

CollectionInterface

match()


    public
                    match(array<string|int, mixed> $conditions) : CollectionInterface

Parameters

$conditions : array<string|int, mixed>

Return values

CollectionInterface

max()


    public
                    max(mixed $path[, int $sort = SORT_NUMERIC ]) : mixed

Parameters

$path : mixed
$sort : int = SORT_NUMERIC

median()


    public
                    median([mixed $path = null ]) : mixed

Parameters

$path : mixed = null

min()


    public
                    min(mixed $path[, int $sort = SORT_NUMERIC ]) : mixed

Parameters

$path : mixed
$sort : int = SORT_NUMERIC

nest()


    public
                    nest(mixed $idPath, mixed $parentPath[, string $nestingKey = 'children' ]) : CollectionInterface

Parameters

$idPath : mixed
$parentPath : mixed
$nestingKey : string = 'children'

Return values

CollectionInterface

next()

Advances the cursor to the next record


    public
                    next() : void

prepend()


    public
                    prepend(mixed $items) : CollectionInterface

Parameters

$items : mixed

Return values

CollectionInterface

prependItem()


    public
                    prependItem(mixed $item[, mixed $key = null ]) : CollectionInterface

Parameters

$item : mixed
$key : mixed = null

Return values

CollectionInterface

reduce()


    public
                    reduce(callable $callback[, mixed $initial = null ]) : mixed

Parameters

$callback : callable
$initial : mixed = null

reject()


    public
                    reject(callable $callback) : CollectionInterface

Parameters

$callback : callable

Return values

CollectionInterface

rewind()

Resets the collection pointer.


    public
                    rewind() : void

sample()


    public
                    sample([int $length = 10 ]) : CollectionInterface

Parameters

$length : int = 10

Return values

CollectionInterface

serialize()

Returns a string representation of this object that can be used to reconstruct it


    public
                    serialize() : string

Return values

string

shuffle()


    public
                    shuffle() : CollectionInterface

Return values

CollectionInterface

skip()


    public
                    skip(int $length) : CollectionInterface

Parameters

$length : int

Return values

CollectionInterface

some()


    public
                    some(callable $callback) : bool

Parameters

$callback : callable

Return values

bool

sortBy()


    public
                    sortBy(mixed $path[, int $order = SORT_DESC ][, int $sort = SORT_NUMERIC ]) : CollectionInterface

Parameters

$path : mixed
$order : int = SORT_DESC
$sort : int = SORT_NUMERIC

Return values

CollectionInterface

stopWhen()


    public
                    stopWhen(mixed $condition) : CollectionInterface

Parameters

$condition : mixed

Return values

CollectionInterface

sumOf()


    public
                    sumOf([mixed $path = null ]) : mixed

Parameters

$path : mixed = null

take()


    public
                    take([int $length = 1 ][, int $offset = 0 ]) : CollectionInterface

Parameters

$length : int = 1
$offset : int = 0

Return values

CollectionInterface

takeLast()


    public
                    takeLast(int $length) : CollectionInterface

Parameters

$length : int

Return values

CollectionInterface

through()


    public
                    through(callable $callback) : CollectionInterface

Parameters

$callback : callable

Return values

CollectionInterface

toArray()


    public
                    toArray([bool $keepKeys = true ]) : array<string|int, mixed>

Parameters

$keepKeys : bool = true

Return values

array<string|int, mixed>

toList()


    public
                    toList() : array<string|int, mixed>

Return values

array<string|int, mixed>

transpose()

{@inheritDoc}


    public
                    transpose() : CollectionInterface

Return values

CollectionInterface

unfold()


    public
                    unfold([callable|null $callback = null ]) : CollectionInterface

Parameters

$callback : callable|null = null

Return values

CollectionInterface

unserialize()

Unserializes the passed string and rebuilds the Collection instance


    public
                    unserialize(string $collection) : void

Parameters

$collection : string: The serialized collection

unwrap()


    public
                    unwrap() : Traversable

Return values

Traversable

zip()


    public
                    zip(iterable<string|int, mixed> $items) : CollectionInterface

Parameters

$items : iterable<string|int, mixed>

Return values

CollectionInterface

zipWith()


    public
                    zipWith(iterable<string|int, mixed> $items, mixed $callback) : CollectionInterface

Parameters

$items : iterable<string|int, mixed>
$callback : mixed

Return values

CollectionInterface

newCollection()

Returns a new collection.


    protected
                    newCollection(mixed ...$args) : CollectionInterface

Allows classes which use this trait to determine their own type of returned collection interface

Parameters

$args : mixed: Constructor arguments.

Return values

CollectionInterface

optimizeUnwrap()

Unwraps this iterator and returns the simplest traversable that can be used for getting the data out


    protected
                    optimizeUnwrap() : iterable<string|int, mixed>

Return values

iterable<string|int, mixed>

InsertIterator extends Collection in package Application

Table of Contents

Properties

Methods

Properties

$_path

$_target

$_validValues

$_values

Methods

__construct()

Parameters

__debugInfo()

Return values

__serialize()

Return values

__unserialize()

Parameters

append()

Parameters

Tags

Return values

appendItem()

Parameters

Tags

Return values

avg()

Parameters

Tags

buffered()

Tags

Return values

cartesianProduct()

Parameters

Tags

Return values

chunk()

Parameters

Tags

Return values

chunkWithKeys()

Parameters

Tags

Return values

combine()

Parameters

Tags

Return values

compile()

Parameters

Tags

Return values

contains()

Parameters

Tags

Return values

count()

Return values

countBy()

Parameters

Tags

Return values

countKeys()

Return values

current()

Attributes

each()

Parameters

Tags

every()

Parameters

Tags

Return values

extract()

Parameters

Tags

Return values

filter()

Parameters

Tags

InsertIterator extends Collection
in package

Application