Mudanças entre as edições de "TPHXML"

 
(15 revisões intermediárias por 3 usuários não estão sendo mostradas)
Linha 1: Linha 1:
O objeto TPHXML permite a leitura de arquivo XML e a geração do XML, tornando possível a criação de XML's elaborados de acordo com a necessidade.
+
==='''Conceito'''===
 +
O objeto TPHXML foi projetado para leitura de dados de arquivos XML. Ele permite a busca de elementos dentro de um XML, e fornece recursos para consumir arquivos XML.
  
===Propriedades===
+
==='''Propriedades'''===
 
{| class="wikitable" style="width: 100%"
 
{| class="wikitable" style="width: 100%"
 
! Nome  
 
! Nome  
!Tipo
+
! Tipo
!Descrição
+
! Descrição
 
|-
 
|-
|Arquivo
+
| Texto
|String
+
| String
|Conteúdo do XML.
+
| Armazena o texto contido em um elemento XML.
 
|}
 
|}
  
===Procedimentos===
+
==='''Procedimentos'''===
*'''NewPHXML''': Função que retorna o objeto criado;
+
*'''LerXml(Xml: String):''' Carrega um XML a partir de uma string fornecida.
*'''Executar:''' Realiza a leitura do conteúdo e carrega o objeto.
+
*'''Elemento(Index: Integer):''' Retorna o elemento na posição especificada pela lista de elementos.
*'''ValorTag(Nivel: Integer; TagInicio: String; Item: String): String''': Retorna o conteúdo da tag e item.
+
*'''ElementoDoNome(Nome: String):''' Busca um elemento pelo nome no XML carregado.
*'''Free''': Libera o objeto da memória.
+
*'''LoadFromFile(Arquivo: String):''' Carrega um arquivo XML do disco e processa com o método LerXml.
*'''GetTag(const NomeTag: string): string''': Retorna o conteúdo da Tag.
+
*'''Count:''' Retorna o número de elementos presentes na lista de elementos.
*'''NovoXML(const TagPrincipal: string):''' Inicia o XML com a Tag principal passada por parâmetro.
+
*'''RetornaXML:''' Retorna o XML armazenado na classe como uma string.
*'''AddOpenTag(const ATagName: string):''' Inicia uma Tag que não há valor e há Tags dentro da Tag Informada.
 
*'''AddTag(const ATagName, ATagValue: string):''' Adiciona uma nova tag com o nome e o valor informado.
 
*'''AddCloseTag:''' Realiza o fechamento da ultima Tag aberta </>.
 
*'''GetXML:''' Retorna o XML construído em forma de texto.
 
  
===Exemplo===
+
==='''Exemplo(s)'''===
  
  // O exemplo de leitura de códigos de produtos de XML de NF-e
+
Este exemplo mostra como utilizar a propriedade '''Count''' da classe TPHXML para iterar pelos elementos '''det''' de um XML e realizar ações específicas em cada produto. Além disso, a boa prática de criar objetos separados para os diferentes segmentos do XML (como ICMS e IPI) ajuda a otimizar a execução, isolando a lógica de cada parte do XML.
  ArqXML := NewPHXML;
 
  try
 
    ArqXML.Arquivo := XMLString; // String com o conteúdo XML
 
    ArqXML.Executar;
 
    while ArqXML.ValorTag(1, 'det', '', I + 1, 'cProd') <> EmptyStr do
 
    begin
 
      V_CodProduto := ArqXML.ValorTag(1, 'det', '', I + 1, 'cProd');
 
      I := I + 1;
 
    end;
 
  finally
 
    ArqXML.Free;
 
  end;
 
  
  // O exemplo de gravação de XML
+
procedure ImportaXML;
  var XML:TPHXML;
+
var
  begin
+
  ArqXML, DETXML, DETICMSXML, DETIPIXML:TPHXML;                        
    XML := NewPHXML;
+
  I:Integer;
    try
+
  V_CodProduto, V_ICMSCST, V_IPIEnq:String                             
      XML.NovoXML('TagPrincipal');
+
begin                                                                                                      
      // Adiciona a seção de verificação
+
  ArqXML := TPHXML.Create;
      XML.AddOpenTag('CampoID');
+
  try                                                                            
      XML.AddTag('ID', 'ID');
+
    ArqXML.LerXML(ParamByName('Arquivo').AsString);
      XML.AddCloseTag;
+
         
      // Adiciona a seção de comando
+
    IniciarTransacao;                     
      XML.AddTag('Nome', 'Teste');
+
    try
      // Adiciona a seção de request
+
      for I := 0 to ArqXML.ElementoDoNome('det').Count - 1 do
      XML.AddOpenTag('SubItem');
+
      begin
        // <SubItem> ....
+
        DETXML := TPHXML.Create;
        XML.AddTag('Sequencia', '1');
+
        try
        XML.AddTag('Nome', 'Teste1');
+
          DETXML.LerXML(ArqXML.ElementoDoNome('det').Elemento(I).RetornaXML);
        // </SubItem> ....
+
           
      XML.AddCloseTag;
+
          { DET }
        
+
          V_CodProduto := DETXML.ElementoDoNome('cProd').Texto;
       Informacao(XML.GetXML);
+
                   
    finally
+
          { ICMS }                   
      XML.Free;
+
          DETICMSXML := TPHXML.Create;
    end;
+
          try
 +
            DETICMSXML.LerXML(DETXML.ElementoDoNome('ICMS').RetornaXML);
 +
 +
            V_ICMSCST := DETICMSXML.ElementoDoNome('CST').Texto;
 +
          finally
 +
            DETICMSXML.Free;
 +
          end;                       
 +
                                                       
 +
          { IPI }
 +
          DETIPIXML := TPHXML.Create;
 +
          try
 +
            DETIPIXML.LerXML(DETXML.ElementoDoNome('IPI').RetornaXML);                    
 +
             
 +
            V_IPIEnq := DETIPIXML.ElementoDoNome('cEnq').Texto;
 +
          finally
 +
            DETIPIXML.Free;
 +
          end;
 +
         
 +
          I := I + 1;
 +
 +
          ConfirmarTransacao;
 +
        finally
 +
          DETXML.Free;                                                     
 +
        end;                     
 +
      end;                
 +
    except           
 +
       CancelarTransacao;
 +
       ErroValidacao(ExceptionMessage +' Produto: '+ V_CodProduto);                                      
 +
    end;                   
 +
  finally
 +
    ArqXML.Free;                                      
 +
  end;                 
 +
end;

Edição atual tal como às 13h57min de 6 de março de 2025

Conceito

O objeto TPHXML foi projetado para leitura de dados de arquivos XML. Ele permite a busca de elementos dentro de um XML, e fornece recursos para consumir arquivos XML.

Propriedades

Nome Tipo Descrição
Texto String Armazena o texto contido em um elemento XML.

Procedimentos

  • LerXml(Xml: String): Carrega um XML a partir de uma string fornecida.
  • Elemento(Index: Integer): Retorna o elemento na posição especificada pela lista de elementos.
  • ElementoDoNome(Nome: String): Busca um elemento pelo nome no XML carregado.
  • LoadFromFile(Arquivo: String): Carrega um arquivo XML do disco e processa com o método LerXml.
  • Count: Retorna o número de elementos presentes na lista de elementos.
  • RetornaXML: Retorna o XML armazenado na classe como uma string.

Exemplo(s)

Este exemplo mostra como utilizar a propriedade Count da classe TPHXML para iterar pelos elementos det de um XML e realizar ações específicas em cada produto. Além disso, a boa prática de criar objetos separados para os diferentes segmentos do XML (como ICMS e IPI) ajuda a otimizar a execução, isolando a lógica de cada parte do XML.

procedure ImportaXML;
var
  ArqXML, DETXML, DETICMSXML, DETIPIXML:TPHXML;                         
  I:Integer; 
  V_CodProduto, V_ICMSCST, V_IPIEnq:String                              
begin                                                                                                        
  ArqXML := TPHXML.Create;
  try                                                                              
    ArqXML.LerXML(ParamByName('Arquivo').AsString);
          
    IniciarTransacao;                      
    try
      for I := 0 to ArqXML.ElementoDoNome('det').Count - 1 do
      begin
        DETXML := TPHXML.Create;
        try
          DETXML.LerXML(ArqXML.ElementoDoNome('det').Elemento(I).RetornaXML);
            
          { DET }
          V_CodProduto := DETXML.ElementoDoNome('cProd').Texto;
                   
          { ICMS }                    
          DETICMSXML := TPHXML.Create;  
          try
            DETICMSXML.LerXML(DETXML.ElementoDoNome('ICMS').RetornaXML);

            V_ICMSCST := DETICMSXML.ElementoDoNome('CST').Texto;
          finally
            DETICMSXML.Free;
          end;                        
                                                        
          { IPI }
          DETIPIXML := TPHXML.Create;
          try
           DETIPIXML.LerXML(DETXML.ElementoDoNome('IPI').RetornaXML);                      
             
           V_IPIEnq := DETIPIXML.ElementoDoNome('cEnq').Texto;
          finally
            DETIPIXML.Free;
          end;
          
          I := I + 1;

          ConfirmarTransacao;
        finally
          DETXML.Free;                                                      
        end;                      
      end;                  
    except            
     CancelarTransacao;
     ErroValidacao(ExceptionMessage +' Produto: '+ V_CodProduto);                                        
    end;                     
  finally
    ArqXML.Free;                                        
  end;                  
end;