Tmdb::checkOptions() - Code Metrics - Inspection of "Change namespace name" - vfalies/tmdb - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2)

unknown

created 2017-06-02 12:07 UTC

Tmdb::checkOptions() B

↳ Parent: Tmdb

Complexity

Conditions	6
Paths	6

Size

Total Lines	30
Code Lines	22

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	20
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	30
ccs	20
cts	20
cp	1
rs	8.439
c	0
b	0
f	0
cc	6
eloc	22
nc	6
nop	1
crap	6

<?php

namespace vfalies\tmdb;

/**
 * Tmdb wrapper core class
 */
class Tmdb implements Interfaces\TmdbInterface
{

    // Private variables
    private $api_key         = null;                              // API Key
    private $language        = 'fr-FR';                           // Default language for API response
    public $base_api_url     = 'https://api.themoviedb.org/3/';   // Base URL of the API
    private $include_adult   = false;                             // Include adult content in search result
    private $page            = 1;                                 // API Page result
    // Protected variables
    protected $configuration = null; // API Configuration
    protected $genres        = null; // API Genres

    /**
     * Constructor
     * @param string $api_key TMDB API Key
     */

    public function __construct(string $api_key)
    {
        $this->api_key = $api_key;
    }

    /**
     * Send cUrl request to TMDB API
     * @param Interfaces\HttpRequestInterface $http_request
     * @param string $action API action to request
     * @param string $query Query of the request (optional)
     * @param array $options Array of options of the request (optional)
     * @return \stdClass
     */
    public function sendRequest(Interfaces\HttpRequestInterface $http_request, string $action, string $query = null, array $options = array()): \stdClass
    {
        // Url construction
        $url = $this->base_api_url . $action;

        // Parameters
        $params            = [];
        $params['api_key'] = $this->api_key;
        if (!is_null($query))
        {
            $params['query'] = $query;
        }

        $params = array_merge($params, $options);

        // URL with paramters construction
        $url = $url . '?' . http_build_query($params);

        $http_request->setUrl($url);
        $http_request->setOption(CURLOPT_HEADER, 0);
        $http_request->setOption(CURLOPT_RETURNTRANSFER, true);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $http_request->setOption(CURLOPT_MAXREDIRS, 10);
        $http_request->setOption(CURLOPT_ENCODING, "");
        $http_request->setOption(CURLOPT_TIMEOUT, 30);
        $http_request->setOption(CURLINFO_HEADER_OUT, true); // To gets header in curl_getinfo()
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $result = $http_request->execute();

        $http_code = $http_request->getInfo(CURLINFO_HTTP_CODE);

        if ($http_code !== 200)
        {
            if ($http_code == 429)
            {
                $message          = new \stdClass();
                $message->message = 'Request rate limit exceeded';
                $header_out       = $http_request->getInfo(CURLINFO_HEADER_OUT);
                $message->headers = var_export($header_out, true);

                throw new \Exception(json_encode($message), 1006);
            }
            throw new \Exception('Incorrect HTTP Code (' . $http_code . ') response : ' . var_export($http_request->getInfo(), true), 1005);

        }

        // cUrl closing
        $http_request->close();

        $response = json_decode($result);
        if (is_null($response) || $response === false)
        {
            throw new \Exception('Search failed : ' . var_export($result, true), 2001);
        }
        return $response;
    }

    /**
     * Get API Configuration
     * @return \stdClass
     */
    public function getConfiguration(): \stdClass
    {
        try
        {
            if (is_null($this->configuration))
            {
                $this->configuration = $this->sendRequest(new CurlRequest(), 'configuration');
            }
            return $this->configuration;
        }
        catch (\Exception $ex)
        {
            throw new \Exception($ex->getMessage(), $ex->getCode(), $ex);
        }
    }

    /**
     * Check options rules before send request
     * @param array $options Array of options to validate
     * @return array
     * @throws \Exception
     */
    public function checkOptions(array $options): array
    {
        $params                  = [];
        // Set default options
        $params['language']      = $this->language;
        $params['include_adult'] = $this->include_adult;
        $params['page']          = $this->page;
        // Check options
        foreach ($options as $key => $value)
        {
            switch ($key)
            {
                case 'year':
                    $params[$key] = $this->checkYear($value);
                    break;
                case 'language':
                    $params[$key] = $this->checkLanguage($value);
                    break;
                case 'include_adult':
                    $params[$key] = filter_var($value, FILTER_VALIDATE_BOOLEAN);
                    break;
                case 'page':
                    $params[$key] = (int) $value;
                    break;
                default:
                    throw new \Exception('Unknown options');
            }
        }
        return $params;
    }

    /**
     * Check year format
     * @param mixed $year year to validate
     * @return int year validated
     * @throws \Exception
     */
    private function checkYear(int $year): int
    {
        $year = (int) $year;
        return $year;
    }

    /**
     * Check language
     * @param string $language Language string with format ISO 639-1
     * @return string Language string validated
     * @throws \Exception
     */
    private function checkLanguage(string $language): string
    {
        $check = preg_match("#([a-z]{2})-([A-Z]{2})#", $language);
        if ($check === 0 || $check === false)
        {
            throw new \Exception("Incorrect language code : $language", 1001);
        }
        return $language;
    }

}


1		<?php
2
3		namespace vfalies\tmdb;
4
5		/**
6		* Tmdb wrapper core class
7		*/
8		class Tmdb implements Interfaces\TmdbInterface
9		{
10
11		// Private variables
12		private $api_key = null; // API Key
13		private $language = 'fr-FR'; // Default language for API response
14		public $base_api_url = 'https://api.themoviedb.org/3/'; // Base URL of the API
15		private $include_adult = false; // Include adult content in search result
16		private $page = 1; // API Page result
17		// Protected variables
18		protected $configuration = null; // API Configuration
19		protected $genres = null; // API Genres
20
21		/**
22		* Constructor
23		* @param string $api_key TMDB API Key
24		*/
25
26	127	public function __construct(string $api_key)
27		{
28	127	$this->api_key = $api_key;
29	127	}
30
31		/**
32		* Send cUrl request to TMDB API
33		* @param Interfaces\HttpRequestInterface $http_request
34		* @param string $action API action to request
35		* @param string $query Query of the request (optional)
36		* @param array $options Array of options of the request (optional)
37		* @return \stdClass
38		*/
39	5	public function sendRequest(Interfaces\HttpRequestInterface $http_request, string $action, string $query = null, array $options = array()): \stdClass
40		{
41		// Url construction
42	5	$url = $this->base_api_url . $action;
43
44		// Parameters
45	5	$params = [];
46	5	$params['api_key'] = $this->api_key;
47	5	if (!is_null($query))
48		{
49	1	$params['query'] = $query;
50		}
51
52	5	$params = array_merge($params, $options);
53
54		// URL with paramters construction
55	5	$url = $url . '?' . http_build_query($params);
56
57	5	$http_request->setUrl($url);
58	5	$http_request->setOption(CURLOPT_HEADER, 0);
59	5	$http_request->setOption(CURLOPT_RETURNTRANSFER, true);
		0 ignored issues – show Documentation introduced 2017-06-02 11:06 UTC by Report Bug Copy Issue Report `true` is of type `boolean`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
60	5	$http_request->setOption(CURLOPT_MAXREDIRS, 10);
61	5	$http_request->setOption(CURLOPT_ENCODING, "");
62	5	$http_request->setOption(CURLOPT_TIMEOUT, 30);
63	5	$http_request->setOption(CURLINFO_HEADER_OUT, true); // To gets header in curl_getinfo()
		0 ignored issues – show Documentation introduced 2017-06-02 11:06 UTC by Report Bug Copy Issue Report `true` is of type `boolean`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
64
65	5	$result = $http_request->execute();
66
67	4	$http_code = $http_request->getInfo(CURLINFO_HTTP_CODE);
68
69	4	if ($http_code !== 200)
70		{
71	2	if ($http_code == 429)
72		{
73	1	$message = new \stdClass();
74	1	$message->message = 'Request rate limit exceeded';
75	1	$header_out = $http_request->getInfo(CURLINFO_HEADER_OUT);
76	1	$message->headers = var_export($header_out, true);
77
78	1	throw new \Exception(json_encode($message), 1006);
79		}
80	1	throw new \Exception('Incorrect HTTP Code (' . $http_code . ') response : ' . var_export($http_request->getInfo(), true), 1005);
		0 ignored issues – show Bug introduced 2017-06-02 11:06 UTC by Report Bug Copy Issue Report The call to `getInfo()` misses a required argument `$name`. This check looks for function calls that miss required arguments. Loading history...
81		}
82
83		// cUrl closing
84	2	$http_request->close();
85
86	2	$response = json_decode($result);
87	2	if (is_null($response) \|\| $response === false)
88		{
89	1	throw new \Exception('Search failed : ' . var_export($result, true), 2001);
90		}
91	1	return $response;
92		}
93
94		/**
95		* Get API Configuration
96		* @return \stdClass
97		*/
98	8	public function getConfiguration(): \stdClass
99		{
100		try
101		{
102	8	if (is_null($this->configuration))
103		{
104	8	$this->configuration = $this->sendRequest(new CurlRequest(), 'configuration');
105		}
106	7	return $this->configuration;
107		}
108	1	catch (\Exception $ex)
109		{
110	1	throw new \Exception($ex->getMessage(), $ex->getCode(), $ex);
111		}
112		}
113
114		/**
115		* Check options rules before send request
116		* @param array $options Array of options to validate
117		* @return array
118		* @throws \Exception
119		*/
120	119	public function checkOptions(array $options): array
121		{
122	119	$params = [];
123		// Set default options
124	119	$params['language'] = $this->language;
125	119	$params['include_adult'] = $this->include_adult;
126	119	$params['page'] = $this->page;
127		// Check options
128	119	foreach ($options as $key => $value)
129		{
130		switch ($key)
131		{
132	48	case 'year':
133	2	$params[$key] = $this->checkYear($value);
134	1	break;
135	47	case 'language':
136	44	$params[$key] = $this->checkLanguage($value);
137	43	break;
138	4	case 'include_adult':
139	1	$params[$key] = filter_var($value, FILTER_VALIDATE_BOOLEAN);
140	1	break;
141	4	case 'page':
142	1	$params[$key] = (int) $value;
143	1	break;
144		default:
145	46	throw new \Exception('Unknown options');
146		}
147		}
148	114	return $params;
149		}
150
151		/**
152		* Check year format
153		* @param mixed $year year to validate
154		* @return int year validated
155		* @throws \Exception
156		*/
157	1	private function checkYear(int $year): int
158		{
159	1	$year = (int) $year;
160	1	return $year;
161		}
162
163		/**
164		* Check language
165		* @param string $language Language string with format ISO 639-1
166		* @return string Language string validated
167		* @throws \Exception
168		*/
169	44	private function checkLanguage(string $language): string
170		{
171	44	$check = preg_match("#([a-z]{2})-([A-Z]{2})#", $language);
172	44	if ($check === 0 \|\| $check === false)
173		{
174	1	throw new \Exception("Incorrect language code : $language", 1001);
175		}
176	43	return $language;
177		}
178
179		}
180

vfalies / tmdb

Pull Request — master (#2)

Tmdb::checkOptions() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like