@@ -23,19 +23,19 @@ discard block |
||
23 | 23 | */ |
24 | 24 | class ConvertHelper_TimeConverter |
25 | 25 | { |
26 | - /** |
|
27 | - * @var float |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var float |
|
28 | + */ |
|
29 | 29 | private $seconds; |
30 | 30 | |
31 | - /** |
|
32 | - * @var array<int,array<string,string|int>> |
|
33 | - */ |
|
31 | + /** |
|
32 | + * @var array<int,array<string,string|int>> |
|
33 | + */ |
|
34 | 34 | private static $units; |
35 | 35 | |
36 | - /** |
|
37 | - * @param float $seconds |
|
38 | - */ |
|
36 | + /** |
|
37 | + * @param float $seconds |
|
38 | + */ |
|
39 | 39 | public function __construct($seconds) |
40 | 40 | { |
41 | 41 | $this->seconds = $seconds; |
@@ -43,9 +43,9 @@ discard block |
||
43 | 43 | $this->initUnits(); |
44 | 44 | } |
45 | 45 | |
46 | - /** |
|
47 | - * Creates the list of units once per request as needed. |
|
48 | - */ |
|
46 | + /** |
|
47 | + * Creates the list of units once per request as needed. |
|
48 | + */ |
|
49 | 49 | private function initUnits() : void |
50 | 50 | { |
51 | 51 | if(isset(self::$units)) |
@@ -112,11 +112,11 @@ discard block |
||
112 | 112 | return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last; |
113 | 113 | } |
114 | 114 | |
115 | - /** |
|
116 | - * Resolves the list of converted units. |
|
117 | - * |
|
118 | - * @return string[] |
|
119 | - */ |
|
115 | + /** |
|
116 | + * Resolves the list of converted units. |
|
117 | + * |
|
118 | + * @return string[] |
|
119 | + */ |
|
120 | 120 | private function resolveTokens() : array |
121 | 121 | { |
122 | 122 | $seconds = $this->seconds; |
@@ -48,7 +48,7 @@ discard block |
||
48 | 48 | */ |
49 | 49 | private function initUnits() : void |
50 | 50 | { |
51 | - if(isset(self::$units)) |
|
51 | + if (isset(self::$units)) |
|
52 | 52 | { |
53 | 53 | return; |
54 | 54 | } |
@@ -90,12 +90,12 @@ discard block |
||
90 | 90 | public function toString() : string |
91 | 91 | { |
92 | 92 | // specifically handle zero |
93 | - if($this->seconds <= 0) |
|
93 | + if ($this->seconds <= 0) |
|
94 | 94 | { |
95 | - return '0 ' . t('seconds'); |
|
95 | + return '0 '.t('seconds'); |
|
96 | 96 | } |
97 | 97 | |
98 | - if($this->seconds < 1) |
|
98 | + if ($this->seconds < 1) |
|
99 | 99 | { |
100 | 100 | return t('less than a second'); |
101 | 101 | } |
@@ -104,12 +104,12 @@ discard block |
||
104 | 104 | |
105 | 105 | $last = array_pop($tokens); |
106 | 106 | |
107 | - if(empty($tokens)) |
|
107 | + if (empty($tokens)) |
|
108 | 108 | { |
109 | 109 | return $last; |
110 | 110 | } |
111 | 111 | |
112 | - return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last; |
|
112 | + return implode(', ', $tokens).' '.t('and').' '.$last; |
|
113 | 113 | } |
114 | 114 | |
115 | 115 | /** |
@@ -122,18 +122,18 @@ discard block |
||
122 | 122 | $seconds = $this->seconds; |
123 | 123 | $tokens = array(); |
124 | 124 | |
125 | - foreach(self::$units as $def) |
|
125 | + foreach (self::$units as $def) |
|
126 | 126 | { |
127 | 127 | $unitValue = intval($seconds / $def['value']); |
128 | 128 | |
129 | - if($unitValue <= 0) |
|
129 | + if ($unitValue <= 0) |
|
130 | 130 | { |
131 | 131 | continue; |
132 | 132 | } |
133 | 133 | |
134 | - $item = strval($unitValue) . ' '; |
|
134 | + $item = strval($unitValue).' '; |
|
135 | 135 | |
136 | - if(abs($unitValue) > 1) |
|
136 | + if (abs($unitValue) > 1) |
|
137 | 137 | { |
138 | 138 | $item .= $def['plural']; |
139 | 139 | } |
@@ -136,8 +136,7 @@ |
||
136 | 136 | if(abs($unitValue) > 1) |
137 | 137 | { |
138 | 138 | $item .= $def['plural']; |
139 | - } |
|
140 | - else |
|
139 | + } else |
|
141 | 140 | { |
142 | 141 | $item .= $def['singular']; |
143 | 142 | } |
@@ -77,7 +77,7 @@ discard block |
||
77 | 77 | 'fragment' |
78 | 78 | ); |
79 | 79 | |
80 | - foreach($parts as $part) |
|
80 | + foreach ($parts as $part) |
|
81 | 81 | { |
82 | 82 | $method = 'render_'.$part; |
83 | 83 | $result[] = (string)$this->$method(); |
@@ -88,7 +88,7 @@ discard block |
||
88 | 88 | |
89 | 89 | protected function render_scheme() : string |
90 | 90 | { |
91 | - if(!$this->info->hasScheme()) { |
|
91 | + if (!$this->info->hasScheme()) { |
|
92 | 92 | return ''; |
93 | 93 | } |
94 | 94 | |
@@ -103,7 +103,7 @@ discard block |
||
103 | 103 | |
104 | 104 | protected function render_username() : string |
105 | 105 | { |
106 | - if(!$this->info->hasUsername()) { |
|
106 | + if (!$this->info->hasUsername()) { |
|
107 | 107 | return ''; |
108 | 108 | } |
109 | 109 | |
@@ -119,7 +119,7 @@ discard block |
||
119 | 119 | |
120 | 120 | protected function render_host() : string |
121 | 121 | { |
122 | - if(!$this->info->hasHost()) { |
|
122 | + if (!$this->info->hasHost()) { |
|
123 | 123 | return ''; |
124 | 124 | } |
125 | 125 | |
@@ -131,7 +131,7 @@ discard block |
||
131 | 131 | |
132 | 132 | protected function render_port() : string |
133 | 133 | { |
134 | - if(!$this->info->hasPort()) { |
|
134 | + if (!$this->info->hasPort()) { |
|
135 | 135 | return ''; |
136 | 136 | } |
137 | 137 | |
@@ -144,7 +144,7 @@ discard block |
||
144 | 144 | |
145 | 145 | protected function render_path() : string |
146 | 146 | { |
147 | - if(!$this->info->hasPath()) { |
|
147 | + if (!$this->info->hasPath()) { |
|
148 | 148 | return ''; |
149 | 149 | } |
150 | 150 | |
@@ -169,7 +169,7 @@ discard block |
||
169 | 169 | { |
170 | 170 | $previous = $this->info->isParamExclusionEnabled(); |
171 | 171 | |
172 | - if($previous) |
|
172 | + if ($previous) |
|
173 | 173 | { |
174 | 174 | $this->info->setParamExclusion(false); |
175 | 175 | } |
@@ -185,19 +185,19 @@ discard block |
||
185 | 185 | { |
186 | 186 | $params = $this->resolveParams(); |
187 | 187 | |
188 | - if(empty($params)) { |
|
188 | + if (empty($params)) { |
|
189 | 189 | return ''; |
190 | 190 | } |
191 | 191 | |
192 | 192 | $tokens = array(); |
193 | 193 | $excluded = array(); |
194 | 194 | |
195 | - if($this->info->isParamExclusionEnabled()) |
|
195 | + if ($this->info->isParamExclusionEnabled()) |
|
196 | 196 | { |
197 | 197 | $excluded = $this->info->getExcludedParams(); |
198 | 198 | } |
199 | 199 | |
200 | - foreach($params as $param => $value) |
|
200 | + foreach ($params as $param => $value) |
|
201 | 201 | { |
202 | 202 | // If the parameter is numeric, it will automatically |
203 | 203 | // be an integer, so we need the conversion here. |
@@ -218,7 +218,7 @@ discard block |
||
218 | 218 | |
219 | 219 | $tag = $this->resolveTag($excluded, $param); |
220 | 220 | |
221 | - if(!empty($tag)) |
|
221 | + if (!empty($tag)) |
|
222 | 222 | { |
223 | 223 | $tokens[] = sprintf($tag, $parts); |
224 | 224 | } |
@@ -232,13 +232,13 @@ discard block |
||
232 | 232 | protected function resolveTag(array $excluded, string $paramName) : string |
233 | 233 | { |
234 | 234 | // regular, non-excluded parameter |
235 | - if(!isset($excluded[$paramName])) |
|
235 | + if (!isset($excluded[$paramName])) |
|
236 | 236 | { |
237 | 237 | return '<span class="link-param">%s</span>'; |
238 | 238 | } |
239 | 239 | |
240 | 240 | // highlight excluded parameters is disabled, ignore this parameter |
241 | - if(!$this->info->isHighlightExcludeEnabled()) |
|
241 | + if (!$this->info->isHighlightExcludeEnabled()) |
|
242 | 242 | { |
243 | 243 | return ''; |
244 | 244 | } |
@@ -254,7 +254,7 @@ discard block |
||
254 | 254 | |
255 | 255 | protected function render_fragment() : string |
256 | 256 | { |
257 | - if(!$this->info->hasFragment()) { |
|
257 | + if (!$this->info->hasFragment()) { |
|
258 | 258 | return ''; |
259 | 259 | } |
260 | 260 | |
@@ -269,7 +269,7 @@ discard block |
||
269 | 269 | { |
270 | 270 | $cssFolder = realpath(__DIR__.'/../../css'); |
271 | 271 | |
272 | - if($cssFolder === false) { |
|
272 | + if ($cssFolder === false) { |
|
273 | 273 | throw new BaseException( |
274 | 274 | 'Cannot find package CSS folder.', |
275 | 275 | null, |
@@ -56,9 +56,9 @@ discard block |
||
56 | 56 | * @param mixed $value |
57 | 57 | * @param array|null $serialized |
58 | 58 | */ |
59 | - public function __construct($value, $serialized=null) |
|
59 | + public function __construct($value, $serialized = null) |
|
60 | 60 | { |
61 | - if(is_array($serialized)) |
|
61 | + if (is_array($serialized)) |
|
62 | 62 | { |
63 | 63 | $this->parseSerialized($serialized); |
64 | 64 | } |
@@ -104,7 +104,7 @@ discard block |
||
104 | 104 | */ |
105 | 105 | protected function parseSerialized(array $serialized) : void |
106 | 106 | { |
107 | - if(!isset($serialized['string']) || !isset($serialized['type']) || !isset($serialized['options'])) |
|
107 | + if (!isset($serialized['string']) || !isset($serialized['type']) || !isset($serialized['options'])) |
|
108 | 108 | { |
109 | 109 | throw new BaseException( |
110 | 110 | 'Invalid variable info serialized data.', |
@@ -126,12 +126,12 @@ discard block |
||
126 | 126 | |
127 | 127 | // Gettype will return a string like "Resource(closed)" when |
128 | 128 | // working with a resource that has already been closed. |
129 | - if(strstr($this->type, 'resource')) |
|
129 | + if (strstr($this->type, 'resource')) |
|
130 | 130 | { |
131 | 131 | $this->type = self::TYPE_RESOURCE; |
132 | 132 | } |
133 | 133 | |
134 | - if(is_array($value) && is_callable($value)) { |
|
134 | + if (is_array($value) && is_callable($value)) { |
|
135 | 135 | $this->type = self::TYPE_CALLABLE; |
136 | 136 | } |
137 | 137 | |
@@ -169,7 +169,7 @@ discard block |
||
169 | 169 | * @param bool $enable |
170 | 170 | * @return VariableInfo |
171 | 171 | */ |
172 | - public function enableType(bool $enable=true) : VariableInfo |
|
172 | + public function enableType(bool $enable = true) : VariableInfo |
|
173 | 173 | { |
174 | 174 | return $this->setOption('prepend-type', $enable); |
175 | 175 | } |
@@ -178,9 +178,9 @@ discard block |
||
178 | 178 | { |
179 | 179 | $converted = $this->string; |
180 | 180 | |
181 | - if($this->getOption('prepend-type') === true && !$this->isNull()) |
|
181 | + if ($this->getOption('prepend-type') === true && !$this->isNull()) |
|
182 | 182 | { |
183 | - if($this->isString()) |
|
183 | + if ($this->isString()) |
|
184 | 184 | { |
185 | 185 | $converted = '"'.$converted.'"'; |
186 | 186 | } |
@@ -55,13 +55,13 @@ discard block |
||
55 | 55 | return str_replace("\t", str_repeat(' ', $tabSize), $string); |
56 | 56 | } |
57 | 57 | |
58 | - /** |
|
59 | - * Converts spaces to tabs in the specified string. |
|
60 | - * |
|
61 | - * @param string $string |
|
62 | - * @param int $tabSize The amount of spaces per tab in the source string. |
|
63 | - * @return string |
|
64 | - */ |
|
58 | + /** |
|
59 | + * Converts spaces to tabs in the specified string. |
|
60 | + * |
|
61 | + * @param string $string |
|
62 | + * @param int $tabSize The amount of spaces per tab in the source string. |
|
63 | + * @return string |
|
64 | + */ |
|
65 | 65 | public static function spaces2tabs(string $string, int $tabSize=4) : string |
66 | 66 | { |
67 | 67 | return str_replace(str_repeat(' ', $tabSize), "\t", $string); |
@@ -74,133 +74,133 @@ discard block |
||
74 | 74 | return $converter->convert($string); |
75 | 75 | } |
76 | 76 | |
77 | - /** |
|
78 | - * Converts the specified amount of seconds into |
|
79 | - * a human readable string split in months, weeks, |
|
80 | - * days, hours, minutes and seconds. |
|
81 | - * |
|
82 | - * @param float $seconds |
|
83 | - * @return string |
|
84 | - */ |
|
77 | + /** |
|
78 | + * Converts the specified amount of seconds into |
|
79 | + * a human readable string split in months, weeks, |
|
80 | + * days, hours, minutes and seconds. |
|
81 | + * |
|
82 | + * @param float $seconds |
|
83 | + * @return string |
|
84 | + */ |
|
85 | 85 | public static function time2string($seconds) : string |
86 | 86 | { |
87 | 87 | $converter = new ConvertHelper_TimeConverter($seconds); |
88 | 88 | return $converter->toString(); |
89 | 89 | } |
90 | 90 | |
91 | - /** |
|
92 | - * Converts a timestamp into an easily understandable |
|
93 | - * format, e.g. "2 hours", "1 day", "3 months" |
|
94 | - * |
|
95 | - * If you set the date to parameter, the difference |
|
96 | - * will be calculated between the two dates and not |
|
97 | - * the current time. |
|
98 | - * |
|
99 | - * @param integer|\DateTime $datefrom |
|
100 | - * @param integer|\DateTime $dateto |
|
101 | - * @return string |
|
102 | - */ |
|
91 | + /** |
|
92 | + * Converts a timestamp into an easily understandable |
|
93 | + * format, e.g. "2 hours", "1 day", "3 months" |
|
94 | + * |
|
95 | + * If you set the date to parameter, the difference |
|
96 | + * will be calculated between the two dates and not |
|
97 | + * the current time. |
|
98 | + * |
|
99 | + * @param integer|\DateTime $datefrom |
|
100 | + * @param integer|\DateTime $dateto |
|
101 | + * @return string |
|
102 | + */ |
|
103 | 103 | public static function duration2string($datefrom, $dateto = -1) : string |
104 | 104 | { |
105 | - $converter = new ConvertHelper_DurationConverter(); |
|
105 | + $converter = new ConvertHelper_DurationConverter(); |
|
106 | 106 | |
107 | - if($datefrom instanceof \DateTime) |
|
108 | - { |
|
109 | - $converter->setDateFrom($datefrom); |
|
110 | - } |
|
111 | - else |
|
112 | - { |
|
113 | - $converter->setDateFrom(self::timestamp2date($datefrom)); |
|
114 | - } |
|
107 | + if($datefrom instanceof \DateTime) |
|
108 | + { |
|
109 | + $converter->setDateFrom($datefrom); |
|
110 | + } |
|
111 | + else |
|
112 | + { |
|
113 | + $converter->setDateFrom(self::timestamp2date($datefrom)); |
|
114 | + } |
|
115 | 115 | |
116 | - if($dateto instanceof \DateTime) |
|
117 | - { |
|
118 | - $converter->setDateTo($dateto); |
|
119 | - } |
|
120 | - else if($dateto > 0) |
|
121 | - { |
|
122 | - $converter->setDateTo(self::timestamp2date($dateto)); |
|
123 | - } |
|
116 | + if($dateto instanceof \DateTime) |
|
117 | + { |
|
118 | + $converter->setDateTo($dateto); |
|
119 | + } |
|
120 | + else if($dateto > 0) |
|
121 | + { |
|
122 | + $converter->setDateTo(self::timestamp2date($dateto)); |
|
123 | + } |
|
124 | 124 | |
125 | - return $converter->convert(); |
|
125 | + return $converter->convert(); |
|
126 | 126 | } |
127 | 127 | |
128 | - /** |
|
129 | - * Adds HTML syntax highlighting to the specified SQL string. |
|
130 | - * |
|
131 | - * @param string $sql |
|
132 | - * @return string |
|
133 | - * @deprecated Use the Highlighter class directly instead. |
|
134 | - * @see Highlighter::sql() |
|
135 | - */ |
|
128 | + /** |
|
129 | + * Adds HTML syntax highlighting to the specified SQL string. |
|
130 | + * |
|
131 | + * @param string $sql |
|
132 | + * @return string |
|
133 | + * @deprecated Use the Highlighter class directly instead. |
|
134 | + * @see Highlighter::sql() |
|
135 | + */ |
|
136 | 136 | public static function highlight_sql(string $sql) : string |
137 | 137 | { |
138 | 138 | return Highlighter::sql($sql); |
139 | 139 | } |
140 | 140 | |
141 | - /** |
|
142 | - * Adds HTML syntax highlighting to the specified XML code. |
|
143 | - * |
|
144 | - * @param string $xml The XML to highlight. |
|
145 | - * @param bool $formatSource Whether to format the source with indentation to make it readable. |
|
146 | - * @return string |
|
147 | - * @deprecated Use the Highlighter class directly instead. |
|
148 | - * @see Highlighter::xml() |
|
149 | - */ |
|
141 | + /** |
|
142 | + * Adds HTML syntax highlighting to the specified XML code. |
|
143 | + * |
|
144 | + * @param string $xml The XML to highlight. |
|
145 | + * @param bool $formatSource Whether to format the source with indentation to make it readable. |
|
146 | + * @return string |
|
147 | + * @deprecated Use the Highlighter class directly instead. |
|
148 | + * @see Highlighter::xml() |
|
149 | + */ |
|
150 | 150 | public static function highlight_xml(string $xml, bool $formatSource=false) : string |
151 | 151 | { |
152 | 152 | return Highlighter::xml($xml, $formatSource); |
153 | 153 | } |
154 | 154 | |
155 | - /** |
|
156 | - * @param string $phpCode |
|
157 | - * @return string |
|
158 | - * @deprecated Use the Highlighter class directly instead. |
|
159 | - * @see Highlighter::php() |
|
160 | - */ |
|
155 | + /** |
|
156 | + * @param string $phpCode |
|
157 | + * @return string |
|
158 | + * @deprecated Use the Highlighter class directly instead. |
|
159 | + * @see Highlighter::php() |
|
160 | + */ |
|
161 | 161 | public static function highlight_php(string $phpCode) : string |
162 | 162 | { |
163 | 163 | return Highlighter::php($phpCode); |
164 | 164 | } |
165 | 165 | |
166 | - /** |
|
167 | - * Converts a number of bytes to a human readable form, |
|
168 | - * e.g. xx Kb / xx Mb / xx Gb |
|
169 | - * |
|
170 | - * @param int $bytes The amount of bytes to convert. |
|
171 | - * @param int $precision The amount of decimals |
|
172 | - * @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). |
|
173 | - * @return string |
|
174 | - * |
|
175 | - * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
176 | - */ |
|
166 | + /** |
|
167 | + * Converts a number of bytes to a human readable form, |
|
168 | + * e.g. xx Kb / xx Mb / xx Gb |
|
169 | + * |
|
170 | + * @param int $bytes The amount of bytes to convert. |
|
171 | + * @param int $precision The amount of decimals |
|
172 | + * @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). |
|
173 | + * @return string |
|
174 | + * |
|
175 | + * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
176 | + */ |
|
177 | 177 | public static function bytes2readable(int $bytes, int $precision = 1, int $base = ConvertHelper_StorageSizeEnum::BASE_10) : string |
178 | 178 | { |
179 | 179 | return self::parseBytes($bytes)->toString($precision, $base); |
180 | 180 | } |
181 | 181 | |
182 | - /** |
|
183 | - * Parses a number of bytes, and creates a converter instance which |
|
184 | - * allows doing common operations with it. |
|
185 | - * |
|
186 | - * @param int $bytes |
|
187 | - * @return ConvertHelper_ByteConverter |
|
188 | - */ |
|
182 | + /** |
|
183 | + * Parses a number of bytes, and creates a converter instance which |
|
184 | + * allows doing common operations with it. |
|
185 | + * |
|
186 | + * @param int $bytes |
|
187 | + * @return ConvertHelper_ByteConverter |
|
188 | + */ |
|
189 | 189 | public static function parseBytes(int $bytes) : ConvertHelper_ByteConverter |
190 | 190 | { |
191 | 191 | return new ConvertHelper_ByteConverter($bytes); |
192 | 192 | } |
193 | 193 | |
194 | - /** |
|
195 | - * Cuts a text to the specified length if it is longer than the |
|
196 | - * target length. Appends a text to signify it has been cut at |
|
197 | - * the end of the string. |
|
198 | - * |
|
199 | - * @param string $text |
|
200 | - * @param int $targetLength |
|
201 | - * @param string $append |
|
202 | - * @return string |
|
203 | - */ |
|
194 | + /** |
|
195 | + * Cuts a text to the specified length if it is longer than the |
|
196 | + * target length. Appends a text to signify it has been cut at |
|
197 | + * the end of the string. |
|
198 | + * |
|
199 | + * @param string $text |
|
200 | + * @param int $targetLength |
|
201 | + * @param string $append |
|
202 | + * @return string |
|
203 | + */ |
|
204 | 204 | public static function text_cut(string $text, int $targetLength, string $append = '...') : string |
205 | 205 | { |
206 | 206 | $length = mb_strlen($text); |
@@ -224,14 +224,14 @@ discard block |
||
224 | 224 | return $info->toString(); |
225 | 225 | } |
226 | 226 | |
227 | - /** |
|
228 | - * Pretty print_r. |
|
229 | - * |
|
230 | - * @param mixed $var The variable to dump. |
|
231 | - * @param bool $return Whether to return the dumped code. |
|
232 | - * @param bool $html Whether to style the dump as HTML. |
|
233 | - * @return string |
|
234 | - */ |
|
227 | + /** |
|
228 | + * Pretty print_r. |
|
229 | + * |
|
230 | + * @param mixed $var The variable to dump. |
|
231 | + * @param bool $return Whether to return the dumped code. |
|
232 | + * @param bool $html Whether to style the dump as HTML. |
|
233 | + * @return string |
|
234 | + */ |
|
235 | 235 | public static function print_r($var, bool $return=false, bool $html=true) : string |
236 | 236 | { |
237 | 237 | $result = parseVariable($var)->enableType()->toString(); |
@@ -252,9 +252,9 @@ discard block |
||
252 | 252 | return $result; |
253 | 253 | } |
254 | 254 | |
255 | - /** |
|
256 | - * @var array<mixed,bool> |
|
257 | - */ |
|
255 | + /** |
|
256 | + * @var array<mixed,bool> |
|
257 | + */ |
|
258 | 258 | protected static $booleanStrings = array( |
259 | 259 | 1 => true, |
260 | 260 | 0 => false, |
@@ -264,15 +264,15 @@ discard block |
||
264 | 264 | 'no' => false |
265 | 265 | ); |
266 | 266 | |
267 | - /** |
|
268 | - * Converts a string, number or boolean value to a boolean value. |
|
269 | - * |
|
270 | - * @param mixed $string |
|
271 | - * @throws ConvertHelper_Exception |
|
272 | - * @return bool |
|
273 | - * |
|
274 | - * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING |
|
275 | - */ |
|
267 | + /** |
|
268 | + * Converts a string, number or boolean value to a boolean value. |
|
269 | + * |
|
270 | + * @param mixed $string |
|
271 | + * @throws ConvertHelper_Exception |
|
272 | + * @return bool |
|
273 | + * |
|
274 | + * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING |
|
275 | + */ |
|
276 | 276 | public static function string2bool($string) : bool |
277 | 277 | { |
278 | 278 | if($string === '' || $string === null || !is_scalar($string)) |
@@ -300,27 +300,27 @@ discard block |
||
300 | 300 | ); |
301 | 301 | } |
302 | 302 | |
303 | - /** |
|
304 | - * Whether the specified string is a boolean string or boolean value. |
|
305 | - * Alias for {@link ConvertHelper::isBoolean()}. |
|
306 | - * |
|
307 | - * @param mixed $string |
|
308 | - * @return bool |
|
309 | - * @deprecated |
|
310 | - * @see ConvertHelper::isBoolean() |
|
311 | - */ |
|
303 | + /** |
|
304 | + * Whether the specified string is a boolean string or boolean value. |
|
305 | + * Alias for {@link ConvertHelper::isBoolean()}. |
|
306 | + * |
|
307 | + * @param mixed $string |
|
308 | + * @return bool |
|
309 | + * @deprecated |
|
310 | + * @see ConvertHelper::isBoolean() |
|
311 | + */ |
|
312 | 312 | public static function isBooleanString($string) : bool |
313 | 313 | { |
314 | 314 | return self::isBoolean($string); |
315 | 315 | } |
316 | 316 | |
317 | - /** |
|
318 | - * Alias for the {@\AppUtils\XMLHelper::string2xml()} method. |
|
319 | - * |
|
320 | - * @param string $text |
|
321 | - * @return string |
|
322 | - * @deprecated |
|
323 | - */ |
|
317 | + /** |
|
318 | + * Alias for the {@\AppUtils\XMLHelper::string2xml()} method. |
|
319 | + * |
|
320 | + * @param string $text |
|
321 | + * @return string |
|
322 | + * @deprecated |
|
323 | + */ |
|
324 | 324 | public static function text_makeXMLCompliant($text) |
325 | 325 | { |
326 | 326 | return XMLHelper::string2xml($text); |
@@ -422,80 +422,80 @@ discard block |
||
422 | 422 | return $translit->convert($string); |
423 | 423 | } |
424 | 424 | |
425 | - /** |
|
426 | - * Retrieves the HEX character codes for all control |
|
427 | - * characters that the {@link stripControlCharacters()} |
|
428 | - * method will remove. |
|
429 | - * |
|
430 | - * @return string[] |
|
431 | - */ |
|
425 | + /** |
|
426 | + * Retrieves the HEX character codes for all control |
|
427 | + * characters that the {@link stripControlCharacters()} |
|
428 | + * method will remove. |
|
429 | + * |
|
430 | + * @return string[] |
|
431 | + */ |
|
432 | 432 | public static function getControlCharactersAsHex() |
433 | 433 | { |
434 | 434 | return self::createControlCharacters()->getCharsAsHex(); |
435 | 435 | } |
436 | 436 | |
437 | - /** |
|
438 | - * Retrieves an array of all control characters that |
|
439 | - * the {@link stripControlCharacters()} method will |
|
440 | - * remove, as the actual UTF-8 characters. |
|
441 | - * |
|
442 | - * @return string[] |
|
443 | - */ |
|
437 | + /** |
|
438 | + * Retrieves an array of all control characters that |
|
439 | + * the {@link stripControlCharacters()} method will |
|
440 | + * remove, as the actual UTF-8 characters. |
|
441 | + * |
|
442 | + * @return string[] |
|
443 | + */ |
|
444 | 444 | public static function getControlCharactersAsUTF8() |
445 | 445 | { |
446 | 446 | return self::createControlCharacters()->getCharsAsUTF8(); |
447 | 447 | } |
448 | 448 | |
449 | - /** |
|
450 | - * Retrieves all control characters as JSON encoded |
|
451 | - * characters, e.g. "\u200b". |
|
452 | - * |
|
453 | - * @return string[] |
|
454 | - */ |
|
449 | + /** |
|
450 | + * Retrieves all control characters as JSON encoded |
|
451 | + * characters, e.g. "\u200b". |
|
452 | + * |
|
453 | + * @return string[] |
|
454 | + */ |
|
455 | 455 | public static function getControlCharactersAsJSON() |
456 | 456 | { |
457 | 457 | return self::createControlCharacters()->getCharsAsJSON(); |
458 | 458 | } |
459 | 459 | |
460 | - /** |
|
461 | - * Removes all control characters from the specified string |
|
462 | - * that can cause problems in some cases, like creating |
|
463 | - * valid XML documents. This includes invisible non-breaking |
|
464 | - * spaces. |
|
465 | - * |
|
466 | - * @param string $string |
|
467 | - * @return string |
|
468 | - */ |
|
460 | + /** |
|
461 | + * Removes all control characters from the specified string |
|
462 | + * that can cause problems in some cases, like creating |
|
463 | + * valid XML documents. This includes invisible non-breaking |
|
464 | + * spaces. |
|
465 | + * |
|
466 | + * @param string $string |
|
467 | + * @return string |
|
468 | + */ |
|
469 | 469 | public static function stripControlCharacters(string $string) : string |
470 | 470 | { |
471 | 471 | return self::createControlCharacters()->stripControlCharacters($string); |
472 | 472 | } |
473 | 473 | |
474 | - /** |
|
475 | - * Creates the control characters class, used to |
|
476 | - * work with control characters in strings. |
|
477 | - * |
|
478 | - * @return ConvertHelper_ControlCharacters |
|
479 | - */ |
|
474 | + /** |
|
475 | + * Creates the control characters class, used to |
|
476 | + * work with control characters in strings. |
|
477 | + * |
|
478 | + * @return ConvertHelper_ControlCharacters |
|
479 | + */ |
|
480 | 480 | public static function createControlCharacters() : ConvertHelper_ControlCharacters |
481 | 481 | { |
482 | 482 | return new ConvertHelper_ControlCharacters(); |
483 | 483 | } |
484 | 484 | |
485 | - /** |
|
486 | - * Converts a unicode character to the PHPO notation. |
|
487 | - * |
|
488 | - * Example: |
|
489 | - * |
|
490 | - * <pre>unicodeChar2php('"\u0000"')</pre> |
|
491 | - * |
|
492 | - * Returns |
|
493 | - * |
|
494 | - * <pre>\x0</pre> |
|
495 | - * |
|
496 | - * @param string $unicodeChar |
|
497 | - * @return string |
|
498 | - */ |
|
485 | + /** |
|
486 | + * Converts a unicode character to the PHPO notation. |
|
487 | + * |
|
488 | + * Example: |
|
489 | + * |
|
490 | + * <pre>unicodeChar2php('"\u0000"')</pre> |
|
491 | + * |
|
492 | + * Returns |
|
493 | + * |
|
494 | + * <pre>\x0</pre> |
|
495 | + * |
|
496 | + * @param string $unicodeChar |
|
497 | + * @return string |
|
498 | + */ |
|
499 | 499 | public static function unicodeChar2php(string $unicodeChar) : string |
500 | 500 | { |
501 | 501 | $unicodeChar = json_decode($unicodeChar); |
@@ -621,25 +621,25 @@ discard block |
||
621 | 621 | return 'false'; |
622 | 622 | } |
623 | 623 | |
624 | - /** |
|
625 | - * Converts an associative array with attribute name > value pairs |
|
626 | - * to an attribute string that can be used in an HTML tag. Empty |
|
627 | - * attribute values are ignored. |
|
628 | - * |
|
629 | - * Example: |
|
630 | - * |
|
631 | - * array2attributeString(array( |
|
632 | - * 'id' => 45, |
|
633 | - * 'href' => 'http://www.mistralys.com' |
|
634 | - * )); |
|
635 | - * |
|
636 | - * Result: |
|
637 | - * |
|
638 | - * id="45" href="http://www.mistralys.com" |
|
639 | - * |
|
640 | - * @param array $array |
|
641 | - * @return string |
|
642 | - */ |
|
624 | + /** |
|
625 | + * Converts an associative array with attribute name > value pairs |
|
626 | + * to an attribute string that can be used in an HTML tag. Empty |
|
627 | + * attribute values are ignored. |
|
628 | + * |
|
629 | + * Example: |
|
630 | + * |
|
631 | + * array2attributeString(array( |
|
632 | + * 'id' => 45, |
|
633 | + * 'href' => 'http://www.mistralys.com' |
|
634 | + * )); |
|
635 | + * |
|
636 | + * Result: |
|
637 | + * |
|
638 | + * id="45" href="http://www.mistralys.com" |
|
639 | + * |
|
640 | + * @param array $array |
|
641 | + * @return string |
|
642 | + */ |
|
643 | 643 | public static function array2attributeString($array) |
644 | 644 | { |
645 | 645 | $tokens = array(); |
@@ -658,14 +658,14 @@ discard block |
||
658 | 658 | return ' '.implode(' ', $tokens); |
659 | 659 | } |
660 | 660 | |
661 | - /** |
|
662 | - * Converts a string so it can safely be used in a javascript |
|
663 | - * statement in an HTML tag: uses single quotes around the string |
|
664 | - * and encodes all special characters as needed. |
|
665 | - * |
|
666 | - * @param string $string |
|
667 | - * @return string |
|
668 | - */ |
|
661 | + /** |
|
662 | + * Converts a string so it can safely be used in a javascript |
|
663 | + * statement in an HTML tag: uses single quotes around the string |
|
664 | + * and encodes all special characters as needed. |
|
665 | + * |
|
666 | + * @param string $string |
|
667 | + * @return string |
|
668 | + */ |
|
669 | 669 | public static function string2attributeJS($string, $quoted=true) |
670 | 670 | { |
671 | 671 | $converted = addslashes(htmlspecialchars(strip_tags($string), ENT_QUOTES, 'UTF-8')); |
@@ -676,15 +676,15 @@ discard block |
||
676 | 676 | return $converted; |
677 | 677 | } |
678 | 678 | |
679 | - /** |
|
680 | - * Checks if the specified string is a boolean value, which |
|
681 | - * includes string representations of boolean values, like |
|
682 | - * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
683 | - * or <code>false</code>. |
|
684 | - * |
|
685 | - * @param mixed $value |
|
686 | - * @return boolean |
|
687 | - */ |
|
679 | + /** |
|
680 | + * Checks if the specified string is a boolean value, which |
|
681 | + * includes string representations of boolean values, like |
|
682 | + * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
683 | + * or <code>false</code>. |
|
684 | + * |
|
685 | + * @param mixed $value |
|
686 | + * @return boolean |
|
687 | + */ |
|
688 | 688 | public static function isBoolean($value) : bool |
689 | 689 | { |
690 | 690 | if(is_bool($value)) { |
@@ -698,12 +698,12 @@ discard block |
||
698 | 698 | return array_key_exists($value, self::$booleanStrings); |
699 | 699 | } |
700 | 700 | |
701 | - /** |
|
702 | - * Converts an associative array to an HTML style attribute value string. |
|
703 | - * |
|
704 | - * @param array $subject |
|
705 | - * @return string |
|
706 | - */ |
|
701 | + /** |
|
702 | + * Converts an associative array to an HTML style attribute value string. |
|
703 | + * |
|
704 | + * @param array $subject |
|
705 | + * @return string |
|
706 | + */ |
|
707 | 707 | public static function array2styleString(array $subject) : string |
708 | 708 | { |
709 | 709 | $tokens = array(); |
@@ -714,23 +714,23 @@ discard block |
||
714 | 714 | return implode(';', $tokens); |
715 | 715 | } |
716 | 716 | |
717 | - /** |
|
718 | - * Converts a DateTime object to a timestamp, which |
|
719 | - * is PHP 5.2 compatible. |
|
720 | - * |
|
721 | - * @param \DateTime $date |
|
722 | - * @return integer |
|
723 | - */ |
|
717 | + /** |
|
718 | + * Converts a DateTime object to a timestamp, which |
|
719 | + * is PHP 5.2 compatible. |
|
720 | + * |
|
721 | + * @param \DateTime $date |
|
722 | + * @return integer |
|
723 | + */ |
|
724 | 724 | public static function date2timestamp(\DateTime $date) : int |
725 | 725 | { |
726 | 726 | return (int)$date->format('U'); |
727 | 727 | } |
728 | 728 | |
729 | - /** |
|
730 | - * Converts a timestamp into a DateTime instance. |
|
731 | - * @param int $timestamp |
|
732 | - * @return \DateTime |
|
733 | - */ |
|
729 | + /** |
|
730 | + * Converts a timestamp into a DateTime instance. |
|
731 | + * @param int $timestamp |
|
732 | + * @return \DateTime |
|
733 | + */ |
|
734 | 734 | public static function timestamp2date(int $timestamp) : \DateTime |
735 | 735 | { |
736 | 736 | $date = new \DateTime(); |
@@ -738,50 +738,50 @@ discard block |
||
738 | 738 | return $date; |
739 | 739 | } |
740 | 740 | |
741 | - /** |
|
742 | - * Strips an absolute path to a file within the application |
|
743 | - * to make the path relative to the application root path. |
|
744 | - * |
|
745 | - * @param string $path |
|
746 | - * @return string |
|
747 | - * |
|
748 | - * @see FileHelper::relativizePath() |
|
749 | - * @see FileHelper::relativizePathByDepth() |
|
750 | - */ |
|
741 | + /** |
|
742 | + * Strips an absolute path to a file within the application |
|
743 | + * to make the path relative to the application root path. |
|
744 | + * |
|
745 | + * @param string $path |
|
746 | + * @return string |
|
747 | + * |
|
748 | + * @see FileHelper::relativizePath() |
|
749 | + * @see FileHelper::relativizePathByDepth() |
|
750 | + */ |
|
751 | 751 | public static function fileRelativize(string $path) : string |
752 | 752 | { |
753 | 753 | return FileHelper::relativizePathByDepth($path); |
754 | 754 | } |
755 | 755 | |
756 | 756 | /** |
757 | - * Converts a PHP regex to a javascript RegExp object statement. |
|
758 | - * |
|
759 | - * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
760 | - * More details are available on its usage there. |
|
761 | - * |
|
762 | - * @param string $regex A PHP preg regex |
|
763 | - * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
764 | - * @return array|string Depending on the specified return type. |
|
765 | - * |
|
766 | - * @see JSHelper::buildRegexStatement() |
|
767 | - */ |
|
757 | + * Converts a PHP regex to a javascript RegExp object statement. |
|
758 | + * |
|
759 | + * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
760 | + * More details are available on its usage there. |
|
761 | + * |
|
762 | + * @param string $regex A PHP preg regex |
|
763 | + * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
764 | + * @return array|string Depending on the specified return type. |
|
765 | + * |
|
766 | + * @see JSHelper::buildRegexStatement() |
|
767 | + */ |
|
768 | 768 | public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) |
769 | 769 | { |
770 | 770 | return JSHelper::buildRegexStatement($regex, $statementType); |
771 | 771 | } |
772 | 772 | |
773 | - /** |
|
774 | - * Converts the specified variable to JSON. Works just |
|
775 | - * like the native `json_encode` method, except that it |
|
776 | - * will trigger an exception on failure, which has the |
|
777 | - * json error details included in its developer details. |
|
778 | - * |
|
779 | - * @param mixed $variable |
|
780 | - * @param int $options JSON encode options. |
|
781 | - * @param int $depth |
|
782 | - * @throws ConvertHelper_Exception |
|
783 | - * @return string |
|
784 | - */ |
|
773 | + /** |
|
774 | + * Converts the specified variable to JSON. Works just |
|
775 | + * like the native `json_encode` method, except that it |
|
776 | + * will trigger an exception on failure, which has the |
|
777 | + * json error details included in its developer details. |
|
778 | + * |
|
779 | + * @param mixed $variable |
|
780 | + * @param int $options JSON encode options. |
|
781 | + * @param int $depth |
|
782 | + * @throws ConvertHelper_Exception |
|
783 | + * @return string |
|
784 | + */ |
|
785 | 785 | public static function var2json($variable, int $options=0, int $depth=512) : string |
786 | 786 | { |
787 | 787 | $result = json_encode($variable, $options, $depth); |
@@ -802,12 +802,12 @@ discard block |
||
802 | 802 | ); |
803 | 803 | } |
804 | 804 | |
805 | - /** |
|
806 | - * Strips all known UTF byte order marks from the specified string. |
|
807 | - * |
|
808 | - * @param string $string |
|
809 | - * @return string |
|
810 | - */ |
|
805 | + /** |
|
806 | + * Strips all known UTF byte order marks from the specified string. |
|
807 | + * |
|
808 | + * @param string $string |
|
809 | + * @return string |
|
810 | + */ |
|
811 | 811 | public static function stripUTFBom($string) |
812 | 812 | { |
813 | 813 | $boms = FileHelper::getUTFBOMs(); |
@@ -822,13 +822,13 @@ discard block |
||
822 | 822 | return $string; |
823 | 823 | } |
824 | 824 | |
825 | - /** |
|
826 | - * Converts a string to valid utf8, regardless |
|
827 | - * of the string's encoding(s). |
|
828 | - * |
|
829 | - * @param string $string |
|
830 | - * @return string |
|
831 | - */ |
|
825 | + /** |
|
826 | + * Converts a string to valid utf8, regardless |
|
827 | + * of the string's encoding(s). |
|
828 | + * |
|
829 | + * @param string $string |
|
830 | + * @return string |
|
831 | + */ |
|
832 | 832 | public static function string2utf8($string) |
833 | 833 | { |
834 | 834 | if(!self::isStringASCII($string)) { |
@@ -838,15 +838,15 @@ discard block |
||
838 | 838 | return $string; |
839 | 839 | } |
840 | 840 | |
841 | - /** |
|
842 | - * Checks whether the specified string is an ASCII |
|
843 | - * string, without any special or UTF8 characters. |
|
844 | - * Note: empty strings and NULL are considered ASCII. |
|
845 | - * Any variable types other than strings are not. |
|
846 | - * |
|
847 | - * @param mixed $string |
|
848 | - * @return boolean |
|
849 | - */ |
|
841 | + /** |
|
842 | + * Checks whether the specified string is an ASCII |
|
843 | + * string, without any special or UTF8 characters. |
|
844 | + * Note: empty strings and NULL are considered ASCII. |
|
845 | + * Any variable types other than strings are not. |
|
846 | + * |
|
847 | + * @param mixed $string |
|
848 | + * @return boolean |
|
849 | + */ |
|
850 | 850 | public static function isStringASCII($string) : bool |
851 | 851 | { |
852 | 852 | if($string === '' || $string === NULL) { |
@@ -860,39 +860,39 @@ discard block |
||
860 | 860 | return !preg_match('/[^\x00-\x7F]/', $string); |
861 | 861 | } |
862 | 862 | |
863 | - /** |
|
864 | - * Adds HTML syntax highlighting to an URL. |
|
865 | - * |
|
866 | - * NOTE: Includes the necessary CSS styles. When |
|
867 | - * highlighting several URLs in the same page, |
|
868 | - * prefer using the `parseURL` function instead. |
|
869 | - * |
|
870 | - * @param string $url |
|
871 | - * @return string |
|
872 | - * @deprecated Use the Highlighter class directly instead. |
|
873 | - * @see Highlighter |
|
874 | - */ |
|
863 | + /** |
|
864 | + * Adds HTML syntax highlighting to an URL. |
|
865 | + * |
|
866 | + * NOTE: Includes the necessary CSS styles. When |
|
867 | + * highlighting several URLs in the same page, |
|
868 | + * prefer using the `parseURL` function instead. |
|
869 | + * |
|
870 | + * @param string $url |
|
871 | + * @return string |
|
872 | + * @deprecated Use the Highlighter class directly instead. |
|
873 | + * @see Highlighter |
|
874 | + */ |
|
875 | 875 | public static function highlight_url(string $url) : string |
876 | 876 | { |
877 | 877 | return Highlighter::url($url); |
878 | 878 | } |
879 | 879 | |
880 | - /** |
|
881 | - * Calculates a percentage match of the source string with the target string. |
|
882 | - * |
|
883 | - * Options are: |
|
884 | - * |
|
885 | - * - maxLevenshtein, default: 10 |
|
886 | - * Any levenshtein results above this value are ignored. |
|
887 | - * |
|
888 | - * - precision, default: 1 |
|
889 | - * The precision of the percentage float value |
|
890 | - * |
|
891 | - * @param string $source |
|
892 | - * @param string $target |
|
893 | - * @param array $options |
|
894 | - * @return float |
|
895 | - */ |
|
880 | + /** |
|
881 | + * Calculates a percentage match of the source string with the target string. |
|
882 | + * |
|
883 | + * Options are: |
|
884 | + * |
|
885 | + * - maxLevenshtein, default: 10 |
|
886 | + * Any levenshtein results above this value are ignored. |
|
887 | + * |
|
888 | + * - precision, default: 1 |
|
889 | + * The precision of the percentage float value |
|
890 | + * |
|
891 | + * @param string $source |
|
892 | + * @param string $target |
|
893 | + * @param array $options |
|
894 | + * @return float |
|
895 | + */ |
|
896 | 896 | public static function matchString($source, $target, $options=array()) |
897 | 897 | { |
898 | 898 | $defaults = array( |
@@ -916,14 +916,14 @@ discard block |
||
916 | 916 | return round(100 - $percent, $options['precision']); |
917 | 917 | } |
918 | 918 | |
919 | - /** |
|
920 | - * Converts a date interval to a human readable string with |
|
921 | - * all necessary time components, e.g. "1 year, 2 months and 4 days". |
|
922 | - * |
|
923 | - * @param \DateInterval $interval |
|
924 | - * @return string |
|
925 | - * @see ConvertHelper_IntervalConverter |
|
926 | - */ |
|
919 | + /** |
|
920 | + * Converts a date interval to a human readable string with |
|
921 | + * all necessary time components, e.g. "1 year, 2 months and 4 days". |
|
922 | + * |
|
923 | + * @param \DateInterval $interval |
|
924 | + * @return string |
|
925 | + * @see ConvertHelper_IntervalConverter |
|
926 | + */ |
|
927 | 927 | public static function interval2string(\DateInterval $interval) : string |
928 | 928 | { |
929 | 929 | $converter = new ConvertHelper_IntervalConverter(); |
@@ -938,60 +938,60 @@ discard block |
||
938 | 938 | |
939 | 939 | const INTERVAL_SECONDS = 'seconds'; |
940 | 940 | |
941 | - /** |
|
942 | - * Converts an interval to its total amount of days. |
|
943 | - * @param \DateInterval $interval |
|
944 | - * @return int |
|
945 | - */ |
|
941 | + /** |
|
942 | + * Converts an interval to its total amount of days. |
|
943 | + * @param \DateInterval $interval |
|
944 | + * @return int |
|
945 | + */ |
|
946 | 946 | public static function interval2days(\DateInterval $interval) : int |
947 | 947 | { |
948 | 948 | return self::interval2total($interval, self::INTERVAL_DAYS); |
949 | 949 | } |
950 | 950 | |
951 | - /** |
|
952 | - * Converts an interval to its total amount of hours. |
|
953 | - * @param \DateInterval $interval |
|
954 | - * @return int |
|
955 | - */ |
|
951 | + /** |
|
952 | + * Converts an interval to its total amount of hours. |
|
953 | + * @param \DateInterval $interval |
|
954 | + * @return int |
|
955 | + */ |
|
956 | 956 | public static function interval2hours(\DateInterval $interval) : int |
957 | 957 | { |
958 | 958 | return self::interval2total($interval, self::INTERVAL_HOURS); |
959 | 959 | } |
960 | 960 | |
961 | - /** |
|
962 | - * Converts an interval to its total amount of minutes. |
|
963 | - * @param \DateInterval $interval |
|
964 | - * @return int |
|
965 | - */ |
|
961 | + /** |
|
962 | + * Converts an interval to its total amount of minutes. |
|
963 | + * @param \DateInterval $interval |
|
964 | + * @return int |
|
965 | + */ |
|
966 | 966 | public static function interval2minutes(\DateInterval $interval) : int |
967 | 967 | { |
968 | 968 | return self::interval2total($interval, self::INTERVAL_MINUTES); |
969 | 969 | } |
970 | 970 | |
971 | - /** |
|
972 | - * Converts an interval to its total amount of seconds. |
|
973 | - * @param \DateInterval $interval |
|
974 | - * @return int |
|
975 | - */ |
|
971 | + /** |
|
972 | + * Converts an interval to its total amount of seconds. |
|
973 | + * @param \DateInterval $interval |
|
974 | + * @return int |
|
975 | + */ |
|
976 | 976 | public static function interval2seconds(\DateInterval $interval) : int |
977 | 977 | { |
978 | 978 | return self::interval2total($interval, self::INTERVAL_SECONDS); |
979 | 979 | } |
980 | 980 | |
981 | - /** |
|
982 | - * Calculates the total amount of days / hours / minutes or seconds |
|
983 | - * of a date interval object (depending in the specified units), and |
|
984 | - * returns the total amount. |
|
985 | - * |
|
986 | - * @param \DateInterval $interval |
|
987 | - * @param string $unit What total value to calculate. |
|
988 | - * @return integer |
|
989 | - * |
|
990 | - * @see ConvertHelper::INTERVAL_SECONDS |
|
991 | - * @see ConvertHelper::INTERVAL_MINUTES |
|
992 | - * @see ConvertHelper::INTERVAL_HOURS |
|
993 | - * @see ConvertHelper::INTERVAL_DAYS |
|
994 | - */ |
|
981 | + /** |
|
982 | + * Calculates the total amount of days / hours / minutes or seconds |
|
983 | + * of a date interval object (depending in the specified units), and |
|
984 | + * returns the total amount. |
|
985 | + * |
|
986 | + * @param \DateInterval $interval |
|
987 | + * @param string $unit What total value to calculate. |
|
988 | + * @return integer |
|
989 | + * |
|
990 | + * @see ConvertHelper::INTERVAL_SECONDS |
|
991 | + * @see ConvertHelper::INTERVAL_MINUTES |
|
992 | + * @see ConvertHelper::INTERVAL_HOURS |
|
993 | + * @see ConvertHelper::INTERVAL_DAYS |
|
994 | + */ |
|
995 | 995 | public static function interval2total(\DateInterval $interval, $unit=self::INTERVAL_SECONDS) : int |
996 | 996 | { |
997 | 997 | $total = (int)$interval->format('%a'); |
@@ -1031,13 +1031,13 @@ discard block |
||
1031 | 1031 | 'Sunday' |
1032 | 1032 | ); |
1033 | 1033 | |
1034 | - /** |
|
1035 | - * Converts a date to the corresponding day name. |
|
1036 | - * |
|
1037 | - * @param \DateTime $date |
|
1038 | - * @param bool $short |
|
1039 | - * @return string|NULL |
|
1040 | - */ |
|
1034 | + /** |
|
1035 | + * Converts a date to the corresponding day name. |
|
1036 | + * |
|
1037 | + * @param \DateTime $date |
|
1038 | + * @param bool $short |
|
1039 | + * @return string|NULL |
|
1040 | + */ |
|
1041 | 1041 | public static function date2dayName(\DateTime $date, bool $short=false) |
1042 | 1042 | { |
1043 | 1043 | $day = $date->format('l'); |
@@ -1052,21 +1052,21 @@ discard block |
||
1052 | 1052 | return null; |
1053 | 1053 | } |
1054 | 1054 | |
1055 | - /** |
|
1056 | - * Retrieves a list of english day names. |
|
1057 | - * @return string[] |
|
1058 | - */ |
|
1055 | + /** |
|
1056 | + * Retrieves a list of english day names. |
|
1057 | + * @return string[] |
|
1058 | + */ |
|
1059 | 1059 | public static function getDayNamesInvariant() |
1060 | 1060 | { |
1061 | 1061 | return self::$daysInvariant; |
1062 | 1062 | } |
1063 | 1063 | |
1064 | - /** |
|
1065 | - * Retrieves the day names list for the current locale. |
|
1066 | - * |
|
1067 | - * @param bool $short |
|
1068 | - * @return array |
|
1069 | - */ |
|
1064 | + /** |
|
1065 | + * Retrieves the day names list for the current locale. |
|
1066 | + * |
|
1067 | + * @param bool $short |
|
1068 | + * @return array |
|
1069 | + */ |
|
1070 | 1070 | public static function getDayNames(bool $short=false) : array |
1071 | 1071 | { |
1072 | 1072 | if($short) { |
@@ -1126,16 +1126,16 @@ discard block |
||
1126 | 1126 | return $last; |
1127 | 1127 | } |
1128 | 1128 | |
1129 | - /** |
|
1130 | - * Splits a string into an array of all characters it is composed of. |
|
1131 | - * Unicode character safe. |
|
1132 | - * |
|
1133 | - * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
1134 | - * characters. |
|
1135 | - * |
|
1136 | - * @param string $string |
|
1137 | - * @return array |
|
1138 | - */ |
|
1129 | + /** |
|
1130 | + * Splits a string into an array of all characters it is composed of. |
|
1131 | + * Unicode character safe. |
|
1132 | + * |
|
1133 | + * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
1134 | + * characters. |
|
1135 | + * |
|
1136 | + * @param string $string |
|
1137 | + * @return array |
|
1138 | + */ |
|
1139 | 1139 | public static function string2array(string $string) : array |
1140 | 1140 | { |
1141 | 1141 | $result = preg_split('//u', $string, null, PREG_SPLIT_NO_EMPTY); |
@@ -1146,12 +1146,12 @@ discard block |
||
1146 | 1146 | return array(); |
1147 | 1147 | } |
1148 | 1148 | |
1149 | - /** |
|
1150 | - * Checks whether the specified string contains HTML code. |
|
1151 | - * |
|
1152 | - * @param string $string |
|
1153 | - * @return boolean |
|
1154 | - */ |
|
1149 | + /** |
|
1150 | + * Checks whether the specified string contains HTML code. |
|
1151 | + * |
|
1152 | + * @param string $string |
|
1153 | + * @return boolean |
|
1154 | + */ |
|
1155 | 1155 | public static function isStringHTML(string $string) : bool |
1156 | 1156 | { |
1157 | 1157 | if(preg_match('%<[a-z/][\s\S]*>%siU', $string)) { |
@@ -1166,17 +1166,17 @@ discard block |
||
1166 | 1166 | return false; |
1167 | 1167 | } |
1168 | 1168 | |
1169 | - /** |
|
1170 | - * UTF8-safe wordwrap method: works like the regular wordwrap |
|
1171 | - * PHP function but compatible with UTF8. Otherwise the lengths |
|
1172 | - * are not calculated correctly. |
|
1173 | - * |
|
1174 | - * @param string $str |
|
1175 | - * @param int $width |
|
1176 | - * @param string $break |
|
1177 | - * @param bool $cut |
|
1178 | - * @return string |
|
1179 | - */ |
|
1169 | + /** |
|
1170 | + * UTF8-safe wordwrap method: works like the regular wordwrap |
|
1171 | + * PHP function but compatible with UTF8. Otherwise the lengths |
|
1172 | + * are not calculated correctly. |
|
1173 | + * |
|
1174 | + * @param string $str |
|
1175 | + * @param int $width |
|
1176 | + * @param string $break |
|
1177 | + * @param bool $cut |
|
1178 | + * @return string |
|
1179 | + */ |
|
1180 | 1180 | public static function wordwrap(string $str, int $width = 75, string $break = "\n", bool $cut = false) : string |
1181 | 1181 | { |
1182 | 1182 | $wrapper = new ConvertHelper_WordWrapper(); |
@@ -1188,27 +1188,27 @@ discard block |
||
1188 | 1188 | ->wrapText($str); |
1189 | 1189 | } |
1190 | 1190 | |
1191 | - /** |
|
1192 | - * Calculates the byte length of a string, taking into |
|
1193 | - * account any unicode characters. |
|
1194 | - * |
|
1195 | - * @param string $string |
|
1196 | - * @return int |
|
1197 | - * @see https://stackoverflow.com/a/9718273/2298192 |
|
1198 | - */ |
|
1191 | + /** |
|
1192 | + * Calculates the byte length of a string, taking into |
|
1193 | + * account any unicode characters. |
|
1194 | + * |
|
1195 | + * @param string $string |
|
1196 | + * @return int |
|
1197 | + * @see https://stackoverflow.com/a/9718273/2298192 |
|
1198 | + */ |
|
1199 | 1199 | public static function string2bytes($string) |
1200 | 1200 | { |
1201 | 1201 | return mb_strlen($string, '8bit'); |
1202 | 1202 | } |
1203 | 1203 | |
1204 | - /** |
|
1205 | - * Creates a short, 8-character long hash for the specified string. |
|
1206 | - * |
|
1207 | - * WARNING: Not cryptographically safe. |
|
1208 | - * |
|
1209 | - * @param string $string |
|
1210 | - * @return string |
|
1211 | - */ |
|
1204 | + /** |
|
1205 | + * Creates a short, 8-character long hash for the specified string. |
|
1206 | + * |
|
1207 | + * WARNING: Not cryptographically safe. |
|
1208 | + * |
|
1209 | + * @param string $string |
|
1210 | + * @return string |
|
1211 | + */ |
|
1212 | 1212 | public static function string2shortHash($string) |
1213 | 1213 | { |
1214 | 1214 | return hash('crc32', $string, false); |
@@ -1234,40 +1234,40 @@ discard block |
||
1234 | 1234 | return ConvertHelper_ThrowableInfo::fromThrowable($e); |
1235 | 1235 | } |
1236 | 1236 | |
1237 | - /** |
|
1238 | - * Parses the specified query string like the native |
|
1239 | - * function <code>parse_str</code>, without the key |
|
1240 | - * naming limitations. |
|
1241 | - * |
|
1242 | - * Using parse_str, dots or spaces in key names are |
|
1243 | - * replaced by underscores. This method keeps all names |
|
1244 | - * intact. |
|
1245 | - * |
|
1246 | - * It still uses the parse_str implementation as it |
|
1247 | - * is tested and tried, but fixes the parameter names |
|
1248 | - * after parsing, as needed. |
|
1249 | - * |
|
1250 | - * @param string $queryString |
|
1251 | - * @return array |
|
1252 | - * @see ConvertHelper_QueryParser |
|
1253 | - */ |
|
1237 | + /** |
|
1238 | + * Parses the specified query string like the native |
|
1239 | + * function <code>parse_str</code>, without the key |
|
1240 | + * naming limitations. |
|
1241 | + * |
|
1242 | + * Using parse_str, dots or spaces in key names are |
|
1243 | + * replaced by underscores. This method keeps all names |
|
1244 | + * intact. |
|
1245 | + * |
|
1246 | + * It still uses the parse_str implementation as it |
|
1247 | + * is tested and tried, but fixes the parameter names |
|
1248 | + * after parsing, as needed. |
|
1249 | + * |
|
1250 | + * @param string $queryString |
|
1251 | + * @return array |
|
1252 | + * @see ConvertHelper_QueryParser |
|
1253 | + */ |
|
1254 | 1254 | public static function parseQueryString(string $queryString) : array |
1255 | 1255 | { |
1256 | 1256 | $parser = new ConvertHelper_QueryParser(); |
1257 | 1257 | return $parser->parse($queryString); |
1258 | 1258 | } |
1259 | 1259 | |
1260 | - /** |
|
1261 | - * Searches for needle in the specified string, and returns a list |
|
1262 | - * of all occurrences, including the matched string. The matched |
|
1263 | - * string is useful when doing a case insensitive search, as it |
|
1264 | - * shows the exact matched case of needle. |
|
1265 | - * |
|
1266 | - * @param string $needle |
|
1267 | - * @param string $haystack |
|
1268 | - * @param bool $caseInsensitive |
|
1269 | - * @return ConvertHelper_StringMatch[] |
|
1270 | - */ |
|
1260 | + /** |
|
1261 | + * Searches for needle in the specified string, and returns a list |
|
1262 | + * of all occurrences, including the matched string. The matched |
|
1263 | + * string is useful when doing a case insensitive search, as it |
|
1264 | + * shows the exact matched case of needle. |
|
1265 | + * |
|
1266 | + * @param string $needle |
|
1267 | + * @param string $haystack |
|
1268 | + * @param bool $caseInsensitive |
|
1269 | + * @return ConvertHelper_StringMatch[] |
|
1270 | + */ |
|
1271 | 1271 | public static function findString(string $needle, string $haystack, bool $caseInsensitive=false) |
1272 | 1272 | { |
1273 | 1273 | if($needle === '') { |
@@ -1293,14 +1293,14 @@ discard block |
||
1293 | 1293 | return $positions; |
1294 | 1294 | } |
1295 | 1295 | |
1296 | - /** |
|
1297 | - * Like explode, but trims all entries, and removes |
|
1298 | - * empty entries from the resulting array. |
|
1299 | - * |
|
1300 | - * @param string $delimiter |
|
1301 | - * @param string $string |
|
1302 | - * @return string[] |
|
1303 | - */ |
|
1296 | + /** |
|
1297 | + * Like explode, but trims all entries, and removes |
|
1298 | + * empty entries from the resulting array. |
|
1299 | + * |
|
1300 | + * @param string $delimiter |
|
1301 | + * @param string $string |
|
1302 | + * @return string[] |
|
1303 | + */ |
|
1304 | 1304 | public static function explodeTrim(string $delimiter, string $string) : array |
1305 | 1305 | { |
1306 | 1306 | if(empty($string) || empty($delimiter)) { |
@@ -1322,12 +1322,12 @@ discard block |
||
1322 | 1322 | |
1323 | 1323 | protected static $eolChars; |
1324 | 1324 | |
1325 | - /** |
|
1326 | - * Detects the most used end-of-line character in the subject string. |
|
1327 | - * |
|
1328 | - * @param string $subjectString The string to check. |
|
1329 | - * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
1330 | - */ |
|
1325 | + /** |
|
1326 | + * Detects the most used end-of-line character in the subject string. |
|
1327 | + * |
|
1328 | + * @param string $subjectString The string to check. |
|
1329 | + * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
1330 | + */ |
|
1331 | 1331 | public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL |
1332 | 1332 | { |
1333 | 1333 | if(empty($subjectString)) { |
@@ -1339,27 +1339,27 @@ discard block |
||
1339 | 1339 | $cr = chr((int)hexdec('0d')); |
1340 | 1340 | $lf = chr((int)hexdec('0a')); |
1341 | 1341 | |
1342 | - self::$eolChars = array( |
|
1343 | - array( |
|
1344 | - 'char' => $cr.$lf, |
|
1345 | - 'type' => ConvertHelper_EOL::TYPE_CRLF, |
|
1346 | - 'description' => t('Carriage return followed by a line feed'), |
|
1347 | - ), |
|
1348 | - array( |
|
1349 | - 'char' => $lf.$cr, |
|
1350 | - 'type' => ConvertHelper_EOL::TYPE_LFCR, |
|
1351 | - 'description' => t('Line feed followed by a carriage return'), |
|
1352 | - ), |
|
1353 | - array( |
|
1354 | - 'char' => $lf, |
|
1355 | - 'type' => ConvertHelper_EOL::TYPE_LF, |
|
1356 | - 'description' => t('Line feed'), |
|
1357 | - ), |
|
1358 | - array( |
|
1359 | - 'char' => $cr, |
|
1360 | - 'type' => ConvertHelper_EOL::TYPE_CR, |
|
1361 | - 'description' => t('Carriage Return'), |
|
1362 | - ), |
|
1342 | + self::$eolChars = array( |
|
1343 | + array( |
|
1344 | + 'char' => $cr.$lf, |
|
1345 | + 'type' => ConvertHelper_EOL::TYPE_CRLF, |
|
1346 | + 'description' => t('Carriage return followed by a line feed'), |
|
1347 | + ), |
|
1348 | + array( |
|
1349 | + 'char' => $lf.$cr, |
|
1350 | + 'type' => ConvertHelper_EOL::TYPE_LFCR, |
|
1351 | + 'description' => t('Line feed followed by a carriage return'), |
|
1352 | + ), |
|
1353 | + array( |
|
1354 | + 'char' => $lf, |
|
1355 | + 'type' => ConvertHelper_EOL::TYPE_LF, |
|
1356 | + 'description' => t('Line feed'), |
|
1357 | + ), |
|
1358 | + array( |
|
1359 | + 'char' => $cr, |
|
1360 | + 'type' => ConvertHelper_EOL::TYPE_CR, |
|
1361 | + 'description' => t('Carriage Return'), |
|
1362 | + ), |
|
1363 | 1363 | ); |
1364 | 1364 | } |
1365 | 1365 | |
@@ -1387,13 +1387,13 @@ discard block |
||
1387 | 1387 | ); |
1388 | 1388 | } |
1389 | 1389 | |
1390 | - /** |
|
1391 | - * Removes the specified keys from the target array, |
|
1392 | - * if they exist. |
|
1393 | - * |
|
1394 | - * @param array $array |
|
1395 | - * @param array $keys |
|
1396 | - */ |
|
1390 | + /** |
|
1391 | + * Removes the specified keys from the target array, |
|
1392 | + * if they exist. |
|
1393 | + * |
|
1394 | + * @param array $array |
|
1395 | + * @param array $keys |
|
1396 | + */ |
|
1397 | 1397 | public static function arrayRemoveKeys(array &$array, array $keys) : void |
1398 | 1398 | { |
1399 | 1399 | foreach($keys as $key) |
@@ -1404,13 +1404,13 @@ discard block |
||
1404 | 1404 | } |
1405 | 1405 | } |
1406 | 1406 | |
1407 | - /** |
|
1408 | - * Checks if the specified variable is an integer or a string containing an integer. |
|
1409 | - * Accepts both positive and negative integers. |
|
1410 | - * |
|
1411 | - * @param mixed $value |
|
1412 | - * @return bool |
|
1413 | - */ |
|
1407 | + /** |
|
1408 | + * Checks if the specified variable is an integer or a string containing an integer. |
|
1409 | + * Accepts both positive and negative integers. |
|
1410 | + * |
|
1411 | + * @param mixed $value |
|
1412 | + * @return bool |
|
1413 | + */ |
|
1414 | 1414 | public static function isInteger($value) : bool |
1415 | 1415 | { |
1416 | 1416 | if(is_int($value)) { |
@@ -1430,52 +1430,52 @@ discard block |
||
1430 | 1430 | return false; |
1431 | 1431 | } |
1432 | 1432 | |
1433 | - /** |
|
1434 | - * Converts an amount of seconds to a DateInterval object. |
|
1435 | - * |
|
1436 | - * @param int $seconds |
|
1437 | - * @return \DateInterval |
|
1438 | - * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
1439 | - * |
|
1440 | - * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
1441 | - */ |
|
1433 | + /** |
|
1434 | + * Converts an amount of seconds to a DateInterval object. |
|
1435 | + * |
|
1436 | + * @param int $seconds |
|
1437 | + * @return \DateInterval |
|
1438 | + * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
1439 | + * |
|
1440 | + * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
1441 | + */ |
|
1442 | 1442 | public static function seconds2interval(int $seconds) : \DateInterval |
1443 | 1443 | { |
1444 | 1444 | return ConvertHelper_DateInterval::fromSeconds($seconds)->getInterval(); |
1445 | 1445 | } |
1446 | 1446 | |
1447 | - /** |
|
1448 | - * Converts a size string like "50 MB" to the corresponding byte size. |
|
1449 | - * It is case insensitive, ignores spaces, and supports both traditional |
|
1450 | - * "MB" and "MiB" notations. |
|
1451 | - * |
|
1452 | - * @param string $size |
|
1453 | - * @return int |
|
1454 | - */ |
|
1447 | + /** |
|
1448 | + * Converts a size string like "50 MB" to the corresponding byte size. |
|
1449 | + * It is case insensitive, ignores spaces, and supports both traditional |
|
1450 | + * "MB" and "MiB" notations. |
|
1451 | + * |
|
1452 | + * @param string $size |
|
1453 | + * @return int |
|
1454 | + */ |
|
1455 | 1455 | public static function size2bytes(string $size) : int |
1456 | 1456 | { |
1457 | 1457 | return self::parseSize($size)->toBytes(); |
1458 | 1458 | } |
1459 | 1459 | |
1460 | - /** |
|
1461 | - * Parses a size string like "50 MB" and returns a size notation instance |
|
1462 | - * that has utility methods to access information on it, and convert it. |
|
1463 | - * |
|
1464 | - * @param string $size |
|
1465 | - * @return ConvertHelper_SizeNotation |
|
1466 | - */ |
|
1460 | + /** |
|
1461 | + * Parses a size string like "50 MB" and returns a size notation instance |
|
1462 | + * that has utility methods to access information on it, and convert it. |
|
1463 | + * |
|
1464 | + * @param string $size |
|
1465 | + * @return ConvertHelper_SizeNotation |
|
1466 | + */ |
|
1467 | 1467 | public static function parseSize(string $size) : ConvertHelper_SizeNotation |
1468 | 1468 | { |
1469 | 1469 | return new ConvertHelper_SizeNotation($size); |
1470 | 1470 | } |
1471 | 1471 | |
1472 | - /** |
|
1473 | - * Creates a URL finder instance, which can be used to find |
|
1474 | - * URLs in a string - be it plain text, or HTML. |
|
1475 | - * |
|
1476 | - * @param string $subject |
|
1477 | - * @return ConvertHelper_URLFinder |
|
1478 | - */ |
|
1472 | + /** |
|
1473 | + * Creates a URL finder instance, which can be used to find |
|
1474 | + * URLs in a string - be it plain text, or HTML. |
|
1475 | + * |
|
1476 | + * @param string $subject |
|
1477 | + * @return ConvertHelper_URLFinder |
|
1478 | + */ |
|
1479 | 1479 | public static function createURLFinder(string $subject) : ConvertHelper_URLFinder |
1480 | 1480 | { |
1481 | 1481 | return new ConvertHelper_URLFinder($subject); |
@@ -50,7 +50,7 @@ discard block |
||
50 | 50 | * @param int $tabSize The amount of spaces per tab. |
51 | 51 | * @return string |
52 | 52 | */ |
53 | - public static function tabs2spaces(string $string, int $tabSize=4) : string |
|
53 | + public static function tabs2spaces(string $string, int $tabSize = 4) : string |
|
54 | 54 | { |
55 | 55 | return str_replace("\t", str_repeat(' ', $tabSize), $string); |
56 | 56 | } |
@@ -62,7 +62,7 @@ discard block |
||
62 | 62 | * @param int $tabSize The amount of spaces per tab in the source string. |
63 | 63 | * @return string |
64 | 64 | */ |
65 | - public static function spaces2tabs(string $string, int $tabSize=4) : string |
|
65 | + public static function spaces2tabs(string $string, int $tabSize = 4) : string |
|
66 | 66 | { |
67 | 67 | return str_replace(str_repeat(' ', $tabSize), "\t", $string); |
68 | 68 | } |
@@ -104,7 +104,7 @@ discard block |
||
104 | 104 | { |
105 | 105 | $converter = new ConvertHelper_DurationConverter(); |
106 | 106 | |
107 | - if($datefrom instanceof \DateTime) |
|
107 | + if ($datefrom instanceof \DateTime) |
|
108 | 108 | { |
109 | 109 | $converter->setDateFrom($datefrom); |
110 | 110 | } |
@@ -113,11 +113,11 @@ discard block |
||
113 | 113 | $converter->setDateFrom(self::timestamp2date($datefrom)); |
114 | 114 | } |
115 | 115 | |
116 | - if($dateto instanceof \DateTime) |
|
116 | + if ($dateto instanceof \DateTime) |
|
117 | 117 | { |
118 | 118 | $converter->setDateTo($dateto); |
119 | 119 | } |
120 | - else if($dateto > 0) |
|
120 | + else if ($dateto > 0) |
|
121 | 121 | { |
122 | 122 | $converter->setDateTo(self::timestamp2date($dateto)); |
123 | 123 | } |
@@ -147,7 +147,7 @@ discard block |
||
147 | 147 | * @deprecated Use the Highlighter class directly instead. |
148 | 148 | * @see Highlighter::xml() |
149 | 149 | */ |
150 | - public static function highlight_xml(string $xml, bool $formatSource=false) : string |
|
150 | + public static function highlight_xml(string $xml, bool $formatSource = false) : string |
|
151 | 151 | { |
152 | 152 | return Highlighter::xml($xml, $formatSource); |
153 | 153 | } |
@@ -208,16 +208,16 @@ discard block |
||
208 | 208 | return $text; |
209 | 209 | } |
210 | 210 | |
211 | - $text = trim(mb_substr($text, 0, $targetLength)) . $append; |
|
211 | + $text = trim(mb_substr($text, 0, $targetLength)).$append; |
|
212 | 212 | |
213 | 213 | return $text; |
214 | 214 | } |
215 | 215 | |
216 | - public static function var_dump($var, $html=true) : string |
|
216 | + public static function var_dump($var, $html = true) : string |
|
217 | 217 | { |
218 | 218 | $info = parseVariable($var); |
219 | 219 | |
220 | - if($html) { |
|
220 | + if ($html) { |
|
221 | 221 | return $info->toHTML(); |
222 | 222 | } |
223 | 223 | |
@@ -232,11 +232,11 @@ discard block |
||
232 | 232 | * @param bool $html Whether to style the dump as HTML. |
233 | 233 | * @return string |
234 | 234 | */ |
235 | - public static function print_r($var, bool $return=false, bool $html=true) : string |
|
235 | + public static function print_r($var, bool $return = false, bool $html = true) : string |
|
236 | 236 | { |
237 | 237 | $result = parseVariable($var)->enableType()->toString(); |
238 | 238 | |
239 | - if($html) |
|
239 | + if ($html) |
|
240 | 240 | { |
241 | 241 | $result = |
242 | 242 | '<pre style="background:#fff;color:#333;padding:16px;border:solid 1px #bbb;border-radius:4px">'. |
@@ -244,7 +244,7 @@ discard block |
||
244 | 244 | '</pre>'; |
245 | 245 | } |
246 | 246 | |
247 | - if(!$return) |
|
247 | + if (!$return) |
|
248 | 248 | { |
249 | 249 | echo $result; |
250 | 250 | } |
@@ -275,17 +275,17 @@ discard block |
||
275 | 275 | */ |
276 | 276 | public static function string2bool($string) : bool |
277 | 277 | { |
278 | - if($string === '' || $string === null || !is_scalar($string)) |
|
278 | + if ($string === '' || $string === null || !is_scalar($string)) |
|
279 | 279 | { |
280 | 280 | return false; |
281 | 281 | } |
282 | 282 | |
283 | - if(is_bool($string)) |
|
283 | + if (is_bool($string)) |
|
284 | 284 | { |
285 | 285 | return $string; |
286 | 286 | } |
287 | 287 | |
288 | - if(array_key_exists($string, self::$booleanStrings)) |
|
288 | + if (array_key_exists($string, self::$booleanStrings)) |
|
289 | 289 | { |
290 | 290 | return self::$booleanStrings[$string]; |
291 | 291 | } |
@@ -340,10 +340,10 @@ discard block |
||
340 | 340 | public static function date2listLabel(\DateTime $date, $includeTime = false, $shortMonth = false) |
341 | 341 | { |
342 | 342 | $today = new \DateTime(); |
343 | - if($date->format('d.m.Y') == $today->format('d.m.Y')) { |
|
343 | + if ($date->format('d.m.Y') == $today->format('d.m.Y')) { |
|
344 | 344 | $label = t('Today'); |
345 | 345 | } else { |
346 | - $label = $date->format('d') . '. ' . self::month2string((int)$date->format('m'), $shortMonth) . ' '; |
|
346 | + $label = $date->format('d').'. '.self::month2string((int)$date->format('m'), $shortMonth).' '; |
|
347 | 347 | if ($date->format('Y') != date('Y')) { |
348 | 348 | $label .= $date->format('Y'); |
349 | 349 | } |
@@ -503,12 +503,12 @@ discard block |
||
503 | 503 | $output = ''; |
504 | 504 | $split = str_split($unicodeChar); |
505 | 505 | |
506 | - foreach($split as $octet) |
|
506 | + foreach ($split as $octet) |
|
507 | 507 | { |
508 | 508 | $ordInt = ord($octet); |
509 | 509 | // Convert from int (base 10) to hex (base 16), for PHP \x syntax |
510 | 510 | $ordHex = base_convert((string)$ordInt, 10, 16); |
511 | - $output .= '\x' . $ordHex; |
|
511 | + $output .= '\x'.$ordHex; |
|
512 | 512 | } |
513 | 513 | |
514 | 514 | return $output; |
@@ -541,19 +541,19 @@ discard block |
||
541 | 541 | |
542 | 542 | protected static function convertScalarForComparison($scalar) |
543 | 543 | { |
544 | - if($scalar === '' || is_null($scalar)) { |
|
544 | + if ($scalar === '' || is_null($scalar)) { |
|
545 | 545 | return null; |
546 | 546 | } |
547 | 547 | |
548 | - if(is_bool($scalar)) { |
|
548 | + if (is_bool($scalar)) { |
|
549 | 549 | return self::bool2string($scalar); |
550 | 550 | } |
551 | 551 | |
552 | - if(is_array($scalar)) { |
|
552 | + if (is_array($scalar)) { |
|
553 | 553 | $scalar = md5(serialize($scalar)); |
554 | 554 | } |
555 | 555 | |
556 | - if($scalar !== null && !is_scalar($scalar)) { |
|
556 | + if ($scalar !== null && !is_scalar($scalar)) { |
|
557 | 557 | throw new ConvertHelper_Exception( |
558 | 558 | 'Not a scalar value in comparison', |
559 | 559 | null, |
@@ -602,7 +602,7 @@ discard block |
||
602 | 602 | public static function bool2string($boolean, bool $yesno = false) : string |
603 | 603 | { |
604 | 604 | // allow 'yes', 'true', 'no', 'false' string notations as well |
605 | - if(!is_bool($boolean)) { |
|
605 | + if (!is_bool($boolean)) { |
|
606 | 606 | $boolean = self::string2bool($boolean); |
607 | 607 | } |
608 | 608 | |
@@ -643,15 +643,15 @@ discard block |
||
643 | 643 | public static function array2attributeString($array) |
644 | 644 | { |
645 | 645 | $tokens = array(); |
646 | - foreach($array as $attr => $value) { |
|
647 | - if($value == '' || $value == null) { |
|
646 | + foreach ($array as $attr => $value) { |
|
647 | + if ($value == '' || $value == null) { |
|
648 | 648 | continue; |
649 | 649 | } |
650 | 650 | |
651 | 651 | $tokens[] = $attr.'="'.$value.'"'; |
652 | 652 | } |
653 | 653 | |
654 | - if(empty($tokens)) { |
|
654 | + if (empty($tokens)) { |
|
655 | 655 | return ''; |
656 | 656 | } |
657 | 657 | |
@@ -666,10 +666,10 @@ discard block |
||
666 | 666 | * @param string $string |
667 | 667 | * @return string |
668 | 668 | */ |
669 | - public static function string2attributeJS($string, $quoted=true) |
|
669 | + public static function string2attributeJS($string, $quoted = true) |
|
670 | 670 | { |
671 | 671 | $converted = addslashes(htmlspecialchars(strip_tags($string), ENT_QUOTES, 'UTF-8')); |
672 | - if($quoted) { |
|
672 | + if ($quoted) { |
|
673 | 673 | $converted = "'".$converted."'"; |
674 | 674 | } |
675 | 675 | |
@@ -687,11 +687,11 @@ discard block |
||
687 | 687 | */ |
688 | 688 | public static function isBoolean($value) : bool |
689 | 689 | { |
690 | - if(is_bool($value)) { |
|
690 | + if (is_bool($value)) { |
|
691 | 691 | return true; |
692 | 692 | } |
693 | 693 | |
694 | - if(!is_scalar($value)) { |
|
694 | + if (!is_scalar($value)) { |
|
695 | 695 | return false; |
696 | 696 | } |
697 | 697 | |
@@ -707,7 +707,7 @@ discard block |
||
707 | 707 | public static function array2styleString(array $subject) : string |
708 | 708 | { |
709 | 709 | $tokens = array(); |
710 | - foreach($subject as $name => $value) { |
|
710 | + foreach ($subject as $name => $value) { |
|
711 | 711 | $tokens[] = $name.':'.$value; |
712 | 712 | } |
713 | 713 | |
@@ -765,7 +765,7 @@ discard block |
||
765 | 765 | * |
766 | 766 | * @see JSHelper::buildRegexStatement() |
767 | 767 | */ |
768 | - public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) |
|
768 | + public static function regex2js(string $regex, string $statementType = JSHelper::JS_REGEX_OBJECT) |
|
769 | 769 | { |
770 | 770 | return JSHelper::buildRegexStatement($regex, $statementType); |
771 | 771 | } |
@@ -782,11 +782,11 @@ discard block |
||
782 | 782 | * @throws ConvertHelper_Exception |
783 | 783 | * @return string |
784 | 784 | */ |
785 | - public static function var2json($variable, int $options=0, int $depth=512) : string |
|
785 | + public static function var2json($variable, int $options = 0, int $depth = 512) : string |
|
786 | 786 | { |
787 | 787 | $result = json_encode($variable, $options, $depth); |
788 | 788 | |
789 | - if($result !== false) { |
|
789 | + if ($result !== false) { |
|
790 | 790 | return $result; |
791 | 791 | } |
792 | 792 | |
@@ -811,10 +811,10 @@ discard block |
||
811 | 811 | public static function stripUTFBom($string) |
812 | 812 | { |
813 | 813 | $boms = FileHelper::getUTFBOMs(); |
814 | - foreach($boms as $bomChars) { |
|
814 | + foreach ($boms as $bomChars) { |
|
815 | 815 | $length = mb_strlen($bomChars); |
816 | 816 | $text = mb_substr($string, 0, $length); |
817 | - if($text==$bomChars) { |
|
817 | + if ($text == $bomChars) { |
|
818 | 818 | return mb_substr($string, $length); |
819 | 819 | } |
820 | 820 | } |
@@ -831,7 +831,7 @@ discard block |
||
831 | 831 | */ |
832 | 832 | public static function string2utf8($string) |
833 | 833 | { |
834 | - if(!self::isStringASCII($string)) { |
|
834 | + if (!self::isStringASCII($string)) { |
|
835 | 835 | return \ForceUTF8\Encoding::toUTF8($string); |
836 | 836 | } |
837 | 837 | |
@@ -849,11 +849,11 @@ discard block |
||
849 | 849 | */ |
850 | 850 | public static function isStringASCII($string) : bool |
851 | 851 | { |
852 | - if($string === '' || $string === NULL) { |
|
852 | + if ($string === '' || $string === NULL) { |
|
853 | 853 | return true; |
854 | 854 | } |
855 | 855 | |
856 | - if(!is_string($string)) { |
|
856 | + if (!is_string($string)) { |
|
857 | 857 | return false; |
858 | 858 | } |
859 | 859 | |
@@ -893,7 +893,7 @@ discard block |
||
893 | 893 | * @param array $options |
894 | 894 | * @return float |
895 | 895 | */ |
896 | - public static function matchString($source, $target, $options=array()) |
|
896 | + public static function matchString($source, $target, $options = array()) |
|
897 | 897 | { |
898 | 898 | $defaults = array( |
899 | 899 | 'maxLevenshtein' => 10, |
@@ -903,12 +903,12 @@ discard block |
||
903 | 903 | $options = array_merge($defaults, $options); |
904 | 904 | |
905 | 905 | // avoid doing this via levenshtein |
906 | - if($source == $target) { |
|
906 | + if ($source == $target) { |
|
907 | 907 | return 100; |
908 | 908 | } |
909 | 909 | |
910 | 910 | $diff = levenshtein($source, $target); |
911 | - if($diff > $options['maxLevenshtein']) { |
|
911 | + if ($diff > $options['maxLevenshtein']) { |
|
912 | 912 | return 0; |
913 | 913 | } |
914 | 914 | |
@@ -992,24 +992,24 @@ discard block |
||
992 | 992 | * @see ConvertHelper::INTERVAL_HOURS |
993 | 993 | * @see ConvertHelper::INTERVAL_DAYS |
994 | 994 | */ |
995 | - public static function interval2total(\DateInterval $interval, $unit=self::INTERVAL_SECONDS) : int |
|
995 | + public static function interval2total(\DateInterval $interval, $unit = self::INTERVAL_SECONDS) : int |
|
996 | 996 | { |
997 | 997 | $total = (int)$interval->format('%a'); |
998 | 998 | if ($unit == self::INTERVAL_DAYS) { |
999 | 999 | return $total; |
1000 | 1000 | } |
1001 | 1001 | |
1002 | - $total = ($total * 24) + ((int)$interval->h ); |
|
1002 | + $total = ($total * 24) + ((int)$interval->h); |
|
1003 | 1003 | if ($unit == self::INTERVAL_HOURS) { |
1004 | 1004 | return $total; |
1005 | 1005 | } |
1006 | 1006 | |
1007 | - $total = ($total * 60) + ((int)$interval->i ); |
|
1007 | + $total = ($total * 60) + ((int)$interval->i); |
|
1008 | 1008 | if ($unit == self::INTERVAL_MINUTES) { |
1009 | 1009 | return $total; |
1010 | 1010 | } |
1011 | 1011 | |
1012 | - $total = ($total * 60) + ((int)$interval->s ); |
|
1012 | + $total = ($total * 60) + ((int)$interval->s); |
|
1013 | 1013 | if ($unit == self::INTERVAL_SECONDS) { |
1014 | 1014 | return $total; |
1015 | 1015 | } |
@@ -1038,13 +1038,13 @@ discard block |
||
1038 | 1038 | * @param bool $short |
1039 | 1039 | * @return string|NULL |
1040 | 1040 | */ |
1041 | - public static function date2dayName(\DateTime $date, bool $short=false) |
|
1041 | + public static function date2dayName(\DateTime $date, bool $short = false) |
|
1042 | 1042 | { |
1043 | 1043 | $day = $date->format('l'); |
1044 | 1044 | $invariant = self::getDayNamesInvariant(); |
1045 | 1045 | |
1046 | 1046 | $idx = array_search($day, $invariant); |
1047 | - if($idx !== false) { |
|
1047 | + if ($idx !== false) { |
|
1048 | 1048 | $localized = self::getDayNames($short); |
1049 | 1049 | return $localized[$idx]; |
1050 | 1050 | } |
@@ -1067,10 +1067,10 @@ discard block |
||
1067 | 1067 | * @param bool $short |
1068 | 1068 | * @return array |
1069 | 1069 | */ |
1070 | - public static function getDayNames(bool $short=false) : array |
|
1070 | + public static function getDayNames(bool $short = false) : array |
|
1071 | 1071 | { |
1072 | - if($short) { |
|
1073 | - if(!isset(self::$daysShort)) { |
|
1072 | + if ($short) { |
|
1073 | + if (!isset(self::$daysShort)) { |
|
1074 | 1074 | self::$daysShort = array( |
1075 | 1075 | t('Mon'), |
1076 | 1076 | t('Tue'), |
@@ -1085,7 +1085,7 @@ discard block |
||
1085 | 1085 | return self::$daysShort; |
1086 | 1086 | } |
1087 | 1087 | |
1088 | - if(!isset(self::$days)) { |
|
1088 | + if (!isset(self::$days)) { |
|
1089 | 1089 | self::$days = array( |
1090 | 1090 | t('Monday'), |
1091 | 1091 | t('Tuesday'), |
@@ -1110,17 +1110,17 @@ discard block |
||
1110 | 1110 | */ |
1111 | 1111 | public static function implodeWithAnd(array $list, $sep = ', ', $conjunction = null) |
1112 | 1112 | { |
1113 | - if(empty($list)) { |
|
1113 | + if (empty($list)) { |
|
1114 | 1114 | return ''; |
1115 | 1115 | } |
1116 | 1116 | |
1117 | - if(empty($conjunction)) { |
|
1117 | + if (empty($conjunction)) { |
|
1118 | 1118 | $conjunction = t('and'); |
1119 | 1119 | } |
1120 | 1120 | |
1121 | 1121 | $last = array_pop($list); |
1122 | - if($list) { |
|
1123 | - return implode($sep, $list) . $conjunction . ' ' . $last; |
|
1122 | + if ($list) { |
|
1123 | + return implode($sep, $list).$conjunction.' '.$last; |
|
1124 | 1124 | } |
1125 | 1125 | |
1126 | 1126 | return $last; |
@@ -1139,7 +1139,7 @@ discard block |
||
1139 | 1139 | public static function string2array(string $string) : array |
1140 | 1140 | { |
1141 | 1141 | $result = preg_split('//u', $string, null, PREG_SPLIT_NO_EMPTY); |
1142 | - if($result !== false) { |
|
1142 | + if ($result !== false) { |
|
1143 | 1143 | return $result; |
1144 | 1144 | } |
1145 | 1145 | |
@@ -1154,12 +1154,12 @@ discard block |
||
1154 | 1154 | */ |
1155 | 1155 | public static function isStringHTML(string $string) : bool |
1156 | 1156 | { |
1157 | - if(preg_match('%<[a-z/][\s\S]*>%siU', $string)) { |
|
1157 | + if (preg_match('%<[a-z/][\s\S]*>%siU', $string)) { |
|
1158 | 1158 | return true; |
1159 | 1159 | } |
1160 | 1160 | |
1161 | 1161 | $decoded = html_entity_decode($string); |
1162 | - if($decoded !== $string) { |
|
1162 | + if ($decoded !== $string) { |
|
1163 | 1163 | return true; |
1164 | 1164 | } |
1165 | 1165 | |
@@ -1268,14 +1268,14 @@ discard block |
||
1268 | 1268 | * @param bool $caseInsensitive |
1269 | 1269 | * @return ConvertHelper_StringMatch[] |
1270 | 1270 | */ |
1271 | - public static function findString(string $needle, string $haystack, bool $caseInsensitive=false) |
|
1271 | + public static function findString(string $needle, string $haystack, bool $caseInsensitive = false) |
|
1272 | 1272 | { |
1273 | - if($needle === '') { |
|
1273 | + if ($needle === '') { |
|
1274 | 1274 | return array(); |
1275 | 1275 | } |
1276 | 1276 | |
1277 | 1277 | $function = 'mb_strpos'; |
1278 | - if($caseInsensitive) { |
|
1278 | + if ($caseInsensitive) { |
|
1279 | 1279 | $function = 'mb_stripos'; |
1280 | 1280 | } |
1281 | 1281 | |
@@ -1283,7 +1283,7 @@ discard block |
||
1283 | 1283 | $positions = array(); |
1284 | 1284 | $length = mb_strlen($needle); |
1285 | 1285 | |
1286 | - while( ($pos = $function($haystack, $needle, $pos)) !== false) |
|
1286 | + while (($pos = $function($haystack, $needle, $pos)) !== false) |
|
1287 | 1287 | { |
1288 | 1288 | $match = mb_substr($haystack, $pos, $length); |
1289 | 1289 | $positions[] = new ConvertHelper_StringMatch($pos, $match); |
@@ -1303,7 +1303,7 @@ discard block |
||
1303 | 1303 | */ |
1304 | 1304 | public static function explodeTrim(string $delimiter, string $string) : array |
1305 | 1305 | { |
1306 | - if(empty($string) || empty($delimiter)) { |
|
1306 | + if (empty($string) || empty($delimiter)) { |
|
1307 | 1307 | return array(); |
1308 | 1308 | } |
1309 | 1309 | |
@@ -1311,8 +1311,8 @@ discard block |
||
1311 | 1311 | $tokens = array_map('trim', $tokens); |
1312 | 1312 | |
1313 | 1313 | $keep = array(); |
1314 | - foreach($tokens as $token) { |
|
1315 | - if($token !== '') { |
|
1314 | + foreach ($tokens as $token) { |
|
1315 | + if ($token !== '') { |
|
1316 | 1316 | $keep[] = $token; |
1317 | 1317 | } |
1318 | 1318 | } |
@@ -1330,11 +1330,11 @@ discard block |
||
1330 | 1330 | */ |
1331 | 1331 | public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL |
1332 | 1332 | { |
1333 | - if(empty($subjectString)) { |
|
1333 | + if (empty($subjectString)) { |
|
1334 | 1334 | return null; |
1335 | 1335 | } |
1336 | 1336 | |
1337 | - if(!isset(self::$eolChars)) |
|
1337 | + if (!isset(self::$eolChars)) |
|
1338 | 1338 | { |
1339 | 1339 | $cr = chr((int)hexdec('0d')); |
1340 | 1340 | $lf = chr((int)hexdec('0a')); |
@@ -1365,18 +1365,18 @@ discard block |
||
1365 | 1365 | |
1366 | 1366 | $max = 0; |
1367 | 1367 | $results = array(); |
1368 | - foreach(self::$eolChars as $def) |
|
1368 | + foreach (self::$eolChars as $def) |
|
1369 | 1369 | { |
1370 | 1370 | $amount = substr_count($subjectString, $def['char']); |
1371 | 1371 | |
1372 | - if($amount > $max) |
|
1372 | + if ($amount > $max) |
|
1373 | 1373 | { |
1374 | 1374 | $max = $amount; |
1375 | 1375 | $results[] = $def; |
1376 | 1376 | } |
1377 | 1377 | } |
1378 | 1378 | |
1379 | - if(empty($results)) { |
|
1379 | + if (empty($results)) { |
|
1380 | 1380 | return null; |
1381 | 1381 | } |
1382 | 1382 | |
@@ -1396,9 +1396,9 @@ discard block |
||
1396 | 1396 | */ |
1397 | 1397 | public static function arrayRemoveKeys(array &$array, array $keys) : void |
1398 | 1398 | { |
1399 | - foreach($keys as $key) |
|
1399 | + foreach ($keys as $key) |
|
1400 | 1400 | { |
1401 | - if(array_key_exists($key, $array)) { |
|
1401 | + if (array_key_exists($key, $array)) { |
|
1402 | 1402 | unset($array[$key]); |
1403 | 1403 | } |
1404 | 1404 | } |
@@ -1413,17 +1413,17 @@ discard block |
||
1413 | 1413 | */ |
1414 | 1414 | public static function isInteger($value) : bool |
1415 | 1415 | { |
1416 | - if(is_int($value)) { |
|
1416 | + if (is_int($value)) { |
|
1417 | 1417 | return true; |
1418 | 1418 | } |
1419 | 1419 | |
1420 | 1420 | // booleans get converted to numbers, so they would |
1421 | 1421 | // actually match the regex. |
1422 | - if(is_bool($value)) { |
|
1422 | + if (is_bool($value)) { |
|
1423 | 1423 | return false; |
1424 | 1424 | } |
1425 | 1425 | |
1426 | - if(is_string($value) && $value !== '') { |
|
1426 | + if (is_string($value) && $value !== '') { |
|
1427 | 1427 | return preg_match('/\A-?\d+\z/', $value) === 1; |
1428 | 1428 | } |
1429 | 1429 |