The Stack class

(PECL ds >= 1.0.0)

Introduction

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.

Uses a Ds\Vector internally.

Class synopsis

classDs\StackimplementsDs\Collection, ArrayAccess {

publicallocate(int$capacity): void

publiccapacity(): int

publicclear(): void

publiccopy(): Ds\Stack

publicisEmpty(): bool

publicpeek(): mixed

publicpop(): mixed

publicpush(mixed...$values): void

publictoArray(): array

}

Changelog

Version	Description
PECL ds 1.3.0	The class now implements ArrayAccess.

Ds\Stack::allocate — Allocates enough memory for a required capacity
Ds\Stack::capacity — Returns the current capacity
Ds\Stack::clear — Removes all values
Ds\Stack::__construct — Creates a new instance
Ds\Stack::copy — Returns a shallow copy of the stack
Ds\Stack::count — Returns the number of values in the stack
Ds\Stack::isEmpty — Returns whether the stack is empty
Ds\Stack::jsonSerialize — Returns a representation that can be converted to JSON
Ds\Stack::peek — Returns the value at the top of the stack
Ds\Stack::pop — Removes and returns the value at the top of the stack
Ds\Stack::push — Pushes values onto the stack
Ds\Stack::toArray — Converts the stack to an array

The Stack class

Introduction

Class synopsis

Changelog

Table of Contents