\Jarouche\ViaCEPbuscaViaCEP

Classe buscaViaCEP Classe Abstrata para definição de similaridades entre as demais classes

Summary

Methods
Properties
Constants
retornaConteudoRequisicao()
retornaCEP()
No public properties found
CEP_SITE
CEP_METHOD
validaCEP()
buscaInfoCEP()
$cep
$results_string
N/A
No private methods found
No private properties found
N/A

Constants

CEP_SITE

CEP_SITE

Constante que indica qual o endereço da requisição

CEP_METHOD

CEP_METHOD

Constante utilizada para dizer o sub-endereço da requisição p.ex para a requisição https://viacep.com.br/ws/cep_a_buscar/querty/ o valor da variável será '/querty/' Deve ser especificada nas classes filhas que formalmente farão a implementação do método de busca

Properties

$cep

$cep : string

Armazena cep pré-formatado para busca p.ex 09190099

Type

string

$results_string

$results_string : string

Armazena o retorno bruto da requisição

Type

string

Methods

retornaConteudoRequisicao()

retornaConteudoRequisicao() : String

Método retornaConteudoRequisicao Método para o retorno dos dados da requisição bruta, este método deve ser usado apenas depois de uma requisição já feita através de @see retornaCEP

Returns

String —

String da requisição pura

retornaCEP()

retornaCEP(string  $cep) : Array

Método retornaCEP Método para o retorno dos dados do CEP pesquisado

Parameters

string $cep

Returns

Array —

Array com os dados do CEP pesquisado, caso não exista irá retornar um array ('erro' => true);

validaCEP()

validaCEP(string  $cep) : \Jarouche\ViaCEP\void;

Método validaCEP Método para a formatação e validação do cep a ser pesquisado

Parameters

string $cep

Throws

\Jarouche\ViaCEP\Exception

Returns

\Jarouche\ViaCEP\void;

buscaInfoCEP()

buscaInfoCEP() : \Jarouche\ViaCEP\void;

Método buscaInfoCEP Método para fazer a requisição e alementar a propriedade results_string

Throws

\Jarouche\ViaCEP\Exception

Returns

\Jarouche\ViaCEP\void;