PHP Класс NFePHP\Extras\Danfe

Наследование: extends NFePHP\Extras\CommonNFePHP, implements NFePHP\Extras\DocumentoNFePHP
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$descProdInfoComplemento boolean Parâmetro do controle se deve concatenar automaticamente informações complementares na descrição do produto, como por exemplo, informações sobre impostos.
$descProdQuebraLinha boolean Parâmetro do controle se deve gerar quebras de linha com "\n" a partir de ";" na descrição do produto.
$exibirIcmsInterestadual boolean Parâmetro para exibir ou ocultar os valores do ICMS Interestadual e Valor Total dos Impostos.
$exibirPIS boolean Parâmetro para exibir ou ocultar os valores do PIS/COFINS.
$exibirTextoFatura boolean Parâmetro para exibir ou ocultar o texto adicional sobre a forma de pagamento e as informações de fatura/duplicata.
$exibirValorTributos boolean Parâmetro para exibir ou ocultar o texto sobre valor aproximado dos tributos.
$logoAlign string alinhamento padrão do logo (C-Center)
$numero_registro_dpec string Numero DPEC
$qCanhoto integer quantidade de canhotos a serem montados, geralmente 1 ou 2
$situacaoExterna integer Situação
$yDados float Posição

Защищенные свойства (Protected)

Свойство Тип Описание
$ICMSTot DOMNode Node
$ISSQNtot DOMNode Node
$cobr DOMNode Node
$compra DOMNode Node compra
$debugMode integer ativa ou desativa o modo de debug
$dest DOMNode Node
$destino string destino do arquivo pdf I-borwser, S-retorna o arquivo, D-força download, F-salva em arquivo local
$det DOMNode Node
$dom DOMDocument Document
$dup DOMNode Node
$emit DOMNode Node
$enderDest DOMNode Node
$enderEmit DOMNode Node
$entrega DOMNode Node
$errMsg string mesagens de erro
$errStatus boolean status de erro true um erro ocorreu false sem erros
$fontePadrao string Nome da Fonte para gerar o DANFE
$formatoChave string Formato chave
$hPrint float Comprimento (altura) imprimivel, em milímetros
$ide DOMNode Node
$infAdic DOMNode Node infAdic
$infNFe DOMNode Node
$infProt DOMNode Node infProt
$logomarca string path para logomarca em jpg
$orientacao string orientação da DANFE P-Retrato ou L-Paisagem
$papel string formato do papel
$pdf object objeto fpdf()
$pdfDir string diretorio para salvar o pdf com a opção de destino = F
$qtdeItensProc integer quantidade de itens já processados na montagem do DANFE
$reboque DOMNode Node reboque
$retirada DOMNode Node
$textoAdic string Texto
$tpEmis integer Tipo de emissão
$tpImp integer 1-Retrato/ 2-Paisagem
$transp DOMNode Node
$transporta DOMNode Node
$veicTransp DOMNode Node
$version string versão
$wAdic float Largura
$wCanhoto float largura do canhoto (25mm) apenas para a formatação paisagem
$wPrint float largura imprimivel, em milímetros
$xml string XML NFe

Открытые методы

Метод Описание
__construct ( string $docXML = '', string $sOrientacao = '', string $sPapel = '', string $sPathLogo = '', string $sDestino = 'I', string $sDirPDF = '', string $fonteDANFE = '', integer $mododebug = 2 ) __construct
monta ( string $orientacao = '', string $papel = 'A4', string $logoAlign = 'C', $situacaoExterna = NFEPHP_SITUACAO_EXTERNA_NONE, $classPdf = false, $dpecNumReg = '', $margSup = 2, $margEsq = 2, $margInf = 2 ) : string monta
montaDANFE ( string $orientacao = '', string $papel = 'A4', $logoAlign = 'C', $situacaoExterna = NFEPHP_SITUACAO_EXTERNA_NONE, $classPdf = false, $depecNumReg = '', $margSup = 2, $margEsq = 2, $margInf = 2 ) : string montaDANFE Monta a DANFE conforme as informações fornecidas para a classe durante sua construção. Constroi DANFEs com até 3 páginas podendo conter até 56 itens.
printDANFE ( string $nome = '', string $destino = 'I', string $printer = '' ) : string printDANFE Esta função envia a DANFE em PDF criada para o dispositivo informado.
printDocument ( string $nome = '', string $destino = 'I', string $printer = '' ) : object printDocument
simpleConsistencyCheck ( ) : boolean simpleConsistencyCheck

Защищенные методы

Метод Описание
pCabecalhoDANFE ( number $x, number $y, number $pag = '1', number $totPag = '1' ) : number cabecalhoDANFE Monta o cabelhalho da DANFE (retrato e paisagem)
pCanhoto ( number $x, number $y ) : number pCcanhotoDANFE Monta o canhoto da DANFE (retrato e paisagem)
pDadosAdicionaisDANFE ( float $x, float $y, float $h ) : float dadosAdicionaisDANFE Coloca o grupo de dados adicionais da NFe. (retrato e paisagem)
pDescricaoProduto ( $itemProd ) : string descricaoProduto Monta a string de descrição de cada Produto
pDescricaoProdutoHelper ( $origem, $campo, $formato ) fim transporteDANFE
pDestinatarioDANFE ( number $x, number $y ) : number destinatarioDANFE Monta o campo com os dados do destinatário na DANFE. (retrato e paisagem)
pFaturaDANFE ( number $x, number $y ) : number faturaDANFE Monta o campo de duplicatas da DANFE (retrato e paisagem)
pGeraChaveAdicionalDeContingencia ( ) : string pGeraChaveAdicionalDeContingencia
pGeraInformacoesDaTagCompra ( ) : string pGeraInformacoesDaTagCompra Devolve uma string contendo informação sobre as tag , e ou string vazia.
pGeraInformacoesDasNotasReferenciadas ( ) : string pGeraInformacoesDasNotasReferenciadas Devolve uma string contendo informação sobre as notas referenciadas. Suporta N notas, eletrônicas ou não Exemplo: NFe Ref.: série: 01 número: 01 emit: 11.111.111/0001-01 em 10/2010 [0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000]
pGetTextoFatura ( ) : a pGetTextoFatura Gera a String do Texto da Fatura
pImpostoDANFE ( number $x, number $y ) : number impostoDANFE Monta o campo de impostos e totais da DANFE (retrato e paisagem)
pImpostoDanfeHelper ( float $x, float $y, float $w, float $h, $titulo, $campoImposto ) : float impostoDanfeHelper Auxilia a montagem dos campos de impostos e totais da DANFE
pIssqnDANFE ( float $x, float $y ) : float issqnDANFE Monta o campo de serviços do DANFE
pItensDANFE ( float $x, float $y, float &$nInicio, float $hmax, $pag, $totpag, $hCabecItens = 7 ) : float itensDANFE Monta o campo de itens da DANFE (retrato e paisagem)
pNotaCancelada ( ) fim função printDANFE
pNotaDPEC ( )
pNotaDenegada ( )
pRodape ( $x, $y ) : void pRodape Monta o rodapé no final da DANFE com a data/hora de impressão e informações sobre a API NfePHP
pSizeExtraTextoFatura ( ) : integer pSizeExtraTextoFatura Calcula o espaço ocupado pelo texto da fatura. Este espaço só é utilizado quando não houver duplicata.
pTransporteDANFE ( float $x, float $y ) : float transporteDANFE Monta o campo de transportes da DANFE (retrato e paisagem)

Приватные методы

Метод Описание
pAnfavea ( string $cdata = '' ) : string anfavea Função para transformar o campo cdata do padrão ANFAVEA para texto imprimível

Описание методов

__construct() публичный Метод

__construct
public __construct ( string $docXML = '', string $sOrientacao = '', string $sPapel = '', string $sPathLogo = '', string $sDestino = 'I', string $sDirPDF = '', string $fonteDANFE = '', integer $mododebug = 2 )
$docXML string Conteúdo XML da NF-e (com ou sem a tag nfeProc)
$sOrientacao string (Opcional) Orientação da impressão P-retrato L-Paisagem
$sPapel string Tamanho do papel (Ex. A4)
$sPathLogo string Caminho para o arquivo do logo
$sDestino string Estabelece a direção do envio do documento PDF I-browser D-browser com download S-
$sDirPDF string Caminho para o diretorio de armazenamento dos arquivos PDF
$fonteDANFE string Nome da fonte alternativa do DAnfe
$mododebug integer 0-Não 1-Sim e 2-nada (2 default)

monta() публичный Метод

monta
public monta ( string $orientacao = '', string $papel = 'A4', string $logoAlign = 'C', $situacaoExterna = NFEPHP_SITUACAO_EXTERNA_NONE, $classPdf = false, $dpecNumReg = '', $margSup = 2, $margEsq = 2, $margInf = 2 ) : string
$orientacao string
$papel string
$logoAlign string
Результат string

montaDANFE() публичный Метод

A definição de margens e posições iniciais para a impressão são estabelecidas pelo conteúdo da funçao e podem ser modificados.
public montaDANFE ( string $orientacao = '', string $papel = 'A4', $logoAlign = 'C', $situacaoExterna = NFEPHP_SITUACAO_EXTERNA_NONE, $classPdf = false, $depecNumReg = '', $margSup = 2, $margEsq = 2, $margInf = 2 ) : string
$orientacao string (Opcional) Estabelece a orientação da impressão (ex. P-retrato), se nada for fornecido será usado o padrão da NFe
$papel string (Opcional) Estabelece o tamanho do papel (ex. A4)
Результат string O ID da NFe numero de 44 digitos extraido do arquivo XML

pCabecalhoDANFE() защищенный Метод

cabecalhoDANFE Monta o cabelhalho da DANFE (retrato e paisagem)
protected pCabecalhoDANFE ( number $x, number $y, number $pag = '1', number $totPag = '1' ) : number
$x number Posição horizontal inicial, canto esquerdo
$y number Posição vertical inicial, canto superior
$pag number Número da Página
$totPag number Total de páginas
Результат number Posição vertical final

pCanhoto() защищенный Метод

pCcanhotoDANFE Monta o canhoto da DANFE (retrato e paisagem)
protected pCanhoto ( number $x, number $y ) : number
$x number Posição horizontal canto esquerdo
$y number Posição vertical canto superior
Результат number Posição vertical final TODO 21/07/14 fmertins: quando orientação L-paisagem, o canhoto está sendo gerado incorretamente

pDadosAdicionaisDANFE() защищенный Метод

dadosAdicionaisDANFE Coloca o grupo de dados adicionais da NFe. (retrato e paisagem)
protected pDadosAdicionaisDANFE ( float $x, float $y, float $h ) : float
$x float Posição horizontal canto esquerdo
$y float Posição vertical canto superior
$h float altura do campo
Результат float Posição vertical final (eixo Y)

pDescricaoProduto() защищенный Метод

descricaoProduto Monta a string de descrição de cada Produto
protected pDescricaoProduto ( $itemProd ) : string
Результат string descricao do produto

pDescricaoProdutoHelper() защищенный Метод

fim transporteDANFE
protected pDescricaoProdutoHelper ( $origem, $campo, $formato )

pDestinatarioDANFE() защищенный Метод

destinatarioDANFE Monta o campo com os dados do destinatário na DANFE. (retrato e paisagem)
protected pDestinatarioDANFE ( number $x, number $y ) : number
$x number Posição horizontal canto esquerdo
$y number Posição vertical canto superior
Результат number Posição vertical final

pFaturaDANFE() защищенный Метод

faturaDANFE Monta o campo de duplicatas da DANFE (retrato e paisagem)
protected pFaturaDANFE ( number $x, number $y ) : number
$x number Posição horizontal canto esquerdo
$y number Posição vertical canto superior
Результат number Posição vertical final

pGeraChaveAdicionalDeContingencia() защищенный Метод

pGeraChaveAdicionalDeContingencia
protected pGeraChaveAdicionalDeContingencia ( ) : string
Результат string chave

pGeraInformacoesDaTagCompra() защищенный Метод

Aviso: Esta função não leva em consideração dados na tag xPed do item.
protected pGeraInformacoesDaTagCompra ( ) : string
Результат string com as informacoes dos pedidos.

pGeraInformacoesDasNotasReferenciadas() защищенный Метод

pGeraInformacoesDasNotasReferenciadas Devolve uma string contendo informação sobre as notas referenciadas. Suporta N notas, eletrônicas ou não Exemplo: NFe Ref.: série: 01 número: 01 emit: 11.111.111/0001-01 em 10/2010 [0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000]
protected pGeraInformacoesDasNotasReferenciadas ( ) : string
Результат string Informacoes a serem adicionadas no rodapé sobre notas referenciadas.

pGetTextoFatura() защищенный Метод

pGetTextoFatura Gera a String do Texto da Fatura
protected pGetTextoFatura ( ) : a
Результат a String com o texto ou "";

pImpostoDANFE() защищенный Метод

impostoDANFE Monta o campo de impostos e totais da DANFE (retrato e paisagem)
protected pImpostoDANFE ( number $x, number $y ) : number
$x number Posição horizontal canto esquerdo
$y number Posição vertical canto superior
Результат number Posição vertical final

pImpostoDanfeHelper() защищенный Метод

impostoDanfeHelper Auxilia a montagem dos campos de impostos e totais da DANFE
protected pImpostoDanfeHelper ( float $x, float $y, float $w, float $h, $titulo, $campoImposto ) : float
$x float Posição horizontal canto esquerdo
$y float Posição vertical canto superior
$w float Largura do campo
$h float Altura do campo
Результат float Sugestão do $x do próximo imposto

pIssqnDANFE() защищенный Метод

issqnDANFE Monta o campo de serviços do DANFE
protected pIssqnDANFE ( float $x, float $y ) : float
$x float Posição horizontal canto esquerdo
$y float Posição vertical canto superior
Результат float Posição vertical final

pItensDANFE() защищенный Метод

itensDANFE Monta o campo de itens da DANFE (retrato e paisagem)
protected pItensDANFE ( float $x, float $y, float &$nInicio, float $hmax, $pag, $totpag, $hCabecItens = 7 ) : float
$x float Posição horizontal canto esquerdo
$y float Posição vertical canto superior
$nInicio float Número do item inicial
$hmax float Altura máxima do campo de itens em mm
Результат float Posição vertical final

pNotaCancelada() защищенный Метод

fim função printDANFE
protected pNotaCancelada ( )

pNotaDPEC() защищенный Метод

protected pNotaDPEC ( )

pNotaDenegada() защищенный Метод

protected pNotaDenegada ( )

pRodape() защищенный Метод

pRodape Monta o rodapé no final da DANFE com a data/hora de impressão e informações sobre a API NfePHP
protected pRodape ( $x, $y ) : void
Результат void

pSizeExtraTextoFatura() защищенный Метод

pSizeExtraTextoFatura Calcula o espaço ocupado pelo texto da fatura. Este espaço só é utilizado quando não houver duplicata.
protected pSizeExtraTextoFatura ( ) : integer
Результат integer

pTransporteDANFE() защищенный Метод

transporteDANFE Monta o campo de transportes da DANFE (retrato e paisagem)
protected pTransporteDANFE ( float $x, float $y ) : float
$x float Posição horizontal canto esquerdo
$y float Posição vertical canto superior
Результат float Posição vertical final

printDANFE() публичный Метод

O destino da impressão pode ser : I-browser D-browser com download F-salva em um arquivo local com o nome informado S-retorna o documento como uma string e o nome é ignorado. Para enviar o pdf diretamente para uma impressora indique o nome da impressora e o destino deve ser 'S'.
public printDANFE ( string $nome = '', string $destino = 'I', string $printer = '' ) : string
$nome string Path completo com o nome do arquivo pdf
$destino string Direção do envio do PDF
$printer string Identificação da impressora no sistema
Результат string Caso o destino seja S o pdf é retornado como uma string

printDocument() публичный Метод

printDocument
public printDocument ( string $nome = '', string $destino = 'I', string $printer = '' ) : object
$nome string
$destino string
$printer string
Результат object pdf

simpleConsistencyCheck() публичный Метод

simpleConsistencyCheck
public simpleConsistencyCheck ( ) : boolean
Результат boolean Retorna se o documento se parece com um DANFE (condicao necessaria porem nao suficiente)

Описание свойств

$ICMSTot защищенное свойство

Node
protected DOMNode $ICMSTot
Результат DOMNode

$ISSQNtot защищенное свойство

Node
protected DOMNode $ISSQNtot
Результат DOMNode

$cobr защищенное свойство

Node
protected DOMNode $cobr
Результат DOMNode

$compra защищенное свойство

Node compra
protected DOMNode $compra
Результат DOMNode

$debugMode защищенное свойство

ativa ou desativa o modo de debug
protected int $debugMode
Результат integer

$descProdInfoComplemento публичное свойство

Parâmetro do controle se deve concatenar automaticamente informações complementares na descrição do produto, como por exemplo, informações sobre impostos.
public bool $descProdInfoComplemento
Результат boolean

$descProdQuebraLinha публичное свойство

Parâmetro do controle se deve gerar quebras de linha com "\n" a partir de ";" na descrição do produto.
public bool $descProdQuebraLinha
Результат boolean

$dest защищенное свойство

Node
protected DOMNode $dest
Результат DOMNode

$destino защищенное свойство

destino do arquivo pdf I-borwser, S-retorna o arquivo, D-força download, F-salva em arquivo local
protected string $destino
Результат string

$det защищенное свойство

Node
protected DOMNode $det
Результат DOMNode

$dom защищенное свойство

Document
protected DOMDocument $dom
Результат DOMDocument

$dup защищенное свойство

Node
protected DOMNode $dup
Результат DOMNode

$emit защищенное свойство

Node
protected DOMNode $emit
Результат DOMNode

$enderDest защищенное свойство

Node
protected DOMNode $enderDest
Результат DOMNode

$enderEmit защищенное свойство

Node
protected DOMNode $enderEmit
Результат DOMNode

$entrega защищенное свойство

Node
protected DOMNode $entrega
Результат DOMNode

$errMsg защищенное свойство

mesagens de erro
protected string $errMsg
Результат string

$errStatus защищенное свойство

status de erro true um erro ocorreu false sem erros
protected bool $errStatus
Результат boolean

$exibirIcmsInterestadual публичное свойство

Parâmetro para exibir ou ocultar os valores do ICMS Interestadual e Valor Total dos Impostos.
public bool $exibirIcmsInterestadual
Результат boolean

$exibirPIS публичное свойство

Parâmetro para exibir ou ocultar os valores do PIS/COFINS.
public bool $exibirPIS
Результат boolean

$exibirTextoFatura публичное свойство

Parâmetro para exibir ou ocultar o texto adicional sobre a forma de pagamento e as informações de fatura/duplicata.
public bool $exibirTextoFatura
Результат boolean

$exibirValorTributos публичное свойство

Parâmetro para exibir ou ocultar o texto sobre valor aproximado dos tributos.
public bool $exibirValorTributos
Результат boolean

$fontePadrao защищенное свойство

Nome da Fonte para gerar o DANFE
protected string $fontePadrao
Результат string

$formatoChave защищенное свойство

Formato chave
protected string $formatoChave
Результат string

$hPrint защищенное свойство

Comprimento (altura) imprimivel, em milímetros
protected float $hPrint
Результат float

$ide защищенное свойство

Node
protected DOMNode $ide
Результат DOMNode

$infAdic защищенное свойство

Node infAdic
protected DOMNode $infAdic
Результат DOMNode

$infNFe защищенное свойство

Node
protected DOMNode $infNFe
Результат DOMNode

$infProt защищенное свойство

Node infProt
protected DOMNode $infProt
Результат DOMNode

$logoAlign публичное свойство

alinhamento padrão do logo (C-Center)
public string $logoAlign
Результат string

$logomarca защищенное свойство

path para logomarca em jpg
protected string $logomarca
Результат string

$numero_registro_dpec публичное свойство

Numero DPEC
public string $numero_registro_dpec
Результат string

$orientacao защищенное свойство

orientação da DANFE P-Retrato ou L-Paisagem
protected string $orientacao
Результат string

$papel защищенное свойство

formato do papel
protected string $papel
Результат string

$pdf защищенное свойство

objeto fpdf()
protected object $pdf
Результат object

$pdfDir защищенное свойство

diretorio para salvar o pdf com a opção de destino = F
protected string $pdfDir
Результат string

$qCanhoto публичное свойство

quantidade de canhotos a serem montados, geralmente 1 ou 2
public int $qCanhoto
Результат integer

$qtdeItensProc защищенное свойство

quantidade de itens já processados na montagem do DANFE
protected int $qtdeItensProc
Результат integer

$reboque защищенное свойство

Node reboque
protected DOMNode $reboque
Результат DOMNode

$retirada защищенное свойство

Node
protected DOMNode $retirada
Результат DOMNode

$situacaoExterna публичное свойство

Situação
public int $situacaoExterna
Результат integer

$textoAdic защищенное свойство

Texto
protected string $textoAdic
Результат string

$tpEmis защищенное свойство

Tipo de emissão
protected int $tpEmis
Результат integer

$tpImp защищенное свойство

1-Retrato/ 2-Paisagem
protected int $tpImp
Результат integer

$transp защищенное свойство

Node
protected DOMNode $transp
Результат DOMNode

$transporta защищенное свойство

Node
protected DOMNode $transporta
Результат DOMNode

$veicTransp защищенное свойство

Node
protected DOMNode $veicTransp
Результат DOMNode

$version защищенное свойство

versão
protected string $version
Результат string

$wAdic защищенное свойство

Largura
protected float $wAdic
Результат float

$wCanhoto защищенное свойство

largura do canhoto (25mm) apenas para a formatação paisagem
protected float $wCanhoto
Результат float

$wPrint защищенное свойство

largura imprimivel, em milímetros
protected float $wPrint
Результат float

$xml защищенное свойство

XML NFe
protected string $xml
Результат string

$yDados публичное свойство

Posição
public float $yDados
Результат float