@@ -22,9 +22,9 @@ discard block |
||
22 | 22 | { |
23 | 23 | use Traits_Optionable; |
24 | 24 | |
25 | - /** |
|
26 | - * @var URLInfo |
|
27 | - */ |
|
25 | + /** |
|
26 | + * @var URLInfo |
|
27 | + */ |
|
28 | 28 | private $url; |
29 | 29 | |
30 | 30 | public function __construct(URLInfo $url) |
@@ -41,13 +41,13 @@ discard block |
||
41 | 41 | ); |
42 | 42 | } |
43 | 43 | |
44 | - /** |
|
45 | - * Whether to verify the host's SSL certificate, in |
|
46 | - * case of an https connection. |
|
47 | - * |
|
48 | - * @param bool $verifySSL |
|
49 | - * @return URLInfo_ConnectionTester |
|
50 | - */ |
|
44 | + /** |
|
45 | + * Whether to verify the host's SSL certificate, in |
|
46 | + * case of an https connection. |
|
47 | + * |
|
48 | + * @param bool $verifySSL |
|
49 | + * @return URLInfo_ConnectionTester |
|
50 | + */ |
|
51 | 51 | public function setVerifySSL(bool $verifySSL=true) : URLInfo_ConnectionTester |
52 | 52 | { |
53 | 53 | $this->setOption('verify-ssl', $verifySSL); |
@@ -81,12 +81,12 @@ discard block |
||
81 | 81 | return $this->getIntOption('timeout'); |
82 | 82 | } |
83 | 83 | |
84 | - /** |
|
85 | - * Initializes the CURL instance. |
|
86 | - * |
|
87 | - * @throws BaseException |
|
88 | - * @return resource |
|
89 | - */ |
|
84 | + /** |
|
85 | + * Initializes the CURL instance. |
|
86 | + * |
|
87 | + * @throws BaseException |
|
88 | + * @return resource |
|
89 | + */ |
|
90 | 90 | private function initCURL() |
91 | 91 | { |
92 | 92 | $ch = curl_init(); |
@@ -103,9 +103,9 @@ discard block |
||
103 | 103 | return $ch; |
104 | 104 | } |
105 | 105 | |
106 | - /** |
|
107 | - * @param resource $ch |
|
108 | - */ |
|
106 | + /** |
|
107 | + * @param resource $ch |
|
108 | + */ |
|
109 | 109 | private function configureOptions($ch) : void |
110 | 110 | { |
111 | 111 | if($this->isVerboseModeEnabled()) |
@@ -48,7 +48,7 @@ discard block |
||
48 | 48 | * @param bool $verifySSL |
49 | 49 | * @return URLInfo_ConnectionTester |
50 | 50 | */ |
51 | - public function setVerifySSL(bool $verifySSL=true) : URLInfo_ConnectionTester |
|
51 | + public function setVerifySSL(bool $verifySSL = true) : URLInfo_ConnectionTester |
|
52 | 52 | { |
53 | 53 | $this->setOption('verify-ssl', $verifySSL); |
54 | 54 | return $this; |
@@ -59,7 +59,7 @@ discard block |
||
59 | 59 | return $this->getBoolOption('verify-ssl'); |
60 | 60 | } |
61 | 61 | |
62 | - public function setVerboseMode(bool $enabled=true) : URLInfo_ConnectionTester |
|
62 | + public function setVerboseMode(bool $enabled = true) : URLInfo_ConnectionTester |
|
63 | 63 | { |
64 | 64 | $this->setOption('curl-verbose', $enabled); |
65 | 65 | return $this; |
@@ -91,7 +91,7 @@ discard block |
||
91 | 91 | { |
92 | 92 | $ch = curl_init(); |
93 | 93 | |
94 | - if(!is_resource($ch)) |
|
94 | + if (!is_resource($ch)) |
|
95 | 95 | { |
96 | 96 | throw new BaseException( |
97 | 97 | 'Could not initialize a new cURL instance.', |
@@ -108,7 +108,7 @@ discard block |
||
108 | 108 | */ |
109 | 109 | private function configureOptions($ch) : void |
110 | 110 | { |
111 | - if($this->isVerboseModeEnabled()) |
|
111 | + if ($this->isVerboseModeEnabled()) |
|
112 | 112 | { |
113 | 113 | curl_setopt($ch, CURLOPT_VERBOSE, true); |
114 | 114 | } |
@@ -118,13 +118,13 @@ discard block |
||
118 | 118 | curl_setopt($ch, CURLOPT_TIMEOUT, $this->getTimeout()); |
119 | 119 | curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); |
120 | 120 | |
121 | - if(!$this->isVerifySSLEnabled()) |
|
121 | + if (!$this->isVerifySSLEnabled()) |
|
122 | 122 | { |
123 | 123 | curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); |
124 | 124 | curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); |
125 | 125 | } |
126 | 126 | |
127 | - if($this->url->hasUsername()) |
|
127 | + if ($this->url->hasUsername()) |
|
128 | 128 | { |
129 | 129 | curl_setopt($ch, CURLOPT_USERNAME, $this->url->getUsername()); |
130 | 130 | curl_setopt($ch, CURLOPT_PASSWORD, $this->url->getPassword()); |
@@ -288,9 +288,9 @@ |
||
288 | 288 | * @param string $extension |
289 | 289 | * @return string|NULL |
290 | 290 | */ |
291 | - public static function getMime(string $extension) :?string |
|
291 | + public static function getMime(string $extension) : ?string |
|
292 | 292 | { |
293 | - if(isset(self::$mimeTypes[$extension])) { |
|
293 | + if (isset(self::$mimeTypes[$extension])) { |
|
294 | 294 | return self::$mimeTypes[$extension]; |
295 | 295 | } |
296 | 296 |
@@ -13,20 +13,20 @@ discard block |
||
13 | 13 | $string = ''; |
14 | 14 | |
15 | 15 | // Simple function call |
16 | - if(is_string($this->value)) |
|
16 | + if (is_string($this->value)) |
|
17 | 17 | { |
18 | 18 | return $this->value.'()'; |
19 | 19 | } |
20 | 20 | |
21 | - if(is_array($this->value)) { |
|
21 | + if (is_array($this->value)) { |
|
22 | 22 | return $this->renderArray(); |
23 | 23 | } |
24 | 24 | |
25 | - if($this->value instanceof NamedClosure) { |
|
25 | + if ($this->value instanceof NamedClosure) { |
|
26 | 26 | return 'Closure:'.$this->value->getOrigin(); |
27 | 27 | } |
28 | 28 | |
29 | - if($this->value instanceof Closure) { |
|
29 | + if ($this->value instanceof Closure) { |
|
30 | 30 | return 'Closure'; |
31 | 31 | } |
32 | 32 | |
@@ -38,9 +38,9 @@ discard block |
||
38 | 38 | $string = ''; |
39 | 39 | |
40 | 40 | if (is_string($this->value[0])) { |
41 | - $string .= $this->value[0] . '::'; |
|
41 | + $string .= $this->value[0].'::'; |
|
42 | 42 | } else { |
43 | - $string .= get_class($this->value[0]) . '->'; |
|
43 | + $string .= get_class($this->value[0]).'->'; |
|
44 | 44 | } |
45 | 45 | |
46 | 46 | $string .= $this->value[1].'()'; |
@@ -74,7 +74,7 @@ discard block |
||
74 | 74 | */ |
75 | 75 | public static function fromClosure(Closure $closure, $origin) : NamedClosure |
76 | 76 | { |
77 | - if(is_object($origin)) { |
|
77 | + if (is_object($origin)) { |
|
78 | 78 | $origin = get_class($origin); |
79 | 79 | } |
80 | 80 | |
@@ -87,7 +87,7 @@ discard block |
||
87 | 87 | * @param string|object $origin Optional origin. If not specified, the object and method name are used instead. |
88 | 88 | * @return NamedClosure |
89 | 89 | */ |
90 | - public static function fromObject(object $object, string $method, $origin='') : NamedClosure |
|
90 | + public static function fromObject(object $object, string $method, $origin = '') : NamedClosure |
|
91 | 91 | { |
92 | 92 | return self::fromArray(array($object, $method), $origin); |
93 | 93 | } |
@@ -97,11 +97,11 @@ discard block |
||
97 | 97 | * @param string|object $origin |
98 | 98 | * @return NamedClosure |
99 | 99 | */ |
100 | - public static function fromArray(array $callback, $origin='') : NamedClosure |
|
100 | + public static function fromArray(array $callback, $origin = '') : NamedClosure |
|
101 | 101 | { |
102 | - if(empty($origin)) { |
|
102 | + if (empty($origin)) { |
|
103 | 103 | $origin = ConvertHelper::callback2string($callback); |
104 | - } else if(is_object($origin)) { |
|
104 | + } else if (is_object($origin)) { |
|
105 | 105 | $origin = get_class($origin); |
106 | 106 | } |
107 | 107 |
@@ -26,9 +26,9 @@ discard block |
||
26 | 26 | */ |
27 | 27 | trait Traits_Optionable |
28 | 28 | { |
29 | - /** |
|
30 | - * @var array |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var array |
|
31 | + */ |
|
32 | 32 | protected $options; |
33 | 33 | |
34 | 34 | /** |
@@ -49,13 +49,13 @@ discard block |
||
49 | 49 | return $this; |
50 | 50 | } |
51 | 51 | |
52 | - /** |
|
53 | - * Sets a collection of options at once, from an |
|
54 | - * associative array. |
|
55 | - * |
|
56 | - * @param array<string,mixed> $options |
|
57 | - * @return $this |
|
58 | - */ |
|
52 | + /** |
|
53 | + * Sets a collection of options at once, from an |
|
54 | + * associative array. |
|
55 | + * |
|
56 | + * @param array<string,mixed> $options |
|
57 | + * @return $this |
|
58 | + */ |
|
59 | 59 | public function setOptions(array $options) |
60 | 60 | { |
61 | 61 | foreach($options as $name => $value) { |
@@ -65,16 +65,16 @@ discard block |
||
65 | 65 | return $this; |
66 | 66 | } |
67 | 67 | |
68 | - /** |
|
69 | - * Retrieves an option's value. |
|
70 | - * |
|
71 | - * NOTE: Use the specialized type getters to ensure an option |
|
72 | - * contains the expected type (for ex. getArrayOption()). |
|
73 | - * |
|
74 | - * @param string $name |
|
75 | - * @param mixed $default The default value to return if the option does not exist. |
|
76 | - * @return mixed |
|
77 | - */ |
|
68 | + /** |
|
69 | + * Retrieves an option's value. |
|
70 | + * |
|
71 | + * NOTE: Use the specialized type getters to ensure an option |
|
72 | + * contains the expected type (for ex. getArrayOption()). |
|
73 | + * |
|
74 | + * @param string $name |
|
75 | + * @param mixed $default The default value to return if the option does not exist. |
|
76 | + * @return mixed |
|
77 | + */ |
|
78 | 78 | public function getOption(string $name, $default=null) |
79 | 79 | { |
80 | 80 | if(!isset($this->options)) { |
@@ -88,16 +88,16 @@ discard block |
||
88 | 88 | return $default; |
89 | 89 | } |
90 | 90 | |
91 | - /** |
|
92 | - * Enforces that the option value is a string. Numbers are converted |
|
93 | - * to string, strings are passed through, and all other types will |
|
94 | - * return the default value. The default value is also returned if |
|
95 | - * the string is empty. |
|
96 | - * |
|
97 | - * @param string $name |
|
98 | - * @param string $default Used if the option does not exist, is invalid, or empty. |
|
99 | - * @return string |
|
100 | - */ |
|
91 | + /** |
|
92 | + * Enforces that the option value is a string. Numbers are converted |
|
93 | + * to string, strings are passed through, and all other types will |
|
94 | + * return the default value. The default value is also returned if |
|
95 | + * the string is empty. |
|
96 | + * |
|
97 | + * @param string $name |
|
98 | + * @param string $default Used if the option does not exist, is invalid, or empty. |
|
99 | + * @return string |
|
100 | + */ |
|
101 | 101 | public function getStringOption(string $name, string $default='') : string |
102 | 102 | { |
103 | 103 | $value = $this->getOption($name, false); |
@@ -128,15 +128,15 @@ discard block |
||
128 | 128 | return $default; |
129 | 129 | } |
130 | 130 | |
131 | - /** |
|
132 | - * Treats the option value as an integer value: will return |
|
133 | - * valid integer values (also from integer strings), or the |
|
134 | - * default value otherwise. |
|
135 | - * |
|
136 | - * @param string $name |
|
137 | - * @param int $default |
|
138 | - * @return int |
|
139 | - */ |
|
131 | + /** |
|
132 | + * Treats the option value as an integer value: will return |
|
133 | + * valid integer values (also from integer strings), or the |
|
134 | + * default value otherwise. |
|
135 | + * |
|
136 | + * @param string $name |
|
137 | + * @param int $default |
|
138 | + * @return int |
|
139 | + */ |
|
140 | 140 | public function getIntOption(string $name, int $default=0) : int |
141 | 141 | { |
142 | 142 | $value = $this->getOption($name); |
@@ -147,14 +147,14 @@ discard block |
||
147 | 147 | return $default; |
148 | 148 | } |
149 | 149 | |
150 | - /** |
|
151 | - * Treats an option as an array, and returns its value |
|
152 | - * only if it contains an array - otherwise, an empty |
|
153 | - * array is returned. |
|
154 | - * |
|
155 | - * @param string $name |
|
156 | - * @return array |
|
157 | - */ |
|
150 | + /** |
|
151 | + * Treats an option as an array, and returns its value |
|
152 | + * only if it contains an array - otherwise, an empty |
|
153 | + * array is returned. |
|
154 | + * |
|
155 | + * @param string $name |
|
156 | + * @return array |
|
157 | + */ |
|
158 | 158 | public function getArrayOption(string $name) : array |
159 | 159 | { |
160 | 160 | $val = $this->getOption($name); |
@@ -165,13 +165,13 @@ discard block |
||
165 | 165 | return array(); |
166 | 166 | } |
167 | 167 | |
168 | - /** |
|
169 | - * Checks whether the specified option exists - even |
|
170 | - * if it has a NULL value. |
|
171 | - * |
|
172 | - * @param string $name |
|
173 | - * @return bool |
|
174 | - */ |
|
168 | + /** |
|
169 | + * Checks whether the specified option exists - even |
|
170 | + * if it has a NULL value. |
|
171 | + * |
|
172 | + * @param string $name |
|
173 | + * @return bool |
|
174 | + */ |
|
175 | 175 | public function hasOption(string $name) : bool |
176 | 176 | { |
177 | 177 | if(!isset($this->options)) { |
@@ -181,11 +181,11 @@ discard block |
||
181 | 181 | return array_key_exists($name, $this->options); |
182 | 182 | } |
183 | 183 | |
184 | - /** |
|
185 | - * Returns all options in one associative array. |
|
186 | - * |
|
187 | - * @return array<string,mixed> |
|
188 | - */ |
|
184 | + /** |
|
185 | + * Returns all options in one associative array. |
|
186 | + * |
|
187 | + * @return array<string,mixed> |
|
188 | + */ |
|
189 | 189 | public function getOptions() : array |
190 | 190 | { |
191 | 191 | if(!isset($this->options)) { |
@@ -195,23 +195,23 @@ discard block |
||
195 | 195 | return $this->options; |
196 | 196 | } |
197 | 197 | |
198 | - /** |
|
199 | - * Checks whether the option's value is the one specified. |
|
200 | - * |
|
201 | - * @param string $name |
|
202 | - * @param mixed $value |
|
203 | - * @return bool |
|
204 | - */ |
|
198 | + /** |
|
199 | + * Checks whether the option's value is the one specified. |
|
200 | + * |
|
201 | + * @param string $name |
|
202 | + * @param mixed $value |
|
203 | + * @return bool |
|
204 | + */ |
|
205 | 205 | public function isOption(string $name, $value) : bool |
206 | 206 | { |
207 | 207 | return $this->getOption($name) === $value; |
208 | 208 | } |
209 | 209 | |
210 | - /** |
|
211 | - * Retrieves the default available options as an |
|
212 | - * associative array with option name => value pairs. |
|
213 | - * |
|
214 | - * @return array<string,mixed> |
|
215 | - */ |
|
210 | + /** |
|
211 | + * Retrieves the default available options as an |
|
212 | + * associative array with option name => value pairs. |
|
213 | + * |
|
214 | + * @return array<string,mixed> |
|
215 | + */ |
|
216 | 216 | abstract public function getDefaultOptions() : array; |
217 | 217 | } |
@@ -41,7 +41,7 @@ discard block |
||
41 | 41 | */ |
42 | 42 | public function setOption(string $name, $value) |
43 | 43 | { |
44 | - if(!isset($this->options)) { |
|
44 | + if (!isset($this->options)) { |
|
45 | 45 | $this->options = $this->getDefaultOptions(); |
46 | 46 | } |
47 | 47 | |
@@ -58,7 +58,7 @@ discard block |
||
58 | 58 | */ |
59 | 59 | public function setOptions(array $options) |
60 | 60 | { |
61 | - foreach($options as $name => $value) { |
|
61 | + foreach ($options as $name => $value) { |
|
62 | 62 | $this->setOption($name, $value); |
63 | 63 | } |
64 | 64 | |
@@ -75,13 +75,13 @@ discard block |
||
75 | 75 | * @param mixed $default The default value to return if the option does not exist. |
76 | 76 | * @return mixed |
77 | 77 | */ |
78 | - public function getOption(string $name, $default=null) |
|
78 | + public function getOption(string $name, $default = null) |
|
79 | 79 | { |
80 | - if(!isset($this->options)) { |
|
80 | + if (!isset($this->options)) { |
|
81 | 81 | $this->options = $this->getDefaultOptions(); |
82 | 82 | } |
83 | 83 | |
84 | - if(isset($this->options[$name])) { |
|
84 | + if (isset($this->options[$name])) { |
|
85 | 85 | return $this->options[$name]; |
86 | 86 | } |
87 | 87 | |
@@ -98,11 +98,11 @@ discard block |
||
98 | 98 | * @param string $default Used if the option does not exist, is invalid, or empty. |
99 | 99 | * @return string |
100 | 100 | */ |
101 | - public function getStringOption(string $name, string $default='') : string |
|
101 | + public function getStringOption(string $name, string $default = '') : string |
|
102 | 102 | { |
103 | 103 | $value = $this->getOption($name, false); |
104 | 104 | |
105 | - if((is_string($value) || is_numeric($value)) && !empty($value)) { |
|
105 | + if ((is_string($value) || is_numeric($value)) && !empty($value)) { |
|
106 | 106 | return (string)$value; |
107 | 107 | } |
108 | 108 | |
@@ -119,9 +119,9 @@ discard block |
||
119 | 119 | * @param bool $default |
120 | 120 | * @return bool |
121 | 121 | */ |
122 | - public function getBoolOption(string $name, bool $default=false) : bool |
|
122 | + public function getBoolOption(string $name, bool $default = false) : bool |
|
123 | 123 | { |
124 | - if($this->getOption($name) === true) { |
|
124 | + if ($this->getOption($name) === true) { |
|
125 | 125 | return true; |
126 | 126 | } |
127 | 127 | |
@@ -137,10 +137,10 @@ discard block |
||
137 | 137 | * @param int $default |
138 | 138 | * @return int |
139 | 139 | */ |
140 | - public function getIntOption(string $name, int $default=0) : int |
|
140 | + public function getIntOption(string $name, int $default = 0) : int |
|
141 | 141 | { |
142 | 142 | $value = $this->getOption($name); |
143 | - if(ConvertHelper::isInteger($value)) { |
|
143 | + if (ConvertHelper::isInteger($value)) { |
|
144 | 144 | return (int)$value; |
145 | 145 | } |
146 | 146 | |
@@ -158,7 +158,7 @@ discard block |
||
158 | 158 | public function getArrayOption(string $name) : array |
159 | 159 | { |
160 | 160 | $val = $this->getOption($name); |
161 | - if(is_array($val)) { |
|
161 | + if (is_array($val)) { |
|
162 | 162 | return $val; |
163 | 163 | } |
164 | 164 | |
@@ -174,7 +174,7 @@ discard block |
||
174 | 174 | */ |
175 | 175 | public function hasOption(string $name) : bool |
176 | 176 | { |
177 | - if(!isset($this->options)) { |
|
177 | + if (!isset($this->options)) { |
|
178 | 178 | $this->options = $this->getDefaultOptions(); |
179 | 179 | } |
180 | 180 | |
@@ -188,7 +188,7 @@ discard block |
||
188 | 188 | */ |
189 | 189 | public function getOptions() : array |
190 | 190 | { |
191 | - if(!isset($this->options)) { |
|
191 | + if (!isset($this->options)) { |
|
192 | 192 | $this->options = $this->getDefaultOptions(); |
193 | 193 | } |
194 | 194 |
@@ -33,24 +33,24 @@ discard block |
||
33 | 33 | */ |
34 | 34 | class StringBuilder implements StringBuilder_Interface |
35 | 35 | { |
36 | - /** |
|
37 | - * @var string |
|
38 | - */ |
|
36 | + /** |
|
37 | + * @var string |
|
38 | + */ |
|
39 | 39 | protected $separator = ' '; |
40 | 40 | |
41 | - /** |
|
42 | - * @var string[] |
|
43 | - */ |
|
41 | + /** |
|
42 | + * @var string[] |
|
43 | + */ |
|
44 | 44 | protected $strings = array(); |
45 | 45 | |
46 | - /** |
|
47 | - * @var string |
|
48 | - */ |
|
46 | + /** |
|
47 | + * @var string |
|
48 | + */ |
|
49 | 49 | protected $mode = 'html'; |
50 | 50 | |
51 | - /** |
|
52 | - * @var string |
|
53 | - */ |
|
51 | + /** |
|
52 | + * @var string |
|
53 | + */ |
|
54 | 54 | protected $noSpace = '§!§'; |
55 | 55 | |
56 | 56 | public function __construct() |
@@ -58,12 +58,12 @@ discard block |
||
58 | 58 | |
59 | 59 | } |
60 | 60 | |
61 | - /** |
|
62 | - * Adds a subject as a string. Is ignored if empty. |
|
63 | - * |
|
64 | - * @param string|number|StringBuilder_Interface $string |
|
65 | - * @return $this |
|
66 | - */ |
|
61 | + /** |
|
62 | + * Adds a subject as a string. Is ignored if empty. |
|
63 | + * |
|
64 | + * @param string|number|StringBuilder_Interface $string |
|
65 | + * @return $this |
|
66 | + */ |
|
67 | 67 | public function add($string) : StringBuilder |
68 | 68 | { |
69 | 69 | $string = strval($string); |
@@ -76,57 +76,57 @@ discard block |
||
76 | 76 | return $this; |
77 | 77 | } |
78 | 78 | |
79 | - /** |
|
80 | - * Adds a string without appending an automatic space. |
|
81 | - * |
|
82 | - * @param string|number|StringBuilder_Interface $string |
|
83 | - * @return $this |
|
84 | - */ |
|
79 | + /** |
|
80 | + * Adds a string without appending an automatic space. |
|
81 | + * |
|
82 | + * @param string|number|StringBuilder_Interface $string |
|
83 | + * @return $this |
|
84 | + */ |
|
85 | 85 | public function nospace($string) : StringBuilder |
86 | 86 | { |
87 | 87 | return $this->add($this->noSpace.strval($string)); |
88 | 88 | } |
89 | 89 | |
90 | - /** |
|
91 | - * Adds raw HTML code. Does not add an automatic space. |
|
92 | - * |
|
93 | - * @param string|number|StringBuilder_Interface $html |
|
94 | - * @return $this |
|
95 | - */ |
|
90 | + /** |
|
91 | + * Adds raw HTML code. Does not add an automatic space. |
|
92 | + * |
|
93 | + * @param string|number|StringBuilder_Interface $html |
|
94 | + * @return $this |
|
95 | + */ |
|
96 | 96 | public function html($html) : StringBuilder |
97 | 97 | { |
98 | 98 | return $this->nospace($html); |
99 | 99 | } |
100 | 100 | |
101 | - /** |
|
102 | - * Adds an unordered list with the specified items. |
|
103 | - * |
|
104 | - * @param array<int,string|number|StringBuilder_Interface> $items |
|
105 | - * @return $this |
|
106 | - */ |
|
101 | + /** |
|
102 | + * Adds an unordered list with the specified items. |
|
103 | + * |
|
104 | + * @param array<int,string|number|StringBuilder_Interface> $items |
|
105 | + * @return $this |
|
106 | + */ |
|
107 | 107 | public function ul(array $items) : StringBuilder |
108 | 108 | { |
109 | 109 | return $this->list('ul', $items); |
110 | 110 | } |
111 | 111 | |
112 | - /** |
|
113 | - * Adds an ordered list with the specified items. |
|
114 | - * |
|
115 | - * @param array<int,string|number|StringBuilder_Interface> $items |
|
116 | - * @return $this |
|
117 | - */ |
|
112 | + /** |
|
113 | + * Adds an ordered list with the specified items. |
|
114 | + * |
|
115 | + * @param array<int,string|number|StringBuilder_Interface> $items |
|
116 | + * @return $this |
|
117 | + */ |
|
118 | 118 | public function ol(array $items) : StringBuilder |
119 | 119 | { |
120 | 120 | return $this->list('ol', $items); |
121 | 121 | } |
122 | 122 | |
123 | - /** |
|
124 | - * Creates a list tag with the items list. |
|
125 | - * |
|
126 | - * @param string $type The list type, `ol` or `ul`. |
|
127 | - * @param array<int,string|number|StringBuilder_Interface> $items |
|
128 | - * @return $this |
|
129 | - */ |
|
123 | + /** |
|
124 | + * Creates a list tag with the items list. |
|
125 | + * |
|
126 | + * @param string $type The list type, `ol` or `ul`. |
|
127 | + * @param array<int,string|number|StringBuilder_Interface> $items |
|
128 | + * @return $this |
|
129 | + */ |
|
130 | 130 | protected function list(string $type, array $items) : StringBuilder |
131 | 131 | { |
132 | 132 | return $this->html(sprintf( |
@@ -136,13 +136,13 @@ discard block |
||
136 | 136 | )); |
137 | 137 | } |
138 | 138 | |
139 | - /** |
|
140 | - * Add a translated string. |
|
141 | - * |
|
142 | - * @param string $format The native string to translate. |
|
143 | - * @param array<int,mixed> $arguments The variables to inject into the translated string, if any. |
|
144 | - * @return $this |
|
145 | - */ |
|
139 | + /** |
|
140 | + * Add a translated string. |
|
141 | + * |
|
142 | + * @param string $format The native string to translate. |
|
143 | + * @param array<int,mixed> $arguments The variables to inject into the translated string, if any. |
|
144 | + * @return $this |
|
145 | + */ |
|
146 | 146 | public function t(string $format, ...$arguments) : StringBuilder |
147 | 147 | { |
148 | 148 | array_unshift($arguments, $format); |
@@ -158,47 +158,47 @@ discard block |
||
158 | 158 | )); |
159 | 159 | } |
160 | 160 | |
161 | - /** |
|
162 | - * Adds a "5 months ago" age since the specified date. |
|
163 | - * |
|
164 | - * @param DateTime $since |
|
165 | - * @return $this |
|
166 | - */ |
|
161 | + /** |
|
162 | + * Adds a "5 months ago" age since the specified date. |
|
163 | + * |
|
164 | + * @param DateTime $since |
|
165 | + * @return $this |
|
166 | + */ |
|
167 | 167 | public function age(DateTime $since) : StringBuilder |
168 | 168 | { |
169 | 169 | return $this->add(ConvertHelper::duration2string($since)); |
170 | 170 | } |
171 | 171 | |
172 | - /** |
|
173 | - * Adds HTML quotes around the string. |
|
174 | - * |
|
175 | - * @param string|number|StringBuilder_Interface $string |
|
176 | - * @return $this |
|
177 | - */ |
|
172 | + /** |
|
173 | + * Adds HTML quotes around the string. |
|
174 | + * |
|
175 | + * @param string|number|StringBuilder_Interface $string |
|
176 | + * @return $this |
|
177 | + */ |
|
178 | 178 | public function quote($string) |
179 | 179 | { |
180 | 180 | return $this->sf('"%s"', strval($string)); |
181 | 181 | } |
182 | 182 | |
183 | - /** |
|
184 | - * Adds a text that is meant as a reference to an UI element, |
|
185 | - * like a menu item, button, etc. |
|
186 | - * |
|
187 | - * @param string|number|StringBuilder_Interface $string |
|
188 | - * @return $this |
|
189 | - */ |
|
183 | + /** |
|
184 | + * Adds a text that is meant as a reference to an UI element, |
|
185 | + * like a menu item, button, etc. |
|
186 | + * |
|
187 | + * @param string|number|StringBuilder_Interface $string |
|
188 | + * @return $this |
|
189 | + */ |
|
190 | 190 | public function reference($string) : StringBuilder |
191 | 191 | { |
192 | 192 | return $this->sf('"%s"', $string); |
193 | 193 | } |
194 | 194 | |
195 | - /** |
|
196 | - * Add a string using the `sprintf` method. |
|
197 | - * |
|
198 | - * @param string $format The format string |
|
199 | - * @param string|number|StringBuilder_Interface ...$arguments The variables to inject |
|
200 | - * @return $this |
|
201 | - */ |
|
195 | + /** |
|
196 | + * Add a string using the `sprintf` method. |
|
197 | + * |
|
198 | + * @param string $format The format string |
|
199 | + * @param string|number|StringBuilder_Interface ...$arguments The variables to inject |
|
200 | + * @return $this |
|
201 | + */ |
|
202 | 202 | public function sf(string $format, ...$arguments) : StringBuilder |
203 | 203 | { |
204 | 204 | array_unshift($arguments, $format); |
@@ -206,12 +206,12 @@ discard block |
||
206 | 206 | return $this->add(call_user_func_array('sprintf', $arguments)); |
207 | 207 | } |
208 | 208 | |
209 | - /** |
|
210 | - * Adds a bold string. |
|
211 | - * |
|
212 | - * @param string|number|StringBuilder_Interface $string |
|
213 | - * @return $this |
|
214 | - */ |
|
209 | + /** |
|
210 | + * Adds a bold string. |
|
211 | + * |
|
212 | + * @param string|number|StringBuilder_Interface $string |
|
213 | + * @return $this |
|
214 | + */ |
|
215 | 215 | public function bold($string) : StringBuilder |
216 | 216 | { |
217 | 217 | return $this->sf( |
@@ -220,12 +220,12 @@ discard block |
||
220 | 220 | ); |
221 | 221 | } |
222 | 222 | |
223 | - /** |
|
224 | - * Adds a HTML `br` tag. |
|
225 | - * |
|
226 | - * @return $this |
|
227 | - * @see StringBuilder::eol() |
|
228 | - */ |
|
223 | + /** |
|
224 | + * Adds a HTML `br` tag. |
|
225 | + * |
|
226 | + * @return $this |
|
227 | + * @see StringBuilder::eol() |
|
228 | + */ |
|
229 | 229 | public function nl() : StringBuilder |
230 | 230 | { |
231 | 231 | return $this->html('<br>'); |
@@ -242,41 +242,41 @@ discard block |
||
242 | 242 | return $this->nospace(PHP_EOL); |
243 | 243 | } |
244 | 244 | |
245 | - /** |
|
246 | - * Adds the current time, in the format <code>H:i:s</code>. |
|
247 | - * |
|
248 | - * @return $this |
|
249 | - */ |
|
245 | + /** |
|
246 | + * Adds the current time, in the format <code>H:i:s</code>. |
|
247 | + * |
|
248 | + * @return $this |
|
249 | + */ |
|
250 | 250 | public function time() : StringBuilder |
251 | 251 | { |
252 | 252 | return $this->add(date('H:i:s')); |
253 | 253 | } |
254 | 254 | |
255 | - /** |
|
256 | - * Adds the "Note:" text. |
|
257 | - * |
|
258 | - * @return $this |
|
259 | - */ |
|
255 | + /** |
|
256 | + * Adds the "Note:" text. |
|
257 | + * |
|
258 | + * @return $this |
|
259 | + */ |
|
260 | 260 | public function note() : StringBuilder |
261 | 261 | { |
262 | 262 | return $this->t('Note:'); |
263 | 263 | } |
264 | 264 | |
265 | - /** |
|
266 | - * Like `note()`, but as bold text. |
|
267 | - * |
|
268 | - * @return $this |
|
269 | - */ |
|
265 | + /** |
|
266 | + * Like `note()`, but as bold text. |
|
267 | + * |
|
268 | + * @return $this |
|
269 | + */ |
|
270 | 270 | public function noteBold() : StringBuilder |
271 | 271 | { |
272 | 272 | return $this->bold(sb()->note()); |
273 | 273 | } |
274 | 274 | |
275 | - /** |
|
276 | - * Adds the "Hint:" text. |
|
277 | - * |
|
278 | - * @return $this |
|
279 | - */ |
|
275 | + /** |
|
276 | + * Adds the "Hint:" text. |
|
277 | + * |
|
278 | + * @return $this |
|
279 | + */ |
|
280 | 280 | public function hint() : StringBuilder |
281 | 281 | { |
282 | 282 | return $this->t('Hint:'); |
@@ -287,12 +287,12 @@ discard block |
||
287 | 287 | return $this->bold(sb()->hint()); |
288 | 288 | } |
289 | 289 | |
290 | - /** |
|
291 | - * Adds two linebreaks. |
|
292 | - * |
|
293 | - * @param StringBuilder_Interface|string|NULL $content |
|
294 | - * @return $this |
|
295 | - */ |
|
290 | + /** |
|
291 | + * Adds two linebreaks. |
|
292 | + * |
|
293 | + * @param StringBuilder_Interface|string|NULL $content |
|
294 | + * @return $this |
|
295 | + */ |
|
296 | 296 | public function para($content=null) : StringBuilder |
297 | 297 | { |
298 | 298 | if($content !== null) { |
@@ -302,14 +302,14 @@ discard block |
||
302 | 302 | return $this->nl()->nl(); |
303 | 303 | } |
304 | 304 | |
305 | - /** |
|
306 | - * Adds an anchor HTML tag. |
|
307 | - * |
|
308 | - * @param string $label |
|
309 | - * @param string $url |
|
310 | - * @param bool $newTab |
|
311 | - * @return $this |
|
312 | - */ |
|
305 | + /** |
|
306 | + * Adds an anchor HTML tag. |
|
307 | + * |
|
308 | + * @param string $label |
|
309 | + * @param string $url |
|
310 | + * @param bool $newTab |
|
311 | + * @return $this |
|
312 | + */ |
|
313 | 313 | public function link(string $label, string $url, bool $newTab=false) : StringBuilder |
314 | 314 | { |
315 | 315 | $target = ''; |
@@ -325,12 +325,12 @@ discard block |
||
325 | 325 | ); |
326 | 326 | } |
327 | 327 | |
328 | - /** |
|
329 | - * Wraps the string in a `code` tag. |
|
330 | - * |
|
331 | - * @param string|number|StringBuilder_Interface $string |
|
332 | - * @return $this |
|
333 | - */ |
|
328 | + /** |
|
329 | + * Wraps the string in a `code` tag. |
|
330 | + * |
|
331 | + * @param string|number|StringBuilder_Interface $string |
|
332 | + * @return $this |
|
333 | + */ |
|
334 | 334 | public function code($string) : StringBuilder |
335 | 335 | { |
336 | 336 | return $this->sf( |
@@ -339,24 +339,24 @@ discard block |
||
339 | 339 | ); |
340 | 340 | } |
341 | 341 | |
342 | - /** |
|
343 | - * Wraps the string in a `pre` tag. |
|
344 | - * |
|
345 | - * @param string|number|StringBuilder_Interface $string |
|
346 | - * @return $this |
|
347 | - */ |
|
342 | + /** |
|
343 | + * Wraps the string in a `pre` tag. |
|
344 | + * |
|
345 | + * @param string|number|StringBuilder_Interface $string |
|
346 | + * @return $this |
|
347 | + */ |
|
348 | 348 | public function pre($string) : StringBuilder |
349 | 349 | { |
350 | 350 | return $this->sf('<pre>%s</pre>', strval($string)); |
351 | 351 | } |
352 | 352 | |
353 | - /** |
|
354 | - * Wraps the text in a `span` tag with the specified classes. |
|
355 | - * |
|
356 | - * @param string|number|StringBuilder_Interface $string |
|
357 | - * @param string|string[] $classes |
|
358 | - * @return $this |
|
359 | - */ |
|
353 | + /** |
|
354 | + * Wraps the text in a `span` tag with the specified classes. |
|
355 | + * |
|
356 | + * @param string|number|StringBuilder_Interface $string |
|
357 | + * @param string|string[] $classes |
|
358 | + * @return $this |
|
359 | + */ |
|
360 | 360 | public function spanned($string, $classes) : StringBuilder |
361 | 361 | { |
362 | 362 | if(!is_array($classes)) |
@@ -68,7 +68,7 @@ discard block |
||
68 | 68 | { |
69 | 69 | $string = strval($string); |
70 | 70 | |
71 | - if(!empty($string)) |
|
71 | + if (!empty($string)) |
|
72 | 72 | { |
73 | 73 | $this->strings[] = $string; |
74 | 74 | } |
@@ -147,7 +147,7 @@ discard block |
||
147 | 147 | { |
148 | 148 | array_unshift($arguments, $format); |
149 | 149 | |
150 | - if(!class_exists('\AppLocalize\Localization')) |
|
150 | + if (!class_exists('\AppLocalize\Localization')) |
|
151 | 151 | { |
152 | 152 | return $this->sf(...$arguments); |
153 | 153 | } |
@@ -293,9 +293,9 @@ discard block |
||
293 | 293 | * @param StringBuilder_Interface|string|NULL $content |
294 | 294 | * @return $this |
295 | 295 | */ |
296 | - public function para($content=null) : StringBuilder |
|
296 | + public function para($content = null) : StringBuilder |
|
297 | 297 | { |
298 | - if($content !== null) { |
|
298 | + if ($content !== null) { |
|
299 | 299 | return $this->html('<p>')->nospace($content)->html('</p>'); |
300 | 300 | } |
301 | 301 | |
@@ -310,10 +310,10 @@ discard block |
||
310 | 310 | * @param bool $newTab |
311 | 311 | * @return $this |
312 | 312 | */ |
313 | - public function link(string $label, string $url, bool $newTab=false) : StringBuilder |
|
313 | + public function link(string $label, string $url, bool $newTab = false) : StringBuilder |
|
314 | 314 | { |
315 | 315 | $target = ''; |
316 | - if($newTab) { |
|
316 | + if ($newTab) { |
|
317 | 317 | $target = ' target="_blank"'; |
318 | 318 | } |
319 | 319 | |
@@ -359,7 +359,7 @@ discard block |
||
359 | 359 | */ |
360 | 360 | public function spanned($string, $classes) : StringBuilder |
361 | 361 | { |
362 | - if(!is_array($classes)) |
|
362 | + if (!is_array($classes)) |
|
363 | 363 | { |
364 | 364 | $classes = array(strval($classes)); |
365 | 365 | } |
@@ -45,7 +45,7 @@ |
||
45 | 45 | * @param mixed $default The default value to return if the option does not exist. |
46 | 46 | * @return mixed |
47 | 47 | */ |
48 | - function getOption(string $name, $default=null); |
|
48 | + function getOption(string $name, $default = null); |
|
49 | 49 | |
50 | 50 | /** |
51 | 51 | * Sets a collection of options at once, from an |
@@ -34,42 +34,42 @@ discard block |
||
34 | 34 | const TYPE_PHONE = 'phone'; |
35 | 35 | const TYPE_URL = 'url'; |
36 | 36 | |
37 | - /** |
|
38 | - * The original URL that was passed to the constructor. |
|
39 | - * @var string |
|
40 | - */ |
|
37 | + /** |
|
38 | + * The original URL that was passed to the constructor. |
|
39 | + * @var string |
|
40 | + */ |
|
41 | 41 | protected $rawURL; |
42 | 42 | |
43 | - /** |
|
44 | - * @var array |
|
45 | - */ |
|
43 | + /** |
|
44 | + * @var array |
|
45 | + */ |
|
46 | 46 | protected $info; |
47 | 47 | |
48 | - /** |
|
49 | - * @var string[] |
|
50 | - */ |
|
48 | + /** |
|
49 | + * @var string[] |
|
50 | + */ |
|
51 | 51 | protected $excludedParams = array(); |
52 | 52 | |
53 | - /** |
|
54 | - * @var bool |
|
55 | - * @see URLInfo::setParamExclusion() |
|
56 | - */ |
|
53 | + /** |
|
54 | + * @var bool |
|
55 | + * @see URLInfo::setParamExclusion() |
|
56 | + */ |
|
57 | 57 | protected $paramExclusion = false; |
58 | 58 | |
59 | - /** |
|
60 | - * @var array |
|
61 | - * @see URLInfo::getTypeLabel() |
|
62 | - */ |
|
59 | + /** |
|
60 | + * @var array |
|
61 | + * @see URLInfo::getTypeLabel() |
|
62 | + */ |
|
63 | 63 | protected static $typeLabels; |
64 | 64 | |
65 | - /** |
|
66 | - * @var bool |
|
67 | - */ |
|
65 | + /** |
|
66 | + * @var bool |
|
67 | + */ |
|
68 | 68 | protected $highlightExcluded = false; |
69 | 69 | |
70 | - /** |
|
71 | - * @var array |
|
72 | - */ |
|
70 | + /** |
|
71 | + * @var array |
|
72 | + */ |
|
73 | 73 | protected $infoKeys = array( |
74 | 74 | 'scheme', |
75 | 75 | 'host', |
@@ -81,24 +81,24 @@ discard block |
||
81 | 81 | 'fragment' |
82 | 82 | ); |
83 | 83 | |
84 | - /** |
|
85 | - * @var string |
|
86 | - */ |
|
84 | + /** |
|
85 | + * @var string |
|
86 | + */ |
|
87 | 87 | protected $url; |
88 | 88 | |
89 | - /** |
|
90 | - * @var URLInfo_Parser |
|
91 | - */ |
|
89 | + /** |
|
90 | + * @var URLInfo_Parser |
|
91 | + */ |
|
92 | 92 | protected $parser; |
93 | 93 | |
94 | - /** |
|
95 | - * @var URLInfo_Normalizer |
|
96 | - */ |
|
94 | + /** |
|
95 | + * @var URLInfo_Normalizer |
|
96 | + */ |
|
97 | 97 | protected $normalizer; |
98 | 98 | |
99 | - /** |
|
100 | - * @var bool |
|
101 | - */ |
|
99 | + /** |
|
100 | + * @var bool |
|
101 | + */ |
|
102 | 102 | protected $encodeUTFChars = false; |
103 | 103 | |
104 | 104 | public function __construct(string $url) |
@@ -115,14 +115,14 @@ discard block |
||
115 | 115 | $this->info = $this->parser->getInfo(); |
116 | 116 | } |
117 | 117 | |
118 | - /** |
|
119 | - * Whether to URL encode any non-encoded UTF8 characters in the URL. |
|
120 | - * Default is to leave them as-is for better readability, since |
|
121 | - * browsers handle this well. |
|
122 | - * |
|
123 | - * @param bool $enabled |
|
124 | - * @return URLInfo |
|
125 | - */ |
|
118 | + /** |
|
119 | + * Whether to URL encode any non-encoded UTF8 characters in the URL. |
|
120 | + * Default is to leave them as-is for better readability, since |
|
121 | + * browsers handle this well. |
|
122 | + * |
|
123 | + * @param bool $enabled |
|
124 | + * @return URLInfo |
|
125 | + */ |
|
126 | 126 | public function setUTFEncoding(bool $enabled=true) : URLInfo |
127 | 127 | { |
128 | 128 | if($this->encodeUTFChars !== $enabled) |
@@ -139,13 +139,13 @@ discard block |
||
139 | 139 | return $this->encodeUTFChars; |
140 | 140 | } |
141 | 141 | |
142 | - /** |
|
143 | - * Filters an URL: removes control characters and the |
|
144 | - * like to have a clean URL to work with. |
|
145 | - * |
|
146 | - * @param string $url |
|
147 | - * @return string |
|
148 | - */ |
|
142 | + /** |
|
143 | + * Filters an URL: removes control characters and the |
|
144 | + * like to have a clean URL to work with. |
|
145 | + * |
|
146 | + * @param string $url |
|
147 | + * @return string |
|
148 | + */ |
|
149 | 149 | public static function filterURL(string $url) |
150 | 150 | { |
151 | 151 | return URLInfo_Filter::filter($url); |
@@ -175,12 +175,12 @@ discard block |
||
175 | 175 | return $this->info['type'] === self::TYPE_PHONE; |
176 | 176 | } |
177 | 177 | |
178 | - /** |
|
179 | - * Whether the URL is a regular URL, not one of the |
|
180 | - * other types like a phone number or email address. |
|
181 | - * |
|
182 | - * @return bool |
|
183 | - */ |
|
178 | + /** |
|
179 | + * Whether the URL is a regular URL, not one of the |
|
180 | + * other types like a phone number or email address. |
|
181 | + * |
|
182 | + * @return bool |
|
183 | + */ |
|
184 | 184 | public function isURL() : bool |
185 | 185 | { |
186 | 186 | $host = $this->getHost(); |
@@ -192,20 +192,20 @@ discard block |
||
192 | 192 | return $this->parser->isValid(); |
193 | 193 | } |
194 | 194 | |
195 | - /** |
|
196 | - * Retrieves the host name, or an empty string if none is present. |
|
197 | - * |
|
198 | - * @return string |
|
199 | - */ |
|
195 | + /** |
|
196 | + * Retrieves the host name, or an empty string if none is present. |
|
197 | + * |
|
198 | + * @return string |
|
199 | + */ |
|
200 | 200 | public function getHost() : string |
201 | 201 | { |
202 | 202 | return $this->getInfoKey('host'); |
203 | 203 | } |
204 | 204 | |
205 | - /** |
|
206 | - * Retrieves the path, or an empty string if none is present. |
|
207 | - * @return string |
|
208 | - */ |
|
205 | + /** |
|
206 | + * Retrieves the path, or an empty string if none is present. |
|
207 | + * @return string |
|
208 | + */ |
|
209 | 209 | public function getPath() : string |
210 | 210 | { |
211 | 211 | return $this->getInfoKey('path'); |
@@ -221,10 +221,10 @@ discard block |
||
221 | 221 | return $this->getInfoKey('scheme'); |
222 | 222 | } |
223 | 223 | |
224 | - /** |
|
225 | - * Retrieves the port specified in the URL, or -1 if none is preseent. |
|
226 | - * @return int |
|
227 | - */ |
|
224 | + /** |
|
225 | + * Retrieves the port specified in the URL, or -1 if none is preseent. |
|
226 | + * @return int |
|
227 | + */ |
|
228 | 228 | public function getPort() : int |
229 | 229 | { |
230 | 230 | $port = $this->getInfoKey('port'); |
@@ -236,13 +236,13 @@ discard block |
||
236 | 236 | return -1; |
237 | 237 | } |
238 | 238 | |
239 | - /** |
|
240 | - * Retrieves the raw query string, or an empty string if none is present. |
|
241 | - * |
|
242 | - * @return string |
|
243 | - * |
|
244 | - * @see URLInfo::getParams() |
|
245 | - */ |
|
239 | + /** |
|
240 | + * Retrieves the raw query string, or an empty string if none is present. |
|
241 | + * |
|
242 | + * @return string |
|
243 | + * |
|
244 | + * @see URLInfo::getParams() |
|
245 | + */ |
|
246 | 246 | public function getQuery() : string |
247 | 247 | { |
248 | 248 | return $this->getInfoKey('query'); |
@@ -258,20 +258,20 @@ discard block |
||
258 | 258 | return $this->getInfoKey('pass'); |
259 | 259 | } |
260 | 260 | |
261 | - /** |
|
262 | - * Whether the URL contains a port number. |
|
263 | - * @return bool |
|
264 | - */ |
|
261 | + /** |
|
262 | + * Whether the URL contains a port number. |
|
263 | + * @return bool |
|
264 | + */ |
|
265 | 265 | public function hasPort() : bool |
266 | 266 | { |
267 | 267 | return $this->getPort() !== -1; |
268 | 268 | } |
269 | 269 | |
270 | - /** |
|
271 | - * Alias for the hasParams() method. |
|
272 | - * @return bool |
|
273 | - * @see URLInfo::hasParams() |
|
274 | - */ |
|
270 | + /** |
|
271 | + * Alias for the hasParams() method. |
|
272 | + * @return bool |
|
273 | + * @see URLInfo::hasParams() |
|
274 | + */ |
|
275 | 275 | public function hasQuery() : bool |
276 | 276 | { |
277 | 277 | return $this->hasParams(); |
@@ -316,23 +316,23 @@ discard block |
||
316 | 316 | return ''; |
317 | 317 | } |
318 | 318 | |
319 | - /** |
|
320 | - * Retrieves a normalized URL: this ensures that all parameters |
|
321 | - * in the URL are always in the same order. |
|
322 | - * |
|
323 | - * @return string |
|
324 | - */ |
|
319 | + /** |
|
320 | + * Retrieves a normalized URL: this ensures that all parameters |
|
321 | + * in the URL are always in the same order. |
|
322 | + * |
|
323 | + * @return string |
|
324 | + */ |
|
325 | 325 | public function getNormalized() : string |
326 | 326 | { |
327 | 327 | return $this->normalize(true); |
328 | 328 | } |
329 | 329 | |
330 | - /** |
|
331 | - * Like getNormalized(), but if a username and password are present |
|
332 | - * in the URL, returns the URL without them. |
|
333 | - * |
|
334 | - * @return string |
|
335 | - */ |
|
330 | + /** |
|
331 | + * Like getNormalized(), but if a username and password are present |
|
332 | + * in the URL, returns the URL without them. |
|
333 | + * |
|
334 | + * @return string |
|
335 | + */ |
|
336 | 336 | public function getNormalizedWithoutAuth() : string |
337 | 337 | { |
338 | 338 | return $this->normalize(false); |
@@ -353,25 +353,25 @@ discard block |
||
353 | 353 | return $this->normalizer->normalize(); |
354 | 354 | } |
355 | 355 | |
356 | - /** |
|
357 | - * Creates a hash of the URL, which can be used for comparisons. |
|
358 | - * Since any parameters in the URL's query are sorted alphabetically, |
|
359 | - * the same links with a different parameter order will have the |
|
360 | - * same hash. |
|
361 | - * |
|
362 | - * @return string |
|
363 | - */ |
|
356 | + /** |
|
357 | + * Creates a hash of the URL, which can be used for comparisons. |
|
358 | + * Since any parameters in the URL's query are sorted alphabetically, |
|
359 | + * the same links with a different parameter order will have the |
|
360 | + * same hash. |
|
361 | + * |
|
362 | + * @return string |
|
363 | + */ |
|
364 | 364 | public function getHash() |
365 | 365 | { |
366 | 366 | return \AppUtils\ConvertHelper::string2shortHash($this->getNormalized()); |
367 | 367 | } |
368 | 368 | |
369 | - /** |
|
370 | - * Highlights the URL using HTML tags with specific highlighting |
|
371 | - * class names. |
|
372 | - * |
|
373 | - * @return string Will return an empty string if the URL is not valid. |
|
374 | - */ |
|
369 | + /** |
|
370 | + * Highlights the URL using HTML tags with specific highlighting |
|
371 | + * class names. |
|
372 | + * |
|
373 | + * @return string Will return an empty string if the URL is not valid. |
|
374 | + */ |
|
375 | 375 | public function getHighlighted() : string |
376 | 376 | { |
377 | 377 | if(!$this->isValid()) { |
@@ -405,15 +405,15 @@ discard block |
||
405 | 405 | return count($params); |
406 | 406 | } |
407 | 407 | |
408 | - /** |
|
409 | - * Retrieves all parameters specified in the url, |
|
410 | - * if any, as an associative array. |
|
411 | - * |
|
412 | - * NOTE: Ignores parameters that have been added |
|
413 | - * to the excluded parameters list. |
|
414 | - * |
|
415 | - * @return array |
|
416 | - */ |
|
408 | + /** |
|
409 | + * Retrieves all parameters specified in the url, |
|
410 | + * if any, as an associative array. |
|
411 | + * |
|
412 | + * NOTE: Ignores parameters that have been added |
|
413 | + * to the excluded parameters list. |
|
414 | + * |
|
415 | + * @return array |
|
416 | + */ |
|
417 | 417 | public function getParams() : array |
418 | 418 | { |
419 | 419 | if(!$this->paramExclusion || empty($this->excludedParams)) { |
@@ -431,22 +431,22 @@ discard block |
||
431 | 431 | return $keep; |
432 | 432 | } |
433 | 433 | |
434 | - /** |
|
435 | - * Retrieves the names of all parameters present in the URL, if any. |
|
436 | - * @return string[] |
|
437 | - */ |
|
434 | + /** |
|
435 | + * Retrieves the names of all parameters present in the URL, if any. |
|
436 | + * @return string[] |
|
437 | + */ |
|
438 | 438 | public function getParamNames() : array |
439 | 439 | { |
440 | 440 | $params = $this->getParams(); |
441 | 441 | return array_keys($params); |
442 | 442 | } |
443 | 443 | |
444 | - /** |
|
445 | - * Retrieves a specific parameter value from the URL. |
|
446 | - * |
|
447 | - * @param string $name |
|
448 | - * @return string The parameter value, or an empty string if it does not exist. |
|
449 | - */ |
|
444 | + /** |
|
445 | + * Retrieves a specific parameter value from the URL. |
|
446 | + * |
|
447 | + * @param string $name |
|
448 | + * @return string The parameter value, or an empty string if it does not exist. |
|
449 | + */ |
|
450 | 450 | public function getParam(string $name) : string |
451 | 451 | { |
452 | 452 | if(isset($this->info['params'][$name])) { |
@@ -456,16 +456,16 @@ discard block |
||
456 | 456 | return ''; |
457 | 457 | } |
458 | 458 | |
459 | - /** |
|
460 | - * Excludes an URL parameter entirely if present: |
|
461 | - * the parser will act as if the parameter was not |
|
462 | - * even present in the source URL, effectively |
|
463 | - * stripping it. |
|
464 | - * |
|
465 | - * @param string $name |
|
466 | - * @param string $reason A human readable explanation why this is excluded - used when highlighting links. |
|
467 | - * @return URLInfo |
|
468 | - */ |
|
459 | + /** |
|
460 | + * Excludes an URL parameter entirely if present: |
|
461 | + * the parser will act as if the parameter was not |
|
462 | + * even present in the source URL, effectively |
|
463 | + * stripping it. |
|
464 | + * |
|
465 | + * @param string $name |
|
466 | + * @param string $reason A human readable explanation why this is excluded - used when highlighting links. |
|
467 | + * @return URLInfo |
|
468 | + */ |
|
469 | 469 | public function excludeParam(string $name, string $reason='') : URLInfo |
470 | 470 | { |
471 | 471 | if(!isset($this->excludedParams[$name])) |
@@ -518,25 +518,25 @@ discard block |
||
518 | 518 | return self::$typeLabels[$this->getType()]; |
519 | 519 | } |
520 | 520 | |
521 | - /** |
|
522 | - * Whether excluded parameters should be highlighted in |
|
523 | - * a different color in the URL when using the |
|
524 | - * {@link URLInfo::getHighlighted()} method. |
|
525 | - * |
|
526 | - * @param bool $highlight |
|
527 | - * @return URLInfo |
|
528 | - */ |
|
521 | + /** |
|
522 | + * Whether excluded parameters should be highlighted in |
|
523 | + * a different color in the URL when using the |
|
524 | + * {@link URLInfo::getHighlighted()} method. |
|
525 | + * |
|
526 | + * @param bool $highlight |
|
527 | + * @return URLInfo |
|
528 | + */ |
|
529 | 529 | public function setHighlightExcluded(bool $highlight=true) : URLInfo |
530 | 530 | { |
531 | 531 | $this->highlightExcluded = $highlight; |
532 | 532 | return $this; |
533 | 533 | } |
534 | 534 | |
535 | - /** |
|
536 | - * Returns an array with all relevant URL information. |
|
537 | - * |
|
538 | - * @return array |
|
539 | - */ |
|
535 | + /** |
|
536 | + * Returns an array with all relevant URL information. |
|
537 | + * |
|
538 | + * @return array |
|
539 | + */ |
|
540 | 540 | public function toArray() : array |
541 | 541 | { |
542 | 542 | return array( |
@@ -580,24 +580,24 @@ discard block |
||
580 | 580 | return $this; |
581 | 581 | } |
582 | 582 | |
583 | - /** |
|
584 | - * Whether the parameter exclusion mode is enabled: |
|
585 | - * In this case, if any parameters have been added to the |
|
586 | - * exclusion list, all relevant methods will exclude these. |
|
587 | - * |
|
588 | - * @return bool |
|
589 | - */ |
|
583 | + /** |
|
584 | + * Whether the parameter exclusion mode is enabled: |
|
585 | + * In this case, if any parameters have been added to the |
|
586 | + * exclusion list, all relevant methods will exclude these. |
|
587 | + * |
|
588 | + * @return bool |
|
589 | + */ |
|
590 | 590 | public function isParamExclusionEnabled() : bool |
591 | 591 | { |
592 | 592 | return $this->paramExclusion; |
593 | 593 | } |
594 | 594 | |
595 | - /** |
|
596 | - * Checks whether the link contains any parameters that |
|
597 | - * are on the list of excluded parameters. |
|
598 | - * |
|
599 | - * @return bool |
|
600 | - */ |
|
595 | + /** |
|
596 | + * Checks whether the link contains any parameters that |
|
597 | + * are on the list of excluded parameters. |
|
598 | + * |
|
599 | + * @return bool |
|
600 | + */ |
|
601 | 601 | public function containsExcludedParams() : bool |
602 | 602 | { |
603 | 603 | if(empty($this->excludedParams)) { |
@@ -665,16 +665,16 @@ discard block |
||
665 | 665 | return $this->highlightExcluded; |
666 | 666 | } |
667 | 667 | |
668 | - /** |
|
669 | - * Checks if the URL exists, i.e. can be connected to. Will return |
|
670 | - * true if the returned HTTP status code is `200` or `302`. |
|
671 | - * |
|
672 | - * NOTE: If the target URL requires HTTP authentication, the username |
|
673 | - * and password should be integrated into the URL. |
|
674 | - * |
|
675 | - * @return bool |
|
676 | - * @throws BaseException |
|
677 | - */ |
|
668 | + /** |
|
669 | + * Checks if the URL exists, i.e. can be connected to. Will return |
|
670 | + * true if the returned HTTP status code is `200` or `302`. |
|
671 | + * |
|
672 | + * NOTE: If the target URL requires HTTP authentication, the username |
|
673 | + * and password should be integrated into the URL. |
|
674 | + * |
|
675 | + * @return bool |
|
676 | + * @throws BaseException |
|
677 | + */ |
|
678 | 678 | public function tryConnect(bool $verifySSL=true) : bool |
679 | 679 | { |
680 | 680 | return $this->createConnectionTester() |
@@ -682,26 +682,26 @@ discard block |
||
682 | 682 | ->canConnect(); |
683 | 683 | } |
684 | 684 | |
685 | - /** |
|
686 | - * Creates the connection tester instance that is used |
|
687 | - * to check if a URL can be connected to, and which is |
|
688 | - * used in the {@see URLInfo::tryConnect()} method. It |
|
689 | - * allows more settings to be used. |
|
690 | - * |
|
691 | - * @return URLInfo_ConnectionTester |
|
692 | - */ |
|
685 | + /** |
|
686 | + * Creates the connection tester instance that is used |
|
687 | + * to check if a URL can be connected to, and which is |
|
688 | + * used in the {@see URLInfo::tryConnect()} method. It |
|
689 | + * allows more settings to be used. |
|
690 | + * |
|
691 | + * @return URLInfo_ConnectionTester |
|
692 | + */ |
|
693 | 693 | public function createConnectionTester() : URLInfo_ConnectionTester |
694 | 694 | { |
695 | 695 | return new URLInfo_ConnectionTester($this); |
696 | 696 | } |
697 | 697 | |
698 | - /** |
|
699 | - * Adds/overwrites an URL parameter. |
|
700 | - * |
|
701 | - * @param string $name |
|
702 | - * @param string $val |
|
703 | - * @return URLInfo |
|
704 | - */ |
|
698 | + /** |
|
699 | + * Adds/overwrites an URL parameter. |
|
700 | + * |
|
701 | + * @param string $name |
|
702 | + * @param string $val |
|
703 | + * @return URLInfo |
|
704 | + */ |
|
705 | 705 | public function setParam(string $name, string $val) : URLInfo |
706 | 706 | { |
707 | 707 | $this->info['params'][$name] = $val; |
@@ -709,13 +709,13 @@ discard block |
||
709 | 709 | return $this; |
710 | 710 | } |
711 | 711 | |
712 | - /** |
|
713 | - * Removes an URL parameter. Has no effect if the |
|
714 | - * parameter is not present to begin with. |
|
715 | - * |
|
716 | - * @param string $param |
|
717 | - * @return URLInfo |
|
718 | - */ |
|
712 | + /** |
|
713 | + * Removes an URL parameter. Has no effect if the |
|
714 | + * parameter is not present to begin with. |
|
715 | + * |
|
716 | + * @param string $param |
|
717 | + * @return URLInfo |
|
718 | + */ |
|
719 | 719 | public function removeParam(string $param) : URLInfo |
720 | 720 | { |
721 | 721 | if(isset($this->info['params'][$param])) |
@@ -123,9 +123,9 @@ discard block |
||
123 | 123 | * @param bool $enabled |
124 | 124 | * @return URLInfo |
125 | 125 | */ |
126 | - public function setUTFEncoding(bool $enabled=true) : URLInfo |
|
126 | + public function setUTFEncoding(bool $enabled = true) : URLInfo |
|
127 | 127 | { |
128 | - if($this->encodeUTFChars !== $enabled) |
|
128 | + if ($this->encodeUTFChars !== $enabled) |
|
129 | 129 | { |
130 | 130 | $this->encodeUTFChars = $enabled; |
131 | 131 | $this->parse(); // re-parse the URL to apply the changes |
@@ -229,7 +229,7 @@ discard block |
||
229 | 229 | { |
230 | 230 | $port = $this->getInfoKey('port'); |
231 | 231 | |
232 | - if(!empty($port)) { |
|
232 | + if (!empty($port)) { |
|
233 | 233 | return (int)$port; |
234 | 234 | } |
235 | 235 | |
@@ -309,7 +309,7 @@ discard block |
||
309 | 309 | |
310 | 310 | protected function getInfoKey(string $name) : string |
311 | 311 | { |
312 | - if(isset($this->info[$name])) { |
|
312 | + if (isset($this->info[$name])) { |
|
313 | 313 | return (string)$this->info[$name]; |
314 | 314 | } |
315 | 315 | |
@@ -338,13 +338,13 @@ discard block |
||
338 | 338 | return $this->normalize(false); |
339 | 339 | } |
340 | 340 | |
341 | - protected function normalize(bool $auth=true) : string |
|
341 | + protected function normalize(bool $auth = true) : string |
|
342 | 342 | { |
343 | - if(!$this->isValid()) { |
|
343 | + if (!$this->isValid()) { |
|
344 | 344 | return ''; |
345 | 345 | } |
346 | 346 | |
347 | - if(!isset($this->normalizer)) { |
|
347 | + if (!isset($this->normalizer)) { |
|
348 | 348 | $this->normalizer = new URLInfo_Normalizer($this); |
349 | 349 | } |
350 | 350 | |
@@ -374,7 +374,7 @@ discard block |
||
374 | 374 | */ |
375 | 375 | public function getHighlighted() : string |
376 | 376 | { |
377 | - if(!$this->isValid()) { |
|
377 | + if (!$this->isValid()) { |
|
378 | 378 | return ''; |
379 | 379 | } |
380 | 380 | |
@@ -416,14 +416,14 @@ discard block |
||
416 | 416 | */ |
417 | 417 | public function getParams() : array |
418 | 418 | { |
419 | - if(!$this->paramExclusion || empty($this->excludedParams)) { |
|
419 | + if (!$this->paramExclusion || empty($this->excludedParams)) { |
|
420 | 420 | return $this->info['params']; |
421 | 421 | } |
422 | 422 | |
423 | 423 | $keep = array(); |
424 | - foreach($this->info['params'] as $name => $value) |
|
424 | + foreach ($this->info['params'] as $name => $value) |
|
425 | 425 | { |
426 | - if(!isset($this->excludedParams[$name])) { |
|
426 | + if (!isset($this->excludedParams[$name])) { |
|
427 | 427 | $keep[$name] = $value; |
428 | 428 | } |
429 | 429 | } |
@@ -449,7 +449,7 @@ discard block |
||
449 | 449 | */ |
450 | 450 | public function getParam(string $name) : string |
451 | 451 | { |
452 | - if(isset($this->info['params'][$name])) { |
|
452 | + if (isset($this->info['params'][$name])) { |
|
453 | 453 | return $this->info['params'][$name]; |
454 | 454 | } |
455 | 455 | |
@@ -466,9 +466,9 @@ discard block |
||
466 | 466 | * @param string $reason A human readable explanation why this is excluded - used when highlighting links. |
467 | 467 | * @return URLInfo |
468 | 468 | */ |
469 | - public function excludeParam(string $name, string $reason='') : URLInfo |
|
469 | + public function excludeParam(string $name, string $reason = '') : URLInfo |
|
470 | 470 | { |
471 | - if(!isset($this->excludedParams[$name])) |
|
471 | + if (!isset($this->excludedParams[$name])) |
|
472 | 472 | { |
473 | 473 | $this->excludedParams[$name] = $reason; |
474 | 474 | $this->setParamExclusion(); |
@@ -494,7 +494,7 @@ discard block |
||
494 | 494 | |
495 | 495 | public function getTypeLabel() : string |
496 | 496 | { |
497 | - if(!isset(self::$typeLabels)) |
|
497 | + if (!isset(self::$typeLabels)) |
|
498 | 498 | { |
499 | 499 | self::$typeLabels = array( |
500 | 500 | self::TYPE_EMAIL => t('Email'), |
@@ -506,7 +506,7 @@ discard block |
||
506 | 506 | |
507 | 507 | $type = $this->getType(); |
508 | 508 | |
509 | - if(!isset(self::$typeLabels[$type])) |
|
509 | + if (!isset(self::$typeLabels[$type])) |
|
510 | 510 | { |
511 | 511 | throw new BaseException( |
512 | 512 | sprintf('Unknown URL type label for type [%s].', $type), |
@@ -526,7 +526,7 @@ discard block |
||
526 | 526 | * @param bool $highlight |
527 | 527 | * @return URLInfo |
528 | 528 | */ |
529 | - public function setHighlightExcluded(bool $highlight=true) : URLInfo |
|
529 | + public function setHighlightExcluded(bool $highlight = true) : URLInfo |
|
530 | 530 | { |
531 | 531 | $this->highlightExcluded = $highlight; |
532 | 532 | return $this; |
@@ -574,7 +574,7 @@ discard block |
||
574 | 574 | * @see URLInfo::isParamExclusionEnabled() |
575 | 575 | * @see URLInfo::setHighlightExcluded() |
576 | 576 | */ |
577 | - public function setParamExclusion(bool $enabled=true) : URLInfo |
|
577 | + public function setParamExclusion(bool $enabled = true) : URLInfo |
|
578 | 578 | { |
579 | 579 | $this->paramExclusion = $enabled; |
580 | 580 | return $this; |
@@ -600,13 +600,13 @@ discard block |
||
600 | 600 | */ |
601 | 601 | public function containsExcludedParams() : bool |
602 | 602 | { |
603 | - if(empty($this->excludedParams)) { |
|
603 | + if (empty($this->excludedParams)) { |
|
604 | 604 | return false; |
605 | 605 | } |
606 | 606 | |
607 | 607 | $names = array_keys($this->info['params']); |
608 | - foreach($names as $name) { |
|
609 | - if(isset($this->excludedParams[$name])) { |
|
608 | + foreach ($names as $name) { |
|
609 | + if (isset($this->excludedParams[$name])) { |
|
610 | 610 | return true; |
611 | 611 | } |
612 | 612 | } |
@@ -622,7 +622,7 @@ discard block |
||
622 | 622 | |
623 | 623 | public function offsetSet($offset, $value) |
624 | 624 | { |
625 | - if(in_array($offset, $this->infoKeys)) { |
|
625 | + if (in_array($offset, $this->infoKeys)) { |
|
626 | 626 | $this->info[$offset] = $value; |
627 | 627 | } |
628 | 628 | } |
@@ -639,11 +639,11 @@ discard block |
||
639 | 639 | |
640 | 640 | public function offsetGet($offset) |
641 | 641 | { |
642 | - if($offset === 'port') { |
|
642 | + if ($offset === 'port') { |
|
643 | 643 | return $this->getPort(); |
644 | 644 | } |
645 | 645 | |
646 | - if(in_array($offset, $this->infoKeys)) { |
|
646 | + if (in_array($offset, $this->infoKeys)) { |
|
647 | 647 | return $this->getInfoKey($offset); |
648 | 648 | } |
649 | 649 | |
@@ -675,7 +675,7 @@ discard block |
||
675 | 675 | * @return bool |
676 | 676 | * @throws BaseException |
677 | 677 | */ |
678 | - public function tryConnect(bool $verifySSL=true) : bool |
|
678 | + public function tryConnect(bool $verifySSL = true) : bool |
|
679 | 679 | { |
680 | 680 | return $this->createConnectionTester() |
681 | 681 | ->setVerifySSL($verifySSL) |
@@ -718,7 +718,7 @@ discard block |
||
718 | 718 | */ |
719 | 719 | public function removeParam(string $param) : URLInfo |
720 | 720 | { |
721 | - if(isset($this->info['params'][$param])) |
|
721 | + if (isset($this->info['params'][$param])) |
|
722 | 722 | { |
723 | 723 | unset($this->info['params'][$param]); |
724 | 724 | } |