PHP - função xmlwriter_start_comment ()

Definição e Uso

XML é uma linguagem de marcação para compartilhar os dados na web, XML é tanto para leitura humana quanto para máquina. A extensão XMLWriter possui internamente a API libxml xmlWriter e é usada para escrever / criar o conteúdo de um documento XML. Os documentos XML gerados por isso não são armazenados em cache e são apenas encaminhados.

o xmlwriter_start_comment() A função aceita um objeto da classe XMLWriter e inicia uma tag de comentário.

Sintaxe

xmlwriter_start_comment($writer);

Parâmetros

Sr. Não	Parâmetro e Descrição
1	writer(Mandatory) Este é um objeto da classe XMLWriter que representa o documento XML que você deseja modificar / criar.

Valores Retornados

Esta função retorna um valor booleano que é TRUE em caso de sucesso e FALSE em caso de falha.

Versão PHP

Esta função foi introduzida pela primeira vez no PHP Versão 5 e funciona em todas as versões posteriores.

Exemplo

O exemplo a seguir demonstra o uso do xmlwriter_start_comment() função -

<?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');
    
   //Starting the comment 
   xmlwriter_start_comment($writer); 
     
   //Setting value to the comment
   xmlwriter_text($writer, 'This is a sample comment'); 
     
   //Ending the comment 
   xmlwriter_end_comment($writer); 

   //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);
?>

Isso irá gerar o seguinte documento XML -

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

Exemplo

A seguir está o exemplo desta função no estilo orientado a objetos -

<?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');

   //Starting the comment 
   $writer->startComment(); 
     
   //Setting value to the comment
   $writer->text('This is a sample comment'); 
     
   //Ending the comment 
   $writer->endComment(); 

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

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

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

Isso irá gerar o seguinte documento XML -

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

↰ Previous page