Consulta
extends ConsultaGnre
in package
Classe utilzada para gerar o envelope SOAP para ser enviado ao web service da SEFAZ para realizar a operação de consulta.
Tags
Table of Contents
Properties
- $ambienteDeTeste : bool
Methods
- getEnvironment() : int
- Retorna o valor do ambiente armazenado no atributo interno na classe
- getHeaderSoap() : array<string|int, mixed>
- Retorna em um formato de array os cabeçalhos necessários para a comunicação com o webservice da SEFAZ.
- getRecibo() : int
- Retorna o número de recibo armazenado no atributo interno da classe
- getSoapEnvelop() : mixed
- Método responsável por encapsular todo o XML gerado e encapsula-lo dentro de um envelop SOAP válido para ser enviado
- setEnvironment() : void
- Define o ambiente desejado para realizar a consulta no webservice da sefaz
- setRecibo() : void
- Define um número de recibo para ser utilizado na consulta ao webservice da sefaz
- soapAction() : string
- Retorna uma string com a ação SOAP que será enviada ao webservice para ser executada
- toXml() : string
- Método que transforma o objeto que sera enviado para o webservice em XML (O tipo de dado aceito pelo webservice)
- utilizarAmbienteDeTeste() : mixed
- Define se a requisição será realizada no ambiente de testes ou não
Properties
$ambienteDeTeste
private
bool
$ambienteDeTeste
= false
Methods
getEnvironment()
Retorna o valor do ambiente armazenado no atributo interno na classe
public
getEnvironment() : int
Tags
Return values
intgetHeaderSoap()
Retorna em um formato de array os cabeçalhos necessários para a comunicação com o webservice da SEFAZ.
public
getHeaderSoap() : array<string|int, mixed>
Return values
array<string|int, mixed>getRecibo()
Retorna o número de recibo armazenado no atributo interno da classe
public
getRecibo() : int
Tags
Return values
intgetSoapEnvelop()
Método responsável por encapsular todo o XML gerado e encapsula-lo dentro de um envelop SOAP válido para ser enviado
public
getSoapEnvelop(mixed $gnre, mixed $consulta) : mixed
Parameters
- $gnre : mixed
- $consulta : mixed
setEnvironment()
Define o ambiente desejado para realizar a consulta no webservice da sefaz
public
setEnvironment(int $environment) : void
Parameters
- $environment : int
-
O número do ambiente que se deseja consultar. 1 = produção e 2 = homologação
Tags
setRecibo()
Define um número de recibo para ser utilizado na consulta ao webservice da sefaz
public
setRecibo(int $recibo) : void
Parameters
- $recibo : int
-
Número retornado pelo webservice da sefaz após ter recebido um lote com sucesso
Tags
soapAction()
Retorna uma string com a ação SOAP que será enviada ao webservice para ser executada
public
soapAction() : string
Return values
string —Retorna uma string com o nome da ação que será executa pelo webservice
toXml()
Método que transforma o objeto que sera enviado para o webservice em XML (O tipo de dado aceito pelo webservice)
public
toXml() : string
Return values
string —Uma string contendo todo o XML gerado
utilizarAmbienteDeTeste()
Define se a requisição será realizada no ambiente de testes ou não
public
utilizarAmbienteDeTeste([mixed $ambiente = false ]) : mixed
Parameters
- $ambiente : mixed = false
-
Define se será utilizado o ambiente de teste ou não, o padrão é false(para não usar o ambiente de testes)