1. class
  2. Ds
  3. \
  4. Seq

Seq

final class Seq implements Countable, IteratorAggregate, JsonSerializable, ArrayAccess (View source)

Constants

MIN_CAPACITY

Methods

__construct(iterable $values = [])

No description

void
allocate(int $capacity)

No description

void
apply(callable $callback)

No description

int
capacity()

No description

void
clear()

No description

bool
contains(TValue ...$values)

No description

Seq
copy()

No description

int
count()

Count elements of an object

Seq
filter(callable|null $callback = null)

No description

int|false
find(TValue $value)

No description

TValue
first()

No description

Traversable
getIterator()

No description

TValue
get(int $index)

No description

void
insert(int $index, TValue ...$values)

No description

bool
isEmpty()

No description

string
join(string $glue = '')

No description

mixed
jsonSerialize()

No description

TValue
last()

No description

Seq
map(callable $callback)

No description

Seq
merge(TValue> $values)

No description

TValue
pop()

No description

void
push(TValue ...$values)

No description

TReturn|null
reduce(callable $callback, TInitial|null $initial = null)

No description

TValue
remove(int $index)

No description

void
reverse()

No description

Seq
reversed()

No description

void
rotate(int $rotations)

No description

void
set(int $index, TValue $value)

No description

TValue
shift()

No description

Seq
slice(int $index, int|null $length = null)

No description

void
sort(callable|null $comparator = null)

No description

Seq
sorted(callable|null $comparator = null)

No description

int|float
sum()

No description

array
toArray()

No description

void
unshift(TValue ...$values)

No description

array
__serialize()

No description

void
__unserialize(array $data)

No description

bool
offsetExists(TKey $offset)

Whether a offset exists

mixed
offsetGet(TKey $offset)

Offset to retrieve

void
offsetSet(TKey $offset, TValue $value)

Offset to set

void
offsetUnset(TKey $offset)

Offset to unset

Details

at line 89
__construct(iterable $values = [])

No description

Parameters

iterable $values

at line 91
void allocate(int $capacity)

No description

Parameters

int $capacity

Return Value

void

at line 96
void apply(callable $callback)

No description

Parameters

callable $callback

Return Value

void

at line 98
int capacity()

No description

Return Value

int

at line 100
void clear()

No description

Return Value

void

at line 105
bool contains(TValue ...$values)

No description

Parameters

TValue ...$values

Return Value

bool

at line 110
Seq copy()

No description

Return Value

Seq

at line 112
int count()

Count elements of an object

Return Value

int

The custom count as an integer.

The return value is cast to an integer.

at line 118
Seq filter(callable|null $callback = null)

No description

Parameters

callable|null $callback

Return Value

Seq

at line 124
int|false find(TValue $value)

No description

Parameters

TValue $value

Return Value

int|false

at line 129
TValue first()

No description

Return Value

TValue

at line 134
Traversable getIterator()

No description

Return Value

Traversable

An instance of an object implementing Iterator or Traversable

at line 139
TValue get(int $index)

No description

Parameters

int $index

Return Value

TValue

at line 144
void insert(int $index, TValue ...$values)

No description

Parameters

int $index
TValue ...$values

Return Value

void

at line 146
bool isEmpty()

No description

Return Value

bool

at line 148
string join(string $glue = '')

No description

Parameters

string $glue

Return Value

string

at line 153
mixed jsonSerialize()

No description

Return Value

mixed

data which can be serialized by json_encode, which is a value of any type other than a resource.

at line 158
TValue last()

No description

Return Value

TValue

at line 165
Seq map(callable $callback)

No description

Parameters

callable $callback

Return Value

Seq

at line 171
Seq merge(TValue> $values)

No description

Parameters

TValue> $values

Return Value

Seq

at line 176
TValue pop()

No description

Return Value

TValue

at line 181
void push(TValue ...$values)

No description

Parameters

TValue ...$values

Return Value

void

at line 190
TReturn|null reduce(callable $callback, TInitial|null $initial = null)

No description

Parameters

callable $callback
TInitial|null $initial

Return Value

TReturn|null

at line 195
TValue remove(int $index)

No description

Parameters

int $index

Return Value

TValue

at line 197
void reverse()

No description

Return Value

void

at line 202
Seq reversed()

No description

Return Value

Seq

at line 204
void rotate(int $rotations)

No description

Parameters

int $rotations

Return Value

void

at line 209
void set(int $index, TValue $value)

No description

Parameters

int $index
TValue $value

Return Value

void

at line 214
TValue shift()

No description

Return Value

TValue

at line 219
Seq slice(int $index, int|null $length = null)

No description

Parameters

int $index
int|null $length

Return Value

Seq

at line 224
void sort(callable|null $comparator = null)

No description

Parameters

callable|null $comparator

Return Value

void

at line 230
Seq sorted(callable|null $comparator = null)

No description

Parameters

callable|null $comparator

Return Value

Seq

at line 235
int|float sum()

No description

Return Value

int|float

at line 240
array toArray()

No description

Return Value

array

at line 245
void unshift(TValue ...$values)

No description

Parameters

TValue ...$values

Return Value

void

at line 250
array __serialize()

No description

Return Value

array

at line 252
void __unserialize(array $data)

No description

Parameters

array $data

Return Value

void

at line 254
bool offsetExists(TKey $offset)

Whether a offset exists

Parameters

TKey $offset

An offset to check for.

Return Value

bool

true on success or false on failure.

The return value will be casted to boolean if non-boolean was returned.

at line 256
mixed offsetGet(TKey $offset)

Offset to retrieve

Parameters

TKey $offset

The offset to retrieve.

Return Value

mixed

Can return all value types.

at line 258
void offsetSet(TKey $offset, TValue $value)

Offset to set

Parameters

TKey $offset

The offset to assign the value to.

TValue $value

The value to set.

Return Value

void

at line 260
void offsetUnset(TKey $offset)

Offset to unset

Parameters

TKey $offset

The offset to unset.

Return Value

void