【PHP8.x】SplQueue::current()メソッドの使い方

currentメソッドはSplQueueオブジェクトにおいて、現在のイテレータが指す要素の値を取得するメソッドです。

SplQueueは、PHPの標準ライブラリ（SPL）の一部として提供される、キューと呼ばれるデータ構造を効率的に管理するためのクラスです。キューは先入れ先出し（FIFO）の原則に基づきデータを扱いますが、currentメソッドはSplQueueオブジェクトをイテレータとして扱う際に、現在注目している要素の実際の値を取り出すために用いられます。

具体的には、foreachループなどでSplQueueオブジェクトを反復処理する際、内部的にこのメソッドが呼び出され、イテレータの内部ポインタが現在指し示している要素の内容そのものを返します。例えば、キューに複数のデータ（例: 商品ID、ユーザー名など）が格納されている場合、currentメソッドを使うことで、イテレータが現在処理対象としている具体的なデータを取得することができます。

戻り値の型はmixedであり、キューに格納されたデータ型（整数、文字列、オブジェクトなど）に応じて異なります。イテレータが有効な位置にない場合や、キューが空の場合には、通常NULLが返されます。このメソッドはイテレータの位置を次に進める役割は持たず、あくまで現在の位置にある要素の値を参照するのみです。SplQueueの要素を順次確認していく上で、それぞれの要素が持つ具体的な情報を取得するために不可欠な機能です。

Copy
1<?php
2
3$queue = new SplQueue();
4$queue->enqueue("first element");
5$queue->enqueue("second element");
6
7$queue->rewind();
8$currentElement = $queue->current();
9

引数なし

引数はありません

mixed

SplQueueの現在の要素を返します。キューが空の場合は null を返します。