CountryLoader::countries() - Code Metrics - Inspection of "Enforce consistency and rename Country Loader clas..." - rinvex/countries - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 9aa9c5...e704a3 )

by Abdelrahman

created 2017-03-06 20:59 UTC

CountryLoader::countries() A

↳ Parent: CountryLoader

Complexity

Conditions	4
Paths	8

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	7
nc	8
nop	2
dl	0
loc	12
rs	9.2
c	0
b	0
f	0

<?php

/*
 * NOTICE OF LICENSE
 *
 * Part of the Rinvex Country Package.
 *
 * This source file is subject to The MIT License (MIT)
 * that is bundled with this package in the LICENSE file.
 *
 * Package: Rinvex Country Package
 * License: The MIT License (MIT)
 * Link:    https://rinvex.com
 */

declare(strict_types=1);

namespace Rinvex\Country;

use Closure;

class CountryLoader
{
    /**
     * The countries array.
     *
     * @var array
     */
    protected static $countries;

    /**
     * Get the country by it's ISO 3166-1 alpha-2.
     *
     * @param string $key
     * @param bool   $hydrate
     *
     * @return \Rinvex\Country\Country|array
     */
    public static function country($key, $hydrate = true)
    {
        $key = mb_strtolower($key);

        if (! isset(static::$countries[$key])) {
            static::$countries[$key] = json_decode(static::getFile(__DIR__.'/../resources/data/'.$key.'.json'), true);
        }

        return $hydrate ? new Country(static::$countries[$key]) : static::$countries[$key];
    }

    /**
     * Get all countries short-listed.
     *
     * @param bool $longlist
     * @param bool $hydrate
     *
     * @return array
     */
    public static function countries($longlist = false, $hydrate = false)
    {
        $list = $longlist ? 'longlist' : 'shortlist';

        if (! isset(static::$countries[$list])) {
            static::$countries[$list] = json_decode(static::getFile(__DIR__.'/../resources/data/'.$list.'.json'), true);
        }

        return $hydrate ? array_map(function ($country) {
            return new Country($country);
        }, static::$countries[$list]) : static::$countries[$list];
    }

    /**
     * Filter items by the given key value pair.
     *
     * @param string $key
     * @param mixed  $operator
     * @param mixed  $value
     *
     * @return array
     */
    public static function where($key, $operator, $value = null)
    {
        if (func_num_args() === 2) {
            $value = $operator;
            $operator = '=';
        }

        if (! isset(static::$countries['longlist'])) {
            static::$countries['longlist'] = json_decode(static::getFile(__DIR__.'/../resources/data/longlist.json'), true);

        }

        return static::filter(static::$countries['longlist'], static::operatorForWhere($key, $operator, $value));
    }

    /**
     * Get an operator checker callback.
     *
     * @param string $key
     * @param string $operator
     * @param mixed  $value
     *
     * @return \Closure
     */
    protected static function operatorForWhere($key, $operator, $value)
    {
        return function ($item) use ($key, $operator, $value) {
            $retrieved = static::get($item, $key);

            switch ($operator) {
                default:
                case '=':
                case '==':  return $retrieved == $value;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
                case '!=':
                case '<>':  return $retrieved != $value;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
                case '<':   return $retrieved < $value;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
                case '>':   return $retrieved > $value;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
                case '<=':  return $retrieved <= $value;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
                case '>=':  return $retrieved >= $value;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
                case '===': return $retrieved === $value;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
                case '!==': return $retrieved !== $value;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            }
        };
    }

    /**
     * Run a filter over each of the items.
     *
     * @param array         $items
     * @param callable|null $callback
     *
     * @return array
     */
    protected static function filter($items, callable $callback = null)
    {
        if ($callback) {
            return array_filter($items, $callback, ARRAY_FILTER_USE_BOTH);
        }

        return array_filter($items);
    }

    /**
     * Get an item from an array or object using "dot" notation.
     *
     * @param mixed        $target
     * @param string|array $key
     * @param mixed        $default
     *
     * @return mixed
     */
    protected static function get($target, $key, $default = null)
    {
        if (is_null($key)) {
            return $target;
        }

        $key = is_array($key) ? $key : explode('.', $key);

        while (($segment = array_shift($key)) !== null) {
            if ($segment === '*') {
                if (! is_array($target)) {
                    return $default instanceof Closure ? $default() : $default;
                }

                $result = static::pluck($target, $key);

                return in_array('*', $key) ? static::collapse($result) : $result;
            }

            if (is_array($target) && array_key_exists($segment, $target)) {
                $target = $target[$segment];
            } elseif (is_object($target) && isset($target->{$segment})) {
                $target = $target->{$segment};
            } else {
                return $default instanceof Closure ? $default() : $default;
            }
        }

        return $target;
    }

    /**
     * Pluck an array of values from an array.
     *
     * @param array             $array
     * @param string|array      $value
     * @param string|array|null $key
     *
     * @return array
     */
    protected static function pluck($array, $value, $key = null)
    {
        $results = [];

        $value = is_string($value) ? explode('.', $value) : $value;

        $key = is_null($key) || is_array($key) ? $key : explode('.', $key);

        foreach ($array as $item) {
            $itemValue = static::get($item, $value);

            // If the key is "null", we will just append the value to the array and keep
            // looping. Otherwise we will key the array using the value of the key we
            // received from the developer. Then we'll return the final array form.
            if (is_null($key)) {
                $results[] = $itemValue;
            } else {
                $itemKey = static::get($item, $key);

                $results[$itemKey] = $itemValue;
            }
        }

        return $results;
    }

    /**
     * Collapse an array of arrays into a single array.
     *
     * @param array $array
     *
     * @return array
     */
    protected static function collapse($array)
    {
        $results = [];

        foreach ($array as $values) {
            if (! is_array($values)) {
                continue;
            }

            $results = array_merge($results, $values);
        }

        return $results;
    }

    /**
     * Get contents of the given file path.
     *
     * @param string $filePath
     *
     * @throws \Rinvex\Country\CountryLoaderException
     *
     * @return string
     */
    protected static function getFile($filePath)
    {
        if (! file_exists($filePath)) {
            throw CountryLoaderException::invalidCountry();
        }

        return file_get_contents($filePath);
    }
}


1			<?php
2
3			/*
4			* NOTICE OF LICENSE
5			*
6			* Part of the Rinvex Country Package.
7			*
8			* This source file is subject to The MIT License (MIT)
9			* that is bundled with this package in the LICENSE file.
10			*
11			* Package: Rinvex Country Package
12			* License: The MIT License (MIT)
13			* Link: https://rinvex.com
14			*/
15
16			declare(strict_types=1);
17
18			namespace Rinvex\Country;
19
20			use Closure;
21
22			class CountryLoader
23			{
24			/**
25			* The countries array.
26			*
27			* @var array
28			*/
29			protected static $countries;
30
31			/**
32			* Get the country by it's ISO 3166-1 alpha-2.
33			*
34			* @param string $key
35			* @param bool $hydrate
36			*
37			* @return \Rinvex\Country\Country\|array
38			*/
39			public static function country($key, $hydrate = true)
40			{
41			$key = mb_strtolower($key);
42
43			if (! isset(static::$countries[$key])) {
44			static::$countries[$key] = json_decode(static::getFile(__DIR__.'/../resources/data/'.$key.'.json'), true);
45			}
46
47			return $hydrate ? new Country(static::$countries[$key]) : static::$countries[$key];
48			}
49
50			/**
51			* Get all countries short-listed.
52			*
53			* @param bool $longlist
54			* @param bool $hydrate
55			*
56			* @return array
57			*/
58			public static function countries($longlist = false, $hydrate = false)
59			{
60			$list = $longlist ? 'longlist' : 'shortlist';
61
62			if (! isset(static::$countries[$list])) {
63			static::$countries[$list] = json_decode(static::getFile(__DIR__.'/../resources/data/'.$list.'.json'), true);
64			}
65
66			return $hydrate ? array_map(function ($country) {
67			return new Country($country);
68			}, static::$countries[$list]) : static::$countries[$list];
69			}
70
71			/**
72			* Filter items by the given key value pair.
73			*
74			* @param string $key
75			* @param mixed $operator
76			* @param mixed $value
77			*
78			* @return array
79			*/
80			public static function where($key, $operator, $value = null)
81			{
82			if (func_num_args() === 2) {
83			$value = $operator;
84			$operator = '=';
85			}
86
87			if (! isset(static::$countries['longlist'])) {
88			static::$countries['longlist'] = json_decode(static::getFile(__DIR__.'/../resources/data/longlist.json'), true);
			0 ignored issues – show Coding Style introduced 2016-12-12 09:20 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 124 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
89			}
90
91			return static::filter(static::$countries['longlist'], static::operatorForWhere($key, $operator, $value));
92			}
93
94			/**
95			* Get an operator checker callback.
96			*
97			* @param string $key
98			* @param string $operator
99			* @param mixed $value
100			*
101			* @return \Closure
102			*/
103			protected static function operatorForWhere($key, $operator, $value)
104			{
105			return function ($item) use ($key, $operator, $value) {
106			$retrieved = static::get($item, $key);
107
108			switch ($operator) {
109			default:
110			case '=':
111			case '==': return $retrieved == $value;
			0 ignored issues – show Coding Style introduced 2017-03-06 21:01 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2017-03-06 21:01 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
112			case '!=':
113			case '<>': return $retrieved != $value;
			0 ignored issues – show Coding Style introduced 2017-03-06 21:01 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2017-03-06 21:01 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
114			case '<': return $retrieved < $value;
			0 ignored issues – show Coding Style introduced 2017-03-06 21:01 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2017-03-06 21:01 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
115			case '>': return $retrieved > $value;
			0 ignored issues – show Coding Style introduced 2017-03-06 21:01 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2017-03-06 21:01 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
116			case '<=': return $retrieved <= $value;
			0 ignored issues – show Coding Style introduced 2017-03-06 21:01 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2017-03-06 21:01 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
117			case '>=': return $retrieved >= $value;
			0 ignored issues – show Coding Style introduced 2017-03-06 21:01 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2017-03-06 21:01 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
118			case '===': return $retrieved === $value;
			0 ignored issues – show Coding Style introduced 2017-03-06 21:01 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2017-03-06 21:01 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
119			case '!==': return $retrieved !== $value;
			0 ignored issues – show Coding Style introduced 2017-03-06 21:01 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2017-03-06 21:01 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
120			}
121			};
122			}
123
124			/**
125			* Run a filter over each of the items.
126			*
127			* @param array $items
128			* @param callable\|null $callback
129			*
130			* @return array
131			*/
132			protected static function filter($items, callable $callback = null)
133			{
134			if ($callback) {
135			return array_filter($items, $callback, ARRAY_FILTER_USE_BOTH);
136			}
137
138			return array_filter($items);
139			}
140
141			/**
142			* Get an item from an array or object using "dot" notation.
143			*
144			* @param mixed $target
145			* @param string\|array $key
146			* @param mixed $default
147			*
148			* @return mixed
149			*/
150			protected static function get($target, $key, $default = null)
151			{
152			if (is_null($key)) {
153			return $target;
154			}
155
156			$key = is_array($key) ? $key : explode('.', $key);
157
158			while (($segment = array_shift($key)) !== null) {
159			if ($segment === '*') {
160			if (! is_array($target)) {
161			return $default instanceof Closure ? $default() : $default;
162			}
163
164			$result = static::pluck($target, $key);
165
166			return in_array('*', $key) ? static::collapse($result) : $result;
167			}
168
169			if (is_array($target) && array_key_exists($segment, $target)) {
170			$target = $target[$segment];
171			} elseif (is_object($target) && isset($target->{$segment})) {
172			$target = $target->{$segment};
173			} else {
174			return $default instanceof Closure ? $default() : $default;
175			}
176			}
177
178			return $target;
179			}
180
181			/**
182			* Pluck an array of values from an array.
183			*
184			* @param array $array
185			* @param string\|array $value
186			* @param string\|array\|null $key
187			*
188			* @return array
189			*/
190			protected static function pluck($array, $value, $key = null)
191			{
192			$results = [];
193
194			$value = is_string($value) ? explode('.', $value) : $value;
195
196			$key = is_null($key) \|\| is_array($key) ? $key : explode('.', $key);
197
198			foreach ($array as $item) {
199			$itemValue = static::get($item, $value);
200
201			// If the key is "null", we will just append the value to the array and keep
202			// looping. Otherwise we will key the array using the value of the key we
203			// received from the developer. Then we'll return the final array form.
204			if (is_null($key)) {
205			$results[] = $itemValue;
206			} else {
207			$itemKey = static::get($item, $key);
208
209			$results[$itemKey] = $itemValue;
210			}
211			}
212
213			return $results;
214			}
215
216			/**
217			* Collapse an array of arrays into a single array.
218			*
219			* @param array $array
220			*
221			* @return array
222			*/
223			protected static function collapse($array)
224			{
225			$results = [];
226
227			foreach ($array as $values) {
228			if (! is_array($values)) {
229			continue;
230			}
231
232			$results = array_merge($results, $values);
233			}
234
235			return $results;
236			}
237
238			/**
239			* Get contents of the given file path.
240			*
241			* @param string $filePath
242			*
243			* @throws \Rinvex\Country\CountryLoaderException
244			*
245			* @return string
246			*/
247			protected static function getFile($filePath)
248			{
249			if (! file_exists($filePath)) {
250			throw CountryLoaderException::invalidCountry();
251			}
252
253			return file_get_contents($filePath);
254			}
255			}
256

rinvex / countries

Push — develop ( 9aa9c5...e704a3 )

CountryLoader::countries() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like