SimpleXMLElement::key

(No version information available, might only be in Git)

SimpleXMLElement::key — Retorna a chave atual

Descrição

public SimpleXMLElement::key(): string

Warning

Antes do PHP 8.0, SimpleXMLElement::key() era declarado somente na sub-classe SimpleXMLIterator.

Este método obtém o nome da etiqueta XML do elemento atual.

Parâmetros

Esta função não possui parâmetros.

Valor Retornado

Retorna o nome da etiqueta XML do elemento referenciado pelo objeto SimpleXMLElement atual.

Erros/Exceções

Lança um Error em caso de falha.

Registro de Alterações

Versão	Descrição
8.1.0	Um Error agora é lançado se SimpleXMLElement::key() for chamado em um iterador inválido. Anteriormente, `false` era retornado.

Exemplos

Example #1 Obtendo a chave da etiqueta XML atual

<?php
$xmlElement = new SimpleXMLElement('<livros><livro>PHP Básico</livro><livro>XML Básico</livro></livros>');

echo var_dump($xmlElement->key());
$xmlElement->rewind(); // retrocede ao primeiro elemento
echo var_dump($xmlElement->key());

?>

O exemplo acima produzirá:

bool(false)
string(5) "livro"