stargrid / laravel-calendario-feriados
Pacote desenvolvido e mantido pela StarGrid (https://stargrid.pro) para facilitar a integração com a API (http://www.calendario.com.br/api_feriados_municipais_estaduais_nacionais.php) para a busca de feriados nacionais, estaduais e municipais.
Installs: 4 853
Dependents: 0
Suggesters: 0
Security: 0
Stars: 11
Watchers: 3
Forks: 4
Open Issues: 2
Requires
- eloquent/enumeration: ^6.0
- guzzlehttp/guzzle: ^6.3
- illuminate/support: ^7.0
Requires (Dev)
- phpstan/phpstan: ^0.11.8
- phpunit/phpunit: ^7.5
This package is auto-updated.
Last update: 2024-04-25 01:13:52 UTC
README
Calendário nacional de feriados.
Este projeto foi iniciado pela StarGrid para ajudar os usuários do Laravel que pretendem integrar seus sistemas com a API http://www.calendario.com.br para busca de feriados nacionais, estaduais e municipais.
Instalação
Para instalar a dependência através do composer, através do terminal, entre na pasta de seu projeto e digite:
$ composer require stargrid/laravel-calendario-feriados:"v2.0.0"
Obs: Caso esteja usando versões inferiores:
$ composer require stargrid/laravel-calendario-feriados:"v1.0.0"
Após a instalação do pacote, execute o próximo comando:
$ php artisan vendor:publish --provider="StarGrid\LaravelHolidayCalendar\Provider\LaravelHolidayCalendarServiceProvider"
Agora é necessário configurar no .env
o seu token de acesso da API:
LARAVEL_HOLIDAY_CALENDAR_TOKEN=SEU_TOKEN_AQUI
Utilização
Para utilizar basta primeiramente instânciar a classe StarGrid\LaravelHolidayCalendar\HolidayClient
conforme o exemplo a seguir:
$holidayClient = new StarGrid\LaravelHolidayCalendar\HolidayClient(env('LARAVEL_HOLIDAY_CALENDAR_TOKEN'));
Antes de efetuar as chamadas da API, é necessário definir o tipo de retorno (Response). A API Calendário permite dois formatos, JSON ou XML.
Para definir o retorno do tipo JSON:
$holidayClient = new StarGrid\LaravelHolidayCalendar\HolidayClient(env('LARAVEL_HOLIDAY_CALENDAR_TOKEN')); $holidayClient->setJsonResponse();
Para definir o retorno do tipo XML:
$holidayClient = new StarGrid\LaravelHolidayCalendar\HolidayClient(env('LARAVEL_HOLIDAY_CALENDAR_TOKEN')); $holidayClient->setXmlResponse();
Finalmente para fazer a chamada da API, exitem dois tipos de consultas.
Consulta através do código do IBGE do município:
$response = $client->setJsonResponse() ->getHolidaysByIbgeCode(2019, 4314902);
- O primeiro parâmetro é o ano para a consulta dos feriados.
- O segundo parâmetro é o código do IBGE.
Consulta através do nome do município:
$response = $client->setJsonResponse() ->getHolidaysByCity(2019, 'São Paulo' , 'SP');
- O primeiro parâmetro é o ano para a consulta dos feriados.
- O segundo parâmetro é o nome da cidade a ser consultada.
- O terceiro parâmetro é a sigla do estado (UF).
Obs: Não é necessário se preocupar com os acentos e letras minúsculas ou maiúsculas, este tratamento é feito diretamente pelo pacote.
No final o resultado será um array de objetos StarGrid\LaravelHolidayCalendar\Entity\HolidayEntity
.
Esse objeto possuí os seguintes métodos para se obter os dados (getters
):
public function getDate(): \DateTime public function getName(): string public function getDescription(): string public function getLink(): string public function getTypeEnum(): HolidayTypeEnum public function getTypeName(): string public function getRawData(): string
Também possuí seus respectivos setters
.
Service-Provider e Facade
É possível utilizar o DI do próprio Laravel para se obter uma instância de StarGrid\LaravelHolidayCalendar\HolidayClient
, se você estiver em uma controller, por exemplo:
<?php namespace App\Http\Controllers; use StarGrid\LaravelHolidayCalendar\HolidayClient; class HomeController { public function testMethod(HolidayClient $holidayClient) { $response = $holidayClient->setJsonResponse() ->getHolidaysByCity(2019, 'São Paulo' , 'SP'); } }
Ou utiliza-lo através do Facade do próprio pacote:
<?php namespace App\Http\Controllers; use StarGrid\LaravelHolidayCalendar\Facade\HolidayClientFacade; class HomeController { public function testMethod() { $response = HolidayClientFacade::setJsonResponse() ->getHolidaysByCity(2019, 'São Paulo' , 'SP'); } }