@@ -22,44 +22,44 @@ discard block |
||
22 | 22 | */ |
23 | 23 | class FileHelper_PHPClassInfo_Class |
24 | 24 | { |
25 | - /** |
|
26 | - * @var FileHelper_PHPClassInfo |
|
27 | - */ |
|
25 | + /** |
|
26 | + * @var FileHelper_PHPClassInfo |
|
27 | + */ |
|
28 | 28 | protected $info; |
29 | 29 | |
30 | - /** |
|
31 | - * @var bool |
|
32 | - */ |
|
30 | + /** |
|
31 | + * @var bool |
|
32 | + */ |
|
33 | 33 | protected $abstract = false; |
34 | 34 | |
35 | - /** |
|
36 | - * @var bool |
|
37 | - */ |
|
35 | + /** |
|
36 | + * @var bool |
|
37 | + */ |
|
38 | 38 | protected $final = false; |
39 | 39 | |
40 | - /** |
|
41 | - * @var string |
|
42 | - */ |
|
40 | + /** |
|
41 | + * @var string |
|
42 | + */ |
|
43 | 43 | protected $extends = ''; |
44 | 44 | |
45 | - /** |
|
46 | - * @var string[] |
|
47 | - */ |
|
45 | + /** |
|
46 | + * @var string[] |
|
47 | + */ |
|
48 | 48 | protected $implements = array(); |
49 | 49 | |
50 | - /** |
|
51 | - * @var string |
|
52 | - */ |
|
50 | + /** |
|
51 | + * @var string |
|
52 | + */ |
|
53 | 53 | protected $name; |
54 | 54 | |
55 | - /** |
|
56 | - * @var string |
|
57 | - */ |
|
55 | + /** |
|
56 | + * @var string |
|
57 | + */ |
|
58 | 58 | protected $declaration; |
59 | 59 | |
60 | - /** |
|
61 | - * @var string |
|
62 | - */ |
|
60 | + /** |
|
61 | + * @var string |
|
62 | + */ |
|
63 | 63 | protected $keyword; |
64 | 64 | |
65 | 65 | /** |
@@ -68,10 +68,10 @@ discard block |
||
68 | 68 | private $type; |
69 | 69 | |
70 | 70 | /** |
71 | - * @param FileHelper_PHPClassInfo $info The class info instance. |
|
72 | - * @param string $declaration The full class declaration, e.g. "class SomeName extends SomeOtherClass". |
|
73 | - * @param string $keyword The class keyword, if any, i.e. "abstract" or "final". |
|
74 | - */ |
|
71 | + * @param FileHelper_PHPClassInfo $info The class info instance. |
|
72 | + * @param string $declaration The full class declaration, e.g. "class SomeName extends SomeOtherClass". |
|
73 | + * @param string $keyword The class keyword, if any, i.e. "abstract" or "final". |
|
74 | + */ |
|
75 | 75 | public function __construct(FileHelper_PHPClassInfo $info, string $declaration, string $keyword, string $type) |
76 | 76 | { |
77 | 77 | $this->info = $info; |
@@ -82,31 +82,31 @@ discard block |
||
82 | 82 | $this->analyzeCode(); |
83 | 83 | } |
84 | 84 | |
85 | - /** |
|
86 | - * Check if this class is a subclass of the specified |
|
87 | - * class name. |
|
88 | - * |
|
89 | - * @param string $className |
|
90 | - * @return bool |
|
91 | - */ |
|
85 | + /** |
|
86 | + * Check if this class is a subclass of the specified |
|
87 | + * class name. |
|
88 | + * |
|
89 | + * @param string $className |
|
90 | + * @return bool |
|
91 | + */ |
|
92 | 92 | public function isSublassOf(string $className) : bool |
93 | 93 | { |
94 | 94 | return is_subclass_of($this->getNameNS(), $className); |
95 | 95 | } |
96 | 96 | |
97 | - /** |
|
98 | - * The class name without namespace. |
|
99 | - * @return string |
|
100 | - */ |
|
97 | + /** |
|
98 | + * The class name without namespace. |
|
99 | + * @return string |
|
100 | + */ |
|
101 | 101 | public function getName() : string |
102 | 102 | { |
103 | 103 | return $this->name; |
104 | 104 | } |
105 | 105 | |
106 | - /** |
|
107 | - * The absolute class name with namespace (if any). |
|
108 | - * @return string |
|
109 | - */ |
|
106 | + /** |
|
107 | + * The absolute class name with namespace (if any). |
|
108 | + * @return string |
|
109 | + */ |
|
110 | 110 | public function getNameNS() : string |
111 | 111 | { |
112 | 112 | $name = $this->getName(); |
@@ -118,48 +118,48 @@ discard block |
||
118 | 118 | return $name; |
119 | 119 | } |
120 | 120 | |
121 | - /** |
|
122 | - * Whether it is an abstract class. |
|
123 | - * @return bool |
|
124 | - */ |
|
121 | + /** |
|
122 | + * Whether it is an abstract class. |
|
123 | + * @return bool |
|
124 | + */ |
|
125 | 125 | public function isAbstract() : bool |
126 | 126 | { |
127 | 127 | return $this->abstract; |
128 | 128 | } |
129 | 129 | |
130 | - /** |
|
131 | - * Whether it is a final class. |
|
132 | - * @return bool |
|
133 | - */ |
|
130 | + /** |
|
131 | + * Whether it is a final class. |
|
132 | + * @return bool |
|
133 | + */ |
|
134 | 134 | public function isFinal() : bool |
135 | 135 | { |
136 | 136 | return $this->final; |
137 | 137 | } |
138 | 138 | |
139 | - /** |
|
140 | - * The name of the class that this class extends (with namespace, if specified). |
|
141 | - * @return string |
|
142 | - */ |
|
139 | + /** |
|
140 | + * The name of the class that this class extends (with namespace, if specified). |
|
141 | + * @return string |
|
142 | + */ |
|
143 | 143 | public function getExtends() : string |
144 | 144 | { |
145 | 145 | return $this->extends; |
146 | 146 | } |
147 | 147 | |
148 | - /** |
|
149 | - * A list of interfaces the class implements, if any. |
|
150 | - * @return string[] |
|
151 | - */ |
|
148 | + /** |
|
149 | + * A list of interfaces the class implements, if any. |
|
150 | + * @return string[] |
|
151 | + */ |
|
152 | 152 | public function getImplements() : array |
153 | 153 | { |
154 | 154 | return $this->implements; |
155 | 155 | } |
156 | 156 | |
157 | - /** |
|
158 | - * The class declaration string, with normalized spaces and sorted interface names. |
|
159 | - * NOTE: does not include the keyword "abstract" or "final". |
|
160 | - * |
|
161 | - * @return string |
|
162 | - */ |
|
157 | + /** |
|
158 | + * The class declaration string, with normalized spaces and sorted interface names. |
|
159 | + * NOTE: does not include the keyword "abstract" or "final". |
|
160 | + * |
|
161 | + * @return string |
|
162 | + */ |
|
163 | 163 | public function getDeclaration() : string |
164 | 164 | { |
165 | 165 | $parts = array(); |
@@ -179,10 +179,10 @@ discard block |
||
179 | 179 | return implode(' ', $parts); |
180 | 180 | } |
181 | 181 | |
182 | - /** |
|
183 | - * The keyword before "class", e.g. "abstract". |
|
184 | - * @return string |
|
185 | - */ |
|
182 | + /** |
|
183 | + * The keyword before "class", e.g. "abstract". |
|
184 | + * @return string |
|
185 | + */ |
|
186 | 186 | public function getKeyword() : string |
187 | 187 | { |
188 | 188 | return $this->keyword; |
@@ -21,18 +21,18 @@ discard block |
||
21 | 21 | public const SVN_ERROR_TYPE_WARNING = 'warning'; |
22 | 22 | |
23 | 23 | /** |
24 | - * @var SVNHelper |
|
25 | - */ |
|
24 | + * @var SVNHelper |
|
25 | + */ |
|
26 | 26 | protected $helper; |
27 | 27 | |
28 | - /** |
|
29 | - * @var SVNHelper_Target |
|
30 | - */ |
|
28 | + /** |
|
29 | + * @var SVNHelper_Target |
|
30 | + */ |
|
31 | 31 | protected $target; |
32 | 32 | |
33 | - /** |
|
34 | - * @var SVNHelper_CommandResult|NULL |
|
35 | - */ |
|
33 | + /** |
|
34 | + * @var SVNHelper_CommandResult|NULL |
|
35 | + */ |
|
36 | 36 | protected ?SVNHelper_CommandResult $result; |
37 | 37 | |
38 | 38 | public function __construct(SVNHelper $helper, SVNHelper_Target $target) |
@@ -41,9 +41,9 @@ discard block |
||
41 | 41 | $this->target = $target; |
42 | 42 | } |
43 | 43 | |
44 | - /** |
|
45 | - * @return SVNHelper |
|
46 | - */ |
|
44 | + /** |
|
45 | + * @return SVNHelper |
|
46 | + */ |
|
47 | 47 | public function getSVN() |
48 | 48 | { |
49 | 49 | return $this->helper; |
@@ -100,15 +100,15 @@ discard block |
||
100 | 100 | return $cmd; |
101 | 101 | } |
102 | 102 | |
103 | - /** |
|
104 | - * Executes the specified command, and returns a result |
|
105 | - * instance to read the results. |
|
106 | - * |
|
107 | - * @param string $mode The command mode, e.g. commit / update... |
|
108 | - * @param string $path The path to apply the command to |
|
109 | - * @param array $params |
|
110 | - * @return SVNHelper_CommandResult |
|
111 | - */ |
|
103 | + /** |
|
104 | + * Executes the specified command, and returns a result |
|
105 | + * instance to read the results. |
|
106 | + * |
|
107 | + * @param string $mode The command mode, e.g. commit / update... |
|
108 | + * @param string $path The path to apply the command to |
|
109 | + * @param array $params |
|
110 | + * @return SVNHelper_CommandResult |
|
111 | + */ |
|
112 | 112 | protected function execCommand($mode, $path=null, $params=array()) |
113 | 113 | { |
114 | 114 | $relative = $this->helper->relativizePath($path); |
@@ -195,10 +195,10 @@ discard block |
||
195 | 195 | return $this->result; |
196 | 196 | } |
197 | 197 | |
198 | - /** |
|
199 | - * Retrieves the type of command, e.g. "Commit" |
|
200 | - * @return string |
|
201 | - */ |
|
198 | + /** |
|
199 | + * Retrieves the type of command, e.g. "Commit" |
|
200 | + * @return string |
|
201 | + */ |
|
202 | 202 | public function getType() |
203 | 203 | { |
204 | 204 | return str_replace('SVNHelper_Command_', '', get_class($this)); |
@@ -37,19 +37,19 @@ discard block |
||
37 | 37 | { |
38 | 38 | public const ERROR_CALLABLE_THREW_ERROR = 99601; |
39 | 39 | |
40 | - /** |
|
41 | - * @var string |
|
42 | - */ |
|
40 | + /** |
|
41 | + * @var string |
|
42 | + */ |
|
43 | 43 | protected $separator = ' '; |
44 | 44 | |
45 | - /** |
|
46 | - * @var string[] |
|
47 | - */ |
|
45 | + /** |
|
46 | + * @var string[] |
|
47 | + */ |
|
48 | 48 | protected $strings = array(); |
49 | 49 | |
50 | - /** |
|
51 | - * @var string |
|
52 | - */ |
|
50 | + /** |
|
51 | + * @var string |
|
52 | + */ |
|
53 | 53 | protected $noSeparator = '§!§'; |
54 | 54 | |
55 | 55 | public function __construct() |
@@ -63,12 +63,12 @@ discard block |
||
63 | 63 | return $this; |
64 | 64 | } |
65 | 65 | |
66 | - /** |
|
67 | - * Adds a subject as a string. Is ignored if empty. |
|
68 | - * |
|
69 | - * @param string|number|Interface_Stringable|NULL $string |
|
70 | - * @return $this |
|
71 | - */ |
|
66 | + /** |
|
67 | + * Adds a subject as a string. Is ignored if empty. |
|
68 | + * |
|
69 | + * @param string|number|Interface_Stringable|NULL $string |
|
70 | + * @return $this |
|
71 | + */ |
|
72 | 72 | public function add($string) : StringBuilder |
73 | 73 | { |
74 | 74 | $string = (string)$string; |
@@ -81,12 +81,12 @@ discard block |
||
81 | 81 | return $this; |
82 | 82 | } |
83 | 83 | |
84 | - /** |
|
85 | - * Adds a string without appending an automatic space. |
|
86 | - * |
|
87 | - * @param string|number|Interface_Stringable|NULL $string |
|
88 | - * @return $this |
|
89 | - */ |
|
84 | + /** |
|
85 | + * Adds a string without appending an automatic space. |
|
86 | + * |
|
87 | + * @param string|number|Interface_Stringable|NULL $string |
|
88 | + * @return $this |
|
89 | + */ |
|
90 | 90 | public function nospace($string) : StringBuilder |
91 | 91 | { |
92 | 92 | $flattened = (string)$string; |
@@ -99,46 +99,46 @@ discard block |
||
99 | 99 | return $this; |
100 | 100 | } |
101 | 101 | |
102 | - /** |
|
103 | - * Adds raw HTML code. Does not add an automatic space. |
|
104 | - * |
|
105 | - * @param string|number|Interface_Stringable $html |
|
106 | - * @return $this |
|
107 | - */ |
|
102 | + /** |
|
103 | + * Adds raw HTML code. Does not add an automatic space. |
|
104 | + * |
|
105 | + * @param string|number|Interface_Stringable $html |
|
106 | + * @return $this |
|
107 | + */ |
|
108 | 108 | public function html($html) : StringBuilder |
109 | 109 | { |
110 | 110 | return $this->nospace($html); |
111 | 111 | } |
112 | 112 | |
113 | - /** |
|
114 | - * Adds an unordered list with the specified items. |
|
115 | - * |
|
116 | - * @param array<int,string|number|Interface_Stringable> $items |
|
117 | - * @return $this |
|
118 | - */ |
|
113 | + /** |
|
114 | + * Adds an unordered list with the specified items. |
|
115 | + * |
|
116 | + * @param array<int,string|number|Interface_Stringable> $items |
|
117 | + * @return $this |
|
118 | + */ |
|
119 | 119 | public function ul(array $items) : StringBuilder |
120 | 120 | { |
121 | 121 | return $this->list('ul', $items); |
122 | 122 | } |
123 | 123 | |
124 | - /** |
|
125 | - * Adds an ordered list with the specified items. |
|
126 | - * |
|
127 | - * @param array<int,string|number|Interface_Stringable> $items |
|
128 | - * @return $this |
|
129 | - */ |
|
124 | + /** |
|
125 | + * Adds an ordered list with the specified items. |
|
126 | + * |
|
127 | + * @param array<int,string|number|Interface_Stringable> $items |
|
128 | + * @return $this |
|
129 | + */ |
|
130 | 130 | public function ol(array $items) : StringBuilder |
131 | 131 | { |
132 | 132 | return $this->list('ol', $items); |
133 | 133 | } |
134 | 134 | |
135 | - /** |
|
136 | - * Creates a list tag with the items list. |
|
137 | - * |
|
138 | - * @param string $type The list type, `ol` or `ul`. |
|
139 | - * @param array<int,string|number|Interface_Stringable> $items |
|
140 | - * @return $this |
|
141 | - */ |
|
135 | + /** |
|
136 | + * Creates a list tag with the items list. |
|
137 | + * |
|
138 | + * @param string $type The list type, `ol` or `ul`. |
|
139 | + * @param array<int,string|number|Interface_Stringable> $items |
|
140 | + * @return $this |
|
141 | + */ |
|
142 | 142 | protected function list(string $type, array $items) : StringBuilder |
143 | 143 | { |
144 | 144 | return $this->html(sprintf( |
@@ -148,13 +148,13 @@ discard block |
||
148 | 148 | )); |
149 | 149 | } |
150 | 150 | |
151 | - /** |
|
152 | - * Add a translated string. |
|
153 | - * |
|
154 | - * @param string $format The native string to translate. |
|
155 | - * @param array<int,mixed> $arguments The variables to inject into the translated string, if any. |
|
156 | - * @return $this |
|
157 | - */ |
|
151 | + /** |
|
152 | + * Add a translated string. |
|
153 | + * |
|
154 | + * @param string $format The native string to translate. |
|
155 | + * @param array<int,mixed> $arguments The variables to inject into the translated string, if any. |
|
156 | + * @return $this |
|
157 | + */ |
|
158 | 158 | public function t(string $format, ...$arguments) : StringBuilder |
159 | 159 | { |
160 | 160 | if(!class_exists('\AppLocalize\Localization')) |
@@ -207,36 +207,36 @@ discard block |
||
207 | 207 | return $this->add(ConvertHelper::duration2string($since)); |
208 | 208 | } |
209 | 209 | |
210 | - /** |
|
211 | - * Adds HTML double quotes around the string. |
|
212 | - * |
|
213 | - * @param string|number|Interface_Stringable $string |
|
214 | - * @return $this |
|
215 | - */ |
|
210 | + /** |
|
211 | + * Adds HTML double quotes around the string. |
|
212 | + * |
|
213 | + * @param string|number|Interface_Stringable $string |
|
214 | + * @return $this |
|
215 | + */ |
|
216 | 216 | public function quote($string) : StringBuilder |
217 | 217 | { |
218 | 218 | return $this->sf('"%s"', (string)$string); |
219 | 219 | } |
220 | 220 | |
221 | - /** |
|
222 | - * Adds a text that is meant as a reference to a UI element, |
|
223 | - * like a menu item, button, etc. |
|
224 | - * |
|
225 | - * @param string|number|Interface_Stringable $string |
|
226 | - * @return $this |
|
227 | - */ |
|
221 | + /** |
|
222 | + * Adds a text that is meant as a reference to a UI element, |
|
223 | + * like a menu item, button, etc. |
|
224 | + * |
|
225 | + * @param string|number|Interface_Stringable $string |
|
226 | + * @return $this |
|
227 | + */ |
|
228 | 228 | public function reference($string) : StringBuilder |
229 | 229 | { |
230 | 230 | return $this->sf('"%s"', $string); |
231 | 231 | } |
232 | 232 | |
233 | - /** |
|
234 | - * Add a string using the `sprintf` method. |
|
235 | - * |
|
236 | - * @param string $format The format string |
|
237 | - * @param string|number|Interface_Stringable ...$arguments The variables to inject |
|
238 | - * @return $this |
|
239 | - */ |
|
233 | + /** |
|
234 | + * Add a string using the `sprintf` method. |
|
235 | + * |
|
236 | + * @param string $format The format string |
|
237 | + * @param string|number|Interface_Stringable ...$arguments The variables to inject |
|
238 | + * @return $this |
|
239 | + */ |
|
240 | 240 | public function sf(string $format, ...$arguments) : StringBuilder |
241 | 241 | { |
242 | 242 | array_unshift($arguments, $format); |
@@ -244,12 +244,12 @@ discard block |
||
244 | 244 | return $this->add(sprintf(...$arguments)); |
245 | 245 | } |
246 | 246 | |
247 | - /** |
|
248 | - * Adds a bold string. |
|
249 | - * |
|
250 | - * @param string|number|Interface_Stringable $string |
|
251 | - * @return $this |
|
252 | - */ |
|
247 | + /** |
|
248 | + * Adds a bold string. |
|
249 | + * |
|
250 | + * @param string|number|Interface_Stringable $string |
|
251 | + * @return $this |
|
252 | + */ |
|
253 | 253 | public function bold($string) : StringBuilder |
254 | 254 | { |
255 | 255 | return $this->sf( |
@@ -258,15 +258,15 @@ discard block |
||
258 | 258 | ); |
259 | 259 | } |
260 | 260 | |
261 | - /** |
|
262 | - * Adds an HTML `<br>` tag. |
|
263 | - * |
|
264 | - * Note: for adding a newline character instead, |
|
265 | - * use {@see StringBuilder::eol()}. |
|
266 | - * |
|
267 | - * @return $this |
|
268 | - * @see StringBuilder::eol() |
|
269 | - */ |
|
261 | + /** |
|
262 | + * Adds an HTML `<br>` tag. |
|
263 | + * |
|
264 | + * Note: for adding a newline character instead, |
|
265 | + * use {@see StringBuilder::eol()}. |
|
266 | + * |
|
267 | + * @return $this |
|
268 | + * @see StringBuilder::eol() |
|
269 | + */ |
|
270 | 270 | public function nl() : StringBuilder |
271 | 271 | { |
272 | 272 | return $this->html('<br>'); |
@@ -283,42 +283,42 @@ discard block |
||
283 | 283 | return $this->nospace(PHP_EOL); |
284 | 284 | } |
285 | 285 | |
286 | - /** |
|
287 | - * Adds the current time, in the format <code>H:i:s</code>. |
|
288 | - * |
|
289 | - * @return $this |
|
290 | - */ |
|
286 | + /** |
|
287 | + * Adds the current time, in the format <code>H:i:s</code>. |
|
288 | + * |
|
289 | + * @return $this |
|
290 | + */ |
|
291 | 291 | public function time() : StringBuilder |
292 | 292 | { |
293 | 293 | return $this->add(date('H:i:s')); |
294 | 294 | } |
295 | 295 | |
296 | - /** |
|
297 | - * Adds the "Note:" text. |
|
298 | - * |
|
299 | - * @return $this |
|
300 | - */ |
|
296 | + /** |
|
297 | + * Adds the "Note:" text. |
|
298 | + * |
|
299 | + * @return $this |
|
300 | + */ |
|
301 | 301 | public function note() : StringBuilder |
302 | 302 | { |
303 | 303 | return $this->t('Note:'); |
304 | 304 | } |
305 | 305 | |
306 | - /** |
|
307 | - * Like {@see StringBuilder::note()}, but as bold text. |
|
308 | - * |
|
309 | - * @return $this |
|
310 | - */ |
|
306 | + /** |
|
307 | + * Like {@see StringBuilder::note()}, but as bold text. |
|
308 | + * |
|
309 | + * @return $this |
|
310 | + */ |
|
311 | 311 | public function noteBold() : StringBuilder |
312 | 312 | { |
313 | 313 | return $this->bold(sb()->note()); |
314 | 314 | } |
315 | 315 | |
316 | - /** |
|
317 | - * Adds the "Hint:" text. |
|
318 | - * |
|
319 | - * @return $this |
|
320 | - * @see StringBuilder::hintBold() |
|
321 | - */ |
|
316 | + /** |
|
317 | + * Adds the "Hint:" text. |
|
318 | + * |
|
319 | + * @return $this |
|
320 | + * @see StringBuilder::hintBold() |
|
321 | + */ |
|
322 | 322 | public function hint() : StringBuilder |
323 | 323 | { |
324 | 324 | return $this->t('Hint:'); |
@@ -334,12 +334,12 @@ discard block |
||
334 | 334 | return $this->bold(sb()->hint()); |
335 | 335 | } |
336 | 336 | |
337 | - /** |
|
338 | - * Adds two linebreaks. |
|
339 | - * |
|
340 | - * @param StringBuilder_Interface|string|NULL $content |
|
341 | - * @return $this |
|
342 | - */ |
|
337 | + /** |
|
338 | + * Adds two linebreaks. |
|
339 | + * |
|
340 | + * @param StringBuilder_Interface|string|NULL $content |
|
341 | + * @return $this |
|
342 | + */ |
|
343 | 343 | public function para($content=null) : StringBuilder |
344 | 344 | { |
345 | 345 | if($content !== null) { |
@@ -391,12 +391,12 @@ discard block |
||
391 | 391 | return $this->html(HTMLTag::create('a')->renderClose()); |
392 | 392 | } |
393 | 393 | |
394 | - /** |
|
395 | - * Wraps the string in a `code` tag. |
|
396 | - * |
|
397 | - * @param string|number|Interface_Stringable $string |
|
398 | - * @return $this |
|
399 | - */ |
|
394 | + /** |
|
395 | + * Wraps the string in a `code` tag. |
|
396 | + * |
|
397 | + * @param string|number|Interface_Stringable $string |
|
398 | + * @return $this |
|
399 | + */ |
|
400 | 400 | public function code($string) : StringBuilder |
401 | 401 | { |
402 | 402 | return $this->sf( |
@@ -405,24 +405,24 @@ discard block |
||
405 | 405 | ); |
406 | 406 | } |
407 | 407 | |
408 | - /** |
|
409 | - * Wraps the string in a `pre` tag. |
|
410 | - * |
|
411 | - * @param string|number|Interface_Stringable $string |
|
412 | - * @return $this |
|
413 | - */ |
|
408 | + /** |
|
409 | + * Wraps the string in a `pre` tag. |
|
410 | + * |
|
411 | + * @param string|number|Interface_Stringable $string |
|
412 | + * @return $this |
|
413 | + */ |
|
414 | 414 | public function pre($string) : StringBuilder |
415 | 415 | { |
416 | 416 | return $this->sf('<pre>%s</pre>', (string)$string); |
417 | 417 | } |
418 | 418 | |
419 | - /** |
|
420 | - * Wraps the text in a `span` tag with the specified classes. |
|
421 | - * |
|
422 | - * @param string|number|Interface_Stringable $string |
|
423 | - * @param string|string[] $classes |
|
424 | - * @return $this |
|
425 | - */ |
|
419 | + /** |
|
420 | + * Wraps the text in a `span` tag with the specified classes. |
|
421 | + * |
|
422 | + * @param string|number|Interface_Stringable $string |
|
423 | + * @param string|string[] $classes |
|
424 | + * @return $this |
|
425 | + */ |
|
426 | 426 | public function spanned($string, $classes) : StringBuilder |
427 | 427 | { |
428 | 428 | if(!is_array($classes)) |
@@ -29,28 +29,28 @@ discard block |
||
29 | 29 | public const QUOTE_STYLE_SINGLE = 1; |
30 | 30 | public const QUOTE_STYLE_DOUBLE = 2; |
31 | 31 | |
32 | - /** |
|
33 | - * @var array<string,string> |
|
34 | - */ |
|
32 | + /** |
|
33 | + * @var array<string,string> |
|
34 | + */ |
|
35 | 35 | protected static array $variableCache = array(); |
36 | 36 | protected static int $elementCounter = 0; |
37 | 37 | protected static string $idPrefix = 'E'; |
38 | 38 | |
39 | - /** |
|
40 | - * Builds a javascript statement. The first parameter is the |
|
41 | - * javascript function to call, any additional parameters are |
|
42 | - * used as arguments for the javascript function call. Variable |
|
43 | - * types are automagically converted to the javascript equivalents. |
|
44 | - * |
|
45 | - * Examples: |
|
46 | - * |
|
47 | - * // add an alert(); statement: |
|
48 | - * JSHelper::buildStatement('alert'); |
|
49 | - * |
|
50 | - * // add an alert('Alert text'); statement |
|
51 | - * JSHelper::buildStatement('alert', 'Alert text'); |
|
52 | - * |
|
53 | - */ |
|
39 | + /** |
|
40 | + * Builds a javascript statement. The first parameter is the |
|
41 | + * javascript function to call, any additional parameters are |
|
42 | + * used as arguments for the javascript function call. Variable |
|
43 | + * types are automagically converted to the javascript equivalents. |
|
44 | + * |
|
45 | + * Examples: |
|
46 | + * |
|
47 | + * // add an alert(); statement: |
|
48 | + * JSHelper::buildStatement('alert'); |
|
49 | + * |
|
50 | + * // add an alert('Alert text'); statement |
|
51 | + * JSHelper::buildStatement('alert', 'Alert text'); |
|
52 | + * |
|
53 | + */ |
|
54 | 54 | public static function buildStatement() : string |
55 | 55 | { |
56 | 56 | $args = func_get_args(); |
@@ -58,13 +58,13 @@ discard block |
||
58 | 58 | return call_user_func_array(array(self::class, 'buildStatementQuoteStyle'), $args); |
59 | 59 | } |
60 | 60 | |
61 | - /** |
|
62 | - * Like {@link JSHelper::buildStatement()}, but using single quotes |
|
63 | - * to make it possible to use the statement in an HTML tag attribute. |
|
64 | - * |
|
65 | - * @return string |
|
66 | - * @see JSHelper::buildStatement() |
|
67 | - */ |
|
61 | + /** |
|
62 | + * Like {@link JSHelper::buildStatement()}, but using single quotes |
|
63 | + * to make it possible to use the statement in an HTML tag attribute. |
|
64 | + * |
|
65 | + * @return string |
|
66 | + * @see JSHelper::buildStatement() |
|
67 | + */ |
|
68 | 68 | public static function buildStatementAttribute() : string |
69 | 69 | { |
70 | 70 | $args = func_get_args(); |
@@ -94,39 +94,39 @@ discard block |
||
94 | 94 | return $call . ');'; |
95 | 95 | } |
96 | 96 | |
97 | - /** |
|
98 | - * Builds a set variable statement. The variable value is |
|
99 | - * automatically converted to the javascript equivalent. |
|
100 | - * |
|
101 | - * Examples: |
|
102 | - * |
|
103 | - * // foo = 'bar'; |
|
104 | - * JSHelper::buildVariable('foo', 'bar'); |
|
105 | - * |
|
106 | - * // foo = 42; |
|
107 | - * JSHelper::buildVariable('foo', 42); |
|
108 | - * |
|
109 | - * // foo = true; |
|
110 | - * JSHelper::buildVariable('foo', true); |
|
111 | - * |
|
112 | - * @param string $varName |
|
113 | - * @param mixed $varValue |
|
114 | - * @return string |
|
115 | - */ |
|
97 | + /** |
|
98 | + * Builds a set variable statement. The variable value is |
|
99 | + * automatically converted to the javascript equivalent. |
|
100 | + * |
|
101 | + * Examples: |
|
102 | + * |
|
103 | + * // foo = 'bar'; |
|
104 | + * JSHelper::buildVariable('foo', 'bar'); |
|
105 | + * |
|
106 | + * // foo = 42; |
|
107 | + * JSHelper::buildVariable('foo', 42); |
|
108 | + * |
|
109 | + * // foo = true; |
|
110 | + * JSHelper::buildVariable('foo', true); |
|
111 | + * |
|
112 | + * @param string $varName |
|
113 | + * @param mixed $varValue |
|
114 | + * @return string |
|
115 | + */ |
|
116 | 116 | public static function buildVariable(string $varName, $varValue) : string |
117 | 117 | { |
118 | 118 | return $varName . "=" . self::phpVariable2JS($varValue) . ';'; |
119 | 119 | } |
120 | 120 | |
121 | - /** |
|
122 | - * Converts a PHP variable to its javascript equivalent. Note that |
|
123 | - * if a variable cannot be converted (like a PHP resource), this will |
|
124 | - * return a javascript "null". |
|
125 | - * |
|
126 | - * @param mixed $variable |
|
127 | - * @param int $quoteStyle The quote style to use for strings |
|
128 | - * @return string |
|
129 | - */ |
|
121 | + /** |
|
122 | + * Converts a PHP variable to its javascript equivalent. Note that |
|
123 | + * if a variable cannot be converted (like a PHP resource), this will |
|
124 | + * return a javascript "null". |
|
125 | + * |
|
126 | + * @param mixed $variable |
|
127 | + * @param int $quoteStyle The quote style to use for strings |
|
128 | + * @return string |
|
129 | + */ |
|
130 | 130 | public static function phpVariable2JS($variable, int $quoteStyle=self::QUOTE_STYLE_DOUBLE) : string |
131 | 131 | { |
132 | 132 | // after much profiling, this variant of the method offers |
@@ -204,26 +204,26 @@ discard block |
||
204 | 204 | return $result; |
205 | 205 | } |
206 | 206 | |
207 | - /** |
|
208 | - * Converts a variable to a JS string that can be |
|
209 | - * used in an HTML attribute: it uses single quotes |
|
210 | - * instead of the default double quotes. |
|
211 | - * |
|
212 | - * @param mixed $variable |
|
213 | - * @return string |
|
214 | - */ |
|
207 | + /** |
|
208 | + * Converts a variable to a JS string that can be |
|
209 | + * used in an HTML attribute: it uses single quotes |
|
210 | + * instead of the default double quotes. |
|
211 | + * |
|
212 | + * @param mixed $variable |
|
213 | + * @return string |
|
214 | + */ |
|
215 | 215 | public static function phpVariable2AttributeJS($variable) : string |
216 | 216 | { |
217 | 217 | return self::phpVariable2JS($variable, self::QUOTE_STYLE_SINGLE); |
218 | 218 | } |
219 | 219 | |
220 | - /** |
|
221 | - * Generates a dynamic element ID to be used with dynamically generated |
|
222 | - * HTML code to tie in with clientside javascript when compact but unique |
|
223 | - * IDs are needed in a request. |
|
224 | - * |
|
225 | - * @return string |
|
226 | - */ |
|
220 | + /** |
|
221 | + * Generates a dynamic element ID to be used with dynamically generated |
|
222 | + * HTML code to tie in with clientside javascript when compact but unique |
|
223 | + * IDs are needed in a request. |
|
224 | + * |
|
225 | + * @return string |
|
226 | + */ |
|
227 | 227 | public static function nextElementID() : string |
228 | 228 | { |
229 | 229 | self::$elementCounter++; |
@@ -231,33 +231,33 @@ discard block |
||
231 | 231 | return self::$idPrefix . self::$elementCounter; |
232 | 232 | } |
233 | 233 | |
234 | - /** |
|
235 | - * Retrieves the ID prefix currently used. |
|
236 | - * |
|
237 | - * @return string |
|
238 | - */ |
|
234 | + /** |
|
235 | + * Retrieves the ID prefix currently used. |
|
236 | + * |
|
237 | + * @return string |
|
238 | + */ |
|
239 | 239 | public static function getIDPrefix() : string |
240 | 240 | { |
241 | 241 | return self::$idPrefix; |
242 | 242 | } |
243 | 243 | |
244 | - /** |
|
245 | - * Retrieves the value of the internal elements counter. |
|
246 | - * |
|
247 | - * @return integer |
|
248 | - */ |
|
244 | + /** |
|
245 | + * Retrieves the value of the internal elements counter. |
|
246 | + * |
|
247 | + * @return integer |
|
248 | + */ |
|
249 | 249 | public static function getElementCounter() : int |
250 | 250 | { |
251 | 251 | return self::$elementCounter; |
252 | 252 | } |
253 | 253 | |
254 | - /** |
|
255 | - * Sets the prefix that is added in front of all IDs |
|
256 | - * retrieved using the {@link nextElementID()} method. |
|
257 | - * |
|
258 | - * @param string $prefix |
|
259 | - * @see JSHelper::nextElementID() |
|
260 | - */ |
|
254 | + /** |
|
255 | + * Sets the prefix that is added in front of all IDs |
|
256 | + * retrieved using the {@link nextElementID()} method. |
|
257 | + * |
|
258 | + * @param string $prefix |
|
259 | + * @see JSHelper::nextElementID() |
|
260 | + */ |
|
261 | 261 | public static function setIDPrefix(string $prefix) : void |
262 | 262 | { |
263 | 263 | self::$idPrefix = $prefix; |
@@ -25,9 +25,9 @@ discard block |
||
25 | 25 | */ |
26 | 26 | trait Traits_Classable |
27 | 27 | { |
28 | - /** |
|
29 | - * @var string[] |
|
30 | - */ |
|
28 | + /** |
|
29 | + * @var string[] |
|
30 | + */ |
|
31 | 31 | protected array $classes = array(); |
32 | 32 | |
33 | 33 | public function hasClasses() : bool |
@@ -82,30 +82,30 @@ discard block |
||
82 | 82 | return $this; |
83 | 83 | } |
84 | 84 | |
85 | - /** |
|
86 | - * Retrieves a list of all classes, if any. |
|
87 | - * |
|
88 | - * @return string[] |
|
89 | - */ |
|
85 | + /** |
|
86 | + * Retrieves a list of all classes, if any. |
|
87 | + * |
|
88 | + * @return string[] |
|
89 | + */ |
|
90 | 90 | public function getClasses() : array |
91 | 91 | { |
92 | 92 | return $this->classes; |
93 | 93 | } |
94 | 94 | |
95 | - /** |
|
96 | - * Renders the class names list as space-separated string for use in an HTML tag. |
|
97 | - * |
|
98 | - * @return string |
|
99 | - */ |
|
95 | + /** |
|
96 | + * Renders the class names list as space-separated string for use in an HTML tag. |
|
97 | + * |
|
98 | + * @return string |
|
99 | + */ |
|
100 | 100 | public function classesToString() : string |
101 | 101 | { |
102 | 102 | return implode(' ', $this->classes); |
103 | 103 | } |
104 | 104 | |
105 | - /** |
|
106 | - * Renders the "class" attribute string for inserting into an HTML tag. |
|
107 | - * @return string |
|
108 | - */ |
|
105 | + /** |
|
106 | + * Renders the "class" attribute string for inserting into an HTML tag. |
|
107 | + * @return string |
|
108 | + */ |
|
109 | 109 | public function classesToAttribute() : string |
110 | 110 | { |
111 | 111 | if(!empty($this->classes)) |
@@ -26,9 +26,9 @@ discard block |
||
26 | 26 | */ |
27 | 27 | trait Traits_Optionable |
28 | 28 | { |
29 | - /** |
|
30 | - * @var array<string,mixed>|NULL |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var array<string,mixed>|NULL |
|
31 | + */ |
|
32 | 32 | protected ?array $options = null; |
33 | 33 | |
34 | 34 | /** |
@@ -49,13 +49,13 @@ discard block |
||
49 | 49 | return $this; |
50 | 50 | } |
51 | 51 | |
52 | - /** |
|
53 | - * Sets a collection of options at once, from an |
|
54 | - * associative array. |
|
55 | - * |
|
56 | - * @param array<string,mixed> $options |
|
57 | - * @return $this |
|
58 | - */ |
|
52 | + /** |
|
53 | + * Sets a collection of options at once, from an |
|
54 | + * associative array. |
|
55 | + * |
|
56 | + * @param array<string,mixed> $options |
|
57 | + * @return $this |
|
58 | + */ |
|
59 | 59 | public function setOptions(array $options) : self |
60 | 60 | { |
61 | 61 | foreach($options as $name => $value) { |
@@ -65,16 +65,16 @@ discard block |
||
65 | 65 | return $this; |
66 | 66 | } |
67 | 67 | |
68 | - /** |
|
69 | - * Retrieves an option's value. |
|
70 | - * |
|
71 | - * NOTE: Use the specialized type getters to ensure an option |
|
72 | - * contains the expected type (for ex. getArrayOption()). |
|
73 | - * |
|
74 | - * @param string $name |
|
75 | - * @param mixed $default The default value to return if the option does not exist. |
|
76 | - * @return mixed |
|
77 | - */ |
|
68 | + /** |
|
69 | + * Retrieves an option's value. |
|
70 | + * |
|
71 | + * NOTE: Use the specialized type getters to ensure an option |
|
72 | + * contains the expected type (for ex. getArrayOption()). |
|
73 | + * |
|
74 | + * @param string $name |
|
75 | + * @param mixed $default The default value to return if the option does not exist. |
|
76 | + * @return mixed |
|
77 | + */ |
|
78 | 78 | public function getOption(string $name, $default=null) |
79 | 79 | { |
80 | 80 | if(!isset($this->options)) |
@@ -85,16 +85,16 @@ discard block |
||
85 | 85 | return $this->options[$name] ?? $default; |
86 | 86 | } |
87 | 87 | |
88 | - /** |
|
89 | - * Enforces that the option value is a string. Numbers are converted |
|
90 | - * to string, strings are passed through, and all other types will |
|
91 | - * return the default value. The default value is also returned if |
|
92 | - * the string is empty. |
|
93 | - * |
|
94 | - * @param string $name |
|
95 | - * @param string $default Used if the option does not exist, is invalid, or empty. |
|
96 | - * @return string |
|
97 | - */ |
|
88 | + /** |
|
89 | + * Enforces that the option value is a string. Numbers are converted |
|
90 | + * to string, strings are passed through, and all other types will |
|
91 | + * return the default value. The default value is also returned if |
|
92 | + * the string is empty. |
|
93 | + * |
|
94 | + * @param string $name |
|
95 | + * @param string $default Used if the option does not exist, is invalid, or empty. |
|
96 | + * @return string |
|
97 | + */ |
|
98 | 98 | public function getStringOption(string $name, string $default='') : string |
99 | 99 | { |
100 | 100 | $value = $this->getOption($name, false); |
@@ -126,15 +126,15 @@ discard block |
||
126 | 126 | return $default; |
127 | 127 | } |
128 | 128 | |
129 | - /** |
|
130 | - * Treats the option value as an integer value: will return |
|
131 | - * valid integer values (also from integer strings), or the |
|
132 | - * default value otherwise. |
|
133 | - * |
|
134 | - * @param string $name |
|
135 | - * @param int $default |
|
136 | - * @return int |
|
137 | - */ |
|
129 | + /** |
|
130 | + * Treats the option value as an integer value: will return |
|
131 | + * valid integer values (also from integer strings), or the |
|
132 | + * default value otherwise. |
|
133 | + * |
|
134 | + * @param string $name |
|
135 | + * @param int $default |
|
136 | + * @return int |
|
137 | + */ |
|
138 | 138 | public function getIntOption(string $name, int $default=0) : int |
139 | 139 | { |
140 | 140 | $value = $this->getOption($name); |
@@ -145,14 +145,14 @@ discard block |
||
145 | 145 | return $default; |
146 | 146 | } |
147 | 147 | |
148 | - /** |
|
149 | - * Treats an option as an array, and returns its value |
|
150 | - * only if it contains an array - otherwise, an empty |
|
151 | - * array is returned. |
|
152 | - * |
|
153 | - * @param string $name |
|
154 | - * @return array<int|string,mixed> |
|
155 | - */ |
|
148 | + /** |
|
149 | + * Treats an option as an array, and returns its value |
|
150 | + * only if it contains an array - otherwise, an empty |
|
151 | + * array is returned. |
|
152 | + * |
|
153 | + * @param string $name |
|
154 | + * @return array<int|string,mixed> |
|
155 | + */ |
|
156 | 156 | public function getArrayOption(string $name) : array |
157 | 157 | { |
158 | 158 | $val = $this->getOption($name); |
@@ -163,13 +163,13 @@ discard block |
||
163 | 163 | return array(); |
164 | 164 | } |
165 | 165 | |
166 | - /** |
|
167 | - * Checks whether the specified option exists - even |
|
168 | - * if it has a NULL value. |
|
169 | - * |
|
170 | - * @param string $name |
|
171 | - * @return bool |
|
172 | - */ |
|
166 | + /** |
|
167 | + * Checks whether the specified option exists - even |
|
168 | + * if it has a NULL value. |
|
169 | + * |
|
170 | + * @param string $name |
|
171 | + * @return bool |
|
172 | + */ |
|
173 | 173 | public function hasOption(string $name) : bool |
174 | 174 | { |
175 | 175 | if(!isset($this->options)) { |
@@ -179,11 +179,11 @@ discard block |
||
179 | 179 | return array_key_exists($name, $this->options); |
180 | 180 | } |
181 | 181 | |
182 | - /** |
|
183 | - * Returns all options in one associative array. |
|
184 | - * |
|
185 | - * @return array<string,mixed> |
|
186 | - */ |
|
182 | + /** |
|
183 | + * Returns all options in one associative array. |
|
184 | + * |
|
185 | + * @return array<string,mixed> |
|
186 | + */ |
|
187 | 187 | public function getOptions() : array |
188 | 188 | { |
189 | 189 | if(!isset($this->options)) { |
@@ -193,13 +193,13 @@ discard block |
||
193 | 193 | return $this->options; |
194 | 194 | } |
195 | 195 | |
196 | - /** |
|
197 | - * Checks whether the option's value is the one specified. |
|
198 | - * |
|
199 | - * @param string $name |
|
200 | - * @param mixed $value |
|
201 | - * @return bool |
|
202 | - */ |
|
196 | + /** |
|
197 | + * Checks whether the option's value is the one specified. |
|
198 | + * |
|
199 | + * @param string $name |
|
200 | + * @param mixed $value |
|
201 | + * @return bool |
|
202 | + */ |
|
203 | 203 | public function isOption(string $name, $value) : bool |
204 | 204 | { |
205 | 205 | return $this->getOption($name) === $value; |
@@ -50,53 +50,53 @@ discard block |
||
50 | 50 | public const COLORFORMAT_HEX = 2; |
51 | 51 | |
52 | 52 | /** |
53 | - * @var string |
|
54 | - */ |
|
53 | + * @var string |
|
54 | + */ |
|
55 | 55 | protected $file; |
56 | 56 | |
57 | - /** |
|
58 | - * @var ImageHelper_Size |
|
59 | - */ |
|
57 | + /** |
|
58 | + * @var ImageHelper_Size |
|
59 | + */ |
|
60 | 60 | protected $info; |
61 | 61 | |
62 | - /** |
|
63 | - * @var string |
|
64 | - */ |
|
62 | + /** |
|
63 | + * @var string |
|
64 | + */ |
|
65 | 65 | protected $type; |
66 | 66 | |
67 | - /** |
|
68 | - * @var resource|NULL |
|
69 | - */ |
|
67 | + /** |
|
68 | + * @var resource|NULL |
|
69 | + */ |
|
70 | 70 | protected $newImage; |
71 | 71 | |
72 | - /** |
|
73 | - * @var resource |
|
74 | - */ |
|
72 | + /** |
|
73 | + * @var resource |
|
74 | + */ |
|
75 | 75 | protected $sourceImage; |
76 | 76 | |
77 | - /** |
|
78 | - * @var int |
|
79 | - */ |
|
77 | + /** |
|
78 | + * @var int |
|
79 | + */ |
|
80 | 80 | protected $width; |
81 | 81 | |
82 | - /** |
|
83 | - * @var int |
|
84 | - */ |
|
82 | + /** |
|
83 | + * @var int |
|
84 | + */ |
|
85 | 85 | protected $height; |
86 | 86 | |
87 | - /** |
|
88 | - * @var int |
|
89 | - */ |
|
87 | + /** |
|
88 | + * @var int |
|
89 | + */ |
|
90 | 90 | protected $newWidth = 0; |
91 | 91 | |
92 | - /** |
|
93 | - * @var int |
|
94 | - */ |
|
92 | + /** |
|
93 | + * @var int |
|
94 | + */ |
|
95 | 95 | protected $newHeight = 0; |
96 | 96 | |
97 | - /** |
|
98 | - * @var int |
|
99 | - */ |
|
97 | + /** |
|
98 | + * @var int |
|
99 | + */ |
|
100 | 100 | protected $quality = 85; |
101 | 101 | |
102 | 102 | /** |
@@ -201,17 +201,17 @@ discard block |
||
201 | 201 | } |
202 | 202 | } |
203 | 203 | |
204 | - /** |
|
205 | - * Factory method: creates a new helper with a blank image. |
|
206 | - * |
|
207 | - * @param integer $width |
|
208 | - * @param integer $height |
|
209 | - * @param string $type The target file type when saving |
|
210 | - * @return ImageHelper |
|
211 | - * @throws ImageHelper_Exception |
|
212 | - * |
|
213 | - * @see ImageHelper::ERROR_CANNOT_CREATE_IMAGE_OBJECT |
|
214 | - */ |
|
204 | + /** |
|
205 | + * Factory method: creates a new helper with a blank image. |
|
206 | + * |
|
207 | + * @param integer $width |
|
208 | + * @param integer $height |
|
209 | + * @param string $type The target file type when saving |
|
210 | + * @return ImageHelper |
|
211 | + * @throws ImageHelper_Exception |
|
212 | + * |
|
213 | + * @see ImageHelper::ERROR_CANNOT_CREATE_IMAGE_OBJECT |
|
214 | + */ |
|
215 | 215 | public static function createNew($width, $height, $type='png') |
216 | 216 | { |
217 | 217 | $img = imagecreatetruecolor($width, $height); |
@@ -226,18 +226,18 @@ discard block |
||
226 | 226 | ); |
227 | 227 | } |
228 | 228 | |
229 | - /** |
|
230 | - * Factory method: creates an image helper from an |
|
231 | - * existing image resource. |
|
232 | - * |
|
233 | - * Note: while the resource is type independent, the |
|
234 | - * type parameter is required for some methods, as well |
|
235 | - * as to be able to save the image. |
|
236 | - * |
|
237 | - * @param resource $resource |
|
238 | - * @param string $type The target image type, e.g. "jpeg", "png", etc. |
|
239 | - * @return ImageHelper |
|
240 | - */ |
|
229 | + /** |
|
230 | + * Factory method: creates an image helper from an |
|
231 | + * existing image resource. |
|
232 | + * |
|
233 | + * Note: while the resource is type independent, the |
|
234 | + * type parameter is required for some methods, as well |
|
235 | + * as to be able to save the image. |
|
236 | + * |
|
237 | + * @param resource $resource |
|
238 | + * @param string $type The target image type, e.g. "jpeg", "png", etc. |
|
239 | + * @return ImageHelper |
|
240 | + */ |
|
241 | 241 | public static function createFromResource($resource, ?string $type=null) |
242 | 242 | { |
243 | 243 | self::requireResource($resource); |
@@ -245,29 +245,29 @@ discard block |
||
245 | 245 | return new ImageHelper(null, $resource, $type); |
246 | 246 | } |
247 | 247 | |
248 | - /** |
|
249 | - * Factory method: creates an image helper from an |
|
250 | - * image file on disk. |
|
251 | - * |
|
252 | - * @param string $file |
|
253 | - * @return ImageHelper |
|
254 | - */ |
|
248 | + /** |
|
249 | + * Factory method: creates an image helper from an |
|
250 | + * image file on disk. |
|
251 | + * |
|
252 | + * @param string $file |
|
253 | + * @return ImageHelper |
|
254 | + */ |
|
255 | 255 | public static function createFromFile(string $file) : ImageHelper |
256 | 256 | { |
257 | 257 | return new ImageHelper($file); |
258 | 258 | } |
259 | 259 | |
260 | - /** |
|
261 | - * Sets a global image helper configuration value. Available |
|
262 | - * configuration settings are: |
|
263 | - * |
|
264 | - * <ul> |
|
265 | - * <li><code>auto-memory-adjustment</code> <i>boolean</i> Whether totry and adjust the memory limit automatically so there will be enough to load/process the target image.</li> |
|
266 | - * </ul> |
|
267 | - * |
|
268 | - * @param string $name |
|
269 | - * @param mixed $value |
|
270 | - */ |
|
260 | + /** |
|
261 | + * Sets a global image helper configuration value. Available |
|
262 | + * configuration settings are: |
|
263 | + * |
|
264 | + * <ul> |
|
265 | + * <li><code>auto-memory-adjustment</code> <i>boolean</i> Whether totry and adjust the memory limit automatically so there will be enough to load/process the target image.</li> |
|
266 | + * </ul> |
|
267 | + * |
|
268 | + * @param string $name |
|
269 | + * @param mixed $value |
|
270 | + */ |
|
271 | 271 | public static function setConfig($name, $value) |
272 | 272 | { |
273 | 273 | if(isset(self::$config[$name])) { |
@@ -275,22 +275,22 @@ discard block |
||
275 | 275 | } |
276 | 276 | } |
277 | 277 | |
278 | - /** |
|
279 | - * Shorthand for setting the automatic memory adjustment |
|
280 | - * global configuration setting. |
|
281 | - * |
|
282 | - * @param bool $enabled |
|
283 | - */ |
|
278 | + /** |
|
279 | + * Shorthand for setting the automatic memory adjustment |
|
280 | + * global configuration setting. |
|
281 | + * |
|
282 | + * @param bool $enabled |
|
283 | + */ |
|
284 | 284 | public static function setAutoMemoryAdjustment($enabled=true) |
285 | 285 | { |
286 | 286 | self::setConfig('auto-memory-adjustment', $enabled); |
287 | 287 | } |
288 | 288 | |
289 | - /** |
|
290 | - * Duplicates an image resource. |
|
291 | - * @param resource $img |
|
292 | - * @return resource |
|
293 | - */ |
|
289 | + /** |
|
290 | + * Duplicates an image resource. |
|
291 | + * @param resource $img |
|
292 | + * @return resource |
|
293 | + */ |
|
294 | 294 | protected function duplicateImage($img) |
295 | 295 | { |
296 | 296 | self::requireResource($img); |
@@ -302,12 +302,12 @@ discard block |
||
302 | 302 | return $duplicate; |
303 | 303 | } |
304 | 304 | |
305 | - /** |
|
306 | - * Duplicates the current state of the image into a new |
|
307 | - * image helper instance. |
|
308 | - * |
|
309 | - * @return ImageHelper |
|
310 | - */ |
|
305 | + /** |
|
306 | + * Duplicates the current state of the image into a new |
|
307 | + * image helper instance. |
|
308 | + * |
|
309 | + * @return ImageHelper |
|
310 | + */ |
|
311 | 311 | public function duplicate() |
312 | 312 | { |
313 | 313 | return ImageHelper::createFromResource($this->duplicateImage($this->newImage)); |
@@ -495,13 +495,13 @@ discard block |
||
495 | 495 | )); |
496 | 496 | } |
497 | 497 | |
498 | - /** |
|
499 | - * Resamples the image to a new width, maintaining |
|
500 | - * aspect ratio. |
|
501 | - * |
|
502 | - * @param int $width |
|
503 | - * @return ImageHelper |
|
504 | - */ |
|
498 | + /** |
|
499 | + * Resamples the image to a new width, maintaining |
|
500 | + * aspect ratio. |
|
501 | + * |
|
502 | + * @param int $width |
|
503 | + * @return ImageHelper |
|
504 | + */ |
|
505 | 505 | public function resampleByWidth(int $width) : ImageHelper |
506 | 506 | { |
507 | 507 | $size = $this->getSizeByWidth($width); |
@@ -511,12 +511,12 @@ discard block |
||
511 | 511 | return $this; |
512 | 512 | } |
513 | 513 | |
514 | - /** |
|
515 | - * Resamples the image by height, and creates a new image file on disk. |
|
516 | - * |
|
517 | - * @param int $height |
|
518 | - * @return ImageHelper |
|
519 | - */ |
|
514 | + /** |
|
515 | + * Resamples the image by height, and creates a new image file on disk. |
|
516 | + * |
|
517 | + * @param int $height |
|
518 | + * @return ImageHelper |
|
519 | + */ |
|
520 | 520 | public function resampleByHeight($height) : ImageHelper |
521 | 521 | { |
522 | 522 | $size = $this->getSizeByHeight($height); |
@@ -524,13 +524,13 @@ discard block |
||
524 | 524 | return $this->resampleImage($size->getWidth(), $size->getHeight()); |
525 | 525 | } |
526 | 526 | |
527 | - /** |
|
528 | - * Resamples the image without keeping the aspect ratio. |
|
529 | - * |
|
530 | - * @param int $width |
|
531 | - * @param int $height |
|
532 | - * @return ImageHelper |
|
533 | - */ |
|
527 | + /** |
|
528 | + * Resamples the image without keeping the aspect ratio. |
|
529 | + * |
|
530 | + * @param int $width |
|
531 | + * @param int $height |
|
532 | + * @return ImageHelper |
|
533 | + */ |
|
534 | 534 | public function resample(?int $width = null, ?int $height = null) : ImageHelper |
535 | 535 | { |
536 | 536 | if($this->isVector()) { |
@@ -595,12 +595,12 @@ discard block |
||
595 | 595 | |
596 | 596 | protected $alpha = false; |
597 | 597 | |
598 | - /** |
|
599 | - * Configures the specified image resource to make it alpha compatible. |
|
600 | - * |
|
601 | - * @param resource $canvas |
|
602 | - * @param bool $fill Whether to fill the whole canvas with the transparency |
|
603 | - */ |
|
598 | + /** |
|
599 | + * Configures the specified image resource to make it alpha compatible. |
|
600 | + * |
|
601 | + * @param resource $canvas |
|
602 | + * @param bool $fill Whether to fill the whole canvas with the transparency |
|
603 | + */ |
|
604 | 604 | public static function addAlphaSupport($canvas, $fill=true) |
605 | 605 | { |
606 | 606 | self::requireResource($canvas); |
@@ -715,12 +715,12 @@ discard block |
||
715 | 715 | $this->quality = $quality * 1; |
716 | 716 | } |
717 | 717 | |
718 | - /** |
|
719 | - * Attempts to adjust the memory to the required size |
|
720 | - * to work with the current image. |
|
721 | - * |
|
722 | - * @return boolean |
|
723 | - */ |
|
718 | + /** |
|
719 | + * Attempts to adjust the memory to the required size |
|
720 | + * to work with the current image. |
|
721 | + * |
|
722 | + * @return boolean |
|
723 | + */ |
|
724 | 724 | protected function adjustMemory() : bool |
725 | 725 | { |
726 | 726 | if(!self::$config['auto-memory-adjustment']) { |
@@ -760,27 +760,27 @@ discard block |
||
760 | 760 | return false; |
761 | 761 | } |
762 | 762 | |
763 | - /** |
|
764 | - * Stretches the image to the specified dimensions. |
|
765 | - * |
|
766 | - * @param int $width |
|
767 | - * @param int $height |
|
768 | - * @return ImageHelper |
|
769 | - */ |
|
763 | + /** |
|
764 | + * Stretches the image to the specified dimensions. |
|
765 | + * |
|
766 | + * @param int $width |
|
767 | + * @param int $height |
|
768 | + * @return ImageHelper |
|
769 | + */ |
|
770 | 770 | public function stretch(int $width, int $height) : ImageHelper |
771 | 771 | { |
772 | 772 | return $this->resampleImage($width, $height); |
773 | 773 | } |
774 | 774 | |
775 | - /** |
|
776 | - * Creates a new image from the current image, |
|
777 | - * resampling it to the new size. |
|
778 | - * |
|
779 | - * @param int $newWidth |
|
780 | - * @param int $newHeight |
|
781 | - * @throws ImageHelper_Exception |
|
782 | - * @return ImageHelper |
|
783 | - */ |
|
775 | + /** |
|
776 | + * Creates a new image from the current image, |
|
777 | + * resampling it to the new size. |
|
778 | + * |
|
779 | + * @param int $newWidth |
|
780 | + * @param int $newHeight |
|
781 | + * @throws ImageHelper_Exception |
|
782 | + * @return ImageHelper |
|
783 | + */ |
|
784 | 784 | protected function resampleImage(int $newWidth, int $newHeight) : ImageHelper |
785 | 785 | { |
786 | 786 | if($this->isVector()) { |
@@ -849,17 +849,17 @@ discard block |
||
849 | 849 | return array_unique($types); |
850 | 850 | } |
851 | 851 | |
852 | - /** |
|
853 | - * Displays an existing image resource. |
|
854 | - * |
|
855 | - * @param resource $resource |
|
856 | - * @param string $imageType The image format to send, i.e. "jpeg", "png" |
|
857 | - * @param int $quality The quality to use for the image. This is 0-9 (0=no compression, 9=max) for PNG, and 0-100 (0=lowest, 100=highest quality) for JPG |
|
858 | - * |
|
859 | - * @throws ImageHelper_Exception |
|
860 | - * @see ImageHelper::ERROR_NOT_A_RESOURCE |
|
861 | - * @see ImageHelper::ERROR_INVALID_STREAM_IMAGE_TYPE |
|
862 | - */ |
|
852 | + /** |
|
853 | + * Displays an existing image resource. |
|
854 | + * |
|
855 | + * @param resource $resource |
|
856 | + * @param string $imageType The image format to send, i.e. "jpeg", "png" |
|
857 | + * @param int $quality The quality to use for the image. This is 0-9 (0=no compression, 9=max) for PNG, and 0-100 (0=lowest, 100=highest quality) for JPG |
|
858 | + * |
|
859 | + * @throws ImageHelper_Exception |
|
860 | + * @see ImageHelper::ERROR_NOT_A_RESOURCE |
|
861 | + * @see ImageHelper::ERROR_INVALID_STREAM_IMAGE_TYPE |
|
862 | + */ |
|
863 | 863 | public static function displayImageStream($resource, string $imageType, int $quality=-1) : void |
864 | 864 | { |
865 | 865 | self::requireResource($resource); |
@@ -942,11 +942,11 @@ discard block |
||
942 | 942 | readfile($imageFile); |
943 | 943 | } |
944 | 944 | |
945 | - /** |
|
946 | - * Displays the current image. |
|
947 | - * |
|
948 | - * NOTE: You must call `exit()` manually after this. |
|
949 | - */ |
|
945 | + /** |
|
946 | + * Displays the current image. |
|
947 | + * |
|
948 | + * NOTE: You must call `exit()` manually after this. |
|
949 | + */ |
|
950 | 950 | public function display() : void |
951 | 951 | { |
952 | 952 | $this->displayImageStream( |
@@ -970,16 +970,16 @@ discard block |
||
970 | 970 | return $this->trimImage($this->newImage, $color); |
971 | 971 | } |
972 | 972 | |
973 | - /** |
|
974 | - * Retrieves a color definition by its index. |
|
975 | - * |
|
976 | - * @param resource $img A valid image resource. |
|
977 | - * @param int $colorIndex The color index, as returned by `imagecolorat` for example. |
|
978 | - * @return array<string,int> An array with red, green, blue and alpha keys. |
|
979 | - * |
|
980 | - * @throws ImageHelper_Exception |
|
981 | - * @see ImageHelper::ERROR_NOT_A_RESOURCE |
|
982 | - */ |
|
973 | + /** |
|
974 | + * Retrieves a color definition by its index. |
|
975 | + * |
|
976 | + * @param resource $img A valid image resource. |
|
977 | + * @param int $colorIndex The color index, as returned by `imagecolorat` for example. |
|
978 | + * @return array<string,int> An array with red, green, blue and alpha keys. |
|
979 | + * |
|
980 | + * @throws ImageHelper_Exception |
|
981 | + * @see ImageHelper::ERROR_NOT_A_RESOURCE |
|
982 | + */ |
|
983 | 983 | public function getIndexedColors($img, int $colorIndex) : array |
984 | 984 | { |
985 | 985 | self::requireResource($img); |
@@ -999,18 +999,18 @@ discard block |
||
999 | 999 | ); |
1000 | 1000 | } |
1001 | 1001 | |
1002 | - /** |
|
1003 | - * Trims the specified image resource by removing the specified color. |
|
1004 | - * Also works with transparency. |
|
1005 | - * |
|
1006 | - * @param resource $img |
|
1007 | - * @param array|NULL $color A color definition, as an associative array with red, green, blue and alpha keys. If not specified, the color at pixel position 0,0 will be used. |
|
1008 | - * @return ImageHelper |
|
1009 | - * |
|
1010 | - * @throws ImageHelper_Exception |
|
1011 | - * @see ImageHelper::ERROR_NOT_A_RESOURCE |
|
1012 | - * @see ImageHelper::ERROR_CANNOT_CREATE_IMAGE_CANVAS |
|
1013 | - */ |
|
1002 | + /** |
|
1003 | + * Trims the specified image resource by removing the specified color. |
|
1004 | + * Also works with transparency. |
|
1005 | + * |
|
1006 | + * @param resource $img |
|
1007 | + * @param array|NULL $color A color definition, as an associative array with red, green, blue and alpha keys. If not specified, the color at pixel position 0,0 will be used. |
|
1008 | + * @return ImageHelper |
|
1009 | + * |
|
1010 | + * @throws ImageHelper_Exception |
|
1011 | + * @see ImageHelper::ERROR_NOT_A_RESOURCE |
|
1012 | + * @see ImageHelper::ERROR_CANNOT_CREATE_IMAGE_CANVAS |
|
1013 | + */ |
|
1014 | 1014 | protected function trimImage($img, ?array $color=null) : ImageHelper |
1015 | 1015 | { |
1016 | 1016 | if($this->isVector()) { |
@@ -1118,14 +1118,14 @@ discard block |
||
1118 | 1118 | return $this; |
1119 | 1119 | } |
1120 | 1120 | |
1121 | - /** |
|
1122 | - * Requires the subject to be a resource. |
|
1123 | - * |
|
1124 | - * @param resource|mixed $subject |
|
1125 | - * |
|
1126 | - * @throws ImageHelper_Exception |
|
1127 | - * @see ImageHelper::ERROR_NOT_A_RESOURCE |
|
1128 | - */ |
|
1121 | + /** |
|
1122 | + * Requires the subject to be a resource. |
|
1123 | + * |
|
1124 | + * @param resource|mixed $subject |
|
1125 | + * |
|
1126 | + * @throws ImageHelper_Exception |
|
1127 | + * @see ImageHelper::ERROR_NOT_A_RESOURCE |
|
1128 | + */ |
|
1129 | 1129 | protected static function requireResource($subject) : void |
1130 | 1130 | { |
1131 | 1131 | if(is_resource($subject)) { |
@@ -1142,14 +1142,14 @@ discard block |
||
1142 | 1142 | ); |
1143 | 1143 | } |
1144 | 1144 | |
1145 | - /** |
|
1146 | - * Creates a new image resource, with transparent background. |
|
1147 | - * |
|
1148 | - * @param int $width |
|
1149 | - * @param int $height |
|
1150 | - * @throws ImageHelper_Exception |
|
1151 | - * @return resource |
|
1152 | - */ |
|
1145 | + /** |
|
1146 | + * Creates a new image resource, with transparent background. |
|
1147 | + * |
|
1148 | + * @param int $width |
|
1149 | + * @param int $height |
|
1150 | + * @throws ImageHelper_Exception |
|
1151 | + * @return resource |
|
1152 | + */ |
|
1153 | 1153 | protected function createNewImage(int $width, int $height) |
1154 | 1154 | { |
1155 | 1155 | $img = imagecreatetruecolor($width, $height); |
@@ -1168,54 +1168,54 @@ discard block |
||
1168 | 1168 | return $img; |
1169 | 1169 | } |
1170 | 1170 | |
1171 | - /** |
|
1172 | - * Whether the two specified colors are the same. |
|
1173 | - * |
|
1174 | - * @param array<string,int> $a |
|
1175 | - * @param array<string,int> $b |
|
1176 | - * @return boolean |
|
1177 | - */ |
|
1178 | - protected function colorsMatch(array $a, array $b) : bool |
|
1179 | - { |
|
1180 | - $parts = array('red', 'green', 'blue'); |
|
1181 | - foreach($parts as $part) { |
|
1182 | - if($a[$part] != $b[$part]) { |
|
1183 | - return false; |
|
1184 | - } |
|
1185 | - } |
|
1171 | + /** |
|
1172 | + * Whether the two specified colors are the same. |
|
1173 | + * |
|
1174 | + * @param array<string,int> $a |
|
1175 | + * @param array<string,int> $b |
|
1176 | + * @return boolean |
|
1177 | + */ |
|
1178 | + protected function colorsMatch(array $a, array $b) : bool |
|
1179 | + { |
|
1180 | + $parts = array('red', 'green', 'blue'); |
|
1181 | + foreach($parts as $part) { |
|
1182 | + if($a[$part] != $b[$part]) { |
|
1183 | + return false; |
|
1184 | + } |
|
1185 | + } |
|
1186 | 1186 | |
1187 | - return true; |
|
1188 | - } |
|
1187 | + return true; |
|
1188 | + } |
|
1189 | 1189 | |
1190 | - public function fillWhite($x=0, $y=0) |
|
1191 | - { |
|
1192 | - $this->addRGBColor('white', 255, 255, 255); |
|
1190 | + public function fillWhite($x=0, $y=0) |
|
1191 | + { |
|
1192 | + $this->addRGBColor('white', 255, 255, 255); |
|
1193 | 1193 | return $this->fill('white', $x, $y); |
1194 | - } |
|
1194 | + } |
|
1195 | 1195 | |
1196 | - public function fillTransparent() : ImageHelper |
|
1197 | - { |
|
1196 | + public function fillTransparent() : ImageHelper |
|
1197 | + { |
|
1198 | 1198 | $this->enableAlpha(); |
1199 | 1199 | |
1200 | - self::fillImageTransparent($this->newImage); |
|
1200 | + self::fillImageTransparent($this->newImage); |
|
1201 | 1201 | |
1202 | - return $this; |
|
1203 | - } |
|
1202 | + return $this; |
|
1203 | + } |
|
1204 | 1204 | |
1205 | - public static function fillImageTransparent($resource) |
|
1206 | - { |
|
1207 | - self::requireResource($resource); |
|
1205 | + public static function fillImageTransparent($resource) |
|
1206 | + { |
|
1207 | + self::requireResource($resource); |
|
1208 | 1208 | |
1209 | - $transparent = imagecolorallocatealpha($resource, 89, 14, 207, 127); |
|
1210 | - imagecolortransparent ($resource, $transparent); |
|
1211 | - imagefill($resource, 0, 0, $transparent); |
|
1212 | - } |
|
1209 | + $transparent = imagecolorallocatealpha($resource, 89, 14, 207, 127); |
|
1210 | + imagecolortransparent ($resource, $transparent); |
|
1211 | + imagefill($resource, 0, 0, $transparent); |
|
1212 | + } |
|
1213 | 1213 | |
1214 | - public function fill($colorName, $x=0, $y=0) |
|
1215 | - { |
|
1216 | - imagefill($this->newImage, $x, $y, $this->colors[$colorName]); |
|
1217 | - return $this; |
|
1218 | - } |
|
1214 | + public function fill($colorName, $x=0, $y=0) |
|
1215 | + { |
|
1216 | + imagefill($this->newImage, $x, $y, $this->colors[$colorName]); |
|
1217 | + return $this; |
|
1218 | + } |
|
1219 | 1219 | |
1220 | 1220 | protected $colors = array(); |
1221 | 1221 | |
@@ -1236,9 +1236,9 @@ discard block |
||
1236 | 1236 | return $this; |
1237 | 1237 | } |
1238 | 1238 | |
1239 | - /** |
|
1240 | - * @return resource |
|
1241 | - */ |
|
1239 | + /** |
|
1240 | + * @return resource |
|
1241 | + */ |
|
1242 | 1242 | public function getImage() |
1243 | 1243 | { |
1244 | 1244 | return $this->newImage; |
@@ -1256,26 +1256,26 @@ discard block |
||
1256 | 1256 | return $this; |
1257 | 1257 | } |
1258 | 1258 | |
1259 | - /** |
|
1260 | - * Retrieves the size of the image. |
|
1261 | - * |
|
1262 | - * @return ImageHelper_Size |
|
1263 | - * @throws ImageHelper_Exception |
|
1264 | - * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE |
|
1265 | - */ |
|
1266 | - public function getSize() : ImageHelper_Size |
|
1259 | + /** |
|
1260 | + * Retrieves the size of the image. |
|
1261 | + * |
|
1262 | + * @return ImageHelper_Size |
|
1263 | + * @throws ImageHelper_Exception |
|
1264 | + * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE |
|
1265 | + */ |
|
1266 | + public function getSize() : ImageHelper_Size |
|
1267 | 1267 | { |
1268 | - return self::getImageSize($this->newImage); |
|
1268 | + return self::getImageSize($this->newImage); |
|
1269 | 1269 | } |
1270 | 1270 | |
1271 | 1271 | protected $TTFFile; |
1272 | 1272 | |
1273 | - /** |
|
1274 | - * Sets the TTF font file to use for text operations. |
|
1275 | - * |
|
1276 | - * @param string $filePath |
|
1277 | - * @return ImageHelper |
|
1278 | - */ |
|
1273 | + /** |
|
1274 | + * Sets the TTF font file to use for text operations. |
|
1275 | + * |
|
1276 | + * @param string $filePath |
|
1277 | + * @return ImageHelper |
|
1278 | + */ |
|
1279 | 1279 | public function setFontTTF($filePath) |
1280 | 1280 | { |
1281 | 1281 | $this->TTFFile = $filePath; |
@@ -1347,63 +1347,63 @@ discard block |
||
1347 | 1347 | return; |
1348 | 1348 | } |
1349 | 1349 | |
1350 | - throw new ImageHelper_Exception( |
|
1350 | + throw new ImageHelper_Exception( |
|
1351 | 1351 | 'No true type font specified', |
1352 | 1352 | 'This functionality requires a TTF font file to be specified with the [setFontTTF] method.', |
1353 | 1353 | self::ERROR_NO_TRUE_TYPE_FONT_SET |
1354 | 1354 | ); |
1355 | 1355 | } |
1356 | 1356 | |
1357 | - /** |
|
1358 | - * Retrieves the size of an image file on disk, or |
|
1359 | - * an existing image resource. |
|
1360 | - * |
|
1361 | - * <pre> |
|
1362 | - * array( |
|
1363 | - * 0: (width), |
|
1364 | - * 1: (height), |
|
1365 | - * "channels": the amount of channels |
|
1366 | - * "bits": bits per channel |
|
1357 | + /** |
|
1358 | + * Retrieves the size of an image file on disk, or |
|
1359 | + * an existing image resource. |
|
1360 | + * |
|
1361 | + * <pre> |
|
1362 | + * array( |
|
1363 | + * 0: (width), |
|
1364 | + * 1: (height), |
|
1365 | + * "channels": the amount of channels |
|
1366 | + * "bits": bits per channel |
|
1367 | 1367 | * ) |
1368 | - * </pre> |
|
1369 | - * |
|
1370 | - * @param string|resource $pathOrResource |
|
1371 | - * @return ImageHelper_Size Size object, can also be accessed like the traditional array from getimagesize |
|
1372 | - * @see ImageHelper_Size |
|
1373 | - * @throws ImageHelper_Exception |
|
1374 | - * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE |
|
1375 | - * @see ImageHelper::ERROR_CANNOT_READ_SVG_IMAGE |
|
1376 | - * @see ImageHelper::ERROR_SVG_SOURCE_VIEWBOX_MISSING |
|
1377 | - * @see ImageHelper::ERROR_SVG_VIEWBOX_INVALID |
|
1378 | - */ |
|
1379 | - public static function getImageSize($pathOrResource) : ImageHelper_Size |
|
1380 | - { |
|
1381 | - if(is_resource($pathOrResource)) |
|
1382 | - { |
|
1383 | - return new ImageHelper_Size(array( |
|
1384 | - 'width' => imagesx($pathOrResource), |
|
1385 | - 'height' => imagesy($pathOrResource), |
|
1386 | - 'channels' => 1, |
|
1387 | - 'bits' => 8 |
|
1388 | - )); |
|
1389 | - } |
|
1368 | + * </pre> |
|
1369 | + * |
|
1370 | + * @param string|resource $pathOrResource |
|
1371 | + * @return ImageHelper_Size Size object, can also be accessed like the traditional array from getimagesize |
|
1372 | + * @see ImageHelper_Size |
|
1373 | + * @throws ImageHelper_Exception |
|
1374 | + * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE |
|
1375 | + * @see ImageHelper::ERROR_CANNOT_READ_SVG_IMAGE |
|
1376 | + * @see ImageHelper::ERROR_SVG_SOURCE_VIEWBOX_MISSING |
|
1377 | + * @see ImageHelper::ERROR_SVG_VIEWBOX_INVALID |
|
1378 | + */ |
|
1379 | + public static function getImageSize($pathOrResource) : ImageHelper_Size |
|
1380 | + { |
|
1381 | + if(is_resource($pathOrResource)) |
|
1382 | + { |
|
1383 | + return new ImageHelper_Size(array( |
|
1384 | + 'width' => imagesx($pathOrResource), |
|
1385 | + 'height' => imagesy($pathOrResource), |
|
1386 | + 'channels' => 1, |
|
1387 | + 'bits' => 8 |
|
1388 | + )); |
|
1389 | + } |
|
1390 | 1390 | |
1391 | - $type = self::getFileImageType($pathOrResource); |
|
1391 | + $type = self::getFileImageType($pathOrResource); |
|
1392 | 1392 | |
1393 | - $info = false; |
|
1394 | - $method = 'getImageSize_'.$type; |
|
1395 | - if(method_exists(__CLASS__, $method)) |
|
1396 | - { |
|
1397 | - $info = call_user_func(array(__CLASS__, $method), $pathOrResource); |
|
1398 | - } |
|
1399 | - else |
|
1400 | - { |
|
1401 | - $info = getimagesize($pathOrResource); |
|
1402 | - } |
|
1393 | + $info = false; |
|
1394 | + $method = 'getImageSize_'.$type; |
|
1395 | + if(method_exists(__CLASS__, $method)) |
|
1396 | + { |
|
1397 | + $info = call_user_func(array(__CLASS__, $method), $pathOrResource); |
|
1398 | + } |
|
1399 | + else |
|
1400 | + { |
|
1401 | + $info = getimagesize($pathOrResource); |
|
1402 | + } |
|
1403 | 1403 | |
1404 | - if($info !== false) { |
|
1405 | - return new ImageHelper_Size($info); |
|
1406 | - } |
|
1404 | + if($info !== false) { |
|
1405 | + return new ImageHelper_Size($info); |
|
1406 | + } |
|
1407 | 1407 | |
1408 | 1408 | throw new ImageHelper_Exception( |
1409 | 1409 | 'Error opening image file', |
@@ -1413,98 +1413,98 @@ discard block |
||
1413 | 1413 | ), |
1414 | 1414 | self::ERROR_CANNOT_GET_IMAGE_SIZE |
1415 | 1415 | ); |
1416 | - } |
|
1416 | + } |
|
1417 | 1417 | |
1418 | - /** |
|
1419 | - * @param string $imagePath |
|
1420 | - * @throws ImageHelper_Exception |
|
1421 | - * @return array |
|
1422 | - * |
|
1423 | - * @todo This should return a ImageHelper_Size instance. |
|
1424 | - */ |
|
1425 | - protected static function getImageSize_svg(string $imagePath) : array |
|
1426 | - { |
|
1427 | - $xml = XMLHelper::createSimplexml(); |
|
1428 | - $xml->loadFile($imagePath); |
|
1418 | + /** |
|
1419 | + * @param string $imagePath |
|
1420 | + * @throws ImageHelper_Exception |
|
1421 | + * @return array |
|
1422 | + * |
|
1423 | + * @todo This should return a ImageHelper_Size instance. |
|
1424 | + */ |
|
1425 | + protected static function getImageSize_svg(string $imagePath) : array |
|
1426 | + { |
|
1427 | + $xml = XMLHelper::createSimplexml(); |
|
1428 | + $xml->loadFile($imagePath); |
|
1429 | 1429 | |
1430 | - if($xml->hasErrors()) { |
|
1431 | - throw new ImageHelper_Exception( |
|
1432 | - 'Error opening SVG image', |
|
1433 | - sprintf( |
|
1434 | - 'The XML content of the image [%s] could not be parsed.', |
|
1435 | - $imagePath |
|
1430 | + if($xml->hasErrors()) { |
|
1431 | + throw new ImageHelper_Exception( |
|
1432 | + 'Error opening SVG image', |
|
1433 | + sprintf( |
|
1434 | + 'The XML content of the image [%s] could not be parsed.', |
|
1435 | + $imagePath |
|
1436 | 1436 | ), |
1437 | - self::ERROR_CANNOT_READ_SVG_IMAGE |
|
1437 | + self::ERROR_CANNOT_READ_SVG_IMAGE |
|
1438 | 1438 | ); |
1439 | - } |
|
1439 | + } |
|
1440 | 1440 | |
1441 | - $data = $xml->toArray(); |
|
1442 | - $xml->dispose(); |
|
1443 | - unset($xml); |
|
1441 | + $data = $xml->toArray(); |
|
1442 | + $xml->dispose(); |
|
1443 | + unset($xml); |
|
1444 | 1444 | |
1445 | - if(!isset($data['@attributes']) || !isset($data['@attributes']['viewBox'])) { |
|
1446 | - throw new ImageHelper_Exception( |
|
1447 | - 'SVG Image is corrupted', |
|
1448 | - sprintf( |
|
1449 | - 'The [viewBox] attribute is missing in the XML of the image at path [%s].', |
|
1450 | - $imagePath |
|
1445 | + if(!isset($data['@attributes']) || !isset($data['@attributes']['viewBox'])) { |
|
1446 | + throw new ImageHelper_Exception( |
|
1447 | + 'SVG Image is corrupted', |
|
1448 | + sprintf( |
|
1449 | + 'The [viewBox] attribute is missing in the XML of the image at path [%s].', |
|
1450 | + $imagePath |
|
1451 | 1451 | ), |
1452 | - self::ERROR_SVG_SOURCE_VIEWBOX_MISSING |
|
1452 | + self::ERROR_SVG_SOURCE_VIEWBOX_MISSING |
|
1453 | 1453 | ); |
1454 | - } |
|
1454 | + } |
|
1455 | 1455 | |
1456 | - $svgWidth = parseNumber($data['@attributes']['width'])->getNumber(); |
|
1457 | - $svgHeight = parseNumber($data['@attributes']['height'])->getNumber(); |
|
1456 | + $svgWidth = parseNumber($data['@attributes']['width'])->getNumber(); |
|
1457 | + $svgHeight = parseNumber($data['@attributes']['height'])->getNumber(); |
|
1458 | 1458 | |
1459 | - $viewBox = str_replace(' ', ',', $data['@attributes']['viewBox']); |
|
1460 | - $size = explode(',', $viewBox); |
|
1459 | + $viewBox = str_replace(' ', ',', $data['@attributes']['viewBox']); |
|
1460 | + $size = explode(',', $viewBox); |
|
1461 | 1461 | |
1462 | - if(count($size) != 4) |
|
1463 | - { |
|
1464 | - throw new ImageHelper_Exception( |
|
1465 | - 'SVG image has an invalid viewBox attribute', |
|
1466 | - sprintf( |
|
1467 | - 'The [viewBox] attribute does not have an expected value: [%s] in path [%s].', |
|
1468 | - $viewBox, |
|
1469 | - $imagePath |
|
1462 | + if(count($size) != 4) |
|
1463 | + { |
|
1464 | + throw new ImageHelper_Exception( |
|
1465 | + 'SVG image has an invalid viewBox attribute', |
|
1466 | + sprintf( |
|
1467 | + 'The [viewBox] attribute does not have an expected value: [%s] in path [%s].', |
|
1468 | + $viewBox, |
|
1469 | + $imagePath |
|
1470 | 1470 | ), |
1471 | - self::ERROR_SVG_VIEWBOX_INVALID |
|
1471 | + self::ERROR_SVG_VIEWBOX_INVALID |
|
1472 | 1472 | ); |
1473 | - } |
|
1473 | + } |
|
1474 | 1474 | |
1475 | - $boxWidth = (float)$size[2]; |
|
1476 | - $boxHeight = (float)$size[3]; |
|
1475 | + $boxWidth = (float)$size[2]; |
|
1476 | + $boxHeight = (float)$size[3]; |
|
1477 | 1477 | |
1478 | - // calculate the x and y units of the document: |
|
1479 | - // @see http://tutorials.jenkov.com/svg/svg-viewport-view-box.html#viewbox |
|
1480 | - // |
|
1481 | - // The viewbox combined with the width and heigt of the svg |
|
1482 | - // allow calculating how many pixels are in one unit of the |
|
1483 | - // width and height of the document. |
|
1478 | + // calculate the x and y units of the document: |
|
1479 | + // @see http://tutorials.jenkov.com/svg/svg-viewport-view-box.html#viewbox |
|
1480 | + // |
|
1481 | + // The viewbox combined with the width and heigt of the svg |
|
1482 | + // allow calculating how many pixels are in one unit of the |
|
1483 | + // width and height of the document. |
|
1484 | 1484 | // |
1485 | - $xUnits = $svgWidth / $boxWidth; |
|
1486 | - $yUnits = $svgHeight / $boxHeight; |
|
1485 | + $xUnits = $svgWidth / $boxWidth; |
|
1486 | + $yUnits = $svgHeight / $boxHeight; |
|
1487 | 1487 | |
1488 | - $pxWidth = $xUnits * $svgWidth; |
|
1489 | - $pxHeight = $yUnits * $svgHeight; |
|
1488 | + $pxWidth = $xUnits * $svgWidth; |
|
1489 | + $pxHeight = $yUnits * $svgHeight; |
|
1490 | 1490 | |
1491 | - return array( |
|
1492 | - $pxWidth, |
|
1493 | - $pxHeight, |
|
1494 | - 'bits' => 8 |
|
1495 | - ); |
|
1496 | - } |
|
1491 | + return array( |
|
1492 | + $pxWidth, |
|
1493 | + $pxHeight, |
|
1494 | + 'bits' => 8 |
|
1495 | + ); |
|
1496 | + } |
|
1497 | 1497 | |
1498 | - /** |
|
1499 | - * Crops the image to the specified width and height, optionally |
|
1500 | - * specifying the origin position to crop from. |
|
1501 | - * |
|
1502 | - * @param integer $width |
|
1503 | - * @param integer $height |
|
1504 | - * @param integer $x |
|
1505 | - * @param integer $y |
|
1506 | - * @return ImageHelper |
|
1507 | - */ |
|
1498 | + /** |
|
1499 | + * Crops the image to the specified width and height, optionally |
|
1500 | + * specifying the origin position to crop from. |
|
1501 | + * |
|
1502 | + * @param integer $width |
|
1503 | + * @param integer $height |
|
1504 | + * @param integer $x |
|
1505 | + * @param integer $y |
|
1506 | + * @return ImageHelper |
|
1507 | + */ |
|
1508 | 1508 | public function crop(int $width, int $height, int $x=0, int $y=0) : ImageHelper |
1509 | 1509 | { |
1510 | 1510 | $new = $this->createNewImage($width, $height); |
@@ -1526,22 +1526,22 @@ discard block |
||
1526 | 1526 | return $this->newHeight; |
1527 | 1527 | } |
1528 | 1528 | |
1529 | - /** |
|
1530 | - * Calculates the average color value used in |
|
1531 | - * the image. Returns an associative array |
|
1532 | - * with the red, green, blue and alpha components, |
|
1533 | - * or a HEX color string depending on the selected |
|
1534 | - * format. |
|
1535 | - * |
|
1536 | - * NOTE: Use the calcAverageColorXXX methods for |
|
1537 | - * strict return types. |
|
1538 | - * |
|
1539 | - * @param int $format The format in which to return the color value. |
|
1540 | - * @return array|string |
|
1541 | - * |
|
1542 | - * @see ImageHelper::calcAverageColorRGB() |
|
1543 | - * @see ImageHelper::calcAverageColorHEX() |
|
1544 | - */ |
|
1529 | + /** |
|
1530 | + * Calculates the average color value used in |
|
1531 | + * the image. Returns an associative array |
|
1532 | + * with the red, green, blue and alpha components, |
|
1533 | + * or a HEX color string depending on the selected |
|
1534 | + * format. |
|
1535 | + * |
|
1536 | + * NOTE: Use the calcAverageColorXXX methods for |
|
1537 | + * strict return types. |
|
1538 | + * |
|
1539 | + * @param int $format The format in which to return the color value. |
|
1540 | + * @return array|string |
|
1541 | + * |
|
1542 | + * @see ImageHelper::calcAverageColorRGB() |
|
1543 | + * @see ImageHelper::calcAverageColorHEX() |
|
1544 | + */ |
|
1545 | 1545 | public function calcAverageColor(int $format=self::COLORFORMAT_RGB) |
1546 | 1546 | { |
1547 | 1547 | $image = $this->duplicate(); |
@@ -1550,35 +1550,35 @@ discard block |
||
1550 | 1550 | return $image->getColorAt(0, 0, $format); |
1551 | 1551 | } |
1552 | 1552 | |
1553 | - /** |
|
1554 | - * Calculates the image's average color value, and |
|
1555 | - * returns an associative array with red, green, |
|
1556 | - * blue and alpha keys. |
|
1557 | - * |
|
1558 | - * @throws ImageHelper_Exception |
|
1559 | - * @return array |
|
1560 | - */ |
|
1553 | + /** |
|
1554 | + * Calculates the image's average color value, and |
|
1555 | + * returns an associative array with red, green, |
|
1556 | + * blue and alpha keys. |
|
1557 | + * |
|
1558 | + * @throws ImageHelper_Exception |
|
1559 | + * @return array |
|
1560 | + */ |
|
1561 | 1561 | public function calcAverageColorRGB() : array |
1562 | 1562 | { |
1563 | - $result = $this->calcAverageColor(self::COLORFORMAT_RGB); |
|
1564 | - if(is_array($result)) { |
|
1565 | - return $result; |
|
1566 | - } |
|
1563 | + $result = $this->calcAverageColor(self::COLORFORMAT_RGB); |
|
1564 | + if(is_array($result)) { |
|
1565 | + return $result; |
|
1566 | + } |
|
1567 | 1567 | |
1568 | - throw new ImageHelper_Exception( |
|
1569 | - 'Unexpected color value', |
|
1570 | - sprintf('Expected an array, got [%s].', gettype($result)), |
|
1571 | - self::ERROR_UNEXPECTED_COLOR_VALUE |
|
1572 | - ); |
|
1568 | + throw new ImageHelper_Exception( |
|
1569 | + 'Unexpected color value', |
|
1570 | + sprintf('Expected an array, got [%s].', gettype($result)), |
|
1571 | + self::ERROR_UNEXPECTED_COLOR_VALUE |
|
1572 | + ); |
|
1573 | 1573 | } |
1574 | 1574 | |
1575 | - /** |
|
1576 | - * Calculates the image's average color value, and |
|
1577 | - * returns a hex color string (without the #). |
|
1578 | - * |
|
1579 | - * @throws ImageHelper_Exception |
|
1580 | - * @return string |
|
1581 | - */ |
|
1575 | + /** |
|
1576 | + * Calculates the image's average color value, and |
|
1577 | + * returns a hex color string (without the #). |
|
1578 | + * |
|
1579 | + * @throws ImageHelper_Exception |
|
1580 | + * @return string |
|
1581 | + */ |
|
1582 | 1582 | public function calcAverageColorHex() : string |
1583 | 1583 | { |
1584 | 1584 | $result = $this->calcAverageColor(self::COLORFORMAT_HEX); |
@@ -1645,12 +1645,12 @@ discard block |
||
1645 | 1645 | return $rgb; |
1646 | 1646 | } |
1647 | 1647 | |
1648 | - /** |
|
1649 | - * Converts an RGB value to its luminance equivalent. |
|
1650 | - * |
|
1651 | - * @param array<string,int> $rgb |
|
1652 | - * @return integer Integer, from 0 to 255 (0=black, 255=white) |
|
1653 | - */ |
|
1648 | + /** |
|
1649 | + * Converts an RGB value to its luminance equivalent. |
|
1650 | + * |
|
1651 | + * @param array<string,int> $rgb |
|
1652 | + * @return integer Integer, from 0 to 255 (0=black, 255=white) |
|
1653 | + */ |
|
1654 | 1654 | public static function rgb2luma(array $rgb) : int |
1655 | 1655 | { |
1656 | 1656 | return (int)floor((($rgb['red']*2)+$rgb['blue']+($rgb['green']*3))/6); |
@@ -1670,15 +1670,15 @@ discard block |
||
1670 | 1670 | return $luma * 100 / 255; |
1671 | 1671 | } |
1672 | 1672 | |
1673 | - /** |
|
1674 | - * Retrieves an md5 hash of the source image file. |
|
1675 | - * |
|
1676 | - * NOTE: Only works when the helper has been created |
|
1677 | - * from a file. Otherwise, an exception is thrown. |
|
1678 | - * |
|
1679 | - * @return string |
|
1680 | - * @throws ImageHelper_Exception|OutputBuffering_Exception |
|
1681 | - */ |
|
1673 | + /** |
|
1674 | + * Retrieves an md5 hash of the source image file. |
|
1675 | + * |
|
1676 | + * NOTE: Only works when the helper has been created |
|
1677 | + * from a file. Otherwise, an exception is thrown. |
|
1678 | + * |
|
1679 | + * @return string |
|
1680 | + * @throws ImageHelper_Exception|OutputBuffering_Exception |
|
1681 | + */ |
|
1682 | 1682 | public function getHash() : string |
1683 | 1683 | { |
1684 | 1684 | if($this->newImage === null) |
@@ -40,19 +40,19 @@ discard block |
||
40 | 40 | */ |
41 | 41 | class NumberInfo |
42 | 42 | { |
43 | - /** |
|
44 | - * @var string|int|float|null |
|
45 | - */ |
|
43 | + /** |
|
44 | + * @var string|int|float|null |
|
45 | + */ |
|
46 | 46 | protected $rawValue; |
47 | 47 | |
48 | - /** |
|
49 | - * @var array<string,mixed> |
|
50 | - */ |
|
48 | + /** |
|
49 | + * @var array<string,mixed> |
|
50 | + */ |
|
51 | 51 | protected array $info; |
52 | 52 | |
53 | - /** |
|
54 | - * @var bool |
|
55 | - */ |
|
53 | + /** |
|
54 | + * @var bool |
|
55 | + */ |
|
56 | 56 | protected bool $empty = false; |
57 | 57 | |
58 | 58 | /** |
@@ -62,8 +62,8 @@ discard block |
||
62 | 62 | |
63 | 63 | /** |
64 | 64 | * Units and whether they allow decimal values. |
65 | - * @var array<string,bool> |
|
66 | - */ |
|
65 | + * @var array<string,bool> |
|
66 | + */ |
|
67 | 67 | protected array $knownUnits = array( |
68 | 68 | '%' => true, |
69 | 69 | 'rem' => true, |
@@ -141,21 +141,21 @@ discard block |
||
141 | 141 | return $this; |
142 | 142 | } |
143 | 143 | |
144 | - /** |
|
145 | - * Retrieves the raw, internal information array resulting |
|
146 | - * from the parsing of the number. |
|
147 | - * |
|
148 | - * @return array<string,mixed> |
|
149 | - */ |
|
144 | + /** |
|
145 | + * Retrieves the raw, internal information array resulting |
|
146 | + * from the parsing of the number. |
|
147 | + * |
|
148 | + * @return array<string,mixed> |
|
149 | + */ |
|
150 | 150 | public function getRawInfo() : array |
151 | 151 | { |
152 | 152 | return $this->info; |
153 | 153 | } |
154 | 154 | |
155 | - /** |
|
156 | - * Whether the number was empty (null or empty string). |
|
157 | - * @return boolean |
|
158 | - */ |
|
155 | + /** |
|
156 | + * Whether the number was empty (null or empty string). |
|
157 | + * @return boolean |
|
158 | + */ |
|
159 | 159 | public function isEmpty() : bool |
160 | 160 | { |
161 | 161 | return $this->empty; |
@@ -729,12 +729,12 @@ discard block |
||
729 | 729 | return $cache[$key]; |
730 | 730 | } |
731 | 731 | |
732 | - /** |
|
733 | - * Parses a string number notation with units included, e.g. 14px, 50%... |
|
734 | - * |
|
735 | - * @param string $test |
|
736 | - * @return array<string,mixed> |
|
737 | - */ |
|
732 | + /** |
|
733 | + * Parses a string number notation with units included, e.g. 14px, 50%... |
|
734 | + * |
|
735 | + * @param string $test |
|
736 | + * @return array<string,mixed> |
|
737 | + */ |
|
738 | 738 | private function parseStringValue(string $test) : array |
739 | 739 | { |
740 | 740 | $number = null; |
@@ -785,13 +785,13 @@ discard block |
||
785 | 785 | return $this->filterInfo($result); |
786 | 786 | } |
787 | 787 | |
788 | - /** |
|
789 | - * Attempts to determine what kind of units are specified |
|
790 | - * in the string. Returns NULL if none could be matched. |
|
791 | - * |
|
792 | - * @param string $value |
|
793 | - * @return array<string,mixed>|NULL |
|
794 | - */ |
|
788 | + /** |
|
789 | + * Attempts to determine what kind of units are specified |
|
790 | + * in the string. Returns NULL if none could be matched. |
|
791 | + * |
|
792 | + * @param string $value |
|
793 | + * @return array<string,mixed>|NULL |
|
794 | + */ |
|
795 | 795 | private function findUnits(string $value) : ?array |
796 | 796 | { |
797 | 797 | $vlength = strlen($value); |
@@ -819,12 +819,12 @@ discard block |
||
819 | 819 | return null; |
820 | 820 | } |
821 | 821 | |
822 | - /** |
|
823 | - * Creates the cache key for the specified value. |
|
824 | - * |
|
825 | - * @param mixed $value |
|
826 | - * @return string |
|
827 | - */ |
|
822 | + /** |
|
823 | + * Creates the cache key for the specified value. |
|
824 | + * |
|
825 | + * @param mixed $value |
|
826 | + * @return string |
|
827 | + */ |
|
828 | 828 | private function createValueKey($value) : string |
829 | 829 | { |
830 | 830 | if(!is_string($value) && !is_numeric($value)) |
@@ -835,59 +835,59 @@ discard block |
||
835 | 835 | return (string)$value; |
836 | 836 | } |
837 | 837 | |
838 | - /** |
|
839 | - * Called if explicitly enabled: allows filtering the |
|
840 | - * number after the detection process has completed. |
|
841 | - * |
|
842 | - * @param string|NULL $number The adjusted number |
|
843 | - * @param string $originalString The original value before it was parsed |
|
844 | - * @return string|null |
|
845 | - */ |
|
838 | + /** |
|
839 | + * Called if explicitly enabled: allows filtering the |
|
840 | + * number after the detection process has completed. |
|
841 | + * |
|
842 | + * @param string|NULL $number The adjusted number |
|
843 | + * @param string $originalString The original value before it was parsed |
|
844 | + * @return string|null |
|
845 | + */ |
|
846 | 846 | protected function postProcess(?string $number, /** @scrutinizer ignore-unused */ string $originalString) |
847 | 847 | { |
848 | 848 | return $number; |
849 | 849 | } |
850 | 850 | |
851 | - /** |
|
852 | - * Filters the value before it is parsed, but only if it is a string. |
|
853 | - * |
|
854 | - * NOTE: This may be overwritten in a subclass, to allow custom filtering |
|
855 | - * the values. An example of a use case would be a preprocessor for |
|
856 | - * variables in a templating system. |
|
857 | - * |
|
858 | - * @param string $trimmedString The trimmed value. |
|
859 | - * @param array<string,mixed> $cache The internal values cache array. |
|
860 | - * @param string $originalValue The original value that the NumberInfo was created for. |
|
861 | - * @return string |
|
862 | - * |
|
863 | - * @see NumberInfo::enablePostProcess() |
|
864 | - */ |
|
851 | + /** |
|
852 | + * Filters the value before it is parsed, but only if it is a string. |
|
853 | + * |
|
854 | + * NOTE: This may be overwritten in a subclass, to allow custom filtering |
|
855 | + * the values. An example of a use case would be a preprocessor for |
|
856 | + * variables in a templating system. |
|
857 | + * |
|
858 | + * @param string $trimmedString The trimmed value. |
|
859 | + * @param array<string,mixed> $cache The internal values cache array. |
|
860 | + * @param string $originalValue The original value that the NumberInfo was created for. |
|
861 | + * @return string |
|
862 | + * |
|
863 | + * @see NumberInfo::enablePostProcess() |
|
864 | + */ |
|
865 | 865 | protected function preProcess(string $trimmedString, /** @scrutinizer ignore-unused */ array &$cache, /** @scrutinizer ignore-unused */ string $originalValue) : string |
866 | 866 | { |
867 | 867 | return str_replace(',', '.', $trimmedString); |
868 | 868 | } |
869 | 869 | |
870 | - /** |
|
871 | - * Enables the post-processing so the postProcess method gets called. |
|
872 | - * This should be called in the {@link NumberInfo::preProcess()} |
|
873 | - * method as needed. |
|
874 | - * |
|
875 | - * @return $this |
|
876 | - * @see NumberInfo::postProcess() |
|
877 | - */ |
|
870 | + /** |
|
871 | + * Enables the post-processing so the postProcess method gets called. |
|
872 | + * This should be called in the {@link NumberInfo::preProcess()} |
|
873 | + * method as needed. |
|
874 | + * |
|
875 | + * @return $this |
|
876 | + * @see NumberInfo::postProcess() |
|
877 | + */ |
|
878 | 878 | protected function enablePostProcess() : NumberInfo |
879 | 879 | { |
880 | 880 | $this->postProcess = true; |
881 | 881 | return $this; |
882 | 882 | } |
883 | 883 | |
884 | - /** |
|
885 | - * Filters the number info array to adjust the units |
|
886 | - * and number according to the required rules. |
|
887 | - * |
|
888 | - * @param array<string,mixed> $info |
|
889 | - * @return array<string,mixed> |
|
890 | - */ |
|
884 | + /** |
|
885 | + * Filters the number info array to adjust the units |
|
886 | + * and number according to the required rules. |
|
887 | + * |
|
888 | + * @param array<string,mixed> $info |
|
889 | + * @return array<string,mixed> |
|
890 | + */ |
|
891 | 891 | protected function filterInfo(array $info) : array |
892 | 892 | { |
893 | 893 | $useUnits = 'px'; |
@@ -23,44 +23,44 @@ |
||
23 | 23 | */ |
24 | 24 | class Request_URLComparer |
25 | 25 | { |
26 | - /** |
|
27 | - * @var Request |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var Request |
|
28 | + */ |
|
29 | 29 | protected Request $request; |
30 | 30 | |
31 | - /** |
|
32 | - * @var string |
|
33 | - */ |
|
31 | + /** |
|
32 | + * @var string |
|
33 | + */ |
|
34 | 34 | protected string $sourceURL; |
35 | 35 | |
36 | - /** |
|
37 | - * @var string |
|
38 | - */ |
|
36 | + /** |
|
37 | + * @var string |
|
38 | + */ |
|
39 | 39 | protected string $targetURL; |
40 | 40 | |
41 | - /** |
|
42 | - * @var string[] |
|
43 | - */ |
|
41 | + /** |
|
42 | + * @var string[] |
|
43 | + */ |
|
44 | 44 | protected array $limitParams = array(); |
45 | 45 | |
46 | - /** |
|
47 | - * @var bool |
|
48 | - */ |
|
46 | + /** |
|
47 | + * @var bool |
|
48 | + */ |
|
49 | 49 | protected bool $isMatch = false; |
50 | 50 | |
51 | - /** |
|
52 | - * @var bool |
|
53 | - */ |
|
51 | + /** |
|
52 | + * @var bool |
|
53 | + */ |
|
54 | 54 | protected bool $ignoreFragment = true; |
55 | 55 | |
56 | - /** |
|
57 | - * @var URLInfo |
|
58 | - */ |
|
56 | + /** |
|
57 | + * @var URLInfo |
|
58 | + */ |
|
59 | 59 | protected URLInfo $sourceInfo; |
60 | 60 | |
61 | - /** |
|
62 | - * @var URLInfo |
|
63 | - */ |
|
61 | + /** |
|
62 | + * @var URLInfo |
|
63 | + */ |
|
64 | 64 | protected URLInfo $targetInfo; |
65 | 65 | |
66 | 66 | public function __construct(Request $request, string $sourceURL, string $targetURL) |