Vlourido: /* Avaliación de expresións XPath */

2013-07-24T18:36:47Z

Avaliación de expresións XPath

Página nueva

== DOM ==

A '''[http://docs.php.net/manual/es/book.dom.php extensión DOM]''' é moito máis potente e complexa que SimpleXML. Entre outras características, permite diferenciar os tipos de nodos e traballar cos comentarios e as instrucións de procesamento dos documentos XML. Imos ver algunhas das súas principais capacidades.

=== Cargar un documento XML ===

Para cargar un documento XML en memoria empregando a extensión DOM, primeiro temos que instanciar un obxecto da clase '''[http://docs.php.net/manual/es/class.domdocument.php DOMDocument]''', e posteriormente empregaremos un dos seguintes métodos:

*'''[http://docs.php.net/manual/es/domdocument.load.php load]'''. Carga un documento XML do ficheiro que se indique.

<div style="margin-left: 2em;">
<source lang="php">
$xml = new DOMDocument();
$xml->load('exemplo.xml');
</source>
</div>

*'''[http://docs.php.net/manual/es/domdocument.loadxml.php loadXML]'''. Carga un documento XML tomando como orixe unha cadea de texto.

<div style="margin-left: 2em;">
<source lang="php">
$xml = new DOMDocument();
$xml->loadXML($texto_xml);
</source>
</div>

Moitas veces convén eliminar os nodos de texto baleiros ao importar un documento XML. Para acadalo, debemos empregar a propiedade '''[http://docs.php.net/manual/es/class.domdocument.php#domdocument.props.preservewhitespace preserveWhiteSpace]''' da clase ''DOMDocument'' antes de procesar o arquivo ou cadea de texto.

<source lang="php">
$xml = new DOMDocument();
$xml->preserveWhiteSpace = false;
$xml->load('exemplo.xml');
</source>

Tamén é posible empregar a función '''[http://docs.php.net/manual/es/function.dom-import-simplexml.php dom_import_simplexml]''' para converter un obxecto SimpleXML a un obxecto '''[http://docs.php.net/manual/es/class.domelement.php DOMElement]''', de xeito inverso ao que facíamos coa función ''simplexml_import_dom''.

<div style="margin-left: 2em;">
<source lang="php">
$sxml = simplexml_load_file('exemplo.xml');
// Creamos o novo nodo a partir do SimpleXML
$dom_element = dom_import_simplexml($sxml);
// E o importamos a un novo documento
$dxml = new DOMDocument('1.0', 'UTF-8');
$dom_node = $dxml->importNode($dom_element, true);
$dxml->appendChild($dom_node);
</source>
</div>

O constructor da clase DOMDocument admite dous parámetros, a versión e o xogo de caracteres do documento, o que nos permite crear novos documentos XML baleiros.

<source lang="php">
$xml = new DOMDocument('1.0', 'UTF-8');
</source>

=== Acceder ao contido dun documento XML ===

Ao cargar un documento XML en memoria empregando a extensión DOM, créase unha árbore de obxectos '''[http://docs.php.net/manual/es/class.domnode.php DOMNode]'''. Cada un destes obxectos ten '''propiedades''' para:

*Acceder ao primeiro fillo ('''[http://docs.php.net/manual/es/class.domnode.php#domnode.props.firstchild firstChild]''') e ao último fillo ('''[http://docs.php.net/manual/es/class.domnode.php#domnode.props.lastchild lastChild]''').

*Acceder ao nodo pai ('''[http://docs.php.net/manual/es/class.domnode.php#domnode.props.parentnode parentNode]''').

*Acceder aos nodos seguinte ('''[http://docs.php.net/manual/es/class.domnode.php#domnode.props.nextsibling nextSibling]''') e anterior ('''[http://docs.php.net/manual/es/class.domnode.php#domnode.props.previoussibling previousSibling]''') na orde do documento XML.

* Obter unha lista '''[http://docs.php.net/manual/es/class.domnodelist.php DOMNodeList]''' dos seus nodos fillos ('''[http://docs.php.net/manual/es/class.domnodelist.php childNodes]'''). A clase ''DOMNodeList'' inclúe un método '''[http://docs.php.net/manual/es/domnodelist.item.php item]''' para acceder aos seus elementos pola súa ubicación na lista, e unha propiedade '''[http://docs.php.net/manual/es/class.domnodelist.php#domnodelist.props.length length]''' que permite coñecer o número de nodos na lista.

*Obter o nome ('''[http://docs.php.net/manual/es/class.domnode.php#domnode.props.nodename nodeName]''') e o valor ('''[http://docs.php.net/manual/es/class.domnode.php#domnode.props.nodevalue nodeValue]''') do nodo, dependendo do seu tipo.

*Obter o tipo de nodo ('''[http://docs.php.net/manual/es/class.domnode.php#domnode.props.nodetype nodeType]'''), referido por unha das [http://docs.php.net/manual/es/dom.constants.php constantes que define a extensión]. Algunhos dos valores posibles son XML_ELEMENT_NODE (é un nodo elemento), XML_ATTRIBUTE_NODE (nodo atributo), XML_TEXT_NODE (nodo de texto) ou XML_COMMENT_NODE (nodo comentario). Dependendo do tipo de nodo, o obxecto pertencerá a unha das clases que herdan de DOMNode: '''[http://docs.php.net/manual/es/class.domelement.php DOMElement]''', '''[http://docs.php.net/manual/es/class.domattr.php DOMAttr]''', '''[http://docs.php.net/manual/es/class.domtext.php DOMText]''', '''[http://docs.php.net/manual/es/class.domcomment.php DOMComment]''', ..., cada unha das cales define os seus propios métodos e propiedades.

:Por exemplo, para acceder ao valor dun atributo emprégase a propiedade '''[http://docs.php.net/manual/es/class.domattr.php#domattr.props.value value]''' da clase ''DOMAttr'', para a etiqueta dun elemento temos a propiedade '''[http://docs.php.net/manual/es/class.domelement.php#domelement.props.tagname tagName]''' da clase ''DOMElement'', e para obter o texto dun nodo pódese facer coa propiedade '''[http://docs.php.net/manual/es/class.domtext.php#domtext.props.wholetext wholeText]''' da clase ''DOMText''.

O seguinte script obtén o nome e valor do elemento ''<importe>'' presente no documento de exemplo.

<source lang="php">
$xml = new DOMDocument();
$xml->preserveWhiteSpace = false;
$xml->load('exemplo.xml');

$raiz = $xml->documentElement;
echo "Etiqueta: " . $raiz->firstChild->firstChild->tagName . "<br />";
echo "Valor: " . $raiz->firstChild->firstChild->firstChild->wholeText . "<br />";
</source>

Os obxectos da '''clase DOMElement''' teñen métodos para acceder aos seus atributos e elementos fillos, por exemplo:

*'''[http://docs.php.net/manual/es/domelement.hasattribute.php hasAttribute]''' comproba se existe ou non no elemento un atributo co nome que indiquemos.

*'''[http://docs.php.net/manual/es/domelement.getattribute.php getAttribute]''' devolve unha cadea co valor do atributo que indiquemos. Tamén é posible devolver un nodo atributo no canto dunha cadea de texto, empregando o método '''[http://docs.php.net/manual/es/domelement.getattributenode.php getAttributeNode]'''.

*'''[http://docs.php.net/manual/es/domelement.getelementsbytagname.php getElementsByTagName]''', tamén presente na clase ''DOMNode'', devolve unha lista de nodos (''DOMNodeList'') cos descendentes cuxo nome correspóndese co que indiquemos.

O seguinte script obtén os nomes dos actores no [[Curso_POO_PHP_e_XML#Documento_XML_de_exemplo|documento XML de exemplo]].

<source lang="php">
$xml = new DOMDocument();
$xml->preserveWhiteSpace = false;
$xml->load('exemplo.xml');

$actores = $xml->getElementsByTagName('actor');
foreach ($actores as $actor) {
$nome = $actor->getElementsByTagName('nome')->item(0);
echo $nome->nodeValue . "<br />";
}
</source>

=== Modificar o contido dun documento XML ===

Os distintos tipos de nodos da extensión DOM inclúen métodos para engadir e eliminar nodos da árbore, como '''[http://docs.php.net/manual/es/domnode.appendchild.php appendChild]''', '''[http://docs.php.net/manual/es/domnode.insertbefore.php insertBefore]''', '''[http://docs.php.net/manual/es/domnode.removechild.php removeChild]''' ou '''[http://docs.php.net/manual/es/domelement.removeattribute.php removeAttribute]'''.

Antes de engadir un nodo, deberemos crearlo no documento empregando os métodos '''[http://docs.php.net/manual/es/domdocument.createelement.php createElement]''', '''[http://docs.php.net/manual/es/domdocument.createelement.php createAttribute]''' ou semellantes, dependendo do tipo de nodo.

Por exemplo, para facer no [[Curso_POO_PHP_e_XML#Documento_XML_de_exemplo|documento de exemplo]] cambios semellantes aos que vimos coa extensión SimpleXML, faríamos:

<source lang="php">
$xml = new DOMDocument();
$xml->preserveWhiteSpace = false;
$xml->load('exemplo.xml');

$pelicula = $xml->getElementsByTagName('película')->item(0);
$titulo = $pelicula->getElementsByTagName('título')->item(0);
$titulo->nodeValue = "O Santo";

$url = $xml->createElement('url','http://www.imdb.com/name/nm0000174/');
$actor = $xml->getElementsByTagName('actor')->item(1);
$actor->appendChild($url);

$version = $xml->createAttribute('versión');
$version->value = "1.0";
$xml->documentElement->appendChild($version);
</source>

Como no caso da extensión SimpleXML, podemos pasar o documento modificado a un ficheiro (método '''[http://docs.php.net/manual/es/domdocument.save.php save]''' da clase ''DOMDocument'') ou a unha cadea de texto (método '''[http://docs.php.net/manual/es/domdocument.savexml.php saveXML]''').

=== Validación de documentos XML ===

Empregando DOM temos acceso a varios mecanismos de validacións para os documentos XML.

* Validación '''mediante DTD'''. Pódese validar o documento XML a partires do seu DTD mentres se le poñendo a ''true'' a propiedade '''[http://docs.php.net/manual/es/class.domdocument.php#domdocument.props.validateonparse validateOnParse]''' da clase ''DOMDocument'' antes de cargar o documento. Tamén é posible executar a validación unha vez cargado o documento empregando o método '''[http://docs.php.net/manual/es/domdocument.validate.php validate]'''.

* Validación '''mediante XML Schema'''. A validación mediante XML Schema pode facerse indicando o nome do ficheiro (método '''schemaValidate''') ou a cadea de texto (método '''[http://docs.php.net/manual/es/domdocument.schemavalidatesource.php schemaValidateSource]''') nos que se almacena o esquema.

* Validación '''mediante RelaxNG'''. De xeito semellante ao caso anterior, pode validarse fronte ao contido dun ficheiro (método '''[http://docs.php.net/manual/es/domdocument.relaxngvalidate.php relaxNGValidate]''') ou dunha cadea de texto (método '''[http://docs.php.net/manual/es/domdocument.relaxngvalidatesource.php relaxNGValidateSource]''').

=== Avaliación de expresións XPath ===

Na extensión DOM inclúese a clase '''[http://docs.php.net/manual/es/class.domxpath.php DOMXPath]''',
que permite avaliar expresións XPath sobre un documento XML almacenado nun obxecto ''DOMDocument''. Ao instanciar a clase débese indicar o documento XML sobre o que se van a avaliar as expresións. Os métodos '''[http://docs.php.net/manual/es/domxpath.evaluate.php evaluate]''' e '''[http://docs.php.net/manual/es/domxpath.query.php query]'''. A primeira delas intenta devolver un valor simple, e a segunda devolve sempre como resultado un conxunto de nodos (''DOMNodeList'').

Por exemplo, para obter os nomes das actrices presentes no [[Curso_POO_PHP_e_XML#Documento_XML_de_exemplo|documento de exemplo]] podemos facer:

<source lang="php">
$xml = new DOMDocument();
$xml->preserveWhiteSpace = false;
$xml->load('exemplo.xml');

$xpath = new DOMXPath($xml);
$consulta = '//videoteca/actor[sexo = "muller"]';
$actores = $xpath->query($consulta);

foreach ($actores as $actor) {
$nome = $actor->getElementsByTagName('nome')->item(0);
echo $nome->nodeValue . "<br />";
}
</source>

--[[Usuario:Vlourido|Víctor Lourido]] 12:13 24 jul 2013 (CEST)

Curso POO PHP DOM - Historial de revisiones

Vlourido: /* Avaliación de expresións XPath */