Skip to content
This repository was archived by the owner on Dec 1, 2019. It is now read-only.

Commit e04b289

Browse files
committed
Mais docs... Será o fim?
1 parent 800883b commit e04b289

File tree

1 file changed

+34
-9
lines changed

1 file changed

+34
-9
lines changed

README.md

+34-9
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Acha que está faltando algo? [Abra um issue!](https://github.com/eberfreitas/co
1414

1515
Já existem [diversos pacotes](https://packagist.org/search/?q=correios) que
1616
trabalham com os serviços dos Correios, mas sempre existia algo que me impedia
17-
de usar algum dele, seja porque ele havia sido feito especificamente para algum
17+
de usar algum deles, seja porque ele havia sido feito especificamente para algum
1818
software ou framework, ou porque ele não tinha todos os recursos que eu
1919
precisava, etc. A ideia então foi tentar um novo pacote com os seguintes
2020
objetivos:
@@ -50,7 +50,7 @@ Chave | Descrição
5050
---------------|----------
5151
`usuario` | Se você tiver contrato com os Correios, pode informar seu nome de usuário aqui.
5252
`senha` | Sua senha, caso tenha um usuário com cadastro nos Correios.
53-
`http_adapter` | Aqui você pode passar um objeto que será responsável por realizar as requisições HTTP de consulta aos webservices dos Correios. Veja mais sobre este mais à frente na documentação.
53+
`http_adapter` | Aqui você pode passar um objeto que será responsável por realizar as requisições HTTP de consulta aos webservices dos Correios. Saiba mais sobre isto [aqui](#usando-um-http-adapter-diferente).
5454

5555
Exemplo:
5656

@@ -65,7 +65,7 @@ $correios = new Correios\Correios([
6565
```
6666

6767
Embora você tenha a opção de providenciar um adaptador, se você não indicar
68-
nenhum, a biblioteca irá utilizar o `GuzzleHttp` por padrão.
68+
nenhum, a biblioteca irá utilizar o `Guzzle` por padrão.
6969

7070
###Encontrando um endereço via CEP
7171

@@ -170,13 +170,13 @@ Chave | Valor
170170
------------|------
171171
`data` | Um objeto do tipo [DateTime](http://php.net/DateTime) representando o horário em que o evento aconteceu.
172172
`descricao` | A descrição do evento em questão.
173-
`local` | Local onde o evento ocorreu. O nome do estabeleciomento dos Correios onde este evento ocorreu.
173+
`local` | O nome do estabeleciomento dos Correios onde este evento ocorreu.
174174
`cidade` | Cidade onde o evento ocorreu.
175175
`uf` | Sigla do estado onde o evento ocorreu.
176176

177177
**Uma nota sobre a consulta de pacotes**: Os Correios fornecem um webservice
178178
específico para a consulta de pacotes, porém este webservice é reservado a
179-
clientes que possuem contrato com os Correios. Sendo assim, nós realizamos um
179+
clientes que possuem contrato. Sendo assim, a biblioteca realiza um
180180
processo de "web scraping" para extrair os dados de páginas comuns de consulta.
181181
Embora a página sendo utilizada já tenha demonstrado uma estabilidade de anos
182182
no que diz respeito à sua estrutura, qualquer alteração no HTML desta página
@@ -208,7 +208,7 @@ $calculado = $correios->calculaFrete([
208208
print_r($calculado);
209209
```
210210

211-
Diferente dos outros métodos, este método recebe um array com um bocado mais
211+
Diferente dos outros métodos, este método recebe um array com um bocado
212212
de opções para que o cálculo seja realizado. Vamos dar uma olhada no que eles
213213
são:
214214

@@ -264,7 +264,7 @@ Array
264264
)
265265
```
266266

267-
Veja que temos um retorno de um array cujos elementos são instâncias da classe
267+
Veja que temos o retorno de um array cujos elementos são instâncias da classe
268268
`Correios\Calculo`. Esta é uma classe simples que de dá acesso aos dados do
269269
resultado da consulta como um array ou um objeto:
270270

@@ -314,7 +314,7 @@ DateTime Object
314314
)
315315
```
316316

317-
Veja que o método recebe um objeto DateTime e retorna um objeto `DateTime`
317+
Veja que o método recebe um objeto `DateTime` e retorna um objeto `DateTime`
318318
representando a data de entrega. O método vai levar em consideração se, a partir
319319
da data de envio, a soma do prazo cai em algum dia do fim de semana, e ajusta
320320
a data para o próximo dia útil seguinte, a não ser que a entrega caia num sábado
@@ -341,6 +341,9 @@ quiser, pode omitir o prefixo "R$" passando `false` no segundo argumento:
341341
echo $calculado[0]->formataValor('valor', talse); //15,50
342342
```
343343

344+
Você pode realizar esta formatação para qualquer chave de valor suprida pela
345+
consulta.
346+
344347
####Ajuste inteligente de pacotes
345348

346349
Nenhum dos valores de dimensões dos pacotes é obrigatório de ser preenchido.
@@ -389,4 +392,26 @@ Código | Descrição
389392
40290 | SEDEX HOJE
390393
40819 | SEDEX Pagamento na Entrega
391394

392-
##Créditos
395+
###Usando um http adapter diferente
396+
397+
Por padrão a biblioteca irá usar o [Guzzle](https://packagist.org/packages/guzzlehttp/guzzle)
398+
para realizar as requisições http aos endpoints dos webservices e páginas usados
399+
pela biblioteca. Se você quiser, poderá utilizar outro pacote no lugar do
400+
`Guzzle` fornecendo um novo objeto na hora de instanciar a classe dos Correios.
401+
402+
Para isto você deve criar uma classe intermediária que implemente a interface
403+
`Correios\Adapters\AdapterInterface` que possui apenas dois métodos: `get` e
404+
`post`.
405+
406+
Ambos os métodos devem retornar uma `string` representando o corpo da resposta
407+
da requisição e qualquer erro no processo de requisição deve ser indicado
408+
através da utilização de exceptions.
409+
410+
Veja uma implementação exemplo
411+
[aqui](https://github.com/eberfreitas/correios/blob/master/src/Adapters/GuzzleAdapter.php).
412+
413+
##Créditos
414+
415+
* Criado por [Éber F. Dias](https://github.com/eberfreitas)
416+
* Com o auxilio de [Tiago Correa](https://github.com/tiagocorrea)
417+
* Patrocinado por [Tanlup](https://github.com/tanlup/)

0 commit comments

Comments
 (0)