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

Stack

class Stack implements Collection, ArrayAccess (View source)

A Stack is a “last in, first out” or “LIFO” collection that only allows access to the value at the top of the structure and iterates in that order, destructively.

Methods

__construct(TValue> $values = [])

Creates a new instance, using either a traversable object or an array for the initial values.

allocate(int $capacity)

Ensures that enough memory is allocated for a required capacity. This removes the need to reallocate the internal as values are added.

int
capacity()

Returns the current capacity.

void
clear()

Removes all values from the stack.

int
count()

Count elements of an object

TValue>
copy()

Returns a shallow copy of the collection.

Traversable
getIterator()

No description

bool
isEmpty()

Returns whether the collection is empty.

array
toArray()

Converts the collection to an array.

mixed
jsonSerialize()

Specify data which should be serialized to JSON

TValue
peek()

Returns the value at the top of the stack, but does not remove it.

TValue
pop()

Removes and returns the value at the top of the stack.

push(TValue ...$values)

Pushes values onto the stack.

bool
offsetExists(TKey $offset)

No description

mixed
offsetGet(TKey $offset)

No description

void
offsetSet(TKey $offset, TValue $value)

No description

void
offsetUnset(TKey $offset)

No description

Details

at line 2330
__construct(TValue> $values = [])

Creates a new instance, using either a traversable object or an array for the initial values.

Parameters

TValue> $values

A traversable object or an array to use for the initial values.

at line 2344
allocate(int $capacity)

Ensures that enough memory is allocated for a required capacity. This removes the need to reallocate the internal as values are added.

Parameters

int $capacity

The number of values for which capacity should be allocated.

Note: Capacity will stay the same if this value is less than or equal to the current capacity.

at line 2353
int capacity()

Returns the current capacity.

Return Value

int

The current capacity.

at line 2359
void clear()

Removes all values from the stack.

Return Value

void

at line 2370
int count()

Since: 5.1

Count elements of an object

Return Value

int

The custom count as an integer.

The return value is cast to an integer.

at line 2377
TValue> copy()

Returns a shallow copy of the collection.

Return Value

TValue>

at line 2382
Traversable getIterator()

No description

Return Value

Traversable

An instance of an object implementing Iterator or Traversable

at line 2389
bool isEmpty()

Returns whether the collection is empty.

Return Value

bool

at line 2398
array toArray()

Converts the collection to an array.

Note: Casting to an array is not supported yet.

Return Value

array

An array containing all the values in the same order as the collection.

at line 2407
mixed jsonSerialize()

Since: 5.4

Specify data which should be serialized to JSON

Return Value

mixed

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

at line 2418
TValue peek()

Returns the value at the top of the stack, but does not remove it.

Return Value

TValue

The value at the top of the stack.

Exceptions

UnderflowException

at line 2429
TValue pop()

Removes and returns the value at the top of the stack.

Return Value

TValue

The removed value which was at the top of the stack.

Exceptions

UnderflowException

at line 2438
push(TValue ...$values)

Pushes values onto the stack.

Parameters

TValue ...$values

The values to push onto the stack.

at line 2443
bool offsetExists(TKey $offset)

No description

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 2450
mixed offsetGet(TKey $offset)

No description

Parameters

TKey $offset

The offset to retrieve.

Return Value

mixed

Can return all value types.

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

No description

Parameters

TKey $offset

The offset to assign the value to.

TValue $value

The value to set.

Return Value

void

at line 2461
void offsetUnset(TKey $offset)

No description

Parameters

TKey $offset

The offset to unset.

Return Value

void