【PHP8.x】currentメソッドの使い方

currentメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

currentメソッドは、LimitIteratorオブジェクトが現在指している要素の値を取得するために実行するメソッドです。LimitIteratorは、既存のイテレータが持つデータの中から、指定した開始位置(オフセット)から特定の件数分の要素だけを切り出して反復処理を行うためのクラスです。このcurrentメソッドは、その切り出された範囲内において、現在どの要素を指しているかという「現在位置」の実際の値を返します。例えば、foreachループでLimitIteratorオブジェクトを処理する場合、ループの各繰り返しにおいてこのメソッドが内部的に呼び出され、その時点での要素の値が取得されます。このメソッドは、Iteratorインターフェースで定められている基本的なメソッドの一つであり、イテレータの現在の状態を取得するために不可欠な機能を提供します。返される値のデータ型は、元のイテレータが保持している要素の型に依存します。このメソッドを利用することで、制限されたデータセット内の現在の要素にアクセスし、値の参照や操作を行うことが可能になります。

構文(syntax)

1<?php
2
3// 元となる配列データ
4$fruits = ['Apple', 'Banana', 'Cherry', 'Date', 'Elderberry'];
5
6// 配列をイテレータに変換
7$arrayIterator = new ArrayIterator($fruits);
8
9// 2番目の要素('Banana')から3つ分の要素に制限するイテレータを作成
10$limitIterator = new LimitIterator($arrayIterator, 1, 3);
11
12// イテレータを先頭に移動 (この時点での先頭は 'Banana')
13$limitIterator->rewind();
14
15// 現在のカーソル位置にある要素を取得します。
16// LimitIterator::current(): mixed
17$currentValue = $limitIterator->current();
18
19// 取得した要素を出力
20var_dump($currentValue); // string(6) "Banana"
21
22?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

mixed

LimitIterator クラスの current メソッドは、現在位置にある要素を返します。返される要素の型は、イテレータが保持している要素の型に依存します。

【PHP8.x】currentメソッドの使い方 | いっしー@Webエンジニア