These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more
1 | <?php |
||
2 | namespace DigitalCanvas\Options; |
||
3 | |||
4 | use RuntimeException; |
||
5 | |||
6 | class Countries |
||
7 | { |
||
8 | /** |
||
9 | * @var string |
||
10 | */ |
||
11 | private static $file; |
||
12 | |||
13 | /** |
||
14 | * @var array |
||
15 | */ |
||
16 | private static $countries; |
||
17 | |||
18 | /** |
||
19 | * Sets the xml file to use to load countries |
||
20 | * |
||
21 | * @param string|null $file |
||
22 | * |
||
23 | * @throws RuntimeException |
||
24 | */ |
||
25 | 3 | public static function setXML($file = null) |
|
26 | { |
||
27 | 3 | if (is_null($file)) { |
|
28 | 1 | $file = __DIR__ . '/countries.xml'; |
|
29 | 1 | } |
|
30 | 3 | if (!is_file($file)) { |
|
31 | 1 | throw new RuntimeException('Country XML file does not exist.'); |
|
32 | } |
||
33 | 2 | self::$file = realpath($file); |
|
34 | 2 | self::$countries = null; |
|
0 ignored issues
–
show
|
|||
35 | 2 | } |
|
36 | |||
37 | /** |
||
38 | * Loads the countries from the xml file. |
||
39 | */ |
||
40 | 7 | private static function loadCountries() |
|
41 | { |
||
42 | 7 | if (is_null(self::$file)) { |
|
43 | 1 | self::setXML(); |
|
44 | 1 | } |
|
45 | // Load xml file |
||
46 | 7 | $xml = simplexml_load_file(self::$file); |
|
47 | 7 | $countries = array(); |
|
48 | // loop through states |
||
49 | 7 | foreach ($xml as $country) { |
|
50 | 7 | $countries[(string) $country->code] = array( |
|
51 | 7 | 'code' => (string) $country->code, |
|
52 | 7 | 'name' => (string) $country->name |
|
53 | 7 | ); |
|
54 | 7 | } |
|
55 | // Cache states |
||
56 | 7 | self::$countries = $countries; |
|
57 | // Clear xml instance |
||
58 | 7 | unset($xml, $countries, $country); |
|
59 | 7 | } |
|
60 | |||
61 | /** |
||
62 | * Clears the data from the cache. |
||
63 | */ |
||
64 | 8 | public static function clearCache() |
|
65 | { |
||
66 | 8 | self::$countries = null; |
|
0 ignored issues
–
show
It seems like
null of type null is incompatible with the declared type array of property $countries .
Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..
Loading history...
|
|||
67 | 8 | } |
|
68 | |||
69 | /** |
||
70 | * Checks if data has been cached |
||
71 | * |
||
72 | * @return boolean |
||
73 | */ |
||
74 | 1 | public static function isCached() |
|
75 | { |
||
76 | 1 | return !is_null(self::$countries); |
|
77 | } |
||
78 | |||
79 | /** |
||
80 | * Returns array of countries |
||
81 | * |
||
82 | * @return array |
||
83 | */ |
||
84 | 1 | public static function getArray() |
|
85 | { |
||
86 | // Load States if they are not yet loaded. |
||
87 | 1 | if (is_null(self::$countries)) { |
|
88 | 1 | self::loadCountries(); |
|
89 | 1 | } |
|
90 | 1 | return self::$countries; |
|
91 | } |
||
92 | |||
93 | /** |
||
94 | * Returns countries as abbreviation=>name pair array |
||
95 | * |
||
96 | * @return array |
||
97 | */ |
||
98 | 3 | public static function getPairs() |
|
99 | { |
||
100 | // Load States if they are not yet loaded. |
||
101 | 3 | if (is_null(self::$countries)) { |
|
102 | 3 | self::loadCountries(); |
|
103 | 3 | } |
|
104 | 3 | $countries = array(); |
|
105 | 3 | foreach (self::$countries as $key => $country) { |
|
0 ignored issues
–
show
The expression
self::$countries of type null|array is not guaranteed to be traversable. How about adding an additional type check?
There are different options of fixing this problem.
Loading history...
|
|||
106 | 3 | $countries[$country['code']] = $country['name']; |
|
107 | 3 | } |
|
108 | 3 | return $countries; |
|
109 | } |
||
110 | |||
111 | /** |
||
112 | * Returns a single country by abbreviation |
||
113 | * |
||
114 | * @param string $country |
||
115 | * @param bool $name_only |
||
116 | * |
||
117 | * @return string|array|bool |
||
118 | */ |
||
119 | 3 | public static function getCountry($country, $name_only = true) |
|
120 | { |
||
121 | // Load States if they are not yet loaded. |
||
122 | 3 | if (is_null(self::$countries)) { |
|
123 | 3 | self::loadCountries(); |
|
124 | 3 | } |
|
125 | 3 | if (array_key_exists($country, self::$countries)) { |
|
126 | 2 | return ($name_only) ? self::$countries[$country]['name'] : self::$countries[$country]; |
|
127 | } else { |
||
128 | 1 | return false; |
|
129 | } |
||
130 | } |
||
131 | } |
||
132 |
Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.
Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..