@@ -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()) |
@@ -37,19 +37,19 @@ discard block |
||
37 | 37 | |
38 | 38 | const ERROR_INVALID_SERIALIZED_DATA = 56301; |
39 | 39 | |
40 | - /** |
|
41 | - * @var string |
|
42 | - */ |
|
40 | + /** |
|
41 | + * @var string |
|
42 | + */ |
|
43 | 43 | protected $string; |
44 | 44 | |
45 | - /** |
|
46 | - * @var mixed |
|
47 | - */ |
|
45 | + /** |
|
46 | + * @var mixed |
|
47 | + */ |
|
48 | 48 | protected $value; |
49 | 49 | |
50 | - /** |
|
51 | - * @var string |
|
52 | - */ |
|
50 | + /** |
|
51 | + * @var string |
|
52 | + */ |
|
53 | 53 | protected $type; |
54 | 54 | |
55 | 55 | /** |
@@ -106,15 +106,15 @@ discard block |
||
106 | 106 | return new VariableInfo(null, $serialized); |
107 | 107 | } |
108 | 108 | |
109 | - /** |
|
110 | - * Parses a previously serialized data set to restore the |
|
111 | - * variable information from it. |
|
112 | - * |
|
113 | - * @param array $serialized |
|
114 | - * @throws BaseException |
|
115 | - * |
|
116 | - * @see VariableInfo::ERROR_INVALID_SERIALIZED_DATA |
|
117 | - */ |
|
109 | + /** |
|
110 | + * Parses a previously serialized data set to restore the |
|
111 | + * variable information from it. |
|
112 | + * |
|
113 | + * @param array $serialized |
|
114 | + * @throws BaseException |
|
115 | + * |
|
116 | + * @see VariableInfo::ERROR_INVALID_SERIALIZED_DATA |
|
117 | + */ |
|
118 | 118 | protected function parseSerialized(array $serialized) : void |
119 | 119 | { |
120 | 120 | if(!isset($serialized['string']) || !isset($serialized['type']) || !isset($serialized['options'])) |
@@ -156,12 +156,12 @@ discard block |
||
156 | 156 | return $this->value; |
157 | 157 | } |
158 | 158 | |
159 | - /** |
|
160 | - * The variable type - this is the same string that |
|
161 | - * is returned by the PHP function `gettype`. |
|
162 | - * |
|
163 | - * @return string |
|
164 | - */ |
|
159 | + /** |
|
160 | + * The variable type - this is the same string that |
|
161 | + * is returned by the PHP function `gettype`. |
|
162 | + * |
|
163 | + * @return string |
|
164 | + */ |
|
165 | 165 | public function getType() : string |
166 | 166 | { |
167 | 167 | return $this->type; |
@@ -175,13 +175,13 @@ discard block |
||
175 | 175 | ); |
176 | 176 | } |
177 | 177 | |
178 | - /** |
|
179 | - * Whether to prepend the variable type before the value, |
|
180 | - * like the var_dump function. Example: <code>string "Some text"</code>. |
|
181 | - * |
|
182 | - * @param bool $enable |
|
183 | - * @return VariableInfo |
|
184 | - */ |
|
178 | + /** |
|
179 | + * Whether to prepend the variable type before the value, |
|
180 | + * like the var_dump function. Example: <code>string "Some text"</code>. |
|
181 | + * |
|
182 | + * @param bool $enable |
|
183 | + * @return VariableInfo |
|
184 | + */ |
|
185 | 185 | public function enableType(bool $enable=true) : VariableInfo |
186 | 186 | { |
187 | 187 | return $this->setOption('prepend-type', $enable); |
@@ -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 | } |
@@ -25,9 +25,9 @@ discard block |
||
25 | 25 | */ |
26 | 26 | trait Traits_Classable |
27 | 27 | { |
28 | - /** |
|
29 | - * @var string[] |
|
30 | - */ |
|
28 | + /** |
|
29 | + * @var string[] |
|
30 | + */ |
|
31 | 31 | protected $classes = array(); |
32 | 32 | |
33 | 33 | public function addClass(string $name) |
@@ -65,30 +65,30 @@ discard block |
||
65 | 65 | return $this; |
66 | 66 | } |
67 | 67 | |
68 | - /** |
|
69 | - * Retrieves a list of all classes, if any. |
|
70 | - * |
|
71 | - * @return string[] |
|
72 | - */ |
|
68 | + /** |
|
69 | + * Retrieves a list of all classes, if any. |
|
70 | + * |
|
71 | + * @return string[] |
|
72 | + */ |
|
73 | 73 | public function getClasses() : array |
74 | 74 | { |
75 | 75 | return $this->classes; |
76 | 76 | } |
77 | 77 | |
78 | - /** |
|
79 | - * Renders the class names list as space-separated string for use in an HTML tag. |
|
80 | - * |
|
81 | - * @return string |
|
82 | - */ |
|
78 | + /** |
|
79 | + * Renders the class names list as space-separated string for use in an HTML tag. |
|
80 | + * |
|
81 | + * @return string |
|
82 | + */ |
|
83 | 83 | public function classesToString() : string |
84 | 84 | { |
85 | 85 | return implode(' ', $this->classes); |
86 | 86 | } |
87 | 87 | |
88 | - /** |
|
89 | - * Renders the "class" attribute string for inserting into an HTML tag. |
|
90 | - * @return string |
|
91 | - */ |
|
88 | + /** |
|
89 | + * Renders the "class" attribute string for inserting into an HTML tag. |
|
90 | + * @return string |
|
91 | + */ |
|
92 | 92 | public function classesToAttribute() : string |
93 | 93 | { |
94 | 94 | if(!empty($this->classes)) |
@@ -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])) |
@@ -110,38 +110,38 @@ discard block |
||
110 | 110 | return $this; |
111 | 111 | } |
112 | 112 | |
113 | - /** |
|
114 | - * Whether to enable sorting the URLs alphabetically (disabled by default). |
|
115 | - * |
|
116 | - * @param bool $enabled |
|
117 | - * @return $this |
|
118 | - */ |
|
113 | + /** |
|
114 | + * Whether to enable sorting the URLs alphabetically (disabled by default). |
|
115 | + * |
|
116 | + * @param bool $enabled |
|
117 | + * @return $this |
|
118 | + */ |
|
119 | 119 | public function enableSorting(bool $enabled=true) : ConvertHelper_URLFinder |
120 | 120 | { |
121 | 121 | $this->setOption('sorting', $enabled); |
122 | 122 | return $this; |
123 | 123 | } |
124 | 124 | |
125 | - /** |
|
126 | - * Whether to include email addresses in the search. |
|
127 | - * This is only relevant when using the getURLs() |
|
128 | - * method. |
|
129 | - * |
|
130 | - * @param bool $include |
|
131 | - * @return ConvertHelper_URLFinder |
|
132 | - */ |
|
125 | + /** |
|
126 | + * Whether to include email addresses in the search. |
|
127 | + * This is only relevant when using the getURLs() |
|
128 | + * method. |
|
129 | + * |
|
130 | + * @param bool $include |
|
131 | + * @return ConvertHelper_URLFinder |
|
132 | + */ |
|
133 | 133 | public function includeEmails(bool $include=true) : ConvertHelper_URLFinder |
134 | 134 | { |
135 | 135 | $this->setOption('include-emails', $include); |
136 | 136 | return $this; |
137 | 137 | } |
138 | 138 | |
139 | - /** |
|
140 | - * Whether to omit the mailto: that is automatically added to all email addresses. |
|
141 | - * |
|
142 | - * @param bool $omit |
|
143 | - * @return ConvertHelper_URLFinder |
|
144 | - */ |
|
139 | + /** |
|
140 | + * Whether to omit the mailto: that is automatically added to all email addresses. |
|
141 | + * |
|
142 | + * @param bool $omit |
|
143 | + * @return ConvertHelper_URLFinder |
|
144 | + */ |
|
145 | 145 | public function omitMailto(bool $omit=true) : ConvertHelper_URLFinder |
146 | 146 | { |
147 | 147 | $this->setOption('omit-mailto', $omit); |
@@ -267,11 +267,11 @@ discard block |
||
267 | 267 | ); |
268 | 268 | } |
269 | 269 | |
270 | - /** |
|
271 | - * Fetches all URLs that can be found in the subject string. |
|
272 | - * |
|
273 | - * @return string[] |
|
274 | - */ |
|
270 | + /** |
|
271 | + * Fetches all URLs that can be found in the subject string. |
|
272 | + * |
|
273 | + * @return string[] |
|
274 | + */ |
|
275 | 275 | public function getURLs() : array |
276 | 276 | { |
277 | 277 | $this->parse(); |
@@ -474,13 +474,13 @@ discard block |
||
474 | 474 | return array_pop($parts); |
475 | 475 | } |
476 | 476 | |
477 | - /** |
|
478 | - * Retrieves all email addresses from the subject string. |
|
479 | - * |
|
480 | - * @return string[] |
|
481 | - * |
|
482 | - * @see omitMailto() |
|
483 | - */ |
|
477 | + /** |
|
478 | + * Retrieves all email addresses from the subject string. |
|
479 | + * |
|
480 | + * @return string[] |
|
481 | + * |
|
482 | + * @see omitMailto() |
|
483 | + */ |
|
484 | 484 | public function getEmails() : array |
485 | 485 | { |
486 | 486 | $this->parse(); |
@@ -506,11 +506,11 @@ discard block |
||
506 | 506 | return $result; |
507 | 507 | } |
508 | 508 | |
509 | - /** |
|
510 | - * Retrieves all URLs as URLInfo instances. |
|
511 | - * |
|
512 | - * @return URLInfo[] |
|
513 | - */ |
|
509 | + /** |
|
510 | + * Retrieves all URLs as URLInfo instances. |
|
511 | + * |
|
512 | + * @return URLInfo[] |
|
513 | + */ |
|
514 | 514 | public function getInfos() : array |
515 | 515 | { |
516 | 516 | $this->parse(); |
@@ -23,24 +23,24 @@ discard block |
||
23 | 23 | */ |
24 | 24 | class URLInfo_Parser |
25 | 25 | { |
26 | - /** |
|
27 | - * @var string |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var string |
|
28 | + */ |
|
29 | 29 | protected $url; |
30 | 30 | |
31 | - /** |
|
32 | - * @var bool |
|
33 | - */ |
|
31 | + /** |
|
32 | + * @var bool |
|
33 | + */ |
|
34 | 34 | protected $isValid = false; |
35 | 35 | |
36 | - /** |
|
37 | - * @var array |
|
38 | - */ |
|
36 | + /** |
|
37 | + * @var array |
|
38 | + */ |
|
39 | 39 | protected $info; |
40 | 40 | |
41 | - /** |
|
42 | - * @var array|NULL |
|
43 | - */ |
|
41 | + /** |
|
42 | + * @var array|NULL |
|
43 | + */ |
|
44 | 44 | protected $error; |
45 | 45 | |
46 | 46 | /** |
@@ -57,25 +57,25 @@ discard block |
||
57 | 57 | 'git' |
58 | 58 | ); |
59 | 59 | |
60 | - /** |
|
61 | - * Stores a list of all unicode characters in the URL |
|
62 | - * that have been filtered out before parsing it with |
|
63 | - * parse_url. |
|
64 | - * |
|
65 | - * @var string[]string |
|
66 | - */ |
|
60 | + /** |
|
61 | + * Stores a list of all unicode characters in the URL |
|
62 | + * that have been filtered out before parsing it with |
|
63 | + * parse_url. |
|
64 | + * |
|
65 | + * @var string[]string |
|
66 | + */ |
|
67 | 67 | protected $unicodeChars = array(); |
68 | 68 | |
69 | - /** |
|
70 | - * @var bool |
|
71 | - */ |
|
69 | + /** |
|
70 | + * @var bool |
|
71 | + */ |
|
72 | 72 | protected $encodeUTF = false; |
73 | 73 | |
74 | - /** |
|
75 | - * |
|
76 | - * @param string $url The target URL. |
|
77 | - * @param bool $encodeUTF Whether to URL encode any plain text unicode characters. |
|
78 | - */ |
|
74 | + /** |
|
75 | + * |
|
76 | + * @param string $url The target URL. |
|
77 | + * @param bool $encodeUTF Whether to URL encode any plain text unicode characters. |
|
78 | + */ |
|
79 | 79 | public function __construct(string $url, bool $encodeUTF) |
80 | 80 | { |
81 | 81 | $this->url = $url; |
@@ -88,12 +88,12 @@ discard block |
||
88 | 88 | } |
89 | 89 | } |
90 | 90 | |
91 | - /** |
|
92 | - * Retrieves the array as parsed by PHP's parse_url, |
|
93 | - * filtered and adjusted as necessary. |
|
94 | - * |
|
95 | - * @return array |
|
96 | - */ |
|
91 | + /** |
|
92 | + * Retrieves the array as parsed by PHP's parse_url, |
|
93 | + * filtered and adjusted as necessary. |
|
94 | + * |
|
95 | + * @return array |
|
96 | + */ |
|
97 | 97 | public function getInfo() : array |
98 | 98 | { |
99 | 99 | return $this->info; |
@@ -115,11 +115,11 @@ discard block |
||
115 | 115 | } |
116 | 116 | } |
117 | 117 | |
118 | - /** |
|
119 | - * Finds any non-url encoded unicode characters in |
|
120 | - * the URL, and encodes them before the URL is |
|
121 | - * passed to parse_url. |
|
122 | - */ |
|
118 | + /** |
|
119 | + * Finds any non-url encoded unicode characters in |
|
120 | + * the URL, and encodes them before the URL is |
|
121 | + * passed to parse_url. |
|
122 | + */ |
|
123 | 123 | protected function filterUnicodeChars() : void |
124 | 124 | { |
125 | 125 | $chars = ConvertHelper::string2array($this->url); |
@@ -238,11 +238,11 @@ discard block |
||
238 | 238 | return false; |
239 | 239 | } |
240 | 240 | |
241 | - /** |
|
242 | - * Goes through all information in the parse_url result |
|
243 | - * array, and attempts to fix any user errors in formatting |
|
244 | - * that can be recovered from, mostly regarding stray spaces. |
|
245 | - */ |
|
241 | + /** |
|
242 | + * Goes through all information in the parse_url result |
|
243 | + * array, and attempts to fix any user errors in formatting |
|
244 | + * that can be recovered from, mostly regarding stray spaces. |
|
245 | + */ |
|
246 | 246 | protected function filterParsed() : void |
247 | 247 | { |
248 | 248 | $this->info['params'] = array(); |
@@ -284,13 +284,13 @@ discard block |
||
284 | 284 | } |
285 | 285 | } |
286 | 286 | |
287 | - /** |
|
288 | - * Recursively goes through the array, and converts all previously |
|
289 | - * URL encoded characters with their unicode character counterparts. |
|
290 | - * |
|
291 | - * @param array $subject |
|
292 | - * @return array |
|
293 | - */ |
|
287 | + /** |
|
288 | + * Recursively goes through the array, and converts all previously |
|
289 | + * URL encoded characters with their unicode character counterparts. |
|
290 | + * |
|
291 | + * @param array $subject |
|
292 | + * @return array |
|
293 | + */ |
|
294 | 294 | protected function restoreUnicodeChars(array $subject) : array |
295 | 295 | { |
296 | 296 | $result = array(); |
@@ -314,13 +314,13 @@ discard block |
||
314 | 314 | return $result; |
315 | 315 | } |
316 | 316 | |
317 | - /** |
|
318 | - * Replaces all URL encoded unicode characters |
|
319 | - * in the string with the unicode character. |
|
320 | - * |
|
321 | - * @param string $string |
|
322 | - * @return string |
|
323 | - */ |
|
317 | + /** |
|
318 | + * Replaces all URL encoded unicode characters |
|
319 | + * in the string with the unicode character. |
|
320 | + * |
|
321 | + * @param string $string |
|
322 | + * @return string |
|
323 | + */ |
|
324 | 324 | protected function restoreUnicodeChar(string $string) : string |
325 | 325 | { |
326 | 326 | if(strstr($string, '%')) |
@@ -404,21 +404,21 @@ discard block |
||
404 | 404 | ); |
405 | 405 | } |
406 | 406 | |
407 | - /** |
|
408 | - * Checks whether the URL that was parsed is valid. |
|
409 | - * @return bool |
|
410 | - */ |
|
407 | + /** |
|
408 | + * Checks whether the URL that was parsed is valid. |
|
409 | + * @return bool |
|
410 | + */ |
|
411 | 411 | public function isValid() : bool |
412 | 412 | { |
413 | 413 | return $this->isValid; |
414 | 414 | } |
415 | 415 | |
416 | - /** |
|
417 | - * If the validation failed, retrieves the validation |
|
418 | - * error message. |
|
419 | - * |
|
420 | - * @return string |
|
421 | - */ |
|
416 | + /** |
|
417 | + * If the validation failed, retrieves the validation |
|
418 | + * error message. |
|
419 | + * |
|
420 | + * @return string |
|
421 | + */ |
|
422 | 422 | public function getErrorMessage() : string |
423 | 423 | { |
424 | 424 | if(isset($this->error)) { |
@@ -428,12 +428,12 @@ discard block |
||
428 | 428 | return ''; |
429 | 429 | } |
430 | 430 | |
431 | - /** |
|
432 | - * If the validation failed, retrieves the validation |
|
433 | - * error code. |
|
434 | - * |
|
435 | - * @return int |
|
436 | - */ |
|
431 | + /** |
|
432 | + * If the validation failed, retrieves the validation |
|
433 | + * error code. |
|
434 | + * |
|
435 | + * @return int |
|
436 | + */ |
|
437 | 437 | public function getErrorCode() : int |
438 | 438 | { |
439 | 439 | if(isset($this->error)) { |
@@ -42,10 +42,10 @@ discard block |
||
42 | 42 | |
43 | 43 | const REGEX_MD5 = '/^[a-f0-9]{32}$/i'; |
44 | 44 | |
45 | - /** |
|
46 | - * @var string |
|
47 | - * @see https://en.wikipedia.org/wiki/Email_address#Local-part |
|
48 | - */ |
|
45 | + /** |
|
46 | + * @var string |
|
47 | + * @see https://en.wikipedia.org/wiki/Email_address#Local-part |
|
48 | + */ |
|
49 | 49 | const REGEX_EMAIL = '/[a-z0-9!#$%&\'*+\/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&\'*+\/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?/i'; |
50 | 50 | |
51 | 51 | const REGEX_PHONE = '/\A[+0-9][0-9 +\-()]+\z/m'; |
@@ -97,14 +97,14 @@ discard block |
||
97 | 97 | */ |
98 | 98 | const REGEX_IS_HTML = '%<{0,1}[a-z\/][\s\S]*>|<[a-z\/][\s\S]*>{0,1}%i'; |
99 | 99 | |
100 | - /** |
|
101 | - * Hexadecimal color codes. Allows the following formats: |
|
102 | - * |
|
103 | - * FFFFFF |
|
104 | - * FFF |
|
105 | - * |
|
106 | - * @var string |
|
107 | - */ |
|
100 | + /** |
|
101 | + * Hexadecimal color codes. Allows the following formats: |
|
102 | + * |
|
103 | + * FFFFFF |
|
104 | + * FFF |
|
105 | + * |
|
106 | + * @var string |
|
107 | + */ |
|
108 | 108 | const REGEX_HEX_COLOR_CODE = '/\A(?:[0-9a-fA-F]{6}|[0-9a-fA-F]{3})\z/iU'; |
109 | 109 | |
110 | 110 | /** |
@@ -25,10 +25,10 @@ |
||
25 | 25 | * |
26 | 26 | * @return string |
27 | 27 | */ |
28 | - function render() : string; |
|
28 | + function render() : string; |
|
29 | 29 | |
30 | 30 | /** |
31 | 31 | * Renders the string and echos it. |
32 | 32 | */ |
33 | - function display() : void; |
|
33 | + function display() : void; |
|
34 | 34 | } |