@@ -41,7 +41,7 @@ discard block |
||
| 41 | 41 | */ |
| 42 | 42 | public function setOption(string $name, $value) |
| 43 | 43 | { |
| 44 | - if(!isset($this->options)) { |
|
| 44 | + if (!isset($this->options)) { |
|
| 45 | 45 | $this->options = $this->getDefaultOptions(); |
| 46 | 46 | } |
| 47 | 47 | |
@@ -58,7 +58,7 @@ discard block |
||
| 58 | 58 | */ |
| 59 | 59 | public function setOptions(array $options) |
| 60 | 60 | { |
| 61 | - foreach($options as $name => $value) { |
|
| 61 | + foreach ($options as $name => $value) { |
|
| 62 | 62 | $this->setOption($name, $value); |
| 63 | 63 | } |
| 64 | 64 | |
@@ -75,13 +75,13 @@ discard block |
||
| 75 | 75 | * @param mixed $default The default value to return if the option does not exist. |
| 76 | 76 | * @return mixed |
| 77 | 77 | */ |
| 78 | - public function getOption(string $name, $default=null) |
|
| 78 | + public function getOption(string $name, $default = null) |
|
| 79 | 79 | { |
| 80 | - if(!isset($this->options)) { |
|
| 80 | + if (!isset($this->options)) { |
|
| 81 | 81 | $this->options = $this->getDefaultOptions(); |
| 82 | 82 | } |
| 83 | 83 | |
| 84 | - if(isset($this->options[$name])) { |
|
| 84 | + if (isset($this->options[$name])) { |
|
| 85 | 85 | return $this->options[$name]; |
| 86 | 86 | } |
| 87 | 87 | |
@@ -98,11 +98,11 @@ discard block |
||
| 98 | 98 | * @param string $default Used if the option does not exist, is invalid, or empty. |
| 99 | 99 | * @return string |
| 100 | 100 | */ |
| 101 | - public function getStringOption(string $name, string $default='') : string |
|
| 101 | + public function getStringOption(string $name, string $default = '') : string |
|
| 102 | 102 | { |
| 103 | 103 | $value = $this->getOption($name, false); |
| 104 | 104 | |
| 105 | - if((is_string($value) || is_numeric($value)) && !empty($value)) { |
|
| 105 | + if ((is_string($value) || is_numeric($value)) && !empty($value)) { |
|
| 106 | 106 | return (string)$value; |
| 107 | 107 | } |
| 108 | 108 | |
@@ -118,9 +118,9 @@ discard block |
||
| 118 | 118 | * @param string $name |
| 119 | 119 | * @return bool |
| 120 | 120 | */ |
| 121 | - public function getBoolOption(string $name, bool $default=false) : bool |
|
| 121 | + public function getBoolOption(string $name, bool $default = false) : bool |
|
| 122 | 122 | { |
| 123 | - if($this->getOption($name) === true) { |
|
| 123 | + if ($this->getOption($name) === true) { |
|
| 124 | 124 | return true; |
| 125 | 125 | } |
| 126 | 126 | |
@@ -136,10 +136,10 @@ discard block |
||
| 136 | 136 | * @param int $default |
| 137 | 137 | * @return int |
| 138 | 138 | */ |
| 139 | - public function getIntOption(string $name, int $default=0) : int |
|
| 139 | + public function getIntOption(string $name, int $default = 0) : int |
|
| 140 | 140 | { |
| 141 | 141 | $value = $this->getOption($name); |
| 142 | - if(ConvertHelper::isInteger($value)) { |
|
| 142 | + if (ConvertHelper::isInteger($value)) { |
|
| 143 | 143 | return (int)$value; |
| 144 | 144 | } |
| 145 | 145 | |
@@ -157,7 +157,7 @@ discard block |
||
| 157 | 157 | public function getArrayOption(string $name) : array |
| 158 | 158 | { |
| 159 | 159 | $val = $this->getOption($name); |
| 160 | - if(is_array($val)) { |
|
| 160 | + if (is_array($val)) { |
|
| 161 | 161 | return $val; |
| 162 | 162 | } |
| 163 | 163 | |
@@ -173,7 +173,7 @@ discard block |
||
| 173 | 173 | */ |
| 174 | 174 | public function hasOption(string $name) : bool |
| 175 | 175 | { |
| 176 | - if(!isset($this->options)) { |
|
| 176 | + if (!isset($this->options)) { |
|
| 177 | 177 | $this->options = $this->getDefaultOptions(); |
| 178 | 178 | } |
| 179 | 179 | |
@@ -186,7 +186,7 @@ discard block |
||
| 186 | 186 | */ |
| 187 | 187 | public function getOptions() : array |
| 188 | 188 | { |
| 189 | - if(!isset($this->options)) { |
|
| 189 | + if (!isset($this->options)) { |
|
| 190 | 190 | $this->options = $this->getDefaultOptions(); |
| 191 | 191 | } |
| 192 | 192 | |
@@ -240,7 +240,7 @@ discard block |
||
| 240 | 240 | * @param mixed $default |
| 241 | 241 | * @return Interface_Optionable |
| 242 | 242 | */ |
| 243 | - function getOption(string $name, $default=null); |
|
| 243 | + function getOption(string $name, $default = null); |
|
| 244 | 244 | |
| 245 | 245 | /** |
| 246 | 246 | * @param array $options |
@@ -26,18 +26,18 @@ discard block |
||
| 26 | 26 | */ |
| 27 | 27 | trait Traits_Optionable |
| 28 | 28 | { |
| 29 | - /** |
|
| 30 | - * @var array |
|
| 31 | - */ |
|
| 29 | + /** |
|
| 30 | + * @var array |
|
| 31 | + */ |
|
| 32 | 32 | protected $options; |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * Sets an option to the specified value. This can be any |
|
| 36 | - * kind of variable type, including objects, as needed. |
|
| 37 | - * |
|
| 38 | - * @param string $name |
|
| 39 | - * @param mixed $default |
|
| 40 | - */ |
|
| 34 | + /** |
|
| 35 | + * Sets an option to the specified value. This can be any |
|
| 36 | + * kind of variable type, including objects, as needed. |
|
| 37 | + * |
|
| 38 | + * @param string $name |
|
| 39 | + * @param mixed $default |
|
| 40 | + */ |
|
| 41 | 41 | public function setOption(string $name, $value) |
| 42 | 42 | { |
| 43 | 43 | if(!isset($this->options)) { |
@@ -48,12 +48,12 @@ discard block |
||
| 48 | 48 | return $this; |
| 49 | 49 | } |
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * Sets a collection of options at once, from an |
|
| 53 | - * associative array. |
|
| 54 | - * |
|
| 55 | - * @param array $options |
|
| 56 | - */ |
|
| 51 | + /** |
|
| 52 | + * Sets a collection of options at once, from an |
|
| 53 | + * associative array. |
|
| 54 | + * |
|
| 55 | + * @param array $options |
|
| 56 | + */ |
|
| 57 | 57 | public function setOptions(array $options) |
| 58 | 58 | { |
| 59 | 59 | foreach($options as $name => $value) { |
@@ -63,16 +63,16 @@ discard block |
||
| 63 | 63 | return $this; |
| 64 | 64 | } |
| 65 | 65 | |
| 66 | - /** |
|
| 67 | - * Retrieves an option's value. |
|
| 68 | - * |
|
| 69 | - * NOTE: Use the specialized type getters to ensure an option |
|
| 70 | - * contains the expected type (for ex. getArrayOption()). |
|
| 71 | - * |
|
| 72 | - * @param string $name |
|
| 73 | - * @param mixed $default The default value to return if the option does not exist. |
|
| 74 | - * @return mixed |
|
| 75 | - */ |
|
| 66 | + /** |
|
| 67 | + * Retrieves an option's value. |
|
| 68 | + * |
|
| 69 | + * NOTE: Use the specialized type getters to ensure an option |
|
| 70 | + * contains the expected type (for ex. getArrayOption()). |
|
| 71 | + * |
|
| 72 | + * @param string $name |
|
| 73 | + * @param mixed $default The default value to return if the option does not exist. |
|
| 74 | + * @return mixed |
|
| 75 | + */ |
|
| 76 | 76 | public function getOption(string $name, $default=null) |
| 77 | 77 | { |
| 78 | 78 | if(!isset($this->options)) { |
@@ -86,16 +86,16 @@ discard block |
||
| 86 | 86 | return $default; |
| 87 | 87 | } |
| 88 | 88 | |
| 89 | - /** |
|
| 90 | - * Enforces that the option value is a string. Numbers are converted |
|
| 91 | - * to string, strings are passed through, and all other types will |
|
| 92 | - * return the default value. The default value is also returned if |
|
| 93 | - * the string is empty. |
|
| 94 | - * |
|
| 95 | - * @param string $name |
|
| 96 | - * @param string $default Used if the option does not exist, is invalid, or empty. |
|
| 97 | - * @return string |
|
| 98 | - */ |
|
| 89 | + /** |
|
| 90 | + * Enforces that the option value is a string. Numbers are converted |
|
| 91 | + * to string, strings are passed through, and all other types will |
|
| 92 | + * return the default value. The default value is also returned if |
|
| 93 | + * the string is empty. |
|
| 94 | + * |
|
| 95 | + * @param string $name |
|
| 96 | + * @param string $default Used if the option does not exist, is invalid, or empty. |
|
| 97 | + * @return string |
|
| 98 | + */ |
|
| 99 | 99 | public function getStringOption(string $name, string $default='') : string |
| 100 | 100 | { |
| 101 | 101 | $value = $this->getOption($name, false); |
@@ -107,15 +107,15 @@ discard block |
||
| 107 | 107 | return $default; |
| 108 | 108 | } |
| 109 | 109 | |
| 110 | - /** |
|
| 111 | - * Treats the option value as a boolean value: will return |
|
| 112 | - * true if the value actually is a boolean true. |
|
| 113 | - * |
|
| 114 | - * NOTE: boolean string representations are not accepted. |
|
| 115 | - * |
|
| 116 | - * @param string $name |
|
| 117 | - * @return bool |
|
| 118 | - */ |
|
| 110 | + /** |
|
| 111 | + * Treats the option value as a boolean value: will return |
|
| 112 | + * true if the value actually is a boolean true. |
|
| 113 | + * |
|
| 114 | + * NOTE: boolean string representations are not accepted. |
|
| 115 | + * |
|
| 116 | + * @param string $name |
|
| 117 | + * @return bool |
|
| 118 | + */ |
|
| 119 | 119 | public function getBoolOption(string $name, bool $default=false) : bool |
| 120 | 120 | { |
| 121 | 121 | if($this->getOption($name) === true) { |
@@ -125,15 +125,15 @@ discard block |
||
| 125 | 125 | return $default; |
| 126 | 126 | } |
| 127 | 127 | |
| 128 | - /** |
|
| 129 | - * Treats the option value as an integer value: will return |
|
| 130 | - * valid integer values (also from integer strings), or the |
|
| 131 | - * default value otherwise. |
|
| 132 | - * |
|
| 133 | - * @param string $name |
|
| 134 | - * @param int $default |
|
| 135 | - * @return int |
|
| 136 | - */ |
|
| 128 | + /** |
|
| 129 | + * Treats the option value as an integer value: will return |
|
| 130 | + * valid integer values (also from integer strings), or the |
|
| 131 | + * default value otherwise. |
|
| 132 | + * |
|
| 133 | + * @param string $name |
|
| 134 | + * @param int $default |
|
| 135 | + * @return int |
|
| 136 | + */ |
|
| 137 | 137 | public function getIntOption(string $name, int $default=0) : int |
| 138 | 138 | { |
| 139 | 139 | $value = $this->getOption($name); |
@@ -144,14 +144,14 @@ discard block |
||
| 144 | 144 | return $default; |
| 145 | 145 | } |
| 146 | 146 | |
| 147 | - /** |
|
| 148 | - * Treats an option as an array, and returns its value |
|
| 149 | - * only if it contains an array - otherwise, an empty |
|
| 150 | - * array is returned. |
|
| 151 | - * |
|
| 152 | - * @param string $name |
|
| 153 | - * @return array |
|
| 154 | - */ |
|
| 147 | + /** |
|
| 148 | + * Treats an option as an array, and returns its value |
|
| 149 | + * only if it contains an array - otherwise, an empty |
|
| 150 | + * array is returned. |
|
| 151 | + * |
|
| 152 | + * @param string $name |
|
| 153 | + * @return array |
|
| 154 | + */ |
|
| 155 | 155 | public function getArrayOption(string $name) : array |
| 156 | 156 | { |
| 157 | 157 | $val = $this->getOption($name); |
@@ -162,13 +162,13 @@ discard block |
||
| 162 | 162 | return array(); |
| 163 | 163 | } |
| 164 | 164 | |
| 165 | - /** |
|
| 166 | - * Checks whether the specified option exists - even |
|
| 167 | - * if it has a NULL value. |
|
| 168 | - * |
|
| 169 | - * @param string $name |
|
| 170 | - * @return bool |
|
| 171 | - */ |
|
| 165 | + /** |
|
| 166 | + * Checks whether the specified option exists - even |
|
| 167 | + * if it has a NULL value. |
|
| 168 | + * |
|
| 169 | + * @param string $name |
|
| 170 | + * @return bool |
|
| 171 | + */ |
|
| 172 | 172 | public function hasOption(string $name) : bool |
| 173 | 173 | { |
| 174 | 174 | if(!isset($this->options)) { |
@@ -178,10 +178,10 @@ discard block |
||
| 178 | 178 | return array_key_exists($name, $this->options); |
| 179 | 179 | } |
| 180 | 180 | |
| 181 | - /** |
|
| 182 | - * Returns all options in one associative array. |
|
| 183 | - * @return array |
|
| 184 | - */ |
|
| 181 | + /** |
|
| 182 | + * Returns all options in one associative array. |
|
| 183 | + * @return array |
|
| 184 | + */ |
|
| 185 | 185 | public function getOptions() : array |
| 186 | 186 | { |
| 187 | 187 | if(!isset($this->options)) { |
@@ -191,24 +191,24 @@ discard block |
||
| 191 | 191 | return $this->options; |
| 192 | 192 | } |
| 193 | 193 | |
| 194 | - /** |
|
| 195 | - * Checks whether the option's value is the one specified. |
|
| 196 | - * |
|
| 197 | - * @param string $name |
|
| 198 | - * @param mixed $value |
|
| 199 | - * @return bool |
|
| 200 | - */ |
|
| 194 | + /** |
|
| 195 | + * Checks whether the option's value is the one specified. |
|
| 196 | + * |
|
| 197 | + * @param string $name |
|
| 198 | + * @param mixed $value |
|
| 199 | + * @return bool |
|
| 200 | + */ |
|
| 201 | 201 | public function isOption(string $name, $value) : bool |
| 202 | 202 | { |
| 203 | 203 | return $this->getOption($name) === $value; |
| 204 | 204 | } |
| 205 | 205 | |
| 206 | - /** |
|
| 207 | - * Retrieves the default available options as an |
|
| 208 | - * associative array with option name => value pairs. |
|
| 209 | - * |
|
| 210 | - * @return array |
|
| 211 | - */ |
|
| 206 | + /** |
|
| 207 | + * Retrieves the default available options as an |
|
| 208 | + * associative array with option name => value pairs. |
|
| 209 | + * |
|
| 210 | + * @return array |
|
| 211 | + */ |
|
| 212 | 212 | abstract public function getDefaultOptions() : array; |
| 213 | 213 | } |
| 214 | 214 | |
@@ -226,24 +226,24 @@ discard block |
||
| 226 | 226 | */ |
| 227 | 227 | interface Interface_Optionable |
| 228 | 228 | { |
| 229 | - /** |
|
| 230 | - * @param string $name |
|
| 231 | - * @param mixed $value |
|
| 232 | - * @return Interface_Optionable |
|
| 233 | - */ |
|
| 229 | + /** |
|
| 230 | + * @param string $name |
|
| 231 | + * @param mixed $value |
|
| 232 | + * @return Interface_Optionable |
|
| 233 | + */ |
|
| 234 | 234 | function setOption(string $name, $value); |
| 235 | 235 | |
| 236 | - /** |
|
| 237 | - * @param string $name |
|
| 238 | - * @param mixed $default |
|
| 239 | - * @return Interface_Optionable |
|
| 240 | - */ |
|
| 236 | + /** |
|
| 237 | + * @param string $name |
|
| 238 | + * @param mixed $default |
|
| 239 | + * @return Interface_Optionable |
|
| 240 | + */ |
|
| 241 | 241 | function getOption(string $name, $default=null); |
| 242 | 242 | |
| 243 | - /** |
|
| 244 | - * @param array $options |
|
| 245 | - * @return Interface_Optionable |
|
| 246 | - */ |
|
| 243 | + /** |
|
| 244 | + * @param array $options |
|
| 245 | + * @return Interface_Optionable |
|
| 246 | + */ |
|
| 247 | 247 | function setOptions(array $options); |
| 248 | 248 | function getOptions() : array; |
| 249 | 249 | function isOption(string $name, $value) : bool; |
@@ -151,8 +151,7 @@ discard block |
||
| 151 | 151 | $this->sourceImage = $resource; |
| 152 | 152 | $this->type = $type; |
| 153 | 153 | $this->info = self::getImageSize($resource); |
| 154 | - } |
|
| 155 | - else |
|
| 154 | + } else |
|
| 156 | 155 | { |
| 157 | 156 | $this->file = $sourceFile; |
| 158 | 157 | if (!file_exists($this->file)) { |
@@ -561,8 +560,7 @@ discard block |
||
| 561 | 560 | if ($this->width <= $this->height) |
| 562 | 561 | { |
| 563 | 562 | $this->resampleByWidth($width); |
| 564 | - } |
|
| 565 | - else |
|
| 563 | + } else |
|
| 566 | 564 | { |
| 567 | 565 | $this->resampleByHeight($height); |
| 568 | 566 | } |
@@ -1037,8 +1035,7 @@ discard block |
||
| 1037 | 1035 | { |
| 1038 | 1036 | $bg2 = imagecolorallocatealpha($im2, $color['red'], $color['green'], $color['blue'], $color['alpha']); |
| 1039 | 1037 | imagecolortransparent($im2, $bg2); |
| 1040 | - } |
|
| 1041 | - else |
|
| 1038 | + } else |
|
| 1042 | 1039 | { |
| 1043 | 1040 | $bg2 = imagecolorallocate($im2, $color['red'], $color['green'], $color['blue']); |
| 1044 | 1041 | } |
@@ -1348,8 +1345,7 @@ discard block |
||
| 1348 | 1345 | if(method_exists(__CLASS__, $method)) |
| 1349 | 1346 | { |
| 1350 | 1347 | $info = call_user_func(array(__CLASS__, $method), $pathOrResource); |
| 1351 | - } |
|
| 1352 | - else |
|
| 1348 | + } else |
|
| 1353 | 1349 | { |
| 1354 | 1350 | $info = getimagesize($pathOrResource); |
| 1355 | 1351 | } |
@@ -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(); |
@@ -136,10 +136,10 @@ discard block |
||
| 136 | 136 | 'gif' |
| 137 | 137 | ); |
| 138 | 138 | |
| 139 | - public function __construct($sourceFile=null, $resource=null, $type=null) |
|
| 139 | + public function __construct($sourceFile = null, $resource = null, $type = null) |
|
| 140 | 140 | { |
| 141 | 141 | // ensure that the GD library is installed |
| 142 | - if(!function_exists('imagecreate')) |
|
| 142 | + if (!function_exists('imagecreate')) |
|
| 143 | 143 | { |
| 144 | 144 | throw new ImageHelper_Exception( |
| 145 | 145 | 'The PHP GD extension is not installed or not enabled.', |
@@ -148,7 +148,7 @@ discard block |
||
| 148 | 148 | ); |
| 149 | 149 | } |
| 150 | 150 | |
| 151 | - if(is_resource($resource)) |
|
| 151 | + if (is_resource($resource)) |
|
| 152 | 152 | { |
| 153 | 153 | $this->sourceImage = $resource; |
| 154 | 154 | $this->type = $type; |
@@ -172,21 +172,21 @@ discard block |
||
| 172 | 172 | if (is_null($this->type)) { |
| 173 | 173 | throw new ImageHelper_Exception( |
| 174 | 174 | 'Error opening image', |
| 175 | - 'Not a valid supported image type for image ' . $this->file, |
|
| 175 | + 'Not a valid supported image type for image '.$this->file, |
|
| 176 | 176 | self::ERROR_UNSUPPORTED_IMAGE_TYPE |
| 177 | 177 | ); |
| 178 | 178 | } |
| 179 | 179 | |
| 180 | 180 | $this->info = self::getImageSize($this->file); |
| 181 | 181 | |
| 182 | - if(!$this->isVector()) |
|
| 182 | + if (!$this->isVector()) |
|
| 183 | 183 | { |
| 184 | - $method = 'imagecreatefrom' . $this->type; |
|
| 184 | + $method = 'imagecreatefrom'.$this->type; |
|
| 185 | 185 | $this->sourceImage = $method($this->file); |
| 186 | 186 | if (!$this->sourceImage) { |
| 187 | 187 | throw new ImageHelper_Exception( |
| 188 | 188 | 'Error creating new image', |
| 189 | - $method . ' failed', |
|
| 189 | + $method.' failed', |
|
| 190 | 190 | self::ERROR_FAILED_TO_CREATE_NEW_IMAGE |
| 191 | 191 | ); |
| 192 | 192 | } |
@@ -198,7 +198,7 @@ discard block |
||
| 198 | 198 | $this->width = $this->info->getWidth(); |
| 199 | 199 | $this->height = $this->info->getHeight(); |
| 200 | 200 | |
| 201 | - if(!$this->isVector()) { |
|
| 201 | + if (!$this->isVector()) { |
|
| 202 | 202 | $this->setNewImage($this->duplicateImage($this->sourceImage)); |
| 203 | 203 | } |
| 204 | 204 | } |
@@ -214,10 +214,10 @@ discard block |
||
| 214 | 214 | * |
| 215 | 215 | * @see ImageHelper::ERROR_CANNOT_CREATE_IMAGE_OBJECT |
| 216 | 216 | */ |
| 217 | - public static function createNew($width, $height, $type='png') |
|
| 217 | + public static function createNew($width, $height, $type = 'png') |
|
| 218 | 218 | { |
| 219 | 219 | $img = imagecreatetruecolor($width, $height); |
| 220 | - if($img !== false) { |
|
| 220 | + if ($img !== false) { |
|
| 221 | 221 | return self::createFromResource($img, 'png'); |
| 222 | 222 | } |
| 223 | 223 | |
@@ -240,7 +240,7 @@ discard block |
||
| 240 | 240 | * @param string $type The target image type, e.g. "jpeg", "png", etc. |
| 241 | 241 | * @return ImageHelper |
| 242 | 242 | */ |
| 243 | - public static function createFromResource($resource, ?string $type=null) |
|
| 243 | + public static function createFromResource($resource, ?string $type = null) |
|
| 244 | 244 | { |
| 245 | 245 | self::requireResource($resource); |
| 246 | 246 | |
@@ -272,7 +272,7 @@ discard block |
||
| 272 | 272 | */ |
| 273 | 273 | public static function setConfig($name, $value) |
| 274 | 274 | { |
| 275 | - if(isset(self::$config[$name])) { |
|
| 275 | + if (isset(self::$config[$name])) { |
|
| 276 | 276 | self::$config[$name] = $value; |
| 277 | 277 | } |
| 278 | 278 | } |
@@ -283,7 +283,7 @@ discard block |
||
| 283 | 283 | * |
| 284 | 284 | * @param bool $enabled |
| 285 | 285 | */ |
| 286 | - public static function setAutoMemoryAdjustment($enabled=true) |
|
| 286 | + public static function setAutoMemoryAdjustment($enabled = true) |
|
| 287 | 287 | { |
| 288 | 288 | self::setConfig('auto-memory-adjustment', $enabled); |
| 289 | 289 | } |
@@ -317,7 +317,7 @@ discard block |
||
| 317 | 317 | |
| 318 | 318 | public function enableAlpha() |
| 319 | 319 | { |
| 320 | - if(!$this->alpha) |
|
| 320 | + if (!$this->alpha) |
|
| 321 | 321 | { |
| 322 | 322 | self::addAlphaSupport($this->newImage, false); |
| 323 | 323 | $this->alpha = true; |
@@ -348,9 +348,9 @@ discard block |
||
| 348 | 348 | * @param number $percent |
| 349 | 349 | * @return ImageHelper |
| 350 | 350 | */ |
| 351 | - public function sharpen($percent=0) |
|
| 351 | + public function sharpen($percent = 0) |
|
| 352 | 352 | { |
| 353 | - if($percent <= 0) { |
|
| 353 | + if ($percent <= 0) { |
|
| 354 | 354 | return $this; |
| 355 | 355 | } |
| 356 | 356 | |
@@ -359,9 +359,9 @@ discard block |
||
| 359 | 359 | return $this->convolute($factor); |
| 360 | 360 | } |
| 361 | 361 | |
| 362 | - public function blur($percent=0) |
|
| 362 | + public function blur($percent = 0) |
|
| 363 | 363 | { |
| 364 | - if($percent <= 0) { |
|
| 364 | + if ($percent <= 0) { |
|
| 365 | 365 | return $this; |
| 366 | 366 | } |
| 367 | 367 | |
@@ -374,12 +374,12 @@ discard block |
||
| 374 | 374 | { |
| 375 | 375 | // get a value thats equal to 64 - abs( factor ) |
| 376 | 376 | // ( using min/max to limited the factor to 0 - 64 to not get out of range values ) |
| 377 | - $val1Adjustment = 64 - min( 64, max( 0, abs( $factor ) ) ); |
|
| 377 | + $val1Adjustment = 64 - min(64, max(0, abs($factor))); |
|
| 378 | 378 | |
| 379 | 379 | // the base factor for the "current" pixel depends on if we are blurring or sharpening. |
| 380 | 380 | // If we are blurring use 1, if sharpening use 9. |
| 381 | 381 | $val1Base = 9; |
| 382 | - if( abs( $factor ) != $factor ) { |
|
| 382 | + if (abs($factor) != $factor) { |
|
| 383 | 383 | $val1Base = 1; |
| 384 | 384 | } |
| 385 | 385 | |
@@ -392,24 +392,24 @@ discard block |
||
| 392 | 392 | |
| 393 | 393 | // the value for the surrounding pixels is either positive or negative depending on if we are blurring or sharpening. |
| 394 | 394 | $val2 = -1; |
| 395 | - if( abs( $factor ) != $factor ) { |
|
| 395 | + if (abs($factor) != $factor) { |
|
| 396 | 396 | $val2 = 1; |
| 397 | 397 | } |
| 398 | 398 | |
| 399 | 399 | // setup matrix .. |
| 400 | 400 | $matrix = array( |
| 401 | - array( $val2, $val2, $val2 ), |
|
| 402 | - array( $val2, $val1, $val2 ), |
|
| 403 | - array( $val2, $val2, $val2 ) |
|
| 401 | + array($val2, $val2, $val2), |
|
| 402 | + array($val2, $val1, $val2), |
|
| 403 | + array($val2, $val2, $val2) |
|
| 404 | 404 | ); |
| 405 | 405 | |
| 406 | 406 | // calculate the correct divisor |
| 407 | 407 | // actual divisor is equal to "$divisor = $val1 + $val2 * 8;" |
| 408 | 408 | // but the following line is more generic |
| 409 | - $divisor = array_sum( array_map( 'array_sum', $matrix ) ); |
|
| 409 | + $divisor = array_sum(array_map('array_sum', $matrix)); |
|
| 410 | 410 | |
| 411 | 411 | // apply the matrix |
| 412 | - imageconvolution( $this->newImage, $matrix, $divisor, 0 ); |
|
| 412 | + imageconvolution($this->newImage, $matrix, $divisor, 0); |
|
| 413 | 413 | |
| 414 | 414 | return $this; |
| 415 | 415 | } |
@@ -535,7 +535,7 @@ discard block |
||
| 535 | 535 | */ |
| 536 | 536 | public function resample(?int $width = null, ?int $height = null) : ImageHelper |
| 537 | 537 | { |
| 538 | - if($this->isVector()) { |
|
| 538 | + if ($this->isVector()) { |
|
| 539 | 539 | return $this; |
| 540 | 540 | } |
| 541 | 541 | |
@@ -556,7 +556,7 @@ discard block |
||
| 556 | 556 | |
| 557 | 557 | public function resampleAndCrop($width, $height) : ImageHelper |
| 558 | 558 | { |
| 559 | - if($this->isVector()) { |
|
| 559 | + if ($this->isVector()) { |
|
| 560 | 560 | return $this; |
| 561 | 561 | } |
| 562 | 562 | |
@@ -603,14 +603,14 @@ discard block |
||
| 603 | 603 | * @param resource $canvas |
| 604 | 604 | * @param bool $fill Whether to fill the whole canvas with the transparency |
| 605 | 605 | */ |
| 606 | - public static function addAlphaSupport($canvas, $fill=true) |
|
| 606 | + public static function addAlphaSupport($canvas, $fill = true) |
|
| 607 | 607 | { |
| 608 | 608 | self::requireResource($canvas); |
| 609 | 609 | |
| 610 | - imagealphablending($canvas,true); |
|
| 610 | + imagealphablending($canvas, true); |
|
| 611 | 611 | imagesavealpha($canvas, true); |
| 612 | 612 | |
| 613 | - if($fill) { |
|
| 613 | + if ($fill) { |
|
| 614 | 614 | self::fillImageTransparent($canvas); |
| 615 | 615 | } |
| 616 | 616 | } |
@@ -620,13 +620,13 @@ discard block |
||
| 620 | 620 | return $this->alpha; |
| 621 | 621 | } |
| 622 | 622 | |
| 623 | - public function save(string $targetFile, $dispose=true) |
|
| 623 | + public function save(string $targetFile, $dispose = true) |
|
| 624 | 624 | { |
| 625 | - if($this->isVector()) { |
|
| 625 | + if ($this->isVector()) { |
|
| 626 | 626 | return true; |
| 627 | 627 | } |
| 628 | 628 | |
| 629 | - if(!is_resource($this->newImage)) { |
|
| 629 | + if (!is_resource($this->newImage)) { |
|
| 630 | 630 | throw new ImageHelper_Exception( |
| 631 | 631 | 'Error creating new image', |
| 632 | 632 | 'Cannot save an image, no valid image resource was created. You have to call one of the resample methods to create a new image.', |
@@ -638,7 +638,7 @@ discard block |
||
| 638 | 638 | unlink($targetFile); |
| 639 | 639 | } |
| 640 | 640 | |
| 641 | - $method = 'image' . $this->type; |
|
| 641 | + $method = 'image'.$this->type; |
|
| 642 | 642 | if (!$method($this->newImage, $targetFile, $this->resolveQuality())) { |
| 643 | 643 | throw new ImageHelper_Exception( |
| 644 | 644 | 'Error creating new image', |
@@ -659,7 +659,7 @@ discard block |
||
| 659 | 659 | ); |
| 660 | 660 | } |
| 661 | 661 | |
| 662 | - if($dispose) { |
|
| 662 | + if ($dispose) { |
|
| 663 | 663 | $this->dispose(); |
| 664 | 664 | } |
| 665 | 665 | |
@@ -668,11 +668,11 @@ discard block |
||
| 668 | 668 | |
| 669 | 669 | public function dispose() |
| 670 | 670 | { |
| 671 | - if(is_resource($this->sourceImage)) { |
|
| 671 | + if (is_resource($this->sourceImage)) { |
|
| 672 | 672 | imagedestroy($this->sourceImage); |
| 673 | 673 | } |
| 674 | 674 | |
| 675 | - if(is_resource($this->newImage)) { |
|
| 675 | + if (is_resource($this->newImage)) { |
|
| 676 | 676 | imagedestroy($this->newImage); |
| 677 | 677 | } |
| 678 | 678 | } |
@@ -725,7 +725,7 @@ discard block |
||
| 725 | 725 | */ |
| 726 | 726 | protected function adjustMemory() : bool |
| 727 | 727 | { |
| 728 | - if(!self::$config['auto-memory-adjustment']) { |
|
| 728 | + if (!self::$config['auto-memory-adjustment']) { |
|
| 729 | 729 | return true; |
| 730 | 730 | } |
| 731 | 731 | |
@@ -754,7 +754,7 @@ discard block |
||
| 754 | 754 | if (function_exists('memory_get_usage') && memory_get_usage() + $memoryNeeded > $memoryLimit) { |
| 755 | 755 | $newLimit = ($memoryLimit + (memory_get_usage() + $memoryNeeded)) / $MB; |
| 756 | 756 | $newLimit = ceil($newLimit); |
| 757 | - ini_set('memory_limit', $newLimit . 'M'); |
|
| 757 | + ini_set('memory_limit', $newLimit.'M'); |
|
| 758 | 758 | |
| 759 | 759 | return true; |
| 760 | 760 | } |
@@ -785,16 +785,16 @@ discard block |
||
| 785 | 785 | */ |
| 786 | 786 | protected function resampleImage(int $newWidth, int $newHeight) : ImageHelper |
| 787 | 787 | { |
| 788 | - if($this->isVector()) { |
|
| 788 | + if ($this->isVector()) { |
|
| 789 | 789 | return $this; |
| 790 | 790 | } |
| 791 | 791 | |
| 792 | - if($this->newWidth==$newWidth && $this->newHeight==$newHeight) { |
|
| 792 | + if ($this->newWidth == $newWidth && $this->newHeight == $newHeight) { |
|
| 793 | 793 | return $this; |
| 794 | 794 | } |
| 795 | 795 | |
| 796 | - if($newWidth < 1) { $newWidth = 1; } |
|
| 797 | - if($newHeight < 1) { $newHeight = 1; } |
|
| 796 | + if ($newWidth < 1) { $newWidth = 1; } |
|
| 797 | + if ($newHeight < 1) { $newHeight = 1; } |
|
| 798 | 798 | |
| 799 | 799 | $this->adjustMemory(); |
| 800 | 800 | |
@@ -858,11 +858,11 @@ discard block |
||
| 858 | 858 | * @param string $imageType The image format to send, i.e. "jpeg", "png" |
| 859 | 859 | * @param int $quality The quality to use for the image. This is 0-9 (0=no compression, 9=max) for PNG, and 0-100 (0=lowest, 100=highest quality) for JPG |
| 860 | 860 | */ |
| 861 | - public static function displayImageStream($resource, $imageType, $quality=-1) |
|
| 861 | + public static function displayImageStream($resource, $imageType, $quality = -1) |
|
| 862 | 862 | { |
| 863 | 863 | $imageType = strtolower($imageType); |
| 864 | 864 | |
| 865 | - if(!in_array($imageType, self::$streamTypes)) { |
|
| 865 | + if (!in_array($imageType, self::$streamTypes)) { |
|
| 866 | 866 | throw new ImageHelper_Exception( |
| 867 | 867 | 'Invalid image stream type', |
| 868 | 868 | sprintf( |
@@ -873,9 +873,9 @@ discard block |
||
| 873 | 873 | ); |
| 874 | 874 | } |
| 875 | 875 | |
| 876 | - header('Content-type:image/' . $imageType); |
|
| 876 | + header('Content-type:image/'.$imageType); |
|
| 877 | 877 | |
| 878 | - $function = 'image' . $imageType; |
|
| 878 | + $function = 'image'.$imageType; |
|
| 879 | 879 | |
| 880 | 880 | $function($resource, null, $quality); |
| 881 | 881 | } |
@@ -891,7 +891,7 @@ discard block |
||
| 891 | 891 | if (headers_sent($file, $line)) { |
| 892 | 892 | throw new ImageHelper_Exception( |
| 893 | 893 | 'Error displaying image', |
| 894 | - 'Headers have already been sent: in file ' . $file . ':' . $line, |
|
| 894 | + 'Headers have already been sent: in file '.$file.':'.$line, |
|
| 895 | 895 | self::ERROR_HEADERS_ALREADY_SENT |
| 896 | 896 | ); |
| 897 | 897 | } |
@@ -908,16 +908,16 @@ discard block |
||
| 908 | 908 | } |
| 909 | 909 | |
| 910 | 910 | $format = self::getFileImageType($imageFile); |
| 911 | - if($format == 'svg') { |
|
| 911 | + if ($format == 'svg') { |
|
| 912 | 912 | $format = 'svg+xml'; |
| 913 | 913 | } |
| 914 | 914 | |
| 915 | - $contentType = 'image/' . $format; |
|
| 915 | + $contentType = 'image/'.$format; |
|
| 916 | 916 | |
| 917 | 917 | header('Content-Type: '.$contentType); |
| 918 | - header("Last-Modified: " . gmdate("D, d M Y H:i:s", filemtime($imageFile)) . " GMT"); |
|
| 918 | + header("Last-Modified: ".gmdate("D, d M Y H:i:s", filemtime($imageFile))." GMT"); |
|
| 919 | 919 | header('Cache-Control: public'); |
| 920 | - header('Content-Length: ' . filesize($imageFile)); |
|
| 920 | + header('Content-Length: '.filesize($imageFile)); |
|
| 921 | 921 | |
| 922 | 922 | readfile($imageFile); |
| 923 | 923 | } |
@@ -935,7 +935,7 @@ discard block |
||
| 935 | 935 | * |
| 936 | 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 | 937 | */ |
| 938 | - public function trim($color=null) |
|
| 938 | + public function trim($color = null) |
|
| 939 | 939 | { |
| 940 | 940 | return $this->trimImage($this->newImage, $color); |
| 941 | 941 | } |
@@ -952,7 +952,7 @@ discard block |
||
| 952 | 952 | $color = imagecolorsforindex($img, $colorIndex); |
| 953 | 953 | |
| 954 | 954 | // it seems imagecolorsforindex may return false (undocumented, unproven) |
| 955 | - if(is_array($color)) { |
|
| 955 | + if (is_array($color)) { |
|
| 956 | 956 | return $color; |
| 957 | 957 | } |
| 958 | 958 | |
@@ -972,15 +972,15 @@ discard block |
||
| 972 | 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 | 973 | * @return ImageHelper |
| 974 | 974 | */ |
| 975 | - protected function trimImage($img, ?array $color=null) : ImageHelper |
|
| 975 | + protected function trimImage($img, ?array $color = null) : ImageHelper |
|
| 976 | 976 | { |
| 977 | - if($this->isVector()) { |
|
| 977 | + if ($this->isVector()) { |
|
| 978 | 978 | return $this; |
| 979 | 979 | } |
| 980 | 980 | |
| 981 | 981 | self::requireResource($img); |
| 982 | 982 | |
| 983 | - if(empty($color)) |
|
| 983 | + if (empty($color)) |
|
| 984 | 984 | { |
| 985 | 985 | $color = imagecolorat($img, 0, 0); |
| 986 | 986 | $color = $this->getIndexedColors($img, $color); |
@@ -997,16 +997,16 @@ discard block |
||
| 997 | 997 | $ymax = null; |
| 998 | 998 | |
| 999 | 999 | // Start scanning for the edges. |
| 1000 | - for ($iy=0; $iy<$imh; $iy++) |
|
| 1000 | + for ($iy = 0; $iy < $imh; $iy++) |
|
| 1001 | 1001 | { |
| 1002 | 1002 | $first = true; |
| 1003 | 1003 | |
| 1004 | - for ($ix=0; $ix<$imw; $ix++) |
|
| 1004 | + for ($ix = 0; $ix < $imw; $ix++) |
|
| 1005 | 1005 | { |
| 1006 | 1006 | $ndx = imagecolorat($img, $ix, $iy); |
| 1007 | 1007 | $colors = $this->getIndexedColors($img, $ndx); |
| 1008 | 1008 | |
| 1009 | - if(!$this->colorsMatch($colors, $color)) |
|
| 1009 | + if (!$this->colorsMatch($colors, $color)) |
|
| 1010 | 1010 | { |
| 1011 | 1011 | if ($xmin > $ix) { $xmin = $ix; } |
| 1012 | 1012 | if ($xmax < $ix) { $xmax = $ix; } |
@@ -1014,7 +1014,7 @@ discard block |
||
| 1014 | 1014 | |
| 1015 | 1015 | $ymax = $iy; |
| 1016 | 1016 | |
| 1017 | - if($first) |
|
| 1017 | + if ($first) |
|
| 1018 | 1018 | { |
| 1019 | 1019 | $ix = $xmax; |
| 1020 | 1020 | $first = false; |
@@ -1024,18 +1024,18 @@ discard block |
||
| 1024 | 1024 | } |
| 1025 | 1025 | |
| 1026 | 1026 | // no trimming border found |
| 1027 | - if($ymax === null && $ymax === null) { |
|
| 1027 | + if ($ymax === null && $ymax === null) { |
|
| 1028 | 1028 | return $this; |
| 1029 | 1029 | } |
| 1030 | 1030 | |
| 1031 | 1031 | // The new width and height of the image. |
| 1032 | - $imw = 1+$xmax-$xmin; // Image width in pixels |
|
| 1033 | - $imh = 1+$ymax-$ymin; // Image height in pixels |
|
| 1032 | + $imw = 1 + $xmax - $xmin; // Image width in pixels |
|
| 1033 | + $imh = 1 + $ymax - $ymin; // Image height in pixels |
|
| 1034 | 1034 | |
| 1035 | 1035 | // Make another image to place the trimmed version in. |
| 1036 | 1036 | $im2 = $this->createNewImage($imw, $imh); |
| 1037 | 1037 | |
| 1038 | - if($color['alpha'] > 0) |
|
| 1038 | + if ($color['alpha'] > 0) |
|
| 1039 | 1039 | { |
| 1040 | 1040 | $bg2 = imagecolorallocatealpha($im2, $color['red'], $color['green'], $color['blue'], $color['alpha']); |
| 1041 | 1041 | imagecolortransparent($im2, $bg2); |
@@ -1071,7 +1071,7 @@ discard block |
||
| 1071 | 1071 | |
| 1072 | 1072 | $this->newImage = $image; |
| 1073 | 1073 | $this->newWidth = imagesx($image); |
| 1074 | - $this->newHeight= imagesy($image); |
|
| 1074 | + $this->newHeight = imagesy($image); |
|
| 1075 | 1075 | } |
| 1076 | 1076 | |
| 1077 | 1077 | /** |
@@ -1082,7 +1082,7 @@ discard block |
||
| 1082 | 1082 | */ |
| 1083 | 1083 | protected static function requireResource($subject) |
| 1084 | 1084 | { |
| 1085 | - if(is_resource($subject)) { |
|
| 1085 | + if (is_resource($subject)) { |
|
| 1086 | 1086 | return; |
| 1087 | 1087 | } |
| 1088 | 1088 | |
@@ -1108,7 +1108,7 @@ discard block |
||
| 1108 | 1108 | { |
| 1109 | 1109 | $img = imagecreatetruecolor($width, $height); |
| 1110 | 1110 | |
| 1111 | - if($img === false) |
|
| 1111 | + if ($img === false) |
|
| 1112 | 1112 | { |
| 1113 | 1113 | throw new ImageHelper_Exception( |
| 1114 | 1114 | 'Error creating new image', |
@@ -1132,8 +1132,8 @@ discard block |
||
| 1132 | 1132 | protected function colorsMatch($a, $b) : bool |
| 1133 | 1133 | { |
| 1134 | 1134 | $parts = array('red', 'green', 'blue'); |
| 1135 | - foreach($parts as $part) { |
|
| 1136 | - if($a[$part] != $b[$part]) { |
|
| 1135 | + foreach ($parts as $part) { |
|
| 1136 | + if ($a[$part] != $b[$part]) { |
|
| 1137 | 1137 | return false; |
| 1138 | 1138 | } |
| 1139 | 1139 | } |
@@ -1141,7 +1141,7 @@ discard block |
||
| 1141 | 1141 | return true; |
| 1142 | 1142 | } |
| 1143 | 1143 | |
| 1144 | - public function fillWhite($x=0, $y=0) |
|
| 1144 | + public function fillWhite($x = 0, $y = 0) |
|
| 1145 | 1145 | { |
| 1146 | 1146 | $this->addRGBColor('white', 255, 255, 255); |
| 1147 | 1147 | return $this->fill('white', $x, $y); |
@@ -1161,11 +1161,11 @@ discard block |
||
| 1161 | 1161 | self::requireResource($resource); |
| 1162 | 1162 | |
| 1163 | 1163 | $transparent = imagecolorallocatealpha($resource, 89, 14, 207, 127); |
| 1164 | - imagecolortransparent ($resource, $transparent); |
|
| 1164 | + imagecolortransparent($resource, $transparent); |
|
| 1165 | 1165 | imagefill($resource, 0, 0, $transparent); |
| 1166 | 1166 | } |
| 1167 | 1167 | |
| 1168 | - public function fill($colorName, $x=0, $y=0) |
|
| 1168 | + public function fill($colorName, $x = 0, $y = 0) |
|
| 1169 | 1169 | { |
| 1170 | 1170 | imagefill($this->newImage, $x, $y, $this->colors[$colorName]); |
| 1171 | 1171 | return $this; |
@@ -1179,7 +1179,7 @@ discard block |
||
| 1179 | 1179 | return $this; |
| 1180 | 1180 | } |
| 1181 | 1181 | |
| 1182 | - public function textTTF($text, $size, $colorName, $x=0, $y=0, $angle=0) |
|
| 1182 | + public function textTTF($text, $size, $colorName, $x = 0, $y = 0, $angle = 0) |
|
| 1183 | 1183 | { |
| 1184 | 1184 | imagealphablending($this->newImage, true); |
| 1185 | 1185 | |
@@ -1198,11 +1198,11 @@ discard block |
||
| 1198 | 1198 | return $this->newImage; |
| 1199 | 1199 | } |
| 1200 | 1200 | |
| 1201 | - public function paste(ImageHelper $target, $xpos=0, $ypos=0, $sourceX=0, $sourceY=0) |
|
| 1201 | + public function paste(ImageHelper $target, $xpos = 0, $ypos = 0, $sourceX = 0, $sourceY = 0) |
|
| 1202 | 1202 | { |
| 1203 | 1203 | $img = $target->getImage(); |
| 1204 | 1204 | |
| 1205 | - if($target->isAlpha()) { |
|
| 1205 | + if ($target->isAlpha()) { |
|
| 1206 | 1206 | $this->enableAlpha(); |
| 1207 | 1207 | } |
| 1208 | 1208 | |
@@ -1248,10 +1248,10 @@ discard block |
||
| 1248 | 1248 | public function fitText($text, $matchWidth) |
| 1249 | 1249 | { |
| 1250 | 1250 | $sizes = array(); |
| 1251 | - for($i=1; $i<=1000; $i=$i+0.1) { |
|
| 1251 | + for ($i = 1; $i <= 1000; $i = $i + 0.1) { |
|
| 1252 | 1252 | $size = $this->calcTextSize($text, $i); |
| 1253 | 1253 | $sizes[] = $size; |
| 1254 | - if($size['width'] >= $matchWidth) { |
|
| 1254 | + if ($size['width'] >= $matchWidth) { |
|
| 1255 | 1255 | break; |
| 1256 | 1256 | } |
| 1257 | 1257 | } |
@@ -1263,7 +1263,7 @@ discard block |
||
| 1263 | 1263 | $diffLast = $last['width'] - $matchWidth; |
| 1264 | 1264 | $diffPrev = $matchWidth - $prev['width']; |
| 1265 | 1265 | |
| 1266 | - if($diffLast <= $diffPrev) { |
|
| 1266 | + if ($diffLast <= $diffPrev) { |
|
| 1267 | 1267 | return $last; |
| 1268 | 1268 | } |
| 1269 | 1269 | |
@@ -1291,14 +1291,14 @@ discard block |
||
| 1291 | 1291 | 'bottom_left_y' => $box[1], |
| 1292 | 1292 | 'bottom_right_x' => $box[2], |
| 1293 | 1293 | 'bottom_right_y' => $box[3], |
| 1294 | - 'width' => $right-$left, |
|
| 1295 | - 'height' => $bottom-$top |
|
| 1294 | + 'width' => $right - $left, |
|
| 1295 | + 'height' => $bottom - $top |
|
| 1296 | 1296 | ); |
| 1297 | 1297 | } |
| 1298 | 1298 | |
| 1299 | 1299 | protected function requireTTFFont() |
| 1300 | 1300 | { |
| 1301 | - if(isset($this->TTFFile)) { |
|
| 1301 | + if (isset($this->TTFFile)) { |
|
| 1302 | 1302 | return; |
| 1303 | 1303 | } |
| 1304 | 1304 | |
@@ -1333,7 +1333,7 @@ discard block |
||
| 1333 | 1333 | */ |
| 1334 | 1334 | public static function getImageSize($pathOrResource) : ImageHelper_Size |
| 1335 | 1335 | { |
| 1336 | - if(is_resource($pathOrResource)) |
|
| 1336 | + if (is_resource($pathOrResource)) |
|
| 1337 | 1337 | { |
| 1338 | 1338 | return new ImageHelper_Size(array( |
| 1339 | 1339 | 'width' => imagesx($pathOrResource), |
@@ -1347,7 +1347,7 @@ discard block |
||
| 1347 | 1347 | |
| 1348 | 1348 | $info = false; |
| 1349 | 1349 | $method = 'getImageSize_'.$type; |
| 1350 | - if(method_exists(__CLASS__, $method)) |
|
| 1350 | + if (method_exists(__CLASS__, $method)) |
|
| 1351 | 1351 | { |
| 1352 | 1352 | $info = call_user_func(array(__CLASS__, $method), $pathOrResource); |
| 1353 | 1353 | } |
@@ -1356,7 +1356,7 @@ discard block |
||
| 1356 | 1356 | $info = getimagesize($pathOrResource); |
| 1357 | 1357 | } |
| 1358 | 1358 | |
| 1359 | - if($info !== false) { |
|
| 1359 | + if ($info !== false) { |
|
| 1360 | 1360 | return new ImageHelper_Size($info); |
| 1361 | 1361 | } |
| 1362 | 1362 | |
@@ -1382,7 +1382,7 @@ discard block |
||
| 1382 | 1382 | $xml = XMLHelper::createSimplexml(); |
| 1383 | 1383 | $xml->loadFile($imagePath); |
| 1384 | 1384 | |
| 1385 | - if($xml->hasErrors()) { |
|
| 1385 | + if ($xml->hasErrors()) { |
|
| 1386 | 1386 | throw new ImageHelper_Exception( |
| 1387 | 1387 | 'Error opening SVG image', |
| 1388 | 1388 | sprintf( |
@@ -1397,7 +1397,7 @@ discard block |
||
| 1397 | 1397 | $xml->dispose(); |
| 1398 | 1398 | unset($xml); |
| 1399 | 1399 | |
| 1400 | - if(!isset($data['@attributes']) || !isset($data['@attributes']['viewBox'])) { |
|
| 1400 | + if (!isset($data['@attributes']) || !isset($data['@attributes']['viewBox'])) { |
|
| 1401 | 1401 | throw new ImageHelper_Exception( |
| 1402 | 1402 | 'SVG Image is corrupted', |
| 1403 | 1403 | sprintf( |
@@ -1414,7 +1414,7 @@ discard block |
||
| 1414 | 1414 | $viewBox = str_replace(' ', ',', $data['@attributes']['viewBox']); |
| 1415 | 1415 | $size = explode(',', $viewBox); |
| 1416 | 1416 | |
| 1417 | - if(count($size) != 4) |
|
| 1417 | + if (count($size) != 4) |
|
| 1418 | 1418 | { |
| 1419 | 1419 | throw new ImageHelper_Exception( |
| 1420 | 1420 | 'SVG image has an invalid viewBox attribute', |
@@ -1460,7 +1460,7 @@ discard block |
||
| 1460 | 1460 | * @param integer $y |
| 1461 | 1461 | * @return ImageHelper |
| 1462 | 1462 | */ |
| 1463 | - public function crop(int $width, int $height, int $x=0, int $y=0) : ImageHelper |
|
| 1463 | + public function crop(int $width, int $height, int $x = 0, int $y = 0) : ImageHelper |
|
| 1464 | 1464 | { |
| 1465 | 1465 | $new = $this->createNewImage($width, $height); |
| 1466 | 1466 | |
@@ -1497,7 +1497,7 @@ discard block |
||
| 1497 | 1497 | * @see ImageHelper::calcAverageColorRGB() |
| 1498 | 1498 | * @see ImageHelper::calcAverageColorHEX() |
| 1499 | 1499 | */ |
| 1500 | - public function calcAverageColor(int $format=self::COLORFORMAT_RGB) |
|
| 1500 | + public function calcAverageColor(int $format = self::COLORFORMAT_RGB) |
|
| 1501 | 1501 | { |
| 1502 | 1502 | $image = $this->duplicate(); |
| 1503 | 1503 | $image->resample(1, 1); |
@@ -1516,7 +1516,7 @@ discard block |
||
| 1516 | 1516 | public function calcAverageColorRGB() : array |
| 1517 | 1517 | { |
| 1518 | 1518 | $result = $this->calcAverageColor(self::COLORFORMAT_RGB); |
| 1519 | - if(is_array($result)) { |
|
| 1519 | + if (is_array($result)) { |
|
| 1520 | 1520 | return $result; |
| 1521 | 1521 | } |
| 1522 | 1522 | |
@@ -1537,7 +1537,7 @@ discard block |
||
| 1537 | 1537 | public function calcAverageColorHex() : string |
| 1538 | 1538 | { |
| 1539 | 1539 | $result = $this->calcAverageColor(self::COLORFORMAT_HEX); |
| 1540 | - if(is_string($result)) { |
|
| 1540 | + if (is_string($result)) { |
|
| 1541 | 1541 | return $result; |
| 1542 | 1542 | } |
| 1543 | 1543 | |
@@ -1574,9 +1574,9 @@ discard block |
||
| 1574 | 1574 | * @see ImageHelper::COLORFORMAT_RGB |
| 1575 | 1575 | * @see ImageHelper::COLORFORMAT_HEX |
| 1576 | 1576 | */ |
| 1577 | - public function getColorAt(int $x, int $y, int $format=self::COLORFORMAT_RGB) |
|
| 1577 | + public function getColorAt(int $x, int $y, int $format = self::COLORFORMAT_RGB) |
|
| 1578 | 1578 | { |
| 1579 | - if($x > $this->getWidth() || $y > $this->getHeight()) |
|
| 1579 | + if ($x > $this->getWidth() || $y > $this->getHeight()) |
|
| 1580 | 1580 | { |
| 1581 | 1581 | throw new ImageHelper_Exception( |
| 1582 | 1582 | 'Position out of bounds', |
@@ -1594,7 +1594,7 @@ discard block |
||
| 1594 | 1594 | $idx = imagecolorat($this->newImage, $x, $y); |
| 1595 | 1595 | $rgb = $this->getIndexedColors($this->newImage, $idx); |
| 1596 | 1596 | |
| 1597 | - if($format == self::COLORFORMAT_HEX) { |
|
| 1597 | + if ($format == self::COLORFORMAT_HEX) { |
|
| 1598 | 1598 | return self::rgb2hex($rgb); |
| 1599 | 1599 | } |
| 1600 | 1600 | |
@@ -1609,7 +1609,7 @@ discard block |
||
| 1609 | 1609 | */ |
| 1610 | 1610 | public static function rgb2luma(array $rgb) : int |
| 1611 | 1611 | { |
| 1612 | - return (int)floor((($rgb['red']*2)+$rgb['blue']+($rgb['green']*3))/6); |
|
| 1612 | + return (int)floor((($rgb['red'] * 2) + $rgb['blue'] + ($rgb['green'] * 3)) / 6); |
|
| 1613 | 1613 | } |
| 1614 | 1614 | |
| 1615 | 1615 | /** |
@@ -181,8 +181,7 @@ discard block |
||
| 181 | 181 | if($datefrom instanceof \DateTime) |
| 182 | 182 | { |
| 183 | 183 | $converter->setDateFrom($datefrom); |
| 184 | - } |
|
| 185 | - else |
|
| 184 | + } else |
|
| 186 | 185 | { |
| 187 | 186 | $converter->setDateFrom(self::timestamp2date($datefrom)); |
| 188 | 187 | } |
@@ -190,8 +189,7 @@ discard block |
||
| 190 | 189 | if($dateto instanceof \DateTime) |
| 191 | 190 | { |
| 192 | 191 | $converter->setDateTo($dateto); |
| 193 | - } |
|
| 194 | - else if($dateto > 0) |
|
| 192 | + } else if($dateto > 0) |
|
| 195 | 193 | { |
| 196 | 194 | $converter->setDateTo(self::timestamp2date($dateto)); |
| 197 | 195 | } |
@@ -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); |
@@ -57,7 +57,7 @@ discard block |
||
| 57 | 57 | $amount = substr_count($line, "\t") - $min; |
| 58 | 58 | $line = trim($line); |
| 59 | 59 | if ($amount >= 1) { |
| 60 | - $line = str_repeat("\t", $amount) . $line; |
|
| 60 | + $line = str_repeat("\t", $amount).$line; |
|
| 61 | 61 | } |
| 62 | 62 | |
| 63 | 63 | $converted[] = $line; |
@@ -129,10 +129,10 @@ discard block |
||
| 129 | 129 | |
| 130 | 130 | // specifically handle zero |
| 131 | 131 | if ($seconds <= 0) { |
| 132 | - return '0 ' . t('seconds'); |
|
| 132 | + return '0 '.t('seconds'); |
|
| 133 | 133 | } |
| 134 | 134 | |
| 135 | - if($seconds < 1) { |
|
| 135 | + if ($seconds < 1) { |
|
| 136 | 136 | return t('less than a second'); |
| 137 | 137 | } |
| 138 | 138 | |
@@ -140,7 +140,7 @@ discard block |
||
| 140 | 140 | foreach ($units as $def) { |
| 141 | 141 | $quot = intval($seconds / $def['value']); |
| 142 | 142 | if ($quot) { |
| 143 | - $item = $quot . ' '; |
|
| 143 | + $item = $quot.' '; |
|
| 144 | 144 | if (abs($quot) > 1) { |
| 145 | 145 | $item .= $def['plural']; |
| 146 | 146 | } else { |
@@ -157,7 +157,7 @@ discard block |
||
| 157 | 157 | return $last; |
| 158 | 158 | } |
| 159 | 159 | |
| 160 | - return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last; |
|
| 160 | + return implode(', ', $tokens).' '.t('and').' '.$last; |
|
| 161 | 161 | } |
| 162 | 162 | |
| 163 | 163 | /** |
@@ -176,7 +176,7 @@ discard block |
||
| 176 | 176 | { |
| 177 | 177 | $converter = new ConvertHelper_DurationConverter(); |
| 178 | 178 | |
| 179 | - if($datefrom instanceof \DateTime) |
|
| 179 | + if ($datefrom instanceof \DateTime) |
|
| 180 | 180 | { |
| 181 | 181 | $converter->setDateFrom($datefrom); |
| 182 | 182 | } |
@@ -185,11 +185,11 @@ discard block |
||
| 185 | 185 | $converter->setDateFrom(self::timestamp2date($datefrom)); |
| 186 | 186 | } |
| 187 | 187 | |
| 188 | - if($dateto instanceof \DateTime) |
|
| 188 | + if ($dateto instanceof \DateTime) |
|
| 189 | 189 | { |
| 190 | 190 | $converter->setDateTo($dateto); |
| 191 | 191 | } |
| 192 | - else if($dateto > 0) |
|
| 192 | + else if ($dateto > 0) |
|
| 193 | 193 | { |
| 194 | 194 | $converter->setDateTo(self::timestamp2date($dateto)); |
| 195 | 195 | } |
@@ -209,9 +209,9 @@ discard block |
||
| 209 | 209 | return $geshi->parse_code(); |
| 210 | 210 | } |
| 211 | 211 | |
| 212 | - public static function highlight_xml($xml, $formatSource=false) |
|
| 212 | + public static function highlight_xml($xml, $formatSource = false) |
|
| 213 | 213 | { |
| 214 | - if($formatSource) |
|
| 214 | + if ($formatSource) |
|
| 215 | 215 | { |
| 216 | 216 | $dom = new \DOMDocument(); |
| 217 | 217 | $dom->loadXML($xml); |
@@ -278,34 +278,34 @@ discard block |
||
| 278 | 278 | return $text; |
| 279 | 279 | } |
| 280 | 280 | |
| 281 | - $text = trim(mb_substr($text, 0, $targetLength)) . $append; |
|
| 281 | + $text = trim(mb_substr($text, 0, $targetLength)).$append; |
|
| 282 | 282 | |
| 283 | 283 | return $text; |
| 284 | 284 | } |
| 285 | 285 | |
| 286 | - public static function var_dump($var, $html=true) |
|
| 286 | + public static function var_dump($var, $html = true) |
|
| 287 | 287 | { |
| 288 | 288 | $info = parseVariable($var); |
| 289 | 289 | |
| 290 | - if($html) { |
|
| 290 | + if ($html) { |
|
| 291 | 291 | return $info->toHTML(); |
| 292 | 292 | } |
| 293 | 293 | |
| 294 | 294 | return $info->toString(); |
| 295 | 295 | } |
| 296 | 296 | |
| 297 | - public static function print_r($var, $return=false, $html=true) |
|
| 297 | + public static function print_r($var, $return = false, $html = true) |
|
| 298 | 298 | { |
| 299 | 299 | $result = self::var_dump($var, $html); |
| 300 | 300 | |
| 301 | - if($html) { |
|
| 301 | + if ($html) { |
|
| 302 | 302 | $result = |
| 303 | 303 | '<pre style="background:#fff;color:#333;padding:16px;border:solid 1px #bbb;border-radius:4px">'. |
| 304 | 304 | $result. |
| 305 | 305 | '</pre>'; |
| 306 | 306 | } |
| 307 | 307 | |
| 308 | - if($return) { |
|
| 308 | + if ($return) { |
|
| 309 | 309 | return $result; |
| 310 | 310 | } |
| 311 | 311 | |
@@ -325,7 +325,7 @@ discard block |
||
| 325 | 325 | |
| 326 | 326 | public static function string2bool($string) |
| 327 | 327 | { |
| 328 | - if($string === '' || $string === null) { |
|
| 328 | + if ($string === '' || $string === null) { |
|
| 329 | 329 | return false; |
| 330 | 330 | } |
| 331 | 331 | |
@@ -380,10 +380,10 @@ discard block |
||
| 380 | 380 | public static function date2listLabel(\DateTime $date, $includeTime = false, $shortMonth = false) |
| 381 | 381 | { |
| 382 | 382 | $today = new \DateTime(); |
| 383 | - if($date->format('d.m.Y') == $today->format('d.m.Y')) { |
|
| 383 | + if ($date->format('d.m.Y') == $today->format('d.m.Y')) { |
|
| 384 | 384 | $label = t('Today'); |
| 385 | 385 | } else { |
| 386 | - $label = $date->format('d') . '. ' . self::month2string((int)$date->format('m'), $shortMonth) . ' '; |
|
| 386 | + $label = $date->format('d').'. '.self::month2string((int)$date->format('m'), $shortMonth).' '; |
|
| 387 | 387 | if ($date->format('Y') != date('Y')) { |
| 388 | 388 | $label .= $date->format('Y'); |
| 389 | 389 | } |
@@ -474,28 +474,28 @@ discard block |
||
| 474 | 474 | $hexAlphabet = array('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'); |
| 475 | 475 | |
| 476 | 476 | $stack = array(); |
| 477 | - foreach(self::$controlChars as $char) |
|
| 477 | + foreach (self::$controlChars as $char) |
|
| 478 | 478 | { |
| 479 | 479 | $tokens = explode('-', $char); |
| 480 | 480 | $start = $tokens[0]; |
| 481 | 481 | $end = $tokens[1]; |
| 482 | 482 | $prefix = substr($start, 0, 3); |
| 483 | 483 | $range = array(); |
| 484 | - foreach($hexAlphabet as $number) { |
|
| 484 | + foreach ($hexAlphabet as $number) { |
|
| 485 | 485 | $range[] = $prefix.$number; |
| 486 | 486 | } |
| 487 | 487 | |
| 488 | 488 | $use = false; |
| 489 | - foreach($range as $number) { |
|
| 490 | - if($number == $start) { |
|
| 489 | + foreach ($range as $number) { |
|
| 490 | + if ($number == $start) { |
|
| 491 | 491 | $use = true; |
| 492 | 492 | } |
| 493 | 493 | |
| 494 | - if($use) { |
|
| 494 | + if ($use) { |
|
| 495 | 495 | $stack[] = $number; |
| 496 | 496 | } |
| 497 | 497 | |
| 498 | - if($number == $end) { |
|
| 498 | + if ($number == $end) { |
|
| 499 | 499 | break; |
| 500 | 500 | } |
| 501 | 501 | } |
@@ -516,7 +516,7 @@ discard block |
||
| 516 | 516 | $chars = self::getControlCharactersAsHex(); |
| 517 | 517 | |
| 518 | 518 | $result = array(); |
| 519 | - foreach($chars as $char) { |
|
| 519 | + foreach ($chars as $char) { |
|
| 520 | 520 | $result[] = hex2bin($char); |
| 521 | 521 | } |
| 522 | 522 | |
@@ -534,14 +534,14 @@ discard block |
||
| 534 | 534 | $chars = self::getControlCharactersAsHex(); |
| 535 | 535 | |
| 536 | 536 | $result = array(); |
| 537 | - foreach($chars as $char) { |
|
| 537 | + foreach ($chars as $char) { |
|
| 538 | 538 | $result[] = '\u'.strtolower($char); |
| 539 | 539 | } |
| 540 | 540 | |
| 541 | 541 | return $result; |
| 542 | 542 | } |
| 543 | 543 | |
| 544 | - protected static $controlChars = array( |
|
| 544 | + protected static $controlChars = array( |
|
| 545 | 545 | '0000-0008', // control chars |
| 546 | 546 | '000E-000F', // control chars |
| 547 | 547 | '0010-001F', // control chars |
@@ -563,19 +563,19 @@ discard block |
||
| 563 | 563 | */ |
| 564 | 564 | public static function stripControlCharacters(string $string) : string |
| 565 | 565 | { |
| 566 | - if(empty($string)) { |
|
| 566 | + if (empty($string)) { |
|
| 567 | 567 | return $string; |
| 568 | 568 | } |
| 569 | 569 | |
| 570 | 570 | // create the regex from the unicode characters list |
| 571 | - if(!isset(self::$controlCharsRegex)) |
|
| 571 | + if (!isset(self::$controlCharsRegex)) |
|
| 572 | 572 | { |
| 573 | 573 | $chars = self::getControlCharactersAsHex(); |
| 574 | 574 | |
| 575 | 575 | // we use the notation \x{0000} to specify the unicode character key |
| 576 | 576 | // in the regular expression. |
| 577 | 577 | $stack = array(); |
| 578 | - foreach($chars as $char) { |
|
| 578 | + foreach ($chars as $char) { |
|
| 579 | 579 | $stack[] = '\x{'.$char.'}'; |
| 580 | 580 | } |
| 581 | 581 | |
@@ -609,7 +609,7 @@ discard block |
||
| 609 | 609 | $ordInt = ord($octet); |
| 610 | 610 | // Convert from int (base 10) to hex (base 16), for PHP \x syntax |
| 611 | 611 | $ordHex = base_convert($ordInt, 10, 16); |
| 612 | - $output .= '\x' . $ordHex; |
|
| 612 | + $output .= '\x'.$ordHex; |
|
| 613 | 613 | } |
| 614 | 614 | return $output; |
| 615 | 615 | } |
@@ -641,19 +641,19 @@ discard block |
||
| 641 | 641 | |
| 642 | 642 | protected static function convertScalarForComparison($scalar) |
| 643 | 643 | { |
| 644 | - if($scalar === '' || is_null($scalar)) { |
|
| 644 | + if ($scalar === '' || is_null($scalar)) { |
|
| 645 | 645 | return null; |
| 646 | 646 | } |
| 647 | 647 | |
| 648 | - if(is_bool($scalar)) { |
|
| 648 | + if (is_bool($scalar)) { |
|
| 649 | 649 | return self::bool2string($scalar); |
| 650 | 650 | } |
| 651 | 651 | |
| 652 | - if(is_array($scalar)) { |
|
| 652 | + if (is_array($scalar)) { |
|
| 653 | 653 | $scalar = md5(serialize($scalar)); |
| 654 | 654 | } |
| 655 | 655 | |
| 656 | - if($scalar !== null && !is_scalar($scalar)) { |
|
| 656 | + if ($scalar !== null && !is_scalar($scalar)) { |
|
| 657 | 657 | throw new ConvertHelper_Exception( |
| 658 | 658 | 'Not a scalar value in comparison', |
| 659 | 659 | null, |
@@ -702,7 +702,7 @@ discard block |
||
| 702 | 702 | public static function bool2string($boolean, bool $yesno = false) : string |
| 703 | 703 | { |
| 704 | 704 | // allow 'yes', 'true', 'no', 'false' string notations as well |
| 705 | - if(!is_bool($boolean)) { |
|
| 705 | + if (!is_bool($boolean)) { |
|
| 706 | 706 | $boolean = self::string2bool($boolean); |
| 707 | 707 | } |
| 708 | 708 | |
@@ -743,15 +743,15 @@ discard block |
||
| 743 | 743 | public static function array2attributeString($array) |
| 744 | 744 | { |
| 745 | 745 | $tokens = array(); |
| 746 | - foreach($array as $attr => $value) { |
|
| 747 | - if($value == '' || $value == null) { |
|
| 746 | + foreach ($array as $attr => $value) { |
|
| 747 | + if ($value == '' || $value == null) { |
|
| 748 | 748 | continue; |
| 749 | 749 | } |
| 750 | 750 | |
| 751 | 751 | $tokens[] = $attr.'="'.$value.'"'; |
| 752 | 752 | } |
| 753 | 753 | |
| 754 | - if(empty($tokens)) { |
|
| 754 | + if (empty($tokens)) { |
|
| 755 | 755 | return ''; |
| 756 | 756 | } |
| 757 | 757 | |
@@ -766,10 +766,10 @@ discard block |
||
| 766 | 766 | * @param string $string |
| 767 | 767 | * @return string |
| 768 | 768 | */ |
| 769 | - public static function string2attributeJS($string, $quoted=true) |
|
| 769 | + public static function string2attributeJS($string, $quoted = true) |
|
| 770 | 770 | { |
| 771 | 771 | $converted = addslashes(htmlspecialchars(strip_tags($string), ENT_QUOTES, 'UTF-8')); |
| 772 | - if($quoted) { |
|
| 772 | + if ($quoted) { |
|
| 773 | 773 | $converted = "'".$converted."'"; |
| 774 | 774 | } |
| 775 | 775 | |
@@ -787,11 +787,11 @@ discard block |
||
| 787 | 787 | */ |
| 788 | 788 | public static function isBoolean($value) : bool |
| 789 | 789 | { |
| 790 | - if(is_bool($value)) { |
|
| 790 | + if (is_bool($value)) { |
|
| 791 | 791 | return true; |
| 792 | 792 | } |
| 793 | 793 | |
| 794 | - if(!is_scalar($value)) { |
|
| 794 | + if (!is_scalar($value)) { |
|
| 795 | 795 | return false; |
| 796 | 796 | } |
| 797 | 797 | |
@@ -807,7 +807,7 @@ discard block |
||
| 807 | 807 | public static function array2styleString(array $subject) : string |
| 808 | 808 | { |
| 809 | 809 | $tokens = array(); |
| 810 | - foreach($subject as $name => $value) { |
|
| 810 | + foreach ($subject as $name => $value) { |
|
| 811 | 811 | $tokens[] = $name.':'.$value; |
| 812 | 812 | } |
| 813 | 813 | |
@@ -865,7 +865,7 @@ discard block |
||
| 865 | 865 | * |
| 866 | 866 | * @see JSHelper::buildRegexStatement() |
| 867 | 867 | */ |
| 868 | - public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) |
|
| 868 | + public static function regex2js(string $regex, string $statementType = JSHelper::JS_REGEX_OBJECT) |
|
| 869 | 869 | { |
| 870 | 870 | return JSHelper::buildRegexStatement($regex, $statementType); |
| 871 | 871 | } |
@@ -882,11 +882,11 @@ discard block |
||
| 882 | 882 | * @throws ConvertHelper_Exception |
| 883 | 883 | * @return string |
| 884 | 884 | */ |
| 885 | - public static function var2json($variable, int $options=0, int $depth=512) : string |
|
| 885 | + public static function var2json($variable, int $options = 0, int $depth = 512) : string |
|
| 886 | 886 | { |
| 887 | 887 | $result = json_encode($variable, $options, $depth); |
| 888 | 888 | |
| 889 | - if($result !== false) { |
|
| 889 | + if ($result !== false) { |
|
| 890 | 890 | return $result; |
| 891 | 891 | } |
| 892 | 892 | |
@@ -911,10 +911,10 @@ discard block |
||
| 911 | 911 | public static function stripUTFBom($string) |
| 912 | 912 | { |
| 913 | 913 | $boms = FileHelper::getUTFBOMs(); |
| 914 | - foreach($boms as $bomChars) { |
|
| 914 | + foreach ($boms as $bomChars) { |
|
| 915 | 915 | $length = mb_strlen($bomChars); |
| 916 | 916 | $text = mb_substr($string, 0, $length); |
| 917 | - if($text==$bomChars) { |
|
| 917 | + if ($text == $bomChars) { |
|
| 918 | 918 | return mb_substr($string, $length); |
| 919 | 919 | } |
| 920 | 920 | } |
@@ -931,7 +931,7 @@ discard block |
||
| 931 | 931 | */ |
| 932 | 932 | public static function string2utf8($string) |
| 933 | 933 | { |
| 934 | - if(!self::isStringASCII($string)) { |
|
| 934 | + if (!self::isStringASCII($string)) { |
|
| 935 | 935 | return \ForceUTF8\Encoding::toUTF8($string); |
| 936 | 936 | } |
| 937 | 937 | |
@@ -949,11 +949,11 @@ discard block |
||
| 949 | 949 | */ |
| 950 | 950 | public static function isStringASCII($string) : bool |
| 951 | 951 | { |
| 952 | - if($string === '' || $string === NULL) { |
|
| 952 | + if ($string === '' || $string === NULL) { |
|
| 953 | 953 | return true; |
| 954 | 954 | } |
| 955 | 955 | |
| 956 | - if(!is_string($string)) { |
|
| 956 | + if (!is_string($string)) { |
|
| 957 | 957 | return false; |
| 958 | 958 | } |
| 959 | 959 | |
@@ -987,7 +987,7 @@ discard block |
||
| 987 | 987 | * @param array $options |
| 988 | 988 | * @return float |
| 989 | 989 | */ |
| 990 | - public static function matchString($source, $target, $options=array()) |
|
| 990 | + public static function matchString($source, $target, $options = array()) |
|
| 991 | 991 | { |
| 992 | 992 | $defaults = array( |
| 993 | 993 | 'maxLevenshtein' => 10, |
@@ -997,12 +997,12 @@ discard block |
||
| 997 | 997 | $options = array_merge($defaults, $options); |
| 998 | 998 | |
| 999 | 999 | // avoid doing this via levenshtein |
| 1000 | - if($source == $target) { |
|
| 1000 | + if ($source == $target) { |
|
| 1001 | 1001 | return 100; |
| 1002 | 1002 | } |
| 1003 | 1003 | |
| 1004 | 1004 | $diff = levenshtein($source, $target); |
| 1005 | - if($diff > $options['maxLevenshtein']) { |
|
| 1005 | + if ($diff > $options['maxLevenshtein']) { |
|
| 1006 | 1006 | return 0; |
| 1007 | 1007 | } |
| 1008 | 1008 | |
@@ -1086,24 +1086,24 @@ discard block |
||
| 1086 | 1086 | * @see ConvertHelper::INTERVAL_HOURS |
| 1087 | 1087 | * @see ConvertHelper::INTERVAL_DAYS |
| 1088 | 1088 | */ |
| 1089 | - public static function interval2total(\DateInterval $interval, $unit=self::INTERVAL_SECONDS) : int |
|
| 1089 | + public static function interval2total(\DateInterval $interval, $unit = self::INTERVAL_SECONDS) : int |
|
| 1090 | 1090 | { |
| 1091 | 1091 | $total = (int)$interval->format('%a'); |
| 1092 | 1092 | if ($unit == self::INTERVAL_DAYS) { |
| 1093 | 1093 | return $total; |
| 1094 | 1094 | } |
| 1095 | 1095 | |
| 1096 | - $total = ($total * 24) + ((int)$interval->h ); |
|
| 1096 | + $total = ($total * 24) + ((int)$interval->h); |
|
| 1097 | 1097 | if ($unit == self::INTERVAL_HOURS) { |
| 1098 | 1098 | return $total; |
| 1099 | 1099 | } |
| 1100 | 1100 | |
| 1101 | - $total = ($total * 60) + ((int)$interval->i ); |
|
| 1101 | + $total = ($total * 60) + ((int)$interval->i); |
|
| 1102 | 1102 | if ($unit == self::INTERVAL_MINUTES) { |
| 1103 | 1103 | return $total; |
| 1104 | 1104 | } |
| 1105 | 1105 | |
| 1106 | - $total = ($total * 60) + ((int)$interval->s ); |
|
| 1106 | + $total = ($total * 60) + ((int)$interval->s); |
|
| 1107 | 1107 | if ($unit == self::INTERVAL_SECONDS) { |
| 1108 | 1108 | return $total; |
| 1109 | 1109 | } |
@@ -1132,13 +1132,13 @@ discard block |
||
| 1132 | 1132 | * @param bool $short |
| 1133 | 1133 | * @return string|NULL |
| 1134 | 1134 | */ |
| 1135 | - public static function date2dayName(\DateTime $date, bool $short=false) |
|
| 1135 | + public static function date2dayName(\DateTime $date, bool $short = false) |
|
| 1136 | 1136 | { |
| 1137 | 1137 | $day = $date->format('l'); |
| 1138 | 1138 | $invariant = self::getDayNamesInvariant(); |
| 1139 | 1139 | |
| 1140 | 1140 | $idx = array_search($day, $invariant); |
| 1141 | - if($idx !== false) { |
|
| 1141 | + if ($idx !== false) { |
|
| 1142 | 1142 | $localized = self::getDayNames($short); |
| 1143 | 1143 | return $localized[$idx]; |
| 1144 | 1144 | } |
@@ -1161,10 +1161,10 @@ discard block |
||
| 1161 | 1161 | * @param bool $short |
| 1162 | 1162 | * @return array |
| 1163 | 1163 | */ |
| 1164 | - public static function getDayNames(bool $short=false) : array |
|
| 1164 | + public static function getDayNames(bool $short = false) : array |
|
| 1165 | 1165 | { |
| 1166 | - if($short) { |
|
| 1167 | - if(!isset(self::$daysShort)) { |
|
| 1166 | + if ($short) { |
|
| 1167 | + if (!isset(self::$daysShort)) { |
|
| 1168 | 1168 | self::$daysShort = array( |
| 1169 | 1169 | t('Mon'), |
| 1170 | 1170 | t('Tue'), |
@@ -1179,7 +1179,7 @@ discard block |
||
| 1179 | 1179 | return self::$daysShort; |
| 1180 | 1180 | } |
| 1181 | 1181 | |
| 1182 | - if(!isset(self::$days)) { |
|
| 1182 | + if (!isset(self::$days)) { |
|
| 1183 | 1183 | self::$days = array( |
| 1184 | 1184 | t('Monday'), |
| 1185 | 1185 | t('Tuesday'), |
@@ -1204,17 +1204,17 @@ discard block |
||
| 1204 | 1204 | */ |
| 1205 | 1205 | public static function implodeWithAnd(array $list, $sep = ', ', $conjunction = null) |
| 1206 | 1206 | { |
| 1207 | - if(empty($list)) { |
|
| 1207 | + if (empty($list)) { |
|
| 1208 | 1208 | return ''; |
| 1209 | 1209 | } |
| 1210 | 1210 | |
| 1211 | - if(empty($conjunction)) { |
|
| 1211 | + if (empty($conjunction)) { |
|
| 1212 | 1212 | $conjunction = t('and'); |
| 1213 | 1213 | } |
| 1214 | 1214 | |
| 1215 | 1215 | $last = array_pop($list); |
| 1216 | - if($list) { |
|
| 1217 | - return implode($sep, $list) . $conjunction . ' ' . $last; |
|
| 1216 | + if ($list) { |
|
| 1217 | + return implode($sep, $list).$conjunction.' '.$last; |
|
| 1218 | 1218 | } |
| 1219 | 1219 | |
| 1220 | 1220 | return $last; |
@@ -1233,7 +1233,7 @@ discard block |
||
| 1233 | 1233 | public static function string2array(string $string) : array |
| 1234 | 1234 | { |
| 1235 | 1235 | $result = preg_split('//u', $string, null, PREG_SPLIT_NO_EMPTY); |
| 1236 | - if($result !== false) { |
|
| 1236 | + if ($result !== false) { |
|
| 1237 | 1237 | return $result; |
| 1238 | 1238 | } |
| 1239 | 1239 | |
@@ -1248,12 +1248,12 @@ discard block |
||
| 1248 | 1248 | */ |
| 1249 | 1249 | public static function isStringHTML(string $string) : bool |
| 1250 | 1250 | { |
| 1251 | - if(preg_match('%<[a-z/][\s\S]*>%siU', $string)) { |
|
| 1251 | + if (preg_match('%<[a-z/][\s\S]*>%siU', $string)) { |
|
| 1252 | 1252 | return true; |
| 1253 | 1253 | } |
| 1254 | 1254 | |
| 1255 | 1255 | $decoded = html_entity_decode($string); |
| 1256 | - if($decoded !== $string) { |
|
| 1256 | + if ($decoded !== $string) { |
|
| 1257 | 1257 | return true; |
| 1258 | 1258 | } |
| 1259 | 1259 | |
@@ -1362,14 +1362,14 @@ discard block |
||
| 1362 | 1362 | * @param bool $caseInsensitive |
| 1363 | 1363 | * @return ConvertHelper_StringMatch[] |
| 1364 | 1364 | */ |
| 1365 | - public static function findString(string $needle, string $haystack, bool $caseInsensitive=false) |
|
| 1365 | + public static function findString(string $needle, string $haystack, bool $caseInsensitive = false) |
|
| 1366 | 1366 | { |
| 1367 | - if($needle === '') { |
|
| 1367 | + if ($needle === '') { |
|
| 1368 | 1368 | return array(); |
| 1369 | 1369 | } |
| 1370 | 1370 | |
| 1371 | 1371 | $function = 'mb_strpos'; |
| 1372 | - if($caseInsensitive) { |
|
| 1372 | + if ($caseInsensitive) { |
|
| 1373 | 1373 | $function = 'mb_stripos'; |
| 1374 | 1374 | } |
| 1375 | 1375 | |
@@ -1377,7 +1377,7 @@ discard block |
||
| 1377 | 1377 | $positions = array(); |
| 1378 | 1378 | $length = mb_strlen($needle); |
| 1379 | 1379 | |
| 1380 | - while( ($pos = $function($haystack, $needle, $pos)) !== false) |
|
| 1380 | + while (($pos = $function($haystack, $needle, $pos)) !== false) |
|
| 1381 | 1381 | { |
| 1382 | 1382 | $match = mb_substr($haystack, $pos, $length); |
| 1383 | 1383 | $positions[] = new ConvertHelper_StringMatch($pos, $match); |
@@ -1397,7 +1397,7 @@ discard block |
||
| 1397 | 1397 | */ |
| 1398 | 1398 | public static function explodeTrim(string $delimiter, string $string) : array |
| 1399 | 1399 | { |
| 1400 | - if(empty($string) || empty($delimiter)) { |
|
| 1400 | + if (empty($string) || empty($delimiter)) { |
|
| 1401 | 1401 | return array(); |
| 1402 | 1402 | } |
| 1403 | 1403 | |
@@ -1405,8 +1405,8 @@ discard block |
||
| 1405 | 1405 | $tokens = array_map('trim', $tokens); |
| 1406 | 1406 | |
| 1407 | 1407 | $keep = array(); |
| 1408 | - foreach($tokens as $token) { |
|
| 1409 | - if($token !== '') { |
|
| 1408 | + foreach ($tokens as $token) { |
|
| 1409 | + if ($token !== '') { |
|
| 1410 | 1410 | $keep[] = $token; |
| 1411 | 1411 | } |
| 1412 | 1412 | } |
@@ -1424,11 +1424,11 @@ discard block |
||
| 1424 | 1424 | */ |
| 1425 | 1425 | public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL |
| 1426 | 1426 | { |
| 1427 | - if(empty($subjectString)) { |
|
| 1427 | + if (empty($subjectString)) { |
|
| 1428 | 1428 | return null; |
| 1429 | 1429 | } |
| 1430 | 1430 | |
| 1431 | - if(!isset(self::$eolChars)) |
|
| 1431 | + if (!isset(self::$eolChars)) |
|
| 1432 | 1432 | { |
| 1433 | 1433 | $cr = chr((int)hexdec('0d')); |
| 1434 | 1434 | $lf = chr((int)hexdec('0a')); |
@@ -1459,18 +1459,18 @@ discard block |
||
| 1459 | 1459 | |
| 1460 | 1460 | $max = 0; |
| 1461 | 1461 | $results = array(); |
| 1462 | - foreach(self::$eolChars as $def) |
|
| 1462 | + foreach (self::$eolChars as $def) |
|
| 1463 | 1463 | { |
| 1464 | 1464 | $amount = substr_count($subjectString, $def['char']); |
| 1465 | 1465 | |
| 1466 | - if($amount > $max) |
|
| 1466 | + if ($amount > $max) |
|
| 1467 | 1467 | { |
| 1468 | 1468 | $max = $amount; |
| 1469 | 1469 | $results[] = $def; |
| 1470 | 1470 | } |
| 1471 | 1471 | } |
| 1472 | 1472 | |
| 1473 | - if(empty($results)) { |
|
| 1473 | + if (empty($results)) { |
|
| 1474 | 1474 | return null; |
| 1475 | 1475 | } |
| 1476 | 1476 | |
@@ -1490,9 +1490,9 @@ discard block |
||
| 1490 | 1490 | */ |
| 1491 | 1491 | public static function arrayRemoveKeys(array &$array, array $keys) : void |
| 1492 | 1492 | { |
| 1493 | - foreach($keys as $key) |
|
| 1493 | + foreach ($keys as $key) |
|
| 1494 | 1494 | { |
| 1495 | - if(array_key_exists($key, $array)) { |
|
| 1495 | + if (array_key_exists($key, $array)) { |
|
| 1496 | 1496 | unset($array[$key]); |
| 1497 | 1497 | } |
| 1498 | 1498 | } |
@@ -1507,17 +1507,17 @@ discard block |
||
| 1507 | 1507 | */ |
| 1508 | 1508 | public static function isInteger($value) : bool |
| 1509 | 1509 | { |
| 1510 | - if(is_int($value)) { |
|
| 1510 | + if (is_int($value)) { |
|
| 1511 | 1511 | return true; |
| 1512 | 1512 | } |
| 1513 | 1513 | |
| 1514 | 1514 | // booleans get converted to numbers, so they would |
| 1515 | 1515 | // actually match the regex. |
| 1516 | - if(is_bool($value)) { |
|
| 1516 | + if (is_bool($value)) { |
|
| 1517 | 1517 | return false; |
| 1518 | 1518 | } |
| 1519 | 1519 | |
| 1520 | - if(is_string($value) && $value !== '') { |
|
| 1520 | + if (is_string($value) && $value !== '') { |
|
| 1521 | 1521 | return preg_match('/\A-?\d+\z/', $value) === 1; |
| 1522 | 1522 | } |
| 1523 | 1523 | |
@@ -37,7 +37,7 @@ discard block |
||
| 37 | 37 | // extract parameter names from the query string |
| 38 | 38 | $result = array(); |
| 39 | 39 | preg_match_all('/&?([^&]+)=.*/sixU', $queryString, $result, PREG_PATTERN_ORDER); |
| 40 | - if(isset($result[1])) { |
|
| 40 | + if (isset($result[1])) { |
|
| 41 | 41 | $paramNames = $result[1]; |
| 42 | 42 | } |
| 43 | 43 | |
@@ -60,11 +60,11 @@ discard block |
||
| 60 | 60 | // possible naming conflicts like having both parameters "foo.bar" |
| 61 | 61 | // and "foo_bar" in the query string: since "foo.bar" would be converted |
| 62 | 62 | // to "foo_bar", one of the two would be replaced. |
| 63 | - if($fixRequired) |
|
| 63 | + if ($fixRequired) |
|
| 64 | 64 | { |
| 65 | 65 | $counter = 1; |
| 66 | 66 | $placeholders = array(); |
| 67 | - foreach($paramNames as $paramName) |
|
| 67 | + foreach ($paramNames as $paramName) |
|
| 68 | 68 | { |
| 69 | 69 | // create a unique placeholder name |
| 70 | 70 | $placeholder = '__PLACEHOLDER'.$counter.'__'; |
@@ -94,13 +94,13 @@ discard block |
||
| 94 | 94 | parse_str($queryString, $parsed); |
| 95 | 95 | |
| 96 | 96 | // do any of the parameter names need to be fixed? |
| 97 | - if(!$fixRequired) { |
|
| 97 | + if (!$fixRequired) { |
|
| 98 | 98 | return $parsed; |
| 99 | 99 | } |
| 100 | 100 | |
| 101 | 101 | $keep = array(); |
| 102 | 102 | |
| 103 | - foreach($parsed as $name => $value) |
|
| 103 | + foreach ($parsed as $name => $value) |
|
| 104 | 104 | { |
| 105 | 105 | $keep[$table[$name]] = $value; |
| 106 | 106 | } |
@@ -63,7 +63,7 @@ |
||
| 63 | 63 | return $this->getBoolOption('cut'); |
| 64 | 64 | } |
| 65 | 65 | |
| 66 | - public function setCuttingEnabled(bool $enabled=true) : ConvertHelper_WordWrapper |
|
| 66 | + public function setCuttingEnabled(bool $enabled = true) : ConvertHelper_WordWrapper |
|
| 67 | 67 | { |
| 68 | 68 | $this->setOption('cut', $enabled); |
| 69 | 69 | return $this; |
@@ -92,8 +92,7 @@ |
||
| 92 | 92 | if (mb_strlen($actual.$word) <= $width) |
| 93 | 93 | { |
| 94 | 94 | $actual .= $word.' '; |
| 95 | - } |
|
| 96 | - else |
|
| 95 | + } else |
|
| 97 | 96 | { |
| 98 | 97 | if ($actual != '') { |
| 99 | 98 | $line .= rtrim($actual).$break; |
@@ -37,14 +37,14 @@ discard block |
||
| 37 | 37 | const TOKEN_MONTHS = 'm'; |
| 38 | 38 | const TOKEN_YEARS = 'y'; |
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * @var \DateInterval |
|
| 42 | - */ |
|
| 40 | + /** |
|
| 41 | + * @var \DateInterval |
|
| 42 | + */ |
|
| 43 | 43 | protected $interval; |
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * @var int |
|
| 47 | - */ |
|
| 45 | + /** |
|
| 46 | + * @var int |
|
| 47 | + */ |
|
| 48 | 48 | protected $seconds; |
| 49 | 49 | |
| 50 | 50 | protected function __construct(int $seconds) |
@@ -69,33 +69,33 @@ discard block |
||
| 69 | 69 | $this->interval = $interval; |
| 70 | 70 | } |
| 71 | 71 | |
| 72 | - /** |
|
| 73 | - * Creates the interval from a specific amount of seconds. |
|
| 74 | - * |
|
| 75 | - * @param int $seconds |
|
| 76 | - * @return \AppUtils\ConvertHelper_DateInterval |
|
| 77 | - */ |
|
| 72 | + /** |
|
| 73 | + * Creates the interval from a specific amount of seconds. |
|
| 74 | + * |
|
| 75 | + * @param int $seconds |
|
| 76 | + * @return \AppUtils\ConvertHelper_DateInterval |
|
| 77 | + */ |
|
| 78 | 78 | public static function fromSeconds(int $seconds) |
| 79 | 79 | { |
| 80 | 80 | return new ConvertHelper_DateInterval($seconds); |
| 81 | 81 | } |
| 82 | 82 | |
| 83 | - /** |
|
| 84 | - * Creates the interval from an existing regular interval instance. |
|
| 85 | - * |
|
| 86 | - * @param \DateInterval $interval |
|
| 87 | - * @return \AppUtils\ConvertHelper_DateInterval |
|
| 88 | - */ |
|
| 83 | + /** |
|
| 84 | + * Creates the interval from an existing regular interval instance. |
|
| 85 | + * |
|
| 86 | + * @param \DateInterval $interval |
|
| 87 | + * @return \AppUtils\ConvertHelper_DateInterval |
|
| 88 | + */ |
|
| 89 | 89 | public static function fromInterval(\DateInterval $interval) |
| 90 | 90 | { |
| 91 | 91 | return self::fromSeconds(ConvertHelper::interval2seconds($interval)); |
| 92 | 92 | } |
| 93 | 93 | |
| 94 | - /** |
|
| 95 | - * Retrieves the PHP native date interval. |
|
| 96 | - * |
|
| 97 | - * @return \DateInterval |
|
| 98 | - */ |
|
| 94 | + /** |
|
| 95 | + * Retrieves the PHP native date interval. |
|
| 96 | + * |
|
| 97 | + * @return \DateInterval |
|
| 98 | + */ |
|
| 99 | 99 | public function getInterval() : \DateInterval |
| 100 | 100 | { |
| 101 | 101 | return $this->interval; |
@@ -131,31 +131,31 @@ discard block |
||
| 131 | 131 | return $this->getToken(self::TOKEN_YEARS); |
| 132 | 132 | } |
| 133 | 133 | |
| 134 | - /** |
|
| 135 | - * Retrieves a specific time token, e.g. "h" (for hours). |
|
| 136 | - * Using the constants to specifiy the tokens is recommended. |
|
| 137 | - * |
|
| 138 | - * @param string $token |
|
| 139 | - * @return int |
|
| 140 | - * |
|
| 141 | - * @see ConvertHelper_DateInterval::TOKEN_SECONDS |
|
| 142 | - * @see ConvertHelper_DateInterval::TOKEN_MINUTES |
|
| 143 | - * @see ConvertHelper_DateInterval::TOKEN_HOURS |
|
| 144 | - * @see ConvertHelper_DateInterval::TOKEN_DAYS |
|
| 145 | - * @see ConvertHelper_DateInterval::TOKEN_MONTHS |
|
| 146 | - * @see ConvertHelper_DateInterval::TOKEN_YEARS |
|
| 147 | - */ |
|
| 134 | + /** |
|
| 135 | + * Retrieves a specific time token, e.g. "h" (for hours). |
|
| 136 | + * Using the constants to specifiy the tokens is recommended. |
|
| 137 | + * |
|
| 138 | + * @param string $token |
|
| 139 | + * @return int |
|
| 140 | + * |
|
| 141 | + * @see ConvertHelper_DateInterval::TOKEN_SECONDS |
|
| 142 | + * @see ConvertHelper_DateInterval::TOKEN_MINUTES |
|
| 143 | + * @see ConvertHelper_DateInterval::TOKEN_HOURS |
|
| 144 | + * @see ConvertHelper_DateInterval::TOKEN_DAYS |
|
| 145 | + * @see ConvertHelper_DateInterval::TOKEN_MONTHS |
|
| 146 | + * @see ConvertHelper_DateInterval::TOKEN_YEARS |
|
| 147 | + */ |
|
| 148 | 148 | public function getToken(string $token) : int |
| 149 | 149 | { |
| 150 | 150 | return (int)$this->interval->$token; |
| 151 | 151 | } |
| 152 | 152 | |
| 153 | - /** |
|
| 154 | - * The total amount of seconds in the interval (including |
|
| 155 | - * everything, from seconds to days, months, years...). |
|
| 156 | - * |
|
| 157 | - * @return int |
|
| 158 | - */ |
|
| 153 | + /** |
|
| 154 | + * The total amount of seconds in the interval (including |
|
| 155 | + * everything, from seconds to days, months, years...). |
|
| 156 | + * |
|
| 157 | + * @return int |
|
| 158 | + */ |
|
| 159 | 159 | public function getTotalSeconds() : int |
| 160 | 160 | { |
| 161 | 161 | return $this->seconds; |
@@ -57,7 +57,7 @@ |
||
| 57 | 57 | |
| 58 | 58 | $interval = $d2->diff($d1); |
| 59 | 59 | |
| 60 | - if($interval === false) |
|
| 60 | + if ($interval === false) |
|
| 61 | 61 | { |
| 62 | 62 | throw new ConvertHelper_Exception( |
| 63 | 63 | 'Cannot create interval', |
@@ -63,7 +63,7 @@ discard block |
||
| 63 | 63 | |
| 64 | 64 | public function __construct() |
| 65 | 65 | { |
| 66 | - if(class_exists('\AppLocalize\Localization')) { |
|
| 66 | + if (class_exists('\AppLocalize\Localization')) { |
|
| 67 | 67 | \AppLocalize\Localization::onLocaleChanged(array($this, 'handle_localeChanged')); |
| 68 | 68 | } |
| 69 | 69 | } |
@@ -125,11 +125,11 @@ discard block |
||
| 125 | 125 | |
| 126 | 126 | $epoch = 'past'; |
| 127 | 127 | $key = 'singular'; |
| 128 | - if($this->dateDiff > 1) { |
|
| 128 | + if ($this->dateDiff > 1) { |
|
| 129 | 129 | $key = 'plural'; |
| 130 | 130 | } |
| 131 | 131 | |
| 132 | - if($this->future) { |
|
| 132 | + if ($this->future) { |
|
| 133 | 133 | $epoch = 'future'; |
| 134 | 134 | } |
| 135 | 135 | |
@@ -142,7 +142,7 @@ discard block |
||
| 142 | 142 | |
| 143 | 143 | protected function initTexts() |
| 144 | 144 | { |
| 145 | - if(isset(self::$texts)) { |
|
| 145 | + if (isset(self::$texts)) { |
|
| 146 | 146 | return; |
| 147 | 147 | } |
| 148 | 148 | |
@@ -228,7 +228,7 @@ discard block |
||
| 228 | 228 | $day = (int)date("j", $this->dateTo); |
| 229 | 229 | $year = (int)date("Y", $this->dateFrom); |
| 230 | 230 | |
| 231 | - while(mktime($hour, $min, $sec, $month + ($months_difference), $day, $year) < $this->dateTo) |
|
| 231 | + while (mktime($hour, $min, $sec, $month + ($months_difference), $day, $year) < $this->dateTo) |
|
| 232 | 232 | { |
| 233 | 233 | $months_difference++; |
| 234 | 234 | } |
@@ -248,7 +248,7 @@ discard block |
||
| 248 | 248 | |
| 249 | 249 | protected function resolveCalculations() : void |
| 250 | 250 | { |
| 251 | - if(!isset($this->dateFrom)) |
|
| 251 | + if (!isset($this->dateFrom)) |
|
| 252 | 252 | { |
| 253 | 253 | throw new ConvertHelper_Exception( |
| 254 | 254 | 'No date from has been specified.', |
@@ -258,7 +258,7 @@ discard block |
||
| 258 | 258 | } |
| 259 | 259 | |
| 260 | 260 | // no date to set? Assume we want to use today. |
| 261 | - if(!isset($this->dateTo)) |
|
| 261 | + if (!isset($this->dateTo)) |
|
| 262 | 262 | { |
| 263 | 263 | $this->dateTo = time(); |
| 264 | 264 | } |
@@ -337,7 +337,7 @@ discard block |
||
| 337 | 337 | |
| 338 | 338 | $difference = $this->dateTo - $this->dateFrom; |
| 339 | 339 | |
| 340 | - if($difference < 0) |
|
| 340 | + if ($difference < 0) |
|
| 341 | 341 | { |
| 342 | 342 | $difference = $difference * -1; |
| 343 | 343 | $this->future = true; |
@@ -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(); |
@@ -36,7 +36,7 @@ discard block |
||
| 36 | 36 | |
| 37 | 37 | public function __construct() |
| 38 | 38 | { |
| 39 | - if(class_exists('\AppLocalize\Localization')) { |
|
| 39 | + if (class_exists('\AppLocalize\Localization')) { |
|
| 40 | 40 | \AppLocalize\Localization::onLocaleChanged(array($this, 'handle_localeChanged')); |
| 41 | 41 | } |
| 42 | 42 | } |
@@ -69,17 +69,17 @@ discard block |
||
| 69 | 69 | $keep = $this->resolveTokens($interval); |
| 70 | 70 | |
| 71 | 71 | $parts = array(); |
| 72 | - foreach($keep as $token) |
|
| 72 | + foreach ($keep as $token) |
|
| 73 | 73 | { |
| 74 | 74 | $value = $interval->getToken($token); |
| 75 | - if($value === 0) { |
|
| 75 | + if ($value === 0) { |
|
| 76 | 76 | continue; |
| 77 | 77 | } |
| 78 | 78 | |
| 79 | 79 | $parts[] = $this->translateToken($token, $interval); |
| 80 | 80 | } |
| 81 | 81 | |
| 82 | - if(count($parts) == 1) { |
|
| 82 | + if (count($parts) == 1) { |
|
| 83 | 83 | return $parts[0]; |
| 84 | 84 | } |
| 85 | 85 | |
@@ -101,10 +101,10 @@ discard block |
||
| 101 | 101 | $value = $interval->getToken($token); |
| 102 | 102 | |
| 103 | 103 | $suffix = 'p'; |
| 104 | - if($value == 1) { $suffix = 's'; } |
|
| 104 | + if ($value == 1) { $suffix = 's'; } |
|
| 105 | 105 | $token .= $suffix; |
| 106 | 106 | |
| 107 | - if(!isset(self::$texts[$token])) |
|
| 107 | + if (!isset(self::$texts[$token])) |
|
| 108 | 108 | { |
| 109 | 109 | throw new ConvertHelper_Exception( |
| 110 | 110 | 'Missing interval translation', |
@@ -134,9 +134,9 @@ discard block |
||
| 134 | 134 | { |
| 135 | 135 | $offset = 0; |
| 136 | 136 | |
| 137 | - foreach($this->tokens as $token) |
|
| 137 | + foreach ($this->tokens as $token) |
|
| 138 | 138 | { |
| 139 | - if($interval->getToken($token) > 0) |
|
| 139 | + if ($interval->getToken($token) > 0) |
|
| 140 | 140 | { |
| 141 | 141 | return array_slice($this->tokens, $offset); |
| 142 | 142 | } |
@@ -152,7 +152,7 @@ discard block |
||
| 152 | 152 | */ |
| 153 | 153 | protected function initTexts() : void |
| 154 | 154 | { |
| 155 | - if(isset(self::$texts)) { |
|
| 155 | + if (isset(self::$texts)) { |
|
| 156 | 156 | return; |
| 157 | 157 | } |
| 158 | 158 | |
@@ -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)) { |
@@ -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( |
@@ -30,7 +30,7 @@ discard block |
||
| 30 | 30 | |
| 31 | 31 | const ERROR_OPENING_ZIP_FILE = 338003; |
| 32 | 32 | |
| 33 | - const ERROR_CANNOT_SAVE_FILE_TO_DISK =338004; |
|
| 33 | + const ERROR_CANNOT_SAVE_FILE_TO_DISK = 338004; |
|
| 34 | 34 | |
| 35 | 35 | protected $options = array( |
| 36 | 36 | 'WriteThreshold' => 100 |
@@ -80,7 +80,7 @@ discard block |
||
| 80 | 80 | * |
| 81 | 81 | * @see FileHelper::ERROR_SOURCE_FILE_DOES_NOT_EXIST |
| 82 | 82 | */ |
| 83 | - public function addFile(string $filePath, ?string $zipPath=null) : bool |
|
| 83 | + public function addFile(string $filePath, ?string $zipPath = null) : bool |
|
| 84 | 84 | { |
| 85 | 85 | $this->open(); |
| 86 | 86 | |
@@ -126,16 +126,16 @@ discard block |
||
| 126 | 126 | |
| 127 | 127 | protected function open() |
| 128 | 128 | { |
| 129 | - if($this->open) { |
|
| 129 | + if ($this->open) { |
|
| 130 | 130 | return; |
| 131 | 131 | } |
| 132 | 132 | |
| 133 | - if(!isset($this->zip)) { |
|
| 133 | + if (!isset($this->zip)) { |
|
| 134 | 134 | $this->zip = new \ZipArchive(); |
| 135 | 135 | } |
| 136 | 136 | |
| 137 | 137 | $flag = null; |
| 138 | - if(!file_exists($this->file)) { |
|
| 138 | + if (!file_exists($this->file)) { |
|
| 139 | 139 | $flag = \ZipArchive::CREATE; |
| 140 | 140 | } |
| 141 | 141 | |
@@ -175,7 +175,7 @@ discard block |
||
| 175 | 175 | { |
| 176 | 176 | $this->fileTracker++; |
| 177 | 177 | |
| 178 | - if($this->options['WriteThreshold'] < 1) { |
|
| 178 | + if ($this->options['WriteThreshold'] < 1) { |
|
| 179 | 179 | return; |
| 180 | 180 | } |
| 181 | 181 | |
@@ -188,7 +188,7 @@ discard block |
||
| 188 | 188 | |
| 189 | 189 | protected function close() |
| 190 | 190 | { |
| 191 | - if(!$this->open) { |
|
| 191 | + if (!$this->open) { |
|
| 192 | 192 | return; |
| 193 | 193 | } |
| 194 | 194 | |
@@ -197,8 +197,8 @@ discard block |
||
| 197 | 197 | throw new ZIPHelper_Exception( |
| 198 | 198 | 'Could not save ZIP file to disk', |
| 199 | 199 | sprintf( |
| 200 | - 'Tried saving the ZIP file [%1$s], but the write failed. This can have several causes, ' . |
|
| 201 | - 'including adding files that do not exist on disk, trying to create an empty zip, ' . |
|
| 200 | + 'Tried saving the ZIP file [%1$s], but the write failed. This can have several causes, '. |
|
| 201 | + 'including adding files that do not exist on disk, trying to create an empty zip, '. |
|
| 202 | 202 | 'or trying to save to a directory that does not exist.', |
| 203 | 203 | $this->file |
| 204 | 204 | ), |
@@ -213,7 +213,7 @@ discard block |
||
| 213 | 213 | { |
| 214 | 214 | $this->open(); |
| 215 | 215 | |
| 216 | - if($this->countFiles() < 1) |
|
| 216 | + if ($this->countFiles() < 1) |
|
| 217 | 217 | { |
| 218 | 218 | throw new ZIPHelper_Exception( |
| 219 | 219 | 'No files in the zip file', |
@@ -237,17 +237,17 @@ discard block |
||
| 237 | 237 | * @throws ZIPHelper_Exception |
| 238 | 238 | * @return string The file name that was sent (useful in case none was specified). |
| 239 | 239 | */ |
| 240 | - public function download(?string $fileName=null) : string |
|
| 240 | + public function download(?string $fileName = null) : string |
|
| 241 | 241 | { |
| 242 | 242 | $this->save(); |
| 243 | 243 | |
| 244 | - if(empty($fileName)) { |
|
| 244 | + if (empty($fileName)) { |
|
| 245 | 245 | $fileName = basename($this->file); |
| 246 | 246 | } |
| 247 | 247 | |
| 248 | 248 | header('Content-type: application/zip'); |
| 249 | - header('Content-Disposition: attachment; filename=' . $fileName); |
|
| 250 | - header('Content-length: ' . filesize($this->file)); |
|
| 249 | + header('Content-Disposition: attachment; filename='.$fileName); |
|
| 250 | + header('Content-length: '.filesize($this->file)); |
|
| 251 | 251 | header('Pragma: no-cache'); |
| 252 | 252 | header('Expires: 0'); |
| 253 | 253 | readfile($this->file); |
@@ -262,7 +262,7 @@ discard block |
||
| 262 | 262 | * @param string|NULL $fileName Override the ZIP's file name for the download |
| 263 | 263 | * @see ZIPHelper::download() |
| 264 | 264 | */ |
| 265 | - public function downloadAndDelete(?string $fileName=null) |
|
| 265 | + public function downloadAndDelete(?string $fileName = null) |
|
| 266 | 266 | { |
| 267 | 267 | $this->download($fileName); |
| 268 | 268 | |
@@ -277,9 +277,9 @@ discard block |
||
| 277 | 277 | * @param string|NULL $outputFolder If no folder is specified, uses the target file's folder. |
| 278 | 278 | * @return boolean |
| 279 | 279 | */ |
| 280 | - public function extractAll(?string $outputFolder=null) : bool |
|
| 280 | + public function extractAll(?string $outputFolder = null) : bool |
|
| 281 | 281 | { |
| 282 | - if(empty($outputFolder)) { |
|
| 282 | + if (empty($outputFolder)) { |
|
| 283 | 283 | $outputFolder = dirname($this->file); |
| 284 | 284 | } |
| 285 | 285 | |