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