Holidays::list() - Code Metrics - Inspection of "Setting start time and end time manually" - stephenlake/php-google-holidays - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#4)

unknown

created 2019-05-14 09:05 UTC

Holidays::list() C

↳ Parent: Holidays

Complexity

Conditions	12
Paths	6

Size

Total Lines	56
Code Lines	33

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	12
eloc	33
nc	6
nop	0
dl	0
loc	56
rs	6.9666
c	0
b	0
f	0

How to fix Long Method Complexity

<?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
filter:
    dependency_paths: ["lib/*"]
     *
     * @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;

    }

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

        return $this;

    }

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

        return $this;

    }

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

        return $this;

    }

    /**
     * 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;
    }
}


1			<?php
2
3			namespace Google;
4
5			class Holidays
6			{
7			/**
8			* Google API Key.
9			*
10			* @var string
11			*/
12			private $api_key;
13
14			/**
15			* Country Code.
16			*
17			* @var string
18			*/
19			private $country_code;
20
21			/**
22			* Start Date.
23			*
24			* @var string
25			*/
26			private $start_date;
27
28			/**
29			* End Date.
30			*
31			* @var string
32			*/
33			private $end_date;
34
35			/**
36			* Minimal output boolean.
37			*
38			* @var bool
39			*/
40			private $minimal = false;
41
42			/**
43			* Dates only output boolean.
44			*
45			* @var bool
46			*/
47			private $dates_only = false;
48
49			/**
50			* Construct!
51			*
52			* @return void
53			*/
54			public function __construct()
55			{
56			$this->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
			0 ignored issues – show Bug introduced 2019-05-14 09:07 UTC by Report Bug Copy Issue Report The type `Google\Date` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
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			return $this;
71			}
72			/**
73			* Setting end date.
74			*
75			* @param string Date in any format
76			*
77			* @return self
78			*/
79			public function to($str)
80			{
81			$this->end_date = date('Y-m-d', strtotime($str)).'T00:00:00-00:00';
82			return $this;
83			}
84			/**
85			* Setter of API key.
86			*
87			* @return void
88			*/
89			public function withApiKey($api_key)
90			{
91			$this->api_key = $api_key;
92
93			return $this;
			0 ignored issues – show Bug Best Practice introduced 2019-01-25 03:09 UTC by Report Bug Copy Issue Report The expression `return $this` returns the type `Google\Holidays` which is incompatible with the documented return type `void`. Loading history...
94			}
95
96			/**
97			* Define the country code to retrieve holidays for.
98			*
99			* @return void
100			*/
101			public function inCountry($country_code)
102			{
103			$this->country_code = strtolower($country_code);
104
105			return $this;
			0 ignored issues – show Bug Best Practice introduced 2019-01-25 03:09 UTC by Report Bug Copy Issue Report The expression `return $this` returns the type `Google\Holidays` which is incompatible with the documented return type `void`. Loading history...
106			}
107
108			/**
109			* Define the output result as minimal.
110			*
111			* @return void
112			*/
113			public function withMinimalOutput()
114			{
115			$this->minimal = true;
116
117			return $this;
			0 ignored issues – show Bug Best Practice introduced 2019-01-25 03:09 UTC by Report Bug Copy Issue Report The expression `return $this` returns the type `Google\Holidays` which is incompatible with the documented return type `void`. Loading history...
118			}
119
120			/**
121			* Define the output as dates only.
122			*
123			* @return void
124			*/
125			public function withDatesOnly()
126			{
127			$this->dates_only = true;
128
129			return $this;
			0 ignored issues – show Bug Best Practice introduced 2019-01-25 03:09 UTC by Report Bug Copy Issue Report The expression `return $this` returns the type `Google\Holidays` which is incompatible with the documented return type `void`. Loading history...
130			}
131
132			/**
133			* Get the list of holidays.
134			*
135			* @return mixed
136			*/
137			public function list()
138			{
139			if (!$this->api_key) {
140			throw new \Exception('Providing an API key might be a better start. RTFM.');
141			}
142
143			if (!$this->country_code) {
144			throw new \Exception('Providing a Country Code is a good idea. RTFM.');
145			}
146
147			$result = [];
148
149			$api_url = "https://content.googleapis.com/calendar/v3/calendars/en.{$this->country_code}%23holiday%40group.v.calendar.google.com/events".
150			'?singleEvents=false'.
151			"&timeMax={$this->end_date}".
152			"&timeMin={$this->start_date}".
153			"&key={$this->api_key}";
154
155			$response = json_decode(file_get_contents($api_url), true);
156
157			if (isset($response['items'])) {
158			if ($this->dates_only === true) {
159			foreach ($response['items'] as $holiday) {
160			$result[] = $holiday['start']['date'];
161			}
162
163			sort($result);
164			} elseif ($this->minimal === true) {
165			foreach ($response['items'] as $holiday) {
166			$result[] = [
167			'name' => $holiday['summary'],
168			'date' => $holiday['start']['date'],
169			];
170			}
171
172			usort($result, function ($a, $b) {
173			if ($a['date'] == $b['date']) {
174			return 0;
175			}
176
177			return ($a['date'] < $b['date']) ? -1 : 1;
178			});
179			} else {
180			$result = $response['items'];
181
182			usort($result, function ($a, $b) {
183			if ($a['start']['date'] == $b['start']['date']) {
184			return 0;
185			}
186
187			return ($a['start']['date'] < $b['start']['date']) ? -1 : 1;
188			});
189			}
190			}
191
192			return $result;
193			}
194			}
195

stephenlake / php-google-holidays

Pull Request — master (#4)

Holidays::list() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like