SplQueue

class SplQueue extends SplDoublyLinkedList (View source)

Constants

IT_MODE_LIFO

IT_MODE_FIFO

IT_MODE_DELETE

IT_MODE_KEEP

Methods

void
add(mixed $index, TValue $value)

Add/insert a new value at the specified index

from  SplDoublyLinkedList
TValue
pop()

Pops a node from the end of the doubly linked list

from  SplDoublyLinkedList
TValue
shift()

Shifts a node from the beginning of the doubly linked list

from  SplDoublyLinkedList
void
push(TValue $value)

Pushes an element at the end of the doubly linked list

from  SplDoublyLinkedList
void
unshift(TValue $value)

Prepends the doubly linked list with an element

from  SplDoublyLinkedList
TValue
top()

Peeks at the node from the end of the doubly linked list

from  SplDoublyLinkedList
TValue
bottom()

Peeks at the node from the beginning of the doubly linked list

from  SplDoublyLinkedList
int<0, max>
count()

Counts the number of elements in the doubly linked list.

from  SplDoublyLinkedList
bool
isEmpty()

Checks whether the doubly linked list is empty.

from  SplDoublyLinkedList
int
setIteratorMode(int $mode)

Sets the mode of iteration

int
getIteratorMode()

Returns the mode of iteration

from  SplDoublyLinkedList
bool
offsetExists(mixed $index)

Returns whether the requested $index exists

from  SplDoublyLinkedList
TValue
offsetGet(mixed $index)

Returns the value at the specified $index

from  SplDoublyLinkedList
void
offsetSet(mixed $index, TValue $value)

Sets the value at the specified $index to $newval

from  SplDoublyLinkedList
void
offsetUnset(mixed $index)

Unsets the value at the specified $index

from  SplDoublyLinkedList
void
rewind()

Rewind iterator back to the start

from  SplDoublyLinkedList
TValue
current()

Return current array entry

from  SplDoublyLinkedList
TKey|null
key()

Return current node index

from  SplDoublyLinkedList
void
next()

Move to next entry

from  SplDoublyLinkedList
void
prev()

Move to previous entry

from  SplDoublyLinkedList
bool
valid()

Check whether the doubly linked list contains more nodes

from  SplDoublyLinkedList
void
unserialize(string $data)

Unserializes the storage

from  SplDoublyLinkedList
string|null
serialize()

Serializes the storage

from  SplDoublyLinkedList
array
__debugInfo()

No description

from  SplDoublyLinkedList
array
__serialize()

No description

from  SplDoublyLinkedList
__unserialize(array $data)

No description

from  SplDoublyLinkedList
void
enqueue(TValue $value)

Adds an element to the queue.

TValue
dequeue()

Dequeues a node from the queue

Details

in SplDoublyLinkedList at line 1174
void add(mixed $index, TValue $value)

Since: 5.5

Add/insert a new value at the specified index

Parameters

mixed $index

The index where the new value is to be inserted.
TValue $value

The new value for the index.

Return Value

void

in SplDoublyLinkedList at line 1186
TValue pop()

Pops a node from the end of the doubly linked list

Return Value

TValue

The value of the popped node.

in SplDoublyLinkedList at line 1195
TValue shift()

Shifts a node from the beginning of the doubly linked list

Return Value

TValue

The value of the shifted node.

in SplDoublyLinkedList at line 1207
void push(TValue $value)

Pushes an element at the end of the doubly linked list

Parameters

TValue $value

The value to push.

Return Value

void

in SplDoublyLinkedList at line 1219
void unshift(TValue $value)

Prepends the doubly linked list with an element

Parameters

TValue $value

The value to unshift.

Return Value

void

in SplDoublyLinkedList at line 1228
TValue top()

Peeks at the node from the end of the doubly linked list

Return Value

TValue

The value of the last node.

in SplDoublyLinkedList at line 1237
TValue bottom()

Peeks at the node from the beginning of the doubly linked list

Return Value

TValue

The value of the first node.

in SplDoublyLinkedList at line 1246
int<0, max> count()

Counts the number of elements in the doubly linked list.

Return Value

int<0, max>

The custom count as an integer.

The return value is cast to an integer.

in SplDoublyLinkedList at line 1255
bool isEmpty()

Checks whether the doubly linked list is empty.

Return Value

bool

whether the doubly linked list is empty.

at line 1472
int setIteratorMode(int $mode)

Sets the mode of iteration

Parameters

int $mode

There are two orthogonal sets of modes that can be set:

The direction of the iteration (either one or the other): SplDoublyLinkedList::IT_MODE_LIFO (Stack style)

Return Value

int

in SplDoublyLinkedList at line 1278
int getIteratorMode()

Returns the mode of iteration

Return Value

int

the different modes and flags that affect the iteration.

in SplDoublyLinkedList at line 1290
bool offsetExists(mixed $index)

Returns whether the requested $index exists

Parameters

mixed $index

The index being checked.

Return Value

bool

true on success or false on failure.

The return value will be casted to boolean if non-boolean was returned.

in SplDoublyLinkedList at line 1302
TValue offsetGet(mixed $index)

Returns the value at the specified $index

Parameters

mixed $index

The index with the value.

Return Value

TValue

Can return all value types.

in SplDoublyLinkedList at line 1317
void offsetSet(mixed $index, TValue $value)

Sets the value at the specified $index to $newval

Parameters

mixed $index

The index being set.

TValue $value

The value to set.

Return Value

void

in SplDoublyLinkedList at line 1329
void offsetUnset(mixed $index)

Unsets the value at the specified $index

Parameters

mixed $index

The index being unset.

Return Value

void

in SplDoublyLinkedList at line 1338
void rewind()

Rewind iterator back to the start

Return Value

void

Any returned value is ignored.

in SplDoublyLinkedList at line 1347
TValue current()

Return current array entry

Return Value

TValue

Can return any type.

in SplDoublyLinkedList at line 1356
TKey|null key()

Return current node index

Return Value

TKey|null

TKey on success, or null on failure.

in SplDoublyLinkedList at line 1365
void next()

Move to next entry

Return Value

void

Any returned value is ignored.

in SplDoublyLinkedList at line 1374
void prev()

Move to previous entry

Return Value

void

in SplDoublyLinkedList at line 1383
bool valid()

Check whether the doubly linked list contains more nodes

Return Value

bool

The return value will be casted to boolean and then evaluated. Returns true on success or false on failure.

in SplDoublyLinkedList at line 1394
void unserialize(string $data)

Since: 5.4

Unserializes the storage

Parameters

string $data

The string representation of the object.

Return Value

void

in SplDoublyLinkedList at line 1404
string|null serialize()

Since: 5.4

Serializes the storage

Return Value

string|null

The string representation of the object or null

in SplDoublyLinkedList at line 1412
array __debugInfo()

Since: 7.4

No description

Return Value

array

in SplDoublyLinkedList at line 1420
array __serialize()

Since: 7.4

No description

Return Value

array

in SplDoublyLinkedList at line 1428
__unserialize(array $data)

Since: 7.4

No description

Parameters

array $data

at line 1449
void enqueue(TValue $value)

Adds an element to the queue.

Parameters

TValue $value

The value to enqueue.

Return Value

void

at line 1458
TValue dequeue()

Dequeues a node from the queue

Return Value

TValue

The value of the dequeued node.