SimpleXMLElement::key

(PHP 8)

SimpleXMLElement::key — Devuelve la clave actual

Descripción

public SimpleXMLElement::key(): string

Advertencia

Antes de PHP 8.0, SimpleXMLElement::key() solo estaba declarada en la subclase SimpleXMLIterator.

Este método lee el nombre de la etiqueta XML actual.

Parámetros

Esta función no contiene ningún parámetro.

Valores devueltos

Devuelve el nombre de la etiqueta XML en el objeto actual del iterador SimpleXMLElement.

Errores/Excepciones

Se lanza una Error en caso de fallo.

Historial de cambios

Versión	Descripción
8.1.0	Ahora se lanza una Error si SimpleXMLElement::key() se llama sobre un iterador no válido. Anteriormente, se devolvía `false`.

Ejemplos

Ejemplo #1 El nombre de la etiqueta XML actual

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

try {
    echo var_dump($xmlElement->key());
} catch (Error $e) {
    echo $e->getMessage(), "\n";
}

$xmlElement->rewind(); // retorno al primer elemento
echo var_dump($xmlElement->key());

?>

El ejemplo anterior mostrará:

Iterator not initialized or already consumed
string(4) "book"