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

Set

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

Constants

MIN_CAPACITY

Methods

__construct(iterable $values = [])

No description

void
add(TValue ...$values)

No description

void
allocate(int $capacity)

No description

int
capacity()

No description

void
clear()

No description

bool
contains(TValue ...$values)

No description

Set
copy()

No description

int
count()

Count elements of an object

Set
diff(Set $set)

No description

Set
filter(callable|null $callback = null)

No description

TValue
first()

No description

TValue
get(int $index)

No description

Traversable
getIterator()

No description

Set
intersect(Set $set)

No description

bool
isEmpty()

No description

string
join(string $glue = '')

No description

mixed
jsonSerialize()

No description

TValue
last()

No description

Set
map(callable $callback)

No description

Set
merge(TValue> $values)

No description

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

No description

void
remove(TValue ...$values)

No description

void
reverse()

No description

Set
reversed()

No description

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

No description

void
sort(callable|null $comparator = null)

No description

Set
sorted(callable|null $comparator = null)

No description

int|float
sum()

No description

array
toArray()

No description

Set
union(Set $set)

No description

Set
xor(Set $set)

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

No description

Parameters

iterable $values

at line 480
void add(TValue ...$values)

No description

Parameters

TValue ...$values

Return Value

void

at line 482
void allocate(int $capacity)

No description

Parameters

int $capacity

Return Value

void

at line 484
int capacity()

No description

Return Value

int

at line 486
void clear()

No description

Return Value

void

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

No description

Parameters

TValue ...$values

Return Value

bool

at line 492
Set copy()

No description

Return Value

Set

at line 494
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 497
Set diff(Set $set)

No description

Parameters

Set $set

Return Value

Set

at line 503
Set filter(callable|null $callback = null)

No description

Parameters

callable|null $callback

Return Value

Set

at line 506
TValue first()

No description

Return Value

TValue

at line 509
TValue get(int $index)

No description

Parameters

int $index

Return Value

TValue

at line 512
Traversable getIterator()

No description

Return Value

Traversable

An instance of an object implementing Iterator or Traversable

at line 515
Set intersect(Set $set)

No description

Parameters

Set $set

Return Value

Set

at line 517
bool isEmpty()

No description

Return Value

bool

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

No description

Parameters

string $glue

Return Value

string

at line 522
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 525
TValue last()

No description

Return Value

TValue

at line 532
Set map(callable $callback)

No description

Parameters

callable $callback

Return Value

Set

at line 538
Set merge(TValue> $values)

No description

Parameters

TValue> $values

Return Value

Set

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

No description

Parameters

callable $callback
TInitial|null $initial

Return Value

TReturn|null

at line 550
void remove(TValue ...$values)

No description

Parameters

TValue ...$values

Return Value

void

at line 552
void reverse()

No description

Return Value

void

at line 555
Set reversed()

No description

Return Value

Set

at line 558
Set slice(int $index, int|null $length = null)

No description

Parameters

int $index
int|null $length

Return Value

Set

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

No description

Parameters

callable|null $comparator

Return Value

void

at line 567
Set sorted(callable|null $comparator = null)

No description

Parameters

callable|null $comparator

Return Value

Set

at line 570
int|float sum()

No description

Return Value

int|float

at line 573
array toArray()

No description

Return Value

array

at line 576
Set union(Set $set)

No description

Parameters

Set $set

Return Value

Set

at line 579
Set xor(Set $set)

No description

Parameters

Set $set

Return Value

Set

at line 581
array __serialize()

No description

Return Value

array

at line 583
void __unserialize(array $data)

No description

Parameters

array $data

Return Value

void

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

Offset to retrieve

Parameters

TKey $offset

The offset to retrieve.

Return Value

mixed

Can return all value types.

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

Offset to unset

Parameters

TKey $offset

The offset to unset.

Return Value

void