The Sequence interface

(PECL ds >= 1.0.0)

Introduction

A Sequence describes the behaviour of values arranged in a single, linear dimension. Some languages refer to this as a "List". It’s similar to an array that uses incremental integer keys, with the exception of a few characteristics:

Values will always be indexed as [0, 1, 2, …, size - 1].
Only allowed to access values by index in the range [0, size - 1].

Use cases:

Wherever you would use an array as a list (not concerned with keys).
A more efficient alternative to SplDoublyLinkedList and SplFixedArray.

Interface synopsis

interfaceDs\SequenceextendsDs\Collection, ArrayAccess {

abstractpublicallocate(int$capacity): void

abstractpublicapply(callable$callback): void

abstractpubliccapacity(): int

abstractpubliccontains(mixed...$values): bool

abstractpublicfilter(callable$callback = ?): Ds\Sequence

abstractpublicfind(mixed$value): mixed

abstractpublicfirst(): mixed

abstractpublicget(int$index): mixed

abstractpublicinsert(int$index, mixed...$values): void

abstractpublicjoin(string$glue = ?): string

abstractpubliclast(): mixed

abstractpublicmap(callable$callback): Ds\Sequence

abstractpublicmerge(mixed$values): Ds\Sequence

abstractpublicpop(): mixed

abstractpublicpush(mixed...$values): void

abstractpublicreduce(callable$callback, mixed$initial = ?): mixed

abstractpublicremove(int$index): mixed

abstractpublicreverse(): void

abstractpublicreversed(): Ds\Sequence

abstractpublicrotate(int$rotations): void

abstractpublicset(int$index, mixed$value): void

abstractpublicshift(): mixed

abstractpublicslice(int$index, int$length = ?): Ds\Sequence

abstractpublicsort(callable$comparator = ?): void

abstractpublicsorted(callable$comparator = ?): Ds\Sequence

abstractpublicsum(): int|float

abstractpublicunshift(mixed$values = ?): void

publicDs\Collection::clear(): void

publicDs\Collection::copy(): Ds\Collection

publicDs\Collection::isEmpty(): bool

publicDs\Collection::toArray(): array

publicCountable::count(): int

publicIteratorAggregate::getIterator(): Traversable

publicJsonSerializable::jsonSerialize(): mixed

publicArrayAccess::offsetExists(mixed$offset): bool

publicArrayAccess::offsetGet(mixed$offset): mixed

publicArrayAccess::offsetSet(mixed$offset, mixed$value): void

publicArrayAccess::offsetUnset(mixed$offset): void

}

Changelog

Version	Description
PECL ds 1.3.0	The interface now extends ArrayAccess.

Ds\Sequence::allocate — Allocates enough memory for a required capacity
Ds\Sequence::apply — Updates all values by applying a callback function to each value
Ds\Sequence::capacity — Returns the current capacity
Ds\Sequence::contains — Determines if the sequence contains given values
Ds\Sequence::filter — Creates a new sequence using a callable to determine which values to include
Ds\Sequence::find — Attempts to find a value's index
Ds\Sequence::first — Returns the first value in the sequence
Ds\Sequence::get — Returns the value at a given index
Ds\Sequence::insert — Inserts values at a given index
Ds\Sequence::join — Joins all values together as a string
Ds\Sequence::last — Returns the last value
Ds\Sequence::map — Returns the result of applying a callback to each value
Ds\Sequence::merge — Returns the result of adding all given values to the sequence
Ds\Sequence::pop — Removes and returns the last value
Ds\Sequence::push — Adds values to the end of the sequence
Ds\Sequence::reduce — Reduces the sequence to a single value using a callback function
Ds\Sequence::remove — Removes and returns a value by index
Ds\Sequence::reverse — Reverses the sequence in-place
Ds\Sequence::reversed — Returns a reversed copy
Ds\Sequence::rotate — Rotates the sequence by a given number of rotations
Ds\Sequence::set — Updates a value at a given index
Ds\Sequence::shift — Removes and returns the first value
Ds\Sequence::slice — Returns a sub-sequence of a given range
Ds\Sequence::sort — Sorts the sequence in-place
Ds\Sequence::sorted — Returns a sorted copy
Ds\Sequence::sum — Returns the sum of all values in the sequence
Ds\Sequence::unshift — Adds values to the front of the sequence

The Sequence interface

Introduction

Interface synopsis

Changelog

Table of Contents