PHP - Funzione xmlwriter_write_comment ()

Definizione e utilizzo

XML è un linguaggio di markup per condividere i dati sul Web, XML è sia leggibile dall'uomo che dalla macchina. L'estensione XMLWriter ha internamente l'API libxml xmlWriter e viene utilizzata per scrivere / creare il contenuto di un documento XML. I documenti XML generati da questo non sono memorizzati nella cache e sono solo forward.

Il xmlwriter_write_comment() la funzione accetta un oggetto della classe XMLWriter e un valore stringa che rappresenta il contenuto di un commento e crea un tag di commento completo.

Sintassi

xmlwriter_start_comment($writer);

Parametri

Suor n	Parametro e descrizione
1	writer(Mandatory) Questo è un oggetto della classe XMLWriter che rappresenta il documento XML che si desidera modificare / creare.
2	comment(Mandatory) Questo è un valore stringa che rappresenta il contenuto di un commento.

Valori restituiti

Questa funzione restituisce un valore booleano che è TRUE in caso di successo e FALSE in caso di fallimento.

Versione PHP

Questa funzione è stata introdotta per la prima volta nella versione 5 di PHP e funziona in tutte le versioni successive.

Esempio

L'esempio seguente mostra l'utilizzo di xmlwriter_write_comment() funzione -

<?php
   //Creating an XMLWriter
   $writer = new XMLWriter();

   //Opening a writer
   $uri = "result.xml";
   $writer = xmlwriter_open_uri($uri);

   //Starting the document
   xmlwriter_start_document($writer);

   //Starting an element
   xmlwriter_start_element($writer, 'Msg');
    
   //Creating a comment tag
   xmlwriter_write_comment($writer, 'This is a sample comment' );

   //Adding text to the element
   xmlwriter_text($writer, 'Welcome to Tutorialspoint');  

   //Starting an element
   xmlwriter_end_element($writer);

   //Ending the document
   xmlwriter_end_document($writer);
?>

Questo genererà il seguente documento XML:

<?xml version="1.0"?>
<Msg><!--This is a sample comment-->Welcome to Tutorialspoint</Msg>

Esempio

Di seguito è riportato l'esempio di questa funzione in stile orientato agli oggetti:

<?php
   //Creating an XMLWriter
   $writer = new XMLWriter();

   //Opening a writer
   $uri = "result.xml";
   $writer->openUri($uri);

   //Starting the document
   $writer->startDocument();

   //Starting an element
   $writer->startElement('Msg');

   //Creating the comment tag 
   $writer->writeComment('This is a sample comment'); 

   //Adding text to the element
   $writer->text('Welcome to Tutorialspoint');  

   //Ending the element
   $writer->endElement();

   //Ending the document
   $writer->endDocument();
?>

Questo genererà il seguente documento XML:

<?xml version="1.0"?>
<Msg><!--This is a sample comment-->Welcome to Tutorialspoint</Msg>