@@ -36,14 +36,14 @@ discard block |
||
36 | 36 | 'WriteThreshold' => 100 |
37 | 37 | ); |
38 | 38 | |
39 | - /** |
|
40 | - * @var string |
|
41 | - */ |
|
39 | + /** |
|
40 | + * @var string |
|
41 | + */ |
|
42 | 42 | protected $file; |
43 | 43 | |
44 | - /** |
|
45 | - * @var \ZipArchive |
|
46 | - */ |
|
44 | + /** |
|
45 | + * @var \ZipArchive |
|
46 | + */ |
|
47 | 47 | protected $zip; |
48 | 48 | |
49 | 49 | public function __construct(string $targetFile) |
@@ -51,35 +51,35 @@ discard block |
||
51 | 51 | $this->file = $targetFile; |
52 | 52 | } |
53 | 53 | |
54 | - /** |
|
55 | - * Sets an option, among the available options: |
|
56 | - * |
|
57 | - * <ul> |
|
58 | - * <li>WriteThreshold: The amount of files to add before the zip is automatically written to disk and re-opened to release the file handles. Set to 0 to disable.</li> |
|
59 | - * </ul> |
|
60 | - * |
|
61 | - * @param string $name |
|
62 | - * @param mixed $value |
|
63 | - * @return ZIPHelper |
|
64 | - */ |
|
54 | + /** |
|
55 | + * Sets an option, among the available options: |
|
56 | + * |
|
57 | + * <ul> |
|
58 | + * <li>WriteThreshold: The amount of files to add before the zip is automatically written to disk and re-opened to release the file handles. Set to 0 to disable.</li> |
|
59 | + * </ul> |
|
60 | + * |
|
61 | + * @param string $name |
|
62 | + * @param mixed $value |
|
63 | + * @return ZIPHelper |
|
64 | + */ |
|
65 | 65 | public function setOption(string $name, $value) : ZIPHelper |
66 | 66 | { |
67 | 67 | $this->options[$name] = $value; |
68 | 68 | return $this; |
69 | 69 | } |
70 | 70 | |
71 | - /** |
|
72 | - * Adds a file to the zip. By default, the file is stored |
|
73 | - * with the same name in the root of the zip. Use the optional |
|
74 | - * parameter to change the location in the zip. |
|
75 | - * |
|
76 | - * @param string $filePath |
|
77 | - * @param string|null $zipPath If no path is specified, file will be added with the same name in the ZIP's root. |
|
78 | - * @throws ZIPHelper_Exception |
|
79 | - * @return bool |
|
80 | - * |
|
81 | - * @see FileHelper::ERROR_SOURCE_FILE_DOES_NOT_EXIST |
|
82 | - */ |
|
71 | + /** |
|
72 | + * Adds a file to the zip. By default, the file is stored |
|
73 | + * with the same name in the root of the zip. Use the optional |
|
74 | + * parameter to change the location in the zip. |
|
75 | + * |
|
76 | + * @param string $filePath |
|
77 | + * @param string|null $zipPath If no path is specified, file will be added with the same name in the ZIP's root. |
|
78 | + * @throws ZIPHelper_Exception |
|
79 | + * @return bool |
|
80 | + * |
|
81 | + * @see FileHelper::ERROR_SOURCE_FILE_DOES_NOT_EXIST |
|
82 | + */ |
|
83 | 83 | public function addFile(string $filePath, ?string $zipPath=null) : bool |
84 | 84 | { |
85 | 85 | $this->open(); |
@@ -255,13 +255,13 @@ discard block |
||
255 | 255 | return $fileName; |
256 | 256 | } |
257 | 257 | |
258 | - /** |
|
259 | - * Like {@link ZIPHelper::download()}, but deletes the |
|
260 | - * file after sending it to the browser. |
|
261 | - * |
|
262 | - * @param string|NULL $fileName Override the ZIP's file name for the download |
|
263 | - * @see ZIPHelper::download() |
|
264 | - */ |
|
258 | + /** |
|
259 | + * Like {@link ZIPHelper::download()}, but deletes the |
|
260 | + * file after sending it to the browser. |
|
261 | + * |
|
262 | + * @param string|NULL $fileName Override the ZIP's file name for the download |
|
263 | + * @see ZIPHelper::download() |
|
264 | + */ |
|
265 | 265 | public function downloadAndDelete(?string $fileName=null) |
266 | 266 | { |
267 | 267 | $this->download($fileName); |
@@ -269,14 +269,14 @@ discard block |
||
269 | 269 | FileHelper::deleteFile($this->file); |
270 | 270 | } |
271 | 271 | |
272 | - /** |
|
273 | - * Extracts all files and folders from the zip to the |
|
274 | - * target folder. If no folder is specified, the files |
|
275 | - * are extracted into the same folder as the zip itself. |
|
276 | - * |
|
277 | - * @param string|NULL $outputFolder If no folder is specified, uses the target file's folder. |
|
278 | - * @return boolean |
|
279 | - */ |
|
272 | + /** |
|
273 | + * Extracts all files and folders from the zip to the |
|
274 | + * target folder. If no folder is specified, the files |
|
275 | + * are extracted into the same folder as the zip itself. |
|
276 | + * |
|
277 | + * @param string|NULL $outputFolder If no folder is specified, uses the target file's folder. |
|
278 | + * @return boolean |
|
279 | + */ |
|
280 | 280 | public function extractAll(?string $outputFolder=null) : bool |
281 | 281 | { |
282 | 282 | if(empty($outputFolder)) { |
@@ -289,9 +289,9 @@ discard block |
||
289 | 289 | } |
290 | 290 | |
291 | 291 | |
292 | - /** |
|
293 | - * @return \ZipArchive |
|
294 | - */ |
|
292 | + /** |
|
293 | + * @return \ZipArchive |
|
294 | + */ |
|
295 | 295 | public function getArchive() : \ZipArchive |
296 | 296 | { |
297 | 297 | $this->open(); |
@@ -299,14 +299,14 @@ discard block |
||
299 | 299 | return $this->zip; |
300 | 300 | } |
301 | 301 | |
302 | - /** |
|
303 | - * JSON encodes the specified data and adds the json as |
|
304 | - * a file in the ZIP archive. |
|
305 | - * |
|
306 | - * @param mixed $data |
|
307 | - * @param string $zipPath |
|
308 | - * @return boolean |
|
309 | - */ |
|
302 | + /** |
|
303 | + * JSON encodes the specified data and adds the json as |
|
304 | + * a file in the ZIP archive. |
|
305 | + * |
|
306 | + * @param mixed $data |
|
307 | + * @param string $zipPath |
|
308 | + * @return boolean |
|
309 | + */ |
|
310 | 310 | public function addJSON($data, $zipPath) |
311 | 311 | { |
312 | 312 | return $this->addString( |
@@ -68,54 +68,54 @@ discard block |
||
68 | 68 | |
69 | 69 | const ERROR_UNEXPECTED_COLOR_VALUE = 513025; |
70 | 70 | |
71 | - /** |
|
72 | - * @var string |
|
73 | - */ |
|
71 | + /** |
|
72 | + * @var string |
|
73 | + */ |
|
74 | 74 | protected $file; |
75 | 75 | |
76 | - /** |
|
77 | - * @var ImageHelper_Size |
|
78 | - */ |
|
76 | + /** |
|
77 | + * @var ImageHelper_Size |
|
78 | + */ |
|
79 | 79 | protected $info; |
80 | 80 | |
81 | - /** |
|
82 | - * @var string |
|
83 | - */ |
|
81 | + /** |
|
82 | + * @var string |
|
83 | + */ |
|
84 | 84 | protected $type; |
85 | 85 | |
86 | - /** |
|
87 | - * @var resource|NULL |
|
88 | - */ |
|
86 | + /** |
|
87 | + * @var resource|NULL |
|
88 | + */ |
|
89 | 89 | protected $newImage; |
90 | 90 | |
91 | - /** |
|
92 | - * @var resource |
|
93 | - */ |
|
91 | + /** |
|
92 | + * @var resource |
|
93 | + */ |
|
94 | 94 | protected $sourceImage; |
95 | 95 | |
96 | - /** |
|
97 | - * @var int |
|
98 | - */ |
|
96 | + /** |
|
97 | + * @var int |
|
98 | + */ |
|
99 | 99 | protected $width; |
100 | 100 | |
101 | - /** |
|
102 | - * @var int |
|
103 | - */ |
|
101 | + /** |
|
102 | + * @var int |
|
103 | + */ |
|
104 | 104 | protected $height; |
105 | 105 | |
106 | - /** |
|
107 | - * @var int |
|
108 | - */ |
|
106 | + /** |
|
107 | + * @var int |
|
108 | + */ |
|
109 | 109 | protected $newWidth = 0; |
110 | 110 | |
111 | - /** |
|
112 | - * @var int |
|
113 | - */ |
|
111 | + /** |
|
112 | + * @var int |
|
113 | + */ |
|
114 | 114 | protected $newHeight = 0; |
115 | 115 | |
116 | - /** |
|
117 | - * @var int |
|
118 | - */ |
|
116 | + /** |
|
117 | + * @var int |
|
118 | + */ |
|
119 | 119 | protected $quality = 85; |
120 | 120 | |
121 | 121 | protected static $imageTypes = array( |
@@ -203,17 +203,17 @@ discard block |
||
203 | 203 | } |
204 | 204 | } |
205 | 205 | |
206 | - /** |
|
207 | - * Factory method: creates a new helper with a blank image. |
|
208 | - * |
|
209 | - * @param integer $width |
|
210 | - * @param integer $height |
|
211 | - * @param string $type The target file type when saving |
|
212 | - * @return ImageHelper |
|
213 | - * @throws ImageHelper_Exception |
|
214 | - * |
|
215 | - * @see ImageHelper::ERROR_CANNOT_CREATE_IMAGE_OBJECT |
|
216 | - */ |
|
206 | + /** |
|
207 | + * Factory method: creates a new helper with a blank image. |
|
208 | + * |
|
209 | + * @param integer $width |
|
210 | + * @param integer $height |
|
211 | + * @param string $type The target file type when saving |
|
212 | + * @return ImageHelper |
|
213 | + * @throws ImageHelper_Exception |
|
214 | + * |
|
215 | + * @see ImageHelper::ERROR_CANNOT_CREATE_IMAGE_OBJECT |
|
216 | + */ |
|
217 | 217 | public static function createNew($width, $height, $type='png') |
218 | 218 | { |
219 | 219 | $img = imagecreatetruecolor($width, $height); |
@@ -228,18 +228,18 @@ discard block |
||
228 | 228 | ); |
229 | 229 | } |
230 | 230 | |
231 | - /** |
|
232 | - * Factory method: creates an image helper from an |
|
233 | - * existing image resource. |
|
234 | - * |
|
235 | - * Note: while the resource is type independent, the |
|
236 | - * type parameter is required for some methods, as well |
|
237 | - * as to be able to save the image. |
|
238 | - * |
|
239 | - * @param resource $resource |
|
240 | - * @param string $type The target image type, e.g. "jpeg", "png", etc. |
|
241 | - * @return ImageHelper |
|
242 | - */ |
|
231 | + /** |
|
232 | + * Factory method: creates an image helper from an |
|
233 | + * existing image resource. |
|
234 | + * |
|
235 | + * Note: while the resource is type independent, the |
|
236 | + * type parameter is required for some methods, as well |
|
237 | + * as to be able to save the image. |
|
238 | + * |
|
239 | + * @param resource $resource |
|
240 | + * @param string $type The target image type, e.g. "jpeg", "png", etc. |
|
241 | + * @return ImageHelper |
|
242 | + */ |
|
243 | 243 | public static function createFromResource($resource, ?string $type=null) |
244 | 244 | { |
245 | 245 | self::requireResource($resource); |
@@ -247,29 +247,29 @@ discard block |
||
247 | 247 | return new ImageHelper(null, $resource, $type); |
248 | 248 | } |
249 | 249 | |
250 | - /** |
|
251 | - * Factory method: creates an image helper from an |
|
252 | - * image file on disk. |
|
253 | - * |
|
254 | - * @param string $path |
|
255 | - * @return ImageHelper |
|
256 | - */ |
|
250 | + /** |
|
251 | + * Factory method: creates an image helper from an |
|
252 | + * image file on disk. |
|
253 | + * |
|
254 | + * @param string $path |
|
255 | + * @return ImageHelper |
|
256 | + */ |
|
257 | 257 | public static function createFromFile($file) |
258 | 258 | { |
259 | 259 | return new ImageHelper($file); |
260 | 260 | } |
261 | 261 | |
262 | - /** |
|
263 | - * Sets a global image helper configuration value. Available |
|
264 | - * configuration settings are: |
|
265 | - * |
|
266 | - * <ul> |
|
267 | - * <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> |
|
268 | - * </ul> |
|
269 | - * |
|
270 | - * @param string $name |
|
271 | - * @param mixed $value |
|
272 | - */ |
|
262 | + /** |
|
263 | + * Sets a global image helper configuration value. Available |
|
264 | + * configuration settings are: |
|
265 | + * |
|
266 | + * <ul> |
|
267 | + * <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> |
|
268 | + * </ul> |
|
269 | + * |
|
270 | + * @param string $name |
|
271 | + * @param mixed $value |
|
272 | + */ |
|
273 | 273 | public static function setConfig($name, $value) |
274 | 274 | { |
275 | 275 | if(isset(self::$config[$name])) { |
@@ -277,22 +277,22 @@ discard block |
||
277 | 277 | } |
278 | 278 | } |
279 | 279 | |
280 | - /** |
|
281 | - * Shorthand for setting the automatic memory adjustment |
|
282 | - * global configuration setting. |
|
283 | - * |
|
284 | - * @param bool $enabled |
|
285 | - */ |
|
280 | + /** |
|
281 | + * Shorthand for setting the automatic memory adjustment |
|
282 | + * global configuration setting. |
|
283 | + * |
|
284 | + * @param bool $enabled |
|
285 | + */ |
|
286 | 286 | public static function setAutoMemoryAdjustment($enabled=true) |
287 | 287 | { |
288 | 288 | self::setConfig('auto-memory-adjustment', $enabled); |
289 | 289 | } |
290 | 290 | |
291 | - /** |
|
292 | - * Duplicates an image resource. |
|
293 | - * @param resource $img |
|
294 | - * @return resource |
|
295 | - */ |
|
291 | + /** |
|
292 | + * Duplicates an image resource. |
|
293 | + * @param resource $img |
|
294 | + * @return resource |
|
295 | + */ |
|
296 | 296 | protected function duplicateImage($img) |
297 | 297 | { |
298 | 298 | self::requireResource($img); |
@@ -304,12 +304,12 @@ discard block |
||
304 | 304 | return $duplicate; |
305 | 305 | } |
306 | 306 | |
307 | - /** |
|
308 | - * Duplicates the current state of the image into a new |
|
309 | - * image helper instance. |
|
310 | - * |
|
311 | - * @return ImageHelper |
|
312 | - */ |
|
307 | + /** |
|
308 | + * Duplicates the current state of the image into a new |
|
309 | + * image helper instance. |
|
310 | + * |
|
311 | + * @return ImageHelper |
|
312 | + */ |
|
313 | 313 | public function duplicate() |
314 | 314 | { |
315 | 315 | return ImageHelper::createFromResource($this->duplicateImage($this->newImage)); |
@@ -497,13 +497,13 @@ discard block |
||
497 | 497 | )); |
498 | 498 | } |
499 | 499 | |
500 | - /** |
|
501 | - * Resamples the image to a new width, maintaining |
|
502 | - * aspect ratio. |
|
503 | - * |
|
504 | - * @param int $width |
|
505 | - * @return ImageHelper |
|
506 | - */ |
|
500 | + /** |
|
501 | + * Resamples the image to a new width, maintaining |
|
502 | + * aspect ratio. |
|
503 | + * |
|
504 | + * @param int $width |
|
505 | + * @return ImageHelper |
|
506 | + */ |
|
507 | 507 | public function resampleByWidth(int $width) : ImageHelper |
508 | 508 | { |
509 | 509 | $size = $this->getSizeByWidth($width); |
@@ -513,12 +513,12 @@ discard block |
||
513 | 513 | return $this; |
514 | 514 | } |
515 | 515 | |
516 | - /** |
|
517 | - * Resamples the image by height, and creates a new image file on disk. |
|
518 | - * |
|
519 | - * @param int $height |
|
520 | - * @return ImageHelper |
|
521 | - */ |
|
516 | + /** |
|
517 | + * Resamples the image by height, and creates a new image file on disk. |
|
518 | + * |
|
519 | + * @param int $height |
|
520 | + * @return ImageHelper |
|
521 | + */ |
|
522 | 522 | public function resampleByHeight($height) : ImageHelper |
523 | 523 | { |
524 | 524 | $size = $this->getSizeByHeight($height); |
@@ -526,13 +526,13 @@ discard block |
||
526 | 526 | return $this->resampleImage($size->getWidth(), $size->getHeight()); |
527 | 527 | } |
528 | 528 | |
529 | - /** |
|
530 | - * Resamples the image without keeping the aspect ratio. |
|
531 | - * |
|
532 | - * @param int $width |
|
533 | - * @param int $height |
|
534 | - * @return ImageHelper |
|
535 | - */ |
|
529 | + /** |
|
530 | + * Resamples the image without keeping the aspect ratio. |
|
531 | + * |
|
532 | + * @param int $width |
|
533 | + * @param int $height |
|
534 | + * @return ImageHelper |
|
535 | + */ |
|
536 | 536 | public function resample(?int $width = null, ?int $height = null) : ImageHelper |
537 | 537 | { |
538 | 538 | if($this->isVector()) { |
@@ -597,12 +597,12 @@ discard block |
||
597 | 597 | |
598 | 598 | protected $alpha = false; |
599 | 599 | |
600 | - /** |
|
601 | - * Configures the specified image resource to make it alpha compatible. |
|
602 | - * |
|
603 | - * @param resource $canvas |
|
604 | - * @param bool $fill Whether to fill the whole canvas with the transparency |
|
605 | - */ |
|
600 | + /** |
|
601 | + * Configures the specified image resource to make it alpha compatible. |
|
602 | + * |
|
603 | + * @param resource $canvas |
|
604 | + * @param bool $fill Whether to fill the whole canvas with the transparency |
|
605 | + */ |
|
606 | 606 | public static function addAlphaSupport($canvas, $fill=true) |
607 | 607 | { |
608 | 608 | self::requireResource($canvas); |
@@ -717,12 +717,12 @@ discard block |
||
717 | 717 | $this->quality = $quality * 1; |
718 | 718 | } |
719 | 719 | |
720 | - /** |
|
721 | - * Attempts to adjust the memory to the required size |
|
722 | - * to work with the current image. |
|
723 | - * |
|
724 | - * @return boolean |
|
725 | - */ |
|
720 | + /** |
|
721 | + * Attempts to adjust the memory to the required size |
|
722 | + * to work with the current image. |
|
723 | + * |
|
724 | + * @return boolean |
|
725 | + */ |
|
726 | 726 | protected function adjustMemory() : bool |
727 | 727 | { |
728 | 728 | if(!self::$config['auto-memory-adjustment']) { |
@@ -762,27 +762,27 @@ discard block |
||
762 | 762 | return false; |
763 | 763 | } |
764 | 764 | |
765 | - /** |
|
766 | - * Stretches the image to the specified dimensions. |
|
767 | - * |
|
768 | - * @param int $width |
|
769 | - * @param int $height |
|
770 | - * @return ImageHelper |
|
771 | - */ |
|
765 | + /** |
|
766 | + * Stretches the image to the specified dimensions. |
|
767 | + * |
|
768 | + * @param int $width |
|
769 | + * @param int $height |
|
770 | + * @return ImageHelper |
|
771 | + */ |
|
772 | 772 | public function stretch(int $width, int $height) : ImageHelper |
773 | 773 | { |
774 | 774 | return $this->resampleImage($width, $height); |
775 | 775 | } |
776 | 776 | |
777 | - /** |
|
778 | - * Creates a new image from the current image, |
|
779 | - * resampling it to the new size. |
|
780 | - * |
|
781 | - * @param int $newWidth |
|
782 | - * @param int $newHeight |
|
783 | - * @throws ImageHelper_Exception |
|
784 | - * @return ImageHelper |
|
785 | - */ |
|
777 | + /** |
|
778 | + * Creates a new image from the current image, |
|
779 | + * resampling it to the new size. |
|
780 | + * |
|
781 | + * @param int $newWidth |
|
782 | + * @param int $newHeight |
|
783 | + * @throws ImageHelper_Exception |
|
784 | + * @return ImageHelper |
|
785 | + */ |
|
786 | 786 | protected function resampleImage(int $newWidth, int $newHeight) : ImageHelper |
787 | 787 | { |
788 | 788 | if($this->isVector()) { |
@@ -922,31 +922,31 @@ discard block |
||
922 | 922 | readfile($imageFile); |
923 | 923 | } |
924 | 924 | |
925 | - /** |
|
926 | - * Displays the current image. |
|
927 | - */ |
|
925 | + /** |
|
926 | + * Displays the current image. |
|
927 | + */ |
|
928 | 928 | public function display() |
929 | 929 | { |
930 | 930 | $this->displayImageStream($this->newImage, $this->getType(), $this->resolveQuality()); |
931 | 931 | } |
932 | 932 | |
933 | - /** |
|
934 | - * Trims the current loaded image. |
|
935 | - * |
|
936 | - * @param array $color A color definition, as an associative array with red, green, and blue keys. If not specified, the color at pixel position 0,0 will be used. |
|
937 | - */ |
|
933 | + /** |
|
934 | + * Trims the current loaded image. |
|
935 | + * |
|
936 | + * @param array $color A color definition, as an associative array with red, green, and blue keys. If not specified, the color at pixel position 0,0 will be used. |
|
937 | + */ |
|
938 | 938 | public function trim($color=null) |
939 | 939 | { |
940 | 940 | return $this->trimImage($this->newImage, $color); |
941 | 941 | } |
942 | 942 | |
943 | - /** |
|
944 | - * Retrieves a color definition by its index. |
|
945 | - * |
|
946 | - * @param resource $img A valid image resource. |
|
947 | - * @param int $colorIndex The color index, as returned by imagecolorat for example. |
|
948 | - * @return array An array with red, green, blue and alpha keys. |
|
949 | - */ |
|
943 | + /** |
|
944 | + * Retrieves a color definition by its index. |
|
945 | + * |
|
946 | + * @param resource $img A valid image resource. |
|
947 | + * @param int $colorIndex The color index, as returned by imagecolorat for example. |
|
948 | + * @return array An array with red, green, blue and alpha keys. |
|
949 | + */ |
|
950 | 950 | public function getIndexedColors($img, int $colorIndex) : array |
951 | 951 | { |
952 | 952 | $color = imagecolorsforindex($img, $colorIndex); |
@@ -964,14 +964,14 @@ discard block |
||
964 | 964 | ); |
965 | 965 | } |
966 | 966 | |
967 | - /** |
|
968 | - * Trims the specified image resource by removing the specified color. |
|
969 | - * Also works with transparency. |
|
970 | - * |
|
971 | - * @param resource $img |
|
972 | - * @param array $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. |
|
973 | - * @return ImageHelper |
|
974 | - */ |
|
967 | + /** |
|
968 | + * Trims the specified image resource by removing the specified color. |
|
969 | + * Also works with transparency. |
|
970 | + * |
|
971 | + * @param resource $img |
|
972 | + * @param array $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. |
|
973 | + * @return ImageHelper |
|
974 | + */ |
|
975 | 975 | protected function trimImage($img, ?array $color=null) : ImageHelper |
976 | 976 | { |
977 | 977 | if($this->isVector()) { |
@@ -1059,12 +1059,12 @@ discard block |
||
1059 | 1059 | return $this; |
1060 | 1060 | } |
1061 | 1061 | |
1062 | - /** |
|
1063 | - * Sets the new image after a transformation operation: |
|
1064 | - * automatically adjusts the new size information. |
|
1065 | - * |
|
1066 | - * @param resource $image |
|
1067 | - */ |
|
1062 | + /** |
|
1063 | + * Sets the new image after a transformation operation: |
|
1064 | + * automatically adjusts the new size information. |
|
1065 | + * |
|
1066 | + * @param resource $image |
|
1067 | + */ |
|
1068 | 1068 | protected function setNewImage($image) |
1069 | 1069 | { |
1070 | 1070 | self::requireResource($image); |
@@ -1074,12 +1074,12 @@ discard block |
||
1074 | 1074 | $this->newHeight= imagesy($image); |
1075 | 1075 | } |
1076 | 1076 | |
1077 | - /** |
|
1078 | - * Requires the subject to be a resource. |
|
1079 | - * |
|
1080 | - * @param resource $subject |
|
1081 | - * @throws ImageHelper_Exception |
|
1082 | - */ |
|
1077 | + /** |
|
1078 | + * Requires the subject to be a resource. |
|
1079 | + * |
|
1080 | + * @param resource $subject |
|
1081 | + * @throws ImageHelper_Exception |
|
1082 | + */ |
|
1083 | 1083 | protected static function requireResource($subject) |
1084 | 1084 | { |
1085 | 1085 | if(is_resource($subject)) { |
@@ -1096,14 +1096,14 @@ discard block |
||
1096 | 1096 | ); |
1097 | 1097 | } |
1098 | 1098 | |
1099 | - /** |
|
1100 | - * Creates a new image resource, with transparent background. |
|
1101 | - * |
|
1102 | - * @param int $width |
|
1103 | - * @param int $height |
|
1104 | - * @throws ImageHelper_Exception |
|
1105 | - * @return resource |
|
1106 | - */ |
|
1099 | + /** |
|
1100 | + * Creates a new image resource, with transparent background. |
|
1101 | + * |
|
1102 | + * @param int $width |
|
1103 | + * @param int $height |
|
1104 | + * @throws ImageHelper_Exception |
|
1105 | + * @return resource |
|
1106 | + */ |
|
1107 | 1107 | protected function createNewImage(int $width, int $height) |
1108 | 1108 | { |
1109 | 1109 | $img = imagecreatetruecolor($width, $height); |
@@ -1122,54 +1122,54 @@ discard block |
||
1122 | 1122 | return $img; |
1123 | 1123 | } |
1124 | 1124 | |
1125 | - /** |
|
1126 | - * Whether the two specified colors are the same. |
|
1127 | - * |
|
1128 | - * @param array $a |
|
1129 | - * @param array $b |
|
1130 | - * @return boolean |
|
1131 | - */ |
|
1132 | - protected function colorsMatch($a, $b) : bool |
|
1133 | - { |
|
1134 | - $parts = array('red', 'green', 'blue'); |
|
1135 | - foreach($parts as $part) { |
|
1136 | - if($a[$part] != $b[$part]) { |
|
1137 | - return false; |
|
1138 | - } |
|
1139 | - } |
|
1125 | + /** |
|
1126 | + * Whether the two specified colors are the same. |
|
1127 | + * |
|
1128 | + * @param array $a |
|
1129 | + * @param array $b |
|
1130 | + * @return boolean |
|
1131 | + */ |
|
1132 | + protected function colorsMatch($a, $b) : bool |
|
1133 | + { |
|
1134 | + $parts = array('red', 'green', 'blue'); |
|
1135 | + foreach($parts as $part) { |
|
1136 | + if($a[$part] != $b[$part]) { |
|
1137 | + return false; |
|
1138 | + } |
|
1139 | + } |
|
1140 | 1140 | |
1141 | - return true; |
|
1142 | - } |
|
1141 | + return true; |
|
1142 | + } |
|
1143 | 1143 | |
1144 | - public function fillWhite($x=0, $y=0) |
|
1145 | - { |
|
1146 | - $this->addRGBColor('white', 255, 255, 255); |
|
1144 | + public function fillWhite($x=0, $y=0) |
|
1145 | + { |
|
1146 | + $this->addRGBColor('white', 255, 255, 255); |
|
1147 | 1147 | return $this->fill('white', $x, $y); |
1148 | - } |
|
1148 | + } |
|
1149 | 1149 | |
1150 | - public function fillTransparent() : ImageHelper |
|
1151 | - { |
|
1150 | + public function fillTransparent() : ImageHelper |
|
1151 | + { |
|
1152 | 1152 | $this->enableAlpha(); |
1153 | 1153 | |
1154 | - self::fillImageTransparent($this->newImage); |
|
1154 | + self::fillImageTransparent($this->newImage); |
|
1155 | 1155 | |
1156 | - return $this; |
|
1157 | - } |
|
1156 | + return $this; |
|
1157 | + } |
|
1158 | 1158 | |
1159 | - public static function fillImageTransparent($resource) |
|
1160 | - { |
|
1161 | - self::requireResource($resource); |
|
1159 | + public static function fillImageTransparent($resource) |
|
1160 | + { |
|
1161 | + self::requireResource($resource); |
|
1162 | 1162 | |
1163 | - $transparent = imagecolorallocatealpha($resource, 89, 14, 207, 127); |
|
1164 | - imagecolortransparent ($resource, $transparent); |
|
1165 | - imagefill($resource, 0, 0, $transparent); |
|
1166 | - } |
|
1163 | + $transparent = imagecolorallocatealpha($resource, 89, 14, 207, 127); |
|
1164 | + imagecolortransparent ($resource, $transparent); |
|
1165 | + imagefill($resource, 0, 0, $transparent); |
|
1166 | + } |
|
1167 | 1167 | |
1168 | - public function fill($colorName, $x=0, $y=0) |
|
1169 | - { |
|
1170 | - imagefill($this->newImage, $x, $y, $this->colors[$colorName]); |
|
1171 | - return $this; |
|
1172 | - } |
|
1168 | + public function fill($colorName, $x=0, $y=0) |
|
1169 | + { |
|
1170 | + imagefill($this->newImage, $x, $y, $this->colors[$colorName]); |
|
1171 | + return $this; |
|
1172 | + } |
|
1173 | 1173 | |
1174 | 1174 | protected $colors = array(); |
1175 | 1175 | |
@@ -1190,9 +1190,9 @@ discard block |
||
1190 | 1190 | return $this; |
1191 | 1191 | } |
1192 | 1192 | |
1193 | - /** |
|
1194 | - * @return resource |
|
1195 | - */ |
|
1193 | + /** |
|
1194 | + * @return resource |
|
1195 | + */ |
|
1196 | 1196 | public function getImage() |
1197 | 1197 | { |
1198 | 1198 | return $this->newImage; |
@@ -1210,27 +1210,27 @@ discard block |
||
1210 | 1210 | return $this; |
1211 | 1211 | } |
1212 | 1212 | |
1213 | - /** |
|
1214 | - * Retrieves the size of the image. |
|
1215 | - * |
|
1216 | - * @param bool $exception Whether to trigger an exception when the image does not exist |
|
1217 | - * @return ImageHelper_Size |
|
1218 | - * @throws ImageHelper_Exception |
|
1219 | - * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE |
|
1220 | - */ |
|
1221 | - public function getSize() : ImageHelper_Size |
|
1213 | + /** |
|
1214 | + * Retrieves the size of the image. |
|
1215 | + * |
|
1216 | + * @param bool $exception Whether to trigger an exception when the image does not exist |
|
1217 | + * @return ImageHelper_Size |
|
1218 | + * @throws ImageHelper_Exception |
|
1219 | + * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE |
|
1220 | + */ |
|
1221 | + public function getSize() : ImageHelper_Size |
|
1222 | 1222 | { |
1223 | - return self::getImageSize($this->newImage); |
|
1223 | + return self::getImageSize($this->newImage); |
|
1224 | 1224 | } |
1225 | 1225 | |
1226 | 1226 | protected $TTFFile; |
1227 | 1227 | |
1228 | - /** |
|
1229 | - * Sets the TTF font file to use for text operations. |
|
1230 | - * |
|
1231 | - * @param string $filePath |
|
1232 | - * @return ImageHelper |
|
1233 | - */ |
|
1228 | + /** |
|
1229 | + * Sets the TTF font file to use for text operations. |
|
1230 | + * |
|
1231 | + * @param string $filePath |
|
1232 | + * @return ImageHelper |
|
1233 | + */ |
|
1234 | 1234 | public function setFontTTF($filePath) |
1235 | 1235 | { |
1236 | 1236 | $this->TTFFile = $filePath; |
@@ -1302,63 +1302,63 @@ discard block |
||
1302 | 1302 | return; |
1303 | 1303 | } |
1304 | 1304 | |
1305 | - throw new ImageHelper_Exception( |
|
1305 | + throw new ImageHelper_Exception( |
|
1306 | 1306 | 'No true type font specified', |
1307 | 1307 | 'This functionality requires a TTF font file to be specified with the [setFontTTF] method.', |
1308 | 1308 | self::ERROR_NO_TRUE_TYPE_FONT_SET |
1309 | 1309 | ); |
1310 | 1310 | } |
1311 | 1311 | |
1312 | - /** |
|
1313 | - * Retrieves the size of an image file on disk, or |
|
1314 | - * an existing image resource. |
|
1315 | - * |
|
1316 | - * <pre> |
|
1317 | - * array( |
|
1318 | - * 0: (width), |
|
1319 | - * 1: (height), |
|
1320 | - * "channels": the amount of channels |
|
1321 | - * "bits": bits per channel |
|
1312 | + /** |
|
1313 | + * Retrieves the size of an image file on disk, or |
|
1314 | + * an existing image resource. |
|
1315 | + * |
|
1316 | + * <pre> |
|
1317 | + * array( |
|
1318 | + * 0: (width), |
|
1319 | + * 1: (height), |
|
1320 | + * "channels": the amount of channels |
|
1321 | + * "bits": bits per channel |
|
1322 | 1322 | * ) |
1323 | - * </pre> |
|
1324 | - * |
|
1325 | - * @param string|resource $pathOrResource |
|
1326 | - * @return ImageHelper_Size Size object, can also be accessed like the traditional array from getimagesize |
|
1327 | - * @see ImageHelper_Size |
|
1328 | - * @throws ImageHelper_Exception |
|
1329 | - * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE |
|
1330 | - * @see ImageHelper::ERROR_CANNOT_READ_SVG_IMAGE |
|
1331 | - * @see ImageHelper::ERROR_SVG_SOURCE_VIEWBOX_MISSING |
|
1332 | - * @see ImageHelper::ERROR_SVG_VIEWBOX_INVALID |
|
1333 | - */ |
|
1334 | - public static function getImageSize($pathOrResource) : ImageHelper_Size |
|
1335 | - { |
|
1336 | - if(is_resource($pathOrResource)) |
|
1337 | - { |
|
1338 | - return new ImageHelper_Size(array( |
|
1339 | - 'width' => imagesx($pathOrResource), |
|
1340 | - 'height' => imagesy($pathOrResource), |
|
1341 | - 'channels' => 1, |
|
1342 | - 'bits' => 8 |
|
1343 | - )); |
|
1344 | - } |
|
1323 | + * </pre> |
|
1324 | + * |
|
1325 | + * @param string|resource $pathOrResource |
|
1326 | + * @return ImageHelper_Size Size object, can also be accessed like the traditional array from getimagesize |
|
1327 | + * @see ImageHelper_Size |
|
1328 | + * @throws ImageHelper_Exception |
|
1329 | + * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE |
|
1330 | + * @see ImageHelper::ERROR_CANNOT_READ_SVG_IMAGE |
|
1331 | + * @see ImageHelper::ERROR_SVG_SOURCE_VIEWBOX_MISSING |
|
1332 | + * @see ImageHelper::ERROR_SVG_VIEWBOX_INVALID |
|
1333 | + */ |
|
1334 | + public static function getImageSize($pathOrResource) : ImageHelper_Size |
|
1335 | + { |
|
1336 | + if(is_resource($pathOrResource)) |
|
1337 | + { |
|
1338 | + return new ImageHelper_Size(array( |
|
1339 | + 'width' => imagesx($pathOrResource), |
|
1340 | + 'height' => imagesy($pathOrResource), |
|
1341 | + 'channels' => 1, |
|
1342 | + 'bits' => 8 |
|
1343 | + )); |
|
1344 | + } |
|
1345 | 1345 | |
1346 | - $type = self::getFileImageType($pathOrResource); |
|
1346 | + $type = self::getFileImageType($pathOrResource); |
|
1347 | 1347 | |
1348 | - $info = false; |
|
1349 | - $method = 'getImageSize_'.$type; |
|
1350 | - if(method_exists(__CLASS__, $method)) |
|
1351 | - { |
|
1352 | - $info = call_user_func(array(__CLASS__, $method), $pathOrResource); |
|
1353 | - } |
|
1354 | - else |
|
1355 | - { |
|
1356 | - $info = getimagesize($pathOrResource); |
|
1357 | - } |
|
1348 | + $info = false; |
|
1349 | + $method = 'getImageSize_'.$type; |
|
1350 | + if(method_exists(__CLASS__, $method)) |
|
1351 | + { |
|
1352 | + $info = call_user_func(array(__CLASS__, $method), $pathOrResource); |
|
1353 | + } |
|
1354 | + else |
|
1355 | + { |
|
1356 | + $info = getimagesize($pathOrResource); |
|
1357 | + } |
|
1358 | 1358 | |
1359 | - if($info !== false) { |
|
1360 | - return new ImageHelper_Size($info); |
|
1361 | - } |
|
1359 | + if($info !== false) { |
|
1360 | + return new ImageHelper_Size($info); |
|
1361 | + } |
|
1362 | 1362 | |
1363 | 1363 | throw new ImageHelper_Exception( |
1364 | 1364 | 'Error opening image file', |
@@ -1368,98 +1368,98 @@ discard block |
||
1368 | 1368 | ), |
1369 | 1369 | self::ERROR_CANNOT_GET_IMAGE_SIZE |
1370 | 1370 | ); |
1371 | - } |
|
1371 | + } |
|
1372 | 1372 | |
1373 | - /** |
|
1374 | - * @param string $imagePath |
|
1375 | - * @throws ImageHelper_Exception |
|
1376 | - * @return array |
|
1377 | - * |
|
1378 | - * @todo This should return a ImageHelper_Size instance. |
|
1379 | - */ |
|
1380 | - protected static function getImageSize_svg(string $imagePath) : array |
|
1381 | - { |
|
1382 | - $xml = XMLHelper::createSimplexml(); |
|
1383 | - $xml->loadFile($imagePath); |
|
1373 | + /** |
|
1374 | + * @param string $imagePath |
|
1375 | + * @throws ImageHelper_Exception |
|
1376 | + * @return array |
|
1377 | + * |
|
1378 | + * @todo This should return a ImageHelper_Size instance. |
|
1379 | + */ |
|
1380 | + protected static function getImageSize_svg(string $imagePath) : array |
|
1381 | + { |
|
1382 | + $xml = XMLHelper::createSimplexml(); |
|
1383 | + $xml->loadFile($imagePath); |
|
1384 | 1384 | |
1385 | - if($xml->hasErrors()) { |
|
1386 | - throw new ImageHelper_Exception( |
|
1387 | - 'Error opening SVG image', |
|
1388 | - sprintf( |
|
1389 | - 'The XML content of the image [%s] could not be parsed.', |
|
1390 | - $imagePath |
|
1385 | + if($xml->hasErrors()) { |
|
1386 | + throw new ImageHelper_Exception( |
|
1387 | + 'Error opening SVG image', |
|
1388 | + sprintf( |
|
1389 | + 'The XML content of the image [%s] could not be parsed.', |
|
1390 | + $imagePath |
|
1391 | 1391 | ), |
1392 | - self::ERROR_CANNOT_READ_SVG_IMAGE |
|
1392 | + self::ERROR_CANNOT_READ_SVG_IMAGE |
|
1393 | 1393 | ); |
1394 | - } |
|
1394 | + } |
|
1395 | 1395 | |
1396 | - $data = $xml->toArray(); |
|
1397 | - $xml->dispose(); |
|
1398 | - unset($xml); |
|
1396 | + $data = $xml->toArray(); |
|
1397 | + $xml->dispose(); |
|
1398 | + unset($xml); |
|
1399 | 1399 | |
1400 | - if(!isset($data['@attributes']) || !isset($data['@attributes']['viewBox'])) { |
|
1401 | - throw new ImageHelper_Exception( |
|
1402 | - 'SVG Image is corrupted', |
|
1403 | - sprintf( |
|
1404 | - 'The [viewBox] attribute is missing in the XML of the image at path [%s].', |
|
1405 | - $imagePath |
|
1400 | + if(!isset($data['@attributes']) || !isset($data['@attributes']['viewBox'])) { |
|
1401 | + throw new ImageHelper_Exception( |
|
1402 | + 'SVG Image is corrupted', |
|
1403 | + sprintf( |
|
1404 | + 'The [viewBox] attribute is missing in the XML of the image at path [%s].', |
|
1405 | + $imagePath |
|
1406 | 1406 | ), |
1407 | - self::ERROR_SVG_SOURCE_VIEWBOX_MISSING |
|
1407 | + self::ERROR_SVG_SOURCE_VIEWBOX_MISSING |
|
1408 | 1408 | ); |
1409 | - } |
|
1409 | + } |
|
1410 | 1410 | |
1411 | - $svgWidth = parseNumber($data['@attributes']['width'])->getNumber(); |
|
1412 | - $svgHeight = parseNumber($data['@attributes']['height'])->getNumber(); |
|
1411 | + $svgWidth = parseNumber($data['@attributes']['width'])->getNumber(); |
|
1412 | + $svgHeight = parseNumber($data['@attributes']['height'])->getNumber(); |
|
1413 | 1413 | |
1414 | - $viewBox = str_replace(' ', ',', $data['@attributes']['viewBox']); |
|
1415 | - $size = explode(',', $viewBox); |
|
1414 | + $viewBox = str_replace(' ', ',', $data['@attributes']['viewBox']); |
|
1415 | + $size = explode(',', $viewBox); |
|
1416 | 1416 | |
1417 | - if(count($size) != 4) |
|
1418 | - { |
|
1419 | - throw new ImageHelper_Exception( |
|
1420 | - 'SVG image has an invalid viewBox attribute', |
|
1421 | - sprintf( |
|
1422 | - 'The [viewBox] attribute does not have an expected value: [%s] in path [%s].', |
|
1423 | - $viewBox, |
|
1424 | - $imagePath |
|
1417 | + if(count($size) != 4) |
|
1418 | + { |
|
1419 | + throw new ImageHelper_Exception( |
|
1420 | + 'SVG image has an invalid viewBox attribute', |
|
1421 | + sprintf( |
|
1422 | + 'The [viewBox] attribute does not have an expected value: [%s] in path [%s].', |
|
1423 | + $viewBox, |
|
1424 | + $imagePath |
|
1425 | 1425 | ), |
1426 | - self::ERROR_SVG_VIEWBOX_INVALID |
|
1426 | + self::ERROR_SVG_VIEWBOX_INVALID |
|
1427 | 1427 | ); |
1428 | - } |
|
1428 | + } |
|
1429 | 1429 | |
1430 | - $boxWidth = $size[2]; |
|
1431 | - $boxHeight = $size[3]; |
|
1430 | + $boxWidth = $size[2]; |
|
1431 | + $boxHeight = $size[3]; |
|
1432 | 1432 | |
1433 | - // calculate the x and y units of the document: |
|
1434 | - // @see http://tutorials.jenkov.com/svg/svg-viewport-view-box.html#viewbox |
|
1435 | - // |
|
1436 | - // The viewbox combined with the width and heigt of the svg |
|
1437 | - // allow calculating how many pixels are in one unit of the |
|
1438 | - // width and height of the document. |
|
1433 | + // calculate the x and y units of the document: |
|
1434 | + // @see http://tutorials.jenkov.com/svg/svg-viewport-view-box.html#viewbox |
|
1435 | + // |
|
1436 | + // The viewbox combined with the width and heigt of the svg |
|
1437 | + // allow calculating how many pixels are in one unit of the |
|
1438 | + // width and height of the document. |
|
1439 | 1439 | // |
1440 | - $xUnits = $svgWidth / $boxWidth; |
|
1441 | - $yUnits = $svgHeight / $boxHeight; |
|
1440 | + $xUnits = $svgWidth / $boxWidth; |
|
1441 | + $yUnits = $svgHeight / $boxHeight; |
|
1442 | 1442 | |
1443 | - $pxWidth = $xUnits * $svgWidth; |
|
1444 | - $pxHeight = $yUnits * $svgHeight; |
|
1443 | + $pxWidth = $xUnits * $svgWidth; |
|
1444 | + $pxHeight = $yUnits * $svgHeight; |
|
1445 | 1445 | |
1446 | - return array( |
|
1447 | - $pxWidth, |
|
1448 | - $pxHeight, |
|
1449 | - 'bits' => 8 |
|
1450 | - ); |
|
1451 | - } |
|
1446 | + return array( |
|
1447 | + $pxWidth, |
|
1448 | + $pxHeight, |
|
1449 | + 'bits' => 8 |
|
1450 | + ); |
|
1451 | + } |
|
1452 | 1452 | |
1453 | - /** |
|
1454 | - * Crops the image to the specified width and height, optionally |
|
1455 | - * specifying the origin position to crop from. |
|
1456 | - * |
|
1457 | - * @param integer $width |
|
1458 | - * @param integer $height |
|
1459 | - * @param integer $x |
|
1460 | - * @param integer $y |
|
1461 | - * @return ImageHelper |
|
1462 | - */ |
|
1453 | + /** |
|
1454 | + * Crops the image to the specified width and height, optionally |
|
1455 | + * specifying the origin position to crop from. |
|
1456 | + * |
|
1457 | + * @param integer $width |
|
1458 | + * @param integer $height |
|
1459 | + * @param integer $x |
|
1460 | + * @param integer $y |
|
1461 | + * @return ImageHelper |
|
1462 | + */ |
|
1463 | 1463 | public function crop(int $width, int $height, int $x=0, int $y=0) : ImageHelper |
1464 | 1464 | { |
1465 | 1465 | $new = $this->createNewImage($width, $height); |
@@ -1481,22 +1481,22 @@ discard block |
||
1481 | 1481 | return $this->newHeight; |
1482 | 1482 | } |
1483 | 1483 | |
1484 | - /** |
|
1485 | - * Calculates the average color value used in |
|
1486 | - * the image. Returns an associative array |
|
1487 | - * with the red, green, blue and alpha components, |
|
1488 | - * or a HEX color string depending on the selected |
|
1489 | - * format. |
|
1490 | - * |
|
1491 | - * NOTE: Use the calcAverageColorXXX methods for |
|
1492 | - * strict return types. |
|
1493 | - * |
|
1494 | - * @param int $format The format in which to return the color value. |
|
1495 | - * @return array|string |
|
1496 | - * |
|
1497 | - * @see ImageHelper::calcAverageColorRGB() |
|
1498 | - * @see ImageHelper::calcAverageColorHEX() |
|
1499 | - */ |
|
1484 | + /** |
|
1485 | + * Calculates the average color value used in |
|
1486 | + * the image. Returns an associative array |
|
1487 | + * with the red, green, blue and alpha components, |
|
1488 | + * or a HEX color string depending on the selected |
|
1489 | + * format. |
|
1490 | + * |
|
1491 | + * NOTE: Use the calcAverageColorXXX methods for |
|
1492 | + * strict return types. |
|
1493 | + * |
|
1494 | + * @param int $format The format in which to return the color value. |
|
1495 | + * @return array|string |
|
1496 | + * |
|
1497 | + * @see ImageHelper::calcAverageColorRGB() |
|
1498 | + * @see ImageHelper::calcAverageColorHEX() |
|
1499 | + */ |
|
1500 | 1500 | public function calcAverageColor(int $format=self::COLORFORMAT_RGB) |
1501 | 1501 | { |
1502 | 1502 | $image = $this->duplicate(); |
@@ -1505,35 +1505,35 @@ discard block |
||
1505 | 1505 | return $image->getColorAt(0, 0, $format); |
1506 | 1506 | } |
1507 | 1507 | |
1508 | - /** |
|
1509 | - * Calculates the image's average color value, and |
|
1510 | - * returns an associative array with red, green, |
|
1511 | - * blue and alpha keys. |
|
1512 | - * |
|
1513 | - * @throws ImageHelper_Exception |
|
1514 | - * @return array |
|
1515 | - */ |
|
1508 | + /** |
|
1509 | + * Calculates the image's average color value, and |
|
1510 | + * returns an associative array with red, green, |
|
1511 | + * blue and alpha keys. |
|
1512 | + * |
|
1513 | + * @throws ImageHelper_Exception |
|
1514 | + * @return array |
|
1515 | + */ |
|
1516 | 1516 | public function calcAverageColorRGB() : array |
1517 | 1517 | { |
1518 | - $result = $this->calcAverageColor(self::COLORFORMAT_RGB); |
|
1519 | - if(is_array($result)) { |
|
1520 | - return $result; |
|
1521 | - } |
|
1518 | + $result = $this->calcAverageColor(self::COLORFORMAT_RGB); |
|
1519 | + if(is_array($result)) { |
|
1520 | + return $result; |
|
1521 | + } |
|
1522 | 1522 | |
1523 | - throw new ImageHelper_Exception( |
|
1524 | - 'Unexpected color value', |
|
1525 | - sprintf('Expected an array, got [%s].', gettype($result)), |
|
1526 | - self::ERROR_UNEXPECTED_COLOR_VALUE |
|
1527 | - ); |
|
1528 | - } |
|
1529 | - |
|
1530 | - /** |
|
1531 | - * Calculates the image's average color value, and |
|
1532 | - * returns a hex color string (without the #). |
|
1533 | - * |
|
1534 | - * @throws ImageHelper_Exception |
|
1535 | - * @return string |
|
1536 | - */ |
|
1523 | + throw new ImageHelper_Exception( |
|
1524 | + 'Unexpected color value', |
|
1525 | + sprintf('Expected an array, got [%s].', gettype($result)), |
|
1526 | + self::ERROR_UNEXPECTED_COLOR_VALUE |
|
1527 | + ); |
|
1528 | + } |
|
1529 | + |
|
1530 | + /** |
|
1531 | + * Calculates the image's average color value, and |
|
1532 | + * returns a hex color string (without the #). |
|
1533 | + * |
|
1534 | + * @throws ImageHelper_Exception |
|
1535 | + * @return string |
|
1536 | + */ |
|
1537 | 1537 | public function calcAverageColorHex() : string |
1538 | 1538 | { |
1539 | 1539 | $result = $this->calcAverageColor(self::COLORFORMAT_HEX); |
@@ -1562,18 +1562,18 @@ discard block |
||
1562 | 1562 | |
1563 | 1563 | const COLORFORMAT_HEX = 2; |
1564 | 1564 | |
1565 | - /** |
|
1566 | - * Retrieves the color value at the specified pixel |
|
1567 | - * coordinates in the image. |
|
1568 | - * |
|
1569 | - * @param int $x |
|
1570 | - * @param int $y |
|
1571 | - * @param int $format The format in which to return the color value. |
|
1572 | - * @return array|string |
|
1573 | - * |
|
1574 | - * @see ImageHelper::COLORFORMAT_RGB |
|
1575 | - * @see ImageHelper::COLORFORMAT_HEX |
|
1576 | - */ |
|
1565 | + /** |
|
1566 | + * Retrieves the color value at the specified pixel |
|
1567 | + * coordinates in the image. |
|
1568 | + * |
|
1569 | + * @param int $x |
|
1570 | + * @param int $y |
|
1571 | + * @param int $format The format in which to return the color value. |
|
1572 | + * @return array|string |
|
1573 | + * |
|
1574 | + * @see ImageHelper::COLORFORMAT_RGB |
|
1575 | + * @see ImageHelper::COLORFORMAT_HEX |
|
1576 | + */ |
|
1577 | 1577 | public function getColorAt(int $x, int $y, int $format=self::COLORFORMAT_RGB) |
1578 | 1578 | { |
1579 | 1579 | if($x > $this->getWidth() || $y > $this->getHeight()) |
@@ -1601,21 +1601,21 @@ discard block |
||
1601 | 1601 | return $rgb; |
1602 | 1602 | } |
1603 | 1603 | |
1604 | - /** |
|
1605 | - * Converts an RGB value to its luminance equivalent. |
|
1606 | - * |
|
1607 | - * @param array $rgb |
|
1608 | - * @return integer Integer, from 0 to 255 (0=black, 255=white) |
|
1609 | - */ |
|
1604 | + /** |
|
1605 | + * Converts an RGB value to its luminance equivalent. |
|
1606 | + * |
|
1607 | + * @param array $rgb |
|
1608 | + * @return integer Integer, from 0 to 255 (0=black, 255=white) |
|
1609 | + */ |
|
1610 | 1610 | public static function rgb2luma(array $rgb) : int |
1611 | 1611 | { |
1612 | 1612 | return (int)floor((($rgb['red']*2)+$rgb['blue']+($rgb['green']*3))/6); |
1613 | 1613 | } |
1614 | 1614 | |
1615 | - /** |
|
1616 | - * Retrieves the brightness of the image, in percent. |
|
1617 | - * @return number |
|
1618 | - */ |
|
1615 | + /** |
|
1616 | + * Retrieves the brightness of the image, in percent. |
|
1617 | + * @return number |
|
1618 | + */ |
|
1619 | 1619 | public function getBrightness() |
1620 | 1620 | { |
1621 | 1621 | $luma = self::rgb2luma($this->calcAverageColorRGB()); |
@@ -1623,15 +1623,15 @@ discard block |
||
1623 | 1623 | return $percent; |
1624 | 1624 | } |
1625 | 1625 | |
1626 | - /** |
|
1627 | - * Retrieves an md5 hash of the source image file. |
|
1628 | - * |
|
1629 | - * NOTE: Only works when the helper has been created |
|
1630 | - * from a file. Otherwise an exception is thrown. |
|
1631 | - * |
|
1632 | - * @return string |
|
1633 | - * @throws ImageHelper_Exception |
|
1634 | - */ |
|
1626 | + /** |
|
1627 | + * Retrieves an md5 hash of the source image file. |
|
1628 | + * |
|
1629 | + * NOTE: Only works when the helper has been created |
|
1630 | + * from a file. Otherwise an exception is thrown. |
|
1631 | + * |
|
1632 | + * @return string |
|
1633 | + * @throws ImageHelper_Exception |
|
1634 | + */ |
|
1635 | 1635 | public function getHash() |
1636 | 1636 | { |
1637 | 1637 | ob_start(); |
@@ -4,37 +4,37 @@ discard block |
||
4 | 4 | |
5 | 5 | class SVNHelper_CommandResult |
6 | 6 | { |
7 | - /** |
|
8 | - * @var SVNHelper_Command |
|
9 | - */ |
|
7 | + /** |
|
8 | + * @var SVNHelper_Command |
|
9 | + */ |
|
10 | 10 | protected $command; |
11 | 11 | |
12 | - /** |
|
13 | - * @var string[] |
|
14 | - */ |
|
12 | + /** |
|
13 | + * @var string[] |
|
14 | + */ |
|
15 | 15 | protected $output; |
16 | 16 | |
17 | - /** |
|
18 | - * @var SVNHelper_CommandError[] |
|
19 | - */ |
|
17 | + /** |
|
18 | + * @var SVNHelper_CommandError[] |
|
19 | + */ |
|
20 | 20 | protected $errors = array(); |
21 | 21 | |
22 | - /** |
|
23 | - * @var SVNHelper_CommandError[] |
|
24 | - */ |
|
22 | + /** |
|
23 | + * @var SVNHelper_CommandError[] |
|
24 | + */ |
|
25 | 25 | protected $warnings = array(); |
26 | 26 | |
27 | - /** |
|
28 | - * The actual command that has been executed |
|
29 | - * @var string |
|
30 | - */ |
|
27 | + /** |
|
28 | + * The actual command that has been executed |
|
29 | + * @var string |
|
30 | + */ |
|
31 | 31 | protected $commandLine; |
32 | 32 | |
33 | - /** |
|
34 | - * @param SVNHelper_Command $command |
|
35 | - * @param string[] $output |
|
36 | - * @param SVNHelper_CommandError[] $errors |
|
37 | - */ |
|
33 | + /** |
|
34 | + * @param SVNHelper_Command $command |
|
35 | + * @param string[] $output |
|
36 | + * @param SVNHelper_CommandError[] $errors |
|
37 | + */ |
|
38 | 38 | public function __construct(SVNHelper_Command $command, $commandLine, $output, $errors) |
39 | 39 | { |
40 | 40 | $this->command = $command; |
@@ -86,12 +86,12 @@ discard block |
||
86 | 86 | return $this->command; |
87 | 87 | } |
88 | 88 | |
89 | - /** |
|
90 | - * Retrieves all error messages. |
|
91 | - * |
|
92 | - * @param bool $asString |
|
93 | - * @return string|string[] |
|
94 | - */ |
|
89 | + /** |
|
90 | + * Retrieves all error messages. |
|
91 | + * |
|
92 | + * @param bool $asString |
|
93 | + * @return string|string[] |
|
94 | + */ |
|
95 | 95 | public function getErrorMessages(bool $asString=false) |
96 | 96 | { |
97 | 97 | if($asString) { |
@@ -38,24 +38,24 @@ discard block |
||
38 | 38 | */ |
39 | 39 | class NumberInfo |
40 | 40 | { |
41 | - /** |
|
42 | - * @var mixed |
|
43 | - */ |
|
41 | + /** |
|
42 | + * @var mixed |
|
43 | + */ |
|
44 | 44 | protected $rawValue; |
45 | 45 | |
46 | - /** |
|
47 | - * @var array |
|
48 | - */ |
|
46 | + /** |
|
47 | + * @var array |
|
48 | + */ |
|
49 | 49 | protected $info; |
50 | 50 | |
51 | - /** |
|
52 | - * @var bool |
|
53 | - */ |
|
51 | + /** |
|
52 | + * @var bool |
|
53 | + */ |
|
54 | 54 | protected $empty = false; |
55 | 55 | |
56 | - /** |
|
57 | - * @var array |
|
58 | - */ |
|
56 | + /** |
|
57 | + * @var array |
|
58 | + */ |
|
59 | 59 | protected $knownUnits = array( |
60 | 60 | '%' => true, |
61 | 61 | 'rem' => true, |
@@ -95,21 +95,21 @@ discard block |
||
95 | 95 | return $this; |
96 | 96 | } |
97 | 97 | |
98 | - /** |
|
99 | - * Retrieves the raw, internal information array resulting |
|
100 | - * from the parsing of the number. |
|
101 | - * |
|
102 | - * @return array |
|
103 | - */ |
|
98 | + /** |
|
99 | + * Retrieves the raw, internal information array resulting |
|
100 | + * from the parsing of the number. |
|
101 | + * |
|
102 | + * @return array |
|
103 | + */ |
|
104 | 104 | public function getRawInfo() : array |
105 | 105 | { |
106 | 106 | return $this->info; |
107 | 107 | } |
108 | 108 | |
109 | - /** |
|
110 | - * Whether the number was empty (null or empty string). |
|
111 | - * @return boolean |
|
112 | - */ |
|
109 | + /** |
|
110 | + * Whether the number was empty (null or empty string). |
|
111 | + * @return boolean |
|
112 | + */ |
|
113 | 113 | public function isEmpty() : bool |
114 | 114 | { |
115 | 115 | return $this->empty; |
@@ -532,12 +532,12 @@ discard block |
||
532 | 532 | return $cache[$key]; |
533 | 533 | } |
534 | 534 | |
535 | - /** |
|
536 | - * Parses a string number notation with units included, e.g. 14px, 50%... |
|
537 | - * |
|
538 | - * @param string $test |
|
539 | - * @return array |
|
540 | - */ |
|
535 | + /** |
|
536 | + * Parses a string number notation with units included, e.g. 14px, 50%... |
|
537 | + * |
|
538 | + * @param string $test |
|
539 | + * @return array |
|
540 | + */ |
|
541 | 541 | private function parseStringValue(string $test) : array |
542 | 542 | { |
543 | 543 | $number = null; |
@@ -588,13 +588,13 @@ discard block |
||
588 | 588 | return $this->filterInfo($result); |
589 | 589 | } |
590 | 590 | |
591 | - /** |
|
592 | - * Attempts to determine what kind of units are specified |
|
593 | - * in the string. Returns NULL if none could be matched. |
|
594 | - * |
|
595 | - * @param string $value |
|
596 | - * @return array|NULL |
|
597 | - */ |
|
591 | + /** |
|
592 | + * Attempts to determine what kind of units are specified |
|
593 | + * in the string. Returns NULL if none could be matched. |
|
594 | + * |
|
595 | + * @param string $value |
|
596 | + * @return array|NULL |
|
597 | + */ |
|
598 | 598 | private function findUnits(string $value) : ?array |
599 | 599 | { |
600 | 600 | $vlength = strlen($value); |
@@ -622,12 +622,12 @@ discard block |
||
622 | 622 | return null; |
623 | 623 | } |
624 | 624 | |
625 | - /** |
|
626 | - * Creates the cache key for the specified value. |
|
627 | - * |
|
628 | - * @param mixed $value |
|
629 | - * @return string |
|
630 | - */ |
|
625 | + /** |
|
626 | + * Creates the cache key for the specified value. |
|
627 | + * |
|
628 | + * @param mixed $value |
|
629 | + * @return string |
|
630 | + */ |
|
631 | 631 | private function createValueKey($value) : string |
632 | 632 | { |
633 | 633 | if(!is_string($value) && !is_numeric($value)) |
@@ -640,59 +640,59 @@ discard block |
||
640 | 640 | |
641 | 641 | protected $postProcess = false; |
642 | 642 | |
643 | - /** |
|
644 | - * Called if explicitly enabled: allows filtering the |
|
645 | - * number after the detection process has completed. |
|
646 | - * |
|
647 | - * @param string|NULL $number The adjusted number |
|
648 | - * @param string $originalString The original value before it was parsed |
|
649 | - * @return mixed |
|
650 | - */ |
|
643 | + /** |
|
644 | + * Called if explicitly enabled: allows filtering the |
|
645 | + * number after the detection process has completed. |
|
646 | + * |
|
647 | + * @param string|NULL $number The adjusted number |
|
648 | + * @param string $originalString The original value before it was parsed |
|
649 | + * @return mixed |
|
650 | + */ |
|
651 | 651 | protected function postProcess(?string $number, /** @scrutinizer ignore-unused */ string $originalString) |
652 | 652 | { |
653 | 653 | return $number; |
654 | 654 | } |
655 | 655 | |
656 | - /** |
|
657 | - * Filters the value before it is parsed, but only if it is a string. |
|
658 | - * |
|
659 | - * NOTE: This may be overwritten in a subclass, to allow custom filtering |
|
660 | - * the the values. An example of a use case would be a preprocessor for |
|
661 | - * variables in a templating system. |
|
662 | - * |
|
663 | - * @param string $trimmedString The trimmed value. |
|
664 | - * @param array $cache The internal values cache array. |
|
665 | - * @param string $originalValue The original value that the NumberInfo was created for. |
|
666 | - * @return string |
|
667 | - * |
|
668 | - * @see NumberInfo::enablePostProcess() |
|
669 | - */ |
|
656 | + /** |
|
657 | + * Filters the value before it is parsed, but only if it is a string. |
|
658 | + * |
|
659 | + * NOTE: This may be overwritten in a subclass, to allow custom filtering |
|
660 | + * the the values. An example of a use case would be a preprocessor for |
|
661 | + * variables in a templating system. |
|
662 | + * |
|
663 | + * @param string $trimmedString The trimmed value. |
|
664 | + * @param array $cache The internal values cache array. |
|
665 | + * @param string $originalValue The original value that the NumberInfo was created for. |
|
666 | + * @return string |
|
667 | + * |
|
668 | + * @see NumberInfo::enablePostProcess() |
|
669 | + */ |
|
670 | 670 | protected function preProcess(string $trimmedString, /** @scrutinizer ignore-unused */ array &$cache, /** @scrutinizer ignore-unused */ string $originalValue) : string |
671 | 671 | { |
672 | 672 | return str_replace(',', '.', $trimmedString); |
673 | 673 | } |
674 | 674 | |
675 | - /** |
|
676 | - * Enables the post processing so the postProcess method gets called. |
|
677 | - * This should be called in the {@link NumberInfo::preProcess()} |
|
678 | - * method as needed. |
|
679 | - * |
|
680 | - * @return NumberInfo |
|
681 | - * @see NumberInfo::postProcess() |
|
682 | - */ |
|
675 | + /** |
|
676 | + * Enables the post processing so the postProcess method gets called. |
|
677 | + * This should be called in the {@link NumberInfo::preProcess()} |
|
678 | + * method as needed. |
|
679 | + * |
|
680 | + * @return NumberInfo |
|
681 | + * @see NumberInfo::postProcess() |
|
682 | + */ |
|
683 | 683 | private function enablePostProcess() : NumberInfo |
684 | 684 | { |
685 | 685 | $this->postProcess = true; |
686 | 686 | return $this; |
687 | 687 | } |
688 | 688 | |
689 | - /** |
|
690 | - * Filters the number info array to adjust the units |
|
691 | - * and number according to the required rules. |
|
692 | - * |
|
693 | - * @param array $info |
|
694 | - * @return array |
|
695 | - */ |
|
689 | + /** |
|
690 | + * Filters the number info array to adjust the units |
|
691 | + * and number according to the required rules. |
|
692 | + * |
|
693 | + * @param array $info |
|
694 | + * @return array |
|
695 | + */ |
|
696 | 696 | protected function filterInfo(array $info) : array |
697 | 697 | { |
698 | 698 | $useUnits = 'px'; |
@@ -23,9 +23,9 @@ discard block |
||
23 | 23 | */ |
24 | 24 | class ConvertHelper_ByteConverter |
25 | 25 | { |
26 | - /** |
|
27 | - * @var int |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var int |
|
28 | + */ |
|
29 | 29 | protected $bytes; |
30 | 30 | |
31 | 31 | public function __construct(int $bytes) |
@@ -39,12 +39,12 @@ discard block |
||
39 | 39 | } |
40 | 40 | } |
41 | 41 | |
42 | - /** |
|
43 | - * Detects the size matching the byte value for the specified base. |
|
44 | - * |
|
45 | - * @param int $base |
|
46 | - * @return ConvertHelper_StorageSizeEnum_Size |
|
47 | - */ |
|
42 | + /** |
|
43 | + * Detects the size matching the byte value for the specified base. |
|
44 | + * |
|
45 | + * @param int $base |
|
46 | + * @return ConvertHelper_StorageSizeEnum_Size |
|
47 | + */ |
|
48 | 48 | protected function detectSize(int $base) : ConvertHelper_StorageSizeEnum_Size |
49 | 49 | { |
50 | 50 | $sizes = $this->getSizesSorted($base); |
@@ -70,13 +70,13 @@ discard block |
||
70 | 70 | return ConvertHelper_StorageSizeEnum::getSizeByName('b'); |
71 | 71 | } |
72 | 72 | |
73 | - /** |
|
74 | - * Retrieves all storage sizes for the specified base, |
|
75 | - * sorted from smallest byte size to highest. |
|
76 | - * |
|
77 | - * @param int $base |
|
78 | - * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[] |
|
79 | - */ |
|
73 | + /** |
|
74 | + * Retrieves all storage sizes for the specified base, |
|
75 | + * sorted from smallest byte size to highest. |
|
76 | + * |
|
77 | + * @param int $base |
|
78 | + * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[] |
|
79 | + */ |
|
80 | 80 | protected function getSizesSorted(int $base) |
81 | 81 | { |
82 | 82 | $sizes = ConvertHelper_StorageSizeEnum::getSizesByBase($base); |
@@ -89,16 +89,16 @@ discard block |
||
89 | 89 | return $sizes; |
90 | 90 | } |
91 | 91 | |
92 | - /** |
|
93 | - * Converts the byte value to a human readable string, e.g. "5 KB", "140 MB". |
|
94 | - * |
|
95 | - * @param int $precision The amount of decimals (rounded up) |
|
96 | - * @param int $base The base to calculate bytes with. |
|
97 | - * @return string |
|
98 | - * |
|
99 | - * @see ConvertHelper_StorageSizeEnum::BASE_10 |
|
100 | - * @see ConvertHelper_StorageSizeEnum::BASE_2 |
|
101 | - */ |
|
92 | + /** |
|
93 | + * Converts the byte value to a human readable string, e.g. "5 KB", "140 MB". |
|
94 | + * |
|
95 | + * @param int $precision The amount of decimals (rounded up) |
|
96 | + * @param int $base The base to calculate bytes with. |
|
97 | + * @return string |
|
98 | + * |
|
99 | + * @see ConvertHelper_StorageSizeEnum::BASE_10 |
|
100 | + * @see ConvertHelper_StorageSizeEnum::BASE_2 |
|
101 | + */ |
|
102 | 102 | public function toString(int $precision, int $base=ConvertHelper_StorageSizeEnum::BASE_10) : string |
103 | 103 | { |
104 | 104 | $size = $this->detectSize($base); |
@@ -106,13 +106,13 @@ discard block |
||
106 | 106 | return round($this->bytes / $size->getBytes(), $precision) . ' ' . $size->getSuffix(); |
107 | 107 | } |
108 | 108 | |
109 | - /** |
|
110 | - * Converts the byte value to the amount of the corresponding units (KB, MB...). |
|
111 | - * |
|
112 | - * @param int $precision The amount of decimals (rounded up) |
|
113 | - * @param string $sizeName The lowercase storage size name (e.g. "kb", "kib") |
|
114 | - * @return float |
|
115 | - */ |
|
109 | + /** |
|
110 | + * Converts the byte value to the amount of the corresponding units (KB, MB...). |
|
111 | + * |
|
112 | + * @param int $precision The amount of decimals (rounded up) |
|
113 | + * @param string $sizeName The lowercase storage size name (e.g. "kb", "kib") |
|
114 | + * @return float |
|
115 | + */ |
|
116 | 116 | public function toNumber(int $precision, string $sizeName) : float |
117 | 117 | { |
118 | 118 | $size = ConvertHelper_StorageSizeEnum::getSizeByName($sizeName); |
@@ -120,56 +120,56 @@ discard block |
||
120 | 120 | return round($this->bytes / $size->getBytes(), $precision); |
121 | 121 | } |
122 | 122 | |
123 | - /** |
|
124 | - * Converts the bytes to Kilobytes. |
|
125 | - * |
|
126 | - * @param int $precision Amount of decimals (rounded up) |
|
127 | - * @return float |
|
128 | - */ |
|
123 | + /** |
|
124 | + * Converts the bytes to Kilobytes. |
|
125 | + * |
|
126 | + * @param int $precision Amount of decimals (rounded up) |
|
127 | + * @return float |
|
128 | + */ |
|
129 | 129 | public function toKilobytes(int $precision=1) : float |
130 | 130 | { |
131 | 131 | return $this->toNumber($precision, 'kb'); |
132 | 132 | } |
133 | 133 | |
134 | - /** |
|
135 | - * Converts the bytes to Megabytes. |
|
136 | - * |
|
137 | - * @param int $precision Amount of decimals (rounded up) |
|
138 | - * @return float |
|
139 | - */ |
|
134 | + /** |
|
135 | + * Converts the bytes to Megabytes. |
|
136 | + * |
|
137 | + * @param int $precision Amount of decimals (rounded up) |
|
138 | + * @return float |
|
139 | + */ |
|
140 | 140 | public function toMegabytes(int $precision=1) : float |
141 | 141 | { |
142 | 142 | return $this->toNumber($precision, 'mb'); |
143 | 143 | } |
144 | 144 | |
145 | - /** |
|
146 | - * Converts the bytes to Gigabytes. |
|
147 | - * |
|
148 | - * @param int $precision Amount of decimals (rounded up) |
|
149 | - * @return float |
|
150 | - */ |
|
145 | + /** |
|
146 | + * Converts the bytes to Gigabytes. |
|
147 | + * |
|
148 | + * @param int $precision Amount of decimals (rounded up) |
|
149 | + * @return float |
|
150 | + */ |
|
151 | 151 | public function toGigabytes(int $precision=1) : float |
152 | 152 | { |
153 | 153 | return $this->toNumber($precision, 'gb'); |
154 | 154 | } |
155 | 155 | |
156 | - /** |
|
157 | - * Converts the bytes to Terabytes. |
|
158 | - * |
|
159 | - * @param int $precision Amount of decimals (rounded up) |
|
160 | - * @return float |
|
161 | - */ |
|
156 | + /** |
|
157 | + * Converts the bytes to Terabytes. |
|
158 | + * |
|
159 | + * @param int $precision Amount of decimals (rounded up) |
|
160 | + * @return float |
|
161 | + */ |
|
162 | 162 | public function toTerabytes(int $precision=1) : float |
163 | 163 | { |
164 | 164 | return $this->toNumber($precision, 'tb'); |
165 | 165 | } |
166 | 166 | |
167 | - /** |
|
168 | - * Converts the bytes to Petabytes. |
|
169 | - * |
|
170 | - * @param int $precision Amount of decimals (rounded up) |
|
171 | - * @return float |
|
172 | - */ |
|
167 | + /** |
|
168 | + * Converts the bytes to Petabytes. |
|
169 | + * |
|
170 | + * @param int $precision Amount of decimals (rounded up) |
|
171 | + * @return float |
|
172 | + */ |
|
173 | 173 | public function toPetabytes(int $precision=1) : float |
174 | 174 | { |
175 | 175 | return $this->toNumber($precision, 'pb'); |
@@ -26,39 +26,39 @@ discard block |
||
26 | 26 | const ERROR_NO_DATE_FROM_SET = 43401; |
27 | 27 | |
28 | 28 | |
29 | - /** |
|
30 | - * @var int |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var int |
|
31 | + */ |
|
32 | 32 | protected $dateFrom; |
33 | 33 | |
34 | - /** |
|
35 | - * @var int |
|
36 | - */ |
|
34 | + /** |
|
35 | + * @var int |
|
36 | + */ |
|
37 | 37 | protected $dateTo; |
38 | 38 | |
39 | - /** |
|
40 | - * @var bool |
|
41 | - */ |
|
39 | + /** |
|
40 | + * @var bool |
|
41 | + */ |
|
42 | 42 | protected $future = false; |
43 | 43 | |
44 | - /** |
|
45 | - * @var string |
|
46 | - */ |
|
44 | + /** |
|
45 | + * @var string |
|
46 | + */ |
|
47 | 47 | protected $interval = ''; |
48 | 48 | |
49 | - /** |
|
50 | - * @var int |
|
51 | - */ |
|
49 | + /** |
|
50 | + * @var int |
|
51 | + */ |
|
52 | 52 | protected $difference = 0; |
53 | 53 | |
54 | - /** |
|
55 | - * @var int |
|
56 | - */ |
|
54 | + /** |
|
55 | + * @var int |
|
56 | + */ |
|
57 | 57 | protected $dateDiff = 0; |
58 | 58 | |
59 | - /** |
|
60 | - * @var array |
|
61 | - */ |
|
59 | + /** |
|
60 | + * @var array |
|
61 | + */ |
|
62 | 62 | protected static $texts; |
63 | 63 | |
64 | 64 | public function __construct() |
@@ -78,17 +78,17 @@ discard block |
||
78 | 78 | self::$texts = null; |
79 | 79 | } |
80 | 80 | |
81 | - /** |
|
82 | - * Sets the origin date to calculate from. |
|
83 | - * |
|
84 | - * NOTE: if this is further in the future than |
|
85 | - * the to: date, it will be considered as a |
|
86 | - * calculation for something to come, i.e. |
|
87 | - * "In two days". |
|
88 | - * |
|
89 | - * @param \DateTime $date |
|
90 | - * @return ConvertHelper_DurationConverter |
|
91 | - */ |
|
81 | + /** |
|
82 | + * Sets the origin date to calculate from. |
|
83 | + * |
|
84 | + * NOTE: if this is further in the future than |
|
85 | + * the to: date, it will be considered as a |
|
86 | + * calculation for something to come, i.e. |
|
87 | + * "In two days". |
|
88 | + * |
|
89 | + * @param \DateTime $date |
|
90 | + * @return ConvertHelper_DurationConverter |
|
91 | + */ |
|
92 | 92 | public function setDateFrom(\DateTime $date) : ConvertHelper_DurationConverter |
93 | 93 | { |
94 | 94 | $this->dateFrom = ConvertHelper::date2timestamp($date); |
@@ -96,13 +96,13 @@ discard block |
||
96 | 96 | return $this; |
97 | 97 | } |
98 | 98 | |
99 | - /** |
|
100 | - * Sets the date to calculate to. Defaults to |
|
101 | - * the current time if not set. |
|
102 | - * |
|
103 | - * @param \DateTime $date |
|
104 | - * @return ConvertHelper_DurationConverter |
|
105 | - */ |
|
99 | + /** |
|
100 | + * Sets the date to calculate to. Defaults to |
|
101 | + * the current time if not set. |
|
102 | + * |
|
103 | + * @param \DateTime $date |
|
104 | + * @return ConvertHelper_DurationConverter |
|
105 | + */ |
|
106 | 106 | public function setDateTo(\DateTime $date) : ConvertHelper_DurationConverter |
107 | 107 | { |
108 | 108 | $this->dateTo = ConvertHelper::date2timestamp($date); |
@@ -110,14 +110,14 @@ discard block |
||
110 | 110 | return $this; |
111 | 111 | } |
112 | 112 | |
113 | - /** |
|
114 | - * Converts the specified dates to a human readable string. |
|
115 | - * |
|
116 | - * @throws ConvertHelper_Exception |
|
117 | - * @return string |
|
118 | - * |
|
119 | - * @see ConvertHelper_DurationConverter::ERROR_NO_DATE_FROM_SET |
|
120 | - */ |
|
113 | + /** |
|
114 | + * Converts the specified dates to a human readable string. |
|
115 | + * |
|
116 | + * @throws ConvertHelper_Exception |
|
117 | + * @return string |
|
118 | + * |
|
119 | + * @see ConvertHelper_DurationConverter::ERROR_NO_DATE_FROM_SET |
|
120 | + */ |
|
121 | 121 | public function convert() : string |
122 | 122 | { |
123 | 123 | $this->initTexts(); |
@@ -25,34 +25,34 @@ |
||
25 | 25 | */ |
26 | 26 | class ConvertHelper_StorageSizeEnum_Size |
27 | 27 | { |
28 | - /** |
|
29 | - * @var string |
|
30 | - */ |
|
28 | + /** |
|
29 | + * @var string |
|
30 | + */ |
|
31 | 31 | protected $name; |
32 | 32 | |
33 | - /** |
|
34 | - * @var int |
|
35 | - */ |
|
33 | + /** |
|
34 | + * @var int |
|
35 | + */ |
|
36 | 36 | protected $base; |
37 | 37 | |
38 | - /** |
|
39 | - * @var int |
|
40 | - */ |
|
38 | + /** |
|
39 | + * @var int |
|
40 | + */ |
|
41 | 41 | protected $exponent; |
42 | 42 | |
43 | - /** |
|
44 | - * @var string |
|
45 | - */ |
|
43 | + /** |
|
44 | + * @var string |
|
45 | + */ |
|
46 | 46 | protected $singular; |
47 | 47 | |
48 | - /** |
|
49 | - * @var string |
|
50 | - */ |
|
48 | + /** |
|
49 | + * @var string |
|
50 | + */ |
|
51 | 51 | protected $plural; |
52 | 52 | |
53 | - /** |
|
54 | - * @var string |
|
55 | - */ |
|
53 | + /** |
|
54 | + * @var string |
|
55 | + */ |
|
56 | 56 | protected $suffix; |
57 | 57 | |
58 | 58 | public function __construct(string $name, int $base, int $exponent, string $suffix, string $singular, string $plural) |
@@ -17,21 +17,20 @@ discard block |
||
17 | 17 | * @package Application Utils |
18 | 18 | * @subpackage ConvertHelper |
19 | 19 | * @author Sebastian Mordziol <[email protected]> |
20 | - |
|
21 | 20 | * @see ConvertHelper::interval2string() |
22 | 21 | */ |
23 | 22 | class ConvertHelper_IntervalConverter |
24 | 23 | { |
25 | 24 | const ERROR_MISSING_TRANSLATION = 43501; |
26 | 25 | |
27 | - /** |
|
28 | - * @var array |
|
29 | - */ |
|
26 | + /** |
|
27 | + * @var array |
|
28 | + */ |
|
30 | 29 | protected static $texts; |
31 | 30 | |
32 | - /** |
|
33 | - * @var array |
|
34 | - */ |
|
31 | + /** |
|
32 | + * @var array |
|
33 | + */ |
|
35 | 34 | protected $tokens = array('y', 'm', 'd', 'h', 'i', 's'); |
36 | 35 | |
37 | 36 | public function __construct() |
@@ -41,25 +40,25 @@ discard block |
||
41 | 40 | } |
42 | 41 | } |
43 | 42 | |
44 | - /** |
|
45 | - * Called whenever the application locale has changed, |
|
46 | - * to reset the internal translation cache. |
|
47 | - */ |
|
43 | + /** |
|
44 | + * Called whenever the application locale has changed, |
|
45 | + * to reset the internal translation cache. |
|
46 | + */ |
|
48 | 47 | public function handle_localeChanged() |
49 | 48 | { |
50 | 49 | self::$texts = null; |
51 | 50 | } |
52 | 51 | |
53 | - /** |
|
54 | - * Converts the specified interval to a human readable |
|
55 | - * string, e.g. "2 hours and 4 minutes". |
|
56 | - * |
|
57 | - * @param \DateInterval $interval |
|
58 | - * @return string |
|
59 | - * @throws ConvertHelper_Exception |
|
60 | - * |
|
61 | - * @see ConvertHelper_IntervalConverter::ERROR_MISSING_TRANSLATION |
|
62 | - */ |
|
52 | + /** |
|
53 | + * Converts the specified interval to a human readable |
|
54 | + * string, e.g. "2 hours and 4 minutes". |
|
55 | + * |
|
56 | + * @param \DateInterval $interval |
|
57 | + * @return string |
|
58 | + * @throws ConvertHelper_Exception |
|
59 | + * |
|
60 | + * @see ConvertHelper_IntervalConverter::ERROR_MISSING_TRANSLATION |
|
61 | + */ |
|
63 | 62 | public function toString(\DateInterval $interval) : string |
64 | 63 | { |
65 | 64 | $this->initTexts(); |
@@ -88,14 +87,14 @@ discard block |
||
88 | 87 | return t('%1$s and %2$s', implode(', ', $parts), $last); |
89 | 88 | } |
90 | 89 | |
91 | - /** |
|
92 | - * Translates the selected time token, e.g. "y" (for year). |
|
93 | - * |
|
94 | - * @param string $token |
|
95 | - * @param ConvertHelper_DateInterval $interval |
|
96 | - * @throws ConvertHelper_Exception |
|
97 | - * @return string |
|
98 | - */ |
|
90 | + /** |
|
91 | + * Translates the selected time token, e.g. "y" (for year). |
|
92 | + * |
|
93 | + * @param string $token |
|
94 | + * @param ConvertHelper_DateInterval $interval |
|
95 | + * @throws ConvertHelper_Exception |
|
96 | + * @return string |
|
97 | + */ |
|
99 | 98 | protected function translateToken(string $token, ConvertHelper_DateInterval $interval) : string |
100 | 99 | { |
101 | 100 | $value = $interval->getToken($token); |
@@ -123,13 +122,13 @@ discard block |
||
123 | 122 | ); |
124 | 123 | } |
125 | 124 | |
126 | - /** |
|
127 | - * Resolves all time tokens that need to be translated in |
|
128 | - * the subject interval, depending on its length. |
|
129 | - * |
|
130 | - * @param ConvertHelper_DateInterval $interval |
|
131 | - * @return array |
|
132 | - */ |
|
125 | + /** |
|
126 | + * Resolves all time tokens that need to be translated in |
|
127 | + * the subject interval, depending on its length. |
|
128 | + * |
|
129 | + * @param ConvertHelper_DateInterval $interval |
|
130 | + * @return array |
|
131 | + */ |
|
133 | 132 | protected function resolveTokens(ConvertHelper_DateInterval $interval) : array |
134 | 133 | { |
135 | 134 | $offset = 0; |
@@ -147,9 +146,9 @@ discard block |
||
147 | 146 | return array(); |
148 | 147 | } |
149 | 148 | |
150 | - /** |
|
151 | - * Initializes the translateable strings. |
|
152 | - */ |
|
149 | + /** |
|
150 | + * Initializes the translateable strings. |
|
151 | + */ |
|
153 | 152 | protected function initTexts() : void |
154 | 153 | { |
155 | 154 | if(isset(self::$texts)) { |
@@ -160,41 +160,41 @@ discard block |
||
160 | 160 | return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last; |
161 | 161 | } |
162 | 162 | |
163 | - /** |
|
164 | - * Converts a timestamp into an easily understandable |
|
165 | - * format, e.g. "2 hours", "1 day", "3 months" |
|
166 | - * |
|
167 | - * If you set the date to parameter, the difference |
|
168 | - * will be calculated between the two dates and not |
|
169 | - * the current time. |
|
170 | - * |
|
171 | - * @param integer|\DateTime $datefrom |
|
172 | - * @param integer|\DateTime $dateto |
|
173 | - * @return string |
|
174 | - */ |
|
163 | + /** |
|
164 | + * Converts a timestamp into an easily understandable |
|
165 | + * format, e.g. "2 hours", "1 day", "3 months" |
|
166 | + * |
|
167 | + * If you set the date to parameter, the difference |
|
168 | + * will be calculated between the two dates and not |
|
169 | + * the current time. |
|
170 | + * |
|
171 | + * @param integer|\DateTime $datefrom |
|
172 | + * @param integer|\DateTime $dateto |
|
173 | + * @return string |
|
174 | + */ |
|
175 | 175 | public static function duration2string($datefrom, $dateto = -1) : string |
176 | 176 | { |
177 | - $converter = new ConvertHelper_DurationConverter(); |
|
177 | + $converter = new ConvertHelper_DurationConverter(); |
|
178 | 178 | |
179 | - if($datefrom instanceof \DateTime) |
|
180 | - { |
|
181 | - $converter->setDateFrom($datefrom); |
|
182 | - } |
|
183 | - else |
|
184 | - { |
|
185 | - $converter->setDateFrom(self::timestamp2date($datefrom)); |
|
186 | - } |
|
179 | + if($datefrom instanceof \DateTime) |
|
180 | + { |
|
181 | + $converter->setDateFrom($datefrom); |
|
182 | + } |
|
183 | + else |
|
184 | + { |
|
185 | + $converter->setDateFrom(self::timestamp2date($datefrom)); |
|
186 | + } |
|
187 | 187 | |
188 | - if($dateto instanceof \DateTime) |
|
189 | - { |
|
190 | - $converter->setDateTo($dateto); |
|
191 | - } |
|
192 | - else if($dateto > 0) |
|
193 | - { |
|
194 | - $converter->setDateTo(self::timestamp2date($dateto)); |
|
195 | - } |
|
188 | + if($dateto instanceof \DateTime) |
|
189 | + { |
|
190 | + $converter->setDateTo($dateto); |
|
191 | + } |
|
192 | + else if($dateto > 0) |
|
193 | + { |
|
194 | + $converter->setDateTo(self::timestamp2date($dateto)); |
|
195 | + } |
|
196 | 196 | |
197 | - return $converter->convert(); |
|
197 | + return $converter->convert(); |
|
198 | 198 | } |
199 | 199 | |
200 | 200 | /** |
@@ -233,44 +233,44 @@ discard block |
||
233 | 233 | return $geshi->parse_code(); |
234 | 234 | } |
235 | 235 | |
236 | - /** |
|
237 | - * Converts a number of bytes to a human readable form, |
|
238 | - * e.g. xx Kb / xx Mb / xx Gb |
|
239 | - * |
|
240 | - * @param int $bytes The amount of bytes to convert. |
|
241 | - * @param int $precision The amount of decimals |
|
242 | - * @param int $base The base to calculate with: Base 10 is default (=1000 Bytes in a KB), Base 2 is mainly used for Windows memory (=1024 Bytes in a KB). |
|
243 | - * @return string |
|
244 | - * |
|
245 | - * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
246 | - */ |
|
236 | + /** |
|
237 | + * Converts a number of bytes to a human readable form, |
|
238 | + * e.g. xx Kb / xx Mb / xx Gb |
|
239 | + * |
|
240 | + * @param int $bytes The amount of bytes to convert. |
|
241 | + * @param int $precision The amount of decimals |
|
242 | + * @param int $base The base to calculate with: Base 10 is default (=1000 Bytes in a KB), Base 2 is mainly used for Windows memory (=1024 Bytes in a KB). |
|
243 | + * @return string |
|
244 | + * |
|
245 | + * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
246 | + */ |
|
247 | 247 | public static function bytes2readable(int $bytes, int $precision = 1, int $base = ConvertHelper_StorageSizeEnum::BASE_10) : string |
248 | 248 | { |
249 | 249 | return self::parseBytes($bytes)->toString($precision, $base); |
250 | 250 | } |
251 | 251 | |
252 | - /** |
|
253 | - * Parses a number of bytes, and creates a converter instance which |
|
254 | - * allows doing common operations with it. |
|
255 | - * |
|
256 | - * @param int $bytes |
|
257 | - * @return ConvertHelper_ByteConverter |
|
258 | - */ |
|
252 | + /** |
|
253 | + * Parses a number of bytes, and creates a converter instance which |
|
254 | + * allows doing common operations with it. |
|
255 | + * |
|
256 | + * @param int $bytes |
|
257 | + * @return ConvertHelper_ByteConverter |
|
258 | + */ |
|
259 | 259 | public static function parseBytes(int $bytes) : ConvertHelper_ByteConverter |
260 | 260 | { |
261 | 261 | return new ConvertHelper_ByteConverter($bytes); |
262 | 262 | } |
263 | 263 | |
264 | - /** |
|
265 | - * Cuts a text to the specified length if it is longer than the |
|
266 | - * target length. Appends a text to signify it has been cut at |
|
267 | - * the end of the string. |
|
268 | - * |
|
269 | - * @param string $text |
|
270 | - * @param int $targetLength |
|
271 | - * @param string $append |
|
272 | - * @return string |
|
273 | - */ |
|
264 | + /** |
|
265 | + * Cuts a text to the specified length if it is longer than the |
|
266 | + * target length. Appends a text to signify it has been cut at |
|
267 | + * the end of the string. |
|
268 | + * |
|
269 | + * @param string $text |
|
270 | + * @param int $targetLength |
|
271 | + * @param string $append |
|
272 | + * @return string |
|
273 | + */ |
|
274 | 274 | public static function text_cut(string $text, int $targetLength, string $append = '...') : string |
275 | 275 | { |
276 | 276 | $length = mb_strlen($text); |
@@ -340,27 +340,27 @@ discard block |
||
340 | 340 | return self::$booleanStrings[$string]; |
341 | 341 | } |
342 | 342 | |
343 | - /** |
|
344 | - * Whether the specified string is a boolean string or boolean value. |
|
345 | - * Alias for {@link ConvertHelper::isBoolean()}. |
|
346 | - * |
|
347 | - * @param mixed $string |
|
348 | - * @return bool |
|
349 | - * @deprecated |
|
350 | - * @see ConvertHelper::isBoolean() |
|
351 | - */ |
|
343 | + /** |
|
344 | + * Whether the specified string is a boolean string or boolean value. |
|
345 | + * Alias for {@link ConvertHelper::isBoolean()}. |
|
346 | + * |
|
347 | + * @param mixed $string |
|
348 | + * @return bool |
|
349 | + * @deprecated |
|
350 | + * @see ConvertHelper::isBoolean() |
|
351 | + */ |
|
352 | 352 | public static function isBooleanString($string) : bool |
353 | 353 | { |
354 | 354 | return self::isBoolean($string); |
355 | 355 | } |
356 | 356 | |
357 | - /** |
|
358 | - * Alias for the {@\AppUtils\XMLHelper::string2xml()} method. |
|
359 | - * |
|
360 | - * @param string $text |
|
361 | - * @return string |
|
362 | - * @deprecated |
|
363 | - */ |
|
357 | + /** |
|
358 | + * Alias for the {@\AppUtils\XMLHelper::string2xml()} method. |
|
359 | + * |
|
360 | + * @param string $text |
|
361 | + * @return string |
|
362 | + * @deprecated |
|
363 | + */ |
|
364 | 364 | public static function text_makeXMLCompliant($text) |
365 | 365 | { |
366 | 366 | return XMLHelper::string2xml($text); |
@@ -462,13 +462,13 @@ discard block |
||
462 | 462 | return $translit->convert($string); |
463 | 463 | } |
464 | 464 | |
465 | - /** |
|
466 | - * Retrieves the HEX character codes for all control |
|
467 | - * characters that the {@link stripControlCharacters()} |
|
468 | - * method will remove. |
|
469 | - * |
|
470 | - * @return string[] |
|
471 | - */ |
|
465 | + /** |
|
466 | + * Retrieves the HEX character codes for all control |
|
467 | + * characters that the {@link stripControlCharacters()} |
|
468 | + * method will remove. |
|
469 | + * |
|
470 | + * @return string[] |
|
471 | + */ |
|
472 | 472 | public static function getControlCharactersAsHex() |
473 | 473 | { |
474 | 474 | $hexAlphabet = array('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'); |
@@ -504,13 +504,13 @@ discard block |
||
504 | 504 | return $stack; |
505 | 505 | } |
506 | 506 | |
507 | - /** |
|
508 | - * Retrieves an array of all control characters that |
|
509 | - * the {@link stripControlCharacters()} method will |
|
510 | - * remove, as the actual UTF-8 characters. |
|
511 | - * |
|
512 | - * @return string[] |
|
513 | - */ |
|
507 | + /** |
|
508 | + * Retrieves an array of all control characters that |
|
509 | + * the {@link stripControlCharacters()} method will |
|
510 | + * remove, as the actual UTF-8 characters. |
|
511 | + * |
|
512 | + * @return string[] |
|
513 | + */ |
|
514 | 514 | public static function getControlCharactersAsUTF8() |
515 | 515 | { |
516 | 516 | $chars = self::getControlCharactersAsHex(); |
@@ -523,12 +523,12 @@ discard block |
||
523 | 523 | return $result; |
524 | 524 | } |
525 | 525 | |
526 | - /** |
|
527 | - * Retrieves all control characters as JSON encoded |
|
528 | - * characters, e.g. "\u200b". |
|
529 | - * |
|
530 | - * @return string[] |
|
531 | - */ |
|
526 | + /** |
|
527 | + * Retrieves all control characters as JSON encoded |
|
528 | + * characters, e.g. "\u200b". |
|
529 | + * |
|
530 | + * @return string[] |
|
531 | + */ |
|
532 | 532 | public static function getControlCharactersAsJSON() |
533 | 533 | { |
534 | 534 | $chars = self::getControlCharactersAsHex(); |
@@ -585,20 +585,20 @@ discard block |
||
585 | 585 | return preg_replace(self::$controlCharsRegex, '', $string); |
586 | 586 | } |
587 | 587 | |
588 | - /** |
|
589 | - * Converts a unicode character to the PHPO notation. |
|
590 | - * |
|
591 | - * Example: |
|
592 | - * |
|
593 | - * <pre>unicodeChar2php('"\u0000"')</pre> |
|
594 | - * |
|
595 | - * Returns |
|
596 | - * |
|
597 | - * <pre>\x0</pre> |
|
598 | - * |
|
599 | - * @param string $unicodeChar |
|
600 | - * @return string |
|
601 | - */ |
|
588 | + /** |
|
589 | + * Converts a unicode character to the PHPO notation. |
|
590 | + * |
|
591 | + * Example: |
|
592 | + * |
|
593 | + * <pre>unicodeChar2php('"\u0000"')</pre> |
|
594 | + * |
|
595 | + * Returns |
|
596 | + * |
|
597 | + * <pre>\x0</pre> |
|
598 | + * |
|
599 | + * @param string $unicodeChar |
|
600 | + * @return string |
|
601 | + */ |
|
602 | 602 | public static function unicodeChar2php($unicodeChar) |
603 | 603 | { |
604 | 604 | $unicodeChar = json_decode($unicodeChar); |
@@ -721,25 +721,25 @@ discard block |
||
721 | 721 | return 'false'; |
722 | 722 | } |
723 | 723 | |
724 | - /** |
|
725 | - * Converts an associative array with attribute name > value pairs |
|
726 | - * to an attribute string that can be used in an HTML tag. Empty |
|
727 | - * attribute values are ignored. |
|
728 | - * |
|
729 | - * Example: |
|
730 | - * |
|
731 | - * array2attributeString(array( |
|
732 | - * 'id' => 45, |
|
733 | - * 'href' => 'http://www.mistralys.com' |
|
734 | - * )); |
|
735 | - * |
|
736 | - * Result: |
|
737 | - * |
|
738 | - * id="45" href="http://www.mistralys.com" |
|
739 | - * |
|
740 | - * @param array $array |
|
741 | - * @return string |
|
742 | - */ |
|
724 | + /** |
|
725 | + * Converts an associative array with attribute name > value pairs |
|
726 | + * to an attribute string that can be used in an HTML tag. Empty |
|
727 | + * attribute values are ignored. |
|
728 | + * |
|
729 | + * Example: |
|
730 | + * |
|
731 | + * array2attributeString(array( |
|
732 | + * 'id' => 45, |
|
733 | + * 'href' => 'http://www.mistralys.com' |
|
734 | + * )); |
|
735 | + * |
|
736 | + * Result: |
|
737 | + * |
|
738 | + * id="45" href="http://www.mistralys.com" |
|
739 | + * |
|
740 | + * @param array $array |
|
741 | + * @return string |
|
742 | + */ |
|
743 | 743 | public static function array2attributeString($array) |
744 | 744 | { |
745 | 745 | $tokens = array(); |
@@ -758,14 +758,14 @@ discard block |
||
758 | 758 | return ' '.implode(' ', $tokens); |
759 | 759 | } |
760 | 760 | |
761 | - /** |
|
762 | - * Converts a string so it can safely be used in a javascript |
|
763 | - * statement in an HTML tag: uses single quotes around the string |
|
764 | - * and encodes all special characters as needed. |
|
765 | - * |
|
766 | - * @param string $string |
|
767 | - * @return string |
|
768 | - */ |
|
761 | + /** |
|
762 | + * Converts a string so it can safely be used in a javascript |
|
763 | + * statement in an HTML tag: uses single quotes around the string |
|
764 | + * and encodes all special characters as needed. |
|
765 | + * |
|
766 | + * @param string $string |
|
767 | + * @return string |
|
768 | + */ |
|
769 | 769 | public static function string2attributeJS($string, $quoted=true) |
770 | 770 | { |
771 | 771 | $converted = addslashes(htmlspecialchars(strip_tags($string), ENT_QUOTES, 'UTF-8')); |
@@ -776,15 +776,15 @@ discard block |
||
776 | 776 | return $converted; |
777 | 777 | } |
778 | 778 | |
779 | - /** |
|
780 | - * Checks if the specified string is a boolean value, which |
|
781 | - * includes string representations of boolean values, like |
|
782 | - * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
783 | - * or <code>false</code>. |
|
784 | - * |
|
785 | - * @param mixed $value |
|
786 | - * @return boolean |
|
787 | - */ |
|
779 | + /** |
|
780 | + * Checks if the specified string is a boolean value, which |
|
781 | + * includes string representations of boolean values, like |
|
782 | + * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
783 | + * or <code>false</code>. |
|
784 | + * |
|
785 | + * @param mixed $value |
|
786 | + * @return boolean |
|
787 | + */ |
|
788 | 788 | public static function isBoolean($value) : bool |
789 | 789 | { |
790 | 790 | if(is_bool($value)) { |
@@ -798,12 +798,12 @@ discard block |
||
798 | 798 | return array_key_exists($value, self::$booleanStrings); |
799 | 799 | } |
800 | 800 | |
801 | - /** |
|
802 | - * Converts an associative array to an HTML style attribute value string. |
|
803 | - * |
|
804 | - * @param array $subject |
|
805 | - * @return string |
|
806 | - */ |
|
801 | + /** |
|
802 | + * Converts an associative array to an HTML style attribute value string. |
|
803 | + * |
|
804 | + * @param array $subject |
|
805 | + * @return string |
|
806 | + */ |
|
807 | 807 | public static function array2styleString(array $subject) : string |
808 | 808 | { |
809 | 809 | $tokens = array(); |
@@ -814,23 +814,23 @@ discard block |
||
814 | 814 | return implode(';', $tokens); |
815 | 815 | } |
816 | 816 | |
817 | - /** |
|
818 | - * Converts a DateTime object to a timestamp, which |
|
819 | - * is PHP 5.2 compatible. |
|
820 | - * |
|
821 | - * @param \DateTime $date |
|
822 | - * @return integer |
|
823 | - */ |
|
817 | + /** |
|
818 | + * Converts a DateTime object to a timestamp, which |
|
819 | + * is PHP 5.2 compatible. |
|
820 | + * |
|
821 | + * @param \DateTime $date |
|
822 | + * @return integer |
|
823 | + */ |
|
824 | 824 | public static function date2timestamp(\DateTime $date) : int |
825 | 825 | { |
826 | 826 | return (int)$date->format('U'); |
827 | 827 | } |
828 | 828 | |
829 | - /** |
|
830 | - * Converts a timestamp into a DateTime instance. |
|
831 | - * @param int $timestamp |
|
832 | - * @return \DateTime |
|
833 | - */ |
|
829 | + /** |
|
830 | + * Converts a timestamp into a DateTime instance. |
|
831 | + * @param int $timestamp |
|
832 | + * @return \DateTime |
|
833 | + */ |
|
834 | 834 | public static function timestamp2date(int $timestamp) : \DateTime |
835 | 835 | { |
836 | 836 | $date = new \DateTime(); |
@@ -838,50 +838,50 @@ discard block |
||
838 | 838 | return $date; |
839 | 839 | } |
840 | 840 | |
841 | - /** |
|
842 | - * Strips an absolute path to a file within the application |
|
843 | - * to make the path relative to the application root path. |
|
844 | - * |
|
845 | - * @param string $path |
|
846 | - * @return string |
|
847 | - * |
|
848 | - * @see FileHelper::relativizePath() |
|
849 | - * @see FileHelper::relativizePathByDepth() |
|
850 | - */ |
|
841 | + /** |
|
842 | + * Strips an absolute path to a file within the application |
|
843 | + * to make the path relative to the application root path. |
|
844 | + * |
|
845 | + * @param string $path |
|
846 | + * @return string |
|
847 | + * |
|
848 | + * @see FileHelper::relativizePath() |
|
849 | + * @see FileHelper::relativizePathByDepth() |
|
850 | + */ |
|
851 | 851 | public static function fileRelativize(string $path) : string |
852 | 852 | { |
853 | 853 | return FileHelper::relativizePathByDepth($path); |
854 | 854 | } |
855 | 855 | |
856 | 856 | /** |
857 | - * Converts a PHP regex to a javascript RegExp object statement. |
|
858 | - * |
|
859 | - * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
860 | - * More details are available on its usage there. |
|
861 | - * |
|
862 | - * @param string $regex A PHP preg regex |
|
863 | - * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
864 | - * @return array|string Depending on the specified return type. |
|
865 | - * |
|
866 | - * @see JSHelper::buildRegexStatement() |
|
867 | - */ |
|
857 | + * Converts a PHP regex to a javascript RegExp object statement. |
|
858 | + * |
|
859 | + * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
860 | + * More details are available on its usage there. |
|
861 | + * |
|
862 | + * @param string $regex A PHP preg regex |
|
863 | + * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
864 | + * @return array|string Depending on the specified return type. |
|
865 | + * |
|
866 | + * @see JSHelper::buildRegexStatement() |
|
867 | + */ |
|
868 | 868 | public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) |
869 | 869 | { |
870 | 870 | return JSHelper::buildRegexStatement($regex, $statementType); |
871 | 871 | } |
872 | 872 | |
873 | - /** |
|
874 | - * Converts the specified variable to JSON. Works just |
|
875 | - * like the native `json_encode` method, except that it |
|
876 | - * will trigger an exception on failure, which has the |
|
877 | - * json error details included in its developer details. |
|
878 | - * |
|
879 | - * @param mixed $variable |
|
880 | - * @param int|NULL $options JSON encode options. |
|
881 | - * @param int|NULL $depth |
|
882 | - * @throws ConvertHelper_Exception |
|
883 | - * @return string |
|
884 | - */ |
|
873 | + /** |
|
874 | + * Converts the specified variable to JSON. Works just |
|
875 | + * like the native `json_encode` method, except that it |
|
876 | + * will trigger an exception on failure, which has the |
|
877 | + * json error details included in its developer details. |
|
878 | + * |
|
879 | + * @param mixed $variable |
|
880 | + * @param int|NULL $options JSON encode options. |
|
881 | + * @param int|NULL $depth |
|
882 | + * @throws ConvertHelper_Exception |
|
883 | + * @return string |
|
884 | + */ |
|
885 | 885 | public static function var2json($variable, int $options=0, int $depth=512) : string |
886 | 886 | { |
887 | 887 | $result = json_encode($variable, $options, $depth); |
@@ -902,12 +902,12 @@ discard block |
||
902 | 902 | ); |
903 | 903 | } |
904 | 904 | |
905 | - /** |
|
906 | - * Strips all known UTF byte order marks from the specified string. |
|
907 | - * |
|
908 | - * @param string $string |
|
909 | - * @return string |
|
910 | - */ |
|
905 | + /** |
|
906 | + * Strips all known UTF byte order marks from the specified string. |
|
907 | + * |
|
908 | + * @param string $string |
|
909 | + * @return string |
|
910 | + */ |
|
911 | 911 | public static function stripUTFBom($string) |
912 | 912 | { |
913 | 913 | $boms = FileHelper::getUTFBOMs(); |
@@ -922,13 +922,13 @@ discard block |
||
922 | 922 | return $string; |
923 | 923 | } |
924 | 924 | |
925 | - /** |
|
926 | - * Converts a string to valid utf8, regardless |
|
927 | - * of the string's encoding(s). |
|
928 | - * |
|
929 | - * @param string $string |
|
930 | - * @return string |
|
931 | - */ |
|
925 | + /** |
|
926 | + * Converts a string to valid utf8, regardless |
|
927 | + * of the string's encoding(s). |
|
928 | + * |
|
929 | + * @param string $string |
|
930 | + * @return string |
|
931 | + */ |
|
932 | 932 | public static function string2utf8($string) |
933 | 933 | { |
934 | 934 | if(!self::isStringASCII($string)) { |
@@ -938,15 +938,15 @@ discard block |
||
938 | 938 | return $string; |
939 | 939 | } |
940 | 940 | |
941 | - /** |
|
942 | - * Checks whether the specified string is an ASCII |
|
943 | - * string, without any special or UTF8 characters. |
|
944 | - * Note: empty strings and NULL are considered ASCII. |
|
945 | - * Any variable types other than strings are not. |
|
946 | - * |
|
947 | - * @param mixed $string |
|
948 | - * @return boolean |
|
949 | - */ |
|
941 | + /** |
|
942 | + * Checks whether the specified string is an ASCII |
|
943 | + * string, without any special or UTF8 characters. |
|
944 | + * Note: empty strings and NULL are considered ASCII. |
|
945 | + * Any variable types other than strings are not. |
|
946 | + * |
|
947 | + * @param mixed $string |
|
948 | + * @return boolean |
|
949 | + */ |
|
950 | 950 | public static function isStringASCII($string) : bool |
951 | 951 | { |
952 | 952 | if($string === '' || $string === NULL) { |
@@ -971,22 +971,22 @@ discard block |
||
971 | 971 | return $url; |
972 | 972 | } |
973 | 973 | |
974 | - /** |
|
975 | - * Calculates a percentage match of the source string with the target string. |
|
976 | - * |
|
977 | - * Options are: |
|
978 | - * |
|
979 | - * - maxLevenshtein, default: 10 |
|
980 | - * Any levenshtein results above this value are ignored. |
|
981 | - * |
|
982 | - * - precision, default: 1 |
|
983 | - * The precision of the percentage float value |
|
984 | - * |
|
985 | - * @param string $source |
|
986 | - * @param string $target |
|
987 | - * @param array $options |
|
988 | - * @return float |
|
989 | - */ |
|
974 | + /** |
|
975 | + * Calculates a percentage match of the source string with the target string. |
|
976 | + * |
|
977 | + * Options are: |
|
978 | + * |
|
979 | + * - maxLevenshtein, default: 10 |
|
980 | + * Any levenshtein results above this value are ignored. |
|
981 | + * |
|
982 | + * - precision, default: 1 |
|
983 | + * The precision of the percentage float value |
|
984 | + * |
|
985 | + * @param string $source |
|
986 | + * @param string $target |
|
987 | + * @param array $options |
|
988 | + * @return float |
|
989 | + */ |
|
990 | 990 | public static function matchString($source, $target, $options=array()) |
991 | 991 | { |
992 | 992 | $defaults = array( |
@@ -1010,14 +1010,14 @@ discard block |
||
1010 | 1010 | return round(100 - $percent, $options['precision']); |
1011 | 1011 | } |
1012 | 1012 | |
1013 | - /** |
|
1014 | - * Converts a date interval to a human readable string with |
|
1015 | - * all necessary time components, e.g. "1 year, 2 months and 4 days". |
|
1016 | - * |
|
1017 | - * @param \DateInterval $interval |
|
1018 | - * @return string |
|
1019 | - * @see ConvertHelper_IntervalConverter |
|
1020 | - */ |
|
1013 | + /** |
|
1014 | + * Converts a date interval to a human readable string with |
|
1015 | + * all necessary time components, e.g. "1 year, 2 months and 4 days". |
|
1016 | + * |
|
1017 | + * @param \DateInterval $interval |
|
1018 | + * @return string |
|
1019 | + * @see ConvertHelper_IntervalConverter |
|
1020 | + */ |
|
1021 | 1021 | public static function interval2string(\DateInterval $interval) : string |
1022 | 1022 | { |
1023 | 1023 | $converter = new ConvertHelper_IntervalConverter(); |
@@ -1032,60 +1032,60 @@ discard block |
||
1032 | 1032 | |
1033 | 1033 | const INTERVAL_SECONDS = 'seconds'; |
1034 | 1034 | |
1035 | - /** |
|
1036 | - * Converts an interval to its total amount of days. |
|
1037 | - * @param \DateInterval $interval |
|
1038 | - * @return int |
|
1039 | - */ |
|
1035 | + /** |
|
1036 | + * Converts an interval to its total amount of days. |
|
1037 | + * @param \DateInterval $interval |
|
1038 | + * @return int |
|
1039 | + */ |
|
1040 | 1040 | public static function interval2days(\DateInterval $interval) : int |
1041 | 1041 | { |
1042 | 1042 | return self::interval2total($interval, self::INTERVAL_DAYS); |
1043 | 1043 | } |
1044 | 1044 | |
1045 | - /** |
|
1046 | - * Converts an interval to its total amount of hours. |
|
1047 | - * @param \DateInterval $interval |
|
1048 | - * @return int |
|
1049 | - */ |
|
1045 | + /** |
|
1046 | + * Converts an interval to its total amount of hours. |
|
1047 | + * @param \DateInterval $interval |
|
1048 | + * @return int |
|
1049 | + */ |
|
1050 | 1050 | public static function interval2hours(\DateInterval $interval) : int |
1051 | 1051 | { |
1052 | 1052 | return self::interval2total($interval, self::INTERVAL_HOURS); |
1053 | 1053 | } |
1054 | 1054 | |
1055 | - /** |
|
1056 | - * Converts an interval to its total amount of minutes. |
|
1057 | - * @param \DateInterval $interval |
|
1058 | - * @return int |
|
1059 | - */ |
|
1055 | + /** |
|
1056 | + * Converts an interval to its total amount of minutes. |
|
1057 | + * @param \DateInterval $interval |
|
1058 | + * @return int |
|
1059 | + */ |
|
1060 | 1060 | public static function interval2minutes(\DateInterval $interval) : int |
1061 | 1061 | { |
1062 | 1062 | return self::interval2total($interval, self::INTERVAL_MINUTES); |
1063 | 1063 | } |
1064 | 1064 | |
1065 | - /** |
|
1066 | - * Converts an interval to its total amount of seconds. |
|
1067 | - * @param \DateInterval $interval |
|
1068 | - * @return int |
|
1069 | - */ |
|
1065 | + /** |
|
1066 | + * Converts an interval to its total amount of seconds. |
|
1067 | + * @param \DateInterval $interval |
|
1068 | + * @return int |
|
1069 | + */ |
|
1070 | 1070 | public static function interval2seconds(\DateInterval $interval) : int |
1071 | 1071 | { |
1072 | 1072 | return self::interval2total($interval, self::INTERVAL_SECONDS); |
1073 | 1073 | } |
1074 | 1074 | |
1075 | - /** |
|
1076 | - * Calculates the total amount of days / hours / minutes or seconds |
|
1077 | - * of a date interval object (depending in the specified units), and |
|
1078 | - * returns the total amount. |
|
1079 | - * |
|
1080 | - * @param \DateInterval $interval |
|
1081 | - * @param string $unit What total value to calculate. |
|
1082 | - * @return integer |
|
1083 | - * |
|
1084 | - * @see ConvertHelper::INTERVAL_SECONDS |
|
1085 | - * @see ConvertHelper::INTERVAL_MINUTES |
|
1086 | - * @see ConvertHelper::INTERVAL_HOURS |
|
1087 | - * @see ConvertHelper::INTERVAL_DAYS |
|
1088 | - */ |
|
1075 | + /** |
|
1076 | + * Calculates the total amount of days / hours / minutes or seconds |
|
1077 | + * of a date interval object (depending in the specified units), and |
|
1078 | + * returns the total amount. |
|
1079 | + * |
|
1080 | + * @param \DateInterval $interval |
|
1081 | + * @param string $unit What total value to calculate. |
|
1082 | + * @return integer |
|
1083 | + * |
|
1084 | + * @see ConvertHelper::INTERVAL_SECONDS |
|
1085 | + * @see ConvertHelper::INTERVAL_MINUTES |
|
1086 | + * @see ConvertHelper::INTERVAL_HOURS |
|
1087 | + * @see ConvertHelper::INTERVAL_DAYS |
|
1088 | + */ |
|
1089 | 1089 | public static function interval2total(\DateInterval $interval, $unit=self::INTERVAL_SECONDS) : int |
1090 | 1090 | { |
1091 | 1091 | $total = (int)$interval->format('%a'); |
@@ -1125,13 +1125,13 @@ discard block |
||
1125 | 1125 | 'Sunday' |
1126 | 1126 | ); |
1127 | 1127 | |
1128 | - /** |
|
1129 | - * Converts a date to the corresponding day name. |
|
1130 | - * |
|
1131 | - * @param \DateTime $date |
|
1132 | - * @param bool $short |
|
1133 | - * @return string|NULL |
|
1134 | - */ |
|
1128 | + /** |
|
1129 | + * Converts a date to the corresponding day name. |
|
1130 | + * |
|
1131 | + * @param \DateTime $date |
|
1132 | + * @param bool $short |
|
1133 | + * @return string|NULL |
|
1134 | + */ |
|
1135 | 1135 | public static function date2dayName(\DateTime $date, bool $short=false) |
1136 | 1136 | { |
1137 | 1137 | $day = $date->format('l'); |
@@ -1146,21 +1146,21 @@ discard block |
||
1146 | 1146 | return null; |
1147 | 1147 | } |
1148 | 1148 | |
1149 | - /** |
|
1150 | - * Retrieves a list of english day names. |
|
1151 | - * @return string[] |
|
1152 | - */ |
|
1149 | + /** |
|
1150 | + * Retrieves a list of english day names. |
|
1151 | + * @return string[] |
|
1152 | + */ |
|
1153 | 1153 | public static function getDayNamesInvariant() |
1154 | 1154 | { |
1155 | 1155 | return self::$daysInvariant; |
1156 | 1156 | } |
1157 | 1157 | |
1158 | - /** |
|
1159 | - * Retrieves the day names list for the current locale. |
|
1160 | - * |
|
1161 | - * @param bool $short |
|
1162 | - * @return array |
|
1163 | - */ |
|
1158 | + /** |
|
1159 | + * Retrieves the day names list for the current locale. |
|
1160 | + * |
|
1161 | + * @param bool $short |
|
1162 | + * @return array |
|
1163 | + */ |
|
1164 | 1164 | public static function getDayNames(bool $short=false) : array |
1165 | 1165 | { |
1166 | 1166 | if($short) { |
@@ -1220,16 +1220,16 @@ discard block |
||
1220 | 1220 | return $last; |
1221 | 1221 | } |
1222 | 1222 | |
1223 | - /** |
|
1224 | - * Splits a string into an array of all characters it is composed of. |
|
1225 | - * Unicode character safe. |
|
1226 | - * |
|
1227 | - * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
1228 | - * characters. |
|
1229 | - * |
|
1230 | - * @param string $string |
|
1231 | - * @return array |
|
1232 | - */ |
|
1223 | + /** |
|
1224 | + * Splits a string into an array of all characters it is composed of. |
|
1225 | + * Unicode character safe. |
|
1226 | + * |
|
1227 | + * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
1228 | + * characters. |
|
1229 | + * |
|
1230 | + * @param string $string |
|
1231 | + * @return array |
|
1232 | + */ |
|
1233 | 1233 | public static function string2array(string $string) : array |
1234 | 1234 | { |
1235 | 1235 | $result = preg_split('//u', $string, null, PREG_SPLIT_NO_EMPTY); |
@@ -1240,12 +1240,12 @@ discard block |
||
1240 | 1240 | return array(); |
1241 | 1241 | } |
1242 | 1242 | |
1243 | - /** |
|
1244 | - * Checks whether the specified string contains HTML code. |
|
1245 | - * |
|
1246 | - * @param string $string |
|
1247 | - * @return boolean |
|
1248 | - */ |
|
1243 | + /** |
|
1244 | + * Checks whether the specified string contains HTML code. |
|
1245 | + * |
|
1246 | + * @param string $string |
|
1247 | + * @return boolean |
|
1248 | + */ |
|
1249 | 1249 | public static function isStringHTML(string $string) : bool |
1250 | 1250 | { |
1251 | 1251 | if(preg_match('%<[a-z/][\s\S]*>%siU', $string)) { |
@@ -1260,17 +1260,17 @@ discard block |
||
1260 | 1260 | return false; |
1261 | 1261 | } |
1262 | 1262 | |
1263 | - /** |
|
1264 | - * UTF8-safe wordwrap method: works like the regular wordwrap |
|
1265 | - * PHP function but compatible with UTF8. Otherwise the lengths |
|
1266 | - * are not calculated correctly. |
|
1267 | - * |
|
1268 | - * @param string $str |
|
1269 | - * @param int $width |
|
1270 | - * @param string $break |
|
1271 | - * @param bool $cut |
|
1272 | - * @return string |
|
1273 | - */ |
|
1263 | + /** |
|
1264 | + * UTF8-safe wordwrap method: works like the regular wordwrap |
|
1265 | + * PHP function but compatible with UTF8. Otherwise the lengths |
|
1266 | + * are not calculated correctly. |
|
1267 | + * |
|
1268 | + * @param string $str |
|
1269 | + * @param int $width |
|
1270 | + * @param string $break |
|
1271 | + * @param bool $cut |
|
1272 | + * @return string |
|
1273 | + */ |
|
1274 | 1274 | public static function wordwrap(string $str, int $width = 75, string $break = "\n", bool $cut = false) : string |
1275 | 1275 | { |
1276 | 1276 | $wrapper = new ConvertHelper_WordWrapper(); |
@@ -1282,27 +1282,27 @@ discard block |
||
1282 | 1282 | ->wrapText($str); |
1283 | 1283 | } |
1284 | 1284 | |
1285 | - /** |
|
1286 | - * Calculates the byte length of a string, taking into |
|
1287 | - * account any unicode characters. |
|
1288 | - * |
|
1289 | - * @param string $string |
|
1290 | - * @return int |
|
1291 | - * @see https://stackoverflow.com/a/9718273/2298192 |
|
1292 | - */ |
|
1285 | + /** |
|
1286 | + * Calculates the byte length of a string, taking into |
|
1287 | + * account any unicode characters. |
|
1288 | + * |
|
1289 | + * @param string $string |
|
1290 | + * @return int |
|
1291 | + * @see https://stackoverflow.com/a/9718273/2298192 |
|
1292 | + */ |
|
1293 | 1293 | public static function string2bytes($string) |
1294 | 1294 | { |
1295 | 1295 | return mb_strlen($string, '8bit'); |
1296 | 1296 | } |
1297 | 1297 | |
1298 | - /** |
|
1299 | - * Creates a short, 8-character long hash for the specified string. |
|
1300 | - * |
|
1301 | - * WARNING: Not cryptographically safe. |
|
1302 | - * |
|
1303 | - * @param string $string |
|
1304 | - * @return string |
|
1305 | - */ |
|
1298 | + /** |
|
1299 | + * Creates a short, 8-character long hash for the specified string. |
|
1300 | + * |
|
1301 | + * WARNING: Not cryptographically safe. |
|
1302 | + * |
|
1303 | + * @param string $string |
|
1304 | + * @return string |
|
1305 | + */ |
|
1306 | 1306 | public static function string2shortHash($string) |
1307 | 1307 | { |
1308 | 1308 | return hash('crc32', $string, false); |
@@ -1328,40 +1328,40 @@ discard block |
||
1328 | 1328 | return ConvertHelper_ThrowableInfo::fromThrowable($e); |
1329 | 1329 | } |
1330 | 1330 | |
1331 | - /** |
|
1332 | - * Parses the specified query string like the native |
|
1333 | - * function <code>parse_str</code>, without the key |
|
1334 | - * naming limitations. |
|
1335 | - * |
|
1336 | - * Using parse_str, dots or spaces in key names are |
|
1337 | - * replaced by underscores. This method keeps all names |
|
1338 | - * intact. |
|
1339 | - * |
|
1340 | - * It still uses the parse_str implementation as it |
|
1341 | - * is tested and tried, but fixes the parameter names |
|
1342 | - * after parsing, as needed. |
|
1343 | - * |
|
1344 | - * @param string $queryString |
|
1345 | - * @return array |
|
1346 | - * @see ConvertHelper_QueryParser |
|
1347 | - */ |
|
1331 | + /** |
|
1332 | + * Parses the specified query string like the native |
|
1333 | + * function <code>parse_str</code>, without the key |
|
1334 | + * naming limitations. |
|
1335 | + * |
|
1336 | + * Using parse_str, dots or spaces in key names are |
|
1337 | + * replaced by underscores. This method keeps all names |
|
1338 | + * intact. |
|
1339 | + * |
|
1340 | + * It still uses the parse_str implementation as it |
|
1341 | + * is tested and tried, but fixes the parameter names |
|
1342 | + * after parsing, as needed. |
|
1343 | + * |
|
1344 | + * @param string $queryString |
|
1345 | + * @return array |
|
1346 | + * @see ConvertHelper_QueryParser |
|
1347 | + */ |
|
1348 | 1348 | public static function parseQueryString(string $queryString) : array |
1349 | 1349 | { |
1350 | 1350 | $parser = new ConvertHelper_QueryParser(); |
1351 | 1351 | return $parser->parse($queryString); |
1352 | 1352 | } |
1353 | 1353 | |
1354 | - /** |
|
1355 | - * Searches for needle in the specified string, and returns a list |
|
1356 | - * of all occurrences, including the matched string. The matched |
|
1357 | - * string is useful when doing a case insensitive search, as it |
|
1358 | - * shows the exact matched case of needle. |
|
1359 | - * |
|
1360 | - * @param string $needle |
|
1361 | - * @param string $haystack |
|
1362 | - * @param bool $caseInsensitive |
|
1363 | - * @return ConvertHelper_StringMatch[] |
|
1364 | - */ |
|
1354 | + /** |
|
1355 | + * Searches for needle in the specified string, and returns a list |
|
1356 | + * of all occurrences, including the matched string. The matched |
|
1357 | + * string is useful when doing a case insensitive search, as it |
|
1358 | + * shows the exact matched case of needle. |
|
1359 | + * |
|
1360 | + * @param string $needle |
|
1361 | + * @param string $haystack |
|
1362 | + * @param bool $caseInsensitive |
|
1363 | + * @return ConvertHelper_StringMatch[] |
|
1364 | + */ |
|
1365 | 1365 | public static function findString(string $needle, string $haystack, bool $caseInsensitive=false) |
1366 | 1366 | { |
1367 | 1367 | if($needle === '') { |
@@ -1387,14 +1387,14 @@ discard block |
||
1387 | 1387 | return $positions; |
1388 | 1388 | } |
1389 | 1389 | |
1390 | - /** |
|
1391 | - * Like explode, but trims all entries, and removes |
|
1392 | - * empty entries from the resulting array. |
|
1393 | - * |
|
1394 | - * @param string $delimiter |
|
1395 | - * @param string $string |
|
1396 | - * @return string[] |
|
1397 | - */ |
|
1390 | + /** |
|
1391 | + * Like explode, but trims all entries, and removes |
|
1392 | + * empty entries from the resulting array. |
|
1393 | + * |
|
1394 | + * @param string $delimiter |
|
1395 | + * @param string $string |
|
1396 | + * @return string[] |
|
1397 | + */ |
|
1398 | 1398 | public static function explodeTrim(string $delimiter, string $string) : array |
1399 | 1399 | { |
1400 | 1400 | if(empty($string) || empty($delimiter)) { |
@@ -1416,12 +1416,12 @@ discard block |
||
1416 | 1416 | |
1417 | 1417 | protected static $eolChars; |
1418 | 1418 | |
1419 | - /** |
|
1420 | - * Detects the most used end-of-line character in the subject string. |
|
1421 | - * |
|
1422 | - * @param string $str The string to check. |
|
1423 | - * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
1424 | - */ |
|
1419 | + /** |
|
1420 | + * Detects the most used end-of-line character in the subject string. |
|
1421 | + * |
|
1422 | + * @param string $str The string to check. |
|
1423 | + * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
1424 | + */ |
|
1425 | 1425 | public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL |
1426 | 1426 | { |
1427 | 1427 | if(empty($subjectString)) { |
@@ -1433,27 +1433,27 @@ discard block |
||
1433 | 1433 | $cr = chr((int)hexdec('0d')); |
1434 | 1434 | $lf = chr((int)hexdec('0a')); |
1435 | 1435 | |
1436 | - self::$eolChars = array( |
|
1437 | - array( |
|
1438 | - 'char' => $cr.$lf, |
|
1439 | - 'type' => ConvertHelper_EOL::TYPE_CRLF, |
|
1440 | - 'description' => t('Carriage return followed by a line feed'), |
|
1441 | - ), |
|
1442 | - array( |
|
1443 | - 'char' => $lf.$cr, |
|
1444 | - 'type' => ConvertHelper_EOL::TYPE_LFCR, |
|
1445 | - 'description' => t('Line feed followed by a carriage return'), |
|
1446 | - ), |
|
1447 | - array( |
|
1448 | - 'char' => $lf, |
|
1449 | - 'type' => ConvertHelper_EOL::TYPE_LF, |
|
1450 | - 'description' => t('Line feed'), |
|
1451 | - ), |
|
1452 | - array( |
|
1453 | - 'char' => $cr, |
|
1454 | - 'type' => ConvertHelper_EOL::TYPE_CR, |
|
1455 | - 'description' => t('Carriage Return'), |
|
1456 | - ), |
|
1436 | + self::$eolChars = array( |
|
1437 | + array( |
|
1438 | + 'char' => $cr.$lf, |
|
1439 | + 'type' => ConvertHelper_EOL::TYPE_CRLF, |
|
1440 | + 'description' => t('Carriage return followed by a line feed'), |
|
1441 | + ), |
|
1442 | + array( |
|
1443 | + 'char' => $lf.$cr, |
|
1444 | + 'type' => ConvertHelper_EOL::TYPE_LFCR, |
|
1445 | + 'description' => t('Line feed followed by a carriage return'), |
|
1446 | + ), |
|
1447 | + array( |
|
1448 | + 'char' => $lf, |
|
1449 | + 'type' => ConvertHelper_EOL::TYPE_LF, |
|
1450 | + 'description' => t('Line feed'), |
|
1451 | + ), |
|
1452 | + array( |
|
1453 | + 'char' => $cr, |
|
1454 | + 'type' => ConvertHelper_EOL::TYPE_CR, |
|
1455 | + 'description' => t('Carriage Return'), |
|
1456 | + ), |
|
1457 | 1457 | ); |
1458 | 1458 | } |
1459 | 1459 | |
@@ -1481,13 +1481,13 @@ discard block |
||
1481 | 1481 | ); |
1482 | 1482 | } |
1483 | 1483 | |
1484 | - /** |
|
1485 | - * Removes the specified keys from the target array, |
|
1486 | - * if they exist. |
|
1487 | - * |
|
1488 | - * @param array $array |
|
1489 | - * @param array $keys |
|
1490 | - */ |
|
1484 | + /** |
|
1485 | + * Removes the specified keys from the target array, |
|
1486 | + * if they exist. |
|
1487 | + * |
|
1488 | + * @param array $array |
|
1489 | + * @param array $keys |
|
1490 | + */ |
|
1491 | 1491 | public static function arrayRemoveKeys(array &$array, array $keys) : void |
1492 | 1492 | { |
1493 | 1493 | foreach($keys as $key) |
@@ -1498,13 +1498,13 @@ discard block |
||
1498 | 1498 | } |
1499 | 1499 | } |
1500 | 1500 | |
1501 | - /** |
|
1502 | - * Checks if the specified variable is an integer or a string containing an integer. |
|
1503 | - * Accepts both positive and negative integers. |
|
1504 | - * |
|
1505 | - * @param mixed $value |
|
1506 | - * @return bool |
|
1507 | - */ |
|
1501 | + /** |
|
1502 | + * Checks if the specified variable is an integer or a string containing an integer. |
|
1503 | + * Accepts both positive and negative integers. |
|
1504 | + * |
|
1505 | + * @param mixed $value |
|
1506 | + * @return bool |
|
1507 | + */ |
|
1508 | 1508 | public static function isInteger($value) : bool |
1509 | 1509 | { |
1510 | 1510 | if(is_int($value)) { |
@@ -1524,40 +1524,40 @@ discard block |
||
1524 | 1524 | return false; |
1525 | 1525 | } |
1526 | 1526 | |
1527 | - /** |
|
1528 | - * Converts an amount of seconds to a DateInterval object. |
|
1529 | - * |
|
1530 | - * @param int $seconds |
|
1531 | - * @return \DateInterval |
|
1532 | - * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
1533 | - * |
|
1534 | - * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
1535 | - */ |
|
1527 | + /** |
|
1528 | + * Converts an amount of seconds to a DateInterval object. |
|
1529 | + * |
|
1530 | + * @param int $seconds |
|
1531 | + * @return \DateInterval |
|
1532 | + * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
1533 | + * |
|
1534 | + * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
1535 | + */ |
|
1536 | 1536 | public static function seconds2interval(int $seconds) : \DateInterval |
1537 | 1537 | { |
1538 | 1538 | return ConvertHelper_DateInterval::fromSeconds($seconds)->getInterval(); |
1539 | 1539 | } |
1540 | 1540 | |
1541 | - /** |
|
1542 | - * Converts a size string like "50 MB" to the corresponding byte size. |
|
1543 | - * It is case insensitive, ignores spaces, and supports both traditional |
|
1544 | - * "MB" and "MiB" notations. |
|
1545 | - * |
|
1546 | - * @param string $size |
|
1547 | - * @return int |
|
1548 | - */ |
|
1541 | + /** |
|
1542 | + * Converts a size string like "50 MB" to the corresponding byte size. |
|
1543 | + * It is case insensitive, ignores spaces, and supports both traditional |
|
1544 | + * "MB" and "MiB" notations. |
|
1545 | + * |
|
1546 | + * @param string $size |
|
1547 | + * @return int |
|
1548 | + */ |
|
1549 | 1549 | public static function size2bytes(string $size) : int |
1550 | 1550 | { |
1551 | 1551 | return self::parseSize($size)->toBytes(); |
1552 | 1552 | } |
1553 | 1553 | |
1554 | - /** |
|
1555 | - * Parses a size string like "50 MB" and returns a size notation instance |
|
1556 | - * that has utility methods to access information on it, and convert it. |
|
1557 | - * |
|
1558 | - * @param string $size |
|
1559 | - * @return ConvertHelper_SizeNotation |
|
1560 | - */ |
|
1554 | + /** |
|
1555 | + * Parses a size string like "50 MB" and returns a size notation instance |
|
1556 | + * that has utility methods to access information on it, and convert it. |
|
1557 | + * |
|
1558 | + * @param string $size |
|
1559 | + * @return ConvertHelper_SizeNotation |
|
1560 | + */ |
|
1561 | 1561 | public static function parseSize(string $size) : ConvertHelper_SizeNotation |
1562 | 1562 | { |
1563 | 1563 | return new ConvertHelper_SizeNotation($size); |