An open API service indexing awesome lists of open source software.

https://github.com/joel-depiltech/codeigniter-holidayapi

CodeIgniter third-party library deals with Holiday API based an official PHP library
https://github.com/joel-depiltech/codeigniter-holidayapi

api codeigniter codeigniter-library holiday holiday-api holidayapi holidays

Last synced: about 1 month ago
JSON representation

CodeIgniter third-party library deals with Holiday API based an official PHP library

Awesome Lists containing this project

README

          

# CodeIgniter Holiday API

[![Latest Stable Version](https://poser.pugx.org/joel-depiltech/codeigniter-holidayapi/v/stable.svg)](https://packagist.org/packages/joel-depiltech/codeigniter-holidayapi)
[![License](https://poser.pugx.org/joel-depiltech/codeigniter-holidayapi/license)](https://packagist.org/packages/joel-depiltech/codeigniter-holidayapi)

[CodeIgniter](https://www.codeigniter.com) third-party library deals with [Holiday API](https://holidayapi.com) based on [official PHP library](https://github.com/joshtronic/php-holidayapi) .

## Installation

_Note that following steps assume that you have correctly installed Composer and configured CodeIgniter on your server._

Please use [Composer](https://getcomposer.org) to install it and include it as a third-party [package](https://www.codeigniter.com/user_guide/libraries/loader.html#application-packages) in your CodeIgniter application.

`composer require joel-depiltech/codeigniter-holidayapi`

1. Make sure you already use Composer auto-loader in your config file (application/config/config.php)

```php
$config['composer_autoload'] = TRUE; // or a custom path as 'vendor/autoload.php'
```

2. Include this **package** with Loader library

```php
$this->load->add_package_path(APPPATH . 'third_party/holidayapi');
```

3. Include this **library** with Loader library

```php
$this->load->library('HolidayAPI');
```

4. Configure your **api keys** in config file (config/holidayapi.php)

```php
$config['holidayapi_test_api_key'] = '058f4506-caf0-4bdd-b52b-cbc98e20e02e';
$config['holidayapi_live_api_key'] = '*** Fill in your own Live API key ***';
```

## Usage

### Simple call

By default, fetch all holidays of this year for USA :

```php
load->library('HolidayAPI');
$holidays = $this->holidayapi->holidays();
print_r($holidays);
```

### Complete call

A example to fetch all upcoming holidays for France from Christmas to end of 2018 with a specific API key :

```php
load->library('HolidayAPI', array('holidayapi_live_api_key' => '** An other API key **'));
$holidays = $this->holidayapi->holidays('FR', 2018, 12, 25, FALSE, TRUE);
print_r($holidays);
```