@@ -25,10 +25,10 @@ |
||
| 25 | 25 | * |
| 26 | 26 | * @return string |
| 27 | 27 | */ |
| 28 | - function render() : string; |
|
| 28 | + function render() : string; |
|
| 29 | 29 | |
| 30 | 30 | /** |
| 31 | 31 | * Renders the string and echos it. |
| 32 | 32 | */ |
| 33 | - function display() : void; |
|
| 33 | + function display() : void; |
|
| 34 | 34 | } |
@@ -23,18 +23,18 @@ |
||
| 23 | 23 | * @see Microtime::ERROR_FAILED_CREATING_DATE_OBJECT |
| 24 | 24 | * @see Microtime::ERROR_FAILED_CONVERTING_STRING |
| 25 | 25 | */ |
| 26 | - public function __construct($datetime='now', DateTimeZone $timeZone=null) |
|
| 26 | + public function __construct($datetime = 'now', DateTimeZone $timeZone = null) |
|
| 27 | 27 | { |
| 28 | - if($timeZone === null) |
|
| 28 | + if ($timeZone === null) |
|
| 29 | 29 | { |
| 30 | 30 | $timeZone = new DateTimeZone(date_default_timezone_get()); |
| 31 | 31 | } |
| 32 | 32 | |
| 33 | - if(empty($datetime) || $datetime === 'now') |
|
| 33 | + if (empty($datetime) || $datetime === 'now') |
|
| 34 | 34 | { |
| 35 | 35 | $dateObj = DateTime::createFromFormat('0.u00 U', microtime(), new DateTimeZone('America/Denver')); |
| 36 | 36 | |
| 37 | - if($dateObj === false) { |
|
| 37 | + if ($dateObj === false) { |
|
| 38 | 38 | throw new ConvertHelper_Exception( |
| 39 | 39 | 'Failed to create microseconds date.', |
| 40 | 40 | '', |
@@ -49,8 +49,7 @@ |
||
| 49 | 49 | try |
| 50 | 50 | { |
| 51 | 51 | parent::__construct($datetime, $timeZone); |
| 52 | - } |
|
| 53 | - catch (Exception $e) |
|
| 52 | + } catch (Exception $e) |
|
| 54 | 53 | { |
| 55 | 54 | throw new ConvertHelper_Exception( |
| 56 | 55 | 'Failed to create date from string.', |
@@ -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 | } |
@@ -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 | } |
@@ -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<string,array<string,string>>|NULL |
|
| 69 | - */ |
|
| 67 | + /** |
|
| 68 | + * @var array<string,array<string,string>>|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() : void |
| 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 | } |
@@ -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 | |
@@ -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; |
@@ -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 | } |
@@ -60,13 +60,13 @@ discard block |
||
| 60 | 60 | return ConvertHelper_String::tabs2spaces($string, $tabSize); |
| 61 | 61 | } |
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * Converts spaces to tabs in the specified string. |
|
| 65 | - * |
|
| 66 | - * @param string $string |
|
| 67 | - * @param int $tabSize The amount of spaces per tab in the source string. |
|
| 68 | - * @return string |
|
| 69 | - */ |
|
| 63 | + /** |
|
| 64 | + * Converts spaces to tabs in the specified string. |
|
| 65 | + * |
|
| 66 | + * @param string $string |
|
| 67 | + * @param int $tabSize The amount of spaces per tab in the source string. |
|
| 68 | + * @return string |
|
| 69 | + */ |
|
| 70 | 70 | public static function spaces2tabs(string $string, int $tabSize=4) : string |
| 71 | 71 | { |
| 72 | 72 | return ConvertHelper_String::spaces2tabs($string, $tabSize); |
@@ -84,14 +84,14 @@ discard block |
||
| 84 | 84 | return ConvertHelper_String::hidden2visible($string); |
| 85 | 85 | } |
| 86 | 86 | |
| 87 | - /** |
|
| 88 | - * Converts the specified amount of seconds into |
|
| 89 | - * a human-readable string split in months, weeks, |
|
| 90 | - * days, hours, minutes and seconds. |
|
| 91 | - * |
|
| 92 | - * @param float $seconds |
|
| 93 | - * @return string |
|
| 94 | - */ |
|
| 87 | + /** |
|
| 88 | + * Converts the specified amount of seconds into |
|
| 89 | + * a human-readable string split in months, weeks, |
|
| 90 | + * days, hours, minutes and seconds. |
|
| 91 | + * |
|
| 92 | + * @param float $seconds |
|
| 93 | + * @return string |
|
| 94 | + */ |
|
| 95 | 95 | public static function time2string($seconds) : string |
| 96 | 96 | { |
| 97 | 97 | $converter = new ConvertHelper_TimeConverter($seconds); |
@@ -115,85 +115,85 @@ discard block |
||
| 115 | 115 | */ |
| 116 | 116 | public static function duration2string($datefrom, $dateto = -1) : string |
| 117 | 117 | { |
| 118 | - return ConvertHelper_DurationConverter::toString($datefrom, $dateto); |
|
| 118 | + return ConvertHelper_DurationConverter::toString($datefrom, $dateto); |
|
| 119 | 119 | } |
| 120 | 120 | |
| 121 | - /** |
|
| 122 | - * Adds HTML syntax highlighting to the specified SQL string. |
|
| 123 | - * |
|
| 124 | - * @param string $sql |
|
| 125 | - * @return string |
|
| 126 | - * @deprecated Use the Highlighter class directly instead. |
|
| 127 | - * @see Highlighter::sql() |
|
| 128 | - */ |
|
| 121 | + /** |
|
| 122 | + * Adds HTML syntax highlighting to the specified SQL string. |
|
| 123 | + * |
|
| 124 | + * @param string $sql |
|
| 125 | + * @return string |
|
| 126 | + * @deprecated Use the Highlighter class directly instead. |
|
| 127 | + * @see Highlighter::sql() |
|
| 128 | + */ |
|
| 129 | 129 | public static function highlight_sql(string $sql) : string |
| 130 | 130 | { |
| 131 | 131 | return Highlighter::sql($sql); |
| 132 | 132 | } |
| 133 | 133 | |
| 134 | - /** |
|
| 135 | - * Adds HTML syntax highlighting to the specified XML code. |
|
| 136 | - * |
|
| 137 | - * @param string $xml The XML to highlight. |
|
| 138 | - * @param bool $formatSource Whether to format the source with indentation to make it readable. |
|
| 139 | - * @return string |
|
| 140 | - * @deprecated Use the Highlighter class directly instead. |
|
| 141 | - * @see Highlighter::xml() |
|
| 142 | - */ |
|
| 134 | + /** |
|
| 135 | + * Adds HTML syntax highlighting to the specified XML code. |
|
| 136 | + * |
|
| 137 | + * @param string $xml The XML to highlight. |
|
| 138 | + * @param bool $formatSource Whether to format the source with indentation to make it readable. |
|
| 139 | + * @return string |
|
| 140 | + * @deprecated Use the Highlighter class directly instead. |
|
| 141 | + * @see Highlighter::xml() |
|
| 142 | + */ |
|
| 143 | 143 | public static function highlight_xml(string $xml, bool $formatSource=false) : string |
| 144 | 144 | { |
| 145 | 145 | return Highlighter::xml($xml, $formatSource); |
| 146 | 146 | } |
| 147 | 147 | |
| 148 | - /** |
|
| 149 | - * @param string $phpCode |
|
| 150 | - * @return string |
|
| 151 | - * @deprecated Use the Highlighter class directly instead. |
|
| 152 | - * @see Highlighter::php() |
|
| 153 | - */ |
|
| 148 | + /** |
|
| 149 | + * @param string $phpCode |
|
| 150 | + * @return string |
|
| 151 | + * @deprecated Use the Highlighter class directly instead. |
|
| 152 | + * @see Highlighter::php() |
|
| 153 | + */ |
|
| 154 | 154 | public static function highlight_php(string $phpCode) : string |
| 155 | 155 | { |
| 156 | 156 | return Highlighter::php($phpCode); |
| 157 | 157 | } |
| 158 | 158 | |
| 159 | - /** |
|
| 160 | - * Converts a number of bytes to a human-readable form, |
|
| 161 | - * e.g. xx Kb / xx Mb / xx Gb |
|
| 162 | - * |
|
| 163 | - * @param int $bytes The amount of bytes to convert. |
|
| 164 | - * @param int $precision The amount of decimals |
|
| 165 | - * @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). |
|
| 166 | - * @return string |
|
| 167 | - * |
|
| 168 | - * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
| 169 | - */ |
|
| 159 | + /** |
|
| 160 | + * Converts a number of bytes to a human-readable form, |
|
| 161 | + * e.g. xx Kb / xx Mb / xx Gb |
|
| 162 | + * |
|
| 163 | + * @param int $bytes The amount of bytes to convert. |
|
| 164 | + * @param int $precision The amount of decimals |
|
| 165 | + * @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). |
|
| 166 | + * @return string |
|
| 167 | + * |
|
| 168 | + * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
| 169 | + */ |
|
| 170 | 170 | public static function bytes2readable(int $bytes, int $precision = 1, int $base = ConvertHelper_StorageSizeEnum::BASE_10) : string |
| 171 | 171 | { |
| 172 | 172 | return self::parseBytes($bytes)->toString($precision, $base); |
| 173 | 173 | } |
| 174 | 174 | |
| 175 | - /** |
|
| 176 | - * Parses a number of bytes, and creates a converter instance which |
|
| 177 | - * allows doing common operations with it. |
|
| 178 | - * |
|
| 179 | - * @param int $bytes |
|
| 180 | - * @return ConvertHelper_ByteConverter |
|
| 181 | - */ |
|
| 175 | + /** |
|
| 176 | + * Parses a number of bytes, and creates a converter instance which |
|
| 177 | + * allows doing common operations with it. |
|
| 178 | + * |
|
| 179 | + * @param int $bytes |
|
| 180 | + * @return ConvertHelper_ByteConverter |
|
| 181 | + */ |
|
| 182 | 182 | public static function parseBytes(int $bytes) : ConvertHelper_ByteConverter |
| 183 | 183 | { |
| 184 | 184 | return new ConvertHelper_ByteConverter($bytes); |
| 185 | 185 | } |
| 186 | 186 | |
| 187 | - /** |
|
| 188 | - * Cuts a text to the specified length if it is longer than the |
|
| 189 | - * target length. Appends a text to signify it has been cut at |
|
| 190 | - * the end of the string. |
|
| 191 | - * |
|
| 192 | - * @param string $text |
|
| 193 | - * @param int $targetLength |
|
| 194 | - * @param string $append |
|
| 195 | - * @return string |
|
| 196 | - */ |
|
| 187 | + /** |
|
| 188 | + * Cuts a text to the specified length if it is longer than the |
|
| 189 | + * target length. Appends a text to signify it has been cut at |
|
| 190 | + * the end of the string. |
|
| 191 | + * |
|
| 192 | + * @param string $text |
|
| 193 | + * @param int $targetLength |
|
| 194 | + * @param string $append |
|
| 195 | + * @return string |
|
| 196 | + */ |
|
| 197 | 197 | public static function text_cut(string $text, int $targetLength, string $append = '...') : string |
| 198 | 198 | { |
| 199 | 199 | return ConvertHelper_String::cutText($text, $targetLength, $append); |
@@ -217,14 +217,14 @@ discard block |
||
| 217 | 217 | return $info->toString(); |
| 218 | 218 | } |
| 219 | 219 | |
| 220 | - /** |
|
| 221 | - * Pretty `print_r`. |
|
| 222 | - * |
|
| 223 | - * @param mixed $var The variable to dump. |
|
| 224 | - * @param bool $return Whether to return the dumped code. |
|
| 225 | - * @param bool $html Whether to style the dump as HTML. |
|
| 226 | - * @return string |
|
| 227 | - */ |
|
| 220 | + /** |
|
| 221 | + * Pretty `print_r`. |
|
| 222 | + * |
|
| 223 | + * @param mixed $var The variable to dump. |
|
| 224 | + * @param bool $return Whether to return the dumped code. |
|
| 225 | + * @param bool $html Whether to style the dump as HTML. |
|
| 226 | + * @return string |
|
| 227 | + */ |
|
| 228 | 228 | public static function print_r($var, bool $return=false, bool $html=true) : string |
| 229 | 229 | { |
| 230 | 230 | $result = parseVariable($var)->enableType()->toString(); |
@@ -245,29 +245,29 @@ discard block |
||
| 245 | 245 | return $result; |
| 246 | 246 | } |
| 247 | 247 | |
| 248 | - /** |
|
| 249 | - * Converts a string, number or boolean value to a boolean value. |
|
| 250 | - * |
|
| 251 | - * @param mixed $string |
|
| 252 | - * @throws ConvertHelper_Exception |
|
| 253 | - * @return bool |
|
| 254 | - * |
|
| 255 | - * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING |
|
| 256 | - */ |
|
| 248 | + /** |
|
| 249 | + * Converts a string, number or boolean value to a boolean value. |
|
| 250 | + * |
|
| 251 | + * @param mixed $string |
|
| 252 | + * @throws ConvertHelper_Exception |
|
| 253 | + * @return bool |
|
| 254 | + * |
|
| 255 | + * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING |
|
| 256 | + */ |
|
| 257 | 257 | public static function string2bool($string) : bool |
| 258 | 258 | { |
| 259 | 259 | return ConvertHelper_Bool::fromString($string); |
| 260 | 260 | } |
| 261 | 261 | |
| 262 | - /** |
|
| 263 | - * Whether the specified string is a boolean string or boolean value. |
|
| 264 | - * Alias for {@link ConvertHelper::isBoolean()}. |
|
| 265 | - * |
|
| 266 | - * @param mixed $string |
|
| 267 | - * @return bool |
|
| 268 | - * @deprecated |
|
| 269 | - * @see ConvertHelper::isBoolean() |
|
| 270 | - */ |
|
| 262 | + /** |
|
| 263 | + * Whether the specified string is a boolean string or boolean value. |
|
| 264 | + * Alias for {@link ConvertHelper::isBoolean()}. |
|
| 265 | + * |
|
| 266 | + * @param mixed $string |
|
| 267 | + * @return bool |
|
| 268 | + * @deprecated |
|
| 269 | + * @see ConvertHelper::isBoolean() |
|
| 270 | + */ |
|
| 271 | 271 | public static function isBooleanString($string) : bool |
| 272 | 272 | { |
| 273 | 273 | return self::isBoolean($string); |
@@ -337,36 +337,36 @@ discard block |
||
| 337 | 337 | return ConvertHelper_String::transliterate($string, $spaceChar, $lowercase); |
| 338 | 338 | } |
| 339 | 339 | |
| 340 | - /** |
|
| 341 | - * Retrieves the HEX character codes for all control |
|
| 342 | - * characters that the {@link stripControlCharacters()} |
|
| 343 | - * method will remove. |
|
| 344 | - * |
|
| 345 | - * @return string[] |
|
| 346 | - */ |
|
| 340 | + /** |
|
| 341 | + * Retrieves the HEX character codes for all control |
|
| 342 | + * characters that the {@link stripControlCharacters()} |
|
| 343 | + * method will remove. |
|
| 344 | + * |
|
| 345 | + * @return string[] |
|
| 346 | + */ |
|
| 347 | 347 | public static function getControlCharactersAsHex() : array |
| 348 | 348 | { |
| 349 | 349 | return self::createControlCharacters()->getCharsAsHex(); |
| 350 | 350 | } |
| 351 | 351 | |
| 352 | - /** |
|
| 353 | - * Retrieves an array of all control characters that |
|
| 354 | - * the {@link stripControlCharacters()} method will |
|
| 355 | - * remove, as the actual UTF-8 characters. |
|
| 356 | - * |
|
| 357 | - * @return string[] |
|
| 358 | - */ |
|
| 352 | + /** |
|
| 353 | + * Retrieves an array of all control characters that |
|
| 354 | + * the {@link stripControlCharacters()} method will |
|
| 355 | + * remove, as the actual UTF-8 characters. |
|
| 356 | + * |
|
| 357 | + * @return string[] |
|
| 358 | + */ |
|
| 359 | 359 | public static function getControlCharactersAsUTF8() : array |
| 360 | 360 | { |
| 361 | 361 | return self::createControlCharacters()->getCharsAsUTF8(); |
| 362 | 362 | } |
| 363 | 363 | |
| 364 | - /** |
|
| 365 | - * Retrieves all control characters as JSON encoded |
|
| 366 | - * characters, e.g. "\u200b". |
|
| 367 | - * |
|
| 368 | - * @return string[] |
|
| 369 | - */ |
|
| 364 | + /** |
|
| 365 | + * Retrieves all control characters as JSON encoded |
|
| 366 | + * characters, e.g. "\u200b". |
|
| 367 | + * |
|
| 368 | + * @return string[] |
|
| 369 | + */ |
|
| 370 | 370 | public static function getControlCharactersAsJSON() : array |
| 371 | 371 | { |
| 372 | 372 | return self::createControlCharacters()->getCharsAsJSON(); |
@@ -387,31 +387,31 @@ discard block |
||
| 387 | 387 | return self::createControlCharacters()->stripControlCharacters($string); |
| 388 | 388 | } |
| 389 | 389 | |
| 390 | - /** |
|
| 391 | - * Creates the control characters class, used to |
|
| 392 | - * work with control characters in strings. |
|
| 393 | - * |
|
| 394 | - * @return ConvertHelper_ControlCharacters |
|
| 395 | - */ |
|
| 390 | + /** |
|
| 391 | + * Creates the control characters class, used to |
|
| 392 | + * work with control characters in strings. |
|
| 393 | + * |
|
| 394 | + * @return ConvertHelper_ControlCharacters |
|
| 395 | + */ |
|
| 396 | 396 | public static function createControlCharacters() : ConvertHelper_ControlCharacters |
| 397 | 397 | { |
| 398 | 398 | return new ConvertHelper_ControlCharacters(); |
| 399 | 399 | } |
| 400 | 400 | |
| 401 | - /** |
|
| 402 | - * Converts a unicode character to the PHP notation. |
|
| 403 | - * |
|
| 404 | - * Example: |
|
| 405 | - * |
|
| 406 | - * <pre>unicodeChar2php('"\u0000"')</pre> |
|
| 407 | - * |
|
| 408 | - * Returns |
|
| 409 | - * |
|
| 410 | - * <pre>\x0</pre> |
|
| 411 | - * |
|
| 412 | - * @param string $unicodeChar |
|
| 413 | - * @return string |
|
| 414 | - */ |
|
| 401 | + /** |
|
| 402 | + * Converts a unicode character to the PHP notation. |
|
| 403 | + * |
|
| 404 | + * Example: |
|
| 405 | + * |
|
| 406 | + * <pre>unicodeChar2php('"\u0000"')</pre> |
|
| 407 | + * |
|
| 408 | + * Returns |
|
| 409 | + * |
|
| 410 | + * <pre>\x0</pre> |
|
| 411 | + * |
|
| 412 | + * @param string $unicodeChar |
|
| 413 | + * @return string |
|
| 414 | + */ |
|
| 415 | 415 | public static function unicodeChar2php(string $unicodeChar) : string |
| 416 | 416 | { |
| 417 | 417 | $unicodeChar = json_decode($unicodeChar); |
@@ -525,138 +525,138 @@ discard block |
||
| 525 | 525 | return ConvertHelper_Bool::toStringStrict($boolean, $yesNo); |
| 526 | 526 | } |
| 527 | 527 | |
| 528 | - /** |
|
| 529 | - * Converts an associative array with attribute name > value pairs |
|
| 530 | - * to an attribute string that can be used in an HTML tag. Empty |
|
| 531 | - * attribute values are ignored. |
|
| 532 | - * |
|
| 533 | - * Example: |
|
| 534 | - * |
|
| 535 | - * array2attributeString(array( |
|
| 536 | - * 'id' => 45, |
|
| 537 | - * 'href' => 'http://www.mistralys.com' |
|
| 538 | - * )); |
|
| 539 | - * |
|
| 540 | - * Result: |
|
| 541 | - * |
|
| 542 | - * id="45" href="http://www.mistralys.com" |
|
| 543 | - * |
|
| 544 | - * @param array<string,mixed> $array |
|
| 545 | - * @return string |
|
| 546 | - */ |
|
| 528 | + /** |
|
| 529 | + * Converts an associative array with attribute name > value pairs |
|
| 530 | + * to an attribute string that can be used in an HTML tag. Empty |
|
| 531 | + * attribute values are ignored. |
|
| 532 | + * |
|
| 533 | + * Example: |
|
| 534 | + * |
|
| 535 | + * array2attributeString(array( |
|
| 536 | + * 'id' => 45, |
|
| 537 | + * 'href' => 'http://www.mistralys.com' |
|
| 538 | + * )); |
|
| 539 | + * |
|
| 540 | + * Result: |
|
| 541 | + * |
|
| 542 | + * id="45" href="http://www.mistralys.com" |
|
| 543 | + * |
|
| 544 | + * @param array<string,mixed> $array |
|
| 545 | + * @return string |
|
| 546 | + */ |
|
| 547 | 547 | public static function array2attributeString(array $array) : string |
| 548 | 548 | { |
| 549 | 549 | return ConvertHelper_Array::toAttributeString($array); |
| 550 | 550 | } |
| 551 | 551 | |
| 552 | - /** |
|
| 553 | - * Converts a string, so it can safely be used in a javascript |
|
| 554 | - * statement in an HTML tag: uses single quotes around the string |
|
| 555 | - * and encodes all special characters as needed. |
|
| 556 | - * |
|
| 557 | - * @param string $string |
|
| 558 | - * @return string |
|
| 559 | - * @deprecated Use the JSHelper class instead. |
|
| 560 | - * @see JSHelper::phpVariable2AttributeJS() |
|
| 561 | - */ |
|
| 552 | + /** |
|
| 553 | + * Converts a string, so it can safely be used in a javascript |
|
| 554 | + * statement in an HTML tag: uses single quotes around the string |
|
| 555 | + * and encodes all special characters as needed. |
|
| 556 | + * |
|
| 557 | + * @param string $string |
|
| 558 | + * @return string |
|
| 559 | + * @deprecated Use the JSHelper class instead. |
|
| 560 | + * @see JSHelper::phpVariable2AttributeJS() |
|
| 561 | + */ |
|
| 562 | 562 | public static function string2attributeJS(string $string) : string |
| 563 | 563 | { |
| 564 | 564 | return JSHelper::phpVariable2AttributeJS($string); |
| 565 | 565 | } |
| 566 | 566 | |
| 567 | - /** |
|
| 568 | - * Checks if the specified string is a boolean value, which |
|
| 569 | - * includes string representations of boolean values, like |
|
| 570 | - * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
| 571 | - * or <code>false</code>. |
|
| 572 | - * |
|
| 573 | - * @param mixed $value |
|
| 574 | - * @return boolean |
|
| 575 | - */ |
|
| 567 | + /** |
|
| 568 | + * Checks if the specified string is a boolean value, which |
|
| 569 | + * includes string representations of boolean values, like |
|
| 570 | + * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
| 571 | + * or <code>false</code>. |
|
| 572 | + * |
|
| 573 | + * @param mixed $value |
|
| 574 | + * @return boolean |
|
| 575 | + */ |
|
| 576 | 576 | public static function isBoolean($value) : bool |
| 577 | 577 | { |
| 578 | 578 | return ConvertHelper_Bool::isBoolean($value); |
| 579 | 579 | } |
| 580 | 580 | |
| 581 | - /** |
|
| 582 | - * Converts an associative array to an HTML style attribute value string. |
|
| 583 | - * |
|
| 584 | - * @param array<string,mixed> $subject |
|
| 585 | - * @return string |
|
| 586 | - */ |
|
| 581 | + /** |
|
| 582 | + * Converts an associative array to an HTML style attribute value string. |
|
| 583 | + * |
|
| 584 | + * @param array<string,mixed> $subject |
|
| 585 | + * @return string |
|
| 586 | + */ |
|
| 587 | 587 | public static function array2styleString(array $subject) : string |
| 588 | 588 | { |
| 589 | 589 | return ConvertHelper_Array::toStyleString($subject); |
| 590 | 590 | } |
| 591 | 591 | |
| 592 | - /** |
|
| 593 | - * Converts a DateTime object to a timestamp, which |
|
| 594 | - * is PHP 5.2 compatible. |
|
| 595 | - * |
|
| 596 | - * @param DateTime $date |
|
| 597 | - * @return integer |
|
| 598 | - */ |
|
| 592 | + /** |
|
| 593 | + * Converts a DateTime object to a timestamp, which |
|
| 594 | + * is PHP 5.2 compatible. |
|
| 595 | + * |
|
| 596 | + * @param DateTime $date |
|
| 597 | + * @return integer |
|
| 598 | + */ |
|
| 599 | 599 | public static function date2timestamp(DateTime $date) : int |
| 600 | 600 | { |
| 601 | 601 | return ConvertHelper_Date::toTimestamp($date); |
| 602 | 602 | } |
| 603 | 603 | |
| 604 | - /** |
|
| 605 | - * Converts a timestamp into a DateTime instance. |
|
| 606 | - * @param int $timestamp |
|
| 607 | - * @return DateTime |
|
| 608 | - */ |
|
| 604 | + /** |
|
| 605 | + * Converts a timestamp into a DateTime instance. |
|
| 606 | + * @param int $timestamp |
|
| 607 | + * @return DateTime |
|
| 608 | + */ |
|
| 609 | 609 | public static function timestamp2date(int $timestamp) : DateTime |
| 610 | 610 | { |
| 611 | 611 | return ConvertHelper_Date::fromTimestamp($timestamp); |
| 612 | 612 | } |
| 613 | 613 | |
| 614 | - /** |
|
| 615 | - * Strips an absolute path to a file within the application |
|
| 616 | - * to make the path relative to the application root path. |
|
| 617 | - * |
|
| 618 | - * @param string $path |
|
| 619 | - * @return string |
|
| 620 | - * |
|
| 621 | - * @see FileHelper::relativizePath() |
|
| 622 | - * @see FileHelper::relativizePathByDepth() |
|
| 623 | - */ |
|
| 614 | + /** |
|
| 615 | + * Strips an absolute path to a file within the application |
|
| 616 | + * to make the path relative to the application root path. |
|
| 617 | + * |
|
| 618 | + * @param string $path |
|
| 619 | + * @return string |
|
| 620 | + * |
|
| 621 | + * @see FileHelper::relativizePath() |
|
| 622 | + * @see FileHelper::relativizePathByDepth() |
|
| 623 | + */ |
|
| 624 | 624 | public static function fileRelativize(string $path) : string |
| 625 | 625 | { |
| 626 | 626 | return FileHelper::relativizePathByDepth($path); |
| 627 | 627 | } |
| 628 | 628 | |
| 629 | 629 | /** |
| 630 | - * Converts a PHP regex to a javascript RegExp object statement. |
|
| 631 | - * |
|
| 632 | - * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
| 633 | - * More details are available on its usage there. |
|
| 634 | - * |
|
| 635 | - * @param string $regex A PHP preg regex |
|
| 636 | - * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
| 637 | - * @return string Depending on the specified return type. |
|
| 638 | - * |
|
| 639 | - * @see JSHelper::buildRegexStatement() |
|
| 640 | - */ |
|
| 630 | + * Converts a PHP regex to a javascript RegExp object statement. |
|
| 631 | + * |
|
| 632 | + * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
| 633 | + * More details are available on its usage there. |
|
| 634 | + * |
|
| 635 | + * @param string $regex A PHP preg regex |
|
| 636 | + * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
| 637 | + * @return string Depending on the specified return type. |
|
| 638 | + * |
|
| 639 | + * @see JSHelper::buildRegexStatement() |
|
| 640 | + */ |
|
| 641 | 641 | public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) : string |
| 642 | 642 | { |
| 643 | 643 | return JSHelper::buildRegexStatement($regex, $statementType); |
| 644 | 644 | } |
| 645 | 645 | |
| 646 | - /** |
|
| 647 | - * Converts the specified variable to JSON. Works just |
|
| 648 | - * like the native `json_encode` method, except that it |
|
| 649 | - * will trigger an exception on failure, which has the |
|
| 650 | - * json error details included in its developer details. |
|
| 651 | - * |
|
| 652 | - * @param mixed $variable |
|
| 653 | - * @param int $options JSON encode options. |
|
| 654 | - * @param int $depth |
|
| 655 | - * @return string |
|
| 656 | - * |
|
| 657 | - * @throws ConvertHelper_Exception |
|
| 658 | - * @see ConvertHelper::ERROR_JSON_ENCODE_FAILED |
|
| 659 | - */ |
|
| 646 | + /** |
|
| 647 | + * Converts the specified variable to JSON. Works just |
|
| 648 | + * like the native `json_encode` method, except that it |
|
| 649 | + * will trigger an exception on failure, which has the |
|
| 650 | + * json error details included in its developer details. |
|
| 651 | + * |
|
| 652 | + * @param mixed $variable |
|
| 653 | + * @param int $options JSON encode options. |
|
| 654 | + * @param int $depth |
|
| 655 | + * @return string |
|
| 656 | + * |
|
| 657 | + * @throws ConvertHelper_Exception |
|
| 658 | + * @see ConvertHelper::ERROR_JSON_ENCODE_FAILED |
|
| 659 | + */ |
|
| 660 | 660 | public static function var2json($variable, int $options=0, int $depth=512) : string |
| 661 | 661 | { |
| 662 | 662 | $result = json_encode($variable, $options, $depth); |
@@ -691,12 +691,12 @@ discard block |
||
| 691 | 691 | ->toString(); |
| 692 | 692 | } |
| 693 | 693 | |
| 694 | - /** |
|
| 695 | - * Strips all known UTF byte order marks from the specified string. |
|
| 696 | - * |
|
| 697 | - * @param string $string |
|
| 698 | - * @return string |
|
| 699 | - */ |
|
| 694 | + /** |
|
| 695 | + * Strips all known UTF byte order marks from the specified string. |
|
| 696 | + * |
|
| 697 | + * @param string $string |
|
| 698 | + * @return string |
|
| 699 | + */ |
|
| 700 | 700 | public static function stripUTFBom(string $string) : string |
| 701 | 701 | { |
| 702 | 702 | $boms = FileHelper::getUTFBOMs(); |
@@ -715,69 +715,69 @@ discard block |
||
| 715 | 715 | return $string; |
| 716 | 716 | } |
| 717 | 717 | |
| 718 | - /** |
|
| 719 | - * Converts a string to valid utf8, regardless |
|
| 720 | - * of the string's encoding(s). |
|
| 721 | - * |
|
| 722 | - * @param string $string |
|
| 723 | - * @return string |
|
| 724 | - */ |
|
| 718 | + /** |
|
| 719 | + * Converts a string to valid utf8, regardless |
|
| 720 | + * of the string's encoding(s). |
|
| 721 | + * |
|
| 722 | + * @param string $string |
|
| 723 | + * @return string |
|
| 724 | + */ |
|
| 725 | 725 | public static function string2utf8(string $string) : string |
| 726 | 726 | { |
| 727 | 727 | return ConvertHelper_String::toUtf8($string); |
| 728 | 728 | } |
| 729 | 729 | |
| 730 | - /** |
|
| 731 | - * Checks whether the specified string is an ASCII |
|
| 732 | - * string, without any special or UTF8 characters. |
|
| 733 | - * Note: empty strings and NULL are considered ASCII. |
|
| 734 | - * Any variable types other than strings are not. |
|
| 735 | - * |
|
| 736 | - * @param string|float|int|NULL $string |
|
| 737 | - * @return boolean |
|
| 738 | - */ |
|
| 730 | + /** |
|
| 731 | + * Checks whether the specified string is an ASCII |
|
| 732 | + * string, without any special or UTF8 characters. |
|
| 733 | + * Note: empty strings and NULL are considered ASCII. |
|
| 734 | + * Any variable types other than strings are not. |
|
| 735 | + * |
|
| 736 | + * @param string|float|int|NULL $string |
|
| 737 | + * @return boolean |
|
| 738 | + */ |
|
| 739 | 739 | public static function isStringASCII($string) : bool |
| 740 | 740 | { |
| 741 | 741 | return ConvertHelper_String::isASCII(strval($string)); |
| 742 | 742 | } |
| 743 | 743 | |
| 744 | - /** |
|
| 745 | - * Adds HTML syntax highlighting to an URL. |
|
| 746 | - * |
|
| 747 | - * NOTE: Includes the necessary CSS styles. When |
|
| 748 | - * highlighting several URLs in the same page, |
|
| 749 | - * prefer using the `parseURL` function instead. |
|
| 750 | - * |
|
| 751 | - * @param string $url |
|
| 752 | - * @return string |
|
| 753 | - * @deprecated Use the Highlighter class directly instead. |
|
| 754 | - * @see Highlighter |
|
| 755 | - */ |
|
| 744 | + /** |
|
| 745 | + * Adds HTML syntax highlighting to an URL. |
|
| 746 | + * |
|
| 747 | + * NOTE: Includes the necessary CSS styles. When |
|
| 748 | + * highlighting several URLs in the same page, |
|
| 749 | + * prefer using the `parseURL` function instead. |
|
| 750 | + * |
|
| 751 | + * @param string $url |
|
| 752 | + * @return string |
|
| 753 | + * @deprecated Use the Highlighter class directly instead. |
|
| 754 | + * @see Highlighter |
|
| 755 | + */ |
|
| 756 | 756 | public static function highlight_url(string $url) : string |
| 757 | 757 | { |
| 758 | 758 | return Highlighter::url($url); |
| 759 | 759 | } |
| 760 | 760 | |
| 761 | - /** |
|
| 762 | - * Calculates a percentage match of the source string with the target string. |
|
| 763 | - * |
|
| 764 | - * Options are: |
|
| 765 | - * |
|
| 766 | - * - maxLevenshtein, default: 10 |
|
| 767 | - * Any levenshtein results above this value are ignored. |
|
| 768 | - * |
|
| 769 | - * - precision, default: 1 |
|
| 770 | - * The precision of the percentage float value |
|
| 771 | - * |
|
| 772 | - * @param string $source |
|
| 773 | - * @param string $target |
|
| 774 | - * @param array<string,mixed> $options |
|
| 775 | - * @return float |
|
| 776 | - * |
|
| 777 | - * @see ConvertHelper_TextComparer |
|
| 778 | - * @see ConvertHelper_TextComparer::OPTION_MAX_LEVENSHTEIN_DISTANCE |
|
| 779 | - * @see ConvertHelper_TextComparer::OPTION_PRECISION |
|
| 780 | - */ |
|
| 761 | + /** |
|
| 762 | + * Calculates a percentage match of the source string with the target string. |
|
| 763 | + * |
|
| 764 | + * Options are: |
|
| 765 | + * |
|
| 766 | + * - maxLevenshtein, default: 10 |
|
| 767 | + * Any levenshtein results above this value are ignored. |
|
| 768 | + * |
|
| 769 | + * - precision, default: 1 |
|
| 770 | + * The precision of the percentage float value |
|
| 771 | + * |
|
| 772 | + * @param string $source |
|
| 773 | + * @param string $target |
|
| 774 | + * @param array<string,mixed> $options |
|
| 775 | + * @return float |
|
| 776 | + * |
|
| 777 | + * @see ConvertHelper_TextComparer |
|
| 778 | + * @see ConvertHelper_TextComparer::OPTION_MAX_LEVENSHTEIN_DISTANCE |
|
| 779 | + * @see ConvertHelper_TextComparer::OPTION_PRECISION |
|
| 780 | + */ |
|
| 781 | 781 | public static function matchString(string $source, string $target, array $options=array()) : float |
| 782 | 782 | { |
| 783 | 783 | return (new ConvertHelper_TextComparer()) |
@@ -785,109 +785,109 @@ discard block |
||
| 785 | 785 | ->match($source, $target); |
| 786 | 786 | } |
| 787 | 787 | |
| 788 | - /** |
|
| 789 | - * Converts a date interval to a human-readable string with |
|
| 790 | - * all necessary time components, e.g. "1 year, 2 months and 4 days". |
|
| 791 | - * |
|
| 792 | - * @param DateInterval $interval |
|
| 793 | - * @return string |
|
| 794 | - * @see ConvertHelper_IntervalConverter |
|
| 795 | - * |
|
| 796 | - * @throws ConvertHelper_Exception |
|
| 797 | - * @see ConvertHelper_IntervalConverter::ERROR_MISSING_TRANSLATION |
|
| 798 | - */ |
|
| 788 | + /** |
|
| 789 | + * Converts a date interval to a human-readable string with |
|
| 790 | + * all necessary time components, e.g. "1 year, 2 months and 4 days". |
|
| 791 | + * |
|
| 792 | + * @param DateInterval $interval |
|
| 793 | + * @return string |
|
| 794 | + * @see ConvertHelper_IntervalConverter |
|
| 795 | + * |
|
| 796 | + * @throws ConvertHelper_Exception |
|
| 797 | + * @see ConvertHelper_IntervalConverter::ERROR_MISSING_TRANSLATION |
|
| 798 | + */ |
|
| 799 | 799 | public static function interval2string(DateInterval $interval) : string |
| 800 | 800 | { |
| 801 | 801 | return (new ConvertHelper_IntervalConverter()) |
| 802 | 802 | ->toString($interval); |
| 803 | 803 | } |
| 804 | 804 | |
| 805 | - /** |
|
| 806 | - * Converts an interval to its total amount of days. |
|
| 807 | - * @param DateInterval $interval |
|
| 808 | - * @return int |
|
| 809 | - */ |
|
| 805 | + /** |
|
| 806 | + * Converts an interval to its total amount of days. |
|
| 807 | + * @param DateInterval $interval |
|
| 808 | + * @return int |
|
| 809 | + */ |
|
| 810 | 810 | public static function interval2days(DateInterval $interval) : int |
| 811 | 811 | { |
| 812 | 812 | return ConvertHelper_DateInterval::toDays($interval); |
| 813 | 813 | } |
| 814 | 814 | |
| 815 | - /** |
|
| 816 | - * Converts an interval to its total amount of hours. |
|
| 817 | - * @param DateInterval $interval |
|
| 818 | - * @return int |
|
| 819 | - */ |
|
| 815 | + /** |
|
| 816 | + * Converts an interval to its total amount of hours. |
|
| 817 | + * @param DateInterval $interval |
|
| 818 | + * @return int |
|
| 819 | + */ |
|
| 820 | 820 | public static function interval2hours(DateInterval $interval) : int |
| 821 | 821 | { |
| 822 | 822 | return ConvertHelper_DateInterval::toHours($interval); |
| 823 | 823 | } |
| 824 | 824 | |
| 825 | - /** |
|
| 826 | - * Converts an interval to its total amount of minutes. |
|
| 827 | - * @param DateInterval $interval |
|
| 828 | - * @return int |
|
| 829 | - */ |
|
| 825 | + /** |
|
| 826 | + * Converts an interval to its total amount of minutes. |
|
| 827 | + * @param DateInterval $interval |
|
| 828 | + * @return int |
|
| 829 | + */ |
|
| 830 | 830 | public static function interval2minutes(DateInterval $interval) : int |
| 831 | 831 | { |
| 832 | 832 | return ConvertHelper_DateInterval::toMinutes($interval); |
| 833 | 833 | } |
| 834 | 834 | |
| 835 | - /** |
|
| 836 | - * Converts an interval to its total amount of seconds. |
|
| 837 | - * @param DateInterval $interval |
|
| 838 | - * @return int |
|
| 839 | - */ |
|
| 835 | + /** |
|
| 836 | + * Converts an interval to its total amount of seconds. |
|
| 837 | + * @param DateInterval $interval |
|
| 838 | + * @return int |
|
| 839 | + */ |
|
| 840 | 840 | public static function interval2seconds(DateInterval $interval) : int |
| 841 | 841 | { |
| 842 | 842 | return ConvertHelper_DateInterval::toSeconds($interval); |
| 843 | 843 | } |
| 844 | 844 | |
| 845 | - /** |
|
| 846 | - * Calculates the total amount of days / hours / minutes or seconds |
|
| 847 | - * of a date interval object (depending on the specified units), and |
|
| 848 | - * returns the total amount. |
|
| 849 | - * |
|
| 850 | - * @param DateInterval $interval |
|
| 851 | - * @param string $unit What total value to calculate. |
|
| 852 | - * @return integer |
|
| 853 | - * |
|
| 854 | - * @see ConvertHelper::INTERVAL_SECONDS |
|
| 855 | - * @see ConvertHelper::INTERVAL_MINUTES |
|
| 856 | - * @see ConvertHelper::INTERVAL_HOURS |
|
| 857 | - * @see ConvertHelper::INTERVAL_DAYS |
|
| 858 | - */ |
|
| 845 | + /** |
|
| 846 | + * Calculates the total amount of days / hours / minutes or seconds |
|
| 847 | + * of a date interval object (depending on the specified units), and |
|
| 848 | + * returns the total amount. |
|
| 849 | + * |
|
| 850 | + * @param DateInterval $interval |
|
| 851 | + * @param string $unit What total value to calculate. |
|
| 852 | + * @return integer |
|
| 853 | + * |
|
| 854 | + * @see ConvertHelper::INTERVAL_SECONDS |
|
| 855 | + * @see ConvertHelper::INTERVAL_MINUTES |
|
| 856 | + * @see ConvertHelper::INTERVAL_HOURS |
|
| 857 | + * @see ConvertHelper::INTERVAL_DAYS |
|
| 858 | + */ |
|
| 859 | 859 | public static function interval2total(DateInterval $interval, string $unit=self::INTERVAL_SECONDS) : int |
| 860 | 860 | { |
| 861 | 861 | return ConvertHelper_DateInterval::toTotal($interval, $unit); |
| 862 | 862 | } |
| 863 | 863 | |
| 864 | - /** |
|
| 865 | - * Converts a date to the corresponding day name. |
|
| 866 | - * |
|
| 867 | - * @param DateTime $date |
|
| 868 | - * @param bool $short |
|
| 869 | - * @return string|NULL |
|
| 870 | - */ |
|
| 864 | + /** |
|
| 865 | + * Converts a date to the corresponding day name. |
|
| 866 | + * |
|
| 867 | + * @param DateTime $date |
|
| 868 | + * @param bool $short |
|
| 869 | + * @return string|NULL |
|
| 870 | + */ |
|
| 871 | 871 | public static function date2dayName(DateTime $date, bool $short=false) : ?string |
| 872 | 872 | { |
| 873 | 873 | return ConvertHelper_Date::toDayName($date, $short); |
| 874 | 874 | } |
| 875 | 875 | |
| 876 | - /** |
|
| 877 | - * Retrieves a list of english day names. |
|
| 878 | - * @return string[] |
|
| 879 | - */ |
|
| 876 | + /** |
|
| 877 | + * Retrieves a list of english day names. |
|
| 878 | + * @return string[] |
|
| 879 | + */ |
|
| 880 | 880 | public static function getDayNamesInvariant() : array |
| 881 | 881 | { |
| 882 | 882 | return ConvertHelper_Date::getDayNamesInvariant(); |
| 883 | 883 | } |
| 884 | 884 | |
| 885 | - /** |
|
| 886 | - * Retrieves the day names list for the current locale. |
|
| 887 | - * |
|
| 888 | - * @param bool $short |
|
| 889 | - * @return string[] |
|
| 890 | - */ |
|
| 885 | + /** |
|
| 886 | + * Retrieves the day names list for the current locale. |
|
| 887 | + * |
|
| 888 | + * @param bool $short |
|
| 889 | + * @return string[] |
|
| 890 | + */ |
|
| 891 | 891 | public static function getDayNames(bool $short=false) : array |
| 892 | 892 | { |
| 893 | 893 | return ConvertHelper_Date::getDayNames($short); |
@@ -906,68 +906,68 @@ discard block |
||
| 906 | 906 | return ConvertHelper_Array::implodeWithAnd($list, $sep, $conjunction); |
| 907 | 907 | } |
| 908 | 908 | |
| 909 | - /** |
|
| 910 | - * Splits a string into an array of all characters it is composed of. |
|
| 911 | - * Unicode character safe. |
|
| 912 | - * |
|
| 913 | - * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
| 914 | - * characters. |
|
| 915 | - * |
|
| 916 | - * @param string $string |
|
| 917 | - * @return string[] |
|
| 918 | - */ |
|
| 909 | + /** |
|
| 910 | + * Splits a string into an array of all characters it is composed of. |
|
| 911 | + * Unicode character safe. |
|
| 912 | + * |
|
| 913 | + * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
| 914 | + * characters. |
|
| 915 | + * |
|
| 916 | + * @param string $string |
|
| 917 | + * @return string[] |
|
| 918 | + */ |
|
| 919 | 919 | public static function string2array(string $string) : array |
| 920 | 920 | { |
| 921 | 921 | return ConvertHelper_String::toArray($string); |
| 922 | 922 | } |
| 923 | 923 | |
| 924 | - /** |
|
| 925 | - * Checks whether the specified string contains HTML code. |
|
| 926 | - * |
|
| 927 | - * @param string $string |
|
| 928 | - * @return boolean |
|
| 929 | - */ |
|
| 924 | + /** |
|
| 925 | + * Checks whether the specified string contains HTML code. |
|
| 926 | + * |
|
| 927 | + * @param string $string |
|
| 928 | + * @return boolean |
|
| 929 | + */ |
|
| 930 | 930 | public static function isStringHTML(string $string) : bool |
| 931 | 931 | { |
| 932 | 932 | return ConvertHelper_String::isHTML($string); |
| 933 | 933 | } |
| 934 | 934 | |
| 935 | - /** |
|
| 936 | - * UTF8-safe wordwrap method: works like the regular wordwrap |
|
| 937 | - * PHP function but compatible with UTF8. Otherwise the lengths |
|
| 938 | - * are not calculated correctly. |
|
| 939 | - * |
|
| 940 | - * @param string $str |
|
| 941 | - * @param int $width |
|
| 942 | - * @param string $break |
|
| 943 | - * @param bool $cut |
|
| 944 | - * @return string |
|
| 945 | - */ |
|
| 935 | + /** |
|
| 936 | + * UTF8-safe wordwrap method: works like the regular wordwrap |
|
| 937 | + * PHP function but compatible with UTF8. Otherwise the lengths |
|
| 938 | + * are not calculated correctly. |
|
| 939 | + * |
|
| 940 | + * @param string $str |
|
| 941 | + * @param int $width |
|
| 942 | + * @param string $break |
|
| 943 | + * @param bool $cut |
|
| 944 | + * @return string |
|
| 945 | + */ |
|
| 946 | 946 | public static function wordwrap(string $str, int $width = 75, string $break = "\n", bool $cut = false) : string |
| 947 | 947 | { |
| 948 | 948 | return ConvertHelper_String::wordwrap($str, $width, $break, $cut); |
| 949 | 949 | } |
| 950 | 950 | |
| 951 | - /** |
|
| 952 | - * Calculates the byte length of a string, taking into |
|
| 953 | - * account any unicode characters. |
|
| 954 | - * |
|
| 955 | - * @param string $string |
|
| 956 | - * @return int |
|
| 957 | - */ |
|
| 951 | + /** |
|
| 952 | + * Calculates the byte length of a string, taking into |
|
| 953 | + * account any unicode characters. |
|
| 954 | + * |
|
| 955 | + * @param string $string |
|
| 956 | + * @return int |
|
| 957 | + */ |
|
| 958 | 958 | public static function string2bytes(string $string): int |
| 959 | 959 | { |
| 960 | 960 | return ConvertHelper_String::toBytes($string); |
| 961 | 961 | } |
| 962 | 962 | |
| 963 | - /** |
|
| 964 | - * Creates a short, 8-character long hash for the specified string. |
|
| 965 | - * |
|
| 966 | - * WARNING: Not cryptographically safe. |
|
| 967 | - * |
|
| 968 | - * @param string $string |
|
| 969 | - * @return string |
|
| 970 | - */ |
|
| 963 | + /** |
|
| 964 | + * Creates a short, 8-character long hash for the specified string. |
|
| 965 | + * |
|
| 966 | + * WARNING: Not cryptographically safe. |
|
| 967 | + * |
|
| 968 | + * @param string $string |
|
| 969 | + * @return string |
|
| 970 | + */ |
|
| 971 | 971 | public static function string2shortHash(string $string) : string |
| 972 | 972 | { |
| 973 | 973 | return ConvertHelper_String::toShortHash($string); |
@@ -1013,88 +1013,88 @@ discard block |
||
| 1013 | 1013 | return ConvertHelper_ThrowableInfo::fromThrowable($e); |
| 1014 | 1014 | } |
| 1015 | 1015 | |
| 1016 | - /** |
|
| 1017 | - * Parses the specified query string like the native |
|
| 1018 | - * function <code>parse_str</code>, without the key |
|
| 1019 | - * naming limitations. |
|
| 1020 | - * |
|
| 1021 | - * Using parse_str, dots or spaces in key names are |
|
| 1022 | - * replaced by underscores. This method keeps all names |
|
| 1023 | - * intact. |
|
| 1024 | - * |
|
| 1025 | - * It still uses the parse_str implementation as it |
|
| 1026 | - * is tested and tried, but fixes the parameter names |
|
| 1027 | - * after parsing, as needed. |
|
| 1028 | - * |
|
| 1029 | - * @param string $queryString |
|
| 1030 | - * @return array<string,string> |
|
| 1031 | - * @see ConvertHelper_QueryParser |
|
| 1032 | - */ |
|
| 1016 | + /** |
|
| 1017 | + * Parses the specified query string like the native |
|
| 1018 | + * function <code>parse_str</code>, without the key |
|
| 1019 | + * naming limitations. |
|
| 1020 | + * |
|
| 1021 | + * Using parse_str, dots or spaces in key names are |
|
| 1022 | + * replaced by underscores. This method keeps all names |
|
| 1023 | + * intact. |
|
| 1024 | + * |
|
| 1025 | + * It still uses the parse_str implementation as it |
|
| 1026 | + * is tested and tried, but fixes the parameter names |
|
| 1027 | + * after parsing, as needed. |
|
| 1028 | + * |
|
| 1029 | + * @param string $queryString |
|
| 1030 | + * @return array<string,string> |
|
| 1031 | + * @see ConvertHelper_QueryParser |
|
| 1032 | + */ |
|
| 1033 | 1033 | public static function parseQueryString(string $queryString) : array |
| 1034 | 1034 | { |
| 1035 | 1035 | $parser = new ConvertHelper_QueryParser(); |
| 1036 | 1036 | return $parser->parse($queryString); |
| 1037 | 1037 | } |
| 1038 | 1038 | |
| 1039 | - /** |
|
| 1040 | - * Searches for needle in the specified string, and returns a list |
|
| 1041 | - * of all occurrences, including the matched string. The matched |
|
| 1042 | - * string is useful when doing a case-insensitive search, as it |
|
| 1043 | - * shows the exact matched case of needle. |
|
| 1044 | - * |
|
| 1045 | - * @param string $needle |
|
| 1046 | - * @param string $haystack |
|
| 1047 | - * @param bool $caseInsensitive |
|
| 1048 | - * @return ConvertHelper_StringMatch[] |
|
| 1049 | - */ |
|
| 1039 | + /** |
|
| 1040 | + * Searches for needle in the specified string, and returns a list |
|
| 1041 | + * of all occurrences, including the matched string. The matched |
|
| 1042 | + * string is useful when doing a case-insensitive search, as it |
|
| 1043 | + * shows the exact matched case of needle. |
|
| 1044 | + * |
|
| 1045 | + * @param string $needle |
|
| 1046 | + * @param string $haystack |
|
| 1047 | + * @param bool $caseInsensitive |
|
| 1048 | + * @return ConvertHelper_StringMatch[] |
|
| 1049 | + */ |
|
| 1050 | 1050 | public static function findString(string $needle, string $haystack, bool $caseInsensitive=false): array |
| 1051 | 1051 | { |
| 1052 | 1052 | return ConvertHelper_String::findString($needle, $haystack, $caseInsensitive); |
| 1053 | 1053 | } |
| 1054 | 1054 | |
| 1055 | - /** |
|
| 1056 | - * Like explode, but trims all entries, and removes |
|
| 1057 | - * empty entries from the resulting array. |
|
| 1058 | - * |
|
| 1059 | - * @param string $delimiter |
|
| 1060 | - * @param string $string |
|
| 1061 | - * @return string[] |
|
| 1062 | - */ |
|
| 1055 | + /** |
|
| 1056 | + * Like explode, but trims all entries, and removes |
|
| 1057 | + * empty entries from the resulting array. |
|
| 1058 | + * |
|
| 1059 | + * @param string $delimiter |
|
| 1060 | + * @param string $string |
|
| 1061 | + * @return string[] |
|
| 1062 | + */ |
|
| 1063 | 1063 | public static function explodeTrim(string $delimiter, string $string) : array |
| 1064 | 1064 | { |
| 1065 | 1065 | return ConvertHelper_String::explodeTrim($delimiter, $string); |
| 1066 | 1066 | } |
| 1067 | 1067 | |
| 1068 | - /** |
|
| 1069 | - * Detects the most used end-of-line character in the subject string. |
|
| 1070 | - * |
|
| 1071 | - * @param string $subjectString The string to check. |
|
| 1072 | - * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
| 1073 | - */ |
|
| 1068 | + /** |
|
| 1069 | + * Detects the most used end-of-line character in the subject string. |
|
| 1070 | + * |
|
| 1071 | + * @param string $subjectString The string to check. |
|
| 1072 | + * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
| 1073 | + */ |
|
| 1074 | 1074 | public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL |
| 1075 | 1075 | { |
| 1076 | 1076 | return ConvertHelper_EOL::detect($subjectString); |
| 1077 | 1077 | } |
| 1078 | 1078 | |
| 1079 | - /** |
|
| 1080 | - * Removes the specified keys from the target array, |
|
| 1081 | - * if they exist. |
|
| 1082 | - * |
|
| 1083 | - * @param array<string|int,mixed> $array |
|
| 1084 | - * @param string[] $keys |
|
| 1085 | - */ |
|
| 1079 | + /** |
|
| 1080 | + * Removes the specified keys from the target array, |
|
| 1081 | + * if they exist. |
|
| 1082 | + * |
|
| 1083 | + * @param array<string|int,mixed> $array |
|
| 1084 | + * @param string[] $keys |
|
| 1085 | + */ |
|
| 1086 | 1086 | public static function arrayRemoveKeys(array &$array, array $keys) : void |
| 1087 | 1087 | { |
| 1088 | 1088 | ConvertHelper_Array::removeKeys($array, $keys); |
| 1089 | 1089 | } |
| 1090 | 1090 | |
| 1091 | - /** |
|
| 1092 | - * Checks if the specified variable is an integer or a string containing an integer. |
|
| 1093 | - * Accepts both positive and negative integers. |
|
| 1094 | - * |
|
| 1095 | - * @param mixed $value |
|
| 1096 | - * @return bool |
|
| 1097 | - */ |
|
| 1091 | + /** |
|
| 1092 | + * Checks if the specified variable is an integer or a string containing an integer. |
|
| 1093 | + * Accepts both positive and negative integers. |
|
| 1094 | + * |
|
| 1095 | + * @param mixed $value |
|
| 1096 | + * @return bool |
|
| 1097 | + */ |
|
| 1098 | 1098 | public static function isInteger($value) : bool |
| 1099 | 1099 | { |
| 1100 | 1100 | if(is_int($value)) { |
@@ -1114,52 +1114,52 @@ discard block |
||
| 1114 | 1114 | return false; |
| 1115 | 1115 | } |
| 1116 | 1116 | |
| 1117 | - /** |
|
| 1118 | - * Converts an amount of seconds to a DateInterval object. |
|
| 1119 | - * |
|
| 1120 | - * @param int $seconds |
|
| 1121 | - * @return DateInterval |
|
| 1122 | - * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
| 1123 | - * |
|
| 1124 | - * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
| 1125 | - */ |
|
| 1117 | + /** |
|
| 1118 | + * Converts an amount of seconds to a DateInterval object. |
|
| 1119 | + * |
|
| 1120 | + * @param int $seconds |
|
| 1121 | + * @return DateInterval |
|
| 1122 | + * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
| 1123 | + * |
|
| 1124 | + * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
| 1125 | + */ |
|
| 1126 | 1126 | public static function seconds2interval(int $seconds) : DateInterval |
| 1127 | 1127 | { |
| 1128 | 1128 | return ConvertHelper_DateInterval::fromSeconds($seconds)->getInterval(); |
| 1129 | 1129 | } |
| 1130 | 1130 | |
| 1131 | - /** |
|
| 1132 | - * Converts a size string like "50 MB" to the corresponding byte size. |
|
| 1133 | - * It is case-insensitive, ignores spaces, and supports both traditional |
|
| 1134 | - * "MB" and "MiB" notations. |
|
| 1135 | - * |
|
| 1136 | - * @param string $size |
|
| 1137 | - * @return int |
|
| 1138 | - */ |
|
| 1131 | + /** |
|
| 1132 | + * Converts a size string like "50 MB" to the corresponding byte size. |
|
| 1133 | + * It is case-insensitive, ignores spaces, and supports both traditional |
|
| 1134 | + * "MB" and "MiB" notations. |
|
| 1135 | + * |
|
| 1136 | + * @param string $size |
|
| 1137 | + * @return int |
|
| 1138 | + */ |
|
| 1139 | 1139 | public static function size2bytes(string $size) : int |
| 1140 | 1140 | { |
| 1141 | 1141 | return self::parseSize($size)->toBytes(); |
| 1142 | 1142 | } |
| 1143 | 1143 | |
| 1144 | - /** |
|
| 1145 | - * Parses a size string like "50 MB" and returns a size notation instance |
|
| 1146 | - * that has utility methods to access information on it, and convert it. |
|
| 1147 | - * |
|
| 1148 | - * @param string $size |
|
| 1149 | - * @return ConvertHelper_SizeNotation |
|
| 1150 | - */ |
|
| 1144 | + /** |
|
| 1145 | + * Parses a size string like "50 MB" and returns a size notation instance |
|
| 1146 | + * that has utility methods to access information on it, and convert it. |
|
| 1147 | + * |
|
| 1148 | + * @param string $size |
|
| 1149 | + * @return ConvertHelper_SizeNotation |
|
| 1150 | + */ |
|
| 1151 | 1151 | public static function parseSize(string $size) : ConvertHelper_SizeNotation |
| 1152 | 1152 | { |
| 1153 | 1153 | return new ConvertHelper_SizeNotation($size); |
| 1154 | 1154 | } |
| 1155 | 1155 | |
| 1156 | - /** |
|
| 1157 | - * Creates a URL finder instance, which can be used to find |
|
| 1158 | - * URLs in a string - be it plain text, or HTML. |
|
| 1159 | - * |
|
| 1160 | - * @param string $subject |
|
| 1161 | - * @return ConvertHelper_URLFinder |
|
| 1162 | - */ |
|
| 1156 | + /** |
|
| 1157 | + * Creates a URL finder instance, which can be used to find |
|
| 1158 | + * URLs in a string - be it plain text, or HTML. |
|
| 1159 | + * |
|
| 1160 | + * @param string $subject |
|
| 1161 | + * @return ConvertHelper_URLFinder |
|
| 1162 | + */ |
|
| 1163 | 1163 | public static function createURLFinder(string $subject) : ConvertHelper_URLFinder |
| 1164 | 1164 | { |
| 1165 | 1165 | return new ConvertHelper_URLFinder($subject); |
@@ -55,7 +55,7 @@ discard block |
||
| 55 | 55 | * @param int $tabSize The amount of spaces per tab. |
| 56 | 56 | * @return string |
| 57 | 57 | */ |
| 58 | - public static function tabs2spaces(string $string, int $tabSize=4) : string |
|
| 58 | + public static function tabs2spaces(string $string, int $tabSize = 4) : string |
|
| 59 | 59 | { |
| 60 | 60 | return ConvertHelper_String::tabs2spaces($string, $tabSize); |
| 61 | 61 | } |
@@ -67,7 +67,7 @@ discard block |
||
| 67 | 67 | * @param int $tabSize The amount of spaces per tab in the source string. |
| 68 | 68 | * @return string |
| 69 | 69 | */ |
| 70 | - public static function spaces2tabs(string $string, int $tabSize=4) : string |
|
| 70 | + public static function spaces2tabs(string $string, int $tabSize = 4) : string |
|
| 71 | 71 | { |
| 72 | 72 | return ConvertHelper_String::spaces2tabs($string, $tabSize); |
| 73 | 73 | } |
@@ -140,7 +140,7 @@ discard block |
||
| 140 | 140 | * @deprecated Use the Highlighter class directly instead. |
| 141 | 141 | * @see Highlighter::xml() |
| 142 | 142 | */ |
| 143 | - public static function highlight_xml(string $xml, bool $formatSource=false) : string |
|
| 143 | + public static function highlight_xml(string $xml, bool $formatSource = false) : string |
|
| 144 | 144 | { |
| 145 | 145 | return Highlighter::xml($xml, $formatSource); |
| 146 | 146 | } |
@@ -206,11 +206,11 @@ discard block |
||
| 206 | 206 | * @param bool $html |
| 207 | 207 | * @return string |
| 208 | 208 | */ |
| 209 | - public static function var_dump($var, bool $html=true) : string |
|
| 209 | + public static function var_dump($var, bool $html = true) : string |
|
| 210 | 210 | { |
| 211 | 211 | $info = parseVariable($var); |
| 212 | 212 | |
| 213 | - if($html) { |
|
| 213 | + if ($html) { |
|
| 214 | 214 | return $info->toHTML(); |
| 215 | 215 | } |
| 216 | 216 | |
@@ -225,11 +225,11 @@ discard block |
||
| 225 | 225 | * @param bool $html Whether to style the dump as HTML. |
| 226 | 226 | * @return string |
| 227 | 227 | */ |
| 228 | - public static function print_r($var, bool $return=false, bool $html=true) : string |
|
| 228 | + public static function print_r($var, bool $return = false, bool $html = true) : string |
|
| 229 | 229 | { |
| 230 | 230 | $result = parseVariable($var)->enableType()->toString(); |
| 231 | 231 | |
| 232 | - if($html) |
|
| 232 | + if ($html) |
|
| 233 | 233 | { |
| 234 | 234 | $result = |
| 235 | 235 | '<pre style="background:#fff;color:#333;padding:16px;border:solid 1px #bbb;border-radius:4px">'. |
@@ -237,7 +237,7 @@ discard block |
||
| 237 | 237 | '</pre>'; |
| 238 | 238 | } |
| 239 | 239 | |
| 240 | - if(!$return) |
|
| 240 | + if (!$return) |
|
| 241 | 241 | { |
| 242 | 242 | echo $result; |
| 243 | 243 | } |
@@ -419,12 +419,12 @@ discard block |
||
| 419 | 419 | $output = ''; |
| 420 | 420 | $split = str_split($unicodeChar); |
| 421 | 421 | |
| 422 | - foreach($split as $octet) |
|
| 422 | + foreach ($split as $octet) |
|
| 423 | 423 | { |
| 424 | 424 | $ordInt = ord($octet); |
| 425 | 425 | // Convert from int (base 10) to hex (base 16), for PHP \x syntax |
| 426 | 426 | $ordHex = base_convert((string)$ordInt, 10, 16); |
| 427 | - $output .= '\x' . $ordHex; |
|
| 427 | + $output .= '\x'.$ordHex; |
|
| 428 | 428 | } |
| 429 | 429 | |
| 430 | 430 | return $output; |
@@ -638,7 +638,7 @@ discard block |
||
| 638 | 638 | * |
| 639 | 639 | * @see JSHelper::buildRegexStatement() |
| 640 | 640 | */ |
| 641 | - public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) : string |
|
| 641 | + public static function regex2js(string $regex, string $statementType = JSHelper::JS_REGEX_OBJECT) : string |
|
| 642 | 642 | { |
| 643 | 643 | return JSHelper::buildRegexStatement($regex, $statementType); |
| 644 | 644 | } |
@@ -657,11 +657,11 @@ discard block |
||
| 657 | 657 | * @throws ConvertHelper_Exception |
| 658 | 658 | * @see ConvertHelper::ERROR_JSON_ENCODE_FAILED |
| 659 | 659 | */ |
| 660 | - public static function var2json($variable, int $options=0, int $depth=512) : string |
|
| 660 | + public static function var2json($variable, int $options = 0, int $depth = 512) : string |
|
| 661 | 661 | { |
| 662 | 662 | $result = json_encode($variable, $options, $depth); |
| 663 | 663 | |
| 664 | - if($result !== false) { |
|
| 664 | + if ($result !== false) { |
|
| 665 | 665 | return $result; |
| 666 | 666 | } |
| 667 | 667 | |
@@ -701,12 +701,12 @@ discard block |
||
| 701 | 701 | { |
| 702 | 702 | $boms = FileHelper::getUTFBOMs(); |
| 703 | 703 | |
| 704 | - foreach($boms as $bomChars) |
|
| 704 | + foreach ($boms as $bomChars) |
|
| 705 | 705 | { |
| 706 | 706 | $length = mb_strlen($bomChars); |
| 707 | 707 | $text = mb_substr($string, 0, $length); |
| 708 | 708 | |
| 709 | - if($text===$bomChars) |
|
| 709 | + if ($text === $bomChars) |
|
| 710 | 710 | { |
| 711 | 711 | return mb_substr($string, $length); |
| 712 | 712 | } |
@@ -778,7 +778,7 @@ discard block |
||
| 778 | 778 | * @see ConvertHelper_TextComparer::OPTION_MAX_LEVENSHTEIN_DISTANCE |
| 779 | 779 | * @see ConvertHelper_TextComparer::OPTION_PRECISION |
| 780 | 780 | */ |
| 781 | - public static function matchString(string $source, string $target, array $options=array()) : float |
|
| 781 | + public static function matchString(string $source, string $target, array $options = array()) : float |
|
| 782 | 782 | { |
| 783 | 783 | return (new ConvertHelper_TextComparer()) |
| 784 | 784 | ->setOptions($options) |
@@ -856,7 +856,7 @@ discard block |
||
| 856 | 856 | * @see ConvertHelper::INTERVAL_HOURS |
| 857 | 857 | * @see ConvertHelper::INTERVAL_DAYS |
| 858 | 858 | */ |
| 859 | - public static function interval2total(DateInterval $interval, string $unit=self::INTERVAL_SECONDS) : int |
|
| 859 | + public static function interval2total(DateInterval $interval, string $unit = self::INTERVAL_SECONDS) : int |
|
| 860 | 860 | { |
| 861 | 861 | return ConvertHelper_DateInterval::toTotal($interval, $unit); |
| 862 | 862 | } |
@@ -868,7 +868,7 @@ discard block |
||
| 868 | 868 | * @param bool $short |
| 869 | 869 | * @return string|NULL |
| 870 | 870 | */ |
| 871 | - public static function date2dayName(DateTime $date, bool $short=false) : ?string |
|
| 871 | + public static function date2dayName(DateTime $date, bool $short = false) : ?string |
|
| 872 | 872 | { |
| 873 | 873 | return ConvertHelper_Date::toDayName($date, $short); |
| 874 | 874 | } |
@@ -888,7 +888,7 @@ discard block |
||
| 888 | 888 | * @param bool $short |
| 889 | 889 | * @return string[] |
| 890 | 890 | */ |
| 891 | - public static function getDayNames(bool $short=false) : array |
|
| 891 | + public static function getDayNames(bool $short = false) : array |
|
| 892 | 892 | { |
| 893 | 893 | return ConvertHelper_Date::getDayNames($short); |
| 894 | 894 | } |
@@ -1047,7 +1047,7 @@ discard block |
||
| 1047 | 1047 | * @param bool $caseInsensitive |
| 1048 | 1048 | * @return ConvertHelper_StringMatch[] |
| 1049 | 1049 | */ |
| 1050 | - public static function findString(string $needle, string $haystack, bool $caseInsensitive=false): array |
|
| 1050 | + public static function findString(string $needle, string $haystack, bool $caseInsensitive = false): array |
|
| 1051 | 1051 | { |
| 1052 | 1052 | return ConvertHelper_String::findString($needle, $haystack, $caseInsensitive); |
| 1053 | 1053 | } |
@@ -1097,17 +1097,17 @@ discard block |
||
| 1097 | 1097 | */ |
| 1098 | 1098 | public static function isInteger($value) : bool |
| 1099 | 1099 | { |
| 1100 | - if(is_int($value)) { |
|
| 1100 | + if (is_int($value)) { |
|
| 1101 | 1101 | return true; |
| 1102 | 1102 | } |
| 1103 | 1103 | |
| 1104 | 1104 | // booleans get converted to numbers, so they would |
| 1105 | 1105 | // actually match the regex. |
| 1106 | - if(is_bool($value)) { |
|
| 1106 | + if (is_bool($value)) { |
|
| 1107 | 1107 | return false; |
| 1108 | 1108 | } |
| 1109 | 1109 | |
| 1110 | - if(is_string($value) && $value !== '') { |
|
| 1110 | + if (is_string($value) && $value !== '') { |
|
| 1111 | 1111 | return preg_match('/\A-?\d+\z/', $value) === 1; |
| 1112 | 1112 | } |
| 1113 | 1113 | |
@@ -1173,7 +1173,7 @@ discard block |
||
| 1173 | 1173 | * @param bool $keepKeys |
| 1174 | 1174 | * @return array<number|string,mixed> |
| 1175 | 1175 | */ |
| 1176 | - public static function arrayRemoveValues(array $sourceArray, array $values, bool $keepKeys=false) : array |
|
| 1176 | + public static function arrayRemoveValues(array $sourceArray, array $values, bool $keepKeys = false) : array |
|
| 1177 | 1177 | { |
| 1178 | 1178 | return ConvertHelper_Array::removeValues($sourceArray, $values, $keepKeys); |
| 1179 | 1179 | } |