@@ -50,20 +50,20 @@ discard block |
||
| 50 | 50 | |
| 51 | 51 | } |
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * Creates and returns a new instance of the CSV builder which |
|
| 55 | - * can be used to build CSV from scratch. |
|
| 56 | - * |
|
| 57 | - * @return CSVHelper_Builder |
|
| 58 | - */ |
|
| 53 | + /** |
|
| 54 | + * Creates and returns a new instance of the CSV builder which |
|
| 55 | + * can be used to build CSV from scratch. |
|
| 56 | + * |
|
| 57 | + * @return CSVHelper_Builder |
|
| 58 | + */ |
|
| 59 | 59 | public static function createBuilder() |
| 60 | 60 | { |
| 61 | 61 | return new CSVHelper_Builder(); |
| 62 | 62 | } |
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * @var string |
|
| 66 | - */ |
|
| 64 | + /** |
|
| 65 | + * @var string |
|
| 66 | + */ |
|
| 67 | 67 | protected $csv = ''; |
| 68 | 68 | |
| 69 | 69 | protected $data = array(); |
@@ -72,16 +72,16 @@ discard block |
||
| 72 | 72 | |
| 73 | 73 | protected $headersPosition = self::HEADERS_NONE; |
| 74 | 74 | |
| 75 | - /** |
|
| 76 | - * Loads CSV data from a string. |
|
| 77 | - * |
|
| 78 | - * Note: Use the {@link hasErrors()} method to |
|
| 79 | - * check if the string could be parsed correctly |
|
| 80 | - * afterwards. |
|
| 81 | - * |
|
| 82 | - * @param string $string |
|
| 83 | - * @return CSVHelper |
|
| 84 | - */ |
|
| 75 | + /** |
|
| 76 | + * Loads CSV data from a string. |
|
| 77 | + * |
|
| 78 | + * Note: Use the {@link hasErrors()} method to |
|
| 79 | + * check if the string could be parsed correctly |
|
| 80 | + * afterwards. |
|
| 81 | + * |
|
| 82 | + * @param string $string |
|
| 83 | + * @return CSVHelper |
|
| 84 | + */ |
|
| 85 | 85 | public function loadString($string) |
| 86 | 86 | { |
| 87 | 87 | // remove any UTF byte order marks that may still be present in the string |
@@ -95,20 +95,20 @@ discard block |
||
| 95 | 95 | return $this; |
| 96 | 96 | } |
| 97 | 97 | |
| 98 | - /** |
|
| 99 | - * Loads CSV data from a file. |
|
| 100 | - * |
|
| 101 | - * Note: Use the {@link hasErrors()} method to |
|
| 102 | - * check if the string could be parsed correctly |
|
| 103 | - * afterwards. |
|
| 104 | - * |
|
| 105 | - * @param string $file |
|
| 106 | - * @throws FileHelper_Exception |
|
| 107 | - * @return CSVHelper |
|
| 108 | - * |
|
| 109 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 110 | - * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
| 111 | - */ |
|
| 98 | + /** |
|
| 99 | + * Loads CSV data from a file. |
|
| 100 | + * |
|
| 101 | + * Note: Use the {@link hasErrors()} method to |
|
| 102 | + * check if the string could be parsed correctly |
|
| 103 | + * afterwards. |
|
| 104 | + * |
|
| 105 | + * @param string $file |
|
| 106 | + * @throws FileHelper_Exception |
|
| 107 | + * @return CSVHelper |
|
| 108 | + * |
|
| 109 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 110 | + * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
| 111 | + */ |
|
| 112 | 112 | public function loadFile(string $file) : CSVHelper |
| 113 | 113 | { |
| 114 | 114 | $csv = FileHelper::readContents($file); |
@@ -122,28 +122,28 @@ discard block |
||
| 122 | 122 | |
| 123 | 123 | protected $rowCount = 0; |
| 124 | 124 | |
| 125 | - /** |
|
| 126 | - * Specifies that headers are positioned on top, horizontally. |
|
| 127 | - * @return CSVHelper |
|
| 128 | - */ |
|
| 125 | + /** |
|
| 126 | + * Specifies that headers are positioned on top, horizontally. |
|
| 127 | + * @return CSVHelper |
|
| 128 | + */ |
|
| 129 | 129 | public function setHeadersTop() |
| 130 | 130 | { |
| 131 | 131 | return $this->setHeadersPosition(self::HEADERS_TOP); |
| 132 | 132 | } |
| 133 | 133 | |
| 134 | - /** |
|
| 135 | - * Specifies that headers are positioned on the left, vertically. |
|
| 136 | - * @return CSVHelper |
|
| 137 | - */ |
|
| 134 | + /** |
|
| 135 | + * Specifies that headers are positioned on the left, vertically. |
|
| 136 | + * @return CSVHelper |
|
| 137 | + */ |
|
| 138 | 138 | public function setHeadersLeft() |
| 139 | 139 | { |
| 140 | 140 | return $this->setHeadersPosition(self::HEADERS_LEFT); |
| 141 | 141 | } |
| 142 | 142 | |
| 143 | - /** |
|
| 144 | - * Specifies that there are no headers in the file (default). |
|
| 145 | - * @return CSVHelper |
|
| 146 | - */ |
|
| 143 | + /** |
|
| 144 | + * Specifies that there are no headers in the file (default). |
|
| 145 | + * @return CSVHelper |
|
| 146 | + */ |
|
| 147 | 147 | public function setHeadersNone() |
| 148 | 148 | { |
| 149 | 149 | return $this->setHeadersPosition(self::HEADERS_NONE); |
@@ -173,18 +173,18 @@ discard block |
||
| 173 | 173 | return false; |
| 174 | 174 | } |
| 175 | 175 | |
| 176 | - /** |
|
| 177 | - * Specifies where the headers are positioned in the |
|
| 178 | - * CSV, or turns them off entirely. Use the class constants |
|
| 179 | - * to ensure the value is correct. |
|
| 180 | - * |
|
| 181 | - * @param string $position |
|
| 182 | - * @throws CSVHelper_Exception |
|
| 183 | - * @return CSVHelper |
|
| 184 | - * @see CSVHelper::HEADERS_LEFT |
|
| 185 | - * @see CSVHelper::HEADERS_TOP |
|
| 186 | - * @see CSVHelper::HEADERS_NONE |
|
| 187 | - */ |
|
| 176 | + /** |
|
| 177 | + * Specifies where the headers are positioned in the |
|
| 178 | + * CSV, or turns them off entirely. Use the class constants |
|
| 179 | + * to ensure the value is correct. |
|
| 180 | + * |
|
| 181 | + * @param string $position |
|
| 182 | + * @throws CSVHelper_Exception |
|
| 183 | + * @return CSVHelper |
|
| 184 | + * @see CSVHelper::HEADERS_LEFT |
|
| 185 | + * @see CSVHelper::HEADERS_TOP |
|
| 186 | + * @see CSVHelper::HEADERS_NONE |
|
| 187 | + */ |
|
| 188 | 188 | public function setHeadersPosition($position) |
| 189 | 189 | { |
| 190 | 190 | $validPositions = array( |
@@ -211,13 +211,13 @@ discard block |
||
| 211 | 211 | return $this; |
| 212 | 212 | } |
| 213 | 213 | |
| 214 | - /** |
|
| 215 | - * Resets all internal data, allowing to start entirely anew |
|
| 216 | - * with a new file, or to start building a new CSV file from |
|
| 217 | - * scratch. |
|
| 218 | - * |
|
| 219 | - * @return CSVHelper |
|
| 220 | - */ |
|
| 214 | + /** |
|
| 215 | + * Resets all internal data, allowing to start entirely anew |
|
| 216 | + * with a new file, or to start building a new CSV file from |
|
| 217 | + * scratch. |
|
| 218 | + * |
|
| 219 | + * @return CSVHelper |
|
| 220 | + */ |
|
| 221 | 221 | public function reset() |
| 222 | 222 | { |
| 223 | 223 | $this->data = array(); |
@@ -234,19 +234,19 @@ discard block |
||
| 234 | 234 | return $this->data; |
| 235 | 235 | } |
| 236 | 236 | |
| 237 | - /** |
|
| 238 | - * Retrieves the row at the specified index. |
|
| 239 | - * If there is no data at the index, this will |
|
| 240 | - * return an array populated with empty strings |
|
| 241 | - * for all available columns. |
|
| 242 | - * |
|
| 243 | - * Tip: Use the {@link rowExists()} method to check |
|
| 244 | - * whether the specified row exists. |
|
| 245 | - * |
|
| 246 | - * @param integer $index |
|
| 247 | - * @return array() |
|
| 248 | - * @see rowExists() |
|
| 249 | - */ |
|
| 237 | + /** |
|
| 238 | + * Retrieves the row at the specified index. |
|
| 239 | + * If there is no data at the index, this will |
|
| 240 | + * return an array populated with empty strings |
|
| 241 | + * for all available columns. |
|
| 242 | + * |
|
| 243 | + * Tip: Use the {@link rowExists()} method to check |
|
| 244 | + * whether the specified row exists. |
|
| 245 | + * |
|
| 246 | + * @param integer $index |
|
| 247 | + * @return array() |
|
| 248 | + * @see rowExists() |
|
| 249 | + */ |
|
| 250 | 250 | public function getRow($index) |
| 251 | 251 | { |
| 252 | 252 | if(isset($this->data[$index])) { |
@@ -256,63 +256,63 @@ discard block |
||
| 256 | 256 | return array_fill(0, $this->rowCount, ''); |
| 257 | 257 | } |
| 258 | 258 | |
| 259 | - /** |
|
| 260 | - * Checks whether the specified row exists in the data set. |
|
| 261 | - * @param integer $index |
|
| 262 | - * @return boolean |
|
| 263 | - */ |
|
| 259 | + /** |
|
| 260 | + * Checks whether the specified row exists in the data set. |
|
| 261 | + * @param integer $index |
|
| 262 | + * @return boolean |
|
| 263 | + */ |
|
| 264 | 264 | public function rowExists($index) |
| 265 | 265 | { |
| 266 | 266 | return isset($this->data[$index]); |
| 267 | 267 | } |
| 268 | 268 | |
| 269 | - /** |
|
| 270 | - * Counts the amount of rows in the parsed CSV, |
|
| 271 | - * excluding the headers if any, depending on |
|
| 272 | - * their position. |
|
| 273 | - * |
|
| 274 | - * @return integer |
|
| 275 | - */ |
|
| 269 | + /** |
|
| 270 | + * Counts the amount of rows in the parsed CSV, |
|
| 271 | + * excluding the headers if any, depending on |
|
| 272 | + * their position. |
|
| 273 | + * |
|
| 274 | + * @return integer |
|
| 275 | + */ |
|
| 276 | 276 | public function countRows() |
| 277 | 277 | { |
| 278 | 278 | return $this->rowCount; |
| 279 | 279 | } |
| 280 | 280 | |
| 281 | - /** |
|
| 282 | - * Counts the amount of rows in the parsed CSV, |
|
| 283 | - * excluding the headers if any, depending on |
|
| 284 | - * their position. |
|
| 285 | - * |
|
| 286 | - * @return integer |
|
| 287 | - */ |
|
| 281 | + /** |
|
| 282 | + * Counts the amount of rows in the parsed CSV, |
|
| 283 | + * excluding the headers if any, depending on |
|
| 284 | + * their position. |
|
| 285 | + * |
|
| 286 | + * @return integer |
|
| 287 | + */ |
|
| 288 | 288 | public function countColumns() |
| 289 | 289 | { |
| 290 | 290 | return $this->columnCount; |
| 291 | 291 | } |
| 292 | 292 | |
| 293 | - /** |
|
| 294 | - * Retrieves the headers, if any. Specify the position of the |
|
| 295 | - * headers first to ensure this works correctly. |
|
| 296 | - * |
|
| 297 | - * @return array Indexed array with header names. |
|
| 298 | - */ |
|
| 293 | + /** |
|
| 294 | + * Retrieves the headers, if any. Specify the position of the |
|
| 295 | + * headers first to ensure this works correctly. |
|
| 296 | + * |
|
| 297 | + * @return array Indexed array with header names. |
|
| 298 | + */ |
|
| 299 | 299 | public function getHeaders() |
| 300 | 300 | { |
| 301 | 301 | return $this->headers; |
| 302 | 302 | } |
| 303 | 303 | |
| 304 | - /** |
|
| 305 | - * Retrieves the column at the specified index. If there |
|
| 306 | - * is no column at the index, this returns an array |
|
| 307 | - * populated with empty strings. |
|
| 308 | - * |
|
| 309 | - * Tip: Use the {@link columnExists()} method to check |
|
| 310 | - * whether a column exists. |
|
| 311 | - * |
|
| 312 | - * @param integer $index |
|
| 313 | - * @return string[] |
|
| 314 | - * @see columnExists() |
|
| 315 | - */ |
|
| 304 | + /** |
|
| 305 | + * Retrieves the column at the specified index. If there |
|
| 306 | + * is no column at the index, this returns an array |
|
| 307 | + * populated with empty strings. |
|
| 308 | + * |
|
| 309 | + * Tip: Use the {@link columnExists()} method to check |
|
| 310 | + * whether a column exists. |
|
| 311 | + * |
|
| 312 | + * @param integer $index |
|
| 313 | + * @return string[] |
|
| 314 | + * @see columnExists() |
|
| 315 | + */ |
|
| 316 | 316 | public function getColumn($index) |
| 317 | 317 | { |
| 318 | 318 | $data = array(); |
@@ -328,11 +328,11 @@ discard block |
||
| 328 | 328 | return $data; |
| 329 | 329 | } |
| 330 | 330 | |
| 331 | - /** |
|
| 332 | - * Checks whether the specified column exists in the data set. |
|
| 333 | - * @param integer $index |
|
| 334 | - * @return boolean |
|
| 335 | - */ |
|
| 331 | + /** |
|
| 332 | + * Checks whether the specified column exists in the data set. |
|
| 333 | + * @param integer $index |
|
| 334 | + * @return boolean |
|
| 335 | + */ |
|
| 336 | 336 | public function columnExists($index) |
| 337 | 337 | { |
| 338 | 338 | if($index < $this->columnCount) { |
@@ -396,22 +396,22 @@ discard block |
||
| 396 | 396 | } |
| 397 | 397 | } |
| 398 | 398 | |
| 399 | - /** |
|
| 400 | - * Checks whether any errors have been encountered |
|
| 401 | - * while parsing the CSV. |
|
| 402 | - * |
|
| 403 | - * @return boolean |
|
| 404 | - * @see getErrorMessages() |
|
| 405 | - */ |
|
| 399 | + /** |
|
| 400 | + * Checks whether any errors have been encountered |
|
| 401 | + * while parsing the CSV. |
|
| 402 | + * |
|
| 403 | + * @return boolean |
|
| 404 | + * @see getErrorMessages() |
|
| 405 | + */ |
|
| 406 | 406 | public function hasErrors() |
| 407 | 407 | { |
| 408 | 408 | return !empty($this->errors); |
| 409 | 409 | } |
| 410 | 410 | |
| 411 | - /** |
|
| 412 | - * Retrieves all error messages. |
|
| 413 | - * @return array |
|
| 414 | - */ |
|
| 411 | + /** |
|
| 412 | + * Retrieves all error messages. |
|
| 413 | + * @return array |
|
| 414 | + */ |
|
| 415 | 415 | public function getErrorMessages() |
| 416 | 416 | { |
| 417 | 417 | return $this->errors; |
@@ -170,7 +170,7 @@ discard block |
||
| 170 | 170 | |
| 171 | 171 | public function isHeadersPosition($position) |
| 172 | 172 | { |
| 173 | - if($this->headersPosition === $position) { |
|
| 173 | + if ($this->headersPosition === $position) { |
|
| 174 | 174 | return true; |
| 175 | 175 | } |
| 176 | 176 | |
@@ -197,7 +197,7 @@ discard block |
||
| 197 | 197 | self::HEADERS_TOP |
| 198 | 198 | ); |
| 199 | 199 | |
| 200 | - if(!in_array($position, $validPositions)) { |
|
| 200 | + if (!in_array($position, $validPositions)) { |
|
| 201 | 201 | throw new CSVHelper_Exception( |
| 202 | 202 | 'Invalid headers position', |
| 203 | 203 | sprintf( |
@@ -253,7 +253,7 @@ discard block |
||
| 253 | 253 | */ |
| 254 | 254 | public function getRow($index) |
| 255 | 255 | { |
| 256 | - if(isset($this->data[$index])) { |
|
| 256 | + if (isset($this->data[$index])) { |
|
| 257 | 257 | return $this->data[$index]; |
| 258 | 258 | } |
| 259 | 259 | |
@@ -320,9 +320,9 @@ discard block |
||
| 320 | 320 | public function getColumn($index) |
| 321 | 321 | { |
| 322 | 322 | $data = array(); |
| 323 | - for($i=0; $i < $this->rowCount; $i++) { |
|
| 323 | + for ($i = 0; $i < $this->rowCount; $i++) { |
|
| 324 | 324 | $value = ''; |
| 325 | - if(isset($this->data[$i][$index])) { |
|
| 325 | + if (isset($this->data[$i][$index])) { |
|
| 326 | 326 | $value = $this->data[$i][$index]; |
| 327 | 327 | } |
| 328 | 328 | |
@@ -339,7 +339,7 @@ discard block |
||
| 339 | 339 | */ |
| 340 | 340 | public function columnExists($index) |
| 341 | 341 | { |
| 342 | - if($index < $this->columnCount) { |
|
| 342 | + if ($index < $this->columnCount) { |
|
| 343 | 343 | return true; |
| 344 | 344 | } |
| 345 | 345 | |
@@ -350,7 +350,7 @@ discard block |
||
| 350 | 350 | { |
| 351 | 351 | $this->reset(); |
| 352 | 352 | |
| 353 | - if(empty(trim($this->csv))) { |
|
| 353 | + if (empty(trim($this->csv))) { |
|
| 354 | 354 | $this->addError('Tried to parse an empty CSV string.'); |
| 355 | 355 | return; |
| 356 | 356 | } |
@@ -362,14 +362,14 @@ discard block |
||
| 362 | 362 | |
| 363 | 363 | $parser = self::createParser(); |
| 364 | 364 | |
| 365 | - if(!$parser->parse($this->csv)) { |
|
| 365 | + if (!$parser->parse($this->csv)) { |
|
| 366 | 366 | $this->addError('The CSV string could not be parsed.'); |
| 367 | 367 | return; |
| 368 | 368 | } |
| 369 | 369 | |
| 370 | 370 | $result = $parser->data; |
| 371 | 371 | |
| 372 | - switch($this->headersPosition) |
|
| 372 | + switch ($this->headersPosition) |
|
| 373 | 373 | { |
| 374 | 374 | case self::HEADERS_TOP: |
| 375 | 375 | $this->headers = array_shift($result); |
@@ -378,7 +378,7 @@ discard block |
||
| 378 | 378 | case self::HEADERS_LEFT: |
| 379 | 379 | $keep = array(); |
| 380 | 380 | $total = count($result); |
| 381 | - for($i=0; $i < $total; $i++) { |
|
| 381 | + for ($i = 0; $i < $total; $i++) { |
|
| 382 | 382 | $row = $result[$i]; |
| 383 | 383 | $this->headers[] = array_shift($row); |
| 384 | 384 | $keep[] = $row; |
@@ -391,9 +391,9 @@ discard block |
||
| 391 | 391 | $this->data = $result; |
| 392 | 392 | $this->rowCount = count($this->data); |
| 393 | 393 | |
| 394 | - for($i=0; $i < $this->rowCount; $i++) { |
|
| 394 | + for ($i = 0; $i < $this->rowCount; $i++) { |
|
| 395 | 395 | $amount = count($this->data[$i]); |
| 396 | - if($amount > $this->columnCount) { |
|
| 396 | + if ($amount > $this->columnCount) { |
|
| 397 | 397 | $this->columnCount = $amount; |
| 398 | 398 | } |
| 399 | 399 | } |
@@ -437,8 +437,8 @@ discard block |
||
| 437 | 437 | ',,' => ',' |
| 438 | 438 | ); |
| 439 | 439 | |
| 440 | - foreach($search as $char => $separator) { |
|
| 441 | - if(strstr($this->csv, $char)) { |
|
| 440 | + foreach ($search as $char => $separator) { |
|
| 441 | + if (strstr($this->csv, $char)) { |
|
| 442 | 442 | return $separator; |
| 443 | 443 | } |
| 444 | 444 | } |
@@ -452,11 +452,11 @@ discard block |
||
| 452 | 452 | * @param string $delimiter |
| 453 | 453 | * @return Csv |
| 454 | 454 | */ |
| 455 | - public static function createParser(string $delimiter=self::DELIMITER_AUTO) : Csv |
|
| 455 | + public static function createParser(string $delimiter = self::DELIMITER_AUTO) : Csv |
|
| 456 | 456 | { |
| 457 | 457 | $csv = new Csv(); |
| 458 | 458 | |
| 459 | - if($delimiter !== self::DELIMITER_AUTO) { |
|
| 459 | + if ($delimiter !== self::DELIMITER_AUTO) { |
|
| 460 | 460 | $csv->delimiter = $delimiter; |
| 461 | 461 | } |
| 462 | 462 | |
@@ -482,7 +482,7 @@ discard block |
||
| 482 | 482 | $parser = self::createParser(); |
| 483 | 483 | $result = $parser->parse($path); |
| 484 | 484 | |
| 485 | - if($result === true) { |
|
| 485 | + if ($result === true) { |
|
| 486 | 486 | return $parser->data; |
| 487 | 487 | } |
| 488 | 488 | |
@@ -512,7 +512,7 @@ discard block |
||
| 512 | 512 | $parser = self::createParser(); |
| 513 | 513 | $result = $parser->parse($string); |
| 514 | 514 | |
| 515 | - if($result === true) { |
|
| 515 | + if ($result === true) { |
|
| 516 | 516 | return $parser->data; |
| 517 | 517 | } |
| 518 | 518 | |
@@ -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 $file |
|
| 255 | - * @return ImageHelper |
|
| 256 | - */ |
|
| 250 | + /** |
|
| 251 | + * Factory method: creates an image helper from an |
|
| 252 | + * image file on disk. |
|
| 253 | + * |
|
| 254 | + * @param string $file |
|
| 255 | + * @return ImageHelper |
|
| 256 | + */ |
|
| 257 | 257 | public static function createFromFile(string $file) : ImageHelper |
| 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()) { |
@@ -851,13 +851,13 @@ discard block |
||
| 851 | 851 | return array_unique($types); |
| 852 | 852 | } |
| 853 | 853 | |
| 854 | - /** |
|
| 855 | - * Displays an existing image resource. |
|
| 856 | - * |
|
| 857 | - * @param resource $resource |
|
| 858 | - * @param string $imageType The image format to send, i.e. "jpeg", "png" |
|
| 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 | - */ |
|
| 854 | + /** |
|
| 855 | + * Displays an existing image resource. |
|
| 856 | + * |
|
| 857 | + * @param resource $resource |
|
| 858 | + * @param string $imageType The image format to send, i.e. "jpeg", "png" |
|
| 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 | + */ |
|
| 861 | 861 | public static function displayImageStream($resource, $imageType, $quality=-1) |
| 862 | 862 | { |
| 863 | 863 | $imageType = strtolower($imageType); |
@@ -923,31 +923,31 @@ discard block |
||
| 923 | 923 | readfile($imageFile); |
| 924 | 924 | } |
| 925 | 925 | |
| 926 | - /** |
|
| 927 | - * Displays the current image. |
|
| 928 | - */ |
|
| 926 | + /** |
|
| 927 | + * Displays the current image. |
|
| 928 | + */ |
|
| 929 | 929 | public function display() |
| 930 | 930 | { |
| 931 | 931 | $this->displayImageStream($this->newImage, $this->getType(), $this->resolveQuality()); |
| 932 | 932 | } |
| 933 | 933 | |
| 934 | - /** |
|
| 935 | - * Trims the current loaded image. |
|
| 936 | - * |
|
| 937 | - * @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. |
|
| 938 | - */ |
|
| 934 | + /** |
|
| 935 | + * Trims the current loaded image. |
|
| 936 | + * |
|
| 937 | + * @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. |
|
| 938 | + */ |
|
| 939 | 939 | public function trim($color=null) |
| 940 | 940 | { |
| 941 | 941 | return $this->trimImage($this->newImage, $color); |
| 942 | 942 | } |
| 943 | 943 | |
| 944 | - /** |
|
| 945 | - * Retrieves a color definition by its index. |
|
| 946 | - * |
|
| 947 | - * @param resource $img A valid image resource. |
|
| 948 | - * @param int $colorIndex The color index, as returned by imagecolorat for example. |
|
| 949 | - * @return array An array with red, green, blue and alpha keys. |
|
| 950 | - */ |
|
| 944 | + /** |
|
| 945 | + * Retrieves a color definition by its index. |
|
| 946 | + * |
|
| 947 | + * @param resource $img A valid image resource. |
|
| 948 | + * @param int $colorIndex The color index, as returned by imagecolorat for example. |
|
| 949 | + * @return array An array with red, green, blue and alpha keys. |
|
| 950 | + */ |
|
| 951 | 951 | public function getIndexedColors($img, int $colorIndex) : array |
| 952 | 952 | { |
| 953 | 953 | $color = imagecolorsforindex($img, $colorIndex); |
@@ -965,14 +965,14 @@ discard block |
||
| 965 | 965 | ); |
| 966 | 966 | } |
| 967 | 967 | |
| 968 | - /** |
|
| 969 | - * Trims the specified image resource by removing the specified color. |
|
| 970 | - * Also works with transparency. |
|
| 971 | - * |
|
| 972 | - * @param resource $img |
|
| 973 | - * @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. |
|
| 974 | - * @return ImageHelper |
|
| 975 | - */ |
|
| 968 | + /** |
|
| 969 | + * Trims the specified image resource by removing the specified color. |
|
| 970 | + * Also works with transparency. |
|
| 971 | + * |
|
| 972 | + * @param resource $img |
|
| 973 | + * @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. |
|
| 974 | + * @return ImageHelper |
|
| 975 | + */ |
|
| 976 | 976 | protected function trimImage($img, ?array $color=null) : ImageHelper |
| 977 | 977 | { |
| 978 | 978 | if($this->isVector()) { |
@@ -1060,12 +1060,12 @@ discard block |
||
| 1060 | 1060 | return $this; |
| 1061 | 1061 | } |
| 1062 | 1062 | |
| 1063 | - /** |
|
| 1064 | - * Sets the new image after a transformation operation: |
|
| 1065 | - * automatically adjusts the new size information. |
|
| 1066 | - * |
|
| 1067 | - * @param resource $image |
|
| 1068 | - */ |
|
| 1063 | + /** |
|
| 1064 | + * Sets the new image after a transformation operation: |
|
| 1065 | + * automatically adjusts the new size information. |
|
| 1066 | + * |
|
| 1067 | + * @param resource $image |
|
| 1068 | + */ |
|
| 1069 | 1069 | protected function setNewImage($image) |
| 1070 | 1070 | { |
| 1071 | 1071 | self::requireResource($image); |
@@ -1075,12 +1075,12 @@ discard block |
||
| 1075 | 1075 | $this->newHeight= imagesy($image); |
| 1076 | 1076 | } |
| 1077 | 1077 | |
| 1078 | - /** |
|
| 1079 | - * Requires the subject to be a resource. |
|
| 1080 | - * |
|
| 1081 | - * @param resource $subject |
|
| 1082 | - * @throws ImageHelper_Exception |
|
| 1083 | - */ |
|
| 1078 | + /** |
|
| 1079 | + * Requires the subject to be a resource. |
|
| 1080 | + * |
|
| 1081 | + * @param resource $subject |
|
| 1082 | + * @throws ImageHelper_Exception |
|
| 1083 | + */ |
|
| 1084 | 1084 | protected static function requireResource($subject) |
| 1085 | 1085 | { |
| 1086 | 1086 | if(is_resource($subject)) { |
@@ -1097,14 +1097,14 @@ discard block |
||
| 1097 | 1097 | ); |
| 1098 | 1098 | } |
| 1099 | 1099 | |
| 1100 | - /** |
|
| 1101 | - * Creates a new image resource, with transparent background. |
|
| 1102 | - * |
|
| 1103 | - * @param int $width |
|
| 1104 | - * @param int $height |
|
| 1105 | - * @throws ImageHelper_Exception |
|
| 1106 | - * @return resource |
|
| 1107 | - */ |
|
| 1100 | + /** |
|
| 1101 | + * Creates a new image resource, with transparent background. |
|
| 1102 | + * |
|
| 1103 | + * @param int $width |
|
| 1104 | + * @param int $height |
|
| 1105 | + * @throws ImageHelper_Exception |
|
| 1106 | + * @return resource |
|
| 1107 | + */ |
|
| 1108 | 1108 | protected function createNewImage(int $width, int $height) |
| 1109 | 1109 | { |
| 1110 | 1110 | $img = imagecreatetruecolor($width, $height); |
@@ -1123,54 +1123,54 @@ discard block |
||
| 1123 | 1123 | return $img; |
| 1124 | 1124 | } |
| 1125 | 1125 | |
| 1126 | - /** |
|
| 1127 | - * Whether the two specified colors are the same. |
|
| 1128 | - * |
|
| 1129 | - * @param array $a |
|
| 1130 | - * @param array $b |
|
| 1131 | - * @return boolean |
|
| 1132 | - */ |
|
| 1133 | - protected function colorsMatch($a, $b) : bool |
|
| 1134 | - { |
|
| 1135 | - $parts = array('red', 'green', 'blue'); |
|
| 1136 | - foreach($parts as $part) { |
|
| 1137 | - if($a[$part] != $b[$part]) { |
|
| 1138 | - return false; |
|
| 1139 | - } |
|
| 1140 | - } |
|
| 1126 | + /** |
|
| 1127 | + * Whether the two specified colors are the same. |
|
| 1128 | + * |
|
| 1129 | + * @param array $a |
|
| 1130 | + * @param array $b |
|
| 1131 | + * @return boolean |
|
| 1132 | + */ |
|
| 1133 | + protected function colorsMatch($a, $b) : bool |
|
| 1134 | + { |
|
| 1135 | + $parts = array('red', 'green', 'blue'); |
|
| 1136 | + foreach($parts as $part) { |
|
| 1137 | + if($a[$part] != $b[$part]) { |
|
| 1138 | + return false; |
|
| 1139 | + } |
|
| 1140 | + } |
|
| 1141 | 1141 | |
| 1142 | - return true; |
|
| 1143 | - } |
|
| 1142 | + return true; |
|
| 1143 | + } |
|
| 1144 | 1144 | |
| 1145 | - public function fillWhite($x=0, $y=0) |
|
| 1146 | - { |
|
| 1147 | - $this->addRGBColor('white', 255, 255, 255); |
|
| 1145 | + public function fillWhite($x=0, $y=0) |
|
| 1146 | + { |
|
| 1147 | + $this->addRGBColor('white', 255, 255, 255); |
|
| 1148 | 1148 | return $this->fill('white', $x, $y); |
| 1149 | - } |
|
| 1149 | + } |
|
| 1150 | 1150 | |
| 1151 | - public function fillTransparent() : ImageHelper |
|
| 1152 | - { |
|
| 1151 | + public function fillTransparent() : ImageHelper |
|
| 1152 | + { |
|
| 1153 | 1153 | $this->enableAlpha(); |
| 1154 | 1154 | |
| 1155 | - self::fillImageTransparent($this->newImage); |
|
| 1155 | + self::fillImageTransparent($this->newImage); |
|
| 1156 | 1156 | |
| 1157 | - return $this; |
|
| 1158 | - } |
|
| 1157 | + return $this; |
|
| 1158 | + } |
|
| 1159 | 1159 | |
| 1160 | - public static function fillImageTransparent($resource) |
|
| 1161 | - { |
|
| 1162 | - self::requireResource($resource); |
|
| 1160 | + public static function fillImageTransparent($resource) |
|
| 1161 | + { |
|
| 1162 | + self::requireResource($resource); |
|
| 1163 | 1163 | |
| 1164 | - $transparent = imagecolorallocatealpha($resource, 89, 14, 207, 127); |
|
| 1165 | - imagecolortransparent ($resource, $transparent); |
|
| 1166 | - imagefill($resource, 0, 0, $transparent); |
|
| 1167 | - } |
|
| 1164 | + $transparent = imagecolorallocatealpha($resource, 89, 14, 207, 127); |
|
| 1165 | + imagecolortransparent ($resource, $transparent); |
|
| 1166 | + imagefill($resource, 0, 0, $transparent); |
|
| 1167 | + } |
|
| 1168 | 1168 | |
| 1169 | - public function fill($colorName, $x=0, $y=0) |
|
| 1170 | - { |
|
| 1171 | - imagefill($this->newImage, $x, $y, $this->colors[$colorName]); |
|
| 1172 | - return $this; |
|
| 1173 | - } |
|
| 1169 | + public function fill($colorName, $x=0, $y=0) |
|
| 1170 | + { |
|
| 1171 | + imagefill($this->newImage, $x, $y, $this->colors[$colorName]); |
|
| 1172 | + return $this; |
|
| 1173 | + } |
|
| 1174 | 1174 | |
| 1175 | 1175 | protected $colors = array(); |
| 1176 | 1176 | |
@@ -1191,9 +1191,9 @@ discard block |
||
| 1191 | 1191 | return $this; |
| 1192 | 1192 | } |
| 1193 | 1193 | |
| 1194 | - /** |
|
| 1195 | - * @return resource |
|
| 1196 | - */ |
|
| 1194 | + /** |
|
| 1195 | + * @return resource |
|
| 1196 | + */ |
|
| 1197 | 1197 | public function getImage() |
| 1198 | 1198 | { |
| 1199 | 1199 | return $this->newImage; |
@@ -1211,26 +1211,26 @@ discard block |
||
| 1211 | 1211 | return $this; |
| 1212 | 1212 | } |
| 1213 | 1213 | |
| 1214 | - /** |
|
| 1215 | - * Retrieves the size of the image. |
|
| 1216 | - * |
|
| 1217 | - * @return ImageHelper_Size |
|
| 1218 | - * @throws ImageHelper_Exception |
|
| 1219 | - * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE |
|
| 1220 | - */ |
|
| 1221 | - public function getSize() : ImageHelper_Size |
|
| 1214 | + /** |
|
| 1215 | + * Retrieves the size of the image. |
|
| 1216 | + * |
|
| 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 | { |
| 867 | 867 | throw new ImageHelper_Exception( |
| 868 | 868 | 'Invalid image stream type', |
@@ -874,9 +874,9 @@ discard block |
||
| 874 | 874 | ); |
| 875 | 875 | } |
| 876 | 876 | |
| 877 | - header('Content-type:image/' . $imageType); |
|
| 877 | + header('Content-type:image/'.$imageType); |
|
| 878 | 878 | |
| 879 | - $function = 'image' . $imageType; |
|
| 879 | + $function = 'image'.$imageType; |
|
| 880 | 880 | |
| 881 | 881 | $function($resource, null, $quality); |
| 882 | 882 | } |
@@ -892,7 +892,7 @@ discard block |
||
| 892 | 892 | if (headers_sent($file, $line)) { |
| 893 | 893 | throw new ImageHelper_Exception( |
| 894 | 894 | 'Error displaying image', |
| 895 | - 'Headers have already been sent: in file ' . $file . ':' . $line, |
|
| 895 | + 'Headers have already been sent: in file '.$file.':'.$line, |
|
| 896 | 896 | self::ERROR_HEADERS_ALREADY_SENT |
| 897 | 897 | ); |
| 898 | 898 | } |
@@ -909,16 +909,16 @@ discard block |
||
| 909 | 909 | } |
| 910 | 910 | |
| 911 | 911 | $format = self::getFileImageType($imageFile); |
| 912 | - if($format == 'svg') { |
|
| 912 | + if ($format == 'svg') { |
|
| 913 | 913 | $format = 'svg+xml'; |
| 914 | 914 | } |
| 915 | 915 | |
| 916 | - $contentType = 'image/' . $format; |
|
| 916 | + $contentType = 'image/'.$format; |
|
| 917 | 917 | |
| 918 | 918 | header('Content-Type: '.$contentType); |
| 919 | - header("Last-Modified: " . gmdate("D, d M Y H:i:s", filemtime($imageFile)) . " GMT"); |
|
| 919 | + header("Last-Modified: ".gmdate("D, d M Y H:i:s", filemtime($imageFile))." GMT"); |
|
| 920 | 920 | header('Cache-Control: public'); |
| 921 | - header('Content-Length: ' . filesize($imageFile)); |
|
| 921 | + header('Content-Length: '.filesize($imageFile)); |
|
| 922 | 922 | |
| 923 | 923 | readfile($imageFile); |
| 924 | 924 | } |
@@ -936,7 +936,7 @@ discard block |
||
| 936 | 936 | * |
| 937 | 937 | * @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. |
| 938 | 938 | */ |
| 939 | - public function trim($color=null) |
|
| 939 | + public function trim($color = null) |
|
| 940 | 940 | { |
| 941 | 941 | return $this->trimImage($this->newImage, $color); |
| 942 | 942 | } |
@@ -953,7 +953,7 @@ discard block |
||
| 953 | 953 | $color = imagecolorsforindex($img, $colorIndex); |
| 954 | 954 | |
| 955 | 955 | // it seems imagecolorsforindex may return false (undocumented, unproven) |
| 956 | - if(is_array($color)) { |
|
| 956 | + if (is_array($color)) { |
|
| 957 | 957 | return $color; |
| 958 | 958 | } |
| 959 | 959 | |
@@ -973,15 +973,15 @@ discard block |
||
| 973 | 973 | * @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. |
| 974 | 974 | * @return ImageHelper |
| 975 | 975 | */ |
| 976 | - protected function trimImage($img, ?array $color=null) : ImageHelper |
|
| 976 | + protected function trimImage($img, ?array $color = null) : ImageHelper |
|
| 977 | 977 | { |
| 978 | - if($this->isVector()) { |
|
| 978 | + if ($this->isVector()) { |
|
| 979 | 979 | return $this; |
| 980 | 980 | } |
| 981 | 981 | |
| 982 | 982 | self::requireResource($img); |
| 983 | 983 | |
| 984 | - if(empty($color)) |
|
| 984 | + if (empty($color)) |
|
| 985 | 985 | { |
| 986 | 986 | $color = imagecolorat($img, 0, 0); |
| 987 | 987 | $color = $this->getIndexedColors($img, $color); |
@@ -998,16 +998,16 @@ discard block |
||
| 998 | 998 | $ymax = null; |
| 999 | 999 | |
| 1000 | 1000 | // Start scanning for the edges. |
| 1001 | - for ($iy=0; $iy<$imh; $iy++) |
|
| 1001 | + for ($iy = 0; $iy < $imh; $iy++) |
|
| 1002 | 1002 | { |
| 1003 | 1003 | $first = true; |
| 1004 | 1004 | |
| 1005 | - for ($ix=0; $ix<$imw; $ix++) |
|
| 1005 | + for ($ix = 0; $ix < $imw; $ix++) |
|
| 1006 | 1006 | { |
| 1007 | 1007 | $ndx = imagecolorat($img, $ix, $iy); |
| 1008 | 1008 | $colors = $this->getIndexedColors($img, $ndx); |
| 1009 | 1009 | |
| 1010 | - if(!$this->colorsMatch($colors, $color)) |
|
| 1010 | + if (!$this->colorsMatch($colors, $color)) |
|
| 1011 | 1011 | { |
| 1012 | 1012 | if ($xmin > $ix) { $xmin = $ix; } |
| 1013 | 1013 | if ($xmax < $ix) { $xmax = $ix; } |
@@ -1015,7 +1015,7 @@ discard block |
||
| 1015 | 1015 | |
| 1016 | 1016 | $ymax = $iy; |
| 1017 | 1017 | |
| 1018 | - if($first) |
|
| 1018 | + if ($first) |
|
| 1019 | 1019 | { |
| 1020 | 1020 | $ix = $xmax; |
| 1021 | 1021 | $first = false; |
@@ -1025,18 +1025,18 @@ discard block |
||
| 1025 | 1025 | } |
| 1026 | 1026 | |
| 1027 | 1027 | // no trimming border found |
| 1028 | - if($ymax === null && $ymax === null) { |
|
| 1028 | + if ($ymax === null && $ymax === null) { |
|
| 1029 | 1029 | return $this; |
| 1030 | 1030 | } |
| 1031 | 1031 | |
| 1032 | 1032 | // The new width and height of the image. |
| 1033 | - $imw = 1+$xmax-$xmin; // Image width in pixels |
|
| 1034 | - $imh = 1+$ymax-$ymin; // Image height in pixels |
|
| 1033 | + $imw = 1 + $xmax - $xmin; // Image width in pixels |
|
| 1034 | + $imh = 1 + $ymax - $ymin; // Image height in pixels |
|
| 1035 | 1035 | |
| 1036 | 1036 | // Make another image to place the trimmed version in. |
| 1037 | 1037 | $im2 = $this->createNewImage($imw, $imh); |
| 1038 | 1038 | |
| 1039 | - if($color['alpha'] > 0) |
|
| 1039 | + if ($color['alpha'] > 0) |
|
| 1040 | 1040 | { |
| 1041 | 1041 | $bg2 = imagecolorallocatealpha($im2, $color['red'], $color['green'], $color['blue'], $color['alpha']); |
| 1042 | 1042 | imagecolortransparent($im2, $bg2); |
@@ -1072,7 +1072,7 @@ discard block |
||
| 1072 | 1072 | |
| 1073 | 1073 | $this->newImage = $image; |
| 1074 | 1074 | $this->newWidth = imagesx($image); |
| 1075 | - $this->newHeight= imagesy($image); |
|
| 1075 | + $this->newHeight = imagesy($image); |
|
| 1076 | 1076 | } |
| 1077 | 1077 | |
| 1078 | 1078 | /** |
@@ -1083,7 +1083,7 @@ discard block |
||
| 1083 | 1083 | */ |
| 1084 | 1084 | protected static function requireResource($subject) |
| 1085 | 1085 | { |
| 1086 | - if(is_resource($subject)) { |
|
| 1086 | + if (is_resource($subject)) { |
|
| 1087 | 1087 | return; |
| 1088 | 1088 | } |
| 1089 | 1089 | |
@@ -1109,7 +1109,7 @@ discard block |
||
| 1109 | 1109 | { |
| 1110 | 1110 | $img = imagecreatetruecolor($width, $height); |
| 1111 | 1111 | |
| 1112 | - if($img === false) |
|
| 1112 | + if ($img === false) |
|
| 1113 | 1113 | { |
| 1114 | 1114 | throw new ImageHelper_Exception( |
| 1115 | 1115 | 'Error creating new image', |
@@ -1133,8 +1133,8 @@ discard block |
||
| 1133 | 1133 | protected function colorsMatch($a, $b) : bool |
| 1134 | 1134 | { |
| 1135 | 1135 | $parts = array('red', 'green', 'blue'); |
| 1136 | - foreach($parts as $part) { |
|
| 1137 | - if($a[$part] != $b[$part]) { |
|
| 1136 | + foreach ($parts as $part) { |
|
| 1137 | + if ($a[$part] != $b[$part]) { |
|
| 1138 | 1138 | return false; |
| 1139 | 1139 | } |
| 1140 | 1140 | } |
@@ -1142,7 +1142,7 @@ discard block |
||
| 1142 | 1142 | return true; |
| 1143 | 1143 | } |
| 1144 | 1144 | |
| 1145 | - public function fillWhite($x=0, $y=0) |
|
| 1145 | + public function fillWhite($x = 0, $y = 0) |
|
| 1146 | 1146 | { |
| 1147 | 1147 | $this->addRGBColor('white', 255, 255, 255); |
| 1148 | 1148 | return $this->fill('white', $x, $y); |
@@ -1162,11 +1162,11 @@ discard block |
||
| 1162 | 1162 | self::requireResource($resource); |
| 1163 | 1163 | |
| 1164 | 1164 | $transparent = imagecolorallocatealpha($resource, 89, 14, 207, 127); |
| 1165 | - imagecolortransparent ($resource, $transparent); |
|
| 1165 | + imagecolortransparent($resource, $transparent); |
|
| 1166 | 1166 | imagefill($resource, 0, 0, $transparent); |
| 1167 | 1167 | } |
| 1168 | 1168 | |
| 1169 | - public function fill($colorName, $x=0, $y=0) |
|
| 1169 | + public function fill($colorName, $x = 0, $y = 0) |
|
| 1170 | 1170 | { |
| 1171 | 1171 | imagefill($this->newImage, $x, $y, $this->colors[$colorName]); |
| 1172 | 1172 | return $this; |
@@ -1180,7 +1180,7 @@ discard block |
||
| 1180 | 1180 | return $this; |
| 1181 | 1181 | } |
| 1182 | 1182 | |
| 1183 | - public function textTTF($text, $size, $colorName, $x=0, $y=0, $angle=0) |
|
| 1183 | + public function textTTF($text, $size, $colorName, $x = 0, $y = 0, $angle = 0) |
|
| 1184 | 1184 | { |
| 1185 | 1185 | imagealphablending($this->newImage, true); |
| 1186 | 1186 | |
@@ -1199,11 +1199,11 @@ discard block |
||
| 1199 | 1199 | return $this->newImage; |
| 1200 | 1200 | } |
| 1201 | 1201 | |
| 1202 | - public function paste(ImageHelper $target, $xpos=0, $ypos=0, $sourceX=0, $sourceY=0) |
|
| 1202 | + public function paste(ImageHelper $target, $xpos = 0, $ypos = 0, $sourceX = 0, $sourceY = 0) |
|
| 1203 | 1203 | { |
| 1204 | 1204 | $img = $target->getImage(); |
| 1205 | 1205 | |
| 1206 | - if($target->isAlpha()) { |
|
| 1206 | + if ($target->isAlpha()) { |
|
| 1207 | 1207 | $this->enableAlpha(); |
| 1208 | 1208 | } |
| 1209 | 1209 | |
@@ -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 | /** |
@@ -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 instanceof \DateInterval) |
|
| 60 | + if (!$interval instanceof \DateInterval) |
|
| 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; |
@@ -32,39 +32,39 @@ discard block |
||
| 32 | 32 | const SECONDS_PER_MONTH_APPROX = 2505600; // imprecise - for 29 days, only for approximations. |
| 33 | 33 | const SECONDS_PER_YEAR = 31536000; |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @var int |
|
| 37 | - */ |
|
| 35 | + /** |
|
| 36 | + * @var int |
|
| 37 | + */ |
|
| 38 | 38 | protected $dateFrom; |
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * @var int |
|
| 42 | - */ |
|
| 40 | + /** |
|
| 41 | + * @var int |
|
| 42 | + */ |
|
| 43 | 43 | protected $dateTo; |
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * @var bool |
|
| 47 | - */ |
|
| 45 | + /** |
|
| 46 | + * @var bool |
|
| 47 | + */ |
|
| 48 | 48 | protected $future = false; |
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * @var string |
|
| 52 | - */ |
|
| 50 | + /** |
|
| 51 | + * @var string |
|
| 52 | + */ |
|
| 53 | 53 | protected $interval = ''; |
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * @var int |
|
| 57 | - */ |
|
| 55 | + /** |
|
| 56 | + * @var int |
|
| 57 | + */ |
|
| 58 | 58 | protected $difference = 0; |
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * @var int |
|
| 62 | - */ |
|
| 60 | + /** |
|
| 61 | + * @var int |
|
| 62 | + */ |
|
| 63 | 63 | protected $dateDiff = 0; |
| 64 | 64 | |
| 65 | - /** |
|
| 66 | - * @var array|NULL |
|
| 67 | - */ |
|
| 65 | + /** |
|
| 66 | + * @var array|NULL |
|
| 67 | + */ |
|
| 68 | 68 | protected static $texts = null; |
| 69 | 69 | |
| 70 | 70 | public function __construct() |
@@ -84,17 +84,17 @@ discard block |
||
| 84 | 84 | self::$texts = null; |
| 85 | 85 | } |
| 86 | 86 | |
| 87 | - /** |
|
| 88 | - * Sets the origin date to calculate from. |
|
| 89 | - * |
|
| 90 | - * NOTE: if this is further in the future than |
|
| 91 | - * the to: date, it will be considered as a |
|
| 92 | - * calculation for something to come, i.e. |
|
| 93 | - * "In two days". |
|
| 94 | - * |
|
| 95 | - * @param \DateTime $date |
|
| 96 | - * @return ConvertHelper_DurationConverter |
|
| 97 | - */ |
|
| 87 | + /** |
|
| 88 | + * Sets the origin date to calculate from. |
|
| 89 | + * |
|
| 90 | + * NOTE: if this is further in the future than |
|
| 91 | + * the to: date, it will be considered as a |
|
| 92 | + * calculation for something to come, i.e. |
|
| 93 | + * "In two days". |
|
| 94 | + * |
|
| 95 | + * @param \DateTime $date |
|
| 96 | + * @return ConvertHelper_DurationConverter |
|
| 97 | + */ |
|
| 98 | 98 | public function setDateFrom(\DateTime $date) : ConvertHelper_DurationConverter |
| 99 | 99 | { |
| 100 | 100 | $this->dateFrom = ConvertHelper::date2timestamp($date); |
@@ -102,13 +102,13 @@ discard block |
||
| 102 | 102 | return $this; |
| 103 | 103 | } |
| 104 | 104 | |
| 105 | - /** |
|
| 106 | - * Sets the date to calculate to. Defaults to |
|
| 107 | - * the current time if not set. |
|
| 108 | - * |
|
| 109 | - * @param \DateTime $date |
|
| 110 | - * @return ConvertHelper_DurationConverter |
|
| 111 | - */ |
|
| 105 | + /** |
|
| 106 | + * Sets the date to calculate to. Defaults to |
|
| 107 | + * the current time if not set. |
|
| 108 | + * |
|
| 109 | + * @param \DateTime $date |
|
| 110 | + * @return ConvertHelper_DurationConverter |
|
| 111 | + */ |
|
| 112 | 112 | public function setDateTo(\DateTime $date) : ConvertHelper_DurationConverter |
| 113 | 113 | { |
| 114 | 114 | $this->dateTo = ConvertHelper::date2timestamp($date); |
@@ -116,14 +116,14 @@ discard block |
||
| 116 | 116 | return $this; |
| 117 | 117 | } |
| 118 | 118 | |
| 119 | - /** |
|
| 120 | - * Converts the specified dates to a human readable string. |
|
| 121 | - * |
|
| 122 | - * @throws ConvertHelper_Exception |
|
| 123 | - * @return string |
|
| 124 | - * |
|
| 125 | - * @see ConvertHelper_DurationConverter::ERROR_NO_DATE_FROM_SET |
|
| 126 | - */ |
|
| 119 | + /** |
|
| 120 | + * Converts the specified dates to a human readable string. |
|
| 121 | + * |
|
| 122 | + * @throws ConvertHelper_Exception |
|
| 123 | + * @return string |
|
| 124 | + * |
|
| 125 | + * @see ConvertHelper_DurationConverter::ERROR_NO_DATE_FROM_SET |
|
| 126 | + */ |
|
| 127 | 127 | public function convert() : string |
| 128 | 128 | { |
| 129 | 129 | $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|NULL |
|
| 29 | - */ |
|
| 26 | + /** |
|
| 27 | + * @var array|NULL |
|
| 28 | + */ |
|
| 30 | 29 | protected static $texts = null; |
| 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 | |
@@ -4,37 +4,37 @@ discard block |
||
| 4 | 4 | |
| 5 | 5 | class SVNHelper_CommandResult |
| 6 | 6 | { |
| 7 | - /** |
|
| 8 | - * @var SVNHelper_Command |
|
| 9 | - */ |
|
| 7 | + /** |
|
| 8 | + * @var SVNHelper_Command |
|
| 9 | + */ |
|
| 10 | 10 | protected $command; |
| 11 | 11 | |
| 12 | - /** |
|
| 13 | - * @var string[] |
|
| 14 | - */ |
|
| 12 | + /** |
|
| 13 | + * @var string[] |
|
| 14 | + */ |
|
| 15 | 15 | protected $output; |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * @var SVNHelper_CommandError[] |
|
| 19 | - */ |
|
| 17 | + /** |
|
| 18 | + * @var SVNHelper_CommandError[] |
|
| 19 | + */ |
|
| 20 | 20 | protected $errors = array(); |
| 21 | 21 | |
| 22 | - /** |
|
| 23 | - * @var SVNHelper_CommandError[] |
|
| 24 | - */ |
|
| 22 | + /** |
|
| 23 | + * @var SVNHelper_CommandError[] |
|
| 24 | + */ |
|
| 25 | 25 | protected $warnings = array(); |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * The actual command that has been executed |
|
| 29 | - * @var string |
|
| 30 | - */ |
|
| 27 | + /** |
|
| 28 | + * The actual command that has been executed |
|
| 29 | + * @var string |
|
| 30 | + */ |
|
| 31 | 31 | protected $commandLine; |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * @param SVNHelper_Command $command |
|
| 35 | - * @param string[] $output |
|
| 36 | - * @param SVNHelper_CommandError[] $errors |
|
| 37 | - */ |
|
| 33 | + /** |
|
| 34 | + * @param SVNHelper_Command $command |
|
| 35 | + * @param string[] $output |
|
| 36 | + * @param SVNHelper_CommandError[] $errors |
|
| 37 | + */ |
|
| 38 | 38 | public function __construct(SVNHelper_Command $command, $commandLine, $output, $errors) |
| 39 | 39 | { |
| 40 | 40 | $this->command = $command; |
@@ -86,12 +86,12 @@ discard block |
||
| 86 | 86 | return $this->command; |
| 87 | 87 | } |
| 88 | 88 | |
| 89 | - /** |
|
| 90 | - * Retrieves all error messages. |
|
| 91 | - * |
|
| 92 | - * @param bool $asString |
|
| 93 | - * @return string|string[] |
|
| 94 | - */ |
|
| 89 | + /** |
|
| 90 | + * Retrieves all error messages. |
|
| 91 | + * |
|
| 92 | + * @param bool $asString |
|
| 93 | + * @return string|string[] |
|
| 94 | + */ |
|
| 95 | 95 | public function getErrorMessages(bool $asString=false) |
| 96 | 96 | { |
| 97 | 97 | if($asString) { |
@@ -41,8 +41,8 @@ discard block |
||
| 41 | 41 | $this->commandLine = $commandLine; |
| 42 | 42 | $this->output = $output; |
| 43 | 43 | |
| 44 | - foreach($errors as $error) { |
|
| 45 | - if($error->isError()) { |
|
| 44 | + foreach ($errors as $error) { |
|
| 45 | + if ($error->isError()) { |
|
| 46 | 46 | $this->errors[] = $error; |
| 47 | 47 | } else { |
| 48 | 48 | $this->warnings[] = $error; |
@@ -62,8 +62,8 @@ discard block |
||
| 62 | 62 | |
| 63 | 63 | public function hasErrorCode($code) |
| 64 | 64 | { |
| 65 | - foreach($this->errors as $error) { |
|
| 66 | - if($error->getCode() == $code) { |
|
| 65 | + foreach ($this->errors as $error) { |
|
| 66 | + if ($error->getCode() == $code) { |
|
| 67 | 67 | return true; |
| 68 | 68 | } |
| 69 | 69 | } |
@@ -92,11 +92,11 @@ discard block |
||
| 92 | 92 | * @param bool $asString |
| 93 | 93 | * @return string|string[] |
| 94 | 94 | */ |
| 95 | - public function getErrorMessages(bool $asString=false) |
|
| 95 | + public function getErrorMessages(bool $asString = false) |
|
| 96 | 96 | { |
| 97 | - if($asString) { |
|
| 97 | + if ($asString) { |
|
| 98 | 98 | $lines = array(); |
| 99 | - foreach($this->errors as $error) { |
|
| 99 | + foreach ($this->errors as $error) { |
|
| 100 | 100 | $lines[] = (string)$error; |
| 101 | 101 | } |
| 102 | 102 | |
@@ -104,7 +104,7 @@ discard block |
||
| 104 | 104 | } |
| 105 | 105 | |
| 106 | 106 | $messages = array(); |
| 107 | - foreach($this->errors as $error) { |
|
| 107 | + foreach ($this->errors as $error) { |
|
| 108 | 108 | $messages[] = (string)$error; |
| 109 | 109 | } |
| 110 | 110 | |
@@ -123,7 +123,7 @@ discard block |
||
| 123 | 123 | |
| 124 | 124 | public function getLastLine() |
| 125 | 125 | { |
| 126 | - return $this->output[count($this->output)-1]; |
|
| 126 | + return $this->output[count($this->output) - 1]; |
|
| 127 | 127 | } |
| 128 | 128 | |
| 129 | 129 | public function getFirstLine() |
@@ -138,8 +138,8 @@ discard block |
||
| 138 | 138 | |
| 139 | 139 | public function isConnectionFailed() |
| 140 | 140 | { |
| 141 | - foreach($this->errors as $error) { |
|
| 142 | - if($error->isConnectionFailed()) { |
|
| 141 | + foreach ($this->errors as $error) { |
|
| 142 | + if ($error->isConnectionFailed()) { |
|
| 143 | 143 | return true; |
| 144 | 144 | } |
| 145 | 145 | } |
@@ -149,8 +149,8 @@ discard block |
||
| 149 | 149 | |
| 150 | 150 | public function hasConflicts() |
| 151 | 151 | { |
| 152 | - foreach($this->errors as $error) { |
|
| 153 | - if($error->isConflict()) { |
|
| 152 | + foreach ($this->errors as $error) { |
|
| 153 | + if ($error->isConflict()) { |
|
| 154 | 154 | return true; |
| 155 | 155 | } |
| 156 | 156 | } |
@@ -160,8 +160,8 @@ discard block |
||
| 160 | 160 | |
| 161 | 161 | public function hasLocks() |
| 162 | 162 | { |
| 163 | - foreach($this->errors as $error) { |
|
| 164 | - if($error->isLock()) { |
|
| 163 | + foreach ($this->errors as $error) { |
|
| 164 | + if ($error->isLock()) { |
|
| 165 | 165 | return true; |
| 166 | 166 | } |
| 167 | 167 | } |
@@ -60,7 +60,7 @@ discard block |
||
| 60 | 60 | * The converted string will be all lowercase. |
| 61 | 61 | * @return Transliteration |
| 62 | 62 | */ |
| 63 | - public function setLowercase(bool $lowercase=true) : Transliteration |
|
| 63 | + public function setLowercase(bool $lowercase = true) : Transliteration |
|
| 64 | 64 | { |
| 65 | 65 | $this->setOption('lowercase', $lowercase); |
| 66 | 66 | |
@@ -97,8 +97,8 @@ discard block |
||
| 97 | 97 | |
| 98 | 98 | $result = implode('', $keep); |
| 99 | 99 | |
| 100 | - while (strstr($result, $space . $space)) { |
|
| 101 | - $result = str_replace($space . $space, $space, $result); |
|
| 100 | + while (strstr($result, $space.$space)) { |
|
| 101 | + $result = str_replace($space.$space, $space, $result); |
|
| 102 | 102 | } |
| 103 | 103 | |
| 104 | 104 | $result = trim($result, $space); |