Setup
in package
Classe abstrata para controlar as propriedades/métodos de uma classe que será a base das configurações. Com isso temos certeza que será enviado as propriedades necessárias para a comunicação com a sefaz, independentemente da classe.
Basta usar essa classe abstrata que tudo deverá funcionar
Tags
Table of Contents
Properties
- $debug : bool
- Define o modo de debug, geralmente utilizado para ver dados da requisição e resposta da comunicação com o webservice
Methods
- getBaseUrl() : string
- Retorna a URL base em que a api se encontra por exemplo http://gnre-api/
- getCertificateCnpj() : int
- Retorna o CNPJ da empresa em que que realizará a emissão da guia para a sefaz
- getCertificateDirectory() : string
- Método utilizado para retornar o diretório onde se encontram os certificados que seram utilizados
- getCertificateName() : string
- Retorna o nome do certificado que será usado junto com sua extenção por exemplo certificado_teste.pfx
- getCertificatePassword() : string
- Retorna a senha do certificado
- getCertificatePemFile() : string
- Método que retorna o caminho e o nome do arquivo extraido do certificado por exemplo /var/www/certificado_pem.pem
- getDebug() : bool
- Método utilizado para retornar o modo de debug
- getEnvironment() : int
- Método utilizado para retornar o número do ambiente em que se deseja realizar a conexão com o webservice da sefaz 1 - Produção 2 - Homologação
- getPrivateKey() : string
- Método que retorna o caminho e o nome do arquivo privado extraido do certificado por exemplo /var/www/chave_privada.pem
- getProxyIp() : string
- Retorna o IP do proxy caso a API estaja atrás de um por exemplo 192.168.0.1
- getProxyPass() : string
- Retorna a senha do usuário do servidor de proxy caso seja necessário a indentificação
- getProxyPort() : int
- Retorna a porta do servidor de proxy por exemplo 3128 (squid)
- getProxyUser() : string
- Retorna o usuário do servidor de proxy caso seja necessário a indentificação
Properties
$debug
Define o modo de debug, geralmente utilizado para ver dados da requisição e resposta da comunicação com o webservice
protected
bool
$debug
= false
Methods
getBaseUrl()
Retorna a URL base em que a api se encontra por exemplo http://gnre-api/
public
abstract getBaseUrl() : string
Tags
Return values
stringgetCertificateCnpj()
Retorna o CNPJ da empresa em que que realizará a emissão da guia para a sefaz
public
abstract getCertificateCnpj() : int
Tags
Return values
intgetCertificateDirectory()
Método utilizado para retornar o diretório onde se encontram os certificados que seram utilizados
public
abstract getCertificateDirectory() : string
Tags
Return values
stringgetCertificateName()
Retorna o nome do certificado que será usado junto com sua extenção por exemplo certificado_teste.pfx
public
abstract getCertificateName() : string
Tags
Return values
stringgetCertificatePassword()
Retorna a senha do certificado
public
abstract getCertificatePassword() : string
Tags
Return values
stringgetCertificatePemFile()
Método que retorna o caminho e o nome do arquivo extraido do certificado por exemplo /var/www/certificado_pem.pem
public
abstract getCertificatePemFile() : string
Tags
Return values
stringgetDebug()
Método utilizado para retornar o modo de debug
public
getDebug() : bool
Return values
boolgetEnvironment()
Método utilizado para retornar o número do ambiente em que se deseja realizar a conexão com o webservice da sefaz 1 - Produção 2 - Homologação
public
abstract getEnvironment() : int
Tags
Return values
intgetPrivateKey()
Método que retorna o caminho e o nome do arquivo privado extraido do certificado por exemplo /var/www/chave_privada.pem
public
abstract getPrivateKey() : string
Tags
Return values
stringgetProxyIp()
Retorna o IP do proxy caso a API estaja atrás de um por exemplo 192.168.0.1
public
abstract getProxyIp() : string
Tags
Return values
stringgetProxyPass()
Retorna a senha do usuário do servidor de proxy caso seja necessário a indentificação
public
abstract getProxyPass() : string
Tags
Return values
stringgetProxyPort()
Retorna a porta do servidor de proxy por exemplo 3128 (squid)
public
abstract getProxyPort() : int
Tags
Return values
intgetProxyUser()
Retorna o usuário do servidor de proxy caso seja necessário a indentificação
public
abstract getProxyUser() : string