Documentation

Rules
in package

AbstractYes

Classe abstrata que utiliza o padrão de projeto Template Method para setar as regras de leitura do retorno da SEFAZ

Tags
author

Matheus Marabesi matheus.marabesi@gmail.com

license

http://www.gnu.org/licenses/gpl-howto.html GPL

link

Template Method Design Pattern

version
1.0.0

Table of Contents

Constants

ERRO_VALIDACAO  = 2
GUIA_EMITIDA_COM_SUCESSO  = 9

Properties

$dadosArquivo  : string
$identificador  : int
$index  : int
$lote  : array<string|int, mixed>
$sequencialGuiaErroValidacao  : string

Methods

__construct()  : mixed
Utiliza o método construtor da classe para ser enviado um conteúdo de arquivo para ser extraido
getContent()  : string
Esse método é mais utilizado pelas classes filhas onde é necessário pegar uma parte do conteúdo baseado em uma string
getLote()  : Lote
aplicarParser()  : mixed
getAmbiente()  : mixed
getAtualizacaoMonetaria()  : mixed
getCEPEmitente()  : mixed
getCodigoBarras()  : mixed
getCodigoMotivoRejeicao()  : mixed
getCodigoReceita()  : mixed
getConvenio()  : mixed
getDataDeVencimento()  : mixed
getDataLimitePagamento()  : mixed
getDescricaoMotivoRejeicao()  : mixed
getDocumentoDestinatario()  : mixed
getDocumentoEmitente()  : mixed
getEnderecoEmitente()  : mixed
getHashDeValidacao()  : mixed
getIdentificador()  : mixed
getIdentificadorDoSolicitante()  : mixed
getIdentificadorGuia()  : mixed
getInformacoesComplementares()  : mixed
getJuros()  : mixed
getMulta()  : mixed
getMunicipioDestinatario()  : mixed
getMunicipioEmitente()  : mixed
getNomeCampo()  : mixed
getNumeroDeControle()  : mixed
getNumeroDocumentoDeOrigem()  : mixed
getNumeroDoProtocoloDoLote()  : mixed
getNumeroProtocolo()  : mixed
getParcela()  : mixed
getPeriodoReferencia()  : mixed
getProduto()  : mixed
getRepresentacaoNumerica()  : mixed
getSequencialGuia()  : mixed
getSequencialGuiaErroValidacao()  : mixed
getSituacaoGuia()  : mixed
getTelefoneEmitente()  : mixed
getTipoDocDestinatario()  : mixed
getTipoEmitente()  : mixed
getTipoIdentificadorDoSolicitante()  : mixed
getTotalGuias()  : mixed
getUFEmitente()  : mixed
getUfFavorecida()  : mixed
getValorPrincipal()  : mixed

Constants

ERRO_VALIDACAO

public mixed ERRO_VALIDACAO = 2

GUIA_EMITIDA_COM_SUCESSO

public mixed GUIA_EMITIDA_COM_SUCESSO = 9

Properties

$dadosArquivo

protected string $dadosArquivo

$identificador

protected int $identificador

$lote

protected array<string|int, mixed> $lote = []

$sequencialGuiaErroValidacao

protected string $sequencialGuiaErroValidacao

Methods

__construct()

Utiliza o método construtor da classe para ser enviado um conteúdo de arquivo para ser extraido

public __construct(string $dadosArquivo) : mixed
Parameters
$dadosArquivo : string

String contendo o conteúdo de retorno do web service da SEFAZ

Tags
since
1.0.0

getContent()

Esse método é mais utilizado pelas classes filhas onde é necessário pegar uma parte do conteúdo baseado em uma string

public getContent(string $content, int $positionStart, int $length) : string
Parameters
$content : string
$positionStart : int
$length : int
Tags
see
SefazRetorno
Return values
string

aplicarParser()

protected abstract aplicarParser() : mixed

getAmbiente()

protected abstract getAmbiente() : mixed

getAtualizacaoMonetaria()

protected abstract getAtualizacaoMonetaria() : mixed

getCEPEmitente()

protected abstract getCEPEmitente() : mixed

getCodigoBarras()

protected abstract getCodigoBarras() : mixed

getCodigoMotivoRejeicao()

protected abstract getCodigoMotivoRejeicao() : mixed

getCodigoReceita()

protected abstract getCodigoReceita() : mixed

getConvenio()

protected abstract getConvenio() : mixed

getDataDeVencimento()

protected abstract getDataDeVencimento() : mixed

getDataLimitePagamento()

protected abstract getDataLimitePagamento() : mixed

getDescricaoMotivoRejeicao()

protected abstract getDescricaoMotivoRejeicao() : mixed

getDocumentoDestinatario()

protected abstract getDocumentoDestinatario() : mixed

getDocumentoEmitente()

protected abstract getDocumentoEmitente() : mixed

getEnderecoEmitente()

protected abstract getEnderecoEmitente() : mixed

getHashDeValidacao()

protected abstract getHashDeValidacao() : mixed

getIdentificador()

protected abstract getIdentificador() : mixed

getIdentificadorDoSolicitante()

protected abstract getIdentificadorDoSolicitante() : mixed

getIdentificadorGuia()

protected abstract getIdentificadorGuia() : mixed

getInformacoesComplementares()

protected abstract getInformacoesComplementares() : mixed

getJuros()

protected abstract getJuros() : mixed

getMulta()

protected abstract getMulta() : mixed

getMunicipioDestinatario()

protected abstract getMunicipioDestinatario() : mixed

getMunicipioEmitente()

protected abstract getMunicipioEmitente() : mixed

getNomeCampo()

protected abstract getNomeCampo() : mixed

getNumeroDeControle()

protected abstract getNumeroDeControle() : mixed

getNumeroDocumentoDeOrigem()

protected abstract getNumeroDocumentoDeOrigem() : mixed

getNumeroDoProtocoloDoLote()

protected abstract getNumeroDoProtocoloDoLote() : mixed

getNumeroProtocolo()

protected abstract getNumeroProtocolo() : mixed

getParcela()

protected abstract getParcela() : mixed

getPeriodoReferencia()

protected abstract getPeriodoReferencia() : mixed

getProduto()

protected abstract getProduto() : mixed

getRepresentacaoNumerica()

protected abstract getRepresentacaoNumerica() : mixed

getSequencialGuia()

protected abstract getSequencialGuia() : mixed

getSequencialGuiaErroValidacao()

protected abstract getSequencialGuiaErroValidacao() : mixed

getSituacaoGuia()

protected abstract getSituacaoGuia() : mixed

getTelefoneEmitente()

protected abstract getTelefoneEmitente() : mixed

getTipoDocDestinatario()

protected abstract getTipoDocDestinatario() : mixed

getTipoEmitente()

protected abstract getTipoEmitente() : mixed

getTipoIdentificadorDoSolicitante()

protected abstract getTipoIdentificadorDoSolicitante() : mixed

getTotalGuias()

protected abstract getTotalGuias() : mixed

getUFEmitente()

protected abstract getUFEmitente() : mixed

getUfFavorecida()

protected abstract getUfFavorecida() : mixed

getValorPrincipal()

protected abstract getValorPrincipal() : mixed

        
On this page

Search results