@@ -22,51 +22,51 @@ discard block |
||
| 22 | 22 | */ |
| 23 | 23 | class FileHelper_PHPClassInfo_Class |
| 24 | 24 | { |
| 25 | - /** |
|
| 26 | - * @var FileHelper_PHPClassInfo |
|
| 27 | - */ |
|
| 25 | + /** |
|
| 26 | + * @var FileHelper_PHPClassInfo |
|
| 27 | + */ |
|
| 28 | 28 | protected $info; |
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * @var bool |
|
| 32 | - */ |
|
| 30 | + /** |
|
| 31 | + * @var bool |
|
| 32 | + */ |
|
| 33 | 33 | protected $abstract = false; |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @var bool |
|
| 37 | - */ |
|
| 35 | + /** |
|
| 36 | + * @var bool |
|
| 37 | + */ |
|
| 38 | 38 | protected $final = false; |
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * @var string |
|
| 42 | - */ |
|
| 40 | + /** |
|
| 41 | + * @var string |
|
| 42 | + */ |
|
| 43 | 43 | protected $extends = ''; |
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * @var string[] |
|
| 47 | - */ |
|
| 45 | + /** |
|
| 46 | + * @var string[] |
|
| 47 | + */ |
|
| 48 | 48 | protected $implements = array(); |
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * @var string |
|
| 52 | - */ |
|
| 50 | + /** |
|
| 51 | + * @var string |
|
| 52 | + */ |
|
| 53 | 53 | protected $name; |
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * @var string |
|
| 57 | - */ |
|
| 55 | + /** |
|
| 56 | + * @var string |
|
| 57 | + */ |
|
| 58 | 58 | protected $declaration; |
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * @var string |
|
| 62 | - */ |
|
| 60 | + /** |
|
| 61 | + * @var string |
|
| 62 | + */ |
|
| 63 | 63 | protected $keyword; |
| 64 | 64 | |
| 65 | - /** |
|
| 66 | - * @param FileHelper_PHPClassInfo $info The class info instance. |
|
| 67 | - * @param string $declaration The full class declaration, e.g. "class SomeName extends SomeOtherClass". |
|
| 68 | - * @param string $keyword The class keyword, if any, i.e. "abstract" or "final". |
|
| 69 | - */ |
|
| 65 | + /** |
|
| 66 | + * @param FileHelper_PHPClassInfo $info The class info instance. |
|
| 67 | + * @param string $declaration The full class declaration, e.g. "class SomeName extends SomeOtherClass". |
|
| 68 | + * @param string $keyword The class keyword, if any, i.e. "abstract" or "final". |
|
| 69 | + */ |
|
| 70 | 70 | public function __construct(FileHelper_PHPClassInfo $info, string $declaration, string $keyword) |
| 71 | 71 | { |
| 72 | 72 | $this->info = $info; |
@@ -76,31 +76,31 @@ discard block |
||
| 76 | 76 | $this->analyzeCode(); |
| 77 | 77 | } |
| 78 | 78 | |
| 79 | - /** |
|
| 80 | - * Check if this class is a subclass of the specified |
|
| 81 | - * class name. |
|
| 82 | - * |
|
| 83 | - * @param string $className |
|
| 84 | - * @return bool |
|
| 85 | - */ |
|
| 79 | + /** |
|
| 80 | + * Check if this class is a subclass of the specified |
|
| 81 | + * class name. |
|
| 82 | + * |
|
| 83 | + * @param string $className |
|
| 84 | + * @return bool |
|
| 85 | + */ |
|
| 86 | 86 | public function isSublassOf(string $className) : bool |
| 87 | 87 | { |
| 88 | 88 | return is_subclass_of($this->getNameNS(), $className); |
| 89 | 89 | } |
| 90 | 90 | |
| 91 | - /** |
|
| 92 | - * The class name without namespace. |
|
| 93 | - * @return string |
|
| 94 | - */ |
|
| 91 | + /** |
|
| 92 | + * The class name without namespace. |
|
| 93 | + * @return string |
|
| 94 | + */ |
|
| 95 | 95 | public function getName() : string |
| 96 | 96 | { |
| 97 | 97 | return $this->name; |
| 98 | 98 | } |
| 99 | 99 | |
| 100 | - /** |
|
| 101 | - * The absolute class name with namespace (if any). |
|
| 102 | - * @return string |
|
| 103 | - */ |
|
| 100 | + /** |
|
| 101 | + * The absolute class name with namespace (if any). |
|
| 102 | + * @return string |
|
| 103 | + */ |
|
| 104 | 104 | public function getNameNS() : string |
| 105 | 105 | { |
| 106 | 106 | $name = $this->getName(); |
@@ -112,48 +112,48 @@ discard block |
||
| 112 | 112 | return $name; |
| 113 | 113 | } |
| 114 | 114 | |
| 115 | - /** |
|
| 116 | - * Whether it is an abstract class. |
|
| 117 | - * @return bool |
|
| 118 | - */ |
|
| 115 | + /** |
|
| 116 | + * Whether it is an abstract class. |
|
| 117 | + * @return bool |
|
| 118 | + */ |
|
| 119 | 119 | public function isAbstract() : bool |
| 120 | 120 | { |
| 121 | 121 | return $this->abstract; |
| 122 | 122 | } |
| 123 | 123 | |
| 124 | - /** |
|
| 125 | - * Whether it is a final class. |
|
| 126 | - * @return bool |
|
| 127 | - */ |
|
| 124 | + /** |
|
| 125 | + * Whether it is a final class. |
|
| 126 | + * @return bool |
|
| 127 | + */ |
|
| 128 | 128 | public function isFinal() : bool |
| 129 | 129 | { |
| 130 | 130 | return $this->final; |
| 131 | 131 | } |
| 132 | 132 | |
| 133 | - /** |
|
| 134 | - * The name of the class that this class extends (with namespace, if specified). |
|
| 135 | - * @return string |
|
| 136 | - */ |
|
| 133 | + /** |
|
| 134 | + * The name of the class that this class extends (with namespace, if specified). |
|
| 135 | + * @return string |
|
| 136 | + */ |
|
| 137 | 137 | public function getExtends() : string |
| 138 | 138 | { |
| 139 | 139 | return $this->extends; |
| 140 | 140 | } |
| 141 | 141 | |
| 142 | - /** |
|
| 143 | - * A list of interfaces the class implements, if any. |
|
| 144 | - * @return array |
|
| 145 | - */ |
|
| 142 | + /** |
|
| 143 | + * A list of interfaces the class implements, if any. |
|
| 144 | + * @return array |
|
| 145 | + */ |
|
| 146 | 146 | public function getImplements() : array |
| 147 | 147 | { |
| 148 | 148 | return $this->implements; |
| 149 | 149 | } |
| 150 | 150 | |
| 151 | - /** |
|
| 152 | - * The class declaration string, with normalized spaces and sorted interface names. |
|
| 153 | - * NOTE: does not include the keyword "abstract" or "final". |
|
| 154 | - * |
|
| 155 | - * @return string |
|
| 156 | - */ |
|
| 151 | + /** |
|
| 152 | + * The class declaration string, with normalized spaces and sorted interface names. |
|
| 153 | + * NOTE: does not include the keyword "abstract" or "final". |
|
| 154 | + * |
|
| 155 | + * @return string |
|
| 156 | + */ |
|
| 157 | 157 | public function getDeclaration() : string |
| 158 | 158 | { |
| 159 | 159 | $parts = array(); |
@@ -173,10 +173,10 @@ discard block |
||
| 173 | 173 | return implode(' ', $parts); |
| 174 | 174 | } |
| 175 | 175 | |
| 176 | - /** |
|
| 177 | - * The keyword before "class", e.g. "abstract". |
|
| 178 | - * @return string |
|
| 179 | - */ |
|
| 176 | + /** |
|
| 177 | + * The keyword before "class", e.g. "abstract". |
|
| 178 | + * @return string |
|
| 179 | + */ |
|
| 180 | 180 | public function getKeyword() : string |
| 181 | 181 | { |
| 182 | 182 | return $this->keyword; |
@@ -105,7 +105,7 @@ discard block |
||
| 105 | 105 | { |
| 106 | 106 | $name = $this->getName(); |
| 107 | 107 | |
| 108 | - if($this->info->hasNamespace()) { |
|
| 108 | + if ($this->info->hasNamespace()) { |
|
| 109 | 109 | $name = $this->info->getNamespace().'\\'.$this->name; |
| 110 | 110 | } |
| 111 | 111 | |
@@ -160,12 +160,12 @@ discard block |
||
| 160 | 160 | $parts[] = 'class'; |
| 161 | 161 | $parts[] = $this->getName(); |
| 162 | 162 | |
| 163 | - if(!empty($this->extends)) { |
|
| 163 | + if (!empty($this->extends)) { |
|
| 164 | 164 | $parts[] = 'extends'; |
| 165 | 165 | $parts[] = $this->extends; |
| 166 | 166 | } |
| 167 | 167 | |
| 168 | - if(!empty($this->implements)) { |
|
| 168 | + if (!empty($this->implements)) { |
|
| 169 | 169 | $parts[] = 'implements'; |
| 170 | 170 | $parts[] = implode(', ', $this->implements); |
| 171 | 171 | } |
@@ -184,9 +184,9 @@ discard block |
||
| 184 | 184 | |
| 185 | 185 | protected function analyzeCode() |
| 186 | 186 | { |
| 187 | - if($this->keyword == 'abstract') { |
|
| 187 | + if ($this->keyword == 'abstract') { |
|
| 188 | 188 | $this->abstract = true; |
| 189 | - } else if($this->keyword == 'final') { |
|
| 189 | + } else if ($this->keyword == 'final') { |
|
| 190 | 190 | $this->final = true; |
| 191 | 191 | } |
| 192 | 192 | |
@@ -203,16 +203,16 @@ discard block |
||
| 203 | 203 | |
| 204 | 204 | $tokenName = 'none'; |
| 205 | 205 | |
| 206 | - foreach($parts as $part) |
|
| 206 | + foreach ($parts as $part) |
|
| 207 | 207 | { |
| 208 | 208 | $part = str_replace(',', '', $part); |
| 209 | 209 | $part = trim($part); |
| 210 | - if(empty($part)) { |
|
| 210 | + if (empty($part)) { |
|
| 211 | 211 | continue; |
| 212 | 212 | } |
| 213 | 213 | |
| 214 | 214 | $name = strtolower($part); |
| 215 | - if($name == 'extends' || $name == 'implements') { |
|
| 215 | + if ($name == 'extends' || $name == 'implements') { |
|
| 216 | 216 | $tokenName = $name; |
| 217 | 217 | continue; |
| 218 | 218 | } |
@@ -222,13 +222,13 @@ discard block |
||
| 222 | 222 | |
| 223 | 223 | $this->implements = $tokens['implements']; |
| 224 | 224 | |
| 225 | - if(!empty($this->implements)) { |
|
| 225 | + if (!empty($this->implements)) { |
|
| 226 | 226 | usort($this->implements, function(string $a, string $b) { |
| 227 | 227 | return strnatcasecmp($a, $b); |
| 228 | 228 | }); |
| 229 | 229 | } |
| 230 | 230 | |
| 231 | - if(!empty($tokens['extends'])) { |
|
| 231 | + if (!empty($tokens['extends'])) { |
|
| 232 | 232 | $this->extends = $tokens['extends'][0]; |
| 233 | 233 | } |
| 234 | 234 | } |
@@ -18,23 +18,23 @@ discard block |
||
| 18 | 18 | |
| 19 | 19 | public function __construct(array $size) |
| 20 | 20 | { |
| 21 | - if(!isset($size['width'])) { |
|
| 21 | + if (!isset($size['width'])) { |
|
| 22 | 22 | $size['width'] = $size[0]; |
| 23 | 23 | } |
| 24 | 24 | |
| 25 | - if(!isset($size['height'])) { |
|
| 25 | + if (!isset($size['height'])) { |
|
| 26 | 26 | $size['height'] = $size[1]; |
| 27 | 27 | } |
| 28 | 28 | |
| 29 | - if(!isset($size[0])) { |
|
| 29 | + if (!isset($size[0])) { |
|
| 30 | 30 | $size[0] = $size['width']; |
| 31 | 31 | } |
| 32 | 32 | |
| 33 | - if(!isset($size[1])) { |
|
| 33 | + if (!isset($size[1])) { |
|
| 34 | 34 | $size[1] = $size['height']; |
| 35 | 35 | } |
| 36 | 36 | |
| 37 | - if(!isset($size['channels'])) { |
|
| 37 | + if (!isset($size['channels'])) { |
|
| 38 | 38 | $size['channels'] = 1; |
| 39 | 39 | } |
| 40 | 40 | |
@@ -68,7 +68,7 @@ discard block |
||
| 68 | 68 | |
| 69 | 69 | public function offsetGet($offset) |
| 70 | 70 | { |
| 71 | - if(isset($this->size[$offset])) { |
|
| 71 | + if (isset($this->size[$offset])) { |
|
| 72 | 72 | return $this->size[$offset]; |
| 73 | 73 | } |
| 74 | 74 | |
@@ -77,7 +77,7 @@ discard block |
||
| 77 | 77 | |
| 78 | 78 | public function offsetSet($offset, $value) |
| 79 | 79 | { |
| 80 | - if(is_null($offset)) { |
|
| 80 | + if (is_null($offset)) { |
|
| 81 | 81 | $this->size[] = $value; |
| 82 | 82 | } else { |
| 83 | 83 | $this->size[$offset] = $value; |
@@ -7,9 +7,9 @@ |
||
| 7 | 7 | * @author Sebastian Mordziol <[email protected]> |
| 8 | 8 | */ |
| 9 | 9 | |
| 10 | - /** |
|
| 11 | - * Examples environment config |
|
| 12 | - */ |
|
| 10 | + /** |
|
| 11 | + * Examples environment config |
|
| 12 | + */ |
|
| 13 | 13 | require_once '../prepend.php'; |
| 14 | 14 | |
| 15 | 15 | use function AppUtils\parseURL; |
@@ -42,7 +42,7 @@ |
||
| 42 | 42 | <br> |
| 43 | 43 | <?php |
| 44 | 44 | |
| 45 | - foreach($urls as $url) |
|
| 45 | + foreach ($urls as $url) |
|
| 46 | 46 | { |
| 47 | 47 | $info = parseURL($url); |
| 48 | 48 | |
@@ -17,33 +17,33 @@ |
||
| 17 | 17 | die('<b>ERROR:</b> Autoloader not present. Run composer update first.'); |
| 18 | 18 | } |
| 19 | 19 | |
| 20 | - /** |
|
| 21 | - * The composer autoloader |
|
| 22 | - */ |
|
| 20 | + /** |
|
| 21 | + * The composer autoloader |
|
| 22 | + */ |
|
| 23 | 23 | require_once $autoload; |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * Translation global function. |
|
| 27 | - * @return string |
|
| 28 | - */ |
|
| 25 | + /** |
|
| 26 | + * Translation global function. |
|
| 27 | + * @return string |
|
| 28 | + */ |
|
| 29 | 29 | function t() |
| 30 | 30 | { |
| 31 | 31 | return call_user_func_array('\AppLocalize\t', func_get_args()); |
| 32 | 32 | } |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * Translation global function. |
|
| 36 | - * @return string |
|
| 37 | - */ |
|
| 34 | + /** |
|
| 35 | + * Translation global function. |
|
| 36 | + * @return string |
|
| 37 | + */ |
|
| 38 | 38 | function pt() |
| 39 | 39 | { |
| 40 | 40 | return call_user_func_array('\AppLocalize\pt', func_get_args()); |
| 41 | 41 | } |
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * Translation global function. |
|
| 45 | - * @return string |
|
| 46 | - */ |
|
| 43 | + /** |
|
| 44 | + * Translation global function. |
|
| 45 | + * @return string |
|
| 46 | + */ |
|
| 47 | 47 | function pts() |
| 48 | 48 | { |
| 49 | 49 | return call_user_func_array('\AppLocalize\pts', func_get_args()); |
@@ -12,7 +12,7 @@ |
||
| 12 | 12 | $autoload = realpath($root.'/../vendor/autoload.php'); |
| 13 | 13 | |
| 14 | 14 | // we need the autoloader to be present |
| 15 | - if($autoload === false) |
|
| 15 | + if ($autoload === false) |
|
| 16 | 16 | { |
| 17 | 17 | die('<b>ERROR:</b> Autoloader not present. Run composer update first.'); |
| 18 | 18 | } |
@@ -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; |
@@ -166,7 +166,7 @@ discard block |
||
| 166 | 166 | |
| 167 | 167 | public function isHeadersPosition($position) |
| 168 | 168 | { |
| 169 | - if($this->headersPosition === $position) { |
|
| 169 | + if ($this->headersPosition === $position) { |
|
| 170 | 170 | return true; |
| 171 | 171 | } |
| 172 | 172 | |
@@ -193,7 +193,7 @@ discard block |
||
| 193 | 193 | self::HEADERS_TOP |
| 194 | 194 | ); |
| 195 | 195 | |
| 196 | - if(!in_array($position, $validPositions)) { |
|
| 196 | + if (!in_array($position, $validPositions)) { |
|
| 197 | 197 | throw new CSVHelper_Exception( |
| 198 | 198 | 'Invalid headers position', |
| 199 | 199 | sprintf( |
@@ -249,7 +249,7 @@ discard block |
||
| 249 | 249 | */ |
| 250 | 250 | public function getRow($index) |
| 251 | 251 | { |
| 252 | - if(isset($this->data[$index])) { |
|
| 252 | + if (isset($this->data[$index])) { |
|
| 253 | 253 | return $this->data[$index]; |
| 254 | 254 | } |
| 255 | 255 | |
@@ -316,9 +316,9 @@ discard block |
||
| 316 | 316 | public function getColumn($index) |
| 317 | 317 | { |
| 318 | 318 | $data = array(); |
| 319 | - for($i=0; $i < $this->rowCount; $i++) { |
|
| 319 | + for ($i = 0; $i < $this->rowCount; $i++) { |
|
| 320 | 320 | $value = ''; |
| 321 | - if(isset($this->data[$i][$index])) { |
|
| 321 | + if (isset($this->data[$i][$index])) { |
|
| 322 | 322 | $value = $this->data[$i][$index]; |
| 323 | 323 | } |
| 324 | 324 | |
@@ -335,7 +335,7 @@ discard block |
||
| 335 | 335 | */ |
| 336 | 336 | public function columnExists($index) |
| 337 | 337 | { |
| 338 | - if($index < $this->columnCount) { |
|
| 338 | + if ($index < $this->columnCount) { |
|
| 339 | 339 | return true; |
| 340 | 340 | } |
| 341 | 341 | |
@@ -346,7 +346,7 @@ discard block |
||
| 346 | 346 | { |
| 347 | 347 | $this->reset(); |
| 348 | 348 | |
| 349 | - if(empty(trim($this->csv))) { |
|
| 349 | + if (empty(trim($this->csv))) { |
|
| 350 | 350 | $this->addError('Tried to parse an empty CSV string.'); |
| 351 | 351 | return; |
| 352 | 352 | } |
@@ -361,12 +361,12 @@ discard block |
||
| 361 | 361 | $parser->delimiter = $this->detectSeparator(); |
| 362 | 362 | |
| 363 | 363 | $result = $parser->parse_string(/** @scrutinizer ignore-type */ $this->csv); |
| 364 | - if(!$result) { |
|
| 364 | + if (!$result) { |
|
| 365 | 365 | $this->addError('The CSV string could not be parsed.'); |
| 366 | 366 | return; |
| 367 | 367 | } |
| 368 | 368 | |
| 369 | - switch($this->headersPosition) |
|
| 369 | + switch ($this->headersPosition) |
|
| 370 | 370 | { |
| 371 | 371 | case self::HEADERS_TOP: |
| 372 | 372 | $this->headers = array_shift($result); |
@@ -375,7 +375,7 @@ discard block |
||
| 375 | 375 | case self::HEADERS_LEFT: |
| 376 | 376 | $keep = array(); |
| 377 | 377 | $total = count($result); |
| 378 | - for($i=0; $i < $total; $i++) { |
|
| 378 | + for ($i = 0; $i < $total; $i++) { |
|
| 379 | 379 | $row = $result[$i]; |
| 380 | 380 | $this->headers[] = array_shift($row); |
| 381 | 381 | $keep[] = $row; |
@@ -388,9 +388,9 @@ discard block |
||
| 388 | 388 | $this->data = $result; |
| 389 | 389 | $this->rowCount = count($this->data); |
| 390 | 390 | |
| 391 | - for($i=0; $i < $this->rowCount; $i++) { |
|
| 391 | + for ($i = 0; $i < $this->rowCount; $i++) { |
|
| 392 | 392 | $amount = count($this->data[$i]); |
| 393 | - if($amount > $this->columnCount) { |
|
| 393 | + if ($amount > $this->columnCount) { |
|
| 394 | 394 | $this->columnCount = $amount; |
| 395 | 395 | } |
| 396 | 396 | } |
@@ -434,8 +434,8 @@ discard block |
||
| 434 | 434 | ',,' => ',' |
| 435 | 435 | ); |
| 436 | 436 | |
| 437 | - foreach($search as $char => $separator) { |
|
| 438 | - if(strstr($this->csv, $char)) { |
|
| 437 | + foreach ($search as $char => $separator) { |
|
| 438 | + if (strstr($this->csv, $char)) { |
|
| 439 | 439 | return $separator; |
| 440 | 440 | } |
| 441 | 441 | } |
@@ -29,19 +29,19 @@ discard block |
||
| 29 | 29 | const TYPE_LF = 'LF'; |
| 30 | 30 | const TYPE_CR = 'CR'; |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * @var string |
|
| 34 | - */ |
|
| 32 | + /** |
|
| 33 | + * @var string |
|
| 34 | + */ |
|
| 35 | 35 | protected $char; |
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * @var string |
|
| 39 | - */ |
|
| 37 | + /** |
|
| 38 | + * @var string |
|
| 39 | + */ |
|
| 40 | 40 | protected $type; |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @var string |
|
| 44 | - */ |
|
| 42 | + /** |
|
| 43 | + * @var string |
|
| 44 | + */ |
|
| 45 | 45 | protected $description; |
| 46 | 46 | |
| 47 | 47 | public function __construct(string $char, string $type, string $description) |
@@ -51,33 +51,33 @@ discard block |
||
| 51 | 51 | $this->description = $description; |
| 52 | 52 | } |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * The actual EOL character. |
|
| 56 | - * @return string |
|
| 57 | - */ |
|
| 54 | + /** |
|
| 55 | + * The actual EOL character. |
|
| 56 | + * @return string |
|
| 57 | + */ |
|
| 58 | 58 | public function getCharacter() : string |
| 59 | 59 | { |
| 60 | 60 | return $this->char; |
| 61 | 61 | } |
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * A more detailed, human readable description of the character. |
|
| 65 | - * @return string |
|
| 66 | - */ |
|
| 63 | + /** |
|
| 64 | + * A more detailed, human readable description of the character. |
|
| 65 | + * @return string |
|
| 66 | + */ |
|
| 67 | 67 | public function getDescription() : string |
| 68 | 68 | { |
| 69 | 69 | return $this->description; |
| 70 | 70 | } |
| 71 | 71 | |
| 72 | - /** |
|
| 73 | - * The EOL character type, e.g. "CR+LF", "CR"... |
|
| 74 | - * @return string |
|
| 75 | - * |
|
| 76 | - * @see ConvertHelper_EOL::TYPE_CR |
|
| 77 | - * @see ConvertHelper_EOL::TYPE_CRLF |
|
| 78 | - * @see ConvertHelper_EOL::TYPE_LF |
|
| 79 | - * @see ConvertHelper_EOL::TYPE_LFCR |
|
| 80 | - */ |
|
| 72 | + /** |
|
| 73 | + * The EOL character type, e.g. "CR+LF", "CR"... |
|
| 74 | + * @return string |
|
| 75 | + * |
|
| 76 | + * @see ConvertHelper_EOL::TYPE_CR |
|
| 77 | + * @see ConvertHelper_EOL::TYPE_CRLF |
|
| 78 | + * @see ConvertHelper_EOL::TYPE_LF |
|
| 79 | + * @see ConvertHelper_EOL::TYPE_LFCR |
|
| 80 | + */ |
|
| 81 | 81 | public function getType() : string |
| 82 | 82 | { |
| 83 | 83 | return $this->type; |
@@ -41,7 +41,7 @@ discard block |
||
| 41 | 41 | */ |
| 42 | 42 | public function setOption(string $name, $value) |
| 43 | 43 | { |
| 44 | - if(!isset($this->options)) { |
|
| 44 | + if (!isset($this->options)) { |
|
| 45 | 45 | $this->options = $this->getDefaultOptions(); |
| 46 | 46 | } |
| 47 | 47 | |
@@ -58,7 +58,7 @@ discard block |
||
| 58 | 58 | */ |
| 59 | 59 | public function setOptions(array $options) |
| 60 | 60 | { |
| 61 | - foreach($options as $name => $value) { |
|
| 61 | + foreach ($options as $name => $value) { |
|
| 62 | 62 | $this->setOption($name, $value); |
| 63 | 63 | } |
| 64 | 64 | |
@@ -75,13 +75,13 @@ discard block |
||
| 75 | 75 | * @param mixed $default The default value to return if the option does not exist. |
| 76 | 76 | * @return mixed |
| 77 | 77 | */ |
| 78 | - public function getOption(string $name, $default=null) |
|
| 78 | + public function getOption(string $name, $default = null) |
|
| 79 | 79 | { |
| 80 | - if(!isset($this->options)) { |
|
| 80 | + if (!isset($this->options)) { |
|
| 81 | 81 | $this->options = $this->getDefaultOptions(); |
| 82 | 82 | } |
| 83 | 83 | |
| 84 | - if(isset($this->options[$name])) { |
|
| 84 | + if (isset($this->options[$name])) { |
|
| 85 | 85 | return $this->options[$name]; |
| 86 | 86 | } |
| 87 | 87 | |
@@ -98,11 +98,11 @@ discard block |
||
| 98 | 98 | * @param string $default Used if the option does not exist, is invalid, or empty. |
| 99 | 99 | * @return string |
| 100 | 100 | */ |
| 101 | - public function getStringOption(string $name, string $default='') : string |
|
| 101 | + public function getStringOption(string $name, string $default = '') : string |
|
| 102 | 102 | { |
| 103 | 103 | $value = $this->getOption($name, false); |
| 104 | 104 | |
| 105 | - if((is_string($value) || is_numeric($value)) && !empty($value)) { |
|
| 105 | + if ((is_string($value) || is_numeric($value)) && !empty($value)) { |
|
| 106 | 106 | return (string)$value; |
| 107 | 107 | } |
| 108 | 108 | |
@@ -118,9 +118,9 @@ discard block |
||
| 118 | 118 | * @param string $name |
| 119 | 119 | * @return bool |
| 120 | 120 | */ |
| 121 | - public function getBoolOption(string $name, bool $default=false) : bool |
|
| 121 | + public function getBoolOption(string $name, bool $default = false) : bool |
|
| 122 | 122 | { |
| 123 | - if($this->getOption($name) === true) { |
|
| 123 | + if ($this->getOption($name) === true) { |
|
| 124 | 124 | return true; |
| 125 | 125 | } |
| 126 | 126 | |
@@ -136,10 +136,10 @@ discard block |
||
| 136 | 136 | * @param int $default |
| 137 | 137 | * @return int |
| 138 | 138 | */ |
| 139 | - public function getIntOption(string $name, int $default=0) : int |
|
| 139 | + public function getIntOption(string $name, int $default = 0) : int |
|
| 140 | 140 | { |
| 141 | 141 | $value = $this->getOption($name); |
| 142 | - if(ConvertHelper::isInteger($value)) { |
|
| 142 | + if (ConvertHelper::isInteger($value)) { |
|
| 143 | 143 | return (int)$value; |
| 144 | 144 | } |
| 145 | 145 | |
@@ -157,7 +157,7 @@ discard block |
||
| 157 | 157 | public function getArrayOption(string $name) : array |
| 158 | 158 | { |
| 159 | 159 | $val = $this->getOption($name); |
| 160 | - if(is_array($val)) { |
|
| 160 | + if (is_array($val)) { |
|
| 161 | 161 | return $val; |
| 162 | 162 | } |
| 163 | 163 | |
@@ -173,7 +173,7 @@ discard block |
||
| 173 | 173 | */ |
| 174 | 174 | public function hasOption(string $name) : bool |
| 175 | 175 | { |
| 176 | - if(!isset($this->options)) { |
|
| 176 | + if (!isset($this->options)) { |
|
| 177 | 177 | $this->options = $this->getDefaultOptions(); |
| 178 | 178 | } |
| 179 | 179 | |
@@ -186,7 +186,7 @@ discard block |
||
| 186 | 186 | */ |
| 187 | 187 | public function getOptions() : array |
| 188 | 188 | { |
| 189 | - if(!isset($this->options)) { |
|
| 189 | + if (!isset($this->options)) { |
|
| 190 | 190 | $this->options = $this->getDefaultOptions(); |
| 191 | 191 | } |
| 192 | 192 | |
@@ -240,7 +240,7 @@ discard block |
||
| 240 | 240 | * @param mixed $default |
| 241 | 241 | * @return Interface_Optionable |
| 242 | 242 | */ |
| 243 | - function getOption(string $name, $default=null); |
|
| 243 | + function getOption(string $name, $default = null); |
|
| 244 | 244 | |
| 245 | 245 | /** |
| 246 | 246 | * @param array $options |
@@ -26,18 +26,18 @@ discard block |
||
| 26 | 26 | */ |
| 27 | 27 | trait Traits_Optionable |
| 28 | 28 | { |
| 29 | - /** |
|
| 30 | - * @var array |
|
| 31 | - */ |
|
| 29 | + /** |
|
| 30 | + * @var array |
|
| 31 | + */ |
|
| 32 | 32 | protected $options; |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * Sets an option to the specified value. This can be any |
|
| 36 | - * kind of variable type, including objects, as needed. |
|
| 37 | - * |
|
| 38 | - * @param string $name |
|
| 39 | - * @param mixed $value |
|
| 40 | - */ |
|
| 34 | + /** |
|
| 35 | + * Sets an option to the specified value. This can be any |
|
| 36 | + * kind of variable type, including objects, as needed. |
|
| 37 | + * |
|
| 38 | + * @param string $name |
|
| 39 | + * @param mixed $value |
|
| 40 | + */ |
|
| 41 | 41 | public function setOption(string $name, $value) |
| 42 | 42 | { |
| 43 | 43 | if(!isset($this->options)) { |
@@ -48,12 +48,12 @@ discard block |
||
| 48 | 48 | return $this; |
| 49 | 49 | } |
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * Sets a collection of options at once, from an |
|
| 53 | - * associative array. |
|
| 54 | - * |
|
| 55 | - * @param array $options |
|
| 56 | - */ |
|
| 51 | + /** |
|
| 52 | + * Sets a collection of options at once, from an |
|
| 53 | + * associative array. |
|
| 54 | + * |
|
| 55 | + * @param array $options |
|
| 56 | + */ |
|
| 57 | 57 | public function setOptions(array $options) |
| 58 | 58 | { |
| 59 | 59 | foreach($options as $name => $value) { |
@@ -63,16 +63,16 @@ discard block |
||
| 63 | 63 | return $this; |
| 64 | 64 | } |
| 65 | 65 | |
| 66 | - /** |
|
| 67 | - * Retrieves an option's value. |
|
| 68 | - * |
|
| 69 | - * NOTE: Use the specialized type getters to ensure an option |
|
| 70 | - * contains the expected type (for ex. getArrayOption()). |
|
| 71 | - * |
|
| 72 | - * @param string $name |
|
| 73 | - * @param mixed $default The default value to return if the option does not exist. |
|
| 74 | - * @return mixed |
|
| 75 | - */ |
|
| 66 | + /** |
|
| 67 | + * Retrieves an option's value. |
|
| 68 | + * |
|
| 69 | + * NOTE: Use the specialized type getters to ensure an option |
|
| 70 | + * contains the expected type (for ex. getArrayOption()). |
|
| 71 | + * |
|
| 72 | + * @param string $name |
|
| 73 | + * @param mixed $default The default value to return if the option does not exist. |
|
| 74 | + * @return mixed |
|
| 75 | + */ |
|
| 76 | 76 | public function getOption(string $name, $default=null) |
| 77 | 77 | { |
| 78 | 78 | if(!isset($this->options)) { |
@@ -86,16 +86,16 @@ discard block |
||
| 86 | 86 | return $default; |
| 87 | 87 | } |
| 88 | 88 | |
| 89 | - /** |
|
| 90 | - * Enforces that the option value is a string. Numbers are converted |
|
| 91 | - * to string, strings are passed through, and all other types will |
|
| 92 | - * return the default value. The default value is also returned if |
|
| 93 | - * the string is empty. |
|
| 94 | - * |
|
| 95 | - * @param string $name |
|
| 96 | - * @param string $default Used if the option does not exist, is invalid, or empty. |
|
| 97 | - * @return string |
|
| 98 | - */ |
|
| 89 | + /** |
|
| 90 | + * Enforces that the option value is a string. Numbers are converted |
|
| 91 | + * to string, strings are passed through, and all other types will |
|
| 92 | + * return the default value. The default value is also returned if |
|
| 93 | + * the string is empty. |
|
| 94 | + * |
|
| 95 | + * @param string $name |
|
| 96 | + * @param string $default Used if the option does not exist, is invalid, or empty. |
|
| 97 | + * @return string |
|
| 98 | + */ |
|
| 99 | 99 | public function getStringOption(string $name, string $default='') : string |
| 100 | 100 | { |
| 101 | 101 | $value = $this->getOption($name, false); |
@@ -107,15 +107,15 @@ discard block |
||
| 107 | 107 | return $default; |
| 108 | 108 | } |
| 109 | 109 | |
| 110 | - /** |
|
| 111 | - * Treats the option value as a boolean value: will return |
|
| 112 | - * true if the value actually is a boolean true. |
|
| 113 | - * |
|
| 114 | - * NOTE: boolean string representations are not accepted. |
|
| 115 | - * |
|
| 116 | - * @param string $name |
|
| 117 | - * @return bool |
|
| 118 | - */ |
|
| 110 | + /** |
|
| 111 | + * Treats the option value as a boolean value: will return |
|
| 112 | + * true if the value actually is a boolean true. |
|
| 113 | + * |
|
| 114 | + * NOTE: boolean string representations are not accepted. |
|
| 115 | + * |
|
| 116 | + * @param string $name |
|
| 117 | + * @return bool |
|
| 118 | + */ |
|
| 119 | 119 | public function getBoolOption(string $name, bool $default=false) : bool |
| 120 | 120 | { |
| 121 | 121 | if($this->getOption($name) === true) { |
@@ -125,15 +125,15 @@ discard block |
||
| 125 | 125 | return $default; |
| 126 | 126 | } |
| 127 | 127 | |
| 128 | - /** |
|
| 129 | - * Treats the option value as an integer value: will return |
|
| 130 | - * valid integer values (also from integer strings), or the |
|
| 131 | - * default value otherwise. |
|
| 132 | - * |
|
| 133 | - * @param string $name |
|
| 134 | - * @param int $default |
|
| 135 | - * @return int |
|
| 136 | - */ |
|
| 128 | + /** |
|
| 129 | + * Treats the option value as an integer value: will return |
|
| 130 | + * valid integer values (also from integer strings), or the |
|
| 131 | + * default value otherwise. |
|
| 132 | + * |
|
| 133 | + * @param string $name |
|
| 134 | + * @param int $default |
|
| 135 | + * @return int |
|
| 136 | + */ |
|
| 137 | 137 | public function getIntOption(string $name, int $default=0) : int |
| 138 | 138 | { |
| 139 | 139 | $value = $this->getOption($name); |
@@ -144,14 +144,14 @@ discard block |
||
| 144 | 144 | return $default; |
| 145 | 145 | } |
| 146 | 146 | |
| 147 | - /** |
|
| 148 | - * Treats an option as an array, and returns its value |
|
| 149 | - * only if it contains an array - otherwise, an empty |
|
| 150 | - * array is returned. |
|
| 151 | - * |
|
| 152 | - * @param string $name |
|
| 153 | - * @return array |
|
| 154 | - */ |
|
| 147 | + /** |
|
| 148 | + * Treats an option as an array, and returns its value |
|
| 149 | + * only if it contains an array - otherwise, an empty |
|
| 150 | + * array is returned. |
|
| 151 | + * |
|
| 152 | + * @param string $name |
|
| 153 | + * @return array |
|
| 154 | + */ |
|
| 155 | 155 | public function getArrayOption(string $name) : array |
| 156 | 156 | { |
| 157 | 157 | $val = $this->getOption($name); |
@@ -162,13 +162,13 @@ discard block |
||
| 162 | 162 | return array(); |
| 163 | 163 | } |
| 164 | 164 | |
| 165 | - /** |
|
| 166 | - * Checks whether the specified option exists - even |
|
| 167 | - * if it has a NULL value. |
|
| 168 | - * |
|
| 169 | - * @param string $name |
|
| 170 | - * @return bool |
|
| 171 | - */ |
|
| 165 | + /** |
|
| 166 | + * Checks whether the specified option exists - even |
|
| 167 | + * if it has a NULL value. |
|
| 168 | + * |
|
| 169 | + * @param string $name |
|
| 170 | + * @return bool |
|
| 171 | + */ |
|
| 172 | 172 | public function hasOption(string $name) : bool |
| 173 | 173 | { |
| 174 | 174 | if(!isset($this->options)) { |
@@ -178,10 +178,10 @@ discard block |
||
| 178 | 178 | return array_key_exists($name, $this->options); |
| 179 | 179 | } |
| 180 | 180 | |
| 181 | - /** |
|
| 182 | - * Returns all options in one associative array. |
|
| 183 | - * @return array |
|
| 184 | - */ |
|
| 181 | + /** |
|
| 182 | + * Returns all options in one associative array. |
|
| 183 | + * @return array |
|
| 184 | + */ |
|
| 185 | 185 | public function getOptions() : array |
| 186 | 186 | { |
| 187 | 187 | if(!isset($this->options)) { |
@@ -191,24 +191,24 @@ discard block |
||
| 191 | 191 | return $this->options; |
| 192 | 192 | } |
| 193 | 193 | |
| 194 | - /** |
|
| 195 | - * Checks whether the option's value is the one specified. |
|
| 196 | - * |
|
| 197 | - * @param string $name |
|
| 198 | - * @param mixed $value |
|
| 199 | - * @return bool |
|
| 200 | - */ |
|
| 194 | + /** |
|
| 195 | + * Checks whether the option's value is the one specified. |
|
| 196 | + * |
|
| 197 | + * @param string $name |
|
| 198 | + * @param mixed $value |
|
| 199 | + * @return bool |
|
| 200 | + */ |
|
| 201 | 201 | public function isOption(string $name, $value) : bool |
| 202 | 202 | { |
| 203 | 203 | return $this->getOption($name) === $value; |
| 204 | 204 | } |
| 205 | 205 | |
| 206 | - /** |
|
| 207 | - * Retrieves the default available options as an |
|
| 208 | - * associative array with option name => value pairs. |
|
| 209 | - * |
|
| 210 | - * @return array |
|
| 211 | - */ |
|
| 206 | + /** |
|
| 207 | + * Retrieves the default available options as an |
|
| 208 | + * associative array with option name => value pairs. |
|
| 209 | + * |
|
| 210 | + * @return array |
|
| 211 | + */ |
|
| 212 | 212 | abstract public function getDefaultOptions() : array; |
| 213 | 213 | } |
| 214 | 214 | |
@@ -226,24 +226,24 @@ discard block |
||
| 226 | 226 | */ |
| 227 | 227 | interface Interface_Optionable |
| 228 | 228 | { |
| 229 | - /** |
|
| 230 | - * @param string $name |
|
| 231 | - * @param mixed $value |
|
| 232 | - * @return Interface_Optionable |
|
| 233 | - */ |
|
| 229 | + /** |
|
| 230 | + * @param string $name |
|
| 231 | + * @param mixed $value |
|
| 232 | + * @return Interface_Optionable |
|
| 233 | + */ |
|
| 234 | 234 | function setOption(string $name, $value); |
| 235 | 235 | |
| 236 | - /** |
|
| 237 | - * @param string $name |
|
| 238 | - * @param mixed $default |
|
| 239 | - * @return Interface_Optionable |
|
| 240 | - */ |
|
| 236 | + /** |
|
| 237 | + * @param string $name |
|
| 238 | + * @param mixed $default |
|
| 239 | + * @return Interface_Optionable |
|
| 240 | + */ |
|
| 241 | 241 | function getOption(string $name, $default=null); |
| 242 | 242 | |
| 243 | - /** |
|
| 244 | - * @param array $options |
|
| 245 | - * @return Interface_Optionable |
|
| 246 | - */ |
|
| 243 | + /** |
|
| 244 | + * @param array $options |
|
| 245 | + * @return Interface_Optionable |
|
| 246 | + */ |
|
| 247 | 247 | function setOptions(array $options); |
| 248 | 248 | function getOptions() : array; |
| 249 | 249 | function isOption(string $name, $value) : bool; |
@@ -151,8 +151,7 @@ discard block |
||
| 151 | 151 | $this->sourceImage = $resource; |
| 152 | 152 | $this->type = $type; |
| 153 | 153 | $this->info = self::getImageSize($resource); |
| 154 | - } |
|
| 155 | - else |
|
| 154 | + } else |
|
| 156 | 155 | { |
| 157 | 156 | $this->file = $sourceFile; |
| 158 | 157 | if (!file_exists($this->file)) { |
@@ -561,8 +560,7 @@ discard block |
||
| 561 | 560 | if ($this->width <= $this->height) |
| 562 | 561 | { |
| 563 | 562 | $this->resampleByWidth($width); |
| 564 | - } |
|
| 565 | - else |
|
| 563 | + } else |
|
| 566 | 564 | { |
| 567 | 565 | $this->resampleByHeight($height); |
| 568 | 566 | } |
@@ -1037,8 +1035,7 @@ discard block |
||
| 1037 | 1035 | { |
| 1038 | 1036 | $bg2 = imagecolorallocatealpha($im2, $color['red'], $color['green'], $color['blue'], $color['alpha']); |
| 1039 | 1037 | imagecolortransparent($im2, $bg2); |
| 1040 | - } |
|
| 1041 | - else |
|
| 1038 | + } else |
|
| 1042 | 1039 | { |
| 1043 | 1040 | $bg2 = imagecolorallocate($im2, $color['red'], $color['green'], $color['blue']); |
| 1044 | 1041 | } |
@@ -1348,8 +1345,7 @@ discard block |
||
| 1348 | 1345 | if(method_exists(__CLASS__, $method)) |
| 1349 | 1346 | { |
| 1350 | 1347 | $info = call_user_func(array(__CLASS__, $method), $pathOrResource); |
| 1351 | - } |
|
| 1352 | - else |
|
| 1348 | + } else |
|
| 1353 | 1349 | { |
| 1354 | 1350 | $info = getimagesize($pathOrResource); |
| 1355 | 1351 | } |
@@ -68,54 +68,54 @@ discard block |
||
| 68 | 68 | |
| 69 | 69 | const ERROR_UNEXPECTED_COLOR_VALUE = 513025; |
| 70 | 70 | |
| 71 | - /** |
|
| 72 | - * @var string |
|
| 73 | - */ |
|
| 71 | + /** |
|
| 72 | + * @var string |
|
| 73 | + */ |
|
| 74 | 74 | protected $file; |
| 75 | 75 | |
| 76 | - /** |
|
| 77 | - * @var ImageHelper_Size |
|
| 78 | - */ |
|
| 76 | + /** |
|
| 77 | + * @var ImageHelper_Size |
|
| 78 | + */ |
|
| 79 | 79 | protected $info; |
| 80 | 80 | |
| 81 | - /** |
|
| 82 | - * @var string |
|
| 83 | - */ |
|
| 81 | + /** |
|
| 82 | + * @var string |
|
| 83 | + */ |
|
| 84 | 84 | protected $type; |
| 85 | 85 | |
| 86 | - /** |
|
| 87 | - * @var resource|NULL |
|
| 88 | - */ |
|
| 86 | + /** |
|
| 87 | + * @var resource|NULL |
|
| 88 | + */ |
|
| 89 | 89 | protected $newImage; |
| 90 | 90 | |
| 91 | - /** |
|
| 92 | - * @var resource |
|
| 93 | - */ |
|
| 91 | + /** |
|
| 92 | + * @var resource |
|
| 93 | + */ |
|
| 94 | 94 | protected $sourceImage; |
| 95 | 95 | |
| 96 | - /** |
|
| 97 | - * @var int |
|
| 98 | - */ |
|
| 96 | + /** |
|
| 97 | + * @var int |
|
| 98 | + */ |
|
| 99 | 99 | protected $width; |
| 100 | 100 | |
| 101 | - /** |
|
| 102 | - * @var int |
|
| 103 | - */ |
|
| 101 | + /** |
|
| 102 | + * @var int |
|
| 103 | + */ |
|
| 104 | 104 | protected $height; |
| 105 | 105 | |
| 106 | - /** |
|
| 107 | - * @var int |
|
| 108 | - */ |
|
| 106 | + /** |
|
| 107 | + * @var int |
|
| 108 | + */ |
|
| 109 | 109 | protected $newWidth = 0; |
| 110 | 110 | |
| 111 | - /** |
|
| 112 | - * @var int |
|
| 113 | - */ |
|
| 111 | + /** |
|
| 112 | + * @var int |
|
| 113 | + */ |
|
| 114 | 114 | protected $newHeight = 0; |
| 115 | 115 | |
| 116 | - /** |
|
| 117 | - * @var int |
|
| 118 | - */ |
|
| 116 | + /** |
|
| 117 | + * @var int |
|
| 118 | + */ |
|
| 119 | 119 | protected $quality = 85; |
| 120 | 120 | |
| 121 | 121 | protected static $imageTypes = array( |
@@ -203,17 +203,17 @@ discard block |
||
| 203 | 203 | } |
| 204 | 204 | } |
| 205 | 205 | |
| 206 | - /** |
|
| 207 | - * Factory method: creates a new helper with a blank image. |
|
| 208 | - * |
|
| 209 | - * @param integer $width |
|
| 210 | - * @param integer $height |
|
| 211 | - * @param string $type The target file type when saving |
|
| 212 | - * @return ImageHelper |
|
| 213 | - * @throws ImageHelper_Exception |
|
| 214 | - * |
|
| 215 | - * @see ImageHelper::ERROR_CANNOT_CREATE_IMAGE_OBJECT |
|
| 216 | - */ |
|
| 206 | + /** |
|
| 207 | + * Factory method: creates a new helper with a blank image. |
|
| 208 | + * |
|
| 209 | + * @param integer $width |
|
| 210 | + * @param integer $height |
|
| 211 | + * @param string $type The target file type when saving |
|
| 212 | + * @return ImageHelper |
|
| 213 | + * @throws ImageHelper_Exception |
|
| 214 | + * |
|
| 215 | + * @see ImageHelper::ERROR_CANNOT_CREATE_IMAGE_OBJECT |
|
| 216 | + */ |
|
| 217 | 217 | public static function createNew($width, $height, $type='png') |
| 218 | 218 | { |
| 219 | 219 | $img = imagecreatetruecolor($width, $height); |
@@ -228,18 +228,18 @@ discard block |
||
| 228 | 228 | ); |
| 229 | 229 | } |
| 230 | 230 | |
| 231 | - /** |
|
| 232 | - * Factory method: creates an image helper from an |
|
| 233 | - * existing image resource. |
|
| 234 | - * |
|
| 235 | - * Note: while the resource is type independent, the |
|
| 236 | - * type parameter is required for some methods, as well |
|
| 237 | - * as to be able to save the image. |
|
| 238 | - * |
|
| 239 | - * @param resource $resource |
|
| 240 | - * @param string $type The target image type, e.g. "jpeg", "png", etc. |
|
| 241 | - * @return ImageHelper |
|
| 242 | - */ |
|
| 231 | + /** |
|
| 232 | + * Factory method: creates an image helper from an |
|
| 233 | + * existing image resource. |
|
| 234 | + * |
|
| 235 | + * Note: while the resource is type independent, the |
|
| 236 | + * type parameter is required for some methods, as well |
|
| 237 | + * as to be able to save the image. |
|
| 238 | + * |
|
| 239 | + * @param resource $resource |
|
| 240 | + * @param string $type The target image type, e.g. "jpeg", "png", etc. |
|
| 241 | + * @return ImageHelper |
|
| 242 | + */ |
|
| 243 | 243 | public static function createFromResource($resource, ?string $type=null) |
| 244 | 244 | { |
| 245 | 245 | self::requireResource($resource); |
@@ -247,29 +247,29 @@ discard block |
||
| 247 | 247 | return new ImageHelper(null, $resource, $type); |
| 248 | 248 | } |
| 249 | 249 | |
| 250 | - /** |
|
| 251 | - * Factory method: creates an image helper from an |
|
| 252 | - * image file on disk. |
|
| 253 | - * |
|
| 254 | - * @param string $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 | /** |
@@ -181,8 +181,7 @@ discard block |
||
| 181 | 181 | if($datefrom instanceof \DateTime) |
| 182 | 182 | { |
| 183 | 183 | $converter->setDateFrom($datefrom); |
| 184 | - } |
|
| 185 | - else |
|
| 184 | + } else |
|
| 186 | 185 | { |
| 187 | 186 | $converter->setDateFrom(self::timestamp2date($datefrom)); |
| 188 | 187 | } |
@@ -190,8 +189,7 @@ discard block |
||
| 190 | 189 | if($dateto instanceof \DateTime) |
| 191 | 190 | { |
| 192 | 191 | $converter->setDateTo($dateto); |
| 193 | - } |
|
| 194 | - else if($dateto > 0) |
|
| 192 | + } else if($dateto > 0) |
|
| 195 | 193 | { |
| 196 | 194 | $converter->setDateTo(self::timestamp2date($dateto)); |
| 197 | 195 | } |
@@ -58,13 +58,13 @@ discard block |
||
| 58 | 58 | return str_replace("\t", str_repeat(' ', $tabSize), $string); |
| 59 | 59 | } |
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * Converts spaces to tabs in the specified string. |
|
| 63 | - * |
|
| 64 | - * @param string $string |
|
| 65 | - * @param int $tabSize The amount of spaces per tab in the source string. |
|
| 66 | - * @return string |
|
| 67 | - */ |
|
| 61 | + /** |
|
| 62 | + * Converts spaces to tabs in the specified string. |
|
| 63 | + * |
|
| 64 | + * @param string $string |
|
| 65 | + * @param int $tabSize The amount of spaces per tab in the source string. |
|
| 66 | + * @return string |
|
| 67 | + */ |
|
| 68 | 68 | public static function spaces2tabs(string $string, int $tabSize=4) : string |
| 69 | 69 | { |
| 70 | 70 | return str_replace(str_repeat(' ', $tabSize), "\t", $string); |
@@ -77,14 +77,14 @@ discard block |
||
| 77 | 77 | return $converter->convert($string); |
| 78 | 78 | } |
| 79 | 79 | |
| 80 | - /** |
|
| 81 | - * Converts the specified amount of seconds into |
|
| 82 | - * a human readable string split in months, weeks, |
|
| 83 | - * days, hours, minutes and seconds. |
|
| 84 | - * |
|
| 85 | - * @param float $seconds |
|
| 86 | - * @return string |
|
| 87 | - */ |
|
| 80 | + /** |
|
| 81 | + * Converts the specified amount of seconds into |
|
| 82 | + * a human readable string split in months, weeks, |
|
| 83 | + * days, hours, minutes and seconds. |
|
| 84 | + * |
|
| 85 | + * @param float $seconds |
|
| 86 | + * @return string |
|
| 87 | + */ |
|
| 88 | 88 | public static function time2string($seconds) |
| 89 | 89 | { |
| 90 | 90 | static $units = null; |
@@ -156,41 +156,41 @@ discard block |
||
| 156 | 156 | return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last; |
| 157 | 157 | } |
| 158 | 158 | |
| 159 | - /** |
|
| 160 | - * Converts a timestamp into an easily understandable |
|
| 161 | - * format, e.g. "2 hours", "1 day", "3 months" |
|
| 162 | - * |
|
| 163 | - * If you set the date to parameter, the difference |
|
| 164 | - * will be calculated between the two dates and not |
|
| 165 | - * the current time. |
|
| 166 | - * |
|
| 167 | - * @param integer|\DateTime $datefrom |
|
| 168 | - * @param integer|\DateTime $dateto |
|
| 169 | - * @return string |
|
| 170 | - */ |
|
| 159 | + /** |
|
| 160 | + * Converts a timestamp into an easily understandable |
|
| 161 | + * format, e.g. "2 hours", "1 day", "3 months" |
|
| 162 | + * |
|
| 163 | + * If you set the date to parameter, the difference |
|
| 164 | + * will be calculated between the two dates and not |
|
| 165 | + * the current time. |
|
| 166 | + * |
|
| 167 | + * @param integer|\DateTime $datefrom |
|
| 168 | + * @param integer|\DateTime $dateto |
|
| 169 | + * @return string |
|
| 170 | + */ |
|
| 171 | 171 | public static function duration2string($datefrom, $dateto = -1) : string |
| 172 | 172 | { |
| 173 | - $converter = new ConvertHelper_DurationConverter(); |
|
| 173 | + $converter = new ConvertHelper_DurationConverter(); |
|
| 174 | 174 | |
| 175 | - if($datefrom instanceof \DateTime) |
|
| 176 | - { |
|
| 177 | - $converter->setDateFrom($datefrom); |
|
| 178 | - } |
|
| 179 | - else |
|
| 180 | - { |
|
| 181 | - $converter->setDateFrom(self::timestamp2date($datefrom)); |
|
| 182 | - } |
|
| 175 | + if($datefrom instanceof \DateTime) |
|
| 176 | + { |
|
| 177 | + $converter->setDateFrom($datefrom); |
|
| 178 | + } |
|
| 179 | + else |
|
| 180 | + { |
|
| 181 | + $converter->setDateFrom(self::timestamp2date($datefrom)); |
|
| 182 | + } |
|
| 183 | 183 | |
| 184 | - if($dateto instanceof \DateTime) |
|
| 185 | - { |
|
| 186 | - $converter->setDateTo($dateto); |
|
| 187 | - } |
|
| 188 | - else if($dateto > 0) |
|
| 189 | - { |
|
| 190 | - $converter->setDateTo(self::timestamp2date($dateto)); |
|
| 191 | - } |
|
| 184 | + if($dateto instanceof \DateTime) |
|
| 185 | + { |
|
| 186 | + $converter->setDateTo($dateto); |
|
| 187 | + } |
|
| 188 | + else if($dateto > 0) |
|
| 189 | + { |
|
| 190 | + $converter->setDateTo(self::timestamp2date($dateto)); |
|
| 191 | + } |
|
| 192 | 192 | |
| 193 | - return $converter->convert(); |
|
| 193 | + return $converter->convert(); |
|
| 194 | 194 | } |
| 195 | 195 | |
| 196 | 196 | /** |
@@ -229,44 +229,44 @@ discard block |
||
| 229 | 229 | return $geshi->parse_code(); |
| 230 | 230 | } |
| 231 | 231 | |
| 232 | - /** |
|
| 233 | - * Converts a number of bytes to a human readable form, |
|
| 234 | - * e.g. xx Kb / xx Mb / xx Gb |
|
| 235 | - * |
|
| 236 | - * @param int $bytes The amount of bytes to convert. |
|
| 237 | - * @param int $precision The amount of decimals |
|
| 238 | - * @param int $base The base to calculate with: Base 10 is default (=1000 Bytes in a KB), Base 2 is mainly used for Windows memory (=1024 Bytes in a KB). |
|
| 239 | - * @return string |
|
| 240 | - * |
|
| 241 | - * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
| 242 | - */ |
|
| 232 | + /** |
|
| 233 | + * Converts a number of bytes to a human readable form, |
|
| 234 | + * e.g. xx Kb / xx Mb / xx Gb |
|
| 235 | + * |
|
| 236 | + * @param int $bytes The amount of bytes to convert. |
|
| 237 | + * @param int $precision The amount of decimals |
|
| 238 | + * @param int $base The base to calculate with: Base 10 is default (=1000 Bytes in a KB), Base 2 is mainly used for Windows memory (=1024 Bytes in a KB). |
|
| 239 | + * @return string |
|
| 240 | + * |
|
| 241 | + * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
| 242 | + */ |
|
| 243 | 243 | public static function bytes2readable(int $bytes, int $precision = 1, int $base = ConvertHelper_StorageSizeEnum::BASE_10) : string |
| 244 | 244 | { |
| 245 | 245 | return self::parseBytes($bytes)->toString($precision, $base); |
| 246 | 246 | } |
| 247 | 247 | |
| 248 | - /** |
|
| 249 | - * Parses a number of bytes, and creates a converter instance which |
|
| 250 | - * allows doing common operations with it. |
|
| 251 | - * |
|
| 252 | - * @param int $bytes |
|
| 253 | - * @return ConvertHelper_ByteConverter |
|
| 254 | - */ |
|
| 248 | + /** |
|
| 249 | + * Parses a number of bytes, and creates a converter instance which |
|
| 250 | + * allows doing common operations with it. |
|
| 251 | + * |
|
| 252 | + * @param int $bytes |
|
| 253 | + * @return ConvertHelper_ByteConverter |
|
| 254 | + */ |
|
| 255 | 255 | public static function parseBytes(int $bytes) : ConvertHelper_ByteConverter |
| 256 | 256 | { |
| 257 | 257 | return new ConvertHelper_ByteConverter($bytes); |
| 258 | 258 | } |
| 259 | 259 | |
| 260 | - /** |
|
| 261 | - * Cuts a text to the specified length if it is longer than the |
|
| 262 | - * target length. Appends a text to signify it has been cut at |
|
| 263 | - * the end of the string. |
|
| 264 | - * |
|
| 265 | - * @param string $text |
|
| 266 | - * @param int $targetLength |
|
| 267 | - * @param string $append |
|
| 268 | - * @return string |
|
| 269 | - */ |
|
| 260 | + /** |
|
| 261 | + * Cuts a text to the specified length if it is longer than the |
|
| 262 | + * target length. Appends a text to signify it has been cut at |
|
| 263 | + * the end of the string. |
|
| 264 | + * |
|
| 265 | + * @param string $text |
|
| 266 | + * @param int $targetLength |
|
| 267 | + * @param string $append |
|
| 268 | + * @return string |
|
| 269 | + */ |
|
| 270 | 270 | public static function text_cut(string $text, int $targetLength, string $append = '...') : string |
| 271 | 271 | { |
| 272 | 272 | $length = mb_strlen($text); |
@@ -290,14 +290,14 @@ discard block |
||
| 290 | 290 | return $info->toString(); |
| 291 | 291 | } |
| 292 | 292 | |
| 293 | - /** |
|
| 294 | - * Pretty print_r. |
|
| 295 | - * |
|
| 296 | - * @param mixed $var The variable to dump. |
|
| 297 | - * @param bool $return Whether to return the dumped code. |
|
| 298 | - * @param bool $html Whether to style the dump as HTML. |
|
| 299 | - * @return string |
|
| 300 | - */ |
|
| 293 | + /** |
|
| 294 | + * Pretty print_r. |
|
| 295 | + * |
|
| 296 | + * @param mixed $var The variable to dump. |
|
| 297 | + * @param bool $return Whether to return the dumped code. |
|
| 298 | + * @param bool $html Whether to style the dump as HTML. |
|
| 299 | + * @return string |
|
| 300 | + */ |
|
| 301 | 301 | public static function print_r($var, bool $return=false, bool $html=true) : string |
| 302 | 302 | { |
| 303 | 303 | $result = parseVariable($var)->enableType()->toString(); |
@@ -327,15 +327,15 @@ discard block |
||
| 327 | 327 | 'no' => false |
| 328 | 328 | ); |
| 329 | 329 | |
| 330 | - /** |
|
| 331 | - * Converts a string, number or boolean value to a boolean value. |
|
| 332 | - * |
|
| 333 | - * @param mixed $string |
|
| 334 | - * @throws ConvertHelper_Exception |
|
| 335 | - * @return bool |
|
| 336 | - * |
|
| 337 | - * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING |
|
| 338 | - */ |
|
| 330 | + /** |
|
| 331 | + * Converts a string, number or boolean value to a boolean value. |
|
| 332 | + * |
|
| 333 | + * @param mixed $string |
|
| 334 | + * @throws ConvertHelper_Exception |
|
| 335 | + * @return bool |
|
| 336 | + * |
|
| 337 | + * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING |
|
| 338 | + */ |
|
| 339 | 339 | public static function string2bool($string) : bool |
| 340 | 340 | { |
| 341 | 341 | if($string === '' || $string === null || !is_scalar($string)) |
@@ -363,27 +363,27 @@ discard block |
||
| 363 | 363 | ); |
| 364 | 364 | } |
| 365 | 365 | |
| 366 | - /** |
|
| 367 | - * Whether the specified string is a boolean string or boolean value. |
|
| 368 | - * Alias for {@link ConvertHelper::isBoolean()}. |
|
| 369 | - * |
|
| 370 | - * @param mixed $string |
|
| 371 | - * @return bool |
|
| 372 | - * @deprecated |
|
| 373 | - * @see ConvertHelper::isBoolean() |
|
| 374 | - */ |
|
| 366 | + /** |
|
| 367 | + * Whether the specified string is a boolean string or boolean value. |
|
| 368 | + * Alias for {@link ConvertHelper::isBoolean()}. |
|
| 369 | + * |
|
| 370 | + * @param mixed $string |
|
| 371 | + * @return bool |
|
| 372 | + * @deprecated |
|
| 373 | + * @see ConvertHelper::isBoolean() |
|
| 374 | + */ |
|
| 375 | 375 | public static function isBooleanString($string) : bool |
| 376 | 376 | { |
| 377 | 377 | return self::isBoolean($string); |
| 378 | 378 | } |
| 379 | 379 | |
| 380 | - /** |
|
| 381 | - * Alias for the {@\AppUtils\XMLHelper::string2xml()} method. |
|
| 382 | - * |
|
| 383 | - * @param string $text |
|
| 384 | - * @return string |
|
| 385 | - * @deprecated |
|
| 386 | - */ |
|
| 380 | + /** |
|
| 381 | + * Alias for the {@\AppUtils\XMLHelper::string2xml()} method. |
|
| 382 | + * |
|
| 383 | + * @param string $text |
|
| 384 | + * @return string |
|
| 385 | + * @deprecated |
|
| 386 | + */ |
|
| 387 | 387 | public static function text_makeXMLCompliant($text) |
| 388 | 388 | { |
| 389 | 389 | return XMLHelper::string2xml($text); |
@@ -485,13 +485,13 @@ discard block |
||
| 485 | 485 | return $translit->convert($string); |
| 486 | 486 | } |
| 487 | 487 | |
| 488 | - /** |
|
| 489 | - * Retrieves the HEX character codes for all control |
|
| 490 | - * characters that the {@link stripControlCharacters()} |
|
| 491 | - * method will remove. |
|
| 492 | - * |
|
| 493 | - * @return string[] |
|
| 494 | - */ |
|
| 488 | + /** |
|
| 489 | + * Retrieves the HEX character codes for all control |
|
| 490 | + * characters that the {@link stripControlCharacters()} |
|
| 491 | + * method will remove. |
|
| 492 | + * |
|
| 493 | + * @return string[] |
|
| 494 | + */ |
|
| 495 | 495 | public static function getControlCharactersAsHex() |
| 496 | 496 | { |
| 497 | 497 | $hexAlphabet = array('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'); |
@@ -527,13 +527,13 @@ discard block |
||
| 527 | 527 | return $stack; |
| 528 | 528 | } |
| 529 | 529 | |
| 530 | - /** |
|
| 531 | - * Retrieves an array of all control characters that |
|
| 532 | - * the {@link stripControlCharacters()} method will |
|
| 533 | - * remove, as the actual UTF-8 characters. |
|
| 534 | - * |
|
| 535 | - * @return string[] |
|
| 536 | - */ |
|
| 530 | + /** |
|
| 531 | + * Retrieves an array of all control characters that |
|
| 532 | + * the {@link stripControlCharacters()} method will |
|
| 533 | + * remove, as the actual UTF-8 characters. |
|
| 534 | + * |
|
| 535 | + * @return string[] |
|
| 536 | + */ |
|
| 537 | 537 | public static function getControlCharactersAsUTF8() |
| 538 | 538 | { |
| 539 | 539 | $chars = self::getControlCharactersAsHex(); |
@@ -546,12 +546,12 @@ discard block |
||
| 546 | 546 | return $result; |
| 547 | 547 | } |
| 548 | 548 | |
| 549 | - /** |
|
| 550 | - * Retrieves all control characters as JSON encoded |
|
| 551 | - * characters, e.g. "\u200b". |
|
| 552 | - * |
|
| 553 | - * @return string[] |
|
| 554 | - */ |
|
| 549 | + /** |
|
| 550 | + * Retrieves all control characters as JSON encoded |
|
| 551 | + * characters, e.g. "\u200b". |
|
| 552 | + * |
|
| 553 | + * @return string[] |
|
| 554 | + */ |
|
| 555 | 555 | public static function getControlCharactersAsJSON() |
| 556 | 556 | { |
| 557 | 557 | $chars = self::getControlCharactersAsHex(); |
@@ -608,20 +608,20 @@ discard block |
||
| 608 | 608 | return preg_replace(self::$controlCharsRegex, '', $string); |
| 609 | 609 | } |
| 610 | 610 | |
| 611 | - /** |
|
| 612 | - * Converts a unicode character to the PHPO notation. |
|
| 613 | - * |
|
| 614 | - * Example: |
|
| 615 | - * |
|
| 616 | - * <pre>unicodeChar2php('"\u0000"')</pre> |
|
| 617 | - * |
|
| 618 | - * Returns |
|
| 619 | - * |
|
| 620 | - * <pre>\x0</pre> |
|
| 621 | - * |
|
| 622 | - * @param string $unicodeChar |
|
| 623 | - * @return string |
|
| 624 | - */ |
|
| 611 | + /** |
|
| 612 | + * Converts a unicode character to the PHPO notation. |
|
| 613 | + * |
|
| 614 | + * Example: |
|
| 615 | + * |
|
| 616 | + * <pre>unicodeChar2php('"\u0000"')</pre> |
|
| 617 | + * |
|
| 618 | + * Returns |
|
| 619 | + * |
|
| 620 | + * <pre>\x0</pre> |
|
| 621 | + * |
|
| 622 | + * @param string $unicodeChar |
|
| 623 | + * @return string |
|
| 624 | + */ |
|
| 625 | 625 | public static function unicodeChar2php(string $unicodeChar) : string |
| 626 | 626 | { |
| 627 | 627 | $unicodeChar = json_decode($unicodeChar); |
@@ -747,25 +747,25 @@ discard block |
||
| 747 | 747 | return 'false'; |
| 748 | 748 | } |
| 749 | 749 | |
| 750 | - /** |
|
| 751 | - * Converts an associative array with attribute name > value pairs |
|
| 752 | - * to an attribute string that can be used in an HTML tag. Empty |
|
| 753 | - * attribute values are ignored. |
|
| 754 | - * |
|
| 755 | - * Example: |
|
| 756 | - * |
|
| 757 | - * array2attributeString(array( |
|
| 758 | - * 'id' => 45, |
|
| 759 | - * 'href' => 'http://www.mistralys.com' |
|
| 760 | - * )); |
|
| 761 | - * |
|
| 762 | - * Result: |
|
| 763 | - * |
|
| 764 | - * id="45" href="http://www.mistralys.com" |
|
| 765 | - * |
|
| 766 | - * @param array $array |
|
| 767 | - * @return string |
|
| 768 | - */ |
|
| 750 | + /** |
|
| 751 | + * Converts an associative array with attribute name > value pairs |
|
| 752 | + * to an attribute string that can be used in an HTML tag. Empty |
|
| 753 | + * attribute values are ignored. |
|
| 754 | + * |
|
| 755 | + * Example: |
|
| 756 | + * |
|
| 757 | + * array2attributeString(array( |
|
| 758 | + * 'id' => 45, |
|
| 759 | + * 'href' => 'http://www.mistralys.com' |
|
| 760 | + * )); |
|
| 761 | + * |
|
| 762 | + * Result: |
|
| 763 | + * |
|
| 764 | + * id="45" href="http://www.mistralys.com" |
|
| 765 | + * |
|
| 766 | + * @param array $array |
|
| 767 | + * @return string |
|
| 768 | + */ |
|
| 769 | 769 | public static function array2attributeString($array) |
| 770 | 770 | { |
| 771 | 771 | $tokens = array(); |
@@ -784,14 +784,14 @@ discard block |
||
| 784 | 784 | return ' '.implode(' ', $tokens); |
| 785 | 785 | } |
| 786 | 786 | |
| 787 | - /** |
|
| 788 | - * Converts a string so it can safely be used in a javascript |
|
| 789 | - * statement in an HTML tag: uses single quotes around the string |
|
| 790 | - * and encodes all special characters as needed. |
|
| 791 | - * |
|
| 792 | - * @param string $string |
|
| 793 | - * @return string |
|
| 794 | - */ |
|
| 787 | + /** |
|
| 788 | + * Converts a string so it can safely be used in a javascript |
|
| 789 | + * statement in an HTML tag: uses single quotes around the string |
|
| 790 | + * and encodes all special characters as needed. |
|
| 791 | + * |
|
| 792 | + * @param string $string |
|
| 793 | + * @return string |
|
| 794 | + */ |
|
| 795 | 795 | public static function string2attributeJS($string, $quoted=true) |
| 796 | 796 | { |
| 797 | 797 | $converted = addslashes(htmlspecialchars(strip_tags($string), ENT_QUOTES, 'UTF-8')); |
@@ -802,15 +802,15 @@ discard block |
||
| 802 | 802 | return $converted; |
| 803 | 803 | } |
| 804 | 804 | |
| 805 | - /** |
|
| 806 | - * Checks if the specified string is a boolean value, which |
|
| 807 | - * includes string representations of boolean values, like |
|
| 808 | - * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
| 809 | - * or <code>false</code>. |
|
| 810 | - * |
|
| 811 | - * @param mixed $value |
|
| 812 | - * @return boolean |
|
| 813 | - */ |
|
| 805 | + /** |
|
| 806 | + * Checks if the specified string is a boolean value, which |
|
| 807 | + * includes string representations of boolean values, like |
|
| 808 | + * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
| 809 | + * or <code>false</code>. |
|
| 810 | + * |
|
| 811 | + * @param mixed $value |
|
| 812 | + * @return boolean |
|
| 813 | + */ |
|
| 814 | 814 | public static function isBoolean($value) : bool |
| 815 | 815 | { |
| 816 | 816 | if(is_bool($value)) { |
@@ -824,12 +824,12 @@ discard block |
||
| 824 | 824 | return array_key_exists($value, self::$booleanStrings); |
| 825 | 825 | } |
| 826 | 826 | |
| 827 | - /** |
|
| 828 | - * Converts an associative array to an HTML style attribute value string. |
|
| 829 | - * |
|
| 830 | - * @param array $subject |
|
| 831 | - * @return string |
|
| 832 | - */ |
|
| 827 | + /** |
|
| 828 | + * Converts an associative array to an HTML style attribute value string. |
|
| 829 | + * |
|
| 830 | + * @param array $subject |
|
| 831 | + * @return string |
|
| 832 | + */ |
|
| 833 | 833 | public static function array2styleString(array $subject) : string |
| 834 | 834 | { |
| 835 | 835 | $tokens = array(); |
@@ -840,23 +840,23 @@ discard block |
||
| 840 | 840 | return implode(';', $tokens); |
| 841 | 841 | } |
| 842 | 842 | |
| 843 | - /** |
|
| 844 | - * Converts a DateTime object to a timestamp, which |
|
| 845 | - * is PHP 5.2 compatible. |
|
| 846 | - * |
|
| 847 | - * @param \DateTime $date |
|
| 848 | - * @return integer |
|
| 849 | - */ |
|
| 843 | + /** |
|
| 844 | + * Converts a DateTime object to a timestamp, which |
|
| 845 | + * is PHP 5.2 compatible. |
|
| 846 | + * |
|
| 847 | + * @param \DateTime $date |
|
| 848 | + * @return integer |
|
| 849 | + */ |
|
| 850 | 850 | public static function date2timestamp(\DateTime $date) : int |
| 851 | 851 | { |
| 852 | 852 | return (int)$date->format('U'); |
| 853 | 853 | } |
| 854 | 854 | |
| 855 | - /** |
|
| 856 | - * Converts a timestamp into a DateTime instance. |
|
| 857 | - * @param int $timestamp |
|
| 858 | - * @return \DateTime |
|
| 859 | - */ |
|
| 855 | + /** |
|
| 856 | + * Converts a timestamp into a DateTime instance. |
|
| 857 | + * @param int $timestamp |
|
| 858 | + * @return \DateTime |
|
| 859 | + */ |
|
| 860 | 860 | public static function timestamp2date(int $timestamp) : \DateTime |
| 861 | 861 | { |
| 862 | 862 | $date = new \DateTime(); |
@@ -864,50 +864,50 @@ discard block |
||
| 864 | 864 | return $date; |
| 865 | 865 | } |
| 866 | 866 | |
| 867 | - /** |
|
| 868 | - * Strips an absolute path to a file within the application |
|
| 869 | - * to make the path relative to the application root path. |
|
| 870 | - * |
|
| 871 | - * @param string $path |
|
| 872 | - * @return string |
|
| 873 | - * |
|
| 874 | - * @see FileHelper::relativizePath() |
|
| 875 | - * @see FileHelper::relativizePathByDepth() |
|
| 876 | - */ |
|
| 867 | + /** |
|
| 868 | + * Strips an absolute path to a file within the application |
|
| 869 | + * to make the path relative to the application root path. |
|
| 870 | + * |
|
| 871 | + * @param string $path |
|
| 872 | + * @return string |
|
| 873 | + * |
|
| 874 | + * @see FileHelper::relativizePath() |
|
| 875 | + * @see FileHelper::relativizePathByDepth() |
|
| 876 | + */ |
|
| 877 | 877 | public static function fileRelativize(string $path) : string |
| 878 | 878 | { |
| 879 | 879 | return FileHelper::relativizePathByDepth($path); |
| 880 | 880 | } |
| 881 | 881 | |
| 882 | 882 | /** |
| 883 | - * Converts a PHP regex to a javascript RegExp object statement. |
|
| 884 | - * |
|
| 885 | - * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
| 886 | - * More details are available on its usage there. |
|
| 887 | - * |
|
| 888 | - * @param string $regex A PHP preg regex |
|
| 889 | - * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
| 890 | - * @return array|string Depending on the specified return type. |
|
| 891 | - * |
|
| 892 | - * @see JSHelper::buildRegexStatement() |
|
| 893 | - */ |
|
| 883 | + * Converts a PHP regex to a javascript RegExp object statement. |
|
| 884 | + * |
|
| 885 | + * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
| 886 | + * More details are available on its usage there. |
|
| 887 | + * |
|
| 888 | + * @param string $regex A PHP preg regex |
|
| 889 | + * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
| 890 | + * @return array|string Depending on the specified return type. |
|
| 891 | + * |
|
| 892 | + * @see JSHelper::buildRegexStatement() |
|
| 893 | + */ |
|
| 894 | 894 | public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) |
| 895 | 895 | { |
| 896 | 896 | return JSHelper::buildRegexStatement($regex, $statementType); |
| 897 | 897 | } |
| 898 | 898 | |
| 899 | - /** |
|
| 900 | - * Converts the specified variable to JSON. Works just |
|
| 901 | - * like the native `json_encode` method, except that it |
|
| 902 | - * will trigger an exception on failure, which has the |
|
| 903 | - * json error details included in its developer details. |
|
| 904 | - * |
|
| 905 | - * @param mixed $variable |
|
| 906 | - * @param int $options JSON encode options. |
|
| 907 | - * @param int $depth |
|
| 908 | - * @throws ConvertHelper_Exception |
|
| 909 | - * @return string |
|
| 910 | - */ |
|
| 899 | + /** |
|
| 900 | + * Converts the specified variable to JSON. Works just |
|
| 901 | + * like the native `json_encode` method, except that it |
|
| 902 | + * will trigger an exception on failure, which has the |
|
| 903 | + * json error details included in its developer details. |
|
| 904 | + * |
|
| 905 | + * @param mixed $variable |
|
| 906 | + * @param int $options JSON encode options. |
|
| 907 | + * @param int $depth |
|
| 908 | + * @throws ConvertHelper_Exception |
|
| 909 | + * @return string |
|
| 910 | + */ |
|
| 911 | 911 | public static function var2json($variable, int $options=0, int $depth=512) : string |
| 912 | 912 | { |
| 913 | 913 | $result = json_encode($variable, $options, $depth); |
@@ -928,12 +928,12 @@ discard block |
||
| 928 | 928 | ); |
| 929 | 929 | } |
| 930 | 930 | |
| 931 | - /** |
|
| 932 | - * Strips all known UTF byte order marks from the specified string. |
|
| 933 | - * |
|
| 934 | - * @param string $string |
|
| 935 | - * @return string |
|
| 936 | - */ |
|
| 931 | + /** |
|
| 932 | + * Strips all known UTF byte order marks from the specified string. |
|
| 933 | + * |
|
| 934 | + * @param string $string |
|
| 935 | + * @return string |
|
| 936 | + */ |
|
| 937 | 937 | public static function stripUTFBom($string) |
| 938 | 938 | { |
| 939 | 939 | $boms = FileHelper::getUTFBOMs(); |
@@ -948,13 +948,13 @@ discard block |
||
| 948 | 948 | return $string; |
| 949 | 949 | } |
| 950 | 950 | |
| 951 | - /** |
|
| 952 | - * Converts a string to valid utf8, regardless |
|
| 953 | - * of the string's encoding(s). |
|
| 954 | - * |
|
| 955 | - * @param string $string |
|
| 956 | - * @return string |
|
| 957 | - */ |
|
| 951 | + /** |
|
| 952 | + * Converts a string to valid utf8, regardless |
|
| 953 | + * of the string's encoding(s). |
|
| 954 | + * |
|
| 955 | + * @param string $string |
|
| 956 | + * @return string |
|
| 957 | + */ |
|
| 958 | 958 | public static function string2utf8($string) |
| 959 | 959 | { |
| 960 | 960 | if(!self::isStringASCII($string)) { |
@@ -964,15 +964,15 @@ discard block |
||
| 964 | 964 | return $string; |
| 965 | 965 | } |
| 966 | 966 | |
| 967 | - /** |
|
| 968 | - * Checks whether the specified string is an ASCII |
|
| 969 | - * string, without any special or UTF8 characters. |
|
| 970 | - * Note: empty strings and NULL are considered ASCII. |
|
| 971 | - * Any variable types other than strings are not. |
|
| 972 | - * |
|
| 973 | - * @param mixed $string |
|
| 974 | - * @return boolean |
|
| 975 | - */ |
|
| 967 | + /** |
|
| 968 | + * Checks whether the specified string is an ASCII |
|
| 969 | + * string, without any special or UTF8 characters. |
|
| 970 | + * Note: empty strings and NULL are considered ASCII. |
|
| 971 | + * Any variable types other than strings are not. |
|
| 972 | + * |
|
| 973 | + * @param mixed $string |
|
| 974 | + * @return boolean |
|
| 975 | + */ |
|
| 976 | 976 | public static function isStringASCII($string) : bool |
| 977 | 977 | { |
| 978 | 978 | if($string === '' || $string === NULL) { |
@@ -997,22 +997,22 @@ discard block |
||
| 997 | 997 | return $url; |
| 998 | 998 | } |
| 999 | 999 | |
| 1000 | - /** |
|
| 1001 | - * Calculates a percentage match of the source string with the target string. |
|
| 1002 | - * |
|
| 1003 | - * Options are: |
|
| 1004 | - * |
|
| 1005 | - * - maxLevenshtein, default: 10 |
|
| 1006 | - * Any levenshtein results above this value are ignored. |
|
| 1007 | - * |
|
| 1008 | - * - precision, default: 1 |
|
| 1009 | - * The precision of the percentage float value |
|
| 1010 | - * |
|
| 1011 | - * @param string $source |
|
| 1012 | - * @param string $target |
|
| 1013 | - * @param array $options |
|
| 1014 | - * @return float |
|
| 1015 | - */ |
|
| 1000 | + /** |
|
| 1001 | + * Calculates a percentage match of the source string with the target string. |
|
| 1002 | + * |
|
| 1003 | + * Options are: |
|
| 1004 | + * |
|
| 1005 | + * - maxLevenshtein, default: 10 |
|
| 1006 | + * Any levenshtein results above this value are ignored. |
|
| 1007 | + * |
|
| 1008 | + * - precision, default: 1 |
|
| 1009 | + * The precision of the percentage float value |
|
| 1010 | + * |
|
| 1011 | + * @param string $source |
|
| 1012 | + * @param string $target |
|
| 1013 | + * @param array $options |
|
| 1014 | + * @return float |
|
| 1015 | + */ |
|
| 1016 | 1016 | public static function matchString($source, $target, $options=array()) |
| 1017 | 1017 | { |
| 1018 | 1018 | $defaults = array( |
@@ -1036,14 +1036,14 @@ discard block |
||
| 1036 | 1036 | return round(100 - $percent, $options['precision']); |
| 1037 | 1037 | } |
| 1038 | 1038 | |
| 1039 | - /** |
|
| 1040 | - * Converts a date interval to a human readable string with |
|
| 1041 | - * all necessary time components, e.g. "1 year, 2 months and 4 days". |
|
| 1042 | - * |
|
| 1043 | - * @param \DateInterval $interval |
|
| 1044 | - * @return string |
|
| 1045 | - * @see ConvertHelper_IntervalConverter |
|
| 1046 | - */ |
|
| 1039 | + /** |
|
| 1040 | + * Converts a date interval to a human readable string with |
|
| 1041 | + * all necessary time components, e.g. "1 year, 2 months and 4 days". |
|
| 1042 | + * |
|
| 1043 | + * @param \DateInterval $interval |
|
| 1044 | + * @return string |
|
| 1045 | + * @see ConvertHelper_IntervalConverter |
|
| 1046 | + */ |
|
| 1047 | 1047 | public static function interval2string(\DateInterval $interval) : string |
| 1048 | 1048 | { |
| 1049 | 1049 | $converter = new ConvertHelper_IntervalConverter(); |
@@ -1058,60 +1058,60 @@ discard block |
||
| 1058 | 1058 | |
| 1059 | 1059 | const INTERVAL_SECONDS = 'seconds'; |
| 1060 | 1060 | |
| 1061 | - /** |
|
| 1062 | - * Converts an interval to its total amount of days. |
|
| 1063 | - * @param \DateInterval $interval |
|
| 1064 | - * @return int |
|
| 1065 | - */ |
|
| 1061 | + /** |
|
| 1062 | + * Converts an interval to its total amount of days. |
|
| 1063 | + * @param \DateInterval $interval |
|
| 1064 | + * @return int |
|
| 1065 | + */ |
|
| 1066 | 1066 | public static function interval2days(\DateInterval $interval) : int |
| 1067 | 1067 | { |
| 1068 | 1068 | return self::interval2total($interval, self::INTERVAL_DAYS); |
| 1069 | 1069 | } |
| 1070 | 1070 | |
| 1071 | - /** |
|
| 1072 | - * Converts an interval to its total amount of hours. |
|
| 1073 | - * @param \DateInterval $interval |
|
| 1074 | - * @return int |
|
| 1075 | - */ |
|
| 1071 | + /** |
|
| 1072 | + * Converts an interval to its total amount of hours. |
|
| 1073 | + * @param \DateInterval $interval |
|
| 1074 | + * @return int |
|
| 1075 | + */ |
|
| 1076 | 1076 | public static function interval2hours(\DateInterval $interval) : int |
| 1077 | 1077 | { |
| 1078 | 1078 | return self::interval2total($interval, self::INTERVAL_HOURS); |
| 1079 | 1079 | } |
| 1080 | 1080 | |
| 1081 | - /** |
|
| 1082 | - * Converts an interval to its total amount of minutes. |
|
| 1083 | - * @param \DateInterval $interval |
|
| 1084 | - * @return int |
|
| 1085 | - */ |
|
| 1081 | + /** |
|
| 1082 | + * Converts an interval to its total amount of minutes. |
|
| 1083 | + * @param \DateInterval $interval |
|
| 1084 | + * @return int |
|
| 1085 | + */ |
|
| 1086 | 1086 | public static function interval2minutes(\DateInterval $interval) : int |
| 1087 | 1087 | { |
| 1088 | 1088 | return self::interval2total($interval, self::INTERVAL_MINUTES); |
| 1089 | 1089 | } |
| 1090 | 1090 | |
| 1091 | - /** |
|
| 1092 | - * Converts an interval to its total amount of seconds. |
|
| 1093 | - * @param \DateInterval $interval |
|
| 1094 | - * @return int |
|
| 1095 | - */ |
|
| 1091 | + /** |
|
| 1092 | + * Converts an interval to its total amount of seconds. |
|
| 1093 | + * @param \DateInterval $interval |
|
| 1094 | + * @return int |
|
| 1095 | + */ |
|
| 1096 | 1096 | public static function interval2seconds(\DateInterval $interval) : int |
| 1097 | 1097 | { |
| 1098 | 1098 | return self::interval2total($interval, self::INTERVAL_SECONDS); |
| 1099 | 1099 | } |
| 1100 | 1100 | |
| 1101 | - /** |
|
| 1102 | - * Calculates the total amount of days / hours / minutes or seconds |
|
| 1103 | - * of a date interval object (depending in the specified units), and |
|
| 1104 | - * returns the total amount. |
|
| 1105 | - * |
|
| 1106 | - * @param \DateInterval $interval |
|
| 1107 | - * @param string $unit What total value to calculate. |
|
| 1108 | - * @return integer |
|
| 1109 | - * |
|
| 1110 | - * @see ConvertHelper::INTERVAL_SECONDS |
|
| 1111 | - * @see ConvertHelper::INTERVAL_MINUTES |
|
| 1112 | - * @see ConvertHelper::INTERVAL_HOURS |
|
| 1113 | - * @see ConvertHelper::INTERVAL_DAYS |
|
| 1114 | - */ |
|
| 1101 | + /** |
|
| 1102 | + * Calculates the total amount of days / hours / minutes or seconds |
|
| 1103 | + * of a date interval object (depending in the specified units), and |
|
| 1104 | + * returns the total amount. |
|
| 1105 | + * |
|
| 1106 | + * @param \DateInterval $interval |
|
| 1107 | + * @param string $unit What total value to calculate. |
|
| 1108 | + * @return integer |
|
| 1109 | + * |
|
| 1110 | + * @see ConvertHelper::INTERVAL_SECONDS |
|
| 1111 | + * @see ConvertHelper::INTERVAL_MINUTES |
|
| 1112 | + * @see ConvertHelper::INTERVAL_HOURS |
|
| 1113 | + * @see ConvertHelper::INTERVAL_DAYS |
|
| 1114 | + */ |
|
| 1115 | 1115 | public static function interval2total(\DateInterval $interval, $unit=self::INTERVAL_SECONDS) : int |
| 1116 | 1116 | { |
| 1117 | 1117 | $total = (int)$interval->format('%a'); |
@@ -1151,13 +1151,13 @@ discard block |
||
| 1151 | 1151 | 'Sunday' |
| 1152 | 1152 | ); |
| 1153 | 1153 | |
| 1154 | - /** |
|
| 1155 | - * Converts a date to the corresponding day name. |
|
| 1156 | - * |
|
| 1157 | - * @param \DateTime $date |
|
| 1158 | - * @param bool $short |
|
| 1159 | - * @return string|NULL |
|
| 1160 | - */ |
|
| 1154 | + /** |
|
| 1155 | + * Converts a date to the corresponding day name. |
|
| 1156 | + * |
|
| 1157 | + * @param \DateTime $date |
|
| 1158 | + * @param bool $short |
|
| 1159 | + * @return string|NULL |
|
| 1160 | + */ |
|
| 1161 | 1161 | public static function date2dayName(\DateTime $date, bool $short=false) |
| 1162 | 1162 | { |
| 1163 | 1163 | $day = $date->format('l'); |
@@ -1172,21 +1172,21 @@ discard block |
||
| 1172 | 1172 | return null; |
| 1173 | 1173 | } |
| 1174 | 1174 | |
| 1175 | - /** |
|
| 1176 | - * Retrieves a list of english day names. |
|
| 1177 | - * @return string[] |
|
| 1178 | - */ |
|
| 1175 | + /** |
|
| 1176 | + * Retrieves a list of english day names. |
|
| 1177 | + * @return string[] |
|
| 1178 | + */ |
|
| 1179 | 1179 | public static function getDayNamesInvariant() |
| 1180 | 1180 | { |
| 1181 | 1181 | return self::$daysInvariant; |
| 1182 | 1182 | } |
| 1183 | 1183 | |
| 1184 | - /** |
|
| 1185 | - * Retrieves the day names list for the current locale. |
|
| 1186 | - * |
|
| 1187 | - * @param bool $short |
|
| 1188 | - * @return array |
|
| 1189 | - */ |
|
| 1184 | + /** |
|
| 1185 | + * Retrieves the day names list for the current locale. |
|
| 1186 | + * |
|
| 1187 | + * @param bool $short |
|
| 1188 | + * @return array |
|
| 1189 | + */ |
|
| 1190 | 1190 | public static function getDayNames(bool $short=false) : array |
| 1191 | 1191 | { |
| 1192 | 1192 | if($short) { |
@@ -1246,16 +1246,16 @@ discard block |
||
| 1246 | 1246 | return $last; |
| 1247 | 1247 | } |
| 1248 | 1248 | |
| 1249 | - /** |
|
| 1250 | - * Splits a string into an array of all characters it is composed of. |
|
| 1251 | - * Unicode character safe. |
|
| 1252 | - * |
|
| 1253 | - * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
| 1254 | - * characters. |
|
| 1255 | - * |
|
| 1256 | - * @param string $string |
|
| 1257 | - * @return array |
|
| 1258 | - */ |
|
| 1249 | + /** |
|
| 1250 | + * Splits a string into an array of all characters it is composed of. |
|
| 1251 | + * Unicode character safe. |
|
| 1252 | + * |
|
| 1253 | + * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
| 1254 | + * characters. |
|
| 1255 | + * |
|
| 1256 | + * @param string $string |
|
| 1257 | + * @return array |
|
| 1258 | + */ |
|
| 1259 | 1259 | public static function string2array(string $string) : array |
| 1260 | 1260 | { |
| 1261 | 1261 | $result = preg_split('//u', $string, null, PREG_SPLIT_NO_EMPTY); |
@@ -1266,12 +1266,12 @@ discard block |
||
| 1266 | 1266 | return array(); |
| 1267 | 1267 | } |
| 1268 | 1268 | |
| 1269 | - /** |
|
| 1270 | - * Checks whether the specified string contains HTML code. |
|
| 1271 | - * |
|
| 1272 | - * @param string $string |
|
| 1273 | - * @return boolean |
|
| 1274 | - */ |
|
| 1269 | + /** |
|
| 1270 | + * Checks whether the specified string contains HTML code. |
|
| 1271 | + * |
|
| 1272 | + * @param string $string |
|
| 1273 | + * @return boolean |
|
| 1274 | + */ |
|
| 1275 | 1275 | public static function isStringHTML(string $string) : bool |
| 1276 | 1276 | { |
| 1277 | 1277 | if(preg_match('%<[a-z/][\s\S]*>%siU', $string)) { |
@@ -1286,17 +1286,17 @@ discard block |
||
| 1286 | 1286 | return false; |
| 1287 | 1287 | } |
| 1288 | 1288 | |
| 1289 | - /** |
|
| 1290 | - * UTF8-safe wordwrap method: works like the regular wordwrap |
|
| 1291 | - * PHP function but compatible with UTF8. Otherwise the lengths |
|
| 1292 | - * are not calculated correctly. |
|
| 1293 | - * |
|
| 1294 | - * @param string $str |
|
| 1295 | - * @param int $width |
|
| 1296 | - * @param string $break |
|
| 1297 | - * @param bool $cut |
|
| 1298 | - * @return string |
|
| 1299 | - */ |
|
| 1289 | + /** |
|
| 1290 | + * UTF8-safe wordwrap method: works like the regular wordwrap |
|
| 1291 | + * PHP function but compatible with UTF8. Otherwise the lengths |
|
| 1292 | + * are not calculated correctly. |
|
| 1293 | + * |
|
| 1294 | + * @param string $str |
|
| 1295 | + * @param int $width |
|
| 1296 | + * @param string $break |
|
| 1297 | + * @param bool $cut |
|
| 1298 | + * @return string |
|
| 1299 | + */ |
|
| 1300 | 1300 | public static function wordwrap(string $str, int $width = 75, string $break = "\n", bool $cut = false) : string |
| 1301 | 1301 | { |
| 1302 | 1302 | $wrapper = new ConvertHelper_WordWrapper(); |
@@ -1308,27 +1308,27 @@ discard block |
||
| 1308 | 1308 | ->wrapText($str); |
| 1309 | 1309 | } |
| 1310 | 1310 | |
| 1311 | - /** |
|
| 1312 | - * Calculates the byte length of a string, taking into |
|
| 1313 | - * account any unicode characters. |
|
| 1314 | - * |
|
| 1315 | - * @param string $string |
|
| 1316 | - * @return int |
|
| 1317 | - * @see https://stackoverflow.com/a/9718273/2298192 |
|
| 1318 | - */ |
|
| 1311 | + /** |
|
| 1312 | + * Calculates the byte length of a string, taking into |
|
| 1313 | + * account any unicode characters. |
|
| 1314 | + * |
|
| 1315 | + * @param string $string |
|
| 1316 | + * @return int |
|
| 1317 | + * @see https://stackoverflow.com/a/9718273/2298192 |
|
| 1318 | + */ |
|
| 1319 | 1319 | public static function string2bytes($string) |
| 1320 | 1320 | { |
| 1321 | 1321 | return mb_strlen($string, '8bit'); |
| 1322 | 1322 | } |
| 1323 | 1323 | |
| 1324 | - /** |
|
| 1325 | - * Creates a short, 8-character long hash for the specified string. |
|
| 1326 | - * |
|
| 1327 | - * WARNING: Not cryptographically safe. |
|
| 1328 | - * |
|
| 1329 | - * @param string $string |
|
| 1330 | - * @return string |
|
| 1331 | - */ |
|
| 1324 | + /** |
|
| 1325 | + * Creates a short, 8-character long hash for the specified string. |
|
| 1326 | + * |
|
| 1327 | + * WARNING: Not cryptographically safe. |
|
| 1328 | + * |
|
| 1329 | + * @param string $string |
|
| 1330 | + * @return string |
|
| 1331 | + */ |
|
| 1332 | 1332 | public static function string2shortHash($string) |
| 1333 | 1333 | { |
| 1334 | 1334 | return hash('crc32', $string, false); |
@@ -1354,40 +1354,40 @@ discard block |
||
| 1354 | 1354 | return ConvertHelper_ThrowableInfo::fromThrowable($e); |
| 1355 | 1355 | } |
| 1356 | 1356 | |
| 1357 | - /** |
|
| 1358 | - * Parses the specified query string like the native |
|
| 1359 | - * function <code>parse_str</code>, without the key |
|
| 1360 | - * naming limitations. |
|
| 1361 | - * |
|
| 1362 | - * Using parse_str, dots or spaces in key names are |
|
| 1363 | - * replaced by underscores. This method keeps all names |
|
| 1364 | - * intact. |
|
| 1365 | - * |
|
| 1366 | - * It still uses the parse_str implementation as it |
|
| 1367 | - * is tested and tried, but fixes the parameter names |
|
| 1368 | - * after parsing, as needed. |
|
| 1369 | - * |
|
| 1370 | - * @param string $queryString |
|
| 1371 | - * @return array |
|
| 1372 | - * @see ConvertHelper_QueryParser |
|
| 1373 | - */ |
|
| 1357 | + /** |
|
| 1358 | + * Parses the specified query string like the native |
|
| 1359 | + * function <code>parse_str</code>, without the key |
|
| 1360 | + * naming limitations. |
|
| 1361 | + * |
|
| 1362 | + * Using parse_str, dots or spaces in key names are |
|
| 1363 | + * replaced by underscores. This method keeps all names |
|
| 1364 | + * intact. |
|
| 1365 | + * |
|
| 1366 | + * It still uses the parse_str implementation as it |
|
| 1367 | + * is tested and tried, but fixes the parameter names |
|
| 1368 | + * after parsing, as needed. |
|
| 1369 | + * |
|
| 1370 | + * @param string $queryString |
|
| 1371 | + * @return array |
|
| 1372 | + * @see ConvertHelper_QueryParser |
|
| 1373 | + */ |
|
| 1374 | 1374 | public static function parseQueryString(string $queryString) : array |
| 1375 | 1375 | { |
| 1376 | 1376 | $parser = new ConvertHelper_QueryParser(); |
| 1377 | 1377 | return $parser->parse($queryString); |
| 1378 | 1378 | } |
| 1379 | 1379 | |
| 1380 | - /** |
|
| 1381 | - * Searches for needle in the specified string, and returns a list |
|
| 1382 | - * of all occurrences, including the matched string. The matched |
|
| 1383 | - * string is useful when doing a case insensitive search, as it |
|
| 1384 | - * shows the exact matched case of needle. |
|
| 1385 | - * |
|
| 1386 | - * @param string $needle |
|
| 1387 | - * @param string $haystack |
|
| 1388 | - * @param bool $caseInsensitive |
|
| 1389 | - * @return ConvertHelper_StringMatch[] |
|
| 1390 | - */ |
|
| 1380 | + /** |
|
| 1381 | + * Searches for needle in the specified string, and returns a list |
|
| 1382 | + * of all occurrences, including the matched string. The matched |
|
| 1383 | + * string is useful when doing a case insensitive search, as it |
|
| 1384 | + * shows the exact matched case of needle. |
|
| 1385 | + * |
|
| 1386 | + * @param string $needle |
|
| 1387 | + * @param string $haystack |
|
| 1388 | + * @param bool $caseInsensitive |
|
| 1389 | + * @return ConvertHelper_StringMatch[] |
|
| 1390 | + */ |
|
| 1391 | 1391 | public static function findString(string $needle, string $haystack, bool $caseInsensitive=false) |
| 1392 | 1392 | { |
| 1393 | 1393 | if($needle === '') { |
@@ -1413,14 +1413,14 @@ discard block |
||
| 1413 | 1413 | return $positions; |
| 1414 | 1414 | } |
| 1415 | 1415 | |
| 1416 | - /** |
|
| 1417 | - * Like explode, but trims all entries, and removes |
|
| 1418 | - * empty entries from the resulting array. |
|
| 1419 | - * |
|
| 1420 | - * @param string $delimiter |
|
| 1421 | - * @param string $string |
|
| 1422 | - * @return string[] |
|
| 1423 | - */ |
|
| 1416 | + /** |
|
| 1417 | + * Like explode, but trims all entries, and removes |
|
| 1418 | + * empty entries from the resulting array. |
|
| 1419 | + * |
|
| 1420 | + * @param string $delimiter |
|
| 1421 | + * @param string $string |
|
| 1422 | + * @return string[] |
|
| 1423 | + */ |
|
| 1424 | 1424 | public static function explodeTrim(string $delimiter, string $string) : array |
| 1425 | 1425 | { |
| 1426 | 1426 | if(empty($string) || empty($delimiter)) { |
@@ -1442,12 +1442,12 @@ discard block |
||
| 1442 | 1442 | |
| 1443 | 1443 | protected static $eolChars; |
| 1444 | 1444 | |
| 1445 | - /** |
|
| 1446 | - * Detects the most used end-of-line character in the subject string. |
|
| 1447 | - * |
|
| 1448 | - * @param string $subjectString The string to check. |
|
| 1449 | - * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
| 1450 | - */ |
|
| 1445 | + /** |
|
| 1446 | + * Detects the most used end-of-line character in the subject string. |
|
| 1447 | + * |
|
| 1448 | + * @param string $subjectString The string to check. |
|
| 1449 | + * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
| 1450 | + */ |
|
| 1451 | 1451 | public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL |
| 1452 | 1452 | { |
| 1453 | 1453 | if(empty($subjectString)) { |
@@ -1459,27 +1459,27 @@ discard block |
||
| 1459 | 1459 | $cr = chr((int)hexdec('0d')); |
| 1460 | 1460 | $lf = chr((int)hexdec('0a')); |
| 1461 | 1461 | |
| 1462 | - self::$eolChars = array( |
|
| 1463 | - array( |
|
| 1464 | - 'char' => $cr.$lf, |
|
| 1465 | - 'type' => ConvertHelper_EOL::TYPE_CRLF, |
|
| 1466 | - 'description' => t('Carriage return followed by a line feed'), |
|
| 1467 | - ), |
|
| 1468 | - array( |
|
| 1469 | - 'char' => $lf.$cr, |
|
| 1470 | - 'type' => ConvertHelper_EOL::TYPE_LFCR, |
|
| 1471 | - 'description' => t('Line feed followed by a carriage return'), |
|
| 1472 | - ), |
|
| 1473 | - array( |
|
| 1474 | - 'char' => $lf, |
|
| 1475 | - 'type' => ConvertHelper_EOL::TYPE_LF, |
|
| 1476 | - 'description' => t('Line feed'), |
|
| 1477 | - ), |
|
| 1478 | - array( |
|
| 1479 | - 'char' => $cr, |
|
| 1480 | - 'type' => ConvertHelper_EOL::TYPE_CR, |
|
| 1481 | - 'description' => t('Carriage Return'), |
|
| 1482 | - ), |
|
| 1462 | + self::$eolChars = array( |
|
| 1463 | + array( |
|
| 1464 | + 'char' => $cr.$lf, |
|
| 1465 | + 'type' => ConvertHelper_EOL::TYPE_CRLF, |
|
| 1466 | + 'description' => t('Carriage return followed by a line feed'), |
|
| 1467 | + ), |
|
| 1468 | + array( |
|
| 1469 | + 'char' => $lf.$cr, |
|
| 1470 | + 'type' => ConvertHelper_EOL::TYPE_LFCR, |
|
| 1471 | + 'description' => t('Line feed followed by a carriage return'), |
|
| 1472 | + ), |
|
| 1473 | + array( |
|
| 1474 | + 'char' => $lf, |
|
| 1475 | + 'type' => ConvertHelper_EOL::TYPE_LF, |
|
| 1476 | + 'description' => t('Line feed'), |
|
| 1477 | + ), |
|
| 1478 | + array( |
|
| 1479 | + 'char' => $cr, |
|
| 1480 | + 'type' => ConvertHelper_EOL::TYPE_CR, |
|
| 1481 | + 'description' => t('Carriage Return'), |
|
| 1482 | + ), |
|
| 1483 | 1483 | ); |
| 1484 | 1484 | } |
| 1485 | 1485 | |
@@ -1507,13 +1507,13 @@ discard block |
||
| 1507 | 1507 | ); |
| 1508 | 1508 | } |
| 1509 | 1509 | |
| 1510 | - /** |
|
| 1511 | - * Removes the specified keys from the target array, |
|
| 1512 | - * if they exist. |
|
| 1513 | - * |
|
| 1514 | - * @param array $array |
|
| 1515 | - * @param array $keys |
|
| 1516 | - */ |
|
| 1510 | + /** |
|
| 1511 | + * Removes the specified keys from the target array, |
|
| 1512 | + * if they exist. |
|
| 1513 | + * |
|
| 1514 | + * @param array $array |
|
| 1515 | + * @param array $keys |
|
| 1516 | + */ |
|
| 1517 | 1517 | public static function arrayRemoveKeys(array &$array, array $keys) : void |
| 1518 | 1518 | { |
| 1519 | 1519 | foreach($keys as $key) |
@@ -1524,13 +1524,13 @@ discard block |
||
| 1524 | 1524 | } |
| 1525 | 1525 | } |
| 1526 | 1526 | |
| 1527 | - /** |
|
| 1528 | - * Checks if the specified variable is an integer or a string containing an integer. |
|
| 1529 | - * Accepts both positive and negative integers. |
|
| 1530 | - * |
|
| 1531 | - * @param mixed $value |
|
| 1532 | - * @return bool |
|
| 1533 | - */ |
|
| 1527 | + /** |
|
| 1528 | + * Checks if the specified variable is an integer or a string containing an integer. |
|
| 1529 | + * Accepts both positive and negative integers. |
|
| 1530 | + * |
|
| 1531 | + * @param mixed $value |
|
| 1532 | + * @return bool |
|
| 1533 | + */ |
|
| 1534 | 1534 | public static function isInteger($value) : bool |
| 1535 | 1535 | { |
| 1536 | 1536 | if(is_int($value)) { |
@@ -1550,40 +1550,40 @@ discard block |
||
| 1550 | 1550 | return false; |
| 1551 | 1551 | } |
| 1552 | 1552 | |
| 1553 | - /** |
|
| 1554 | - * Converts an amount of seconds to a DateInterval object. |
|
| 1555 | - * |
|
| 1556 | - * @param int $seconds |
|
| 1557 | - * @return \DateInterval |
|
| 1558 | - * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
| 1559 | - * |
|
| 1560 | - * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
| 1561 | - */ |
|
| 1553 | + /** |
|
| 1554 | + * Converts an amount of seconds to a DateInterval object. |
|
| 1555 | + * |
|
| 1556 | + * @param int $seconds |
|
| 1557 | + * @return \DateInterval |
|
| 1558 | + * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
| 1559 | + * |
|
| 1560 | + * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
| 1561 | + */ |
|
| 1562 | 1562 | public static function seconds2interval(int $seconds) : \DateInterval |
| 1563 | 1563 | { |
| 1564 | 1564 | return ConvertHelper_DateInterval::fromSeconds($seconds)->getInterval(); |
| 1565 | 1565 | } |
| 1566 | 1566 | |
| 1567 | - /** |
|
| 1568 | - * Converts a size string like "50 MB" to the corresponding byte size. |
|
| 1569 | - * It is case insensitive, ignores spaces, and supports both traditional |
|
| 1570 | - * "MB" and "MiB" notations. |
|
| 1571 | - * |
|
| 1572 | - * @param string $size |
|
| 1573 | - * @return int |
|
| 1574 | - */ |
|
| 1567 | + /** |
|
| 1568 | + * Converts a size string like "50 MB" to the corresponding byte size. |
|
| 1569 | + * It is case insensitive, ignores spaces, and supports both traditional |
|
| 1570 | + * "MB" and "MiB" notations. |
|
| 1571 | + * |
|
| 1572 | + * @param string $size |
|
| 1573 | + * @return int |
|
| 1574 | + */ |
|
| 1575 | 1575 | public static function size2bytes(string $size) : int |
| 1576 | 1576 | { |
| 1577 | 1577 | return self::parseSize($size)->toBytes(); |
| 1578 | 1578 | } |
| 1579 | 1579 | |
| 1580 | - /** |
|
| 1581 | - * Parses a size string like "50 MB" and returns a size notation instance |
|
| 1582 | - * that has utility methods to access information on it, and convert it. |
|
| 1583 | - * |
|
| 1584 | - * @param string $size |
|
| 1585 | - * @return ConvertHelper_SizeNotation |
|
| 1586 | - */ |
|
| 1580 | + /** |
|
| 1581 | + * Parses a size string like "50 MB" and returns a size notation instance |
|
| 1582 | + * that has utility methods to access information on it, and convert it. |
|
| 1583 | + * |
|
| 1584 | + * @param string $size |
|
| 1585 | + * @return ConvertHelper_SizeNotation |
|
| 1586 | + */ |
|
| 1587 | 1587 | public static function parseSize(string $size) : ConvertHelper_SizeNotation |
| 1588 | 1588 | { |
| 1589 | 1589 | return new ConvertHelper_SizeNotation($size); |
@@ -53,7 +53,7 @@ discard block |
||
| 53 | 53 | * @param int $tabSize The amount of spaces per tab. |
| 54 | 54 | * @return string |
| 55 | 55 | */ |
| 56 | - public static function tabs2spaces(string $string, int $tabSize=4) : string |
|
| 56 | + public static function tabs2spaces(string $string, int $tabSize = 4) : string |
|
| 57 | 57 | { |
| 58 | 58 | return str_replace("\t", str_repeat(' ', $tabSize), $string); |
| 59 | 59 | } |
@@ -65,7 +65,7 @@ discard block |
||
| 65 | 65 | * @param int $tabSize The amount of spaces per tab in the source string. |
| 66 | 66 | * @return string |
| 67 | 67 | */ |
| 68 | - public static function spaces2tabs(string $string, int $tabSize=4) : string |
|
| 68 | + public static function spaces2tabs(string $string, int $tabSize = 4) : string |
|
| 69 | 69 | { |
| 70 | 70 | return str_replace(str_repeat(' ', $tabSize), "\t", $string); |
| 71 | 71 | } |
@@ -125,10 +125,10 @@ discard block |
||
| 125 | 125 | |
| 126 | 126 | // specifically handle zero |
| 127 | 127 | if ($seconds <= 0) { |
| 128 | - return '0 ' . t('seconds'); |
|
| 128 | + return '0 '.t('seconds'); |
|
| 129 | 129 | } |
| 130 | 130 | |
| 131 | - if($seconds < 1) { |
|
| 131 | + if ($seconds < 1) { |
|
| 132 | 132 | return t('less than a second'); |
| 133 | 133 | } |
| 134 | 134 | |
@@ -136,7 +136,7 @@ discard block |
||
| 136 | 136 | foreach ($units as $def) { |
| 137 | 137 | $quot = intval($seconds / $def['value']); |
| 138 | 138 | if ($quot) { |
| 139 | - $item = $quot . ' '; |
|
| 139 | + $item = $quot.' '; |
|
| 140 | 140 | if (abs($quot) > 1) { |
| 141 | 141 | $item .= $def['plural']; |
| 142 | 142 | } else { |
@@ -153,7 +153,7 @@ discard block |
||
| 153 | 153 | return $last; |
| 154 | 154 | } |
| 155 | 155 | |
| 156 | - return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last; |
|
| 156 | + return implode(', ', $tokens).' '.t('and').' '.$last; |
|
| 157 | 157 | } |
| 158 | 158 | |
| 159 | 159 | /** |
@@ -172,7 +172,7 @@ discard block |
||
| 172 | 172 | { |
| 173 | 173 | $converter = new ConvertHelper_DurationConverter(); |
| 174 | 174 | |
| 175 | - if($datefrom instanceof \DateTime) |
|
| 175 | + if ($datefrom instanceof \DateTime) |
|
| 176 | 176 | { |
| 177 | 177 | $converter->setDateFrom($datefrom); |
| 178 | 178 | } |
@@ -181,11 +181,11 @@ discard block |
||
| 181 | 181 | $converter->setDateFrom(self::timestamp2date($datefrom)); |
| 182 | 182 | } |
| 183 | 183 | |
| 184 | - if($dateto instanceof \DateTime) |
|
| 184 | + if ($dateto instanceof \DateTime) |
|
| 185 | 185 | { |
| 186 | 186 | $converter->setDateTo($dateto); |
| 187 | 187 | } |
| 188 | - else if($dateto > 0) |
|
| 188 | + else if ($dateto > 0) |
|
| 189 | 189 | { |
| 190 | 190 | $converter->setDateTo(self::timestamp2date($dateto)); |
| 191 | 191 | } |
@@ -205,9 +205,9 @@ discard block |
||
| 205 | 205 | return $geshi->parse_code(); |
| 206 | 206 | } |
| 207 | 207 | |
| 208 | - public static function highlight_xml($xml, $formatSource=false) |
|
| 208 | + public static function highlight_xml($xml, $formatSource = false) |
|
| 209 | 209 | { |
| 210 | - if($formatSource) |
|
| 210 | + if ($formatSource) |
|
| 211 | 211 | { |
| 212 | 212 | $dom = new \DOMDocument(); |
| 213 | 213 | $dom->loadXML($xml); |
@@ -274,16 +274,16 @@ discard block |
||
| 274 | 274 | return $text; |
| 275 | 275 | } |
| 276 | 276 | |
| 277 | - $text = trim(mb_substr($text, 0, $targetLength)) . $append; |
|
| 277 | + $text = trim(mb_substr($text, 0, $targetLength)).$append; |
|
| 278 | 278 | |
| 279 | 279 | return $text; |
| 280 | 280 | } |
| 281 | 281 | |
| 282 | - public static function var_dump($var, $html=true) : string |
|
| 282 | + public static function var_dump($var, $html = true) : string |
|
| 283 | 283 | { |
| 284 | 284 | $info = parseVariable($var); |
| 285 | 285 | |
| 286 | - if($html) { |
|
| 286 | + if ($html) { |
|
| 287 | 287 | return $info->toHTML(); |
| 288 | 288 | } |
| 289 | 289 | |
@@ -298,11 +298,11 @@ discard block |
||
| 298 | 298 | * @param bool $html Whether to style the dump as HTML. |
| 299 | 299 | * @return string |
| 300 | 300 | */ |
| 301 | - public static function print_r($var, bool $return=false, bool $html=true) : string |
|
| 301 | + public static function print_r($var, bool $return = false, bool $html = true) : string |
|
| 302 | 302 | { |
| 303 | 303 | $result = parseVariable($var)->enableType()->toString(); |
| 304 | 304 | |
| 305 | - if($html) |
|
| 305 | + if ($html) |
|
| 306 | 306 | { |
| 307 | 307 | $result = |
| 308 | 308 | '<pre style="background:#fff;color:#333;padding:16px;border:solid 1px #bbb;border-radius:4px">'. |
@@ -310,7 +310,7 @@ discard block |
||
| 310 | 310 | '</pre>'; |
| 311 | 311 | } |
| 312 | 312 | |
| 313 | - if(!$return) |
|
| 313 | + if (!$return) |
|
| 314 | 314 | { |
| 315 | 315 | echo $result; |
| 316 | 316 | } |
@@ -338,17 +338,17 @@ discard block |
||
| 338 | 338 | */ |
| 339 | 339 | public static function string2bool($string) : bool |
| 340 | 340 | { |
| 341 | - if($string === '' || $string === null || !is_scalar($string)) |
|
| 341 | + if ($string === '' || $string === null || !is_scalar($string)) |
|
| 342 | 342 | { |
| 343 | 343 | return false; |
| 344 | 344 | } |
| 345 | 345 | |
| 346 | - if(is_bool($string)) |
|
| 346 | + if (is_bool($string)) |
|
| 347 | 347 | { |
| 348 | 348 | return $string; |
| 349 | 349 | } |
| 350 | 350 | |
| 351 | - if(array_key_exists($string, self::$booleanStrings)) |
|
| 351 | + if (array_key_exists($string, self::$booleanStrings)) |
|
| 352 | 352 | { |
| 353 | 353 | return self::$booleanStrings[$string]; |
| 354 | 354 | } |
@@ -403,10 +403,10 @@ discard block |
||
| 403 | 403 | public static function date2listLabel(\DateTime $date, $includeTime = false, $shortMonth = false) |
| 404 | 404 | { |
| 405 | 405 | $today = new \DateTime(); |
| 406 | - if($date->format('d.m.Y') == $today->format('d.m.Y')) { |
|
| 406 | + if ($date->format('d.m.Y') == $today->format('d.m.Y')) { |
|
| 407 | 407 | $label = t('Today'); |
| 408 | 408 | } else { |
| 409 | - $label = $date->format('d') . '. ' . self::month2string((int)$date->format('m'), $shortMonth) . ' '; |
|
| 409 | + $label = $date->format('d').'. '.self::month2string((int)$date->format('m'), $shortMonth).' '; |
|
| 410 | 410 | if ($date->format('Y') != date('Y')) { |
| 411 | 411 | $label .= $date->format('Y'); |
| 412 | 412 | } |
@@ -497,28 +497,28 @@ discard block |
||
| 497 | 497 | $hexAlphabet = array('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'); |
| 498 | 498 | |
| 499 | 499 | $stack = array(); |
| 500 | - foreach(self::$controlChars as $char) |
|
| 500 | + foreach (self::$controlChars as $char) |
|
| 501 | 501 | { |
| 502 | 502 | $tokens = explode('-', $char); |
| 503 | 503 | $start = $tokens[0]; |
| 504 | 504 | $end = $tokens[1]; |
| 505 | 505 | $prefix = substr($start, 0, 3); |
| 506 | 506 | $range = array(); |
| 507 | - foreach($hexAlphabet as $number) { |
|
| 507 | + foreach ($hexAlphabet as $number) { |
|
| 508 | 508 | $range[] = $prefix.$number; |
| 509 | 509 | } |
| 510 | 510 | |
| 511 | 511 | $use = false; |
| 512 | - foreach($range as $number) { |
|
| 513 | - if($number == $start) { |
|
| 512 | + foreach ($range as $number) { |
|
| 513 | + if ($number == $start) { |
|
| 514 | 514 | $use = true; |
| 515 | 515 | } |
| 516 | 516 | |
| 517 | - if($use) { |
|
| 517 | + if ($use) { |
|
| 518 | 518 | $stack[] = $number; |
| 519 | 519 | } |
| 520 | 520 | |
| 521 | - if($number == $end) { |
|
| 521 | + if ($number == $end) { |
|
| 522 | 522 | break; |
| 523 | 523 | } |
| 524 | 524 | } |
@@ -539,7 +539,7 @@ discard block |
||
| 539 | 539 | $chars = self::getControlCharactersAsHex(); |
| 540 | 540 | |
| 541 | 541 | $result = array(); |
| 542 | - foreach($chars as $char) { |
|
| 542 | + foreach ($chars as $char) { |
|
| 543 | 543 | $result[] = hex2bin($char); |
| 544 | 544 | } |
| 545 | 545 | |
@@ -557,14 +557,14 @@ discard block |
||
| 557 | 557 | $chars = self::getControlCharactersAsHex(); |
| 558 | 558 | |
| 559 | 559 | $result = array(); |
| 560 | - foreach($chars as $char) { |
|
| 560 | + foreach ($chars as $char) { |
|
| 561 | 561 | $result[] = '\u'.strtolower($char); |
| 562 | 562 | } |
| 563 | 563 | |
| 564 | 564 | return $result; |
| 565 | 565 | } |
| 566 | 566 | |
| 567 | - protected static $controlChars = array( |
|
| 567 | + protected static $controlChars = array( |
|
| 568 | 568 | '0000-0008', // control chars |
| 569 | 569 | '000E-000F', // control chars |
| 570 | 570 | '0010-001F', // control chars |
@@ -586,19 +586,19 @@ discard block |
||
| 586 | 586 | */ |
| 587 | 587 | public static function stripControlCharacters(string $string) : string |
| 588 | 588 | { |
| 589 | - if(empty($string)) { |
|
| 589 | + if (empty($string)) { |
|
| 590 | 590 | return $string; |
| 591 | 591 | } |
| 592 | 592 | |
| 593 | 593 | // create the regex from the unicode characters list |
| 594 | - if(!isset(self::$controlCharsRegex)) |
|
| 594 | + if (!isset(self::$controlCharsRegex)) |
|
| 595 | 595 | { |
| 596 | 596 | $chars = self::getControlCharactersAsHex(); |
| 597 | 597 | |
| 598 | 598 | // we use the notation \x{0000} to specify the unicode character key |
| 599 | 599 | // in the regular expression. |
| 600 | 600 | $stack = array(); |
| 601 | - foreach($chars as $char) { |
|
| 601 | + foreach ($chars as $char) { |
|
| 602 | 602 | $stack[] = '\x{'.$char.'}'; |
| 603 | 603 | } |
| 604 | 604 | |
@@ -629,12 +629,12 @@ discard block |
||
| 629 | 629 | $output = ''; |
| 630 | 630 | $split = str_split($unicodeChar); |
| 631 | 631 | |
| 632 | - foreach($split as $octet) |
|
| 632 | + foreach ($split as $octet) |
|
| 633 | 633 | { |
| 634 | 634 | $ordInt = ord($octet); |
| 635 | 635 | // Convert from int (base 10) to hex (base 16), for PHP \x syntax |
| 636 | 636 | $ordHex = base_convert((string)$ordInt, 10, 16); |
| 637 | - $output .= '\x' . $ordHex; |
|
| 637 | + $output .= '\x'.$ordHex; |
|
| 638 | 638 | } |
| 639 | 639 | |
| 640 | 640 | return $output; |
@@ -667,19 +667,19 @@ discard block |
||
| 667 | 667 | |
| 668 | 668 | protected static function convertScalarForComparison($scalar) |
| 669 | 669 | { |
| 670 | - if($scalar === '' || is_null($scalar)) { |
|
| 670 | + if ($scalar === '' || is_null($scalar)) { |
|
| 671 | 671 | return null; |
| 672 | 672 | } |
| 673 | 673 | |
| 674 | - if(is_bool($scalar)) { |
|
| 674 | + if (is_bool($scalar)) { |
|
| 675 | 675 | return self::bool2string($scalar); |
| 676 | 676 | } |
| 677 | 677 | |
| 678 | - if(is_array($scalar)) { |
|
| 678 | + if (is_array($scalar)) { |
|
| 679 | 679 | $scalar = md5(serialize($scalar)); |
| 680 | 680 | } |
| 681 | 681 | |
| 682 | - if($scalar !== null && !is_scalar($scalar)) { |
|
| 682 | + if ($scalar !== null && !is_scalar($scalar)) { |
|
| 683 | 683 | throw new ConvertHelper_Exception( |
| 684 | 684 | 'Not a scalar value in comparison', |
| 685 | 685 | null, |
@@ -728,7 +728,7 @@ discard block |
||
| 728 | 728 | public static function bool2string($boolean, bool $yesno = false) : string |
| 729 | 729 | { |
| 730 | 730 | // allow 'yes', 'true', 'no', 'false' string notations as well |
| 731 | - if(!is_bool($boolean)) { |
|
| 731 | + if (!is_bool($boolean)) { |
|
| 732 | 732 | $boolean = self::string2bool($boolean); |
| 733 | 733 | } |
| 734 | 734 | |
@@ -769,15 +769,15 @@ discard block |
||
| 769 | 769 | public static function array2attributeString($array) |
| 770 | 770 | { |
| 771 | 771 | $tokens = array(); |
| 772 | - foreach($array as $attr => $value) { |
|
| 773 | - if($value == '' || $value == null) { |
|
| 772 | + foreach ($array as $attr => $value) { |
|
| 773 | + if ($value == '' || $value == null) { |
|
| 774 | 774 | continue; |
| 775 | 775 | } |
| 776 | 776 | |
| 777 | 777 | $tokens[] = $attr.'="'.$value.'"'; |
| 778 | 778 | } |
| 779 | 779 | |
| 780 | - if(empty($tokens)) { |
|
| 780 | + if (empty($tokens)) { |
|
| 781 | 781 | return ''; |
| 782 | 782 | } |
| 783 | 783 | |
@@ -792,10 +792,10 @@ discard block |
||
| 792 | 792 | * @param string $string |
| 793 | 793 | * @return string |
| 794 | 794 | */ |
| 795 | - public static function string2attributeJS($string, $quoted=true) |
|
| 795 | + public static function string2attributeJS($string, $quoted = true) |
|
| 796 | 796 | { |
| 797 | 797 | $converted = addslashes(htmlspecialchars(strip_tags($string), ENT_QUOTES, 'UTF-8')); |
| 798 | - if($quoted) { |
|
| 798 | + if ($quoted) { |
|
| 799 | 799 | $converted = "'".$converted."'"; |
| 800 | 800 | } |
| 801 | 801 | |
@@ -813,11 +813,11 @@ discard block |
||
| 813 | 813 | */ |
| 814 | 814 | public static function isBoolean($value) : bool |
| 815 | 815 | { |
| 816 | - if(is_bool($value)) { |
|
| 816 | + if (is_bool($value)) { |
|
| 817 | 817 | return true; |
| 818 | 818 | } |
| 819 | 819 | |
| 820 | - if(!is_scalar($value)) { |
|
| 820 | + if (!is_scalar($value)) { |
|
| 821 | 821 | return false; |
| 822 | 822 | } |
| 823 | 823 | |
@@ -833,7 +833,7 @@ discard block |
||
| 833 | 833 | public static function array2styleString(array $subject) : string |
| 834 | 834 | { |
| 835 | 835 | $tokens = array(); |
| 836 | - foreach($subject as $name => $value) { |
|
| 836 | + foreach ($subject as $name => $value) { |
|
| 837 | 837 | $tokens[] = $name.':'.$value; |
| 838 | 838 | } |
| 839 | 839 | |
@@ -891,7 +891,7 @@ discard block |
||
| 891 | 891 | * |
| 892 | 892 | * @see JSHelper::buildRegexStatement() |
| 893 | 893 | */ |
| 894 | - public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) |
|
| 894 | + public static function regex2js(string $regex, string $statementType = JSHelper::JS_REGEX_OBJECT) |
|
| 895 | 895 | { |
| 896 | 896 | return JSHelper::buildRegexStatement($regex, $statementType); |
| 897 | 897 | } |
@@ -908,11 +908,11 @@ discard block |
||
| 908 | 908 | * @throws ConvertHelper_Exception |
| 909 | 909 | * @return string |
| 910 | 910 | */ |
| 911 | - public static function var2json($variable, int $options=0, int $depth=512) : string |
|
| 911 | + public static function var2json($variable, int $options = 0, int $depth = 512) : string |
|
| 912 | 912 | { |
| 913 | 913 | $result = json_encode($variable, $options, $depth); |
| 914 | 914 | |
| 915 | - if($result !== false) { |
|
| 915 | + if ($result !== false) { |
|
| 916 | 916 | return $result; |
| 917 | 917 | } |
| 918 | 918 | |
@@ -937,10 +937,10 @@ discard block |
||
| 937 | 937 | public static function stripUTFBom($string) |
| 938 | 938 | { |
| 939 | 939 | $boms = FileHelper::getUTFBOMs(); |
| 940 | - foreach($boms as $bomChars) { |
|
| 940 | + foreach ($boms as $bomChars) { |
|
| 941 | 941 | $length = mb_strlen($bomChars); |
| 942 | 942 | $text = mb_substr($string, 0, $length); |
| 943 | - if($text==$bomChars) { |
|
| 943 | + if ($text == $bomChars) { |
|
| 944 | 944 | return mb_substr($string, $length); |
| 945 | 945 | } |
| 946 | 946 | } |
@@ -957,7 +957,7 @@ discard block |
||
| 957 | 957 | */ |
| 958 | 958 | public static function string2utf8($string) |
| 959 | 959 | { |
| 960 | - if(!self::isStringASCII($string)) { |
|
| 960 | + if (!self::isStringASCII($string)) { |
|
| 961 | 961 | return \ForceUTF8\Encoding::toUTF8($string); |
| 962 | 962 | } |
| 963 | 963 | |
@@ -975,11 +975,11 @@ discard block |
||
| 975 | 975 | */ |
| 976 | 976 | public static function isStringASCII($string) : bool |
| 977 | 977 | { |
| 978 | - if($string === '' || $string === NULL) { |
|
| 978 | + if ($string === '' || $string === NULL) { |
|
| 979 | 979 | return true; |
| 980 | 980 | } |
| 981 | 981 | |
| 982 | - if(!is_string($string)) { |
|
| 982 | + if (!is_string($string)) { |
|
| 983 | 983 | return false; |
| 984 | 984 | } |
| 985 | 985 | |
@@ -1013,7 +1013,7 @@ discard block |
||
| 1013 | 1013 | * @param array $options |
| 1014 | 1014 | * @return float |
| 1015 | 1015 | */ |
| 1016 | - public static function matchString($source, $target, $options=array()) |
|
| 1016 | + public static function matchString($source, $target, $options = array()) |
|
| 1017 | 1017 | { |
| 1018 | 1018 | $defaults = array( |
| 1019 | 1019 | 'maxLevenshtein' => 10, |
@@ -1023,12 +1023,12 @@ discard block |
||
| 1023 | 1023 | $options = array_merge($defaults, $options); |
| 1024 | 1024 | |
| 1025 | 1025 | // avoid doing this via levenshtein |
| 1026 | - if($source == $target) { |
|
| 1026 | + if ($source == $target) { |
|
| 1027 | 1027 | return 100; |
| 1028 | 1028 | } |
| 1029 | 1029 | |
| 1030 | 1030 | $diff = levenshtein($source, $target); |
| 1031 | - if($diff > $options['maxLevenshtein']) { |
|
| 1031 | + if ($diff > $options['maxLevenshtein']) { |
|
| 1032 | 1032 | return 0; |
| 1033 | 1033 | } |
| 1034 | 1034 | |
@@ -1112,24 +1112,24 @@ discard block |
||
| 1112 | 1112 | * @see ConvertHelper::INTERVAL_HOURS |
| 1113 | 1113 | * @see ConvertHelper::INTERVAL_DAYS |
| 1114 | 1114 | */ |
| 1115 | - public static function interval2total(\DateInterval $interval, $unit=self::INTERVAL_SECONDS) : int |
|
| 1115 | + public static function interval2total(\DateInterval $interval, $unit = self::INTERVAL_SECONDS) : int |
|
| 1116 | 1116 | { |
| 1117 | 1117 | $total = (int)$interval->format('%a'); |
| 1118 | 1118 | if ($unit == self::INTERVAL_DAYS) { |
| 1119 | 1119 | return $total; |
| 1120 | 1120 | } |
| 1121 | 1121 | |
| 1122 | - $total = ($total * 24) + ((int)$interval->h ); |
|
| 1122 | + $total = ($total * 24) + ((int)$interval->h); |
|
| 1123 | 1123 | if ($unit == self::INTERVAL_HOURS) { |
| 1124 | 1124 | return $total; |
| 1125 | 1125 | } |
| 1126 | 1126 | |
| 1127 | - $total = ($total * 60) + ((int)$interval->i ); |
|
| 1127 | + $total = ($total * 60) + ((int)$interval->i); |
|
| 1128 | 1128 | if ($unit == self::INTERVAL_MINUTES) { |
| 1129 | 1129 | return $total; |
| 1130 | 1130 | } |
| 1131 | 1131 | |
| 1132 | - $total = ($total * 60) + ((int)$interval->s ); |
|
| 1132 | + $total = ($total * 60) + ((int)$interval->s); |
|
| 1133 | 1133 | if ($unit == self::INTERVAL_SECONDS) { |
| 1134 | 1134 | return $total; |
| 1135 | 1135 | } |
@@ -1158,13 +1158,13 @@ discard block |
||
| 1158 | 1158 | * @param bool $short |
| 1159 | 1159 | * @return string|NULL |
| 1160 | 1160 | */ |
| 1161 | - public static function date2dayName(\DateTime $date, bool $short=false) |
|
| 1161 | + public static function date2dayName(\DateTime $date, bool $short = false) |
|
| 1162 | 1162 | { |
| 1163 | 1163 | $day = $date->format('l'); |
| 1164 | 1164 | $invariant = self::getDayNamesInvariant(); |
| 1165 | 1165 | |
| 1166 | 1166 | $idx = array_search($day, $invariant); |
| 1167 | - if($idx !== false) { |
|
| 1167 | + if ($idx !== false) { |
|
| 1168 | 1168 | $localized = self::getDayNames($short); |
| 1169 | 1169 | return $localized[$idx]; |
| 1170 | 1170 | } |
@@ -1187,10 +1187,10 @@ discard block |
||
| 1187 | 1187 | * @param bool $short |
| 1188 | 1188 | * @return array |
| 1189 | 1189 | */ |
| 1190 | - public static function getDayNames(bool $short=false) : array |
|
| 1190 | + public static function getDayNames(bool $short = false) : array |
|
| 1191 | 1191 | { |
| 1192 | - if($short) { |
|
| 1193 | - if(!isset(self::$daysShort)) { |
|
| 1192 | + if ($short) { |
|
| 1193 | + if (!isset(self::$daysShort)) { |
|
| 1194 | 1194 | self::$daysShort = array( |
| 1195 | 1195 | t('Mon'), |
| 1196 | 1196 | t('Tue'), |
@@ -1205,7 +1205,7 @@ discard block |
||
| 1205 | 1205 | return self::$daysShort; |
| 1206 | 1206 | } |
| 1207 | 1207 | |
| 1208 | - if(!isset(self::$days)) { |
|
| 1208 | + if (!isset(self::$days)) { |
|
| 1209 | 1209 | self::$days = array( |
| 1210 | 1210 | t('Monday'), |
| 1211 | 1211 | t('Tuesday'), |
@@ -1230,17 +1230,17 @@ discard block |
||
| 1230 | 1230 | */ |
| 1231 | 1231 | public static function implodeWithAnd(array $list, $sep = ', ', $conjunction = null) |
| 1232 | 1232 | { |
| 1233 | - if(empty($list)) { |
|
| 1233 | + if (empty($list)) { |
|
| 1234 | 1234 | return ''; |
| 1235 | 1235 | } |
| 1236 | 1236 | |
| 1237 | - if(empty($conjunction)) { |
|
| 1237 | + if (empty($conjunction)) { |
|
| 1238 | 1238 | $conjunction = t('and'); |
| 1239 | 1239 | } |
| 1240 | 1240 | |
| 1241 | 1241 | $last = array_pop($list); |
| 1242 | - if($list) { |
|
| 1243 | - return implode($sep, $list) . $conjunction . ' ' . $last; |
|
| 1242 | + if ($list) { |
|
| 1243 | + return implode($sep, $list).$conjunction.' '.$last; |
|
| 1244 | 1244 | } |
| 1245 | 1245 | |
| 1246 | 1246 | return $last; |
@@ -1259,7 +1259,7 @@ discard block |
||
| 1259 | 1259 | public static function string2array(string $string) : array |
| 1260 | 1260 | { |
| 1261 | 1261 | $result = preg_split('//u', $string, null, PREG_SPLIT_NO_EMPTY); |
| 1262 | - if($result !== false) { |
|
| 1262 | + if ($result !== false) { |
|
| 1263 | 1263 | return $result; |
| 1264 | 1264 | } |
| 1265 | 1265 | |
@@ -1274,12 +1274,12 @@ discard block |
||
| 1274 | 1274 | */ |
| 1275 | 1275 | public static function isStringHTML(string $string) : bool |
| 1276 | 1276 | { |
| 1277 | - if(preg_match('%<[a-z/][\s\S]*>%siU', $string)) { |
|
| 1277 | + if (preg_match('%<[a-z/][\s\S]*>%siU', $string)) { |
|
| 1278 | 1278 | return true; |
| 1279 | 1279 | } |
| 1280 | 1280 | |
| 1281 | 1281 | $decoded = html_entity_decode($string); |
| 1282 | - if($decoded !== $string) { |
|
| 1282 | + if ($decoded !== $string) { |
|
| 1283 | 1283 | return true; |
| 1284 | 1284 | } |
| 1285 | 1285 | |
@@ -1388,14 +1388,14 @@ discard block |
||
| 1388 | 1388 | * @param bool $caseInsensitive |
| 1389 | 1389 | * @return ConvertHelper_StringMatch[] |
| 1390 | 1390 | */ |
| 1391 | - public static function findString(string $needle, string $haystack, bool $caseInsensitive=false) |
|
| 1391 | + public static function findString(string $needle, string $haystack, bool $caseInsensitive = false) |
|
| 1392 | 1392 | { |
| 1393 | - if($needle === '') { |
|
| 1393 | + if ($needle === '') { |
|
| 1394 | 1394 | return array(); |
| 1395 | 1395 | } |
| 1396 | 1396 | |
| 1397 | 1397 | $function = 'mb_strpos'; |
| 1398 | - if($caseInsensitive) { |
|
| 1398 | + if ($caseInsensitive) { |
|
| 1399 | 1399 | $function = 'mb_stripos'; |
| 1400 | 1400 | } |
| 1401 | 1401 | |
@@ -1403,7 +1403,7 @@ discard block |
||
| 1403 | 1403 | $positions = array(); |
| 1404 | 1404 | $length = mb_strlen($needle); |
| 1405 | 1405 | |
| 1406 | - while( ($pos = $function($haystack, $needle, $pos)) !== false) |
|
| 1406 | + while (($pos = $function($haystack, $needle, $pos)) !== false) |
|
| 1407 | 1407 | { |
| 1408 | 1408 | $match = mb_substr($haystack, $pos, $length); |
| 1409 | 1409 | $positions[] = new ConvertHelper_StringMatch($pos, $match); |
@@ -1423,7 +1423,7 @@ discard block |
||
| 1423 | 1423 | */ |
| 1424 | 1424 | public static function explodeTrim(string $delimiter, string $string) : array |
| 1425 | 1425 | { |
| 1426 | - if(empty($string) || empty($delimiter)) { |
|
| 1426 | + if (empty($string) || empty($delimiter)) { |
|
| 1427 | 1427 | return array(); |
| 1428 | 1428 | } |
| 1429 | 1429 | |
@@ -1431,8 +1431,8 @@ discard block |
||
| 1431 | 1431 | $tokens = array_map('trim', $tokens); |
| 1432 | 1432 | |
| 1433 | 1433 | $keep = array(); |
| 1434 | - foreach($tokens as $token) { |
|
| 1435 | - if($token !== '') { |
|
| 1434 | + foreach ($tokens as $token) { |
|
| 1435 | + if ($token !== '') { |
|
| 1436 | 1436 | $keep[] = $token; |
| 1437 | 1437 | } |
| 1438 | 1438 | } |
@@ -1450,11 +1450,11 @@ discard block |
||
| 1450 | 1450 | */ |
| 1451 | 1451 | public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL |
| 1452 | 1452 | { |
| 1453 | - if(empty($subjectString)) { |
|
| 1453 | + if (empty($subjectString)) { |
|
| 1454 | 1454 | return null; |
| 1455 | 1455 | } |
| 1456 | 1456 | |
| 1457 | - if(!isset(self::$eolChars)) |
|
| 1457 | + if (!isset(self::$eolChars)) |
|
| 1458 | 1458 | { |
| 1459 | 1459 | $cr = chr((int)hexdec('0d')); |
| 1460 | 1460 | $lf = chr((int)hexdec('0a')); |
@@ -1485,18 +1485,18 @@ discard block |
||
| 1485 | 1485 | |
| 1486 | 1486 | $max = 0; |
| 1487 | 1487 | $results = array(); |
| 1488 | - foreach(self::$eolChars as $def) |
|
| 1488 | + foreach (self::$eolChars as $def) |
|
| 1489 | 1489 | { |
| 1490 | 1490 | $amount = substr_count($subjectString, $def['char']); |
| 1491 | 1491 | |
| 1492 | - if($amount > $max) |
|
| 1492 | + if ($amount > $max) |
|
| 1493 | 1493 | { |
| 1494 | 1494 | $max = $amount; |
| 1495 | 1495 | $results[] = $def; |
| 1496 | 1496 | } |
| 1497 | 1497 | } |
| 1498 | 1498 | |
| 1499 | - if(empty($results)) { |
|
| 1499 | + if (empty($results)) { |
|
| 1500 | 1500 | return null; |
| 1501 | 1501 | } |
| 1502 | 1502 | |
@@ -1516,9 +1516,9 @@ discard block |
||
| 1516 | 1516 | */ |
| 1517 | 1517 | public static function arrayRemoveKeys(array &$array, array $keys) : void |
| 1518 | 1518 | { |
| 1519 | - foreach($keys as $key) |
|
| 1519 | + foreach ($keys as $key) |
|
| 1520 | 1520 | { |
| 1521 | - if(array_key_exists($key, $array)) { |
|
| 1521 | + if (array_key_exists($key, $array)) { |
|
| 1522 | 1522 | unset($array[$key]); |
| 1523 | 1523 | } |
| 1524 | 1524 | } |
@@ -1533,17 +1533,17 @@ discard block |
||
| 1533 | 1533 | */ |
| 1534 | 1534 | public static function isInteger($value) : bool |
| 1535 | 1535 | { |
| 1536 | - if(is_int($value)) { |
|
| 1536 | + if (is_int($value)) { |
|
| 1537 | 1537 | return true; |
| 1538 | 1538 | } |
| 1539 | 1539 | |
| 1540 | 1540 | // booleans get converted to numbers, so they would |
| 1541 | 1541 | // actually match the regex. |
| 1542 | - if(is_bool($value)) { |
|
| 1542 | + if (is_bool($value)) { |
|
| 1543 | 1543 | return false; |
| 1544 | 1544 | } |
| 1545 | 1545 | |
| 1546 | - if(is_string($value) && $value !== '') { |
|
| 1546 | + if (is_string($value) && $value !== '') { |
|
| 1547 | 1547 | return preg_match('/\A-?\d+\z/', $value) === 1; |
| 1548 | 1548 | } |
| 1549 | 1549 | |