Vlourido: /* XMLWriter */

2013-07-25T22:58:31Z

XMLWriter

Página nueva

== XMLReader e XMLWriter ==

As extensións '''[http://docs.php.net/manual/es/book.xmlreader.php XMLReader]''' e '''[http://docs.php.net/manual/es/book.xmlwriter.php XMLWriter]''' veñen habilitadas por defecto dende a versión 5.1.2 de PHP. Permiten traballar con documentos XML empregando fluxos do mesmo xeito que se fai cos ficheiros.

=== XMLReader ===

Empregando XMLReader podemos validar un documento a medida que se vai procesando, e detener as tarefas de procesamento en calquera momento.

Para '''abrir un documento XML''', primeiro debemos crear unha instancia da '''[http://docs.php.net/manual/es/class.xmlreader.php clase XMLReader]''', e empregar un dos seguintes métodos:

* '''[http://docs.php.net/manual/es/xmlreader.open.php open]'''. Abre un documento a partir dun URI.

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

* '''[http://docs.php.net/manual/es/xmlreader.xml.php XML]'''. Abre un documento XML almacenado nunha cadea de texto.

<div style="margin-left: 2em;">
<source lang="php">
$xml = new XMLReader();
$xml->XML($texto);
</source>
</div>

O seguinte paso é, cando sexa preciso, utilizar o método '''[http://docs.php.net/manual/es/xmlreader.setparserproperty.php setParserProperty]''' para '''establecer as [http://docs.php.net/manual/es/class.xmlreader.php#xmlreader.constants.options opcións do procesador]'''. Unha das máis empregadas é '''XMLReader::VALIDATE''', que habilita a validación mediante DTD.

<source lang="php">
$xml->setParserProperty(XMLReader::VALIDATE, true);
</source>

A continuación o procedemento habitual '''crear un bucle''' que vaia chamando ao método '''[http://docs.php.net/manual/es/xmlreader.read.php read]''' para avanzar ao seguinte nodo, comprobando os tipos dos nodos coa propiedade '''[http://docs.php.net/manual/es/class.xmlreader.php#xmlreader.props.nodetype nodeType]''' ou os seus contidos con '''[http://docs.php.net/manual/es/class.xmlreader.php#xmlreader.props.value value]'''. Cando se chega ao final do documento o método ''read'' devolve ''false''. O método '''[http://docs.php.net/manual/es/xmlreader.close.php close]''' pecha o documento XML orixe.

<source lang="php">
while ($xml->read()) {
if ($reader->nodeType == XMLREADER::ELEMENT) print $reader->localName . "<br />";
}
</source>

Algunhas das [http://docs.php.net/manual/es/class.xmlreader.php#xmlreader.constants constantes que se definen na clase XMLReader] para os tipos de nodos son:

* ''XMLReader::ELEMENT''. Comenzo dun elemento.
* ''XMLReader::END_ELEMENT''. Final dun elemento.
* ''XMLReader::TEXT''. Texto.
* ''XMLReader::PI''. Instrucción de procesamento.
* ''XMLReader::COMMENT''. Comentario.

Por exemplo, para obter a mesma táboa HTML da película que obtivemos con XMLParse, a partires da que figura no documento de exemplo, pódese facer:

<source lang="php">
$xml = new XMLReader();
$xml->open('exemplo.xml');

while ($xml->read()) {
switch($xml->nodeType) {
case XMLREADER::ELEMENT:
$nome_nodo = $xml->localName;
switch ($nome_nodo) {
case 'película' :
echo '<table>';
break;
case "título":
echo '<tr> <th colspan="2">';
break;
case "títuloorixinal":
echo ' (';
break;
case "director":
case "xénero":
case "duración":
echo '<tr><td>' . $nome_nodo . '</td><td>';
}
break;
case XMLReader::END_ELEMENT:
switch($xml->localName) {
case "película":
echo '</table>';
break;
case "títuloorixinal":
echo ')</th></tr>';
break;
case "director":
echo '</td></tr>';
}
$nome_nodo = "";
break;
case XMLReader::TEXT:
switch($nome_nodo) {
case "película":
case "título":
case "títuloorixinal":
case "director":
case "xénero":
case "duración":
echo $xml->value;
}
}
}

$xml->close();
</source>

Unha forma sinxela de percorrer os atributos dun elemento é empregando a propiedade '''[http://docs.php.net/manual/es/class.xmlreader.php#xmlreader.props.hasattributes hasAttributes]''', que indica se o elemento ten ou non atributos, e o método '''[http://docs.php.net/manual/es/xmlreader.movetonextattribute.php moveToNextAttribute]''' para movernos de un en un.

<source lang="php">
...
case XMLREADER::ELEMENT:
if($xml->hasAttributes)
while($xml->moveToNextAttribute())
echo 'Atributo ' . $xml->localName . ', valor = "' . $xml->value . '" <br />';
...
</source>

==== Validación ====

XMLReader pode validar o documento conforme o vai lendo. Admite tres tipos de validación.

* Mediante '''DTD'''. Para activar a validación por DTD, débense establecer as seguintes opcións:

<div style="margin-left: 2em;">
<source lang="php">
$xml->setParserProperty(XMLReader::LOADDTD, TRUE);
$xml->setParserProperty(XMLReader::VALIDATE, TRUE);
</source>
</div>

* Mediante '''XML Schema'''. Neste caso será necesario empregar o método '''[http://docs.php.net/manual/es/xmlreader.setschema.php setSchema]''' `para indicar a ubicación do documento de validación.

<div style="margin-left: 2em;">
<source lang="php">
$xml->setSchema('esquema.xsd');
</source>
</div>

* Mediante '''Relax NG'''. Temos dúas posibilidades: indicar o arquivo de validación con '''[http://docs.php.net/manual/es/xmlreader.setrelaxngschema.php setRelaxNGSchema]''' ou unha cadea de texto co seu contido con '''[http://docs.php.net/manual/es/xmlreader.setrelaxngschemasource.php setRelaxNGSchemaSource]'''.

<div style="margin-left: 2em;">
<source lang="php">
$xml->setRelaxNGSchemaSource('esquema.rng');
</source>
</div>

En calquera dos casos anteriores, o método '''[http://docs.php.net/manual/es/xmlreader.isvalid.php isValid]''' devolverá ''true'' se o que se leva lido do documento é valido ou ''false'' en caso contrario.

<source lang="php">
$xml = new XMLReader();
$xml->open('exemplo.xml');
$xml->setSchema('esquema.xsd');

while ($xml->read()) {
...
}
if(!$xml->is_valid()) exit('Erro de validación do documento XML!');
</source>

=== XMLWriter ===

XMLWriter é a contrapartida de XMLReader. Aporta unha forma sinxela de crear documentos XML ben formados. O seu funcionamento é semellante ao de XMLReader.

Para '''crear un documento XML''', primeiro debemos crear unha instancia da '''clase XMLWriter''', e empregar un dos seguintes métodos:

* '''[http://docs.php.net/manual/es/function.xmlwriter-open-uri.php openURI]'''. Almacena o documento XML nun URI.

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

* '''[http://docs.php.net/manual/es/function.xmlwriter-open-memory.php openMemory]'''. Almacena o documento XML en memoria.

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

:Neste caso empregando o método '''[http://docs.php.net/manual/es/function.xmlwriter-output-memory.php outputMemory]''' obteremos o documento XML que levamos escrito en memoria.

Posteriormente para '''crear o contido do documento''', deberemos empregar chamadas aos distintos métodos ''start...'', ''end...'' ou ''write...''.

* Para '''crear un novo elemento''', podemos emprear o método '''[http://docs.php.net/manual/es/function.xmlwriter-write-element.php writeElement]''' indicando o seu nome e o seu contido

<div style="margin-left: 2em;">
<source lang="php">
$xml->writeElement('xénero', 'Acción');
</source>
</div>

: Ou chamar primeiro a '''[http://docs.php.net/manual/es/function.xmlwriter-start-element.php startElement]''' indicando o seu nome, e despois a '''[http://docs.php.net/manual/es/function.xmlwriter-end-element.php endElement]'''. Deste xeito entre as dúas chamadas poderemos crear atributos para o elemento con '''[http://docs.php.net/manual/es/function.xmlwriter-start-attribute.php startAttribute]''' e '''[http://docs.php.net/manual/es/function.xmlwriter-end-attribute.php endAttribute]''' ou directamente con '''[http://docs.php.net/manual/es/function.xmlwriter-write-attribute.php writeAttribute]'''.

<div style="margin-left: 2em;">
<source lang="php">
$xml->startElement('importe');
$xml->writeAttribute('moneda', 'dólar');
$xml->endElement();
</source>
</div>

* Do mesmo xeito tamén é posible '''crear comentarios''' ('''[http://docs.php.net/manual/es/function.xmlwriter-start-comment.php startComment]''' con '''[http://docs.php.net/manual/es/function.xmlwriter-end-comment.php endComment]''', ou '''[http://docs.php.net/manual/es/function.xmlwriter-write-comment.php writeComment]'''), '''instruccións de procesamento''' ('''[http://docs.php.net/manual/es/function.xmlwriter-start-pi.php startPI]''' con '''[http://docs.php.net/manual/es/function.xmlwriter-end-pi.php endPI]''', ou '''[http://docs.php.net/manual/es/function.xmlwriter-write-pi.php writePI]'''), etc.

* Para '''crear texto''' chamaremos ao método '''[http://docs.php.net/manual/es/function.xmlwriter-text.php text]''' indicando o seu contido

<div style="margin-left: 2em;">
<source lang="php">
$xml->startElement('importe');
$xml->writeAttribute('moneda', 'dólar');
$xml->text('13.56');
$xml->endElement();
</source>
</div>

* Para '''crear a declaración XML''' emprégase o método '''[http://docs.php.net/manual/es/function.xmlwriter-start-document.php startDocument]''', indicando opcionalmente a versión da linguaxe e o sistema de codificación empregado. Do mesmo xeito, cando remata o noso documento deberemos indicarlo chamando ao método '''[http://docs.php.net/manual/es/function.xmlwriter-end-document.php endDocument]'''.

<div style="margin-left: 2em;">
<source lang="php">
$xml = new XMLWriter();
$xml->openURI('exemplo.xml');
$xml->startDocument('1.0', 'UTF-8');
...
$xml->endDocument();
</source>
</div>

* O método '''[http://docs.php.net/manual/es/function.xmlwriter-flush.php flush]''' volca os búferes no disco. Debe chamarse para finalizar as labores de escritura. No caso de gardar o documento XML en memoria, devolve o seu contido.

Por exemplo, o seguinte código crea un documento XML semellante ao documento de exemplo (sen os elementos "<actor>").

<source lang="php">
$xml = new XMLWriter();
$xml->openURI('exemplo.xml');
$xml->setIndent(true);

$xml->startDocument('1.0', 'UTF-8');
$xml->startElement('videoteca');
$xml->writeAttribute('data_creación', '24/02/2009');
$xml->startElement('película');
$xml->writeAttribute('id', '1');
$xml->startElement('importe');
$xml->writeAttribute('moneda', 'dólar');
$xml->text('13.56');
$xml->endElement();
$xml->writeElement('título', 'El Santo');
$xml->writeElement('títuloorixinal', 'The Saint');
$xml->writeElement('ano', '1997');
$xml->writeElement('director', 'Phillip Noyce');
$xml->writeElement('xénero', 'Acción');
$xml->writeElement('duración', '111');
$xml->writeComment(' Elisabeth Shue ');
$xml->startElement('actúa');
$xml->writeAttribute('id', '51');
$xml->endElement();
$xml->writeComment(' Val Kilmer ');
$xml->startElement('actúa');
$xml->writeAttribute('id', '156');
$xml->endElement();
$xml->endElement(); // Remata o elemento "película"
$xml->endElement(); // Remata o elemento "videoteca"
$xml->endDocument();

$xml->flush();
</source>

O método '''[http://docs.php.net/manual/es/function.xmlwriter-set-indent.php setIndent]''' habilita ou inhabilita a indentación, mellorando a lexibilidade do documento resultante.

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

Curso POO PHP XMLReader e XMLWriter - Historial de revisiones

Vlourido: /* XMLWriter */