Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / PHP

SplQueue::dequeue — retirar o primeiro elemento da fila

`dequeue()` retira o primeiro elemento de uma fila FIFO e devolve o seu valor. Se a fila estiver vazia, lança `RuntimeException`; `null` pode ser um valor guardado.

Versão: PHP 8.3

Sintaxe

public function dequeue(): mixed

$value = $queue->dequeue();

Em PHP 8.3, SplQueue::dequeue é um método público de instância da classe \SplQueue da SPL. A SPL faz parte do núcleo do PHP 8.3 e não pode ser desativada. A chamada $queue->dequeue() não recebe argumentos: retira um elemento do início da fila e devolve o seu valor como mixed. Como enqueue() acrescenta elementos ao fim da fila, estes saem pela ordem de inserção (FIFO).

O método é um alias de SplDoublyLinkedList::shift(). Para consultar o primeiro elemento sem o retirar, usa o método herdado bottom(). Já pop() retira o elemento da extremidade oposta e devolve o seu valor.

Chamar dequeue() numa fila vazia lança uma \RuntimeException. Se for normal a fila estar vazia, verifica o seu estado com isEmpty() antes de retirar um elemento. Um resultado null ou false pode ser um valor guardado, não um sinal de que a fila está vazia.

Exemplos

<?php
$queue = new \SplQueue();
$queue->enqueue('A');
$queue->enqueue(null);
$queue->enqueue('B');

while (!$queue->isEmpty()) {
    echo var_export($queue->dequeue(), true), "\n";
}

try {
    $queue->dequeue();
} catch (\RuntimeException $exception) {
    echo get_class($exception), "\n";
}

Resultado

'A'
NULL
'B'
RuntimeException

O ciclo apresenta os três valores pela ordem de inserção, incluindo `NULL`. A última chamada omite deliberadamente a verificação com `isEmpty()` e apresenta o nome da classe da exceção capturada.

Lições relacionadas

  • PHP · Lição 65 · Avançado · Versão: 2

Fontes