SimpleXMLElement::rewind

最初の要素に巻き戻す

説明

public void SimpleXMLElement::rewind()

警告

PHP 8.0 より前のバージョンでは、 SimpleXMLElement::rewind はサブクラスの SimpleXMLIterator でのみ宣言されていました。

このメソッドは、SimpleXMLElement を最初の要素に巻き戻します。

注意: PHP 8.4.0 以降では、値を取得するメソッド ( SimpleXMLElement::asXML や SimpleXMLElement::getName など) を呼び出したり、 SimpleXMLElement を string にキャストしたりしても、イテレータが暗黙的に巻き戻されることはなくなりました。必要な場合は、このメソッドを呼び出してイテレータを明示的に巻き戻さなければなりません。

パラメータ

この関数にはパラメータはありません。

戻り値

値を返しません。

例

例1 最初の要素に巻き戻す

<?php
$xmlElement = new SimpleXMLElement('<books><book>PHP Basics</book><book>XML Basics</book></books>');
$xmlElement->rewind();

var_dump($xmlElement->current());
?>

上の例の出力は以下となります。

object(SimpleXMLElement)#2 (1) {
  [0]=>
  string(10) "PHP Basics"
}