├── .gitignore
├── .travis.yml
├── LICENSE.md
├── README.md
├── composer.json
├── composer.lock
├── docs
├── .nojekyll
├── README.md
├── assets
│ ├── .gitkeep
│ └── php-google-holidays.png
└── index.html
├── phpunit.xml
├── src
└── Holidays.php
└── tests
├── .gitkeep
├── TestCase.php
└── Unit
└── ModelTest.php
/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor
2 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: php
2 |
3 | sudo: true
4 |
5 | php:
6 | - 7.2
7 |
8 | services:
9 | - sqlite
10 |
11 | before_script:
12 | - composer install
13 | - travis_retry composer self-update
14 | - travis_retry composer update --no-interaction --prefer-dist
15 | - composer show laravel/framework
16 |
17 | script:
18 | - vendor/bin/phpunit
19 |
--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2018 Stephen Lake
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 |
6 | A PHP package to assist in retrieving a country's year bank holiday listings with name and date from Google Calendar API's.
7 |
8 |
9 |
10 |
14 |
16 |
19 |
20 |
2 |
4 |
5 |
6 | A PHP package to assist in retrieving a country's year bank holiday listings with name and date from Google Calendar API's.
7 |
8 |
9 |
10 |
15 |
16 | ## Getting Started
17 |
18 | Install the package via composer.
19 |
20 | composer require stephenlake/php-google-holidays
21 |
22 | ## Usage
23 |
24 | ### Instantiation
25 |
26 | ```php
27 | $instance = new \Google\Holidays();
28 | ```
29 |
30 | ### Get Holiday's Name & Date
31 | **Return only `name` and `date`**
32 | ```php
33 | $holidays = $instance->withApiKey('')
34 | ->inCountry('US')
35 | ->withMinimalOutput()
36 | ->list();
37 | ```
38 | **Sample Output**
39 | ```
40 | [
41 | "name": "A holiday",
42 | "date": "2018-01-01"
43 | ],
44 | [
45 | "name": "Another holiday",
46 | "date": "2018-02-01"
47 | ]
48 | ```
49 |
50 | ### Get Holiday's Dates Only
51 | **Return only dates**
52 | ```php
53 | $holidays = $instance->withApiKey('')
54 | ->inCountry('UK')
55 | ->withDatesOnly()
56 | ->list();
57 | ```
58 |
59 | **Sample Output**
60 | ```
61 | [
62 | "2018-01-01",
63 | "2018-02-01",
64 | "2018-03-15"
65 | ]
66 | ```
67 |
--------------------------------------------------------------------------------
/docs/assets/.gitkeep:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/docs/assets/php-google-holidays.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/stephenlake/php-google-holidays/799085827c52606c8ff692769274d7a593936c3e/docs/assets/php-google-holidays.png
--------------------------------------------------------------------------------
/docs/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | PHP Google Holidays
6 |
13 |
19 |
20 |
21 |
22 |
--------------------------------------------------------------------------------
/phpunit.xml:
--------------------------------------------------------------------------------
1 |
2 |
12 |
13 |
14 | ./tests/Unit/
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/src/Holidays.php:
--------------------------------------------------------------------------------
1 | start_date = date('Y-m-d').'T00:00:00-00:00';
57 | $this->end_date = (date('Y') + 1).'-01-01T00:00:00-00:00';
58 | }
59 |
60 | /**
61 | * Setting starting date.
62 | *
63 | * @param string Date in any format
64 | *
65 | * @return self
66 | */
67 | public function from($str)
68 | {
69 | $this->start_date = date('Y-m-d', strtotime($str)).'T00:00:00-00:00';
70 |
71 | return $this;
72 | }
73 |
74 | /**
75 | * Setting end date.
76 | *
77 | * @param string Date in any format
78 | *
79 | * @return self
80 | */
81 | public function to($str)
82 | {
83 | $this->end_date = date('Y-m-d', strtotime($str)).'T00:00:00-00:00';
84 |
85 | return $this;
86 | }
87 |
88 | /**
89 | * Setter of API key.
90 | *
91 | * @return void
92 | */
93 | public function withApiKey($api_key)
94 | {
95 | $this->api_key = $api_key;
96 |
97 | return $this;
98 | }
99 |
100 | /**
101 | * Define the country code to retrieve holidays for.
102 | *
103 | * @return void
104 | */
105 | public function inCountry($country_code)
106 | {
107 | $this->country_code = strtolower($country_code);
108 |
109 | return $this;
110 | }
111 |
112 | /**
113 | * Define the output result as minimal.
114 | *
115 | * @return void
116 | */
117 | public function withMinimalOutput()
118 | {
119 | $this->minimal = true;
120 |
121 | return $this;
122 | }
123 |
124 | /**
125 | * Define the output as dates only.
126 | *
127 | * @return void
128 | */
129 | public function withDatesOnly()
130 | {
131 | $this->dates_only = true;
132 |
133 | return $this;
134 | }
135 |
136 | /**
137 | * Get the list of holidays.
138 | *
139 | * @return mixed
140 | */
141 | public function list()
142 | {
143 | if (!$this->api_key) {
144 | throw new \Exception('Providing an API key might be a better start. RTFM.');
145 | }
146 |
147 | if (!$this->country_code) {
148 | throw new \Exception('Providing a Country Code is a good idea. RTFM.');
149 | }
150 |
151 | $result = [];
152 |
153 | $api_url = "https://content.googleapis.com/calendar/v3/calendars/en.{$this->country_code}%23holiday%40group.v.calendar.google.com/events".
154 | '?singleEvents=false'.
155 | "&timeMax={$this->end_date}".
156 | "&timeMin={$this->start_date}".
157 | "&key={$this->api_key}";
158 |
159 | $response = json_decode(file_get_contents($api_url), true);
160 |
161 | if (isset($response['items'])) {
162 | if ($this->dates_only === true) {
163 | foreach ($response['items'] as $holiday) {
164 | $result[] = $holiday['start']['date'];
165 | }
166 |
167 | sort($result);
168 | } elseif ($this->minimal === true) {
169 | foreach ($response['items'] as $holiday) {
170 | $result[] = [
171 | 'name' => $holiday['summary'],
172 | 'date' => $holiday['start']['date'],
173 | ];
174 | }
175 |
176 | usort($result, function ($a, $b) {
177 | if ($a['date'] == $b['date']) {
178 | return 0;
179 | }
180 |
181 | return ($a['date'] < $b['date']) ? -1 : 1;
182 | });
183 | } else {
184 | $result = $response['items'];
185 |
186 | usort($result, function ($a, $b) {
187 | if ($a['start']['date'] == $b['start']['date']) {
188 | return 0;
189 | }
190 |
191 | return ($a['start']['date'] < $b['start']['date']) ? -1 : 1;
192 | });
193 | }
194 | }
195 |
196 | return $result;
197 | }
198 | }
199 |
--------------------------------------------------------------------------------
/tests/.gitkeep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/stephenlake/php-google-holidays/799085827c52606c8ff692769274d7a593936c3e/tests/.gitkeep
--------------------------------------------------------------------------------
/tests/TestCase.php:
--------------------------------------------------------------------------------
1 | app->setBasePath(__DIR__.'/../');
14 | }
15 | }
16 |
--------------------------------------------------------------------------------
/tests/Unit/ModelTest.php:
--------------------------------------------------------------------------------
1 | assertTrue(true);
19 | }
20 | }
21 |
--------------------------------------------------------------------------------
3 | 
11 | 
13 |
14 | 
15 |
16 | 
17 | 
18 | 
14 |