Documentation

Arr
in package
implements IteratorAggregate, ProvidesIter

Immutable array wrapper.

Tags
template

TVal

implements

IteratorAggregate<TVal>

implements

ProvidesIter<array-key, TVal>

psalm-suppress

MixedReturnTypeCoercion, MixedArgumentTypeCoercion, ImpureMethodCall, ImpureFunctionCall

psalm-immutable

Table of Contents

Interfaces

IteratorAggregate
ProvidesIter

Properties

$array  : array<string|int, mixed>

Methods

at()  : Option<string|int, TVal>
contains()  : bool
duplicate()  : Arr<string|int, U>
filter()  : Arr<string|int, TVal>
getIterator()  : Traversable
isEmpty()  : bool
isList()  : bool
iter()  : Iter<TKey, TVal>
keys()  : Arr<string|int, string|int>
map()  : Arr<string|int, UVal>
of()  : Arr<string|int, UVal>
pipeThrough()  : mixed
values()  : Arr<string|int, TVal>
wrap()  : Arr<string|int, U>
zip()  : Arr<string|int, array<string|int, mixed>>
__construct()  : mixed

Properties

$array read-only

protected array<string|int, mixed> $array

Methods

at()

public at(string|int $key) : Option<string|int, TVal>
Parameters
$key : string|int
Return values
Option<string|int, TVal>

contains()

public contains(TVal $value) : bool
Parameters
$value : TVal
Return values
bool

duplicate()

public static duplicate(U $item, int<0, max> $count) : Arr<string|int, U>
Parameters
$item : U
$count : int<0, max>
Tags
template

U

Return values
Arr<string|int, U>

filter()

public filter(callable $predicate) : Arr<string|int, TVal>
Parameters
$predicate : callable
Return values
Arr<string|int, TVal>

getIterator()

public getIterator() : Traversable
Tags
inheritDoc
Return values
Traversable

isEmpty()

public isEmpty() : bool
Return values
bool

isList()

public isList() : bool
Return values
bool

iter()

public iter() : Iter<TKey, TVal>
Tags
inheritDoc
Return values
Iter<TKey, TVal>

keys()

public keys() : Arr<string|int, string|int>
Return values
Arr<string|int, string|int>

map()

public map(callable $f) : Arr<string|int, UVal>
Parameters
$f : callable
Tags
template

UVal

Return values
Arr<string|int, UVal>

of()

public static of(array<string|int, UVal$array) : Arr<string|int, UVal>
Parameters
$array : array<string|int, UVal>
Tags
template

UVal

Return values
Arr<string|int, UVal>

pipeThrough()

public pipeThrough(callable ...$funs) : mixed
Parameters
$funs : callable

values()

public values() : Arr<string|int, TVal>
Return values
Arr<string|int, TVal>

wrap()

public static wrap(U $value) : Arr<string|int, U>
Parameters
$value : U
Tags
template

U

Return values
Arr<string|int, U>

zip()

public zip(array<string|int, mixed>|Arr ...$arrays) : Arr<string|int, array<string|int, mixed>>
Parameters
$arrays : array<string|int, mixed>|Arr
Return values
Arr<string|int, array<string|int, mixed>>

__construct()

protected __construct(array<string|int, TVal$array) : mixed
Parameters
$array : array<string|int, TVal>

        
On this page

Search results