| Methods |
public
|
allocate(int $capacity): void
Ensures that enough memory is allocated for a required capacity.
This removes the need to reallocate the internal as…
Ensures that enough memory is allocated for a required capacity.
This removes the need to reallocate the internal as values are added.
Parameters
| $capacity |
The number of values for which capacity should
be allocated. Note: Capacity will stay the same if this value is
less than or equal to the current capacity.
|
Implemented by
|
#
|
public
|
apply(callable $callback): void
Updates all values by applying a callback function to each value in
the sequence.
Updates all values by applying a callback function to each value in
the sequence.
Parameters
| $callback |
A callable to apply to each value in the
sequence. The callback should return what the value should be
replaced by.
callback ( mixed $value ) : mixed
|
Implemented by
|
#
|
public
|
capacity(): int
Returns the current capacity.
Returns the current capacity.
Returns
Implemented by
|
#
|
public
|
contains(mixed ...$values): bool
Determines if the sequence contains all values.
Determines if the sequence contains all values.
Parameters
| ...$values |
Values to check.
|
Returns
FALSE if any of the provided values are not in the
sequence, TRUE otherwise.
Implemented by
|
#
|
public
|
filter(null|callable $callback = null): Sequence
Creates a new sequence using a callable to determine which values
to include.
Creates a new sequence using a callable to determine which values
to include.
Parameters
| $callback |
Optional callable which returns TRUE if the
value should be included, FALSE otherwise. If a callback is not
provided, only values which are TRUE (see converting to boolean) will
be included.
callback ( mixed $value ) : bool
|
Returns
A new sequence containing all the values for which
either the callback returned TRUE, or all values that convert to
TRUE if a callback was not provided.
Implemented by
|
#
|
public
|
find(mixed $value): int|false
Returns the index of the value, or FALSE if not found.
Returns the index of the value, or FALSE if not found.
Parameters
| $value |
The value to find.
|
Returns
The index of the value, or FALSE if not found.
Implemented by
|
#
|
public
|
first(): mixed
Returns the first value in the sequence.
Returns the first value in the sequence.
Returns
The first value in the sequence.
Throws
Implemented by
|
#
|
public
|
get(int $index): mixed
Returns the value at a given index.
Returns the value at a given index.
Parameters
| $index |
The index to access, starting at 0.
|
Returns
The value at the requested index.
Throws
Implemented by
|
#
|
public
|
insert(int $index, mixed ...$values): void
Inserts values into the sequence at a given index.
Inserts values into the sequence at a given index.
Parameters
| $index |
The index at which to insert. 0 <= index <= count
Note: You can insert at the index equal to the number of values.
|
| ...$values |
The value or values to insert.
|
Throws
Implemented by
|
#
|
public
|
join(string $glue = ''): string
Joins all values together as a string using an optional separator
between each value.
Joins all values together as a string using an optional separator
between each value.
Parameters
| $glue |
An optional string to separate each value.
|
Returns
All values of the sequence joined together as a
string.
Implemented by
|
#
|
public
|
last(): mixed
Returns the last value in the sequence.
Returns the last value in the sequence.
Returns
The last value in the sequence.
Throws
Implemented by
|
#
|
public
|
map(callable $callback): Sequence
Returns the result of applying a callback function to each value in
the sequence.
Returns the result of applying a callback function to each value in
the sequence.
Parameters
| $callback |
A callable to apply to each value in the
sequence.
The callable should return what the new value will be in the new
sequence.
callback ( mixed $value ) : mixed
|
Returns
The result of applying a callback to each value in
the sequence. Note: The values of the current instance won't be
affected.
Implemented by
|
#
|
public
|
merge(iterable $values): Sequence
Returns the result of adding all given values to the sequence.
Returns the result of adding all given values to the sequence.
Parameters
| $values |
A traversable object or an array.
|
Returns
The result of adding all given values to the
sequence, effectively the same as adding the values to a copy,
then returning that copy.
Implemented by
|
#
|
public
|
pop(): mixed
Removes and returns the last value.
Removes and returns the last value.
Returns
Throws
Implemented by
|
#
|
public
|
push(mixed ...$values): void
Adds values to the end of the sequence.
Adds values to the end of the sequence.
Parameters
| ...$values |
The values to add.
|
Implemented by
|
#
|
public
|
reduce(callable $callback, mixed $initial = null): mixed
Reduces the sequence to a single value using a callback function.
Reduces the sequence to a single value using a callback function.
Parameters
| $callback |
callback ( mixed $carry , mixed $value ) : mixed
$carry The return value of the previous callback, or initial if it's
the first iteration.
$value The value of the current iteration.
|
| $initial |
The initial value of the carry value. Can be NULL.
|
Returns
The return value of the final callback.
Implemented by
|
#
|
public
|
remove(int $index): mixed
Removes and returns a value by index.
Removes and returns a value by index.
Parameters
| $index |
The index of the value to remove.
|
Returns
The value that was removed.
Implemented by
|
#
|
public
|
reverse(): void
Reverses the sequence in-place.
Reverses the sequence in-place.
Implemented by
|
#
|
public
|
reversed(): Sequence
Returns a reversed copy of the sequence.
Returns a reversed copy of the sequence.
Returns
A reversed copy of the sequence.
Note: The current instance is not affected.
Implemented by
|
#
|
public
|
rotate(int $rotations): void
Rotates the sequence by a given number of rotations, which is
equivalent to successively calling
$sequence->push(…
Rotates the sequence by a given number of rotations, which is
equivalent to successively calling
$sequence->push($sequence->shift()) if the number of rotations is
positive, or $sequence->unshift($sequence->pop()) if negative.
Parameters
| $rotations |
The number of times the sequence should be
rotated.
|
Implemented by
|
#
|
public
|
set(int $index, mixed $value): void
Updates a value at a given index.
Updates a value at a given index.
Parameters
| $index |
The index of the value to update.
|
| $value |
The new value.
|
Throws
Implemented by
|
#
|
public
|
shift(): mixed
Removes and returns the first value.
Removes and returns the first value.
Throws
Implemented by
|
#
|
public
|
slice(int $index, int|null $length = null): Sequence
Creates a sub-sequence of a given range.
Creates a sub-sequence of a given range.
Parameters
| $index |
The index at which the sub-sequence starts.
If positive, the sequence will start at that index in the sequence.
If negative, the sequence will start that far from the end.
|
| $length |
If a length is given and is positive, the
resulting sequence will have up to that many values in it. If the
length results in an overflow, only values up to the end of the
sequence will be included. If a length is given and is negative,
the sequence will stop that many values from the end. If a length
is not provided, the resulting sequence will contain all values
between the index and the end of the sequence.
|
Returns
A sub-sequence of the given range.
Implemented by
|
#
|
public
|
sort(callable|null $comparator = null): void
Sorts the sequence in-place, using an optional comparator function.
Sorts the sequence in-place, using an optional comparator function.
Parameters
| $comparator |
The comparison function must return
an integer less than, equal to, or greater than zero if the first
argument is considered to be respectively less than, equal to, or
greater than the second. Note that before PHP 7.0.0 this integer had
to be in the range from -2147483648 to 2147483647.
callback ( mixed $a, mixed $b ) : int
Caution: Returning non-integer values from the comparison
function, such as float, will result in an internal cast to integer
of the callback's return value. So values such as 0.99 and 0.1 will
both be cast to an integer value of 0, which will compare such
values as equal.
|
Implemented by
|
#
|
public
|
sorted(callable|null $comparator = null): Sequence
Returns a sorted copy, using an optional comparator function.
Returns a sorted copy, using an optional comparator function.
Parameters
| $comparator |
The comparison function must return
an integer less than, equal to, or greater than zero if the first
argument is considered to be respectively less than, equal to, or
greater than the second. Note that before PHP 7.0.0 this integer had
to be in the range from -2147483648 to 2147483647.
callback ( mixed $a, mixed $b ) : int
Caution: Returning non-integer values from the comparison
function, such as float, will result in an internal cast to integer
of the callback's return value. So values such as 0.99 and 0.1 will
both be cast to an integer value of 0, which will compare such
values as equal.
|
Returns
Returns a sorted copy of the sequence.
Implemented by
|
#
|
public
|
sum(): float|int
Returns the sum of all values in the sequence.
<p><b>Note:</b> Arrays and objects are considered equal to zero when…
Returns the sum of all values in the sequence.
Note: Arrays and objects are considered equal to zero when
calculating the sum.
Returns
The sum of all the values in the sequence as
either a float or int depending on the values in the sequence.
Implemented by
|
#
|
public
|
unshift(mixed $values): void
Adds values to the front of the sequence, moving all the current
values forward to make room for the new values.
Adds values to the front of the sequence, moving all the current
values forward to make room for the new values.
Parameters
| $values |
The values to add to the front of the sequence.
Note: Multiple values will be added in the same order that they
are passed.
|
Implemented by
|
#
|