The SplDoublyLinkedList class

Introduction

The SplDoublyLinkedList class provides the main functionalities of a doubly linked list.

Class synopsis

SplDoublyLinkedList

implements Iterator Countable ArrayAccess Serializable

/* Constants */

public const int SplDoublyLinkedList::IT_MODE_LIFO;

public const int SplDoublyLinkedList::IT_MODE_FIFO;

public const int SplDoublyLinkedList::IT_MODE_DELETE;

public const int SplDoublyLinkedList::IT_MODE_KEEP;

/* Methods */

public void add(int $index, mixed $value)

public mixed bottom()

public int count()

public mixed current()

public int getIteratorMode()

public bool isEmpty()

public int key()

public void next()

public bool offsetExists(int $index)

public mixed offsetGet(int $index)

public void offsetSet(intnull $index, mixed $value)

public void offsetUnset(int $index)

public mixed pop()

public void prev()

public void push(mixed $value)

public void rewind()

public string serialize()

public int setIteratorMode(int $mode)

public mixed shift()

public mixed top()

public void unserialize(string $data)

public void unshift(mixed $value)

public bool valid()

Predefined Constants

Iteration Direction

SplDoublyLinkedList::IT_MODE_LIFO: The list will be iterated in a last in, first out order, like a stack.
SplDoublyLinkedList::IT_MODE_FIFO: The list will be iterated in a first in, first out order, like a queue.

Iteration Behavior

SplDoublyLinkedList::IT_MODE_DELETE: Iteration will remove the iterated elements.
SplDoublyLinkedList::IT_MODE_KEEP: Iteration will not remove the iterated elements.

Table of Contents

SplDoublyLinkedList::add — Add/insert a new value at the specified index
SplDoublyLinkedList::bottom — Peeks at the node from the beginning of the doubly linked list
SplDoublyLinkedList::count — Counts the number of elements in the doubly linked list
SplDoublyLinkedList::current — Return current array entry
SplDoublyLinkedList::getIteratorMode — Returns the mode of iteration
SplDoublyLinkedList::isEmpty — Checks whether the doubly linked list is empty
SplDoublyLinkedList::key — Return current node index
SplDoublyLinkedList::next — Move to next entry
SplDoublyLinkedList::offsetExists — Returns whether the requested $index exists
SplDoublyLinkedList::offsetGet — Returns the value at the specified $index
SplDoublyLinkedList::offsetSet — Sets the value at the specified $index to $value
SplDoublyLinkedList::offsetUnset — Unsets the value at the specified $index
SplDoublyLinkedList::pop — Pops a node from the end of the doubly linked list
SplDoublyLinkedList::prev — Move to previous entry
SplDoublyLinkedList::push — Pushes an element at the end of the doubly linked list
SplDoublyLinkedList::rewind — Rewind iterator back to the start
SplDoublyLinkedList::serialize — Serializes the storage
SplDoublyLinkedList::setIteratorMode — Sets the mode of iteration
SplDoublyLinkedList::shift — Shifts a node from the beginning of the doubly linked list
SplDoublyLinkedList::top — Peeks at the node from the end of the doubly linked list
SplDoublyLinkedList::unserialize — Unserializes the storage
SplDoublyLinkedList::unshift — Prepends the doubly linked list with an element
SplDoublyLinkedList::valid — Check whether the doubly linked list contains more nodes