@@ -19,9 +19,9 @@ |
||
19 | 19 | */ |
20 | 20 | class Request_RefreshParams_Exclude_Name extends Request_RefreshParams_Exclude |
21 | 21 | { |
22 | - /** |
|
23 | - * @var string |
|
24 | - */ |
|
22 | + /** |
|
23 | + * @var string |
|
24 | + */ |
|
25 | 25 | private $name; |
26 | 26 | |
27 | 27 | public function __construct(string $paramName) |
@@ -22,9 +22,9 @@ |
||
22 | 22 | { |
23 | 23 | const ERROR_INVALID_CALLBACK = 62101; |
24 | 24 | |
25 | - /** |
|
26 | - * @var callable |
|
27 | - */ |
|
25 | + /** |
|
26 | + * @var callable |
|
27 | + */ |
|
28 | 28 | private $callback; |
29 | 29 | |
30 | 30 | public function __construct($callback) |
@@ -29,7 +29,7 @@ |
||
29 | 29 | |
30 | 30 | public function __construct($callback) |
31 | 31 | { |
32 | - if(!is_callable($callback)) |
|
32 | + if (!is_callable($callback)) |
|
33 | 33 | { |
34 | 34 | throw new Request_Exception( |
35 | 35 | 'Invalid exclusion callback', |
@@ -23,14 +23,14 @@ discard block |
||
23 | 23 | { |
24 | 24 | use Traits_Optionable; |
25 | 25 | |
26 | - /** |
|
27 | - * @var array<string,mixed> |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var array<string,mixed> |
|
28 | + */ |
|
29 | 29 | private $overrides = array(); |
30 | 30 | |
31 | - /** |
|
32 | - * @var Request_RefreshParams_Exclude[] |
|
33 | - */ |
|
31 | + /** |
|
32 | + * @var Request_RefreshParams_Exclude[] |
|
33 | + */ |
|
34 | 34 | private $excludes = array(); |
35 | 35 | |
36 | 36 | public function getDefaultOptions() : array |
@@ -41,27 +41,27 @@ discard block |
||
41 | 41 | ); |
42 | 42 | } |
43 | 43 | |
44 | - /** |
|
45 | - * Whether to automatically exclude the session variable |
|
46 | - * from the parameters. |
|
47 | - * |
|
48 | - * @param bool $exclude |
|
49 | - * @return Request_RefreshParams |
|
50 | - */ |
|
44 | + /** |
|
45 | + * Whether to automatically exclude the session variable |
|
46 | + * from the parameters. |
|
47 | + * |
|
48 | + * @param bool $exclude |
|
49 | + * @return Request_RefreshParams |
|
50 | + */ |
|
51 | 51 | public function setExcludeSessionName(bool $exclude=true) : Request_RefreshParams |
52 | 52 | { |
53 | 53 | $this->setOption('exclude-session-name', $exclude); |
54 | 54 | return $this; |
55 | 55 | } |
56 | 56 | |
57 | - /** |
|
58 | - * Whether to automatically exclude the HTML_QuickForm2 |
|
59 | - * request variable used to track whether a form has been |
|
60 | - * submitted. |
|
61 | - * |
|
62 | - * @param bool $exclude |
|
63 | - * @return Request_RefreshParams |
|
64 | - */ |
|
57 | + /** |
|
58 | + * Whether to automatically exclude the HTML_QuickForm2 |
|
59 | + * request variable used to track whether a form has been |
|
60 | + * submitted. |
|
61 | + * |
|
62 | + * @param bool $exclude |
|
63 | + * @return Request_RefreshParams |
|
64 | + */ |
|
65 | 65 | public function setExcludeQuickform(bool $exclude) : Request_RefreshParams |
66 | 66 | { |
67 | 67 | $this->setOption('exclude-quickform-submitter', $exclude); |
@@ -78,20 +78,20 @@ discard block |
||
78 | 78 | return $this; |
79 | 79 | } |
80 | 80 | |
81 | - /** |
|
82 | - * Exclude a request using a callback function. |
|
83 | - * |
|
84 | - * The function gets two parameters: |
|
85 | - * |
|
86 | - * - The name of the request parameter |
|
87 | - * - The value of the request parameter |
|
88 | - * |
|
89 | - * If the callback returns a boolean true, the |
|
90 | - * parameter will be excluded. |
|
91 | - * |
|
92 | - * @param callable $callback |
|
93 | - * @return Request_RefreshParams |
|
94 | - */ |
|
81 | + /** |
|
82 | + * Exclude a request using a callback function. |
|
83 | + * |
|
84 | + * The function gets two parameters: |
|
85 | + * |
|
86 | + * - The name of the request parameter |
|
87 | + * - The value of the request parameter |
|
88 | + * |
|
89 | + * If the callback returns a boolean true, the |
|
90 | + * parameter will be excluded. |
|
91 | + * |
|
92 | + * @param callable $callback |
|
93 | + * @return Request_RefreshParams |
|
94 | + */ |
|
95 | 95 | public function excludeParamByCallback($callback) : Request_RefreshParams |
96 | 96 | { |
97 | 97 | $this->excludes[] = new Request_RefreshParams_Exclude_Callback($callback); |
@@ -99,12 +99,12 @@ discard block |
||
99 | 99 | return $this; |
100 | 100 | } |
101 | 101 | |
102 | - /** |
|
103 | - * Excludes a request parameter by name. |
|
104 | - * |
|
105 | - * @param array $paramNames |
|
106 | - * @return Request_RefreshParams |
|
107 | - */ |
|
102 | + /** |
|
103 | + * Excludes a request parameter by name. |
|
104 | + * |
|
105 | + * @param array $paramNames |
|
106 | + * @return Request_RefreshParams |
|
107 | + */ |
|
108 | 108 | public function excludeParamsByName(array $paramNames) : Request_RefreshParams |
109 | 109 | { |
110 | 110 | foreach($paramNames as $name) |
@@ -115,15 +115,15 @@ discard block |
||
115 | 115 | return $this; |
116 | 116 | } |
117 | 117 | |
118 | - /** |
|
119 | - * Overrides a parameter: even if it exists, this |
|
120 | - * value will be used instead - even if it is on |
|
121 | - * the list of excluded parameters. |
|
122 | - * |
|
123 | - * @param string $paramName |
|
124 | - * @param mixed $paramValue |
|
125 | - * @return Request_RefreshParams |
|
126 | - */ |
|
118 | + /** |
|
119 | + * Overrides a parameter: even if it exists, this |
|
120 | + * value will be used instead - even if it is on |
|
121 | + * the list of excluded parameters. |
|
122 | + * |
|
123 | + * @param string $paramName |
|
124 | + * @param mixed $paramValue |
|
125 | + * @return Request_RefreshParams |
|
126 | + */ |
|
127 | 127 | public function overrideParam(string $paramName, $paramValue) : Request_RefreshParams |
128 | 128 | { |
129 | 129 | $this->overrides[$paramName] = $paramValue; |
@@ -131,12 +131,12 @@ discard block |
||
131 | 131 | return $this; |
132 | 132 | } |
133 | 133 | |
134 | - /** |
|
135 | - * Overrides an array of parameters. |
|
136 | - * |
|
137 | - * @param array $params |
|
138 | - * @return Request_RefreshParams |
|
139 | - */ |
|
134 | + /** |
|
135 | + * Overrides an array of parameters. |
|
136 | + * |
|
137 | + * @param array $params |
|
138 | + * @return Request_RefreshParams |
|
139 | + */ |
|
140 | 140 | public function overrideParams(array $params) : Request_RefreshParams |
141 | 141 | { |
142 | 142 | foreach($params as $name => $value) |
@@ -147,14 +147,14 @@ discard block |
||
147 | 147 | return $this; |
148 | 148 | } |
149 | 149 | |
150 | - /** |
|
151 | - * Resolves all the parameter exclusions that should |
|
152 | - * be applied to the list of parameters. This includes |
|
153 | - * the manually added exclusions and the dynamic exclusions |
|
154 | - * like the session name. |
|
155 | - * |
|
156 | - * @return Request_RefreshParams_Exclude[] |
|
157 | - */ |
|
150 | + /** |
|
151 | + * Resolves all the parameter exclusions that should |
|
152 | + * be applied to the list of parameters. This includes |
|
153 | + * the manually added exclusions and the dynamic exclusions |
|
154 | + * like the session name. |
|
155 | + * |
|
156 | + * @return Request_RefreshParams_Exclude[] |
|
157 | + */ |
|
158 | 158 | private function resolveExcludes() : array |
159 | 159 | { |
160 | 160 | $excludes = $this->excludes; |
@@ -165,12 +165,12 @@ discard block |
||
165 | 165 | return $excludes; |
166 | 166 | } |
167 | 167 | |
168 | - /** |
|
169 | - * Automatically excludes the session name from the |
|
170 | - * parameters, if present. |
|
171 | - * |
|
172 | - * @param Request_RefreshParams_Exclude[] $excludes |
|
173 | - */ |
|
168 | + /** |
|
169 | + * Automatically excludes the session name from the |
|
170 | + * parameters, if present. |
|
171 | + * |
|
172 | + * @param Request_RefreshParams_Exclude[] $excludes |
|
173 | + */ |
|
174 | 174 | private function autoExcludeSessionName(array &$excludes) : void |
175 | 175 | { |
176 | 176 | if($this->getBoolOption('exclude-session-name')) |
@@ -179,12 +179,12 @@ discard block |
||
179 | 179 | } |
180 | 180 | } |
181 | 181 | |
182 | - /** |
|
183 | - * Automatically excludes the HTML_QuickForm2 submit |
|
184 | - * tracking variable, when enabled. |
|
185 | - * |
|
186 | - * @param Request_RefreshParams_Exclude[] $excludes |
|
187 | - */ |
|
182 | + /** |
|
183 | + * Automatically excludes the HTML_QuickForm2 submit |
|
184 | + * tracking variable, when enabled. |
|
185 | + * |
|
186 | + * @param Request_RefreshParams_Exclude[] $excludes |
|
187 | + */ |
|
188 | 188 | private function autoExcludeQuickform(array &$excludes) : void |
189 | 189 | { |
190 | 190 | if($this->getBoolOption('exclude-quickform-submitter')) |
@@ -196,12 +196,12 @@ discard block |
||
196 | 196 | } |
197 | 197 | } |
198 | 198 | |
199 | - /** |
|
200 | - * Retrieves the list of parameters matching the |
|
201 | - * current settings. |
|
202 | - * |
|
203 | - * @return array<string,mixed> |
|
204 | - */ |
|
199 | + /** |
|
200 | + * Retrieves the list of parameters matching the |
|
201 | + * current settings. |
|
202 | + * |
|
203 | + * @return array<string,mixed> |
|
204 | + */ |
|
205 | 205 | public function getParams() : array |
206 | 206 | { |
207 | 207 | $params = $this->removeExcluded($_REQUEST); |
@@ -217,12 +217,12 @@ discard block |
||
217 | 217 | return $params; |
218 | 218 | } |
219 | 219 | |
220 | - /** |
|
221 | - * Removes all excluded parameters from the array. |
|
222 | - * |
|
223 | - * @param array<string,mixed> $params |
|
224 | - * @return array<string,mixed> |
|
225 | - */ |
|
220 | + /** |
|
221 | + * Removes all excluded parameters from the array. |
|
222 | + * |
|
223 | + * @param array<string,mixed> $params |
|
224 | + * @return array<string,mixed> |
|
225 | + */ |
|
226 | 226 | private function removeExcluded(array $params) : array |
227 | 227 | { |
228 | 228 | $result = array(); |
@@ -240,14 +240,14 @@ discard block |
||
240 | 240 | return $result; |
241 | 241 | } |
242 | 242 | |
243 | - /** |
|
244 | - * Checks all configured exclusions to see if the |
|
245 | - * parameter should be excluded or not. |
|
246 | - * |
|
247 | - * @param string $paramName |
|
248 | - * @param mixed $paramValue |
|
249 | - * @return bool |
|
250 | - */ |
|
243 | + /** |
|
244 | + * Checks all configured exclusions to see if the |
|
245 | + * parameter should be excluded or not. |
|
246 | + * |
|
247 | + * @param string $paramName |
|
248 | + * @param mixed $paramValue |
|
249 | + * @return bool |
|
250 | + */ |
|
251 | 251 | public function isExcluded(string $paramName, $paramValue) : bool |
252 | 252 | { |
253 | 253 | $excludes = $this->resolveExcludes(); |
@@ -48,7 +48,7 @@ discard block |
||
48 | 48 | * @param bool $exclude |
49 | 49 | * @return Request_RefreshParams |
50 | 50 | */ |
51 | - public function setExcludeSessionName(bool $exclude=true) : Request_RefreshParams |
|
51 | + public function setExcludeSessionName(bool $exclude = true) : Request_RefreshParams |
|
52 | 52 | { |
53 | 53 | $this->setOption('exclude-session-name', $exclude); |
54 | 54 | return $this; |
@@ -70,7 +70,7 @@ discard block |
||
70 | 70 | |
71 | 71 | public function excludeParamByName(string $paramName) : Request_RefreshParams |
72 | 72 | { |
73 | - if($paramName !== '') |
|
73 | + if ($paramName !== '') |
|
74 | 74 | { |
75 | 75 | $this->excludes[] = new Request_RefreshParams_Exclude_Name($paramName); |
76 | 76 | } |
@@ -107,7 +107,7 @@ discard block |
||
107 | 107 | */ |
108 | 108 | public function excludeParamsByName(array $paramNames) : Request_RefreshParams |
109 | 109 | { |
110 | - foreach($paramNames as $name) |
|
110 | + foreach ($paramNames as $name) |
|
111 | 111 | { |
112 | 112 | $this->excludeParamByName((string)$name); |
113 | 113 | } |
@@ -139,7 +139,7 @@ discard block |
||
139 | 139 | */ |
140 | 140 | public function overrideParams(array $params) : Request_RefreshParams |
141 | 141 | { |
142 | - foreach($params as $name => $value) |
|
142 | + foreach ($params as $name => $value) |
|
143 | 143 | { |
144 | 144 | $this->overrideParam((string)$name, $value); |
145 | 145 | } |
@@ -173,7 +173,7 @@ discard block |
||
173 | 173 | */ |
174 | 174 | private function autoExcludeSessionName(array &$excludes) : void |
175 | 175 | { |
176 | - if($this->getBoolOption('exclude-session-name')) |
|
176 | + if ($this->getBoolOption('exclude-session-name')) |
|
177 | 177 | { |
178 | 178 | $excludes[] = new Request_RefreshParams_Exclude_Name(session_name()); |
179 | 179 | } |
@@ -187,7 +187,7 @@ discard block |
||
187 | 187 | */ |
188 | 188 | private function autoExcludeQuickform(array &$excludes) : void |
189 | 189 | { |
190 | - if($this->getBoolOption('exclude-quickform-submitter')) |
|
190 | + if ($this->getBoolOption('exclude-quickform-submitter')) |
|
191 | 191 | { |
192 | 192 | $excludes[] = new Request_RefreshParams_Exclude_Callback(function(string $paramName) |
193 | 193 | { |
@@ -209,7 +209,7 @@ discard block |
||
209 | 209 | // Note: using this loop instead of array_merge, |
210 | 210 | // because array_merge has weird behavior when |
211 | 211 | // using numeric keys. |
212 | - foreach($this->overrides as $name => $val) |
|
212 | + foreach ($this->overrides as $name => $val) |
|
213 | 213 | { |
214 | 214 | $params[$name] = $val; |
215 | 215 | } |
@@ -227,11 +227,11 @@ discard block |
||
227 | 227 | { |
228 | 228 | $result = array(); |
229 | 229 | |
230 | - foreach($params as $name => $value) |
|
230 | + foreach ($params as $name => $value) |
|
231 | 231 | { |
232 | 232 | $name = (string)$name; |
233 | 233 | |
234 | - if(!$this->isExcluded($name, $value)) |
|
234 | + if (!$this->isExcluded($name, $value)) |
|
235 | 235 | { |
236 | 236 | $result[$name] = $value; |
237 | 237 | } |
@@ -252,9 +252,9 @@ discard block |
||
252 | 252 | { |
253 | 253 | $excludes = $this->resolveExcludes(); |
254 | 254 | |
255 | - foreach($excludes as $exclude) |
|
255 | + foreach ($excludes as $exclude) |
|
256 | 256 | { |
257 | - if($exclude->isExcluded($paramName, $paramValue)) |
|
257 | + if ($exclude->isExcluded($paramName, $paramValue)) |
|
258 | 258 | { |
259 | 259 | return true; |
260 | 260 | } |
@@ -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 | |
@@ -468,7 +468,7 @@ discard block |
||
468 | 468 | */ |
469 | 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 | } |
@@ -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 | requireCURL(); |
@@ -105,9 +105,9 @@ discard block |
||
105 | 105 | return $ch; |
106 | 106 | } |
107 | 107 | |
108 | - /** |
|
109 | - * @param resource $ch |
|
110 | - */ |
|
108 | + /** |
|
109 | + * @param resource $ch |
|
110 | + */ |
|
111 | 111 | private function configureOptions($ch) : void |
112 | 112 | { |
113 | 113 | 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; |
@@ -93,7 +93,7 @@ discard block |
||
93 | 93 | |
94 | 94 | $ch = curl_init(); |
95 | 95 | |
96 | - if(!is_resource($ch)) |
|
96 | + if (!is_resource($ch)) |
|
97 | 97 | { |
98 | 98 | throw new BaseException( |
99 | 99 | 'Could not initialize a new cURL instance.', |
@@ -110,7 +110,7 @@ discard block |
||
110 | 110 | */ |
111 | 111 | private function configureOptions($ch) : void |
112 | 112 | { |
113 | - if($this->isVerboseModeEnabled()) |
|
113 | + if ($this->isVerboseModeEnabled()) |
|
114 | 114 | { |
115 | 115 | curl_setopt($ch, CURLOPT_VERBOSE, true); |
116 | 116 | } |
@@ -120,13 +120,13 @@ discard block |
||
120 | 120 | curl_setopt($ch, CURLOPT_TIMEOUT, $this->getTimeout()); |
121 | 121 | curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); |
122 | 122 | |
123 | - if(!$this->isVerifySSLEnabled()) |
|
123 | + if (!$this->isVerifySSLEnabled()) |
|
124 | 124 | { |
125 | 125 | curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); |
126 | 126 | curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); |
127 | 127 | } |
128 | 128 | |
129 | - if($this->url->hasUsername()) |
|
129 | + if ($this->url->hasUsername()) |
|
130 | 130 | { |
131 | 131 | curl_setopt($ch, CURLOPT_USERNAME, $this->url->getUsername()); |
132 | 132 | curl_setopt($ch, CURLOPT_PASSWORD, $this->url->getPassword()); |
@@ -241,7 +241,7 @@ discard block |
||
241 | 241 | |
242 | 242 | $output = curl_exec($ch); |
243 | 243 | |
244 | - if(isset($this->logfilePointer)) |
|
244 | + if (isset($this->logfilePointer)) |
|
245 | 245 | { |
246 | 246 | fclose($this->logfilePointer); |
247 | 247 | } |
@@ -253,7 +253,7 @@ discard block |
||
253 | 253 | // CURL will complain about an empty response when the |
254 | 254 | // server sends a 100-continue code. That should not be |
255 | 255 | // regarded as an error. |
256 | - if($output === false && $this->response->getCode() !== 100) |
|
256 | + if ($output === false && $this->response->getCode() !== 100) |
|
257 | 257 | { |
258 | 258 | $curlCode = curl_errno($ch); |
259 | 259 | |
@@ -289,7 +289,7 @@ discard block |
||
289 | 289 | { |
290 | 290 | $ch = curl_init(); |
291 | 291 | |
292 | - if(!is_resource($ch)) |
|
292 | + if (!is_resource($ch)) |
|
293 | 293 | { |
294 | 294 | throw new RequestHelper_Exception( |
295 | 295 | 'Could not initialize a new cURL instance.', |
@@ -299,7 +299,7 @@ discard block |
||
299 | 299 | } |
300 | 300 | |
301 | 301 | $this->setHeader('Content-Length', (string)$this->boundaries->getContentLength()); |
302 | - $this->setHeader('Content-Type', 'multipart/form-data; boundary=' . $this->mimeBoundary); |
|
302 | + $this->setHeader('Content-Type', 'multipart/form-data; boundary='.$this->mimeBoundary); |
|
303 | 303 | |
304 | 304 | curl_setopt($ch, CURLOPT_POST, true); |
305 | 305 | curl_setopt($ch, CURLOPT_URL, $url->getNormalizedWithoutAuth()); |
@@ -312,18 +312,18 @@ discard block |
||
312 | 312 | |
313 | 313 | $loggingEnabled = $this->configureLogging($ch); |
314 | 314 | |
315 | - if(!$loggingEnabled) |
|
315 | + if (!$loggingEnabled) |
|
316 | 316 | { |
317 | 317 | curl_setopt($ch, CURLINFO_HEADER_OUT, true); |
318 | 318 | } |
319 | 319 | |
320 | - if($this->verifySSL) |
|
320 | + if ($this->verifySSL) |
|
321 | 321 | { |
322 | 322 | curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); |
323 | 323 | curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); |
324 | 324 | } |
325 | 325 | |
326 | - if($url->hasUsername()) |
|
326 | + if ($url->hasUsername()) |
|
327 | 327 | { |
328 | 328 | curl_setopt($ch, CURLOPT_USERNAME, $url->getUsername()); |
329 | 329 | curl_setopt($ch, CURLOPT_PASSWORD, $url->getPassword()); |
@@ -338,14 +338,14 @@ discard block |
||
338 | 338 | */ |
339 | 339 | protected function configureLogging($ch) : bool |
340 | 340 | { |
341 | - if(empty($this->logfile)) |
|
341 | + if (empty($this->logfile)) |
|
342 | 342 | { |
343 | 343 | return false; |
344 | 344 | } |
345 | 345 | |
346 | 346 | $res = fopen($this->logfile, 'w+'); |
347 | 347 | |
348 | - if($res === false) |
|
348 | + if ($res === false) |
|
349 | 349 | { |
350 | 350 | throw new RequestHelper_Exception( |
351 | 351 | 'Cannot open logfile for writing.', |
@@ -375,7 +375,7 @@ discard block |
||
375 | 375 | |
376 | 376 | $this->setHeader('Expect', ''); |
377 | 377 | |
378 | - foreach($this->headers as $name => $value) { |
|
378 | + foreach ($this->headers as $name => $value) { |
|
379 | 379 | $result[] = $name.': '.$value; |
380 | 380 | } |
381 | 381 | |
@@ -392,7 +392,7 @@ discard block |
||
392 | 392 | { |
393 | 393 | $response = $this->getResponse(); |
394 | 394 | |
395 | - if($response !== null) { |
|
395 | + if ($response !== null) { |
|
396 | 396 | return $response->getHeaders(); |
397 | 397 | } |
398 | 398 | |
@@ -428,7 +428,7 @@ discard block |
||
428 | 428 | */ |
429 | 429 | public function getHeader(string $name) : string |
430 | 430 | { |
431 | - if(isset($this->headers[$name])) |
|
431 | + if (isset($this->headers[$name])) |
|
432 | 432 | { |
433 | 433 | return $this->headers[$name]; |
434 | 434 | } |
@@ -261,8 +261,7 @@ |
||
261 | 261 | $curlCode, |
262 | 262 | curl_error($ch).' | Explanation: '.curl_strerror($curlCode) |
263 | 263 | ); |
264 | - } |
|
265 | - else |
|
264 | + } else |
|
266 | 265 | { |
267 | 266 | $this->response->setBody((string)$output); |
268 | 267 | } |
@@ -32,62 +32,62 @@ discard block |
||
32 | 32 | const ERROR_CURL_INIT_FAILED = 17903; |
33 | 33 | const ERROR_CANNOT_OPEN_LOGFILE = 17904; |
34 | 34 | |
35 | - /** |
|
36 | - * @var string |
|
37 | - */ |
|
35 | + /** |
|
36 | + * @var string |
|
37 | + */ |
|
38 | 38 | protected $eol = "\r\n"; |
39 | 39 | |
40 | - /** |
|
41 | - * @var string |
|
42 | - */ |
|
40 | + /** |
|
41 | + * @var string |
|
42 | + */ |
|
43 | 43 | protected $mimeBoundary; |
44 | 44 | |
45 | - /** |
|
46 | - * @var string |
|
47 | - */ |
|
45 | + /** |
|
46 | + * @var string |
|
47 | + */ |
|
48 | 48 | protected $destination; |
49 | 49 | |
50 | - /** |
|
51 | - * @var array<string,string> |
|
52 | - */ |
|
50 | + /** |
|
51 | + * @var array<string,string> |
|
52 | + */ |
|
53 | 53 | protected $headers = array(); |
54 | 54 | |
55 | - /** |
|
56 | - * Whether to verify SSL certificates. |
|
57 | - * @var bool |
|
58 | - */ |
|
55 | + /** |
|
56 | + * Whether to verify SSL certificates. |
|
57 | + * @var bool |
|
58 | + */ |
|
59 | 59 | protected $verifySSL = true; |
60 | 60 | |
61 | - /** |
|
62 | - * @var RequestHelper_Boundaries |
|
63 | - */ |
|
61 | + /** |
|
62 | + * @var RequestHelper_Boundaries |
|
63 | + */ |
|
64 | 64 | protected $boundaries; |
65 | 65 | |
66 | - /** |
|
67 | - * @var RequestHelper_Response|NULL |
|
68 | - */ |
|
66 | + /** |
|
67 | + * @var RequestHelper_Response|NULL |
|
68 | + */ |
|
69 | 69 | protected $response; |
70 | 70 | |
71 | - /** |
|
72 | - * Timeout duration, in seconds. |
|
73 | - * @var integer |
|
74 | - */ |
|
71 | + /** |
|
72 | + * Timeout duration, in seconds. |
|
73 | + * @var integer |
|
74 | + */ |
|
75 | 75 | protected $timeout = 30; |
76 | 76 | |
77 | - /** |
|
78 | - * @var string |
|
79 | - */ |
|
77 | + /** |
|
78 | + * @var string |
|
79 | + */ |
|
80 | 80 | protected $logfile = ''; |
81 | 81 | |
82 | - /** |
|
83 | - * @var resource|NULL |
|
84 | - */ |
|
82 | + /** |
|
83 | + * @var resource|NULL |
|
84 | + */ |
|
85 | 85 | protected $logfilePointer = null; |
86 | 86 | |
87 | - /** |
|
88 | - * Creates a new request helper to send POST data to the specified destination URL. |
|
89 | - * @param string $destinationURL |
|
90 | - */ |
|
87 | + /** |
|
88 | + * Creates a new request helper to send POST data to the specified destination URL. |
|
89 | + * @param string $destinationURL |
|
90 | + */ |
|
91 | 91 | public function __construct(string $destinationURL) |
92 | 92 | { |
93 | 93 | $this->destination = $destinationURL; |
@@ -112,13 +112,13 @@ discard block |
||
112 | 112 | return $this->eol; |
113 | 113 | } |
114 | 114 | |
115 | - /** |
|
116 | - * Sets the timeout for the request, in seconds. If the request |
|
117 | - * takes longer, it will be cancelled and an exception triggered. |
|
118 | - * |
|
119 | - * @param int $seconds |
|
120 | - * @return RequestHelper |
|
121 | - */ |
|
115 | + /** |
|
116 | + * Sets the timeout for the request, in seconds. If the request |
|
117 | + * takes longer, it will be cancelled and an exception triggered. |
|
118 | + * |
|
119 | + * @param int $seconds |
|
120 | + * @return RequestHelper |
|
121 | + */ |
|
122 | 122 | public function setTimeout(int $seconds) : RequestHelper |
123 | 123 | { |
124 | 124 | $this->timeout = $seconds; |
@@ -131,13 +131,13 @@ discard block |
||
131 | 131 | return $this->timeout; |
132 | 132 | } |
133 | 133 | |
134 | - /** |
|
135 | - * Enables verbose logging of the CURL request, which |
|
136 | - * is then redirected to the target file. |
|
137 | - * |
|
138 | - * @param string $targetFile |
|
139 | - * @return RequestHelper |
|
140 | - */ |
|
134 | + /** |
|
135 | + * Enables verbose logging of the CURL request, which |
|
136 | + * is then redirected to the target file. |
|
137 | + * |
|
138 | + * @param string $targetFile |
|
139 | + * @return RequestHelper |
|
140 | + */ |
|
141 | 141 | public function enableLogging(string $targetFile) : RequestHelper |
142 | 142 | { |
143 | 143 | $this->logfile = $targetFile; |
@@ -145,15 +145,15 @@ discard block |
||
145 | 145 | return $this; |
146 | 146 | } |
147 | 147 | |
148 | - /** |
|
149 | - * Adds a file to be sent with the request. |
|
150 | - * |
|
151 | - * @param string $varName The variable name to send the file in |
|
152 | - * @param string $fileName The name of the file as it should be received at the destination |
|
153 | - * @param string $content The raw content of the file |
|
154 | - * @param string $contentType The content type, use the constants to specify this |
|
155 | - * @param string $encoding The encoding of the file, use the constants to specify this |
|
156 | - */ |
|
148 | + /** |
|
149 | + * Adds a file to be sent with the request. |
|
150 | + * |
|
151 | + * @param string $varName The variable name to send the file in |
|
152 | + * @param string $fileName The name of the file as it should be received at the destination |
|
153 | + * @param string $content The raw content of the file |
|
154 | + * @param string $contentType The content type, use the constants to specify this |
|
155 | + * @param string $encoding The encoding of the file, use the constants to specify this |
|
156 | + */ |
|
157 | 157 | public function addFile(string $varName, string $fileName, string $content, string $contentType = '', string $encoding = '') : RequestHelper |
158 | 158 | { |
159 | 159 | $this->boundaries->addFile($varName, $fileName, $content, $contentType, $encoding); |
@@ -161,13 +161,13 @@ discard block |
||
161 | 161 | return $this; |
162 | 162 | } |
163 | 163 | |
164 | - /** |
|
165 | - * Adds arbitrary content. |
|
166 | - * |
|
167 | - * @param string $varName The variable name to send the content in. |
|
168 | - * @param string $content |
|
169 | - * @param string $contentType |
|
170 | - */ |
|
164 | + /** |
|
165 | + * Adds arbitrary content. |
|
166 | + * |
|
167 | + * @param string $varName The variable name to send the content in. |
|
168 | + * @param string $content |
|
169 | + * @param string $contentType |
|
170 | + */ |
|
171 | 171 | public function addContent(string $varName, string $content, string $contentType) : RequestHelper |
172 | 172 | { |
173 | 173 | $this->boundaries->addContent($varName, $content, $contentType); |
@@ -175,13 +175,13 @@ discard block |
||
175 | 175 | return $this; |
176 | 176 | } |
177 | 177 | |
178 | - /** |
|
179 | - * Adds a variable to be sent with the request. If it |
|
180 | - * already exists, its value is overwritten. |
|
181 | - * |
|
182 | - * @param string $name |
|
183 | - * @param string $value |
|
184 | - */ |
|
178 | + /** |
|
179 | + * Adds a variable to be sent with the request. If it |
|
180 | + * already exists, its value is overwritten. |
|
181 | + * |
|
182 | + * @param string $name |
|
183 | + * @param string $value |
|
184 | + */ |
|
185 | 185 | public function addVariable(string $name, string $value) : RequestHelper |
186 | 186 | { |
187 | 187 | $this->boundaries->addVariable($name, $value); |
@@ -189,13 +189,13 @@ discard block |
||
189 | 189 | return $this; |
190 | 190 | } |
191 | 191 | |
192 | - /** |
|
193 | - * Sets an HTTP header to include in the request. |
|
194 | - * |
|
195 | - * @param string $name |
|
196 | - * @param string $value |
|
197 | - * @return RequestHelper |
|
198 | - */ |
|
192 | + /** |
|
193 | + * Sets an HTTP header to include in the request. |
|
194 | + * |
|
195 | + * @param string $name |
|
196 | + * @param string $value |
|
197 | + * @return RequestHelper |
|
198 | + */ |
|
199 | 199 | public function setHeader(string $name, string $value) : RequestHelper |
200 | 200 | { |
201 | 201 | $this->headers[$name] = $value; |
@@ -203,36 +203,36 @@ discard block |
||
203 | 203 | return $this; |
204 | 204 | } |
205 | 205 | |
206 | - /** |
|
207 | - * Disables SSL certificate checking. |
|
208 | - * |
|
209 | - * @return RequestHelper |
|
210 | - */ |
|
206 | + /** |
|
207 | + * Disables SSL certificate checking. |
|
208 | + * |
|
209 | + * @return RequestHelper |
|
210 | + */ |
|
211 | 211 | public function disableSSLChecks() : RequestHelper |
212 | 212 | { |
213 | 213 | $this->verifySSL = false; |
214 | 214 | return $this; |
215 | 215 | } |
216 | 216 | |
217 | - /** |
|
218 | - * @var integer |
|
219 | - */ |
|
217 | + /** |
|
218 | + * @var integer |
|
219 | + */ |
|
220 | 220 | protected $contentLength = 0; |
221 | 221 | |
222 | - /** |
|
223 | - * Sends the POST request to the destination, and returns |
|
224 | - * the response text. |
|
225 | - * |
|
226 | - * The response object is stored internally, so after calling |
|
227 | - * this method it may be retrieved at any moment using the |
|
228 | - * {@link getResponse()} method. |
|
229 | - * |
|
230 | - * @return string |
|
231 | - * @see RequestHelper::getResponse() |
|
232 | - * @throws RequestHelper_Exception |
|
233 | - * |
|
234 | - * @see RequestHelper::ERROR_REQUEST_FAILED |
|
235 | - */ |
|
222 | + /** |
|
223 | + * Sends the POST request to the destination, and returns |
|
224 | + * the response text. |
|
225 | + * |
|
226 | + * The response object is stored internally, so after calling |
|
227 | + * this method it may be retrieved at any moment using the |
|
228 | + * {@link getResponse()} method. |
|
229 | + * |
|
230 | + * @return string |
|
231 | + * @see RequestHelper::getResponse() |
|
232 | + * @throws RequestHelper_Exception |
|
233 | + * |
|
234 | + * @see RequestHelper::ERROR_REQUEST_FAILED |
|
235 | + */ |
|
236 | 236 | public function send() : string |
237 | 237 | { |
238 | 238 | $info = parseURL($this->destination); |
@@ -272,26 +272,26 @@ discard block |
||
272 | 272 | return $this->response->getResponseBody(); |
273 | 273 | } |
274 | 274 | |
275 | - /** |
|
276 | - * Retrieves the request's body content. This is an alias |
|
277 | - * for {@see RequestHelper::getMimeBody()}. |
|
278 | - * |
|
279 | - * @return string |
|
280 | - * @see RequestHelper::getMimeBody() |
|
281 | - */ |
|
275 | + /** |
|
276 | + * Retrieves the request's body content. This is an alias |
|
277 | + * for {@see RequestHelper::getMimeBody()}. |
|
278 | + * |
|
279 | + * @return string |
|
280 | + * @see RequestHelper::getMimeBody() |
|
281 | + */ |
|
282 | 282 | public function getBody() : string |
283 | 283 | { |
284 | 284 | return $this->getMimeBody(); |
285 | 285 | } |
286 | 286 | |
287 | - /** |
|
288 | - * Creates a new CURL resource configured according to the |
|
289 | - * request's settings. |
|
290 | - * |
|
291 | - * @param URLInfo $url |
|
292 | - * @throws RequestHelper_Exception |
|
293 | - * @return resource |
|
294 | - */ |
|
287 | + /** |
|
288 | + * Creates a new CURL resource configured according to the |
|
289 | + * request's settings. |
|
290 | + * |
|
291 | + * @param URLInfo $url |
|
292 | + * @throws RequestHelper_Exception |
|
293 | + * @return resource |
|
294 | + */ |
|
295 | 295 | protected function createCURL(URLInfo $url) |
296 | 296 | { |
297 | 297 | $ch = curl_init(); |
@@ -339,10 +339,10 @@ discard block |
||
339 | 339 | return $ch; |
340 | 340 | } |
341 | 341 | |
342 | - /** |
|
343 | - * @param resource $ch |
|
344 | - * @return bool Whether logging is enabled. |
|
345 | - */ |
|
342 | + /** |
|
343 | + * @param resource $ch |
|
344 | + * @return bool Whether logging is enabled. |
|
345 | + */ |
|
346 | 346 | protected function configureLogging($ch) : bool |
347 | 347 | { |
348 | 348 | if(empty($this->logfile)) |
@@ -369,13 +369,13 @@ discard block |
||
369 | 369 | return true; |
370 | 370 | } |
371 | 371 | |
372 | - /** |
|
373 | - * Compiles the associative headers array into |
|
374 | - * the format understood by CURL, namely an indexed |
|
375 | - * array with one header string per entry. |
|
376 | - * |
|
377 | - * @return array |
|
378 | - */ |
|
372 | + /** |
|
373 | + * Compiles the associative headers array into |
|
374 | + * the format understood by CURL, namely an indexed |
|
375 | + * array with one header string per entry. |
|
376 | + * |
|
377 | + * @return array |
|
378 | + */ |
|
379 | 379 | protected function renderHeaders() : array |
380 | 380 | { |
381 | 381 | $result = array(); |
@@ -389,12 +389,12 @@ discard block |
||
389 | 389 | return $result; |
390 | 390 | } |
391 | 391 | |
392 | - /** |
|
393 | - * Retrieves the raw response header, in the form of an indexed |
|
394 | - * array containing all response header lines. |
|
395 | - * |
|
396 | - * @return array |
|
397 | - */ |
|
392 | + /** |
|
393 | + * Retrieves the raw response header, in the form of an indexed |
|
394 | + * array containing all response header lines. |
|
395 | + * |
|
396 | + * @return array |
|
397 | + */ |
|
398 | 398 | public function getResponseHeader() : array |
399 | 399 | { |
400 | 400 | $response = $this->getResponse(); |
@@ -406,33 +406,33 @@ discard block |
||
406 | 406 | return array(); |
407 | 407 | } |
408 | 408 | |
409 | - /** |
|
410 | - * After calling the {@link send()} method, this may be used to |
|
411 | - * retrieve the response text from the POST request. |
|
412 | - * |
|
413 | - * @return RequestHelper_Response|NULL |
|
414 | - */ |
|
409 | + /** |
|
410 | + * After calling the {@link send()} method, this may be used to |
|
411 | + * retrieve the response text from the POST request. |
|
412 | + * |
|
413 | + * @return RequestHelper_Response|NULL |
|
414 | + */ |
|
415 | 415 | public function getResponse() : ?RequestHelper_Response |
416 | 416 | { |
417 | 417 | return $this->response; |
418 | 418 | } |
419 | 419 | |
420 | - /** |
|
421 | - * Retrieves all headers set until now. |
|
422 | - * |
|
423 | - * @return array<string,string> |
|
424 | - */ |
|
420 | + /** |
|
421 | + * Retrieves all headers set until now. |
|
422 | + * |
|
423 | + * @return array<string,string> |
|
424 | + */ |
|
425 | 425 | public function getHeaders() : array |
426 | 426 | { |
427 | 427 | return $this->headers; |
428 | 428 | } |
429 | 429 | |
430 | - /** |
|
431 | - * Retrieves the value of a header by its name. |
|
432 | - * |
|
433 | - * @param string $name |
|
434 | - * @return string The header value, or an empty string if not set. |
|
435 | - */ |
|
430 | + /** |
|
431 | + * Retrieves the value of a header by its name. |
|
432 | + * |
|
433 | + * @param string $name |
|
434 | + * @return string The header value, or an empty string if not set. |
|
435 | + */ |
|
436 | 436 | public function getHeader(string $name) : string |
437 | 437 | { |
438 | 438 | if(isset($this->headers[$name])) |
@@ -25,17 +25,17 @@ |
||
25 | 25 | * |
26 | 26 | * @return string |
27 | 27 | */ |
28 | - function render() : string; |
|
28 | + function render() : string; |
|
29 | 29 | |
30 | 30 | /** |
31 | 31 | * Converts the string builder to a string. |
32 | 32 | * |
33 | 33 | * @return string |
34 | 34 | */ |
35 | - function __toString(); |
|
35 | + function __toString(); |
|
36 | 36 | |
37 | 37 | /** |
38 | 38 | * Renders the string and echos it. |
39 | 39 | */ |
40 | - function display() : void; |
|
40 | + function display() : void; |
|
41 | 41 | } |
@@ -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 | } |
@@ -288,10 +288,10 @@ discard block |
||
288 | 288 | * @param bool $newTab |
289 | 289 | * @return $this |
290 | 290 | */ |
291 | - public function link(string $label, string $url, bool $newTab=false) : StringBuilder |
|
291 | + public function link(string $label, string $url, bool $newTab = false) : StringBuilder |
|
292 | 292 | { |
293 | 293 | $target = ''; |
294 | - if($newTab) { |
|
294 | + if ($newTab) { |
|
295 | 295 | $target = ' target="_blank"'; |
296 | 296 | } |
297 | 297 | |
@@ -337,7 +337,7 @@ discard block |
||
337 | 337 | */ |
338 | 338 | protected function spanned($string, $classes) : StringBuilder |
339 | 339 | { |
340 | - if(!is_array($classes)) |
|
340 | + if (!is_array($classes)) |
|
341 | 341 | { |
342 | 342 | $classes = array(strval($classes)); |
343 | 343 | } |
@@ -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,74 +220,74 @@ discard block |
||
220 | 220 | ); |
221 | 221 | } |
222 | 222 | |
223 | - /** |
|
224 | - * Adds a HTML `br` tag. |
|
225 | - * |
|
226 | - * @return $this |
|
227 | - */ |
|
223 | + /** |
|
224 | + * Adds a HTML `br` tag. |
|
225 | + * |
|
226 | + * @return $this |
|
227 | + */ |
|
228 | 228 | public function nl() : StringBuilder |
229 | 229 | { |
230 | 230 | return $this->html('<br>'); |
231 | 231 | } |
232 | 232 | |
233 | - /** |
|
234 | - * Adds the current time, in the format <code>H:i:s</code>. |
|
235 | - * |
|
236 | - * @return $this |
|
237 | - */ |
|
233 | + /** |
|
234 | + * Adds the current time, in the format <code>H:i:s</code>. |
|
235 | + * |
|
236 | + * @return $this |
|
237 | + */ |
|
238 | 238 | public function time() : StringBuilder |
239 | 239 | { |
240 | 240 | return $this->add(date('H:i:s')); |
241 | 241 | } |
242 | 242 | |
243 | - /** |
|
244 | - * Adds the "Note:" text. |
|
245 | - * |
|
246 | - * @return $this |
|
247 | - */ |
|
243 | + /** |
|
244 | + * Adds the "Note:" text. |
|
245 | + * |
|
246 | + * @return $this |
|
247 | + */ |
|
248 | 248 | public function note() : StringBuilder |
249 | 249 | { |
250 | 250 | return $this->t('Note:'); |
251 | 251 | } |
252 | 252 | |
253 | - /** |
|
254 | - * Like `note()`, but as bold text. |
|
255 | - * |
|
256 | - * @return $this |
|
257 | - */ |
|
253 | + /** |
|
254 | + * Like `note()`, but as bold text. |
|
255 | + * |
|
256 | + * @return $this |
|
257 | + */ |
|
258 | 258 | public function noteBold() : StringBuilder |
259 | 259 | { |
260 | 260 | return $this->bold(sb()->note()); |
261 | 261 | } |
262 | 262 | |
263 | - /** |
|
264 | - * Adds the "Hint:" text. |
|
265 | - * |
|
266 | - * @return $this |
|
267 | - */ |
|
263 | + /** |
|
264 | + * Adds the "Hint:" text. |
|
265 | + * |
|
266 | + * @return $this |
|
267 | + */ |
|
268 | 268 | public function hint() : StringBuilder |
269 | 269 | { |
270 | 270 | return $this->t('Hint:'); |
271 | 271 | } |
272 | 272 | |
273 | - /** |
|
274 | - * Adds two linebreaks. |
|
275 | - * |
|
276 | - * @return $this |
|
277 | - */ |
|
273 | + /** |
|
274 | + * Adds two linebreaks. |
|
275 | + * |
|
276 | + * @return $this |
|
277 | + */ |
|
278 | 278 | public function para() : StringBuilder |
279 | 279 | { |
280 | 280 | return $this->nl()->nl(); |
281 | 281 | } |
282 | 282 | |
283 | - /** |
|
284 | - * Adds an anchor HTML tag. |
|
285 | - * |
|
286 | - * @param string $label |
|
287 | - * @param string $url |
|
288 | - * @param bool $newTab |
|
289 | - * @return $this |
|
290 | - */ |
|
283 | + /** |
|
284 | + * Adds an anchor HTML tag. |
|
285 | + * |
|
286 | + * @param string $label |
|
287 | + * @param string $url |
|
288 | + * @param bool $newTab |
|
289 | + * @return $this |
|
290 | + */ |
|
291 | 291 | public function link(string $label, string $url, bool $newTab=false) : StringBuilder |
292 | 292 | { |
293 | 293 | $target = ''; |
@@ -303,12 +303,12 @@ discard block |
||
303 | 303 | ); |
304 | 304 | } |
305 | 305 | |
306 | - /** |
|
307 | - * Wraps the string in a `code` tag. |
|
308 | - * |
|
309 | - * @param string|number|StringBuilder_Interface $string |
|
310 | - * @return $this |
|
311 | - */ |
|
306 | + /** |
|
307 | + * Wraps the string in a `code` tag. |
|
308 | + * |
|
309 | + * @param string|number|StringBuilder_Interface $string |
|
310 | + * @return $this |
|
311 | + */ |
|
312 | 312 | public function code($string) : StringBuilder |
313 | 313 | { |
314 | 314 | return $this->sf( |
@@ -317,24 +317,24 @@ discard block |
||
317 | 317 | ); |
318 | 318 | } |
319 | 319 | |
320 | - /** |
|
321 | - * Wraps the string in a `pre` tag. |
|
322 | - * |
|
323 | - * @param string|number|StringBuilder_Interface $string |
|
324 | - * @return $this |
|
325 | - */ |
|
320 | + /** |
|
321 | + * Wraps the string in a `pre` tag. |
|
322 | + * |
|
323 | + * @param string|number|StringBuilder_Interface $string |
|
324 | + * @return $this |
|
325 | + */ |
|
326 | 326 | public function pre($string) : StringBuilder |
327 | 327 | { |
328 | 328 | return $this->sf('<pre>%s</pre>', strval($string)); |
329 | 329 | } |
330 | 330 | |
331 | - /** |
|
332 | - * Wraps the text in a `span` tag with the specified classes. |
|
333 | - * |
|
334 | - * @param string|number|StringBuilder_Interface $string |
|
335 | - * @param string|string[] $classes |
|
336 | - * @return $this |
|
337 | - */ |
|
331 | + /** |
|
332 | + * Wraps the text in a `span` tag with the specified classes. |
|
333 | + * |
|
334 | + * @param string|number|StringBuilder_Interface $string |
|
335 | + * @param string|string[] $classes |
|
336 | + * @return $this |
|
337 | + */ |
|
338 | 338 | protected function spanned($string, $classes) : StringBuilder |
339 | 339 | { |
340 | 340 | if(!is_array($classes)) |
@@ -28,9 +28,9 @@ discard block |
||
28 | 28 | { |
29 | 29 | const ERROR_CANNOT_APPEND_FRAGMENT = 491001; |
30 | 30 | |
31 | - /** |
|
32 | - * @var boolean |
|
33 | - */ |
|
31 | + /** |
|
32 | + * @var boolean |
|
33 | + */ |
|
34 | 34 | private static $simulation = false; |
35 | 35 | |
36 | 36 | /** |
@@ -38,11 +38,11 @@ discard block |
||
38 | 38 | */ |
39 | 39 | private $dom; |
40 | 40 | |
41 | - /** |
|
42 | - * Creates a new XMLHelper instance. |
|
43 | - * |
|
44 | - * @return XMLHelper |
|
45 | - */ |
|
41 | + /** |
|
42 | + * Creates a new XMLHelper instance. |
|
43 | + * |
|
44 | + * @return XMLHelper |
|
45 | + */ |
|
46 | 46 | public static function create() : XMLHelper |
47 | 47 | { |
48 | 48 | $dom = new DOMDocument('1.0', 'UTF-8'); |
@@ -51,72 +51,72 @@ discard block |
||
51 | 51 | return new XMLHelper($dom); |
52 | 52 | } |
53 | 53 | |
54 | - /** |
|
55 | - * Creates a converter instance from an XML file. |
|
56 | - * @param string $xmlFile |
|
57 | - * @return XMLHelper_Converter |
|
58 | - */ |
|
54 | + /** |
|
55 | + * Creates a converter instance from an XML file. |
|
56 | + * @param string $xmlFile |
|
57 | + * @return XMLHelper_Converter |
|
58 | + */ |
|
59 | 59 | public static function convertFile(string $xmlFile) : XMLHelper_Converter |
60 | 60 | { |
61 | 61 | return XMLHelper_Converter::fromFile($xmlFile); |
62 | 62 | } |
63 | 63 | |
64 | - /** |
|
65 | - * Creates a converter from an XML string. |
|
66 | - * @param string $xmlString |
|
67 | - * @return XMLHelper_Converter |
|
68 | - */ |
|
64 | + /** |
|
65 | + * Creates a converter from an XML string. |
|
66 | + * @param string $xmlString |
|
67 | + * @return XMLHelper_Converter |
|
68 | + */ |
|
69 | 69 | public static function convertString(string $xmlString) : XMLHelper_Converter |
70 | 70 | { |
71 | 71 | return XMLHelper_Converter::fromString($xmlString); |
72 | 72 | } |
73 | 73 | |
74 | - /** |
|
75 | - * Creates a converter from a SimpleXMLElement instance. |
|
76 | - * @param SimpleXMLElement $element |
|
77 | - * @return XMLHelper_Converter |
|
78 | - */ |
|
74 | + /** |
|
75 | + * Creates a converter from a SimpleXMLElement instance. |
|
76 | + * @param SimpleXMLElement $element |
|
77 | + * @return XMLHelper_Converter |
|
78 | + */ |
|
79 | 79 | public static function convertElement(SimpleXMLElement $element) : XMLHelper_Converter |
80 | 80 | { |
81 | 81 | return XMLHelper_Converter::fromElement($element); |
82 | 82 | } |
83 | 83 | |
84 | - /** |
|
85 | - * Creates a converter from a DOMElement instance. |
|
86 | - * @param DOMElement $element |
|
87 | - * @return XMLHelper_Converter |
|
88 | - */ |
|
84 | + /** |
|
85 | + * Creates a converter from a DOMElement instance. |
|
86 | + * @param DOMElement $element |
|
87 | + * @return XMLHelper_Converter |
|
88 | + */ |
|
89 | 89 | public static function convertDOMElement(DOMElement $element) : XMLHelper_Converter |
90 | 90 | { |
91 | 91 | return XMLHelper_Converter::fromDOMElement($element); |
92 | 92 | } |
93 | 93 | |
94 | - /** |
|
95 | - * Creates a new helper using an existing DOMDocument object. |
|
96 | - * @param DOMDocument $dom |
|
97 | - */ |
|
94 | + /** |
|
95 | + * Creates a new helper using an existing DOMDocument object. |
|
96 | + * @param DOMDocument $dom |
|
97 | + */ |
|
98 | 98 | public function __construct(DOMDocument $dom) |
99 | 99 | { |
100 | 100 | $this->dom = $dom; |
101 | 101 | } |
102 | 102 | |
103 | - /** |
|
104 | - * @return DOMDocument |
|
105 | - */ |
|
103 | + /** |
|
104 | + * @return DOMDocument |
|
105 | + */ |
|
106 | 106 | public function getDOM() : DOMDocument |
107 | 107 | { |
108 | 108 | return $this->dom; |
109 | 109 | } |
110 | 110 | |
111 | - /** |
|
112 | - * Adds an attribute to an existing tag with |
|
113 | - * the specified value. |
|
114 | - * |
|
115 | - * @param DOMNode $parent |
|
116 | - * @param string $name |
|
117 | - * @param mixed $value |
|
118 | - * @return DOMNode |
|
119 | - */ |
|
111 | + /** |
|
112 | + * Adds an attribute to an existing tag with |
|
113 | + * the specified value. |
|
114 | + * |
|
115 | + * @param DOMNode $parent |
|
116 | + * @param string $name |
|
117 | + * @param mixed $value |
|
118 | + * @return DOMNode |
|
119 | + */ |
|
120 | 120 | public function addAttribute(DOMNode $parent, string $name, $value) |
121 | 121 | { |
122 | 122 | $node = $this->dom->createAttribute($name); |
@@ -126,12 +126,12 @@ discard block |
||
126 | 126 | return $parent->appendChild($node); |
127 | 127 | } |
128 | 128 | |
129 | - /** |
|
130 | - * Adds several attributes to the target node. |
|
131 | - * |
|
132 | - * @param DOMNode $parent |
|
133 | - * @param array<string,mixed> $attributes |
|
134 | - */ |
|
129 | + /** |
|
130 | + * Adds several attributes to the target node. |
|
131 | + * |
|
132 | + * @param DOMNode $parent |
|
133 | + * @param array<string,mixed> $attributes |
|
134 | + */ |
|
135 | 135 | public function addAttributes(DOMNode $parent, array $attributes) : void |
136 | 136 | { |
137 | 137 | foreach ($attributes as $name => $value) { |
@@ -139,14 +139,14 @@ discard block |
||
139 | 139 | } |
140 | 140 | } |
141 | 141 | |
142 | - /** |
|
143 | - * Adds a tag without content. |
|
144 | - * |
|
145 | - * @param DOMNode $parent |
|
146 | - * @param string $name |
|
147 | - * @param integer $indent |
|
148 | - * @return DOMNode |
|
149 | - */ |
|
142 | + /** |
|
143 | + * Adds a tag without content. |
|
144 | + * |
|
145 | + * @param DOMNode $parent |
|
146 | + * @param string $name |
|
147 | + * @param integer $indent |
|
148 | + * @return DOMNode |
|
149 | + */ |
|
150 | 150 | public function addTag(DOMNode $parent, string $name, int $indent = 0) : DOMNode |
151 | 151 | { |
152 | 152 | if ($indent > 0) { |
@@ -168,17 +168,17 @@ discard block |
||
168 | 168 | $parent->appendChild($this->dom->createTextNode(str_repeat("\t", $amount))); |
169 | 169 | } |
170 | 170 | |
171 | - /** |
|
172 | - * Adds a tag with textual content, like: |
|
173 | - * |
|
174 | - * <tagname>text</tagname> |
|
175 | - * |
|
176 | - * @param DOMNode $parent |
|
177 | - * @param string $name |
|
178 | - * @param string $text |
|
179 | - * @param integer $indent |
|
180 | - * @return DOMNode |
|
181 | - */ |
|
171 | + /** |
|
172 | + * Adds a tag with textual content, like: |
|
173 | + * |
|
174 | + * <tagname>text</tagname> |
|
175 | + * |
|
176 | + * @param DOMNode $parent |
|
177 | + * @param string $name |
|
178 | + * @param string $text |
|
179 | + * @param integer $indent |
|
180 | + * @return DOMNode |
|
181 | + */ |
|
182 | 182 | public function addTextTag(DOMNode $parent, string $name, string $text, int $indent = 0) : DOMNode |
183 | 183 | { |
184 | 184 | if ($indent > 0) { |
@@ -192,19 +192,19 @@ discard block |
||
192 | 192 | return $parent->appendChild($tag); |
193 | 193 | } |
194 | 194 | |
195 | - /** |
|
196 | - * Adds a tag with textual content, like: |
|
197 | - * |
|
198 | - * <tagname>text</tagname> |
|
199 | - * |
|
200 | - * and removes <p> tags |
|
201 | - * |
|
202 | - * @param DOMNode $parent |
|
203 | - * @param string $name |
|
204 | - * @param string $text |
|
205 | - * @param integer $indent |
|
206 | - * @return DOMNode |
|
207 | - */ |
|
195 | + /** |
|
196 | + * Adds a tag with textual content, like: |
|
197 | + * |
|
198 | + * <tagname>text</tagname> |
|
199 | + * |
|
200 | + * and removes <p> tags |
|
201 | + * |
|
202 | + * @param DOMNode $parent |
|
203 | + * @param string $name |
|
204 | + * @param string $text |
|
205 | + * @param integer $indent |
|
206 | + * @return DOMNode |
|
207 | + */ |
|
208 | 208 | public function addEscapedTag(DOMNode $parent, string $name, string $text, int $indent = 0) |
209 | 209 | { |
210 | 210 | if ($indent > 0) { |
@@ -220,19 +220,19 @@ discard block |
||
220 | 220 | return $parent->appendChild($tag); |
221 | 221 | } |
222 | 222 | |
223 | - /** |
|
224 | - * Adds a tag with HTML content, like: |
|
225 | - * |
|
226 | - * <tagname><i>text</i></tagname> |
|
227 | - * |
|
228 | - * Tags will not be escaped. |
|
229 | - * |
|
230 | - * @param DOMNode $parent |
|
231 | - * @param string $name |
|
232 | - * @param string $text |
|
233 | - * @param integer $indent |
|
234 | - * @return DOMNode |
|
235 | - */ |
|
223 | + /** |
|
224 | + * Adds a tag with HTML content, like: |
|
225 | + * |
|
226 | + * <tagname><i>text</i></tagname> |
|
227 | + * |
|
228 | + * Tags will not be escaped. |
|
229 | + * |
|
230 | + * @param DOMNode $parent |
|
231 | + * @param string $name |
|
232 | + * @param string $text |
|
233 | + * @param integer $indent |
|
234 | + * @return DOMNode |
|
235 | + */ |
|
236 | 236 | public function addFragmentTag(DOMNode $parent, string $name, string $text, int $indent = 0) |
237 | 237 | { |
238 | 238 | if ($indent > 0) { |
@@ -260,16 +260,16 @@ discard block |
||
260 | 260 | return $parent->appendChild($tag); |
261 | 261 | } |
262 | 262 | |
263 | - /** |
|
264 | - * Adds a tag with CDATA content, like: |
|
265 | - * |
|
266 | - * <tagname><![CDATA[value]]></tagname> |
|
267 | - * |
|
268 | - * @param DOMNode $parent |
|
269 | - * @param string $name |
|
270 | - * @param string $content |
|
271 | - * @return DOMNode |
|
272 | - */ |
|
263 | + /** |
|
264 | + * Adds a tag with CDATA content, like: |
|
265 | + * |
|
266 | + * <tagname><![CDATA[value]]></tagname> |
|
267 | + * |
|
268 | + * @param DOMNode $parent |
|
269 | + * @param string $name |
|
270 | + * @param string $content |
|
271 | + * @return DOMNode |
|
272 | + */ |
|
273 | 273 | public function addCDATATag(DOMNode $parent, string $name, string $content) : DOMNode |
274 | 274 | { |
275 | 275 | $tag = $this->dom->createElement($name); |
@@ -279,12 +279,12 @@ discard block |
||
279 | 279 | return $parent->appendChild($tag); |
280 | 280 | } |
281 | 281 | |
282 | - /** |
|
283 | - * Creates the root element of the document. |
|
284 | - * @param string $name |
|
285 | - * @param array<string,mixed> $attributes |
|
286 | - * @return DOMNode |
|
287 | - */ |
|
282 | + /** |
|
283 | + * Creates the root element of the document. |
|
284 | + * @param string $name |
|
285 | + * @param array<string,mixed> $attributes |
|
286 | + * @return DOMNode |
|
287 | + */ |
|
288 | 288 | public function createRoot(string $name, array $attributes=array()) |
289 | 289 | { |
290 | 290 | $root = $this->dom->appendChild($this->dom->createElement($name)); |
@@ -292,12 +292,12 @@ discard block |
||
292 | 292 | return $root; |
293 | 293 | } |
294 | 294 | |
295 | - /** |
|
296 | - * Escaped the string for use in XML. |
|
297 | - * |
|
298 | - * @param string $string |
|
299 | - * @return string |
|
300 | - */ |
|
295 | + /** |
|
296 | + * Escaped the string for use in XML. |
|
297 | + * |
|
298 | + * @param string $string |
|
299 | + * @return string |
|
300 | + */ |
|
301 | 301 | public function escape(string $string) : string |
302 | 302 | { |
303 | 303 | $string = preg_replace('#<p>(.*)</p>#isUm', '$1', $string); |
@@ -317,18 +317,18 @@ discard block |
||
317 | 317 | return $string; |
318 | 318 | } |
319 | 319 | |
320 | - /** |
|
321 | - * Sends the specified XML string to the browser with |
|
322 | - * the correct headers to trigger a download of the XML |
|
323 | - * to a local file. |
|
324 | - * |
|
325 | - * NOTE: Ensure calling exit after this is done, and to |
|
326 | - * not send additional content, which would corrupt the |
|
327 | - * download. |
|
328 | - * |
|
329 | - * @param string $xml |
|
330 | - * @param string $filename |
|
331 | - */ |
|
320 | + /** |
|
321 | + * Sends the specified XML string to the browser with |
|
322 | + * the correct headers to trigger a download of the XML |
|
323 | + * to a local file. |
|
324 | + * |
|
325 | + * NOTE: Ensure calling exit after this is done, and to |
|
326 | + * not send additional content, which would corrupt the |
|
327 | + * download. |
|
328 | + * |
|
329 | + * @param string $xml |
|
330 | + * @param string $filename |
|
331 | + */ |
|
332 | 332 | public static function downloadXML(string $xml, string $filename = 'download.xml') : void |
333 | 333 | { |
334 | 334 | if(!headers_sent() && !self::$simulation) |
@@ -339,12 +339,12 @@ discard block |
||
339 | 339 | echo $xml; |
340 | 340 | } |
341 | 341 | |
342 | - /** |
|
343 | - * Sends the specified XML string to the browser with |
|
344 | - * the correct headers and terminates the request. |
|
345 | - * |
|
346 | - * @param string $xml |
|
347 | - */ |
|
342 | + /** |
|
343 | + * Sends the specified XML string to the browser with |
|
344 | + * the correct headers and terminates the request. |
|
345 | + * |
|
346 | + * @param string $xml |
|
347 | + */ |
|
348 | 348 | public static function displayXML(string $xml) : void |
349 | 349 | { |
350 | 350 | if(!headers_sent() && !self::$simulation) |
@@ -411,23 +411,23 @@ discard block |
||
411 | 411 | return $xml->saveXML(); |
412 | 412 | } |
413 | 413 | |
414 | - /** |
|
415 | - * Creates XML markup to describe an application error |
|
416 | - * when using XML services. Creates XML with the |
|
417 | - * following structure: |
|
418 | - * |
|
419 | - * <error> |
|
420 | - * <id>99</id> |
|
421 | - * <message>Full error message text</message> |
|
422 | - * <title>Short error label</title> |
|
423 | - * </error> |
|
424 | - * |
|
425 | - * @param string|number $code |
|
426 | - * @param string $message |
|
427 | - * @param string $title |
|
428 | - * @param array<string,string> $customInfo |
|
429 | - * @return string |
|
430 | - */ |
|
414 | + /** |
|
415 | + * Creates XML markup to describe an application error |
|
416 | + * when using XML services. Creates XML with the |
|
417 | + * following structure: |
|
418 | + * |
|
419 | + * <error> |
|
420 | + * <id>99</id> |
|
421 | + * <message>Full error message text</message> |
|
422 | + * <title>Short error label</title> |
|
423 | + * </error> |
|
424 | + * |
|
425 | + * @param string|number $code |
|
426 | + * @param string $message |
|
427 | + * @param string $title |
|
428 | + * @param array<string,string> $customInfo |
|
429 | + * @return string |
|
430 | + */ |
|
431 | 431 | public static function buildErrorXML($code, string $message, string $title, array $customInfo=array()) |
432 | 432 | { |
433 | 433 | $xml = new DOMDocument('1.0', 'UTF-8'); |
@@ -460,31 +460,31 @@ discard block |
||
460 | 460 | return $this->dom->saveXML(); |
461 | 461 | } |
462 | 462 | |
463 | - /** |
|
464 | - * Creates a new SimpleXML helper instance: this |
|
465 | - * object is useful to work with loading XML strings |
|
466 | - * and files with easy access to any errors that |
|
467 | - * may occurr, since the simplexml functions can be |
|
468 | - * somewhat cryptic. |
|
469 | - * |
|
470 | - * @return XMLHelper_SimpleXML |
|
471 | - */ |
|
463 | + /** |
|
464 | + * Creates a new SimpleXML helper instance: this |
|
465 | + * object is useful to work with loading XML strings |
|
466 | + * and files with easy access to any errors that |
|
467 | + * may occurr, since the simplexml functions can be |
|
468 | + * somewhat cryptic. |
|
469 | + * |
|
470 | + * @return XMLHelper_SimpleXML |
|
471 | + */ |
|
472 | 472 | public static function createSimplexml() : XMLHelper_SimpleXML |
473 | 473 | { |
474 | 474 | return new XMLHelper_SimpleXML(); |
475 | 475 | } |
476 | 476 | |
477 | - /** |
|
478 | - * Converts a string to valid XML: can be a text only string |
|
479 | - * or an HTML string. Returns valid XML code. |
|
480 | - * |
|
481 | - * NOTE: The string may contain custom tags, which are |
|
482 | - * preserved. |
|
483 | - * |
|
484 | - * @param string $string |
|
485 | - * @throws XMLHelper_Exception |
|
486 | - * @return string |
|
487 | - */ |
|
477 | + /** |
|
478 | + * Converts a string to valid XML: can be a text only string |
|
479 | + * or an HTML string. Returns valid XML code. |
|
480 | + * |
|
481 | + * NOTE: The string may contain custom tags, which are |
|
482 | + * preserved. |
|
483 | + * |
|
484 | + * @param string $string |
|
485 | + * @throws XMLHelper_Exception |
|
486 | + * @return string |
|
487 | + */ |
|
488 | 488 | public static function string2xml(string $string) : string |
489 | 489 | { |
490 | 490 | return XMLHelper_HTMLLoader::loadFragment($string)->fragmentToXML(); |
@@ -243,7 +243,7 @@ discard block |
||
243 | 243 | |
244 | 244 | if (!empty($text)) { |
245 | 245 | $fragment = $this->dom->createDocumentFragment(); |
246 | - if(!@$fragment->appendXML($text)) { |
|
246 | + if (!@$fragment->appendXML($text)) { |
|
247 | 247 | throw new XMLHelper_Exception( |
248 | 248 | 'Cannot append XML fragment', |
249 | 249 | sprintf( |
@@ -285,7 +285,7 @@ discard block |
||
285 | 285 | * @param array<string,mixed> $attributes |
286 | 286 | * @return DOMNode |
287 | 287 | */ |
288 | - public function createRoot(string $name, array $attributes=array()) |
|
288 | + public function createRoot(string $name, array $attributes = array()) |
|
289 | 289 | { |
290 | 290 | $root = $this->dom->appendChild($this->dom->createElement($name)); |
291 | 291 | $this->addAttributes($root, $attributes); |
@@ -311,8 +311,8 @@ discard block |
||
311 | 311 | $string = str_replace('<', 'LT_ESCAPE', $string); |
312 | 312 | $string = str_replace('>', 'GT_ESCAPE', $string); |
313 | 313 | |
314 | - $string = str_replace(' ',' ', $string); |
|
315 | - $string = str_replace('&','&', $string); |
|
314 | + $string = str_replace(' ', ' ', $string); |
|
315 | + $string = str_replace('&', '&', $string); |
|
316 | 316 | |
317 | 317 | return $string; |
318 | 318 | } |
@@ -331,9 +331,9 @@ discard block |
||
331 | 331 | */ |
332 | 332 | public static function downloadXML(string $xml, string $filename = 'download.xml') : void |
333 | 333 | { |
334 | - if(!headers_sent() && !self::$simulation) |
|
334 | + if (!headers_sent() && !self::$simulation) |
|
335 | 335 | { |
336 | - header('Content-Disposition: attachment; filename="' . $filename . '"'); |
|
336 | + header('Content-Disposition: attachment; filename="'.$filename.'"'); |
|
337 | 337 | } |
338 | 338 | |
339 | 339 | echo $xml; |
@@ -347,12 +347,12 @@ discard block |
||
347 | 347 | */ |
348 | 348 | public static function displayXML(string $xml) : void |
349 | 349 | { |
350 | - if(!headers_sent() && !self::$simulation) |
|
350 | + if (!headers_sent() && !self::$simulation) |
|
351 | 351 | { |
352 | 352 | header('Content-Type:text/xml; charset=utf-8'); |
353 | 353 | } |
354 | 354 | |
355 | - if(self::$simulation) |
|
355 | + if (self::$simulation) |
|
356 | 356 | { |
357 | 357 | $xml = '<pre>'.htmlspecialchars($xml).'</pre>'; |
358 | 358 | } |
@@ -370,16 +370,16 @@ discard block |
||
370 | 370 | * @param array<string,string> $customInfo Associative array with name => value pairs for custom tags to add to the output xml |
371 | 371 | * @see buildErrorXML() |
372 | 372 | */ |
373 | - public static function displayErrorXML($code, string $message, string $title, array $customInfo=array()) |
|
373 | + public static function displayErrorXML($code, string $message, string $title, array $customInfo = array()) |
|
374 | 374 | { |
375 | - if(!headers_sent() && !self::$simulation) { |
|
376 | - header('HTTP/1.1 400 Bad Request: ' . $title, true, 400); |
|
375 | + if (!headers_sent() && !self::$simulation) { |
|
376 | + header('HTTP/1.1 400 Bad Request: '.$title, true, 400); |
|
377 | 377 | } |
378 | 378 | |
379 | 379 | self::displayXML(self::buildErrorXML($code, $message, $title, $customInfo)); |
380 | 380 | } |
381 | 381 | |
382 | - public static function setSimulation(bool $simulate=true) : void |
|
382 | + public static function setSimulation(bool $simulate = true) : void |
|
383 | 383 | { |
384 | 384 | self::$simulation = $simulate; |
385 | 385 | } |
@@ -428,7 +428,7 @@ discard block |
||
428 | 428 | * @param array<string,string> $customInfo |
429 | 429 | * @return string |
430 | 430 | */ |
431 | - public static function buildErrorXML($code, string $message, string $title, array $customInfo=array()) |
|
431 | + public static function buildErrorXML($code, string $message, string $title, array $customInfo = array()) |
|
432 | 432 | { |
433 | 433 | $xml = new DOMDocument('1.0', 'UTF-8'); |
434 | 434 | $xml->formatOutput = true; |
@@ -442,7 +442,7 @@ discard block |
||
442 | 442 | $helper->addTextTag($root, 'title', $title); |
443 | 443 | $helper->addTextTag($root, 'request_uri', $_SERVER['REQUEST_URI']); |
444 | 444 | |
445 | - foreach($customInfo as $name => $value) { |
|
445 | + foreach ($customInfo as $name => $value) { |
|
446 | 446 | $helper->addTextTag($root, $name, $value); |
447 | 447 | } |
448 | 448 |