php8.5
/
Download
Home/ Manual/ spl / spldoublylinkedlist/ SplDoublyLinkedList::setIteratorMode

SplDoublyLinkedList::setIteratorMode

PHP function Edit on GitHub ✎

(PHP 5 >= 5.3.0, PHP 7, PHP 8)

Sets the mode of iteration

Description

SplDoublyLinkedList::setIteratorMode(int $mode): int

Parameters

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)
    • SplDoublyLinkedList::IT_MODE_FIFO (Queue style)

  • The behavior of the iterator (either one or the other):

    • SplDoublyLinkedList::IT_MODE_DELETE (Elements are deleted by the iterator)
    • SplDoublyLinkedList::IT_MODE_KEEP (Elements are traversed by the iterator)

The default mode is: SplDoublyLinkedList::IT_MODE_FIFO | SplDoublyLinkedList::IT_MODE_KEEP

Warning

The direction of iteration can not be changed for SplStack and SplQueue classes, it is always SplDoublyLinkedList::IT_MODE_FIFO. Trying to modify it will result in a RuntimeException being thrown.

Return Values

Returns the different modes and flags that affect the iteration.

Source: reference/spl/spldoublylinkedlist/setiteratormode.xml · from the official PHP manual (php/doc-en)