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

Map

final class Map 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

Map
copy()

No description

int
count()

Count elements of an object

Map
diff(Map $map)

No description

Map
filter(callable|null $callback = null)

No description

Pair
first()

No description

TValue|null
get(TKey $key, TValue|null $default = null)

No description

Traversable
getIterator()

No description

bool
hasKey(TKey $key)

No description

bool
hasValue(TValue $value)

No description

Map
intersect(Map $map)

No description

bool
isEmpty()

No description

mixed
jsonSerialize()

No description

Set
keys()

No description

void
ksort(callable|null $comparator = null)

No description

Map
ksorted(callable|null $comparator = null)

No description

Pair
last()

No description

Map
map(callable $callback)

No description

Map
merge(TValue> $values)

No description

Seq
pairs()

No description

void
put(TKey $key, TValue $value)

No description

void
putAll(TValue> $values)

No description

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

No description

TValue|null
remove(TKey $key, TValue|null $default = null)

No description

void
reverse()

No description

Map
reversed()

No description

Pair
skip(int $position)

No description

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

No description

void
sort(callable|null $comparator = null)

No description

Map
sorted(callable|null $comparator = null)

No description

int|float
sum()

No description

array
toArray()

No description

Map
union(Map $map)

No description

Seq
values()

No description

Map
xor(Map $map)

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 277
__construct(iterable $values = [])

No description

Parameters

iterable $values

at line 279
void allocate(int $capacity)

No description

Parameters

int $capacity

Return Value

void

at line 284
void apply(callable $callback)

No description

Parameters

callable $callback

Return Value

void

at line 286
int capacity()

No description

Return Value

int

at line 288
void clear()

No description

Return Value

void

at line 291
Map copy()

No description

Return Value

Map

at line 293
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 296
Map diff(Map $map)

No description

Parameters

Map $map

Return Value

Map

at line 302
Map filter(callable|null $callback = null)

No description

Parameters

callable|null $callback

Return Value

Map

at line 305
Pair first()

No description

Return Value

Pair

at line 312
TValue|null get(TKey $key, TValue|null $default = null)

No description

Parameters

TKey $key
TValue|null $default

Return Value

TValue|null

at line 315
Traversable getIterator()

No description

Return Value

Traversable

An instance of an object implementing Iterator or Traversable

at line 318
bool hasKey(TKey $key)

No description

Parameters

TKey $key

Return Value

bool

at line 321
bool hasValue(TValue $value)

No description

Parameters

TValue $value

Return Value

bool

at line 324
Map intersect(Map $map)

No description

Parameters

Map $map

Return Value

Map

at line 326
bool isEmpty()

No description

Return Value

bool

at line 329
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 332
Set keys()

No description

Return Value

Set

at line 335
void ksort(callable|null $comparator = null)

No description

Parameters

callable|null $comparator

Return Value

void

at line 341
Map ksorted(callable|null $comparator = null)

No description

Parameters

callable|null $comparator

Return Value

Map

at line 344
Pair last()

No description

Return Value

Pair

at line 351
Map map(callable $callback)

No description

Parameters

callable $callback

Return Value

Map

at line 357
Map merge(TValue> $values)

No description

Parameters

TValue> $values

Return Value

Map

at line 360
Seq pairs()

No description

Return Value

Seq

at line 366
void put(TKey $key, TValue $value)

No description

Parameters

TKey $key
TValue $value

Return Value

void

at line 369
void putAll(TValue> $values)

No description

Parameters

TValue> $values

Return Value

void

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

No description

Parameters

callable $callback
TInitial|null $initial

Return Value

TReturn|null

at line 385
TValue|null remove(TKey $key, TValue|null $default = null)

No description

Parameters

TKey $key
TValue|null $default

Return Value

TValue|null

at line 387
void reverse()

No description

Return Value

void

at line 390
Map reversed()

No description

Return Value

Map

at line 393
Pair skip(int $position)

No description

Parameters

int $position

Return Value

Pair

at line 396
Map slice(int $index, int|null $length = null)

No description

Parameters

int $index
int|null $length

Return Value

Map

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

No description

Parameters

callable|null $comparator

Return Value

void

at line 405
Map sorted(callable|null $comparator = null)

No description

Parameters

callable|null $comparator

Return Value

Map

at line 408
int|float sum()

No description

Return Value

int|float

at line 411
array toArray()

No description

Return Value

array

at line 414
Map union(Map $map)

No description

Parameters

Map $map

Return Value

Map

at line 417
Seq values()

No description

Return Value

Seq

at line 420
Map xor(Map $map)

No description

Parameters

Map $map

Return Value

Map

at line 422
array __serialize()

No description

Return Value

array

at line 424
void __unserialize(array $data)

No description

Parameters

array $data

Return Value

void

at line 426
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 428
mixed offsetGet(TKey $offset)

Offset to retrieve

Parameters

TKey $offset

The offset to retrieve.

Return Value

mixed

Can return all value types.

at line 430
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 432
void offsetUnset(TKey $offset)

Offset to unset

Parameters

TKey $offset

The offset to unset.

Return Value

void