stephenlake / php-google-holidays

src/Holidays.php

<?php

namespace Google;

class Holidays
{
    /**
     * Google API Key.
     *
     * @var string
     */
    private $api_key;

    /**
     * Country Code.
     *
     * @var string
     */
    private $country_code;

    /**
     * Start Date.
     *
     * @var string
     */
    private $start_date;

    /**
     * End Date.
     *
     * @var string
     */
    private $end_date;

    /**
     * Minimal output boolean.
     *
     * @var bool
     */
    private $minimal = false;

    /**
     * Dates only output boolean.
     *
     * @var bool
     */
    private $dates_only = false;

    /**
     * Construct!
     *
     * @return void
     */
    public function __construct()
    {
        $this->start_date = date('Y-m-d').'T00:00:00-00:00';
        $this->end_date = (date('Y') + 1).'-01-01T00:00:00-00:00';
    }

    /**
     * Setting starting date.
     *
     * @param string Date in any format
     *
     * @return self
     */
    public function from($str)
    {
        $this->start_date = date('Y-m-d', strtotime($str)).'T00:00:00-00:00';

        return $this;
    }

    /**
     * Setting end date.
     *
     * @param string Date in any format
     *
     * @return self
     */
    public function to($str)
    {
        $this->end_date = date('Y-m-d', strtotime($str)).'T00:00:00-00:00';

        return $this;
    }

    /**
     * Setter of API key.
     *
     * @return void
     */
    public function withApiKey($api_key)
    {
        $this->api_key = $api_key;

        return $this;

The expression return $this returns the type Google\Holidays which is incompatible with the documented return type void.

    }

    /**
     * Define the country code to retrieve holidays for.
     *
     * @return void
     */
    public function inCountry($country_code)
    {
        $this->country_code = strtolower($country_code);

        return $this;

The expression return $this returns the type Google\Holidays which is incompatible with the documented return type void.

    }

    /**
     * Define the output result as minimal.
     *
     * @return void
     */
    public function withMinimalOutput()
    {
        $this->minimal = true;

        return $this;

The expression return $this returns the type Google\Holidays which is incompatible with the documented return type void.

    }

    /**
     * Define the output as dates only.
     *
     * @return void
     */
    public function withDatesOnly()
    {
        $this->dates_only = true;

        return $this;

The expression return $this returns the type Google\Holidays which is incompatible with the documented return type void.

    }

    /**
     * Get the list of holidays.
     *
     * @return mixed
     */
    public function list()
    {
        if (!$this->api_key) {
            throw new \Exception('Providing an API key might be a better start. RTFM.');
        }

        if (!$this->country_code) {
            throw new \Exception('Providing a Country Code is a good idea. RTFM.');
        }

        $result = [];

        $api_url = "https://content.googleapis.com/calendar/v3/calendars/en.{$this->country_code}%23holiday%40group.v.calendar.google.com/events".
               '?singleEvents=false'.
               "&timeMax={$this->end_date}".
               "&timeMin={$this->start_date}".
               "&key={$this->api_key}";

        $response = json_decode(file_get_contents($api_url), true);

        if (isset($response['items'])) {
            if ($this->dates_only === true) {
                foreach ($response['items'] as $holiday) {
                    $result[] = $holiday['start']['date'];
                }

                sort($result);
            } elseif ($this->minimal === true) {
                foreach ($response['items'] as $holiday) {
                    $result[] = [
                      'name' => $holiday['summary'],
                      'date' => $holiday['start']['date'],
                    ];
                }

                usort($result, function ($a, $b) {
                    if ($a['date'] == $b['date']) {
                        return 0;
                    }

                    return ($a['date'] < $b['date']) ? -1 : 1;
                });
            } else {
                $result = $response['items'];

                usort($result, function ($a, $b) {
                    if ($a['start']['date'] == $b['start']['date']) {
                        return 0;
                    }

                    return ($a['start']['date'] < $b['start']['date']) ? -1 : 1;
                });
            }
        }

        return $result;
    }
}