@@ -55,13 +55,13 @@ discard block |
||
| 55 | 55 | return ConvertHelper_String::tabs2spaces($string, $tabSize); |
| 56 | 56 | } |
| 57 | 57 | |
| 58 | - /** |
|
| 59 | - * Converts spaces to tabs in the specified string. |
|
| 60 | - * |
|
| 61 | - * @param string $string |
|
| 62 | - * @param int $tabSize The amount of spaces per tab in the source string. |
|
| 63 | - * @return string |
|
| 64 | - */ |
|
| 58 | + /** |
|
| 59 | + * Converts spaces to tabs in the specified string. |
|
| 60 | + * |
|
| 61 | + * @param string $string |
|
| 62 | + * @param int $tabSize The amount of spaces per tab in the source string. |
|
| 63 | + * @return string |
|
| 64 | + */ |
|
| 65 | 65 | public static function spaces2tabs(string $string, int $tabSize=4) : string |
| 66 | 66 | { |
| 67 | 67 | return ConvertHelper_String::spaces2tabs($string, $tabSize); |
@@ -79,14 +79,14 @@ discard block |
||
| 79 | 79 | return ConvertHelper_String::hidden2visible($string); |
| 80 | 80 | } |
| 81 | 81 | |
| 82 | - /** |
|
| 83 | - * Converts the specified amount of seconds into |
|
| 84 | - * a human-readable string split in months, weeks, |
|
| 85 | - * days, hours, minutes and seconds. |
|
| 86 | - * |
|
| 87 | - * @param float $seconds |
|
| 88 | - * @return string |
|
| 89 | - */ |
|
| 82 | + /** |
|
| 83 | + * Converts the specified amount of seconds into |
|
| 84 | + * a human-readable string split in months, weeks, |
|
| 85 | + * days, hours, minutes and seconds. |
|
| 86 | + * |
|
| 87 | + * @param float $seconds |
|
| 88 | + * @return string |
|
| 89 | + */ |
|
| 90 | 90 | public static function time2string($seconds) : string |
| 91 | 91 | { |
| 92 | 92 | $converter = new ConvertHelper_TimeConverter($seconds); |
@@ -110,85 +110,85 @@ discard block |
||
| 110 | 110 | */ |
| 111 | 111 | public static function duration2string($datefrom, $dateto = -1) : string |
| 112 | 112 | { |
| 113 | - return ConvertHelper_DurationConverter::toString($datefrom, $dateto); |
|
| 113 | + return ConvertHelper_DurationConverter::toString($datefrom, $dateto); |
|
| 114 | 114 | } |
| 115 | 115 | |
| 116 | - /** |
|
| 117 | - * Adds HTML syntax highlighting to the specified SQL string. |
|
| 118 | - * |
|
| 119 | - * @param string $sql |
|
| 120 | - * @return string |
|
| 121 | - * @deprecated Use the Highlighter class directly instead. |
|
| 122 | - * @see Highlighter::sql() |
|
| 123 | - */ |
|
| 116 | + /** |
|
| 117 | + * Adds HTML syntax highlighting to the specified SQL string. |
|
| 118 | + * |
|
| 119 | + * @param string $sql |
|
| 120 | + * @return string |
|
| 121 | + * @deprecated Use the Highlighter class directly instead. |
|
| 122 | + * @see Highlighter::sql() |
|
| 123 | + */ |
|
| 124 | 124 | public static function highlight_sql(string $sql) : string |
| 125 | 125 | { |
| 126 | 126 | return Highlighter::sql($sql); |
| 127 | 127 | } |
| 128 | 128 | |
| 129 | - /** |
|
| 130 | - * Adds HTML syntax highlighting to the specified XML code. |
|
| 131 | - * |
|
| 132 | - * @param string $xml The XML to highlight. |
|
| 133 | - * @param bool $formatSource Whether to format the source with indentation to make it readable. |
|
| 134 | - * @return string |
|
| 135 | - * @deprecated Use the Highlighter class directly instead. |
|
| 136 | - * @see Highlighter::xml() |
|
| 137 | - */ |
|
| 129 | + /** |
|
| 130 | + * Adds HTML syntax highlighting to the specified XML code. |
|
| 131 | + * |
|
| 132 | + * @param string $xml The XML to highlight. |
|
| 133 | + * @param bool $formatSource Whether to format the source with indentation to make it readable. |
|
| 134 | + * @return string |
|
| 135 | + * @deprecated Use the Highlighter class directly instead. |
|
| 136 | + * @see Highlighter::xml() |
|
| 137 | + */ |
|
| 138 | 138 | public static function highlight_xml(string $xml, bool $formatSource=false) : string |
| 139 | 139 | { |
| 140 | 140 | return Highlighter::xml($xml, $formatSource); |
| 141 | 141 | } |
| 142 | 142 | |
| 143 | - /** |
|
| 144 | - * @param string $phpCode |
|
| 145 | - * @return string |
|
| 146 | - * @deprecated Use the Highlighter class directly instead. |
|
| 147 | - * @see Highlighter::php() |
|
| 148 | - */ |
|
| 143 | + /** |
|
| 144 | + * @param string $phpCode |
|
| 145 | + * @return string |
|
| 146 | + * @deprecated Use the Highlighter class directly instead. |
|
| 147 | + * @see Highlighter::php() |
|
| 148 | + */ |
|
| 149 | 149 | public static function highlight_php(string $phpCode) : string |
| 150 | 150 | { |
| 151 | 151 | return Highlighter::php($phpCode); |
| 152 | 152 | } |
| 153 | 153 | |
| 154 | - /** |
|
| 155 | - * Converts a number of bytes to a human readable form, |
|
| 156 | - * e.g. xx Kb / xx Mb / xx Gb |
|
| 157 | - * |
|
| 158 | - * @param int $bytes The amount of bytes to convert. |
|
| 159 | - * @param int $precision The amount of decimals |
|
| 160 | - * @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). |
|
| 161 | - * @return string |
|
| 162 | - * |
|
| 163 | - * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
| 164 | - */ |
|
| 154 | + /** |
|
| 155 | + * Converts a number of bytes to a human readable form, |
|
| 156 | + * e.g. xx Kb / xx Mb / xx Gb |
|
| 157 | + * |
|
| 158 | + * @param int $bytes The amount of bytes to convert. |
|
| 159 | + * @param int $precision The amount of decimals |
|
| 160 | + * @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). |
|
| 161 | + * @return string |
|
| 162 | + * |
|
| 163 | + * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
| 164 | + */ |
|
| 165 | 165 | public static function bytes2readable(int $bytes, int $precision = 1, int $base = ConvertHelper_StorageSizeEnum::BASE_10) : string |
| 166 | 166 | { |
| 167 | 167 | return self::parseBytes($bytes)->toString($precision, $base); |
| 168 | 168 | } |
| 169 | 169 | |
| 170 | - /** |
|
| 171 | - * Parses a number of bytes, and creates a converter instance which |
|
| 172 | - * allows doing common operations with it. |
|
| 173 | - * |
|
| 174 | - * @param int $bytes |
|
| 175 | - * @return ConvertHelper_ByteConverter |
|
| 176 | - */ |
|
| 170 | + /** |
|
| 171 | + * Parses a number of bytes, and creates a converter instance which |
|
| 172 | + * allows doing common operations with it. |
|
| 173 | + * |
|
| 174 | + * @param int $bytes |
|
| 175 | + * @return ConvertHelper_ByteConverter |
|
| 176 | + */ |
|
| 177 | 177 | public static function parseBytes(int $bytes) : ConvertHelper_ByteConverter |
| 178 | 178 | { |
| 179 | 179 | return new ConvertHelper_ByteConverter($bytes); |
| 180 | 180 | } |
| 181 | 181 | |
| 182 | - /** |
|
| 183 | - * Cuts a text to the specified length if it is longer than the |
|
| 184 | - * target length. Appends a text to signify it has been cut at |
|
| 185 | - * the end of the string. |
|
| 186 | - * |
|
| 187 | - * @param string $text |
|
| 188 | - * @param int $targetLength |
|
| 189 | - * @param string $append |
|
| 190 | - * @return string |
|
| 191 | - */ |
|
| 182 | + /** |
|
| 183 | + * Cuts a text to the specified length if it is longer than the |
|
| 184 | + * target length. Appends a text to signify it has been cut at |
|
| 185 | + * the end of the string. |
|
| 186 | + * |
|
| 187 | + * @param string $text |
|
| 188 | + * @param int $targetLength |
|
| 189 | + * @param string $append |
|
| 190 | + * @return string |
|
| 191 | + */ |
|
| 192 | 192 | public static function text_cut(string $text, int $targetLength, string $append = '...') : string |
| 193 | 193 | { |
| 194 | 194 | return ConvertHelper_String::cutText($text, $targetLength, $append); |
@@ -212,14 +212,14 @@ discard block |
||
| 212 | 212 | return $info->toString(); |
| 213 | 213 | } |
| 214 | 214 | |
| 215 | - /** |
|
| 216 | - * Pretty `print_r`. |
|
| 217 | - * |
|
| 218 | - * @param mixed $var The variable to dump. |
|
| 219 | - * @param bool $return Whether to return the dumped code. |
|
| 220 | - * @param bool $html Whether to style the dump as HTML. |
|
| 221 | - * @return string |
|
| 222 | - */ |
|
| 215 | + /** |
|
| 216 | + * Pretty `print_r`. |
|
| 217 | + * |
|
| 218 | + * @param mixed $var The variable to dump. |
|
| 219 | + * @param bool $return Whether to return the dumped code. |
|
| 220 | + * @param bool $html Whether to style the dump as HTML. |
|
| 221 | + * @return string |
|
| 222 | + */ |
|
| 223 | 223 | public static function print_r($var, bool $return=false, bool $html=true) : string |
| 224 | 224 | { |
| 225 | 225 | $result = parseVariable($var)->enableType()->toString(); |
@@ -240,41 +240,41 @@ discard block |
||
| 240 | 240 | return $result; |
| 241 | 241 | } |
| 242 | 242 | |
| 243 | - /** |
|
| 244 | - * Converts a string, number or boolean value to a boolean value. |
|
| 245 | - * |
|
| 246 | - * @param mixed $string |
|
| 247 | - * @throws ConvertHelper_Exception |
|
| 248 | - * @return bool |
|
| 249 | - * |
|
| 250 | - * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING |
|
| 251 | - */ |
|
| 243 | + /** |
|
| 244 | + * Converts a string, number or boolean value to a boolean value. |
|
| 245 | + * |
|
| 246 | + * @param mixed $string |
|
| 247 | + * @throws ConvertHelper_Exception |
|
| 248 | + * @return bool |
|
| 249 | + * |
|
| 250 | + * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING |
|
| 251 | + */ |
|
| 252 | 252 | public static function string2bool($string) : bool |
| 253 | 253 | { |
| 254 | 254 | return ConvertHelper_Bool::fromString($string); |
| 255 | 255 | } |
| 256 | 256 | |
| 257 | - /** |
|
| 258 | - * Whether the specified string is a boolean string or boolean value. |
|
| 259 | - * Alias for {@link ConvertHelper::isBoolean()}. |
|
| 260 | - * |
|
| 261 | - * @param mixed $string |
|
| 262 | - * @return bool |
|
| 263 | - * @deprecated |
|
| 264 | - * @see ConvertHelper::isBoolean() |
|
| 265 | - */ |
|
| 257 | + /** |
|
| 258 | + * Whether the specified string is a boolean string or boolean value. |
|
| 259 | + * Alias for {@link ConvertHelper::isBoolean()}. |
|
| 260 | + * |
|
| 261 | + * @param mixed $string |
|
| 262 | + * @return bool |
|
| 263 | + * @deprecated |
|
| 264 | + * @see ConvertHelper::isBoolean() |
|
| 265 | + */ |
|
| 266 | 266 | public static function isBooleanString($string) : bool |
| 267 | 267 | { |
| 268 | 268 | return self::isBoolean($string); |
| 269 | 269 | } |
| 270 | 270 | |
| 271 | - /** |
|
| 272 | - * Alias for the {@\AppUtils\XMLHelper::string2xml()} method. |
|
| 273 | - * |
|
| 274 | - * @param string $text |
|
| 275 | - * @return string |
|
| 276 | - * @deprecated |
|
| 277 | - */ |
|
| 271 | + /** |
|
| 272 | + * Alias for the {@\AppUtils\XMLHelper::string2xml()} method. |
|
| 273 | + * |
|
| 274 | + * @param string $text |
|
| 275 | + * @return string |
|
| 276 | + * @deprecated |
|
| 277 | + */ |
|
| 278 | 278 | public static function text_makeXMLCompliant($text) |
| 279 | 279 | { |
| 280 | 280 | return XMLHelper::string2xml($text); |
@@ -331,36 +331,36 @@ discard block |
||
| 331 | 331 | return ConvertHelper_String::transliterate($string, $spaceChar, $lowercase); |
| 332 | 332 | } |
| 333 | 333 | |
| 334 | - /** |
|
| 335 | - * Retrieves the HEX character codes for all control |
|
| 336 | - * characters that the {@link stripControlCharacters()} |
|
| 337 | - * method will remove. |
|
| 338 | - * |
|
| 339 | - * @return string[] |
|
| 340 | - */ |
|
| 334 | + /** |
|
| 335 | + * Retrieves the HEX character codes for all control |
|
| 336 | + * characters that the {@link stripControlCharacters()} |
|
| 337 | + * method will remove. |
|
| 338 | + * |
|
| 339 | + * @return string[] |
|
| 340 | + */ |
|
| 341 | 341 | public static function getControlCharactersAsHex() : array |
| 342 | 342 | { |
| 343 | 343 | return self::createControlCharacters()->getCharsAsHex(); |
| 344 | 344 | } |
| 345 | 345 | |
| 346 | - /** |
|
| 347 | - * Retrieves an array of all control characters that |
|
| 348 | - * the {@link stripControlCharacters()} method will |
|
| 349 | - * remove, as the actual UTF-8 characters. |
|
| 350 | - * |
|
| 351 | - * @return string[] |
|
| 352 | - */ |
|
| 346 | + /** |
|
| 347 | + * Retrieves an array of all control characters that |
|
| 348 | + * the {@link stripControlCharacters()} method will |
|
| 349 | + * remove, as the actual UTF-8 characters. |
|
| 350 | + * |
|
| 351 | + * @return string[] |
|
| 352 | + */ |
|
| 353 | 353 | public static function getControlCharactersAsUTF8() : array |
| 354 | 354 | { |
| 355 | 355 | return self::createControlCharacters()->getCharsAsUTF8(); |
| 356 | 356 | } |
| 357 | 357 | |
| 358 | - /** |
|
| 359 | - * Retrieves all control characters as JSON encoded |
|
| 360 | - * characters, e.g. "\u200b". |
|
| 361 | - * |
|
| 362 | - * @return string[] |
|
| 363 | - */ |
|
| 358 | + /** |
|
| 359 | + * Retrieves all control characters as JSON encoded |
|
| 360 | + * characters, e.g. "\u200b". |
|
| 361 | + * |
|
| 362 | + * @return string[] |
|
| 363 | + */ |
|
| 364 | 364 | public static function getControlCharactersAsJSON() : array |
| 365 | 365 | { |
| 366 | 366 | return self::createControlCharacters()->getCharsAsJSON(); |
@@ -381,31 +381,31 @@ discard block |
||
| 381 | 381 | return self::createControlCharacters()->stripControlCharacters($string); |
| 382 | 382 | } |
| 383 | 383 | |
| 384 | - /** |
|
| 385 | - * Creates the control characters class, used to |
|
| 386 | - * work with control characters in strings. |
|
| 387 | - * |
|
| 388 | - * @return ConvertHelper_ControlCharacters |
|
| 389 | - */ |
|
| 384 | + /** |
|
| 385 | + * Creates the control characters class, used to |
|
| 386 | + * work with control characters in strings. |
|
| 387 | + * |
|
| 388 | + * @return ConvertHelper_ControlCharacters |
|
| 389 | + */ |
|
| 390 | 390 | public static function createControlCharacters() : ConvertHelper_ControlCharacters |
| 391 | 391 | { |
| 392 | 392 | return new ConvertHelper_ControlCharacters(); |
| 393 | 393 | } |
| 394 | 394 | |
| 395 | - /** |
|
| 396 | - * Converts a unicode character to the PHP notation. |
|
| 397 | - * |
|
| 398 | - * Example: |
|
| 399 | - * |
|
| 400 | - * <pre>unicodeChar2php('"\u0000"')</pre> |
|
| 401 | - * |
|
| 402 | - * Returns |
|
| 403 | - * |
|
| 404 | - * <pre>\x0</pre> |
|
| 405 | - * |
|
| 406 | - * @param string $unicodeChar |
|
| 407 | - * @return string |
|
| 408 | - */ |
|
| 395 | + /** |
|
| 396 | + * Converts a unicode character to the PHP notation. |
|
| 397 | + * |
|
| 398 | + * Example: |
|
| 399 | + * |
|
| 400 | + * <pre>unicodeChar2php('"\u0000"')</pre> |
|
| 401 | + * |
|
| 402 | + * Returns |
|
| 403 | + * |
|
| 404 | + * <pre>\x0</pre> |
|
| 405 | + * |
|
| 406 | + * @param string $unicodeChar |
|
| 407 | + * @return string |
|
| 408 | + */ |
|
| 409 | 409 | public static function unicodeChar2php(string $unicodeChar) : string |
| 410 | 410 | { |
| 411 | 411 | $unicodeChar = json_decode($unicodeChar); |
@@ -556,138 +556,138 @@ discard block |
||
| 556 | 556 | return ConvertHelper_Bool::toStringStrict($boolean, $yesNo); |
| 557 | 557 | } |
| 558 | 558 | |
| 559 | - /** |
|
| 560 | - * Converts an associative array with attribute name > value pairs |
|
| 561 | - * to an attribute string that can be used in an HTML tag. Empty |
|
| 562 | - * attribute values are ignored. |
|
| 563 | - * |
|
| 564 | - * Example: |
|
| 565 | - * |
|
| 566 | - * array2attributeString(array( |
|
| 567 | - * 'id' => 45, |
|
| 568 | - * 'href' => 'http://www.mistralys.com' |
|
| 569 | - * )); |
|
| 570 | - * |
|
| 571 | - * Result: |
|
| 572 | - * |
|
| 573 | - * id="45" href="http://www.mistralys.com" |
|
| 574 | - * |
|
| 575 | - * @param array<string,mixed> $array |
|
| 576 | - * @return string |
|
| 577 | - */ |
|
| 559 | + /** |
|
| 560 | + * Converts an associative array with attribute name > value pairs |
|
| 561 | + * to an attribute string that can be used in an HTML tag. Empty |
|
| 562 | + * attribute values are ignored. |
|
| 563 | + * |
|
| 564 | + * Example: |
|
| 565 | + * |
|
| 566 | + * array2attributeString(array( |
|
| 567 | + * 'id' => 45, |
|
| 568 | + * 'href' => 'http://www.mistralys.com' |
|
| 569 | + * )); |
|
| 570 | + * |
|
| 571 | + * Result: |
|
| 572 | + * |
|
| 573 | + * id="45" href="http://www.mistralys.com" |
|
| 574 | + * |
|
| 575 | + * @param array<string,mixed> $array |
|
| 576 | + * @return string |
|
| 577 | + */ |
|
| 578 | 578 | public static function array2attributeString(array $array) : string |
| 579 | 579 | { |
| 580 | 580 | return ConvertHelper_Array::toAttributeString($array); |
| 581 | 581 | } |
| 582 | 582 | |
| 583 | - /** |
|
| 584 | - * Converts a string, so it can safely be used in a javascript |
|
| 585 | - * statement in an HTML tag: uses single quotes around the string |
|
| 586 | - * and encodes all special characters as needed. |
|
| 587 | - * |
|
| 588 | - * @param string $string |
|
| 589 | - * @return string |
|
| 590 | - * @deprecated Use the JSHelper class instead. |
|
| 591 | - * @see JSHelper::phpVariable2AttributeJS() |
|
| 592 | - */ |
|
| 583 | + /** |
|
| 584 | + * Converts a string, so it can safely be used in a javascript |
|
| 585 | + * statement in an HTML tag: uses single quotes around the string |
|
| 586 | + * and encodes all special characters as needed. |
|
| 587 | + * |
|
| 588 | + * @param string $string |
|
| 589 | + * @return string |
|
| 590 | + * @deprecated Use the JSHelper class instead. |
|
| 591 | + * @see JSHelper::phpVariable2AttributeJS() |
|
| 592 | + */ |
|
| 593 | 593 | public static function string2attributeJS(string $string) : string |
| 594 | 594 | { |
| 595 | 595 | return JSHelper::phpVariable2AttributeJS($string); |
| 596 | 596 | } |
| 597 | 597 | |
| 598 | - /** |
|
| 599 | - * Checks if the specified string is a boolean value, which |
|
| 600 | - * includes string representations of boolean values, like |
|
| 601 | - * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
| 602 | - * or <code>false</code>. |
|
| 603 | - * |
|
| 604 | - * @param mixed $value |
|
| 605 | - * @return boolean |
|
| 606 | - */ |
|
| 598 | + /** |
|
| 599 | + * Checks if the specified string is a boolean value, which |
|
| 600 | + * includes string representations of boolean values, like |
|
| 601 | + * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
| 602 | + * or <code>false</code>. |
|
| 603 | + * |
|
| 604 | + * @param mixed $value |
|
| 605 | + * @return boolean |
|
| 606 | + */ |
|
| 607 | 607 | public static function isBoolean($value) : bool |
| 608 | 608 | { |
| 609 | 609 | return ConvertHelper_Bool::isBoolean($value); |
| 610 | 610 | } |
| 611 | 611 | |
| 612 | - /** |
|
| 613 | - * Converts an associative array to an HTML style attribute value string. |
|
| 614 | - * |
|
| 615 | - * @param array<string,mixed> $subject |
|
| 616 | - * @return string |
|
| 617 | - */ |
|
| 612 | + /** |
|
| 613 | + * Converts an associative array to an HTML style attribute value string. |
|
| 614 | + * |
|
| 615 | + * @param array<string,mixed> $subject |
|
| 616 | + * @return string |
|
| 617 | + */ |
|
| 618 | 618 | public static function array2styleString(array $subject) : string |
| 619 | 619 | { |
| 620 | 620 | return ConvertHelper_Array::toStyleString($subject); |
| 621 | 621 | } |
| 622 | 622 | |
| 623 | - /** |
|
| 624 | - * Converts a DateTime object to a timestamp, which |
|
| 625 | - * is PHP 5.2 compatible. |
|
| 626 | - * |
|
| 627 | - * @param DateTime $date |
|
| 628 | - * @return integer |
|
| 629 | - */ |
|
| 623 | + /** |
|
| 624 | + * Converts a DateTime object to a timestamp, which |
|
| 625 | + * is PHP 5.2 compatible. |
|
| 626 | + * |
|
| 627 | + * @param DateTime $date |
|
| 628 | + * @return integer |
|
| 629 | + */ |
|
| 630 | 630 | public static function date2timestamp(DateTime $date) : int |
| 631 | 631 | { |
| 632 | 632 | return ConvertHelper_Date::toTimestamp($date); |
| 633 | 633 | } |
| 634 | 634 | |
| 635 | - /** |
|
| 636 | - * Converts a timestamp into a DateTime instance. |
|
| 637 | - * @param int $timestamp |
|
| 638 | - * @return DateTime |
|
| 639 | - */ |
|
| 635 | + /** |
|
| 636 | + * Converts a timestamp into a DateTime instance. |
|
| 637 | + * @param int $timestamp |
|
| 638 | + * @return DateTime |
|
| 639 | + */ |
|
| 640 | 640 | public static function timestamp2date(int $timestamp) : DateTime |
| 641 | 641 | { |
| 642 | 642 | return ConvertHelper_Date::fromTimestamp($timestamp); |
| 643 | 643 | } |
| 644 | 644 | |
| 645 | - /** |
|
| 646 | - * Strips an absolute path to a file within the application |
|
| 647 | - * to make the path relative to the application root path. |
|
| 648 | - * |
|
| 649 | - * @param string $path |
|
| 650 | - * @return string |
|
| 651 | - * |
|
| 652 | - * @see FileHelper::relativizePath() |
|
| 653 | - * @see FileHelper::relativizePathByDepth() |
|
| 654 | - */ |
|
| 645 | + /** |
|
| 646 | + * Strips an absolute path to a file within the application |
|
| 647 | + * to make the path relative to the application root path. |
|
| 648 | + * |
|
| 649 | + * @param string $path |
|
| 650 | + * @return string |
|
| 651 | + * |
|
| 652 | + * @see FileHelper::relativizePath() |
|
| 653 | + * @see FileHelper::relativizePathByDepth() |
|
| 654 | + */ |
|
| 655 | 655 | public static function fileRelativize(string $path) : string |
| 656 | 656 | { |
| 657 | 657 | return FileHelper::relativizePathByDepth($path); |
| 658 | 658 | } |
| 659 | 659 | |
| 660 | 660 | /** |
| 661 | - * Converts a PHP regex to a javascript RegExp object statement. |
|
| 662 | - * |
|
| 663 | - * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
| 664 | - * More details are available on its usage there. |
|
| 665 | - * |
|
| 666 | - * @param string $regex A PHP preg regex |
|
| 667 | - * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
| 668 | - * @return string Depending on the specified return type. |
|
| 669 | - * |
|
| 670 | - * @see JSHelper::buildRegexStatement() |
|
| 671 | - */ |
|
| 661 | + * Converts a PHP regex to a javascript RegExp object statement. |
|
| 662 | + * |
|
| 663 | + * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
| 664 | + * More details are available on its usage there. |
|
| 665 | + * |
|
| 666 | + * @param string $regex A PHP preg regex |
|
| 667 | + * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
| 668 | + * @return string Depending on the specified return type. |
|
| 669 | + * |
|
| 670 | + * @see JSHelper::buildRegexStatement() |
|
| 671 | + */ |
|
| 672 | 672 | public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) : string |
| 673 | 673 | { |
| 674 | 674 | return JSHelper::buildRegexStatement($regex, $statementType); |
| 675 | 675 | } |
| 676 | 676 | |
| 677 | - /** |
|
| 678 | - * Converts the specified variable to JSON. Works just |
|
| 679 | - * like the native `json_encode` method, except that it |
|
| 680 | - * will trigger an exception on failure, which has the |
|
| 681 | - * json error details included in its developer details. |
|
| 682 | - * |
|
| 683 | - * @param mixed $variable |
|
| 684 | - * @param int $options JSON encode options. |
|
| 685 | - * @param int $depth |
|
| 686 | - * @return string |
|
| 687 | - * |
|
| 688 | - * @throws ConvertHelper_Exception |
|
| 689 | - * @see ConvertHelper::ERROR_JSON_ENCODE_FAILED |
|
| 690 | - */ |
|
| 677 | + /** |
|
| 678 | + * Converts the specified variable to JSON. Works just |
|
| 679 | + * like the native `json_encode` method, except that it |
|
| 680 | + * will trigger an exception on failure, which has the |
|
| 681 | + * json error details included in its developer details. |
|
| 682 | + * |
|
| 683 | + * @param mixed $variable |
|
| 684 | + * @param int $options JSON encode options. |
|
| 685 | + * @param int $depth |
|
| 686 | + * @return string |
|
| 687 | + * |
|
| 688 | + * @throws ConvertHelper_Exception |
|
| 689 | + * @see ConvertHelper::ERROR_JSON_ENCODE_FAILED |
|
| 690 | + */ |
|
| 691 | 691 | public static function var2json($variable, int $options=0, int $depth=512) : string |
| 692 | 692 | { |
| 693 | 693 | $result = json_encode($variable, $options, $depth); |
@@ -722,12 +722,12 @@ discard block |
||
| 722 | 722 | ->toString(); |
| 723 | 723 | } |
| 724 | 724 | |
| 725 | - /** |
|
| 726 | - * Strips all known UTF byte order marks from the specified string. |
|
| 727 | - * |
|
| 728 | - * @param string $string |
|
| 729 | - * @return string |
|
| 730 | - */ |
|
| 725 | + /** |
|
| 726 | + * Strips all known UTF byte order marks from the specified string. |
|
| 727 | + * |
|
| 728 | + * @param string $string |
|
| 729 | + * @return string |
|
| 730 | + */ |
|
| 731 | 731 | public static function stripUTFBom($string) |
| 732 | 732 | { |
| 733 | 733 | $boms = FileHelper::getUTFBOMs(); |
@@ -742,65 +742,65 @@ discard block |
||
| 742 | 742 | return $string; |
| 743 | 743 | } |
| 744 | 744 | |
| 745 | - /** |
|
| 746 | - * Converts a string to valid utf8, regardless |
|
| 747 | - * of the string's encoding(s). |
|
| 748 | - * |
|
| 749 | - * @param string $string |
|
| 750 | - * @return string |
|
| 751 | - */ |
|
| 745 | + /** |
|
| 746 | + * Converts a string to valid utf8, regardless |
|
| 747 | + * of the string's encoding(s). |
|
| 748 | + * |
|
| 749 | + * @param string $string |
|
| 750 | + * @return string |
|
| 751 | + */ |
|
| 752 | 752 | public static function string2utf8(string $string) : string |
| 753 | 753 | { |
| 754 | 754 | return ConvertHelper_String::toUtf8($string); |
| 755 | 755 | } |
| 756 | 756 | |
| 757 | - /** |
|
| 758 | - * Checks whether the specified string is an ASCII |
|
| 759 | - * string, without any special or UTF8 characters. |
|
| 760 | - * Note: empty strings and NULL are considered ASCII. |
|
| 761 | - * Any variable types other than strings are not. |
|
| 762 | - * |
|
| 763 | - * @param string|float|int|NULL $string |
|
| 764 | - * @return boolean |
|
| 765 | - */ |
|
| 757 | + /** |
|
| 758 | + * Checks whether the specified string is an ASCII |
|
| 759 | + * string, without any special or UTF8 characters. |
|
| 760 | + * Note: empty strings and NULL are considered ASCII. |
|
| 761 | + * Any variable types other than strings are not. |
|
| 762 | + * |
|
| 763 | + * @param string|float|int|NULL $string |
|
| 764 | + * @return boolean |
|
| 765 | + */ |
|
| 766 | 766 | public static function isStringASCII($string) : bool |
| 767 | 767 | { |
| 768 | 768 | return ConvertHelper_String::isASCII(strval($string)); |
| 769 | 769 | } |
| 770 | 770 | |
| 771 | - /** |
|
| 772 | - * Adds HTML syntax highlighting to an URL. |
|
| 773 | - * |
|
| 774 | - * NOTE: Includes the necessary CSS styles. When |
|
| 775 | - * highlighting several URLs in the same page, |
|
| 776 | - * prefer using the `parseURL` function instead. |
|
| 777 | - * |
|
| 778 | - * @param string $url |
|
| 779 | - * @return string |
|
| 780 | - * @deprecated Use the Highlighter class directly instead. |
|
| 781 | - * @see Highlighter |
|
| 782 | - */ |
|
| 771 | + /** |
|
| 772 | + * Adds HTML syntax highlighting to an URL. |
|
| 773 | + * |
|
| 774 | + * NOTE: Includes the necessary CSS styles. When |
|
| 775 | + * highlighting several URLs in the same page, |
|
| 776 | + * prefer using the `parseURL` function instead. |
|
| 777 | + * |
|
| 778 | + * @param string $url |
|
| 779 | + * @return string |
|
| 780 | + * @deprecated Use the Highlighter class directly instead. |
|
| 781 | + * @see Highlighter |
|
| 782 | + */ |
|
| 783 | 783 | public static function highlight_url(string $url) : string |
| 784 | 784 | { |
| 785 | 785 | return Highlighter::url($url); |
| 786 | 786 | } |
| 787 | 787 | |
| 788 | - /** |
|
| 789 | - * Calculates a percentage match of the source string with the target string. |
|
| 790 | - * |
|
| 791 | - * Options are: |
|
| 792 | - * |
|
| 793 | - * - maxLevenshtein, default: 10 |
|
| 794 | - * Any levenshtein results above this value are ignored. |
|
| 795 | - * |
|
| 796 | - * - precision, default: 1 |
|
| 797 | - * The precision of the percentage float value |
|
| 798 | - * |
|
| 799 | - * @param string $source |
|
| 800 | - * @param string $target |
|
| 801 | - * @param array<string,mixed> $options |
|
| 802 | - * @return float |
|
| 803 | - */ |
|
| 788 | + /** |
|
| 789 | + * Calculates a percentage match of the source string with the target string. |
|
| 790 | + * |
|
| 791 | + * Options are: |
|
| 792 | + * |
|
| 793 | + * - maxLevenshtein, default: 10 |
|
| 794 | + * Any levenshtein results above this value are ignored. |
|
| 795 | + * |
|
| 796 | + * - precision, default: 1 |
|
| 797 | + * The precision of the percentage float value |
|
| 798 | + * |
|
| 799 | + * @param string $source |
|
| 800 | + * @param string $target |
|
| 801 | + * @param array<string,mixed> $options |
|
| 802 | + * @return float |
|
| 803 | + */ |
|
| 804 | 804 | public static function matchString(string $source, string $target, array $options=array()) : float |
| 805 | 805 | { |
| 806 | 806 | $defaults = array( |
@@ -824,14 +824,14 @@ discard block |
||
| 824 | 824 | return round(100 - $percent, $options['precision']); |
| 825 | 825 | } |
| 826 | 826 | |
| 827 | - /** |
|
| 828 | - * Converts a date interval to a human readable string with |
|
| 829 | - * all necessary time components, e.g. "1 year, 2 months and 4 days". |
|
| 830 | - * |
|
| 831 | - * @param DateInterval $interval |
|
| 832 | - * @return string |
|
| 833 | - * @see ConvertHelper_IntervalConverter |
|
| 834 | - */ |
|
| 827 | + /** |
|
| 828 | + * Converts a date interval to a human readable string with |
|
| 829 | + * all necessary time components, e.g. "1 year, 2 months and 4 days". |
|
| 830 | + * |
|
| 831 | + * @param DateInterval $interval |
|
| 832 | + * @return string |
|
| 833 | + * @see ConvertHelper_IntervalConverter |
|
| 834 | + */ |
|
| 835 | 835 | public static function interval2string(DateInterval $interval) : string |
| 836 | 836 | { |
| 837 | 837 | $converter = new ConvertHelper_IntervalConverter(); |
@@ -843,92 +843,92 @@ discard block |
||
| 843 | 843 | const INTERVAL_MINUTES = 'minutes'; |
| 844 | 844 | const INTERVAL_SECONDS = 'seconds'; |
| 845 | 845 | |
| 846 | - /** |
|
| 847 | - * Converts an interval to its total amount of days. |
|
| 848 | - * @param DateInterval $interval |
|
| 849 | - * @return int |
|
| 850 | - */ |
|
| 846 | + /** |
|
| 847 | + * Converts an interval to its total amount of days. |
|
| 848 | + * @param DateInterval $interval |
|
| 849 | + * @return int |
|
| 850 | + */ |
|
| 851 | 851 | public static function interval2days(DateInterval $interval) : int |
| 852 | 852 | { |
| 853 | 853 | return ConvertHelper_DateInterval::toDays($interval); |
| 854 | 854 | } |
| 855 | 855 | |
| 856 | - /** |
|
| 857 | - * Converts an interval to its total amount of hours. |
|
| 858 | - * @param DateInterval $interval |
|
| 859 | - * @return int |
|
| 860 | - */ |
|
| 856 | + /** |
|
| 857 | + * Converts an interval to its total amount of hours. |
|
| 858 | + * @param DateInterval $interval |
|
| 859 | + * @return int |
|
| 860 | + */ |
|
| 861 | 861 | public static function interval2hours(DateInterval $interval) : int |
| 862 | 862 | { |
| 863 | 863 | return ConvertHelper_DateInterval::toHours($interval); |
| 864 | 864 | } |
| 865 | 865 | |
| 866 | - /** |
|
| 867 | - * Converts an interval to its total amount of minutes. |
|
| 868 | - * @param DateInterval $interval |
|
| 869 | - * @return int |
|
| 870 | - */ |
|
| 866 | + /** |
|
| 867 | + * Converts an interval to its total amount of minutes. |
|
| 868 | + * @param DateInterval $interval |
|
| 869 | + * @return int |
|
| 870 | + */ |
|
| 871 | 871 | public static function interval2minutes(DateInterval $interval) : int |
| 872 | 872 | { |
| 873 | 873 | return ConvertHelper_DateInterval::toMinutes($interval); |
| 874 | 874 | } |
| 875 | 875 | |
| 876 | - /** |
|
| 877 | - * Converts an interval to its total amount of seconds. |
|
| 878 | - * @param DateInterval $interval |
|
| 879 | - * @return int |
|
| 880 | - */ |
|
| 876 | + /** |
|
| 877 | + * Converts an interval to its total amount of seconds. |
|
| 878 | + * @param DateInterval $interval |
|
| 879 | + * @return int |
|
| 880 | + */ |
|
| 881 | 881 | public static function interval2seconds(DateInterval $interval) : int |
| 882 | 882 | { |
| 883 | 883 | return ConvertHelper_DateInterval::toSeconds($interval); |
| 884 | 884 | } |
| 885 | 885 | |
| 886 | - /** |
|
| 887 | - * Calculates the total amount of days / hours / minutes or seconds |
|
| 888 | - * of a date interval object (depending on the specified units), and |
|
| 889 | - * returns the total amount. |
|
| 890 | - * |
|
| 891 | - * @param DateInterval $interval |
|
| 892 | - * @param string $unit What total value to calculate. |
|
| 893 | - * @return integer |
|
| 894 | - * |
|
| 895 | - * @see ConvertHelper::INTERVAL_SECONDS |
|
| 896 | - * @see ConvertHelper::INTERVAL_MINUTES |
|
| 897 | - * @see ConvertHelper::INTERVAL_HOURS |
|
| 898 | - * @see ConvertHelper::INTERVAL_DAYS |
|
| 899 | - */ |
|
| 886 | + /** |
|
| 887 | + * Calculates the total amount of days / hours / minutes or seconds |
|
| 888 | + * of a date interval object (depending on the specified units), and |
|
| 889 | + * returns the total amount. |
|
| 890 | + * |
|
| 891 | + * @param DateInterval $interval |
|
| 892 | + * @param string $unit What total value to calculate. |
|
| 893 | + * @return integer |
|
| 894 | + * |
|
| 895 | + * @see ConvertHelper::INTERVAL_SECONDS |
|
| 896 | + * @see ConvertHelper::INTERVAL_MINUTES |
|
| 897 | + * @see ConvertHelper::INTERVAL_HOURS |
|
| 898 | + * @see ConvertHelper::INTERVAL_DAYS |
|
| 899 | + */ |
|
| 900 | 900 | public static function interval2total(DateInterval $interval, string $unit=self::INTERVAL_SECONDS) : int |
| 901 | 901 | { |
| 902 | 902 | return ConvertHelper_DateInterval::toTotal($interval, $unit); |
| 903 | 903 | } |
| 904 | 904 | |
| 905 | - /** |
|
| 906 | - * Converts a date to the corresponding day name. |
|
| 907 | - * |
|
| 908 | - * @param DateTime $date |
|
| 909 | - * @param bool $short |
|
| 910 | - * @return string|NULL |
|
| 911 | - */ |
|
| 905 | + /** |
|
| 906 | + * Converts a date to the corresponding day name. |
|
| 907 | + * |
|
| 908 | + * @param DateTime $date |
|
| 909 | + * @param bool $short |
|
| 910 | + * @return string|NULL |
|
| 911 | + */ |
|
| 912 | 912 | public static function date2dayName(DateTime $date, bool $short=false) : ?string |
| 913 | 913 | { |
| 914 | 914 | return ConvertHelper_Date::toDayName($date, $short); |
| 915 | 915 | } |
| 916 | 916 | |
| 917 | - /** |
|
| 918 | - * Retrieves a list of english day names. |
|
| 919 | - * @return string[] |
|
| 920 | - */ |
|
| 917 | + /** |
|
| 918 | + * Retrieves a list of english day names. |
|
| 919 | + * @return string[] |
|
| 920 | + */ |
|
| 921 | 921 | public static function getDayNamesInvariant() : array |
| 922 | 922 | { |
| 923 | 923 | return ConvertHelper_Date::getDayNamesInvariant(); |
| 924 | 924 | } |
| 925 | 925 | |
| 926 | - /** |
|
| 927 | - * Retrieves the day names list for the current locale. |
|
| 928 | - * |
|
| 929 | - * @param bool $short |
|
| 930 | - * @return string[] |
|
| 931 | - */ |
|
| 926 | + /** |
|
| 927 | + * Retrieves the day names list for the current locale. |
|
| 928 | + * |
|
| 929 | + * @param bool $short |
|
| 930 | + * @return string[] |
|
| 931 | + */ |
|
| 932 | 932 | public static function getDayNames(bool $short=false) : array |
| 933 | 933 | { |
| 934 | 934 | return ConvertHelper_Date::getDayNames($short); |
@@ -947,68 +947,68 @@ discard block |
||
| 947 | 947 | return ConvertHelper_Array::implodeWithAnd($list, $sep, $conjunction); |
| 948 | 948 | } |
| 949 | 949 | |
| 950 | - /** |
|
| 951 | - * Splits a string into an array of all characters it is composed of. |
|
| 952 | - * Unicode character safe. |
|
| 953 | - * |
|
| 954 | - * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
| 955 | - * characters. |
|
| 956 | - * |
|
| 957 | - * @param string $string |
|
| 958 | - * @return string[] |
|
| 959 | - */ |
|
| 950 | + /** |
|
| 951 | + * Splits a string into an array of all characters it is composed of. |
|
| 952 | + * Unicode character safe. |
|
| 953 | + * |
|
| 954 | + * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
| 955 | + * characters. |
|
| 956 | + * |
|
| 957 | + * @param string $string |
|
| 958 | + * @return string[] |
|
| 959 | + */ |
|
| 960 | 960 | public static function string2array(string $string) : array |
| 961 | 961 | { |
| 962 | 962 | return ConvertHelper_String::toArray($string); |
| 963 | 963 | } |
| 964 | 964 | |
| 965 | - /** |
|
| 966 | - * Checks whether the specified string contains HTML code. |
|
| 967 | - * |
|
| 968 | - * @param string $string |
|
| 969 | - * @return boolean |
|
| 970 | - */ |
|
| 965 | + /** |
|
| 966 | + * Checks whether the specified string contains HTML code. |
|
| 967 | + * |
|
| 968 | + * @param string $string |
|
| 969 | + * @return boolean |
|
| 970 | + */ |
|
| 971 | 971 | public static function isStringHTML(string $string) : bool |
| 972 | 972 | { |
| 973 | 973 | return ConvertHelper_String::isHTML($string); |
| 974 | 974 | } |
| 975 | 975 | |
| 976 | - /** |
|
| 977 | - * UTF8-safe wordwrap method: works like the regular wordwrap |
|
| 978 | - * PHP function but compatible with UTF8. Otherwise the lengths |
|
| 979 | - * are not calculated correctly. |
|
| 980 | - * |
|
| 981 | - * @param string $str |
|
| 982 | - * @param int $width |
|
| 983 | - * @param string $break |
|
| 984 | - * @param bool $cut |
|
| 985 | - * @return string |
|
| 986 | - */ |
|
| 976 | + /** |
|
| 977 | + * UTF8-safe wordwrap method: works like the regular wordwrap |
|
| 978 | + * PHP function but compatible with UTF8. Otherwise the lengths |
|
| 979 | + * are not calculated correctly. |
|
| 980 | + * |
|
| 981 | + * @param string $str |
|
| 982 | + * @param int $width |
|
| 983 | + * @param string $break |
|
| 984 | + * @param bool $cut |
|
| 985 | + * @return string |
|
| 986 | + */ |
|
| 987 | 987 | public static function wordwrap(string $str, int $width = 75, string $break = "\n", bool $cut = false) : string |
| 988 | 988 | { |
| 989 | 989 | return ConvertHelper_String::wordwrap($str, $width, $break, $cut); |
| 990 | 990 | } |
| 991 | 991 | |
| 992 | - /** |
|
| 993 | - * Calculates the byte length of a string, taking into |
|
| 994 | - * account any unicode characters. |
|
| 995 | - * |
|
| 996 | - * @param string $string |
|
| 997 | - * @return int |
|
| 998 | - */ |
|
| 992 | + /** |
|
| 993 | + * Calculates the byte length of a string, taking into |
|
| 994 | + * account any unicode characters. |
|
| 995 | + * |
|
| 996 | + * @param string $string |
|
| 997 | + * @return int |
|
| 998 | + */ |
|
| 999 | 999 | public static function string2bytes(string $string): int |
| 1000 | 1000 | { |
| 1001 | 1001 | return ConvertHelper_String::toBytes($string); |
| 1002 | 1002 | } |
| 1003 | 1003 | |
| 1004 | - /** |
|
| 1005 | - * Creates a short, 8-character long hash for the specified string. |
|
| 1006 | - * |
|
| 1007 | - * WARNING: Not cryptographically safe. |
|
| 1008 | - * |
|
| 1009 | - * @param string $string |
|
| 1010 | - * @return string |
|
| 1011 | - */ |
|
| 1004 | + /** |
|
| 1005 | + * Creates a short, 8-character long hash for the specified string. |
|
| 1006 | + * |
|
| 1007 | + * WARNING: Not cryptographically safe. |
|
| 1008 | + * |
|
| 1009 | + * @param string $string |
|
| 1010 | + * @return string |
|
| 1011 | + */ |
|
| 1012 | 1012 | public static function string2shortHash(string $string) : string |
| 1013 | 1013 | { |
| 1014 | 1014 | return ConvertHelper_String::toShortHash($string); |
@@ -1054,88 +1054,88 @@ discard block |
||
| 1054 | 1054 | return ConvertHelper_ThrowableInfo::fromThrowable($e); |
| 1055 | 1055 | } |
| 1056 | 1056 | |
| 1057 | - /** |
|
| 1058 | - * Parses the specified query string like the native |
|
| 1059 | - * function <code>parse_str</code>, without the key |
|
| 1060 | - * naming limitations. |
|
| 1061 | - * |
|
| 1062 | - * Using parse_str, dots or spaces in key names are |
|
| 1063 | - * replaced by underscores. This method keeps all names |
|
| 1064 | - * intact. |
|
| 1065 | - * |
|
| 1066 | - * It still uses the parse_str implementation as it |
|
| 1067 | - * is tested and tried, but fixes the parameter names |
|
| 1068 | - * after parsing, as needed. |
|
| 1069 | - * |
|
| 1070 | - * @param string $queryString |
|
| 1071 | - * @return array<string,string> |
|
| 1072 | - * @see ConvertHelper_QueryParser |
|
| 1073 | - */ |
|
| 1057 | + /** |
|
| 1058 | + * Parses the specified query string like the native |
|
| 1059 | + * function <code>parse_str</code>, without the key |
|
| 1060 | + * naming limitations. |
|
| 1061 | + * |
|
| 1062 | + * Using parse_str, dots or spaces in key names are |
|
| 1063 | + * replaced by underscores. This method keeps all names |
|
| 1064 | + * intact. |
|
| 1065 | + * |
|
| 1066 | + * It still uses the parse_str implementation as it |
|
| 1067 | + * is tested and tried, but fixes the parameter names |
|
| 1068 | + * after parsing, as needed. |
|
| 1069 | + * |
|
| 1070 | + * @param string $queryString |
|
| 1071 | + * @return array<string,string> |
|
| 1072 | + * @see ConvertHelper_QueryParser |
|
| 1073 | + */ |
|
| 1074 | 1074 | public static function parseQueryString(string $queryString) : array |
| 1075 | 1075 | { |
| 1076 | 1076 | $parser = new ConvertHelper_QueryParser(); |
| 1077 | 1077 | return $parser->parse($queryString); |
| 1078 | 1078 | } |
| 1079 | 1079 | |
| 1080 | - /** |
|
| 1081 | - * Searches for needle in the specified string, and returns a list |
|
| 1082 | - * of all occurrences, including the matched string. The matched |
|
| 1083 | - * string is useful when doing a case insensitive search, as it |
|
| 1084 | - * shows the exact matched case of needle. |
|
| 1085 | - * |
|
| 1086 | - * @param string $needle |
|
| 1087 | - * @param string $haystack |
|
| 1088 | - * @param bool $caseInsensitive |
|
| 1089 | - * @return ConvertHelper_StringMatch[] |
|
| 1090 | - */ |
|
| 1080 | + /** |
|
| 1081 | + * Searches for needle in the specified string, and returns a list |
|
| 1082 | + * of all occurrences, including the matched string. The matched |
|
| 1083 | + * string is useful when doing a case insensitive search, as it |
|
| 1084 | + * shows the exact matched case of needle. |
|
| 1085 | + * |
|
| 1086 | + * @param string $needle |
|
| 1087 | + * @param string $haystack |
|
| 1088 | + * @param bool $caseInsensitive |
|
| 1089 | + * @return ConvertHelper_StringMatch[] |
|
| 1090 | + */ |
|
| 1091 | 1091 | public static function findString(string $needle, string $haystack, bool $caseInsensitive=false): array |
| 1092 | 1092 | { |
| 1093 | 1093 | return ConvertHelper_String::findString($needle, $haystack, $caseInsensitive); |
| 1094 | 1094 | } |
| 1095 | 1095 | |
| 1096 | - /** |
|
| 1097 | - * Like explode, but trims all entries, and removes |
|
| 1098 | - * empty entries from the resulting array. |
|
| 1099 | - * |
|
| 1100 | - * @param string $delimiter |
|
| 1101 | - * @param string $string |
|
| 1102 | - * @return string[] |
|
| 1103 | - */ |
|
| 1096 | + /** |
|
| 1097 | + * Like explode, but trims all entries, and removes |
|
| 1098 | + * empty entries from the resulting array. |
|
| 1099 | + * |
|
| 1100 | + * @param string $delimiter |
|
| 1101 | + * @param string $string |
|
| 1102 | + * @return string[] |
|
| 1103 | + */ |
|
| 1104 | 1104 | public static function explodeTrim(string $delimiter, string $string) : array |
| 1105 | 1105 | { |
| 1106 | 1106 | return ConvertHelper_String::explodeTrim($delimiter, $string); |
| 1107 | 1107 | } |
| 1108 | 1108 | |
| 1109 | - /** |
|
| 1110 | - * Detects the most used end-of-line character in the subject string. |
|
| 1111 | - * |
|
| 1112 | - * @param string $subjectString The string to check. |
|
| 1113 | - * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
| 1114 | - */ |
|
| 1109 | + /** |
|
| 1110 | + * Detects the most used end-of-line character in the subject string. |
|
| 1111 | + * |
|
| 1112 | + * @param string $subjectString The string to check. |
|
| 1113 | + * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
| 1114 | + */ |
|
| 1115 | 1115 | public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL |
| 1116 | 1116 | { |
| 1117 | 1117 | return ConvertHelper_EOL::detect($subjectString); |
| 1118 | 1118 | } |
| 1119 | 1119 | |
| 1120 | - /** |
|
| 1121 | - * Removes the specified keys from the target array, |
|
| 1122 | - * if they exist. |
|
| 1123 | - * |
|
| 1124 | - * @param array<string|int,mixed> $array |
|
| 1125 | - * @param string[] $keys |
|
| 1126 | - */ |
|
| 1120 | + /** |
|
| 1121 | + * Removes the specified keys from the target array, |
|
| 1122 | + * if they exist. |
|
| 1123 | + * |
|
| 1124 | + * @param array<string|int,mixed> $array |
|
| 1125 | + * @param string[] $keys |
|
| 1126 | + */ |
|
| 1127 | 1127 | public static function arrayRemoveKeys(array &$array, array $keys) : void |
| 1128 | 1128 | { |
| 1129 | 1129 | ConvertHelper_Array::removeKeys($array, $keys); |
| 1130 | 1130 | } |
| 1131 | 1131 | |
| 1132 | - /** |
|
| 1133 | - * Checks if the specified variable is an integer or a string containing an integer. |
|
| 1134 | - * Accepts both positive and negative integers. |
|
| 1135 | - * |
|
| 1136 | - * @param mixed $value |
|
| 1137 | - * @return bool |
|
| 1138 | - */ |
|
| 1132 | + /** |
|
| 1133 | + * Checks if the specified variable is an integer or a string containing an integer. |
|
| 1134 | + * Accepts both positive and negative integers. |
|
| 1135 | + * |
|
| 1136 | + * @param mixed $value |
|
| 1137 | + * @return bool |
|
| 1138 | + */ |
|
| 1139 | 1139 | public static function isInteger($value) : bool |
| 1140 | 1140 | { |
| 1141 | 1141 | if(is_int($value)) { |
@@ -1155,52 +1155,52 @@ discard block |
||
| 1155 | 1155 | return false; |
| 1156 | 1156 | } |
| 1157 | 1157 | |
| 1158 | - /** |
|
| 1159 | - * Converts an amount of seconds to a DateInterval object. |
|
| 1160 | - * |
|
| 1161 | - * @param int $seconds |
|
| 1162 | - * @return DateInterval |
|
| 1163 | - * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
| 1164 | - * |
|
| 1165 | - * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
| 1166 | - */ |
|
| 1158 | + /** |
|
| 1159 | + * Converts an amount of seconds to a DateInterval object. |
|
| 1160 | + * |
|
| 1161 | + * @param int $seconds |
|
| 1162 | + * @return DateInterval |
|
| 1163 | + * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
| 1164 | + * |
|
| 1165 | + * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
| 1166 | + */ |
|
| 1167 | 1167 | public static function seconds2interval(int $seconds) : DateInterval |
| 1168 | 1168 | { |
| 1169 | 1169 | return ConvertHelper_DateInterval::fromSeconds($seconds)->getInterval(); |
| 1170 | 1170 | } |
| 1171 | 1171 | |
| 1172 | - /** |
|
| 1173 | - * Converts a size string like "50 MB" to the corresponding byte size. |
|
| 1174 | - * It is case-insensitive, ignores spaces, and supports both traditional |
|
| 1175 | - * "MB" and "MiB" notations. |
|
| 1176 | - * |
|
| 1177 | - * @param string $size |
|
| 1178 | - * @return int |
|
| 1179 | - */ |
|
| 1172 | + /** |
|
| 1173 | + * Converts a size string like "50 MB" to the corresponding byte size. |
|
| 1174 | + * It is case-insensitive, ignores spaces, and supports both traditional |
|
| 1175 | + * "MB" and "MiB" notations. |
|
| 1176 | + * |
|
| 1177 | + * @param string $size |
|
| 1178 | + * @return int |
|
| 1179 | + */ |
|
| 1180 | 1180 | public static function size2bytes(string $size) : int |
| 1181 | 1181 | { |
| 1182 | 1182 | return self::parseSize($size)->toBytes(); |
| 1183 | 1183 | } |
| 1184 | 1184 | |
| 1185 | - /** |
|
| 1186 | - * Parses a size string like "50 MB" and returns a size notation instance |
|
| 1187 | - * that has utility methods to access information on it, and convert it. |
|
| 1188 | - * |
|
| 1189 | - * @param string $size |
|
| 1190 | - * @return ConvertHelper_SizeNotation |
|
| 1191 | - */ |
|
| 1185 | + /** |
|
| 1186 | + * Parses a size string like "50 MB" and returns a size notation instance |
|
| 1187 | + * that has utility methods to access information on it, and convert it. |
|
| 1188 | + * |
|
| 1189 | + * @param string $size |
|
| 1190 | + * @return ConvertHelper_SizeNotation |
|
| 1191 | + */ |
|
| 1192 | 1192 | public static function parseSize(string $size) : ConvertHelper_SizeNotation |
| 1193 | 1193 | { |
| 1194 | 1194 | return new ConvertHelper_SizeNotation($size); |
| 1195 | 1195 | } |
| 1196 | 1196 | |
| 1197 | - /** |
|
| 1198 | - * Creates a URL finder instance, which can be used to find |
|
| 1199 | - * URLs in a string - be it plain text, or HTML. |
|
| 1200 | - * |
|
| 1201 | - * @param string $subject |
|
| 1202 | - * @return ConvertHelper_URLFinder |
|
| 1203 | - */ |
|
| 1197 | + /** |
|
| 1198 | + * Creates a URL finder instance, which can be used to find |
|
| 1199 | + * URLs in a string - be it plain text, or HTML. |
|
| 1200 | + * |
|
| 1201 | + * @param string $subject |
|
| 1202 | + * @return ConvertHelper_URLFinder |
|
| 1203 | + */ |
|
| 1204 | 1204 | public static function createURLFinder(string $subject) : ConvertHelper_URLFinder |
| 1205 | 1205 | { |
| 1206 | 1206 | return new ConvertHelper_URLFinder($subject); |
@@ -50,7 +50,7 @@ discard block |
||
| 50 | 50 | * @param int $tabSize The amount of spaces per tab. |
| 51 | 51 | * @return string |
| 52 | 52 | */ |
| 53 | - public static function tabs2spaces(string $string, int $tabSize=4) : string |
|
| 53 | + public static function tabs2spaces(string $string, int $tabSize = 4) : string |
|
| 54 | 54 | { |
| 55 | 55 | return ConvertHelper_String::tabs2spaces($string, $tabSize); |
| 56 | 56 | } |
@@ -62,7 +62,7 @@ discard block |
||
| 62 | 62 | * @param int $tabSize The amount of spaces per tab in the source string. |
| 63 | 63 | * @return string |
| 64 | 64 | */ |
| 65 | - public static function spaces2tabs(string $string, int $tabSize=4) : string |
|
| 65 | + public static function spaces2tabs(string $string, int $tabSize = 4) : string |
|
| 66 | 66 | { |
| 67 | 67 | return ConvertHelper_String::spaces2tabs($string, $tabSize); |
| 68 | 68 | } |
@@ -135,7 +135,7 @@ discard block |
||
| 135 | 135 | * @deprecated Use the Highlighter class directly instead. |
| 136 | 136 | * @see Highlighter::xml() |
| 137 | 137 | */ |
| 138 | - public static function highlight_xml(string $xml, bool $formatSource=false) : string |
|
| 138 | + public static function highlight_xml(string $xml, bool $formatSource = false) : string |
|
| 139 | 139 | { |
| 140 | 140 | return Highlighter::xml($xml, $formatSource); |
| 141 | 141 | } |
@@ -201,11 +201,11 @@ discard block |
||
| 201 | 201 | * @param bool $html |
| 202 | 202 | * @return string |
| 203 | 203 | */ |
| 204 | - public static function var_dump($var, bool $html=true) : string |
|
| 204 | + public static function var_dump($var, bool $html = true) : string |
|
| 205 | 205 | { |
| 206 | 206 | $info = parseVariable($var); |
| 207 | 207 | |
| 208 | - if($html) { |
|
| 208 | + if ($html) { |
|
| 209 | 209 | return $info->toHTML(); |
| 210 | 210 | } |
| 211 | 211 | |
@@ -220,11 +220,11 @@ discard block |
||
| 220 | 220 | * @param bool $html Whether to style the dump as HTML. |
| 221 | 221 | * @return string |
| 222 | 222 | */ |
| 223 | - public static function print_r($var, bool $return=false, bool $html=true) : string |
|
| 223 | + public static function print_r($var, bool $return = false, bool $html = true) : string |
|
| 224 | 224 | { |
| 225 | 225 | $result = parseVariable($var)->enableType()->toString(); |
| 226 | 226 | |
| 227 | - if($html) |
|
| 227 | + if ($html) |
|
| 228 | 228 | { |
| 229 | 229 | $result = |
| 230 | 230 | '<pre style="background:#fff;color:#333;padding:16px;border:solid 1px #bbb;border-radius:4px">'. |
@@ -232,7 +232,7 @@ discard block |
||
| 232 | 232 | '</pre>'; |
| 233 | 233 | } |
| 234 | 234 | |
| 235 | - if(!$return) |
|
| 235 | + if (!$return) |
|
| 236 | 236 | { |
| 237 | 237 | echo $result; |
| 238 | 238 | } |
@@ -413,12 +413,12 @@ discard block |
||
| 413 | 413 | $output = ''; |
| 414 | 414 | $split = str_split($unicodeChar); |
| 415 | 415 | |
| 416 | - foreach($split as $octet) |
|
| 416 | + foreach ($split as $octet) |
|
| 417 | 417 | { |
| 418 | 418 | $ordInt = ord($octet); |
| 419 | 419 | // Convert from int (base 10) to hex (base 16), for PHP \x syntax |
| 420 | 420 | $ordHex = base_convert((string)$ordInt, 10, 16); |
| 421 | - $output .= '\x' . $ordHex; |
|
| 421 | + $output .= '\x'.$ordHex; |
|
| 422 | 422 | } |
| 423 | 423 | |
| 424 | 424 | return $output; |
@@ -471,19 +471,19 @@ discard block |
||
| 471 | 471 | */ |
| 472 | 472 | protected static function convertScalarForComparison($scalar) : ?string |
| 473 | 473 | { |
| 474 | - if($scalar === '' || is_null($scalar)) { |
|
| 474 | + if ($scalar === '' || is_null($scalar)) { |
|
| 475 | 475 | return null; |
| 476 | 476 | } |
| 477 | 477 | |
| 478 | - if(is_bool($scalar)) { |
|
| 478 | + if (is_bool($scalar)) { |
|
| 479 | 479 | return self::bool2string($scalar); |
| 480 | 480 | } |
| 481 | 481 | |
| 482 | - if(is_array($scalar)) { |
|
| 482 | + if (is_array($scalar)) { |
|
| 483 | 483 | $scalar = md5(serialize($scalar)); |
| 484 | 484 | } |
| 485 | 485 | |
| 486 | - if($scalar !== null && !is_scalar($scalar)) { |
|
| 486 | + if ($scalar !== null && !is_scalar($scalar)) { |
|
| 487 | 487 | throw new ConvertHelper_Exception( |
| 488 | 488 | 'Not a scalar value in comparison', |
| 489 | 489 | null, |
@@ -669,7 +669,7 @@ discard block |
||
| 669 | 669 | * |
| 670 | 670 | * @see JSHelper::buildRegexStatement() |
| 671 | 671 | */ |
| 672 | - public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) : string |
|
| 672 | + public static function regex2js(string $regex, string $statementType = JSHelper::JS_REGEX_OBJECT) : string |
|
| 673 | 673 | { |
| 674 | 674 | return JSHelper::buildRegexStatement($regex, $statementType); |
| 675 | 675 | } |
@@ -688,11 +688,11 @@ discard block |
||
| 688 | 688 | * @throws ConvertHelper_Exception |
| 689 | 689 | * @see ConvertHelper::ERROR_JSON_ENCODE_FAILED |
| 690 | 690 | */ |
| 691 | - public static function var2json($variable, int $options=0, int $depth=512) : string |
|
| 691 | + public static function var2json($variable, int $options = 0, int $depth = 512) : string |
|
| 692 | 692 | { |
| 693 | 693 | $result = json_encode($variable, $options, $depth); |
| 694 | 694 | |
| 695 | - if($result !== false) { |
|
| 695 | + if ($result !== false) { |
|
| 696 | 696 | return $result; |
| 697 | 697 | } |
| 698 | 698 | |
@@ -731,10 +731,10 @@ discard block |
||
| 731 | 731 | public static function stripUTFBom($string) |
| 732 | 732 | { |
| 733 | 733 | $boms = FileHelper::getUTFBOMs(); |
| 734 | - foreach($boms as $bomChars) { |
|
| 734 | + foreach ($boms as $bomChars) { |
|
| 735 | 735 | $length = mb_strlen($bomChars); |
| 736 | 736 | $text = mb_substr($string, 0, $length); |
| 737 | - if($text==$bomChars) { |
|
| 737 | + if ($text == $bomChars) { |
|
| 738 | 738 | return mb_substr($string, $length); |
| 739 | 739 | } |
| 740 | 740 | } |
@@ -801,7 +801,7 @@ discard block |
||
| 801 | 801 | * @param array<string,mixed> $options |
| 802 | 802 | * @return float |
| 803 | 803 | */ |
| 804 | - public static function matchString(string $source, string $target, array $options=array()) : float |
|
| 804 | + public static function matchString(string $source, string $target, array $options = array()) : float |
|
| 805 | 805 | { |
| 806 | 806 | $defaults = array( |
| 807 | 807 | 'maxLevenshtein' => 10, |
@@ -811,12 +811,12 @@ discard block |
||
| 811 | 811 | $options = array_merge($defaults, $options); |
| 812 | 812 | |
| 813 | 813 | // avoid doing this via levenshtein |
| 814 | - if($source == $target) { |
|
| 814 | + if ($source == $target) { |
|
| 815 | 815 | return 100; |
| 816 | 816 | } |
| 817 | 817 | |
| 818 | 818 | $diff = levenshtein($source, $target); |
| 819 | - if($diff > $options['maxLevenshtein']) { |
|
| 819 | + if ($diff > $options['maxLevenshtein']) { |
|
| 820 | 820 | return 0; |
| 821 | 821 | } |
| 822 | 822 | |
@@ -897,7 +897,7 @@ discard block |
||
| 897 | 897 | * @see ConvertHelper::INTERVAL_HOURS |
| 898 | 898 | * @see ConvertHelper::INTERVAL_DAYS |
| 899 | 899 | */ |
| 900 | - public static function interval2total(DateInterval $interval, string $unit=self::INTERVAL_SECONDS) : int |
|
| 900 | + public static function interval2total(DateInterval $interval, string $unit = self::INTERVAL_SECONDS) : int |
|
| 901 | 901 | { |
| 902 | 902 | return ConvertHelper_DateInterval::toTotal($interval, $unit); |
| 903 | 903 | } |
@@ -909,7 +909,7 @@ discard block |
||
| 909 | 909 | * @param bool $short |
| 910 | 910 | * @return string|NULL |
| 911 | 911 | */ |
| 912 | - public static function date2dayName(DateTime $date, bool $short=false) : ?string |
|
| 912 | + public static function date2dayName(DateTime $date, bool $short = false) : ?string |
|
| 913 | 913 | { |
| 914 | 914 | return ConvertHelper_Date::toDayName($date, $short); |
| 915 | 915 | } |
@@ -929,7 +929,7 @@ discard block |
||
| 929 | 929 | * @param bool $short |
| 930 | 930 | * @return string[] |
| 931 | 931 | */ |
| 932 | - public static function getDayNames(bool $short=false) : array |
|
| 932 | + public static function getDayNames(bool $short = false) : array |
|
| 933 | 933 | { |
| 934 | 934 | return ConvertHelper_Date::getDayNames($short); |
| 935 | 935 | } |
@@ -1088,7 +1088,7 @@ discard block |
||
| 1088 | 1088 | * @param bool $caseInsensitive |
| 1089 | 1089 | * @return ConvertHelper_StringMatch[] |
| 1090 | 1090 | */ |
| 1091 | - public static function findString(string $needle, string $haystack, bool $caseInsensitive=false): array |
|
| 1091 | + public static function findString(string $needle, string $haystack, bool $caseInsensitive = false): array |
|
| 1092 | 1092 | { |
| 1093 | 1093 | return ConvertHelper_String::findString($needle, $haystack, $caseInsensitive); |
| 1094 | 1094 | } |
@@ -1138,17 +1138,17 @@ discard block |
||
| 1138 | 1138 | */ |
| 1139 | 1139 | public static function isInteger($value) : bool |
| 1140 | 1140 | { |
| 1141 | - if(is_int($value)) { |
|
| 1141 | + if (is_int($value)) { |
|
| 1142 | 1142 | return true; |
| 1143 | 1143 | } |
| 1144 | 1144 | |
| 1145 | 1145 | // booleans get converted to numbers, so they would |
| 1146 | 1146 | // actually match the regex. |
| 1147 | - if(is_bool($value)) { |
|
| 1147 | + if (is_bool($value)) { |
|
| 1148 | 1148 | return false; |
| 1149 | 1149 | } |
| 1150 | 1150 | |
| 1151 | - if(is_string($value) && $value !== '') { |
|
| 1151 | + if (is_string($value) && $value !== '') { |
|
| 1152 | 1152 | return preg_match('/\A-?\d+\z/', $value) === 1; |
| 1153 | 1153 | } |
| 1154 | 1154 | |
@@ -1214,7 +1214,7 @@ discard block |
||
| 1214 | 1214 | * @param bool $keepKeys |
| 1215 | 1215 | * @return array<number|string,mixed> |
| 1216 | 1216 | */ |
| 1217 | - public static function arrayRemoveValues(array $sourceArray, array $values, bool $keepKeys=false) : array |
|
| 1217 | + public static function arrayRemoveValues(array $sourceArray, array $values, bool $keepKeys = false) : array |
|
| 1218 | 1218 | { |
| 1219 | 1219 | return ConvertHelper_Array::removeValues($sourceArray, $values, $keepKeys); |
| 1220 | 1220 | } |
@@ -41,14 +41,14 @@ discard block |
||
| 41 | 41 | const TOKEN_MONTHS = 'm'; |
| 42 | 42 | const TOKEN_YEARS = 'y'; |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * @var DateInterval |
|
| 46 | - */ |
|
| 44 | + /** |
|
| 45 | + * @var DateInterval |
|
| 46 | + */ |
|
| 47 | 47 | protected $interval; |
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * @var int |
|
| 51 | - */ |
|
| 49 | + /** |
|
| 50 | + * @var int |
|
| 51 | + */ |
|
| 52 | 52 | protected $seconds; |
| 53 | 53 | |
| 54 | 54 | /** |
@@ -92,22 +92,22 @@ discard block |
||
| 92 | 92 | return new ConvertHelper_DateInterval($seconds); |
| 93 | 93 | } |
| 94 | 94 | |
| 95 | - /** |
|
| 96 | - * Creates the interval from an existing regular interval instance. |
|
| 97 | - * |
|
| 98 | - * @param DateInterval $interval |
|
| 99 | - * @return ConvertHelper_DateInterval |
|
| 100 | - */ |
|
| 95 | + /** |
|
| 96 | + * Creates the interval from an existing regular interval instance. |
|
| 97 | + * |
|
| 98 | + * @param DateInterval $interval |
|
| 99 | + * @return ConvertHelper_DateInterval |
|
| 100 | + */ |
|
| 101 | 101 | public static function fromInterval(DateInterval $interval) |
| 102 | 102 | { |
| 103 | 103 | return self::fromSeconds(ConvertHelper::interval2seconds($interval)); |
| 104 | 104 | } |
| 105 | 105 | |
| 106 | - /** |
|
| 107 | - * Retrieves the PHP native date interval. |
|
| 108 | - * |
|
| 109 | - * @return DateInterval |
|
| 110 | - */ |
|
| 106 | + /** |
|
| 107 | + * Retrieves the PHP native date interval. |
|
| 108 | + * |
|
| 109 | + * @return DateInterval |
|
| 110 | + */ |
|
| 111 | 111 | public function getInterval() : DateInterval |
| 112 | 112 | { |
| 113 | 113 | return $this->interval; |
@@ -143,31 +143,31 @@ discard block |
||
| 143 | 143 | return $this->getToken(self::TOKEN_YEARS); |
| 144 | 144 | } |
| 145 | 145 | |
| 146 | - /** |
|
| 147 | - * Retrieves a specific time token, e.g. "h" (for hours). |
|
| 148 | - * Using the constants to specifiy the tokens is recommended. |
|
| 149 | - * |
|
| 150 | - * @param string $token |
|
| 151 | - * @return int |
|
| 152 | - * |
|
| 153 | - * @see ConvertHelper_DateInterval::TOKEN_SECONDS |
|
| 154 | - * @see ConvertHelper_DateInterval::TOKEN_MINUTES |
|
| 155 | - * @see ConvertHelper_DateInterval::TOKEN_HOURS |
|
| 156 | - * @see ConvertHelper_DateInterval::TOKEN_DAYS |
|
| 157 | - * @see ConvertHelper_DateInterval::TOKEN_MONTHS |
|
| 158 | - * @see ConvertHelper_DateInterval::TOKEN_YEARS |
|
| 159 | - */ |
|
| 146 | + /** |
|
| 147 | + * Retrieves a specific time token, e.g. "h" (for hours). |
|
| 148 | + * Using the constants to specifiy the tokens is recommended. |
|
| 149 | + * |
|
| 150 | + * @param string $token |
|
| 151 | + * @return int |
|
| 152 | + * |
|
| 153 | + * @see ConvertHelper_DateInterval::TOKEN_SECONDS |
|
| 154 | + * @see ConvertHelper_DateInterval::TOKEN_MINUTES |
|
| 155 | + * @see ConvertHelper_DateInterval::TOKEN_HOURS |
|
| 156 | + * @see ConvertHelper_DateInterval::TOKEN_DAYS |
|
| 157 | + * @see ConvertHelper_DateInterval::TOKEN_MONTHS |
|
| 158 | + * @see ConvertHelper_DateInterval::TOKEN_YEARS |
|
| 159 | + */ |
|
| 160 | 160 | public function getToken(string $token) : int |
| 161 | 161 | { |
| 162 | 162 | return (int)$this->interval->$token; |
| 163 | 163 | } |
| 164 | 164 | |
| 165 | - /** |
|
| 166 | - * The total amount of seconds in the interval (including |
|
| 167 | - * everything, from seconds to days, months, years...). |
|
| 168 | - * |
|
| 169 | - * @return int |
|
| 170 | - */ |
|
| 165 | + /** |
|
| 166 | + * The total amount of seconds in the interval (including |
|
| 167 | + * everything, from seconds to days, months, years...). |
|
| 168 | + * |
|
| 169 | + * @return int |
|
| 170 | + */ |
|
| 171 | 171 | public function getTotalSeconds() : int |
| 172 | 172 | { |
| 173 | 173 | return $this->seconds; |
@@ -68,7 +68,7 @@ discard block |
||
| 68 | 68 | |
| 69 | 69 | $interval = $d2->diff($d1); |
| 70 | 70 | |
| 71 | - if(!$interval instanceof DateInterval) |
|
| 71 | + if (!$interval instanceof DateInterval) |
|
| 72 | 72 | { |
| 73 | 73 | throw new ConvertHelper_Exception( |
| 74 | 74 | 'Cannot create interval', |
@@ -187,24 +187,24 @@ discard block |
||
| 187 | 187 | * @see ConvertHelper::INTERVAL_HOURS |
| 188 | 188 | * @see ConvertHelper::INTERVAL_DAYS |
| 189 | 189 | */ |
| 190 | - public static function toTotal(DateInterval $interval, string $unit=ConvertHelper::INTERVAL_SECONDS) : int |
|
| 190 | + public static function toTotal(DateInterval $interval, string $unit = ConvertHelper::INTERVAL_SECONDS) : int |
|
| 191 | 191 | { |
| 192 | 192 | $total = (int)$interval->format('%a'); |
| 193 | 193 | if ($unit == ConvertHelper::INTERVAL_DAYS) { |
| 194 | 194 | return $total; |
| 195 | 195 | } |
| 196 | 196 | |
| 197 | - $total = ($total * 24) + ((int)$interval->h ); |
|
| 197 | + $total = ($total * 24) + ((int)$interval->h); |
|
| 198 | 198 | if ($unit == ConvertHelper::INTERVAL_HOURS) { |
| 199 | 199 | return $total; |
| 200 | 200 | } |
| 201 | 201 | |
| 202 | - $total = ($total * 60) + ((int)$interval->i ); |
|
| 202 | + $total = ($total * 60) + ((int)$interval->i); |
|
| 203 | 203 | if ($unit == ConvertHelper::INTERVAL_MINUTES) { |
| 204 | 204 | return $total; |
| 205 | 205 | } |
| 206 | 206 | |
| 207 | - $total = ($total * 60) + ((int)$interval->s ); |
|
| 207 | + $total = ($total * 60) + ((int)$interval->s); |
|
| 208 | 208 | if ($unit == ConvertHelper::INTERVAL_SECONDS) { |
| 209 | 209 | return $total; |
| 210 | 210 | } |
@@ -34,39 +34,39 @@ discard block |
||
| 34 | 34 | const SECONDS_PER_MONTH_APPROX = 2505600; // imprecise - for 29 days, only for approximations. |
| 35 | 35 | const SECONDS_PER_YEAR = 31536000; |
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * @var int |
|
| 39 | - */ |
|
| 37 | + /** |
|
| 38 | + * @var int |
|
| 39 | + */ |
|
| 40 | 40 | protected $dateFrom; |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @var int |
|
| 44 | - */ |
|
| 42 | + /** |
|
| 43 | + * @var int |
|
| 44 | + */ |
|
| 45 | 45 | protected $dateTo; |
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * @var bool |
|
| 49 | - */ |
|
| 47 | + /** |
|
| 48 | + * @var bool |
|
| 49 | + */ |
|
| 50 | 50 | protected $future = false; |
| 51 | 51 | |
| 52 | - /** |
|
| 53 | - * @var string |
|
| 54 | - */ |
|
| 52 | + /** |
|
| 53 | + * @var string |
|
| 54 | + */ |
|
| 55 | 55 | protected $interval = ''; |
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * @var int |
|
| 59 | - */ |
|
| 57 | + /** |
|
| 58 | + * @var int |
|
| 59 | + */ |
|
| 60 | 60 | protected $difference = 0; |
| 61 | 61 | |
| 62 | - /** |
|
| 63 | - * @var int |
|
| 64 | - */ |
|
| 62 | + /** |
|
| 63 | + * @var int |
|
| 64 | + */ |
|
| 65 | 65 | protected $dateDiff = 0; |
| 66 | 66 | |
| 67 | - /** |
|
| 68 | - * @var array|NULL |
|
| 69 | - */ |
|
| 67 | + /** |
|
| 68 | + * @var array|NULL |
|
| 69 | + */ |
|
| 70 | 70 | protected static $texts = null; |
| 71 | 71 | |
| 72 | 72 | public function __construct() |
@@ -86,17 +86,17 @@ discard block |
||
| 86 | 86 | self::$texts = null; |
| 87 | 87 | } |
| 88 | 88 | |
| 89 | - /** |
|
| 90 | - * Sets the origin date to calculate from. |
|
| 91 | - * |
|
| 92 | - * NOTE: if this is further in the future than |
|
| 93 | - * the to: date, it will be considered as a |
|
| 94 | - * calculation for something to come, i.e. |
|
| 95 | - * "In two days". |
|
| 96 | - * |
|
| 97 | - * @param \DateTime $date |
|
| 98 | - * @return ConvertHelper_DurationConverter |
|
| 99 | - */ |
|
| 89 | + /** |
|
| 90 | + * Sets the origin date to calculate from. |
|
| 91 | + * |
|
| 92 | + * NOTE: if this is further in the future than |
|
| 93 | + * the to: date, it will be considered as a |
|
| 94 | + * calculation for something to come, i.e. |
|
| 95 | + * "In two days". |
|
| 96 | + * |
|
| 97 | + * @param \DateTime $date |
|
| 98 | + * @return ConvertHelper_DurationConverter |
|
| 99 | + */ |
|
| 100 | 100 | public function setDateFrom(\DateTime $date) : ConvertHelper_DurationConverter |
| 101 | 101 | { |
| 102 | 102 | $this->dateFrom = ConvertHelper::date2timestamp($date); |
@@ -104,13 +104,13 @@ discard block |
||
| 104 | 104 | return $this; |
| 105 | 105 | } |
| 106 | 106 | |
| 107 | - /** |
|
| 108 | - * Sets the date to calculate to. Defaults to |
|
| 109 | - * the current time if not set. |
|
| 110 | - * |
|
| 111 | - * @param \DateTime $date |
|
| 112 | - * @return ConvertHelper_DurationConverter |
|
| 113 | - */ |
|
| 107 | + /** |
|
| 108 | + * Sets the date to calculate to. Defaults to |
|
| 109 | + * the current time if not set. |
|
| 110 | + * |
|
| 111 | + * @param \DateTime $date |
|
| 112 | + * @return ConvertHelper_DurationConverter |
|
| 113 | + */ |
|
| 114 | 114 | public function setDateTo(\DateTime $date) : ConvertHelper_DurationConverter |
| 115 | 115 | { |
| 116 | 116 | $this->dateTo = ConvertHelper::date2timestamp($date); |
@@ -118,14 +118,14 @@ discard block |
||
| 118 | 118 | return $this; |
| 119 | 119 | } |
| 120 | 120 | |
| 121 | - /** |
|
| 122 | - * Converts the specified dates to a human-readable string. |
|
| 123 | - * |
|
| 124 | - * @throws ConvertHelper_Exception |
|
| 125 | - * @return string |
|
| 126 | - * |
|
| 127 | - * @see ConvertHelper_DurationConverter::ERROR_NO_DATE_FROM_SET |
|
| 128 | - */ |
|
| 121 | + /** |
|
| 122 | + * Converts the specified dates to a human-readable string. |
|
| 123 | + * |
|
| 124 | + * @throws ConvertHelper_Exception |
|
| 125 | + * @return string |
|
| 126 | + * |
|
| 127 | + * @see ConvertHelper_DurationConverter::ERROR_NO_DATE_FROM_SET |
|
| 128 | + */ |
|
| 129 | 129 | public function convert() : string |
| 130 | 130 | { |
| 131 | 131 | $this->initTexts(); |
@@ -71,7 +71,7 @@ discard block |
||
| 71 | 71 | |
| 72 | 72 | public function __construct() |
| 73 | 73 | { |
| 74 | - if(class_exists('\AppLocalize\Localization')) { |
|
| 74 | + if (class_exists('\AppLocalize\Localization')) { |
|
| 75 | 75 | \AppLocalize\Localization::onLocaleChanged(array($this, 'handle_localeChanged')); |
| 76 | 76 | } |
| 77 | 77 | } |
@@ -133,11 +133,11 @@ discard block |
||
| 133 | 133 | |
| 134 | 134 | $epoch = 'past'; |
| 135 | 135 | $key = 'singular'; |
| 136 | - if($this->dateDiff > 1) { |
|
| 136 | + if ($this->dateDiff > 1) { |
|
| 137 | 137 | $key = 'plural'; |
| 138 | 138 | } |
| 139 | 139 | |
| 140 | - if($this->future) { |
|
| 140 | + if ($this->future) { |
|
| 141 | 141 | $epoch = 'future'; |
| 142 | 142 | } |
| 143 | 143 | |
@@ -150,7 +150,7 @@ discard block |
||
| 150 | 150 | |
| 151 | 151 | protected function initTexts() |
| 152 | 152 | { |
| 153 | - if(isset(self::$texts)) { |
|
| 153 | + if (isset(self::$texts)) { |
|
| 154 | 154 | return; |
| 155 | 155 | } |
| 156 | 156 | |
@@ -236,7 +236,7 @@ discard block |
||
| 236 | 236 | $day = (int)date("j", $this->dateTo); |
| 237 | 237 | $year = (int)date("Y", $this->dateFrom); |
| 238 | 238 | |
| 239 | - while(mktime($hour, $min, $sec, $month + ($months_difference), $day, $year) < $this->dateTo) |
|
| 239 | + while (mktime($hour, $min, $sec, $month + ($months_difference), $day, $year) < $this->dateTo) |
|
| 240 | 240 | { |
| 241 | 241 | $months_difference++; |
| 242 | 242 | } |
@@ -256,7 +256,7 @@ discard block |
||
| 256 | 256 | |
| 257 | 257 | protected function resolveCalculations() : void |
| 258 | 258 | { |
| 259 | - if(!isset($this->dateFrom)) |
|
| 259 | + if (!isset($this->dateFrom)) |
|
| 260 | 260 | { |
| 261 | 261 | throw new ConvertHelper_Exception( |
| 262 | 262 | 'No date from has been specified.', |
@@ -266,7 +266,7 @@ discard block |
||
| 266 | 266 | } |
| 267 | 267 | |
| 268 | 268 | // no date to set? Assume we want to use today. |
| 269 | - if(!isset($this->dateTo)) |
|
| 269 | + if (!isset($this->dateTo)) |
|
| 270 | 270 | { |
| 271 | 271 | $this->dateTo = time(); |
| 272 | 272 | } |
@@ -333,7 +333,7 @@ discard block |
||
| 333 | 333 | |
| 334 | 334 | $difference = $this->dateTo - $this->dateFrom; |
| 335 | 335 | |
| 336 | - if($difference < 0) |
|
| 336 | + if ($difference < 0) |
|
| 337 | 337 | { |
| 338 | 338 | $difference = $difference * -1; |
| 339 | 339 | $this->future = true; |
@@ -395,7 +395,7 @@ discard block |
||
| 395 | 395 | { |
| 396 | 396 | $converter = new ConvertHelper_DurationConverter(); |
| 397 | 397 | |
| 398 | - if($datefrom instanceof DateTime) |
|
| 398 | + if ($datefrom instanceof DateTime) |
|
| 399 | 399 | { |
| 400 | 400 | $converter->setDateFrom($datefrom); |
| 401 | 401 | } |
@@ -404,11 +404,11 @@ discard block |
||
| 404 | 404 | $converter->setDateFrom(ConvertHelper_Date::fromTimestamp($datefrom)); |
| 405 | 405 | } |
| 406 | 406 | |
| 407 | - if($dateto instanceof DateTime) |
|
| 407 | + if ($dateto instanceof DateTime) |
|
| 408 | 408 | { |
| 409 | 409 | $converter->setDateTo($dateto); |
| 410 | 410 | } |
| 411 | - else if($dateto > 0) |
|
| 411 | + else if ($dateto > 0) |
|
| 412 | 412 | { |
| 413 | 413 | $converter->setDateTo(ConvertHelper_Date::fromTimestamp($dateto)); |
| 414 | 414 | } |
@@ -398,8 +398,7 @@ discard block |
||
| 398 | 398 | if($datefrom instanceof DateTime) |
| 399 | 399 | { |
| 400 | 400 | $converter->setDateFrom($datefrom); |
| 401 | - } |
|
| 402 | - else |
|
| 401 | + } else |
|
| 403 | 402 | { |
| 404 | 403 | $converter->setDateFrom(ConvertHelper_Date::fromTimestamp($datefrom)); |
| 405 | 404 | } |
@@ -407,8 +406,7 @@ discard block |
||
| 407 | 406 | if($dateto instanceof DateTime) |
| 408 | 407 | { |
| 409 | 408 | $converter->setDateTo($dateto); |
| 410 | - } |
|
| 411 | - else if($dateto > 0) |
|
| 409 | + } else if($dateto > 0) |
|
| 412 | 410 | { |
| 413 | 411 | $converter->setDateTo(ConvertHelper_Date::fromTimestamp($dateto)); |
| 414 | 412 | } |
@@ -43,13 +43,13 @@ discard block |
||
| 43 | 43 | * @param bool $short |
| 44 | 44 | * @return string|NULL |
| 45 | 45 | */ |
| 46 | - public static function toDayName(DateTime $date, bool $short=false) : ?string |
|
| 46 | + public static function toDayName(DateTime $date, bool $short = false) : ?string |
|
| 47 | 47 | { |
| 48 | 48 | $day = $date->format('l'); |
| 49 | 49 | $invariant = self::getDayNamesInvariant(); |
| 50 | 50 | |
| 51 | 51 | $idx = array_search($day, $invariant); |
| 52 | - if($idx !== false) { |
|
| 52 | + if ($idx !== false) { |
|
| 53 | 53 | $localized = self::getDayNames($short); |
| 54 | 54 | return $localized[$idx]; |
| 55 | 55 | } |
@@ -72,11 +72,11 @@ discard block |
||
| 72 | 72 | * @param bool $short |
| 73 | 73 | * @return string[] |
| 74 | 74 | */ |
| 75 | - public static function getDayNames(bool $short=false) : array |
|
| 75 | + public static function getDayNames(bool $short = false) : array |
|
| 76 | 76 | { |
| 77 | 77 | self::initDays(); |
| 78 | 78 | |
| 79 | - if($short) { |
|
| 79 | + if ($short) { |
|
| 80 | 80 | return self::$daysShort; |
| 81 | 81 | } |
| 82 | 82 | |
@@ -102,13 +102,13 @@ discard block |
||
| 102 | 102 | public static function toListLabel(DateTime $date, bool $includeTime = false, bool $shortMonth = false) : string |
| 103 | 103 | { |
| 104 | 104 | $today = new DateTime(); |
| 105 | - if($date->format('d.m.Y') === $today->format('d.m.Y')) |
|
| 105 | + if ($date->format('d.m.Y') === $today->format('d.m.Y')) |
|
| 106 | 106 | { |
| 107 | 107 | $label = t('Today'); |
| 108 | 108 | } |
| 109 | 109 | else |
| 110 | 110 | { |
| 111 | - $label = $date->format('d') . '. ' . self::month2string((int)$date->format('m'), $shortMonth) . ' '; |
|
| 111 | + $label = $date->format('d').'. '.self::month2string((int)$date->format('m'), $shortMonth).' '; |
|
| 112 | 112 | |
| 113 | 113 | if ($date->format('Y') != date('Y')) |
| 114 | 114 | { |
@@ -213,7 +213,7 @@ discard block |
||
| 213 | 213 | |
| 214 | 214 | private static function initDays() : void |
| 215 | 215 | { |
| 216 | - if(!empty(self::$daysShort)) |
|
| 216 | + if (!empty(self::$daysShort)) |
|
| 217 | 217 | { |
| 218 | 218 | return; |
| 219 | 219 | } |
@@ -105,8 +105,7 @@ |
||
| 105 | 105 | if($date->format('d.m.Y') === $today->format('d.m.Y')) |
| 106 | 106 | { |
| 107 | 107 | $label = t('Today'); |
| 108 | - } |
|
| 109 | - else |
|
| 108 | + } else |
|
| 110 | 109 | { |
| 111 | 110 | $label = $date->format('d') . '. ' . self::month2string((int)$date->format('m'), $shortMonth) . ' '; |
| 112 | 111 | |
@@ -104,7 +104,7 @@ discard block |
||
| 104 | 104 | * @param bool $enabled |
| 105 | 105 | * @return $this |
| 106 | 106 | */ |
| 107 | - public function enableNormalizing(bool $enabled=true) : ConvertHelper_URLFinder |
|
| 107 | + public function enableNormalizing(bool $enabled = true) : ConvertHelper_URLFinder |
|
| 108 | 108 | { |
| 109 | 109 | $this->setOption('normalize', $enabled); |
| 110 | 110 | return $this; |
@@ -116,7 +116,7 @@ discard block |
||
| 116 | 116 | * @param bool $enabled |
| 117 | 117 | * @return $this |
| 118 | 118 | */ |
| 119 | - public function enableSorting(bool $enabled=true) : ConvertHelper_URLFinder |
|
| 119 | + public function enableSorting(bool $enabled = true) : ConvertHelper_URLFinder |
|
| 120 | 120 | { |
| 121 | 121 | $this->setOption('sorting', $enabled); |
| 122 | 122 | return $this; |
@@ -130,7 +130,7 @@ discard block |
||
| 130 | 130 | * @param bool $include |
| 131 | 131 | * @return ConvertHelper_URLFinder |
| 132 | 132 | */ |
| 133 | - public function includeEmails(bool $include=true) : ConvertHelper_URLFinder |
|
| 133 | + public function includeEmails(bool $include = true) : ConvertHelper_URLFinder |
|
| 134 | 134 | { |
| 135 | 135 | $this->setOption('include-emails', $include); |
| 136 | 136 | return $this; |
@@ -142,7 +142,7 @@ discard block |
||
| 142 | 142 | * @param bool $omit |
| 143 | 143 | * @return ConvertHelper_URLFinder |
| 144 | 144 | */ |
| 145 | - public function omitMailto(bool $omit=true) : ConvertHelper_URLFinder |
|
| 145 | + public function omitMailto(bool $omit = true) : ConvertHelper_URLFinder |
|
| 146 | 146 | { |
| 147 | 147 | $this->setOption('omit-mailto', $omit); |
| 148 | 148 | return $this; |
@@ -169,7 +169,7 @@ discard block |
||
| 169 | 169 | { |
| 170 | 170 | $line = $this->analyzeLine($line); |
| 171 | 171 | |
| 172 | - if($line !== null) { |
|
| 172 | + if ($line !== null) { |
|
| 173 | 173 | $keep[] = $line; |
| 174 | 174 | } |
| 175 | 175 | } |
@@ -190,7 +190,7 @@ discard block |
||
| 190 | 190 | $line = trim($line, '.'); |
| 191 | 191 | |
| 192 | 192 | // Handle detecting an URI scheme |
| 193 | - if(strstr($line, ':') !== false) |
|
| 193 | + if (strstr($line, ':') !== false) |
|
| 194 | 194 | { |
| 195 | 195 | $scheme = URLInfo_Schemes::detectScheme($line); |
| 196 | 196 | |
@@ -204,7 +204,7 @@ discard block |
||
| 204 | 204 | // detect are email addresses and domain names. |
| 205 | 205 | |
| 206 | 206 | // No dot? Then it's certainly not a domain name. |
| 207 | - if(strstr($line, '.') === false) { |
|
| 207 | + if (strstr($line, '.') === false) { |
|
| 208 | 208 | return null; |
| 209 | 209 | } |
| 210 | 210 | |
@@ -222,10 +222,10 @@ discard block |
||
| 222 | 222 | { |
| 223 | 223 | $subject = stripslashes($subject); |
| 224 | 224 | |
| 225 | - foreach($this->detectors as $detector) |
|
| 225 | + foreach ($this->detectors as $detector) |
|
| 226 | 226 | { |
| 227 | 227 | // Avoid processing the string if it is not needed. |
| 228 | - if($detector->getRunPosition() !== ConvertHelper_URLFinder_Detector::RUN_BEFORE || !$detector->isValidFor($subject)) { |
|
| 228 | + if ($detector->getRunPosition() !== ConvertHelper_URLFinder_Detector::RUN_BEFORE || !$detector->isValidFor($subject)) { |
|
| 229 | 229 | continue; |
| 230 | 230 | } |
| 231 | 231 | |
@@ -246,7 +246,7 @@ discard block |
||
| 246 | 246 | { |
| 247 | 247 | $detector = new $className(); |
| 248 | 248 | |
| 249 | - if($detector instanceof ConvertHelper_URLFinder_Detector) |
|
| 249 | + if ($detector instanceof ConvertHelper_URLFinder_Detector) |
|
| 250 | 250 | { |
| 251 | 251 | return $detector; |
| 252 | 252 | } |
@@ -273,12 +273,12 @@ discard block |
||
| 273 | 273 | |
| 274 | 274 | $result = $this->getItemsAsString($this->urls); |
| 275 | 275 | |
| 276 | - if($this->getBoolOption('include-emails')) |
|
| 276 | + if ($this->getBoolOption('include-emails')) |
|
| 277 | 277 | { |
| 278 | 278 | $result = array_merge($result, $this->getEmails()); |
| 279 | 279 | } |
| 280 | 280 | |
| 281 | - if($this->getBoolOption('sorting')) |
|
| 281 | + if ($this->getBoolOption('sorting')) |
|
| 282 | 282 | { |
| 283 | 283 | usort($result, function(string $a, string $b) { |
| 284 | 284 | return strnatcasecmp($a, $b); |
@@ -298,12 +298,12 @@ discard block |
||
| 298 | 298 | |
| 299 | 299 | $result = array(); |
| 300 | 300 | |
| 301 | - foreach($collection as $url => $info) { |
|
| 302 | - if($normalize) { |
|
| 301 | + foreach ($collection as $url => $info) { |
|
| 302 | + if ($normalize) { |
|
| 303 | 303 | $url = $info->getNormalized(); |
| 304 | 304 | } |
| 305 | 305 | |
| 306 | - if(!in_array($url, $result)) { |
|
| 306 | + if (!in_array($url, $result)) { |
|
| 307 | 307 | $result[] = $url; |
| 308 | 308 | } |
| 309 | 309 | } |
@@ -320,9 +320,9 @@ discard block |
||
| 320 | 320 | */ |
| 321 | 321 | private function initDetectors() : void |
| 322 | 322 | { |
| 323 | - foreach($this->enabledDetectorClasses as $className => $enabled) |
|
| 323 | + foreach ($this->enabledDetectorClasses as $className => $enabled) |
|
| 324 | 324 | { |
| 325 | - if($enabled) { |
|
| 325 | + if ($enabled) { |
|
| 326 | 326 | $this->detectors[] = $this->createDetector($className); |
| 327 | 327 | } |
| 328 | 328 | } |
@@ -337,7 +337,7 @@ discard block |
||
| 337 | 337 | */ |
| 338 | 338 | private function parse() : void |
| 339 | 339 | { |
| 340 | - if($this->parsed) { |
|
| 340 | + if ($this->parsed) { |
|
| 341 | 341 | return; |
| 342 | 342 | } |
| 343 | 343 | |
@@ -348,11 +348,11 @@ discard block |
||
| 348 | 348 | |
| 349 | 349 | unset($this->subject); |
| 350 | 350 | |
| 351 | - foreach($this->matches as $match) |
|
| 351 | + foreach ($this->matches as $match) |
|
| 352 | 352 | { |
| 353 | 353 | $info = parseURL($match); |
| 354 | 354 | |
| 355 | - if($info->isEmail()) |
|
| 355 | + if ($info->isEmail()) |
|
| 356 | 356 | { |
| 357 | 357 | $this->emails[$this->filterEmailAddress($match)] = $info; |
| 358 | 358 | continue; |
@@ -368,7 +368,7 @@ discard block |
||
| 368 | 368 | * @param bool $enable |
| 369 | 369 | * @return $this |
| 370 | 370 | */ |
| 371 | - public function enableHTMLAttributes(bool $enable=true) : ConvertHelper_URLFinder |
|
| 371 | + public function enableHTMLAttributes(bool $enable = true) : ConvertHelper_URLFinder |
|
| 372 | 372 | { |
| 373 | 373 | $this->enabledDetectorClasses[ConvertHelper_URLFinder_Detector_HTMLAttributes::class] = $enable; |
| 374 | 374 | return $this; |
@@ -383,7 +383,7 @@ discard block |
||
| 383 | 383 | */ |
| 384 | 384 | private function filterEmailAddress(string $email) : string |
| 385 | 385 | { |
| 386 | - if(stristr($email, 'mailto:') === false) { |
|
| 386 | + if (stristr($email, 'mailto:') === false) { |
|
| 387 | 387 | $email = 'mailto:'.$email; |
| 388 | 388 | } |
| 389 | 389 | |
@@ -405,14 +405,14 @@ discard block |
||
| 405 | 405 | foreach ($lines as $line) |
| 406 | 406 | { |
| 407 | 407 | $scheme = URLInfo_Schemes::detectScheme($line); |
| 408 | - if($scheme !== null) { |
|
| 408 | + if ($scheme !== null) { |
|
| 409 | 409 | $this->matches[] = $line; |
| 410 | 410 | continue; |
| 411 | 411 | } |
| 412 | 412 | |
| 413 | 413 | $extension = $this->detectDomainExtension($line); |
| 414 | 414 | |
| 415 | - if($domains->nameExists($extension)) { |
|
| 415 | + if ($domains->nameExists($extension)) { |
|
| 416 | 416 | $this->matches[] = $line; |
| 417 | 417 | } |
| 418 | 418 | } |
@@ -431,9 +431,9 @@ discard block |
||
| 431 | 431 | |
| 432 | 432 | $subject = str_replace($remove, ' ', $subject); |
| 433 | 433 | |
| 434 | - foreach($this->detectors as $detector) |
|
| 434 | + foreach ($this->detectors as $detector) |
|
| 435 | 435 | { |
| 436 | - if($detector->getRunPosition() !== ConvertHelper_URLFinder_Detector::RUN_AFTER || !$detector->isValidFor($subject)) { |
|
| 436 | + if ($detector->getRunPosition() !== ConvertHelper_URLFinder_Detector::RUN_AFTER || !$detector->isValidFor($subject)) { |
|
| 437 | 437 | continue; |
| 438 | 438 | } |
| 439 | 439 | |
@@ -456,8 +456,8 @@ discard block |
||
| 456 | 456 | $boundaries = array('/', '?'); |
| 457 | 457 | |
| 458 | 458 | // Remove the path or query parts to access the domain extension only |
| 459 | - foreach($boundaries as $boundary) { |
|
| 460 | - if(strstr($url, $boundary)) { |
|
| 459 | + foreach ($boundaries as $boundary) { |
|
| 460 | + if (strstr($url, $boundary)) { |
|
| 461 | 461 | $parts = explode($boundary, $url); |
| 462 | 462 | $url = array_shift($parts); |
| 463 | 463 | break; |
@@ -482,16 +482,16 @@ discard block |
||
| 482 | 482 | |
| 483 | 483 | $result = $this->getItemsAsString($this->emails); |
| 484 | 484 | |
| 485 | - if($this->getBoolOption('omit-mailto')) { |
|
| 485 | + if ($this->getBoolOption('omit-mailto')) { |
|
| 486 | 486 | $keep = array(); |
| 487 | - foreach($result as $email) { |
|
| 487 | + foreach ($result as $email) { |
|
| 488 | 488 | $keep[] = str_replace('mailto:', '', $email); |
| 489 | 489 | } |
| 490 | 490 | |
| 491 | 491 | $result = $keep; |
| 492 | 492 | } |
| 493 | 493 | |
| 494 | - if($this->getBoolOption('sorting')) |
|
| 494 | + if ($this->getBoolOption('sorting')) |
|
| 495 | 495 | { |
| 496 | 496 | usort($result, function(string $a, string $b) { |
| 497 | 497 | return strnatcasecmp($a, $b); |
@@ -513,16 +513,16 @@ discard block |
||
| 513 | 513 | $result = array(); |
| 514 | 514 | $normalize = $this->getBoolOption('normalize'); |
| 515 | 515 | |
| 516 | - foreach($this->urls as $url => $info) |
|
| 516 | + foreach ($this->urls as $url => $info) |
|
| 517 | 517 | { |
| 518 | - if($normalize) { |
|
| 518 | + if ($normalize) { |
|
| 519 | 519 | $url = $info->getNormalized(); |
| 520 | 520 | } |
| 521 | 521 | |
| 522 | 522 | $result[$url] = $info; |
| 523 | 523 | } |
| 524 | 524 | |
| 525 | - if($this->getBoolOption('sorting')) |
|
| 525 | + if ($this->getBoolOption('sorting')) |
|
| 526 | 526 | { |
| 527 | 527 | ksort($result); |
| 528 | 528 | } |
@@ -15,9 +15,9 @@ discard block |
||
| 15 | 15 | */ |
| 16 | 16 | public static function removeKeys(array &$sourceArray, array $keys) : void |
| 17 | 17 | { |
| 18 | - foreach($keys as $key) |
|
| 18 | + foreach ($keys as $key) |
|
| 19 | 19 | { |
| 20 | - if(array_key_exists($key, $sourceArray)) { |
|
| 20 | + if (array_key_exists($key, $sourceArray)) { |
|
| 21 | 21 | unset($sourceArray[$key]); |
| 22 | 22 | } |
| 23 | 23 | } |
@@ -31,18 +31,18 @@ discard block |
||
| 31 | 31 | * @param bool $keepKeys Whether to maintain index association |
| 32 | 32 | * @return array<number|string,mixed> |
| 33 | 33 | */ |
| 34 | - public static function removeValues(array $sourceArray, array $values, bool $keepKeys=false) : array |
|
| 34 | + public static function removeValues(array $sourceArray, array $values, bool $keepKeys = false) : array |
|
| 35 | 35 | { |
| 36 | 36 | $result = array(); |
| 37 | 37 | $values = array_values($values); |
| 38 | 38 | |
| 39 | - foreach($sourceArray as $key => $value) |
|
| 39 | + foreach ($sourceArray as $key => $value) |
|
| 40 | 40 | { |
| 41 | - if(in_array($value, $values, true)) { |
|
| 41 | + if (in_array($value, $values, true)) { |
|
| 42 | 42 | continue; |
| 43 | 43 | } |
| 44 | 44 | |
| 45 | - if($keepKeys) { |
|
| 45 | + if ($keepKeys) { |
|
| 46 | 46 | $result[$key] = $value; |
| 47 | 47 | continue; |
| 48 | 48 | } |
@@ -75,7 +75,7 @@ discard block |
||
| 75 | 75 | public static function toStyleString(array $subject) : string |
| 76 | 76 | { |
| 77 | 77 | $tokens = array(); |
| 78 | - foreach($subject as $name => $value) { |
|
| 78 | + foreach ($subject as $name => $value) { |
|
| 79 | 79 | $tokens[] = $name.':'.strval($value); |
| 80 | 80 | } |
| 81 | 81 | |
@@ -104,18 +104,18 @@ discard block |
||
| 104 | 104 | public static function toAttributeString(array $array) : string |
| 105 | 105 | { |
| 106 | 106 | $tokens = array(); |
| 107 | - foreach($array as $attr => $value) |
|
| 107 | + foreach ($array as $attr => $value) |
|
| 108 | 108 | { |
| 109 | 109 | $value = strval($value); |
| 110 | 110 | |
| 111 | - if($value === '') { |
|
| 111 | + if ($value === '') { |
|
| 112 | 112 | continue; |
| 113 | 113 | } |
| 114 | 114 | |
| 115 | 115 | $tokens[] = $attr.'="'.htmlspecialchars($value, ENT_QUOTES, 'UTF-8').'"'; |
| 116 | 116 | } |
| 117 | 117 | |
| 118 | - if(empty($tokens)) { |
|
| 118 | + if (empty($tokens)) { |
|
| 119 | 119 | return ''; |
| 120 | 120 | } |
| 121 | 121 | |
@@ -136,17 +136,17 @@ discard block |
||
| 136 | 136 | */ |
| 137 | 137 | public static function implodeWithAnd(array $list, string $sep = ', ', string $conjunction = '') : string |
| 138 | 138 | { |
| 139 | - if(empty($list)) { |
|
| 139 | + if (empty($list)) { |
|
| 140 | 140 | return ''; |
| 141 | 141 | } |
| 142 | 142 | |
| 143 | - if(empty($conjunction)) { |
|
| 143 | + if (empty($conjunction)) { |
|
| 144 | 144 | $conjunction = ' '.t('and').' '; |
| 145 | 145 | } |
| 146 | 146 | |
| 147 | 147 | $last = array_pop($list); |
| 148 | - if($list) { |
|
| 149 | - return implode($sep, $list) . $conjunction . $last; |
|
| 148 | + if ($list) { |
|
| 149 | + return implode($sep, $list).$conjunction.$last; |
|
| 150 | 150 | } |
| 151 | 151 | |
| 152 | 152 | return $last; |
@@ -22,17 +22,17 @@ discard block |
||
| 22 | 22 | */ |
| 23 | 23 | class BaseException extends \Exception |
| 24 | 24 | { |
| 25 | - /** |
|
| 26 | - * @var string |
|
| 27 | - */ |
|
| 25 | + /** |
|
| 26 | + * @var string |
|
| 27 | + */ |
|
| 28 | 28 | protected $details; |
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * @param string $message |
|
| 32 | - * @param string $details |
|
| 33 | - * @param int $code |
|
| 34 | - * @param \Exception $previous |
|
| 35 | - */ |
|
| 30 | + /** |
|
| 31 | + * @param string $message |
|
| 32 | + * @param string $details |
|
| 33 | + * @param int $code |
|
| 34 | + * @param \Exception $previous |
|
| 35 | + */ |
|
| 36 | 36 | public function __construct(string $message, $details=null, $code=null, $previous=null) |
| 37 | 37 | { |
| 38 | 38 | parent::__construct($message, $code, $previous); |
@@ -40,10 +40,10 @@ discard block |
||
| 40 | 40 | $this->details = $details; |
| 41 | 41 | } |
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * Retrieves the detailed error description, if any. |
|
| 45 | - * @return string |
|
| 46 | - */ |
|
| 43 | + /** |
|
| 44 | + * Retrieves the detailed error description, if any. |
|
| 45 | + * @return string |
|
| 46 | + */ |
|
| 47 | 47 | public function getDetails() : string |
| 48 | 48 | { |
| 49 | 49 | if($this->details !== null) { |
@@ -53,9 +53,9 @@ discard block |
||
| 53 | 53 | return ''; |
| 54 | 54 | } |
| 55 | 55 | |
| 56 | - /** |
|
| 57 | - * Displays pertinent information on the exception. |
|
| 58 | - */ |
|
| 56 | + /** |
|
| 57 | + * Displays pertinent information on the exception. |
|
| 58 | + */ |
|
| 59 | 59 | public function display() : void |
| 60 | 60 | { |
| 61 | 61 | if(!headers_sent()) { |
@@ -65,20 +65,20 @@ discard block |
||
| 65 | 65 | echo $this->getInfo(); |
| 66 | 66 | } |
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * Retrieves information on the exception that can be |
|
| 70 | - * easily accessed. |
|
| 71 | - * |
|
| 72 | - * @return ConvertHelper_ThrowableInfo |
|
| 73 | - */ |
|
| 68 | + /** |
|
| 69 | + * Retrieves information on the exception that can be |
|
| 70 | + * easily accessed. |
|
| 71 | + * |
|
| 72 | + * @return ConvertHelper_ThrowableInfo |
|
| 73 | + */ |
|
| 74 | 74 | public function getInfo() : ConvertHelper_ThrowableInfo |
| 75 | 75 | { |
| 76 | 76 | return ConvertHelper::throwable2info($this); |
| 77 | 77 | } |
| 78 | 78 | |
| 79 | - /** |
|
| 80 | - * Dumps a current PHP function trace, as a text only string. |
|
| 81 | - */ |
|
| 79 | + /** |
|
| 80 | + * Dumps a current PHP function trace, as a text only string. |
|
| 81 | + */ |
|
| 82 | 82 | public static function dumpTraceAsString() : void |
| 83 | 83 | { |
| 84 | 84 | try |
@@ -91,9 +91,9 @@ discard block |
||
| 91 | 91 | } |
| 92 | 92 | } |
| 93 | 93 | |
| 94 | - /** |
|
| 95 | - * Dumps a current PHP function trace, with HTML styling. |
|
| 96 | - */ |
|
| 94 | + /** |
|
| 95 | + * Dumps a current PHP function trace, with HTML styling. |
|
| 96 | + */ |
|
| 97 | 97 | public static function dumpTraceAsHTML() : void |
| 98 | 98 | { |
| 99 | 99 | try |
@@ -108,13 +108,13 @@ discard block |
||
| 108 | 108 | } |
| 109 | 109 | } |
| 110 | 110 | |
| 111 | - /** |
|
| 112 | - * Creates an exception info instance from a throwable instance. |
|
| 113 | - * |
|
| 114 | - * @param Throwable $e |
|
| 115 | - * @return ConvertHelper_ThrowableInfo |
|
| 116 | - * @see ConvertHelper::throwable2info() |
|
| 117 | - */ |
|
| 111 | + /** |
|
| 112 | + * Creates an exception info instance from a throwable instance. |
|
| 113 | + * |
|
| 114 | + * @param Throwable $e |
|
| 115 | + * @return ConvertHelper_ThrowableInfo |
|
| 116 | + * @see ConvertHelper::throwable2info() |
|
| 117 | + */ |
|
| 118 | 118 | public static function createInfo(Throwable $e) : ConvertHelper_ThrowableInfo |
| 119 | 119 | { |
| 120 | 120 | return ConvertHelper::throwable2info($e); |
@@ -33,7 +33,7 @@ discard block |
||
| 33 | 33 | * @param int $code |
| 34 | 34 | * @param \Exception $previous |
| 35 | 35 | */ |
| 36 | - public function __construct(string $message, $details=null, $code=null, $previous=null) |
|
| 36 | + public function __construct(string $message, $details = null, $code = null, $previous = null) |
|
| 37 | 37 | { |
| 38 | 38 | parent::__construct($message, $code, $previous); |
| 39 | 39 | |
@@ -46,7 +46,7 @@ discard block |
||
| 46 | 46 | */ |
| 47 | 47 | public function getDetails() : string |
| 48 | 48 | { |
| 49 | - if($this->details !== null) { |
|
| 49 | + if ($this->details !== null) { |
|
| 50 | 50 | return $this->details; |
| 51 | 51 | } |
| 52 | 52 | |
@@ -58,7 +58,7 @@ discard block |
||
| 58 | 58 | */ |
| 59 | 59 | public function display() : void |
| 60 | 60 | { |
| 61 | - if(!headers_sent()) { |
|
| 61 | + if (!headers_sent()) { |
|
| 62 | 62 | header('Content-type:text/plain; charset=utf-8'); |
| 63 | 63 | } |
| 64 | 64 | |
@@ -85,7 +85,7 @@ discard block |
||
| 85 | 85 | { |
| 86 | 86 | throw new BaseException(''); |
| 87 | 87 | } |
| 88 | - catch(BaseException $e) |
|
| 88 | + catch (BaseException $e) |
|
| 89 | 89 | { |
| 90 | 90 | echo self::createInfo($e)->toString(); |
| 91 | 91 | } |
@@ -100,7 +100,7 @@ discard block |
||
| 100 | 100 | { |
| 101 | 101 | throw new BaseException(''); |
| 102 | 102 | } |
| 103 | - catch(BaseException $e) |
|
| 103 | + catch (BaseException $e) |
|
| 104 | 104 | { |
| 105 | 105 | echo '<pre style="background:#fff;font-family:monospace;font-size:14px;color:#444;padding:16px;border:solid 1px #999;border-radius:4px;">'; |
| 106 | 106 | echo self::createInfo($e)->toString(); |
@@ -33,24 +33,24 @@ discard block |
||
| 33 | 33 | */ |
| 34 | 34 | class StringBuilder implements StringBuilder_Interface |
| 35 | 35 | { |
| 36 | - /** |
|
| 37 | - * @var string |
|
| 38 | - */ |
|
| 36 | + /** |
|
| 37 | + * @var string |
|
| 38 | + */ |
|
| 39 | 39 | protected $separator = ' '; |
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * @var string[] |
|
| 43 | - */ |
|
| 41 | + /** |
|
| 42 | + * @var string[] |
|
| 43 | + */ |
|
| 44 | 44 | protected $strings = array(); |
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * @var string |
|
| 48 | - */ |
|
| 46 | + /** |
|
| 47 | + * @var string |
|
| 48 | + */ |
|
| 49 | 49 | protected $mode = 'html'; |
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * @var string |
|
| 53 | - */ |
|
| 51 | + /** |
|
| 52 | + * @var string |
|
| 53 | + */ |
|
| 54 | 54 | protected $noSpace = '§!§'; |
| 55 | 55 | |
| 56 | 56 | public function __construct() |
@@ -58,12 +58,12 @@ discard block |
||
| 58 | 58 | |
| 59 | 59 | } |
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * Adds a subject as a string. Is ignored if empty. |
|
| 63 | - * |
|
| 64 | - * @param string|number|StringBuilder_Interface $string |
|
| 65 | - * @return $this |
|
| 66 | - */ |
|
| 61 | + /** |
|
| 62 | + * Adds a subject as a string. Is ignored if empty. |
|
| 63 | + * |
|
| 64 | + * @param string|number|StringBuilder_Interface $string |
|
| 65 | + * @return $this |
|
| 66 | + */ |
|
| 67 | 67 | public function add($string) : StringBuilder |
| 68 | 68 | { |
| 69 | 69 | $string = strval($string); |
@@ -76,57 +76,57 @@ discard block |
||
| 76 | 76 | return $this; |
| 77 | 77 | } |
| 78 | 78 | |
| 79 | - /** |
|
| 80 | - * Adds a string without appending an automatic space. |
|
| 81 | - * |
|
| 82 | - * @param string|number|StringBuilder_Interface $string |
|
| 83 | - * @return $this |
|
| 84 | - */ |
|
| 79 | + /** |
|
| 80 | + * Adds a string without appending an automatic space. |
|
| 81 | + * |
|
| 82 | + * @param string|number|StringBuilder_Interface $string |
|
| 83 | + * @return $this |
|
| 84 | + */ |
|
| 85 | 85 | public function nospace($string) : StringBuilder |
| 86 | 86 | { |
| 87 | 87 | return $this->add($this->noSpace.strval($string)); |
| 88 | 88 | } |
| 89 | 89 | |
| 90 | - /** |
|
| 91 | - * Adds raw HTML code. Does not add an automatic space. |
|
| 92 | - * |
|
| 93 | - * @param string|number|StringBuilder_Interface $html |
|
| 94 | - * @return $this |
|
| 95 | - */ |
|
| 90 | + /** |
|
| 91 | + * Adds raw HTML code. Does not add an automatic space. |
|
| 92 | + * |
|
| 93 | + * @param string|number|StringBuilder_Interface $html |
|
| 94 | + * @return $this |
|
| 95 | + */ |
|
| 96 | 96 | public function html($html) : StringBuilder |
| 97 | 97 | { |
| 98 | 98 | return $this->nospace($html); |
| 99 | 99 | } |
| 100 | 100 | |
| 101 | - /** |
|
| 102 | - * Adds an unordered list with the specified items. |
|
| 103 | - * |
|
| 104 | - * @param array<int,string|number|StringBuilder_Interface> $items |
|
| 105 | - * @return $this |
|
| 106 | - */ |
|
| 101 | + /** |
|
| 102 | + * Adds an unordered list with the specified items. |
|
| 103 | + * |
|
| 104 | + * @param array<int,string|number|StringBuilder_Interface> $items |
|
| 105 | + * @return $this |
|
| 106 | + */ |
|
| 107 | 107 | public function ul(array $items) : StringBuilder |
| 108 | 108 | { |
| 109 | 109 | return $this->list('ul', $items); |
| 110 | 110 | } |
| 111 | 111 | |
| 112 | - /** |
|
| 113 | - * Adds an ordered list with the specified items. |
|
| 114 | - * |
|
| 115 | - * @param array<int,string|number|StringBuilder_Interface> $items |
|
| 116 | - * @return $this |
|
| 117 | - */ |
|
| 112 | + /** |
|
| 113 | + * Adds an ordered list with the specified items. |
|
| 114 | + * |
|
| 115 | + * @param array<int,string|number|StringBuilder_Interface> $items |
|
| 116 | + * @return $this |
|
| 117 | + */ |
|
| 118 | 118 | public function ol(array $items) : StringBuilder |
| 119 | 119 | { |
| 120 | 120 | return $this->list('ol', $items); |
| 121 | 121 | } |
| 122 | 122 | |
| 123 | - /** |
|
| 124 | - * Creates a list tag with the items list. |
|
| 125 | - * |
|
| 126 | - * @param string $type The list type, `ol` or `ul`. |
|
| 127 | - * @param array<int,string|number|StringBuilder_Interface> $items |
|
| 128 | - * @return $this |
|
| 129 | - */ |
|
| 123 | + /** |
|
| 124 | + * Creates a list tag with the items list. |
|
| 125 | + * |
|
| 126 | + * @param string $type The list type, `ol` or `ul`. |
|
| 127 | + * @param array<int,string|number|StringBuilder_Interface> $items |
|
| 128 | + * @return $this |
|
| 129 | + */ |
|
| 130 | 130 | protected function list(string $type, array $items) : StringBuilder |
| 131 | 131 | { |
| 132 | 132 | return $this->html(sprintf( |
@@ -136,13 +136,13 @@ discard block |
||
| 136 | 136 | )); |
| 137 | 137 | } |
| 138 | 138 | |
| 139 | - /** |
|
| 140 | - * Add a translated string. |
|
| 141 | - * |
|
| 142 | - * @param string $format The native string to translate. |
|
| 143 | - * @param array<int,mixed> $arguments The variables to inject into the translated string, if any. |
|
| 144 | - * @return $this |
|
| 145 | - */ |
|
| 139 | + /** |
|
| 140 | + * Add a translated string. |
|
| 141 | + * |
|
| 142 | + * @param string $format The native string to translate. |
|
| 143 | + * @param array<int,mixed> $arguments The variables to inject into the translated string, if any. |
|
| 144 | + * @return $this |
|
| 145 | + */ |
|
| 146 | 146 | public function t(string $format, ...$arguments) : StringBuilder |
| 147 | 147 | { |
| 148 | 148 | if(!class_exists('\AppLocalize\Localization')) |
@@ -195,36 +195,36 @@ discard block |
||
| 195 | 195 | return $this->add(ConvertHelper::duration2string($since)); |
| 196 | 196 | } |
| 197 | 197 | |
| 198 | - /** |
|
| 199 | - * Adds HTML double quotes around the string. |
|
| 200 | - * |
|
| 201 | - * @param string|number|StringBuilder_Interface $string |
|
| 202 | - * @return $this |
|
| 203 | - */ |
|
| 198 | + /** |
|
| 199 | + * Adds HTML double quotes around the string. |
|
| 200 | + * |
|
| 201 | + * @param string|number|StringBuilder_Interface $string |
|
| 202 | + * @return $this |
|
| 203 | + */ |
|
| 204 | 204 | public function quote($string) |
| 205 | 205 | { |
| 206 | 206 | return $this->sf('"%s"', strval($string)); |
| 207 | 207 | } |
| 208 | 208 | |
| 209 | - /** |
|
| 210 | - * Adds a text that is meant as a reference to an UI element, |
|
| 211 | - * like a menu item, button, etc. |
|
| 212 | - * |
|
| 213 | - * @param string|number|StringBuilder_Interface $string |
|
| 214 | - * @return $this |
|
| 215 | - */ |
|
| 209 | + /** |
|
| 210 | + * Adds a text that is meant as a reference to an UI element, |
|
| 211 | + * like a menu item, button, etc. |
|
| 212 | + * |
|
| 213 | + * @param string|number|StringBuilder_Interface $string |
|
| 214 | + * @return $this |
|
| 215 | + */ |
|
| 216 | 216 | public function reference($string) : StringBuilder |
| 217 | 217 | { |
| 218 | 218 | return $this->sf('"%s"', $string); |
| 219 | 219 | } |
| 220 | 220 | |
| 221 | - /** |
|
| 222 | - * Add a string using the `sprintf` method. |
|
| 223 | - * |
|
| 224 | - * @param string $format The format string |
|
| 225 | - * @param string|number|StringBuilder_Interface ...$arguments The variables to inject |
|
| 226 | - * @return $this |
|
| 227 | - */ |
|
| 221 | + /** |
|
| 222 | + * Add a string using the `sprintf` method. |
|
| 223 | + * |
|
| 224 | + * @param string $format The format string |
|
| 225 | + * @param string|number|StringBuilder_Interface ...$arguments The variables to inject |
|
| 226 | + * @return $this |
|
| 227 | + */ |
|
| 228 | 228 | public function sf(string $format, ...$arguments) : StringBuilder |
| 229 | 229 | { |
| 230 | 230 | array_unshift($arguments, $format); |
@@ -232,12 +232,12 @@ discard block |
||
| 232 | 232 | return $this->add(call_user_func_array('sprintf', $arguments)); |
| 233 | 233 | } |
| 234 | 234 | |
| 235 | - /** |
|
| 236 | - * Adds a bold string. |
|
| 237 | - * |
|
| 238 | - * @param string|number|StringBuilder_Interface $string |
|
| 239 | - * @return $this |
|
| 240 | - */ |
|
| 235 | + /** |
|
| 236 | + * Adds a bold string. |
|
| 237 | + * |
|
| 238 | + * @param string|number|StringBuilder_Interface $string |
|
| 239 | + * @return $this |
|
| 240 | + */ |
|
| 241 | 241 | public function bold($string) : StringBuilder |
| 242 | 242 | { |
| 243 | 243 | return $this->sf( |
@@ -246,15 +246,15 @@ discard block |
||
| 246 | 246 | ); |
| 247 | 247 | } |
| 248 | 248 | |
| 249 | - /** |
|
| 250 | - * Adds an HTML `<br>` tag. |
|
| 251 | - * |
|
| 252 | - * Note: for adding a newline character instead, |
|
| 253 | - * use {@see StringBuilder::eol()}. |
|
| 254 | - * |
|
| 255 | - * @return $this |
|
| 256 | - * @see StringBuilder::eol() |
|
| 257 | - */ |
|
| 249 | + /** |
|
| 250 | + * Adds an HTML `<br>` tag. |
|
| 251 | + * |
|
| 252 | + * Note: for adding a newline character instead, |
|
| 253 | + * use {@see StringBuilder::eol()}. |
|
| 254 | + * |
|
| 255 | + * @return $this |
|
| 256 | + * @see StringBuilder::eol() |
|
| 257 | + */ |
|
| 258 | 258 | public function nl() : StringBuilder |
| 259 | 259 | { |
| 260 | 260 | return $this->html('<br>'); |
@@ -271,42 +271,42 @@ discard block |
||
| 271 | 271 | return $this->nospace(PHP_EOL); |
| 272 | 272 | } |
| 273 | 273 | |
| 274 | - /** |
|
| 275 | - * Adds the current time, in the format <code>H:i:s</code>. |
|
| 276 | - * |
|
| 277 | - * @return $this |
|
| 278 | - */ |
|
| 274 | + /** |
|
| 275 | + * Adds the current time, in the format <code>H:i:s</code>. |
|
| 276 | + * |
|
| 277 | + * @return $this |
|
| 278 | + */ |
|
| 279 | 279 | public function time() : StringBuilder |
| 280 | 280 | { |
| 281 | 281 | return $this->add(date('H:i:s')); |
| 282 | 282 | } |
| 283 | 283 | |
| 284 | - /** |
|
| 285 | - * Adds the "Note:" text. |
|
| 286 | - * |
|
| 287 | - * @return $this |
|
| 288 | - */ |
|
| 284 | + /** |
|
| 285 | + * Adds the "Note:" text. |
|
| 286 | + * |
|
| 287 | + * @return $this |
|
| 288 | + */ |
|
| 289 | 289 | public function note() : StringBuilder |
| 290 | 290 | { |
| 291 | 291 | return $this->t('Note:'); |
| 292 | 292 | } |
| 293 | 293 | |
| 294 | - /** |
|
| 295 | - * Like {@see StringBuilder::note()}, but as bold text. |
|
| 296 | - * |
|
| 297 | - * @return $this |
|
| 298 | - */ |
|
| 294 | + /** |
|
| 295 | + * Like {@see StringBuilder::note()}, but as bold text. |
|
| 296 | + * |
|
| 297 | + * @return $this |
|
| 298 | + */ |
|
| 299 | 299 | public function noteBold() : StringBuilder |
| 300 | 300 | { |
| 301 | 301 | return $this->bold(sb()->note()); |
| 302 | 302 | } |
| 303 | 303 | |
| 304 | - /** |
|
| 305 | - * Adds the "Hint:" text. |
|
| 306 | - * |
|
| 307 | - * @return $this |
|
| 308 | - * @see StringBuilder::hintBold() |
|
| 309 | - */ |
|
| 304 | + /** |
|
| 305 | + * Adds the "Hint:" text. |
|
| 306 | + * |
|
| 307 | + * @return $this |
|
| 308 | + * @see StringBuilder::hintBold() |
|
| 309 | + */ |
|
| 310 | 310 | public function hint() : StringBuilder |
| 311 | 311 | { |
| 312 | 312 | return $this->t('Hint:'); |
@@ -322,12 +322,12 @@ discard block |
||
| 322 | 322 | return $this->bold(sb()->hint()); |
| 323 | 323 | } |
| 324 | 324 | |
| 325 | - /** |
|
| 326 | - * Adds two linebreaks. |
|
| 327 | - * |
|
| 328 | - * @param StringBuilder_Interface|string|NULL $content |
|
| 329 | - * @return $this |
|
| 330 | - */ |
|
| 325 | + /** |
|
| 326 | + * Adds two linebreaks. |
|
| 327 | + * |
|
| 328 | + * @param StringBuilder_Interface|string|NULL $content |
|
| 329 | + * @return $this |
|
| 330 | + */ |
|
| 331 | 331 | public function para($content=null) : StringBuilder |
| 332 | 332 | { |
| 333 | 333 | if($content !== null) { |
@@ -337,14 +337,14 @@ discard block |
||
| 337 | 337 | return $this->nl()->nl(); |
| 338 | 338 | } |
| 339 | 339 | |
| 340 | - /** |
|
| 341 | - * Adds an anchor HTML tag. |
|
| 342 | - * |
|
| 343 | - * @param string $label |
|
| 344 | - * @param string $url |
|
| 345 | - * @param bool $newTab |
|
| 346 | - * @return $this |
|
| 347 | - */ |
|
| 340 | + /** |
|
| 341 | + * Adds an anchor HTML tag. |
|
| 342 | + * |
|
| 343 | + * @param string $label |
|
| 344 | + * @param string $url |
|
| 345 | + * @param bool $newTab |
|
| 346 | + * @return $this |
|
| 347 | + */ |
|
| 348 | 348 | public function link(string $label, string $url, bool $newTab=false) : StringBuilder |
| 349 | 349 | { |
| 350 | 350 | $target = ''; |
@@ -360,12 +360,12 @@ discard block |
||
| 360 | 360 | ); |
| 361 | 361 | } |
| 362 | 362 | |
| 363 | - /** |
|
| 364 | - * Wraps the string in a `code` tag. |
|
| 365 | - * |
|
| 366 | - * @param string|number|StringBuilder_Interface $string |
|
| 367 | - * @return $this |
|
| 368 | - */ |
|
| 363 | + /** |
|
| 364 | + * Wraps the string in a `code` tag. |
|
| 365 | + * |
|
| 366 | + * @param string|number|StringBuilder_Interface $string |
|
| 367 | + * @return $this |
|
| 368 | + */ |
|
| 369 | 369 | public function code($string) : StringBuilder |
| 370 | 370 | { |
| 371 | 371 | return $this->sf( |
@@ -374,24 +374,24 @@ discard block |
||
| 374 | 374 | ); |
| 375 | 375 | } |
| 376 | 376 | |
| 377 | - /** |
|
| 378 | - * Wraps the string in a `pre` tag. |
|
| 379 | - * |
|
| 380 | - * @param string|number|StringBuilder_Interface $string |
|
| 381 | - * @return $this |
|
| 382 | - */ |
|
| 377 | + /** |
|
| 378 | + * Wraps the string in a `pre` tag. |
|
| 379 | + * |
|
| 380 | + * @param string|number|StringBuilder_Interface $string |
|
| 381 | + * @return $this |
|
| 382 | + */ |
|
| 383 | 383 | public function pre($string) : StringBuilder |
| 384 | 384 | { |
| 385 | 385 | return $this->sf('<pre>%s</pre>', strval($string)); |
| 386 | 386 | } |
| 387 | 387 | |
| 388 | - /** |
|
| 389 | - * Wraps the text in a `span` tag with the specified classes. |
|
| 390 | - * |
|
| 391 | - * @param string|number|StringBuilder_Interface $string |
|
| 392 | - * @param string|string[] $classes |
|
| 393 | - * @return $this |
|
| 394 | - */ |
|
| 388 | + /** |
|
| 389 | + * Wraps the text in a `span` tag with the specified classes. |
|
| 390 | + * |
|
| 391 | + * @param string|number|StringBuilder_Interface $string |
|
| 392 | + * @param string|string[] $classes |
|
| 393 | + * @return $this |
|
| 394 | + */ |
|
| 395 | 395 | public function spanned($string, $classes) : StringBuilder |
| 396 | 396 | { |
| 397 | 397 | if(!is_array($classes)) |
@@ -68,7 +68,7 @@ discard block |
||
| 68 | 68 | { |
| 69 | 69 | $string = strval($string); |
| 70 | 70 | |
| 71 | - if(!empty($string)) |
|
| 71 | + if (!empty($string)) |
|
| 72 | 72 | { |
| 73 | 73 | $this->strings[] = $string; |
| 74 | 74 | } |
@@ -145,7 +145,7 @@ discard block |
||
| 145 | 145 | */ |
| 146 | 146 | public function t(string $format, ...$arguments) : StringBuilder |
| 147 | 147 | { |
| 148 | - if(!class_exists('\AppLocalize\Localization')) |
|
| 148 | + if (!class_exists('\AppLocalize\Localization')) |
|
| 149 | 149 | { |
| 150 | 150 | array_unshift($arguments, $format); |
| 151 | 151 | return $this->sf(...$arguments); |
@@ -170,7 +170,7 @@ discard block |
||
| 170 | 170 | { |
| 171 | 171 | unset($context); // Only used by the localization parser. |
| 172 | 172 | |
| 173 | - if(!class_exists('\AppLocalize\Localization')) |
|
| 173 | + if (!class_exists('\AppLocalize\Localization')) |
|
| 174 | 174 | { |
| 175 | 175 | array_unshift($arguments, $format); |
| 176 | 176 | return $this->sf(...$arguments); |
@@ -328,9 +328,9 @@ discard block |
||
| 328 | 328 | * @param StringBuilder_Interface|string|NULL $content |
| 329 | 329 | * @return $this |
| 330 | 330 | */ |
| 331 | - public function para($content=null) : StringBuilder |
|
| 331 | + public function para($content = null) : StringBuilder |
|
| 332 | 332 | { |
| 333 | - if($content !== null) { |
|
| 333 | + if ($content !== null) { |
|
| 334 | 334 | return $this->html('<p>')->nospace($content)->html('</p>'); |
| 335 | 335 | } |
| 336 | 336 | |
@@ -345,10 +345,10 @@ discard block |
||
| 345 | 345 | * @param bool $newTab |
| 346 | 346 | * @return $this |
| 347 | 347 | */ |
| 348 | - public function link(string $label, string $url, bool $newTab=false) : StringBuilder |
|
| 348 | + public function link(string $label, string $url, bool $newTab = false) : StringBuilder |
|
| 349 | 349 | { |
| 350 | 350 | $target = ''; |
| 351 | - if($newTab) { |
|
| 351 | + if ($newTab) { |
|
| 352 | 352 | $target = ' target="_blank"'; |
| 353 | 353 | } |
| 354 | 354 | |
@@ -394,7 +394,7 @@ discard block |
||
| 394 | 394 | */ |
| 395 | 395 | public function spanned($string, $classes) : StringBuilder |
| 396 | 396 | { |
| 397 | - if(!is_array($classes)) |
|
| 397 | + if (!is_array($classes)) |
|
| 398 | 398 | { |
| 399 | 399 | $classes = array(strval($classes)); |
| 400 | 400 | } |
@@ -68,7 +68,7 @@ discard block |
||
| 68 | 68 | { |
| 69 | 69 | self::$stack[] = 1; |
| 70 | 70 | |
| 71 | - if(ob_start() === true) { |
|
| 71 | + if (ob_start() === true) { |
|
| 72 | 72 | return; |
| 73 | 73 | } |
| 74 | 74 | |
@@ -90,7 +90,7 @@ discard block |
||
| 90 | 90 | { |
| 91 | 91 | self::_stop(); |
| 92 | 92 | |
| 93 | - if(ob_end_clean() !== false) |
|
| 93 | + if (ob_end_clean() !== false) |
|
| 94 | 94 | { |
| 95 | 95 | return; |
| 96 | 96 | } |
@@ -107,7 +107,7 @@ discard block |
||
| 107 | 107 | */ |
| 108 | 108 | private static function _stop() : void |
| 109 | 109 | { |
| 110 | - if(empty(self::$stack)) |
|
| 110 | + if (empty(self::$stack)) |
|
| 111 | 111 | { |
| 112 | 112 | throw new OutputBuffering_Exception( |
| 113 | 113 | 'Output buffering is not active', |
@@ -130,7 +130,7 @@ discard block |
||
| 130 | 130 | { |
| 131 | 131 | self::_stop(); |
| 132 | 132 | |
| 133 | - if(ob_end_flush() !== false) |
|
| 133 | + if (ob_end_flush() !== false) |
|
| 134 | 134 | { |
| 135 | 135 | return; |
| 136 | 136 | } |
@@ -158,7 +158,7 @@ discard block |
||
| 158 | 158 | |
| 159 | 159 | $content = ob_get_clean(); |
| 160 | 160 | |
| 161 | - if($content !== false) |
|
| 161 | + if ($content !== false) |
|
| 162 | 162 | { |
| 163 | 163 | return $content; |
| 164 | 164 | } |