calendarific / php-calendarific
PHP library for Calendarific.com
Installs: 146 396
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 1
Requires
- php: >=7.0.0
- jedkirby/json: 0.1.0
Requires (Dev)
- phpunit/phpunit: ^6.5
This package is auto-updated.
Last update: 2024-09-28 00:34:34 UTC
README
Calendarific
Official PHP library for the Calendarific API.
Installation
This package can be installed via Composer:
$ composer require calendarific/php-calendarific
It requires PHP >= 7.0.0.
Usage
The following guide assumes that you've imported the class Calendarific\Calendarific
into your namespace. There's a helper command available which makes querying the API very easy, and is explained below:
$key = 'api-key-123'; $country = 'GB'; $year = 2019; $month = null; $day = null, $location = null, $types = ['national']; $dates = Calendarific::make( $key, $country, $year, $month, $day, $location, $types );
The below define's the parameter's for the Calendarific::make()
helper command:
Testing
Unit tests can be run within the package, however, it utilises Docker & Docker Compose:
$ docker-compose -f ./docker-compose.yml run --rm cli php ./vendor/bin/phpunit
License
calendarific/calendarific is licensed under the MIT license. See the LICENSE file for more details.