@@ -23,9 +23,9 @@ discard block |
||
23 | 23 | */ |
24 | 24 | class ConvertHelper_ByteConverter |
25 | 25 | { |
26 | - /** |
|
27 | - * @var int |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var int |
|
28 | + */ |
|
29 | 29 | protected $bytes; |
30 | 30 | |
31 | 31 | public function __construct(int $bytes) |
@@ -39,12 +39,12 @@ discard block |
||
39 | 39 | } |
40 | 40 | } |
41 | 41 | |
42 | - /** |
|
43 | - * Detects the size matching the byte value for the specified base. |
|
44 | - * |
|
45 | - * @param int $base |
|
46 | - * @return ConvertHelper_StorageSizeEnum_Size |
|
47 | - */ |
|
42 | + /** |
|
43 | + * Detects the size matching the byte value for the specified base. |
|
44 | + * |
|
45 | + * @param int $base |
|
46 | + * @return ConvertHelper_StorageSizeEnum_Size |
|
47 | + */ |
|
48 | 48 | protected function detectSize(int $base) : ConvertHelper_StorageSizeEnum_Size |
49 | 49 | { |
50 | 50 | $sizes = $this->getSizesSorted($base); |
@@ -70,13 +70,13 @@ discard block |
||
70 | 70 | return ConvertHelper_StorageSizeEnum::getSizeByName('b'); |
71 | 71 | } |
72 | 72 | |
73 | - /** |
|
74 | - * Retrieves all storage sizes for the specified base, |
|
75 | - * sorted from smallest byte size to highest. |
|
76 | - * |
|
77 | - * @param int $base |
|
78 | - * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[] |
|
79 | - */ |
|
73 | + /** |
|
74 | + * Retrieves all storage sizes for the specified base, |
|
75 | + * sorted from smallest byte size to highest. |
|
76 | + * |
|
77 | + * @param int $base |
|
78 | + * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[] |
|
79 | + */ |
|
80 | 80 | protected function getSizesSorted(int $base) |
81 | 81 | { |
82 | 82 | $sizes = ConvertHelper_StorageSizeEnum::getSizesByBase($base); |
@@ -89,16 +89,16 @@ discard block |
||
89 | 89 | return $sizes; |
90 | 90 | } |
91 | 91 | |
92 | - /** |
|
93 | - * Converts the byte value to a human readable string, e.g. "5 KB", "140 MB". |
|
94 | - * |
|
95 | - * @param int $precision The amount of decimals (rounded up) |
|
96 | - * @param int $base The base to calculate bytes with. |
|
97 | - * @return string |
|
98 | - * |
|
99 | - * @see ConvertHelper_StorageSizeEnum::BASE_10 |
|
100 | - * @see ConvertHelper_StorageSizeEnum::BASE_2 |
|
101 | - */ |
|
92 | + /** |
|
93 | + * Converts the byte value to a human readable string, e.g. "5 KB", "140 MB". |
|
94 | + * |
|
95 | + * @param int $precision The amount of decimals (rounded up) |
|
96 | + * @param int $base The base to calculate bytes with. |
|
97 | + * @return string |
|
98 | + * |
|
99 | + * @see ConvertHelper_StorageSizeEnum::BASE_10 |
|
100 | + * @see ConvertHelper_StorageSizeEnum::BASE_2 |
|
101 | + */ |
|
102 | 102 | public function toString(int $precision, int $base=ConvertHelper_StorageSizeEnum::BASE_10) : string |
103 | 103 | { |
104 | 104 | $size = $this->detectSize($base); |
@@ -106,13 +106,13 @@ discard block |
||
106 | 106 | return round($this->bytes / $size->getBytes(), $precision) . ' ' . $size->getSuffix(); |
107 | 107 | } |
108 | 108 | |
109 | - /** |
|
110 | - * Converts the byte value to the amount of the corresponding units (KB, MB...). |
|
111 | - * |
|
112 | - * @param int $precision The amount of decimals (rounded up) |
|
113 | - * @param string $sizeName The lowercase storage size name (e.g. "kb", "kib") |
|
114 | - * @return float |
|
115 | - */ |
|
109 | + /** |
|
110 | + * Converts the byte value to the amount of the corresponding units (KB, MB...). |
|
111 | + * |
|
112 | + * @param int $precision The amount of decimals (rounded up) |
|
113 | + * @param string $sizeName The lowercase storage size name (e.g. "kb", "kib") |
|
114 | + * @return float |
|
115 | + */ |
|
116 | 116 | public function toNumber(int $precision, string $sizeName) : float |
117 | 117 | { |
118 | 118 | $size = ConvertHelper_StorageSizeEnum::getSizeByName($sizeName); |
@@ -120,56 +120,56 @@ discard block |
||
120 | 120 | return round($this->bytes / $size->getBytes(), $precision); |
121 | 121 | } |
122 | 122 | |
123 | - /** |
|
124 | - * Converts the bytes to Kilobytes. |
|
125 | - * |
|
126 | - * @param int $precision Amount of decimals (rounded up) |
|
127 | - * @return float |
|
128 | - */ |
|
123 | + /** |
|
124 | + * Converts the bytes to Kilobytes. |
|
125 | + * |
|
126 | + * @param int $precision Amount of decimals (rounded up) |
|
127 | + * @return float |
|
128 | + */ |
|
129 | 129 | public function toKilobytes(int $precision=1) : float |
130 | 130 | { |
131 | 131 | return $this->toNumber($precision, 'kb'); |
132 | 132 | } |
133 | 133 | |
134 | - /** |
|
135 | - * Converts the bytes to Megabytes. |
|
136 | - * |
|
137 | - * @param int $precision Amount of decimals (rounded up) |
|
138 | - * @return float |
|
139 | - */ |
|
134 | + /** |
|
135 | + * Converts the bytes to Megabytes. |
|
136 | + * |
|
137 | + * @param int $precision Amount of decimals (rounded up) |
|
138 | + * @return float |
|
139 | + */ |
|
140 | 140 | public function toMegabytes(int $precision=1) : float |
141 | 141 | { |
142 | 142 | return $this->toNumber($precision, 'mb'); |
143 | 143 | } |
144 | 144 | |
145 | - /** |
|
146 | - * Converts the bytes to Gigabytes. |
|
147 | - * |
|
148 | - * @param int $precision Amount of decimals (rounded up) |
|
149 | - * @return float |
|
150 | - */ |
|
145 | + /** |
|
146 | + * Converts the bytes to Gigabytes. |
|
147 | + * |
|
148 | + * @param int $precision Amount of decimals (rounded up) |
|
149 | + * @return float |
|
150 | + */ |
|
151 | 151 | public function toGigabytes(int $precision=1) : float |
152 | 152 | { |
153 | 153 | return $this->toNumber($precision, 'gb'); |
154 | 154 | } |
155 | 155 | |
156 | - /** |
|
157 | - * Converts the bytes to Terabytes. |
|
158 | - * |
|
159 | - * @param int $precision Amount of decimals (rounded up) |
|
160 | - * @return float |
|
161 | - */ |
|
156 | + /** |
|
157 | + * Converts the bytes to Terabytes. |
|
158 | + * |
|
159 | + * @param int $precision Amount of decimals (rounded up) |
|
160 | + * @return float |
|
161 | + */ |
|
162 | 162 | public function toTerabytes(int $precision=1) : float |
163 | 163 | { |
164 | 164 | return $this->toNumber($precision, 'tb'); |
165 | 165 | } |
166 | 166 | |
167 | - /** |
|
168 | - * Converts the bytes to Petabytes. |
|
169 | - * |
|
170 | - * @param int $precision Amount of decimals (rounded up) |
|
171 | - * @return float |
|
172 | - */ |
|
167 | + /** |
|
168 | + * Converts the bytes to Petabytes. |
|
169 | + * |
|
170 | + * @param int $precision Amount of decimals (rounded up) |
|
171 | + * @return float |
|
172 | + */ |
|
173 | 173 | public function toPetabytes(int $precision=1) : float |
174 | 174 | { |
175 | 175 | return $this->toNumber($precision, 'pb'); |
@@ -33,7 +33,7 @@ discard block |
||
33 | 33 | $this->bytes = $bytes; |
34 | 34 | |
35 | 35 | // correct negative values |
36 | - if($this->bytes < 0) |
|
36 | + if ($this->bytes < 0) |
|
37 | 37 | { |
38 | 38 | $this->bytes = 0; |
39 | 39 | } |
@@ -49,19 +49,19 @@ discard block |
||
49 | 49 | { |
50 | 50 | $sizes = $this->getSizesSorted($base); |
51 | 51 | |
52 | - if($this->bytes >= $sizes[0]->getBytes()) |
|
52 | + if ($this->bytes >= $sizes[0]->getBytes()) |
|
53 | 53 | { |
54 | 54 | $total = count($sizes); |
55 | 55 | |
56 | - for($i=0; $i < $total; $i++) |
|
56 | + for ($i = 0; $i < $total; $i++) |
|
57 | 57 | { |
58 | 58 | $size = $sizes[$i]; |
59 | 59 | |
60 | - if(!isset($sizes[($i+1)])) { |
|
60 | + if (!isset($sizes[($i + 1)])) { |
|
61 | 61 | return $size; |
62 | 62 | } |
63 | 63 | |
64 | - if($this->bytes >= $size->getBytes() && $this->bytes < $sizes[($i+1)]->getBytes()) { |
|
64 | + if ($this->bytes >= $size->getBytes() && $this->bytes < $sizes[($i + 1)]->getBytes()) { |
|
65 | 65 | return $size; |
66 | 66 | } |
67 | 67 | } |
@@ -99,11 +99,11 @@ discard block |
||
99 | 99 | * @see ConvertHelper_StorageSizeEnum::BASE_10 |
100 | 100 | * @see ConvertHelper_StorageSizeEnum::BASE_2 |
101 | 101 | */ |
102 | - public function toString(int $precision, int $base=ConvertHelper_StorageSizeEnum::BASE_10) : string |
|
102 | + public function toString(int $precision, int $base = ConvertHelper_StorageSizeEnum::BASE_10) : string |
|
103 | 103 | { |
104 | 104 | $size = $this->detectSize($base); |
105 | 105 | |
106 | - return round($this->bytes / $size->getBytes(), $precision) . ' ' . $size->getSuffix(); |
|
106 | + return round($this->bytes / $size->getBytes(), $precision).' '.$size->getSuffix(); |
|
107 | 107 | } |
108 | 108 | |
109 | 109 | /** |
@@ -126,7 +126,7 @@ discard block |
||
126 | 126 | * @param int $precision Amount of decimals (rounded up) |
127 | 127 | * @return float |
128 | 128 | */ |
129 | - public function toKilobytes(int $precision=1) : float |
|
129 | + public function toKilobytes(int $precision = 1) : float |
|
130 | 130 | { |
131 | 131 | return $this->toNumber($precision, 'kb'); |
132 | 132 | } |
@@ -137,7 +137,7 @@ discard block |
||
137 | 137 | * @param int $precision Amount of decimals (rounded up) |
138 | 138 | * @return float |
139 | 139 | */ |
140 | - public function toMegabytes(int $precision=1) : float |
|
140 | + public function toMegabytes(int $precision = 1) : float |
|
141 | 141 | { |
142 | 142 | return $this->toNumber($precision, 'mb'); |
143 | 143 | } |
@@ -148,7 +148,7 @@ discard block |
||
148 | 148 | * @param int $precision Amount of decimals (rounded up) |
149 | 149 | * @return float |
150 | 150 | */ |
151 | - public function toGigabytes(int $precision=1) : float |
|
151 | + public function toGigabytes(int $precision = 1) : float |
|
152 | 152 | { |
153 | 153 | return $this->toNumber($precision, 'gb'); |
154 | 154 | } |
@@ -159,7 +159,7 @@ discard block |
||
159 | 159 | * @param int $precision Amount of decimals (rounded up) |
160 | 160 | * @return float |
161 | 161 | */ |
162 | - public function toTerabytes(int $precision=1) : float |
|
162 | + public function toTerabytes(int $precision = 1) : float |
|
163 | 163 | { |
164 | 164 | return $this->toNumber($precision, 'tb'); |
165 | 165 | } |
@@ -170,7 +170,7 @@ discard block |
||
170 | 170 | * @param int $precision Amount of decimals (rounded up) |
171 | 171 | * @return float |
172 | 172 | */ |
173 | - public function toPetabytes(int $precision=1) : float |
|
173 | + public function toPetabytes(int $precision = 1) : float |
|
174 | 174 | { |
175 | 175 | return $this->toNumber($precision, 'pb'); |
176 | 176 | } |
@@ -181,7 +181,7 @@ discard block |
||
181 | 181 | * @param int $precision Amount of decimals (rounded up) |
182 | 182 | * @return float |
183 | 183 | */ |
184 | - public function toKibibytes(int $precision=1) : float |
|
184 | + public function toKibibytes(int $precision = 1) : float |
|
185 | 185 | { |
186 | 186 | return $this->toNumber($precision, 'kib'); |
187 | 187 | } |
@@ -192,7 +192,7 @@ discard block |
||
192 | 192 | * @param int $precision Amount of decimals (rounded up) |
193 | 193 | * @return float |
194 | 194 | */ |
195 | - public function toMebibytes(int $precision=1) : float |
|
195 | + public function toMebibytes(int $precision = 1) : float |
|
196 | 196 | { |
197 | 197 | return $this->toNumber($precision, 'mib'); |
198 | 198 | } |
@@ -203,7 +203,7 @@ discard block |
||
203 | 203 | * @param int $precision Amount of decimals (rounded up) |
204 | 204 | * @return float |
205 | 205 | */ |
206 | - public function toGibibytes(int $precision=1) : float |
|
206 | + public function toGibibytes(int $precision = 1) : float |
|
207 | 207 | { |
208 | 208 | return $this->toNumber($precision, 'gib'); |
209 | 209 | } |
@@ -214,7 +214,7 @@ discard block |
||
214 | 214 | * @param int $precision Amount of decimals (rounded up) |
215 | 215 | * @return float |
216 | 216 | */ |
217 | - public function toTebibytes(int $precision=1) : float |
|
217 | + public function toTebibytes(int $precision = 1) : float |
|
218 | 218 | { |
219 | 219 | return $this->toNumber($precision, 'tib'); |
220 | 220 | } |
@@ -225,7 +225,7 @@ discard block |
||
225 | 225 | * @param int $precision Amount of decimals (rounded up) |
226 | 226 | * @return float |
227 | 227 | */ |
228 | - public function toPebibytes(int $precision=1) : float |
|
228 | + public function toPebibytes(int $precision = 1) : float |
|
229 | 229 | { |
230 | 230 | return $this->toNumber($precision, 'pib'); |
231 | 231 | } |
@@ -26,39 +26,39 @@ discard block |
||
26 | 26 | const ERROR_NO_DATE_FROM_SET = 43401; |
27 | 27 | |
28 | 28 | |
29 | - /** |
|
30 | - * @var int |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var int |
|
31 | + */ |
|
32 | 32 | protected $dateFrom; |
33 | 33 | |
34 | - /** |
|
35 | - * @var int |
|
36 | - */ |
|
34 | + /** |
|
35 | + * @var int |
|
36 | + */ |
|
37 | 37 | protected $dateTo; |
38 | 38 | |
39 | - /** |
|
40 | - * @var bool |
|
41 | - */ |
|
39 | + /** |
|
40 | + * @var bool |
|
41 | + */ |
|
42 | 42 | protected $future = false; |
43 | 43 | |
44 | - /** |
|
45 | - * @var string |
|
46 | - */ |
|
44 | + /** |
|
45 | + * @var string |
|
46 | + */ |
|
47 | 47 | protected $interval = ''; |
48 | 48 | |
49 | - /** |
|
50 | - * @var int |
|
51 | - */ |
|
49 | + /** |
|
50 | + * @var int |
|
51 | + */ |
|
52 | 52 | protected $difference = 0; |
53 | 53 | |
54 | - /** |
|
55 | - * @var int |
|
56 | - */ |
|
54 | + /** |
|
55 | + * @var int |
|
56 | + */ |
|
57 | 57 | protected $dateDiff = 0; |
58 | 58 | |
59 | - /** |
|
60 | - * @var array |
|
61 | - */ |
|
59 | + /** |
|
60 | + * @var array |
|
61 | + */ |
|
62 | 62 | protected static $texts; |
63 | 63 | |
64 | 64 | public function __construct() |
@@ -78,17 +78,17 @@ discard block |
||
78 | 78 | self::$texts = null; |
79 | 79 | } |
80 | 80 | |
81 | - /** |
|
82 | - * Sets the origin date to calculate from. |
|
83 | - * |
|
84 | - * NOTE: if this is further in the future than |
|
85 | - * the to: date, it will be considered as a |
|
86 | - * calculation for something to come, i.e. |
|
87 | - * "In two days". |
|
88 | - * |
|
89 | - * @param \DateTime $date |
|
90 | - * @return ConvertHelper_DurationConverter |
|
91 | - */ |
|
81 | + /** |
|
82 | + * Sets the origin date to calculate from. |
|
83 | + * |
|
84 | + * NOTE: if this is further in the future than |
|
85 | + * the to: date, it will be considered as a |
|
86 | + * calculation for something to come, i.e. |
|
87 | + * "In two days". |
|
88 | + * |
|
89 | + * @param \DateTime $date |
|
90 | + * @return ConvertHelper_DurationConverter |
|
91 | + */ |
|
92 | 92 | public function setDateFrom(\DateTime $date) : ConvertHelper_DurationConverter |
93 | 93 | { |
94 | 94 | $this->dateFrom = ConvertHelper::date2timestamp($date); |
@@ -96,13 +96,13 @@ discard block |
||
96 | 96 | return $this; |
97 | 97 | } |
98 | 98 | |
99 | - /** |
|
100 | - * Sets the date to calculate to. Defaults to |
|
101 | - * the current time if not set. |
|
102 | - * |
|
103 | - * @param \DateTime $date |
|
104 | - * @return ConvertHelper_DurationConverter |
|
105 | - */ |
|
99 | + /** |
|
100 | + * Sets the date to calculate to. Defaults to |
|
101 | + * the current time if not set. |
|
102 | + * |
|
103 | + * @param \DateTime $date |
|
104 | + * @return ConvertHelper_DurationConverter |
|
105 | + */ |
|
106 | 106 | public function setDateTo(\DateTime $date) : ConvertHelper_DurationConverter |
107 | 107 | { |
108 | 108 | $this->dateTo = ConvertHelper::date2timestamp($date); |
@@ -110,14 +110,14 @@ discard block |
||
110 | 110 | return $this; |
111 | 111 | } |
112 | 112 | |
113 | - /** |
|
114 | - * Converts the specified dates to a human readable string. |
|
115 | - * |
|
116 | - * @throws ConvertHelper_Exception |
|
117 | - * @return string |
|
118 | - * |
|
119 | - * @see ConvertHelper_DurationConverter::ERROR_NO_DATE_FROM_SET |
|
120 | - */ |
|
113 | + /** |
|
114 | + * Converts the specified dates to a human readable string. |
|
115 | + * |
|
116 | + * @throws ConvertHelper_Exception |
|
117 | + * @return string |
|
118 | + * |
|
119 | + * @see ConvertHelper_DurationConverter::ERROR_NO_DATE_FROM_SET |
|
120 | + */ |
|
121 | 121 | public function convert() : string |
122 | 122 | { |
123 | 123 | $this->initTexts(); |
@@ -31,46 +31,46 @@ discard block |
||
31 | 31 | |
32 | 32 | const VALIDATION_ERROR_NEGATIVE_VALUE = 43803; |
33 | 33 | |
34 | - /** |
|
35 | - * @var string |
|
36 | - */ |
|
34 | + /** |
|
35 | + * @var string |
|
36 | + */ |
|
37 | 37 | protected $size; |
38 | 38 | |
39 | - /** |
|
40 | - * @var integer |
|
41 | - */ |
|
39 | + /** |
|
40 | + * @var integer |
|
41 | + */ |
|
42 | 42 | protected $bytes = 0; |
43 | 43 | |
44 | - /** |
|
45 | - * @var bool |
|
46 | - */ |
|
44 | + /** |
|
45 | + * @var bool |
|
46 | + */ |
|
47 | 47 | protected $valid = true; |
48 | 48 | |
49 | - /** |
|
50 | - * @var string |
|
51 | - */ |
|
49 | + /** |
|
50 | + * @var string |
|
51 | + */ |
|
52 | 52 | protected $units = null; |
53 | 53 | |
54 | - /** |
|
55 | - * @var string |
|
56 | - */ |
|
54 | + /** |
|
55 | + * @var string |
|
56 | + */ |
|
57 | 57 | protected $number = ''; |
58 | 58 | |
59 | - /** |
|
60 | - * @var string |
|
61 | - */ |
|
59 | + /** |
|
60 | + * @var string |
|
61 | + */ |
|
62 | 62 | protected $errorMessage = ''; |
63 | 63 | |
64 | - /** |
|
65 | - * @var int |
|
66 | - */ |
|
64 | + /** |
|
65 | + * @var int |
|
66 | + */ |
|
67 | 67 | protected $errorCode = 0; |
68 | 68 | |
69 | - /** |
|
70 | - * Create a new instance for the specified size string. |
|
71 | - * |
|
72 | - * @param string $size A size notation in the format "50 MB", or a number of bytes without units. Spaces are ignored, so "50MB" = "50 MB" = " 50 MB ". Floating point values are accepted, both with dot and comma notation ("50.5" = "50,5"). To use Base 2 values, ose appropriate units, e.g. "50 MiB", "1.5 GiB". The units are case insensitive, so "50 MB" = "50 mb". |
|
73 | - */ |
|
69 | + /** |
|
70 | + * Create a new instance for the specified size string. |
|
71 | + * |
|
72 | + * @param string $size A size notation in the format "50 MB", or a number of bytes without units. Spaces are ignored, so "50MB" = "50 MB" = " 50 MB ". Floating point values are accepted, both with dot and comma notation ("50.5" = "50,5"). To use Base 2 values, ose appropriate units, e.g. "50 MiB", "1.5 GiB". The units are case insensitive, so "50 MB" = "50 mb". |
|
73 | + */ |
|
74 | 74 | public function __construct(string $size) |
75 | 75 | { |
76 | 76 | $this->size = $this->cleanString($size); |
@@ -78,31 +78,31 @@ discard block |
||
78 | 78 | $this->convert(); |
79 | 79 | } |
80 | 80 | |
81 | - /** |
|
82 | - * Gets the amount of bytes contained in the size notation. |
|
83 | - * @return int |
|
84 | - */ |
|
81 | + /** |
|
82 | + * Gets the amount of bytes contained in the size notation. |
|
83 | + * @return int |
|
84 | + */ |
|
85 | 85 | public function toBytes() : int |
86 | 86 | { |
87 | 87 | return $this->bytes; |
88 | 88 | } |
89 | 89 | |
90 | - /** |
|
91 | - * Converts the size notation to a human readable string, e.g. "50 MB". |
|
92 | - * |
|
93 | - * @param int $precision |
|
94 | - * @return string |
|
95 | - * @see ConvertHelper::bytes2readable() |
|
96 | - */ |
|
90 | + /** |
|
91 | + * Converts the size notation to a human readable string, e.g. "50 MB". |
|
92 | + * |
|
93 | + * @param int $precision |
|
94 | + * @return string |
|
95 | + * @see ConvertHelper::bytes2readable() |
|
96 | + */ |
|
97 | 97 | public function toString(int $precision=1) : string |
98 | 98 | { |
99 | 99 | return ConvertHelper::bytes2readable($this->bytes, $precision, $this->getBase()); |
100 | 100 | } |
101 | 101 | |
102 | - /** |
|
103 | - * Retrieves the detected number's base. |
|
104 | - * @return int The base number (1000 for Base 10, or 1024 for Base 2), or 0 if it is not valid. |
|
105 | - */ |
|
102 | + /** |
|
103 | + * Retrieves the detected number's base. |
|
104 | + * @return int The base number (1000 for Base 10, or 1024 for Base 2), or 0 if it is not valid. |
|
105 | + */ |
|
106 | 106 | public function getBase() : int |
107 | 107 | { |
108 | 108 | if(!$this->isValid()) { |
@@ -112,27 +112,27 @@ discard block |
||
112 | 112 | return $this->size->getBase(); |
113 | 113 | } |
114 | 114 | |
115 | - /** |
|
116 | - * Checks whether the size notation was valid and could be parsed |
|
117 | - * into a meaningful byte value. If this returns `false`, it is |
|
118 | - * possible to use the `getErrorXXX` methods to retrieve information |
|
119 | - * on what went wrong. |
|
120 | - * |
|
121 | - * @return bool |
|
122 | - * @see ConvertHelper_SizeNotation::getErrorMessage() |
|
123 | - * @see ConvertHelper_SizeNotation::getErrorCode() |
|
124 | - */ |
|
115 | + /** |
|
116 | + * Checks whether the size notation was valid and could be parsed |
|
117 | + * into a meaningful byte value. If this returns `false`, it is |
|
118 | + * possible to use the `getErrorXXX` methods to retrieve information |
|
119 | + * on what went wrong. |
|
120 | + * |
|
121 | + * @return bool |
|
122 | + * @see ConvertHelper_SizeNotation::getErrorMessage() |
|
123 | + * @see ConvertHelper_SizeNotation::getErrorCode() |
|
124 | + */ |
|
125 | 125 | public function isValid() : bool |
126 | 126 | { |
127 | 127 | return $this->valid; |
128 | 128 | } |
129 | 129 | |
130 | - /** |
|
131 | - * Retrieves the error message if the size notation validation failed. |
|
132 | - * |
|
133 | - * @return string |
|
134 | - * @see ConvertHelper_SizeNotation::getErrorCode() |
|
135 | - */ |
|
130 | + /** |
|
131 | + * Retrieves the error message if the size notation validation failed. |
|
132 | + * |
|
133 | + * @return string |
|
134 | + * @see ConvertHelper_SizeNotation::getErrorCode() |
|
135 | + */ |
|
136 | 136 | public function getErrorMessage() : string |
137 | 137 | { |
138 | 138 | return $this->errorMessage; |
@@ -179,12 +179,12 @@ discard block |
||
179 | 179 | ); |
180 | 180 | } |
181 | 181 | |
182 | - /** |
|
183 | - * Detects the units and the number in the size notation string. |
|
184 | - * Populates the `units` and `number` properties. |
|
185 | - * |
|
186 | - * @return bool Whether the string could be parsed successfully. |
|
187 | - */ |
|
182 | + /** |
|
183 | + * Detects the units and the number in the size notation string. |
|
184 | + * Populates the `units` and `number` properties. |
|
185 | + * |
|
186 | + * @return bool Whether the string could be parsed successfully. |
|
187 | + */ |
|
188 | 188 | protected function detectParts() : bool |
189 | 189 | { |
190 | 190 | $units = ConvertHelper_StorageSizeEnum::getSizeNames(); |
@@ -220,16 +220,16 @@ discard block |
||
220 | 220 | return true; |
221 | 221 | } |
222 | 222 | |
223 | - /** |
|
224 | - * If the validation fails, this is used to store the reason for retrieval later. |
|
225 | - * |
|
226 | - * @param string $message |
|
227 | - * @param int $code |
|
228 | - * |
|
229 | - * @see ConvertHelper_SizeNotation::isValid() |
|
230 | - * @see ConvertHelper_SizeNotation::getErrorMessage() |
|
231 | - * @see ConvertHelper_SizeNotation::getErrorCode() |
|
232 | - */ |
|
223 | + /** |
|
224 | + * If the validation fails, this is used to store the reason for retrieval later. |
|
225 | + * |
|
226 | + * @param string $message |
|
227 | + * @param int $code |
|
228 | + * |
|
229 | + * @see ConvertHelper_SizeNotation::isValid() |
|
230 | + * @see ConvertHelper_SizeNotation::getErrorMessage() |
|
231 | + * @see ConvertHelper_SizeNotation::getErrorCode() |
|
232 | + */ |
|
233 | 233 | protected function setError(string $message, int $code) : void |
234 | 234 | { |
235 | 235 | $this->valid = false; |
@@ -237,12 +237,12 @@ discard block |
||
237 | 237 | $this->errorCode = $code; |
238 | 238 | } |
239 | 239 | |
240 | - /** |
|
241 | - * Retrieves the error code, if the size notation validation failed. |
|
242 | - * |
|
243 | - * @return int |
|
244 | - * @see ConvertHelper_SizeNotation::getErrorMessage() |
|
245 | - */ |
|
240 | + /** |
|
241 | + * Retrieves the error code, if the size notation validation failed. |
|
242 | + * |
|
243 | + * @return int |
|
244 | + * @see ConvertHelper_SizeNotation::getErrorMessage() |
|
245 | + */ |
|
246 | 246 | public function getErrorCode() : int |
247 | 247 | { |
248 | 248 | return $this->errorCode; |
@@ -94,7 +94,7 @@ discard block |
||
94 | 94 | * @return string |
95 | 95 | * @see ConvertHelper::bytes2readable() |
96 | 96 | */ |
97 | - public function toString(int $precision=1) : string |
|
97 | + public function toString(int $precision = 1) : string |
|
98 | 98 | { |
99 | 99 | return ConvertHelper::bytes2readable($this->bytes, $precision, $this->getBase()); |
100 | 100 | } |
@@ -105,7 +105,7 @@ discard block |
||
105 | 105 | */ |
106 | 106 | public function getBase() : int |
107 | 107 | { |
108 | - if(!$this->isValid()) { |
|
108 | + if (!$this->isValid()) { |
|
109 | 109 | return 0; |
110 | 110 | } |
111 | 111 | |
@@ -154,18 +154,18 @@ discard block |
||
154 | 154 | |
155 | 155 | protected function parseSize() : void |
156 | 156 | { |
157 | - if(!$this->detectParts()) { |
|
157 | + if (!$this->detectParts()) { |
|
158 | 158 | return; |
159 | 159 | } |
160 | 160 | |
161 | 161 | // we detected units in the string: all good. |
162 | - if($this->units !== null) |
|
162 | + if ($this->units !== null) |
|
163 | 163 | { |
164 | 164 | return; |
165 | 165 | } |
166 | 166 | |
167 | 167 | // just a numeric value: we assume this means we're dealing with bytes. |
168 | - if(is_numeric($this->number)) |
|
168 | + if (is_numeric($this->number)) |
|
169 | 169 | { |
170 | 170 | $this->units = 'b'; |
171 | 171 | return; |
@@ -191,12 +191,12 @@ discard block |
||
191 | 191 | |
192 | 192 | $number = $this->size; |
193 | 193 | |
194 | - foreach($units as $unit) |
|
194 | + foreach ($units as $unit) |
|
195 | 195 | { |
196 | - if(stristr($number, $unit)) |
|
196 | + if (stristr($number, $unit)) |
|
197 | 197 | { |
198 | 198 | // there are more than 1 unit defined in the string |
199 | - if($this->units !== null) |
|
199 | + if ($this->units !== null) |
|
200 | 200 | { |
201 | 201 | $this->setError( |
202 | 202 | t( |
@@ -252,14 +252,14 @@ discard block |
||
252 | 252 | { |
253 | 253 | $this->parseSize(); |
254 | 254 | |
255 | - if(!$this->valid) { |
|
255 | + if (!$this->valid) { |
|
256 | 256 | return; |
257 | 257 | } |
258 | 258 | |
259 | 259 | $int = intval($this->number); |
260 | 260 | |
261 | 261 | // negative values |
262 | - if($int < 0) |
|
262 | + if ($int < 0) |
|
263 | 263 | { |
264 | 264 | $this->setError( |
265 | 265 | t('Negative values cannot be used as size.'), |
@@ -25,34 +25,34 @@ |
||
25 | 25 | */ |
26 | 26 | class ConvertHelper_StorageSizeEnum_Size |
27 | 27 | { |
28 | - /** |
|
29 | - * @var string |
|
30 | - */ |
|
28 | + /** |
|
29 | + * @var string |
|
30 | + */ |
|
31 | 31 | protected $name; |
32 | 32 | |
33 | - /** |
|
34 | - * @var int |
|
35 | - */ |
|
33 | + /** |
|
34 | + * @var int |
|
35 | + */ |
|
36 | 36 | protected $base; |
37 | 37 | |
38 | - /** |
|
39 | - * @var int |
|
40 | - */ |
|
38 | + /** |
|
39 | + * @var int |
|
40 | + */ |
|
41 | 41 | protected $exponent; |
42 | 42 | |
43 | - /** |
|
44 | - * @var string |
|
45 | - */ |
|
43 | + /** |
|
44 | + * @var string |
|
45 | + */ |
|
46 | 46 | protected $singular; |
47 | 47 | |
48 | - /** |
|
49 | - * @var string |
|
50 | - */ |
|
48 | + /** |
|
49 | + * @var string |
|
50 | + */ |
|
51 | 51 | protected $plural; |
52 | 52 | |
53 | - /** |
|
54 | - * @var string |
|
55 | - */ |
|
53 | + /** |
|
54 | + * @var string |
|
55 | + */ |
|
56 | 56 | protected $suffix; |
57 | 57 | |
58 | 58 | public function __construct(string $name, int $base, int $exponent, string $suffix, string $singular, string $plural) |
@@ -20,27 +20,27 @@ discard block |
||
20 | 20 | |
21 | 21 | const BASE_2 = 1024; |
22 | 22 | |
23 | - /** |
|
24 | - * @var ConvertHelper_StorageSizeEnum_Size |
|
25 | - */ |
|
23 | + /** |
|
24 | + * @var ConvertHelper_StorageSizeEnum_Size |
|
25 | + */ |
|
26 | 26 | protected static $sizes; |
27 | 27 | |
28 | - /** |
|
29 | - * Stores the supported unit notations, and |
|
30 | - * how they are supposed to be calculated. |
|
31 | - * |
|
32 | - * The `base` key: This defines how many bytes there are |
|
33 | - * in a kilobyte, to differentiate with the two |
|
34 | - * common way to calculate sizes: base 10 or base 2. |
|
35 | - * See the Wikipedia link for more details. |
|
36 | - * |
|
37 | - * The `exponent` key: This defines the multiplier to |
|
38 | - * multiply the value with to get the target size. |
|
39 | - * |
|
40 | - * @var array |
|
41 | - * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
42 | - * @see ConvertHelper_SizeNotation::parseSize() |
|
43 | - */ |
|
28 | + /** |
|
29 | + * Stores the supported unit notations, and |
|
30 | + * how they are supposed to be calculated. |
|
31 | + * |
|
32 | + * The `base` key: This defines how many bytes there are |
|
33 | + * in a kilobyte, to differentiate with the two |
|
34 | + * common way to calculate sizes: base 10 or base 2. |
|
35 | + * See the Wikipedia link for more details. |
|
36 | + * |
|
37 | + * The `exponent` key: This defines the multiplier to |
|
38 | + * multiply the value with to get the target size. |
|
39 | + * |
|
40 | + * @var array |
|
41 | + * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
42 | + * @see ConvertHelper_SizeNotation::parseSize() |
|
43 | + */ |
|
44 | 44 | protected static function init() |
45 | 45 | { |
46 | 46 | if(isset(self::$sizes)) { |
@@ -69,13 +69,13 @@ discard block |
||
69 | 69 | } |
70 | 70 | } |
71 | 71 | |
72 | - /** |
|
73 | - * Called whenever the application locale is changed, |
|
74 | - * to reset the size definitions so the labels get |
|
75 | - * translated to the new locale. |
|
76 | - * |
|
77 | - * @param \AppLocalize\Localization_Event_LocaleChanged $event |
|
78 | - */ |
|
72 | + /** |
|
73 | + * Called whenever the application locale is changed, |
|
74 | + * to reset the size definitions so the labels get |
|
75 | + * translated to the new locale. |
|
76 | + * |
|
77 | + * @param \AppLocalize\Localization_Event_LocaleChanged $event |
|
78 | + */ |
|
79 | 79 | public static function handle_localeChanged(\AppLocalize\Localization_Event_LocaleChanged $event) |
80 | 80 | { |
81 | 81 | self::$sizes = null; |
@@ -93,10 +93,10 @@ discard block |
||
93 | 93 | ); |
94 | 94 | } |
95 | 95 | |
96 | - /** |
|
97 | - * Retrieves all known sizes. |
|
98 | - * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size |
|
99 | - */ |
|
96 | + /** |
|
97 | + * Retrieves all known sizes. |
|
98 | + * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size |
|
99 | + */ |
|
100 | 100 | public static function getSizes() |
101 | 101 | { |
102 | 102 | self::init(); |
@@ -123,10 +123,10 @@ discard block |
||
123 | 123 | ); |
124 | 124 | } |
125 | 125 | |
126 | - /** |
|
127 | - * Retrieves a list of all size names, e.g. "mb", "kib" (lowercase). |
|
128 | - * @return array |
|
129 | - */ |
|
126 | + /** |
|
127 | + * Retrieves a list of all size names, e.g. "mb", "kib" (lowercase). |
|
128 | + * @return array |
|
129 | + */ |
|
130 | 130 | public static function getSizeNames() : array |
131 | 131 | { |
132 | 132 | self::init(); |
@@ -43,7 +43,7 @@ discard block |
||
43 | 43 | */ |
44 | 44 | protected static function init() |
45 | 45 | { |
46 | - if(isset(self::$sizes)) { |
|
46 | + if (isset(self::$sizes)) { |
|
47 | 47 | return; |
48 | 48 | } |
49 | 49 | |
@@ -63,7 +63,7 @@ discard block |
||
63 | 63 | |
64 | 64 | self::addSize('b', 1, 1, t('B'), t('Byte'), t('Bytes')); |
65 | 65 | |
66 | - if(class_exists('AppLocalize\Localization')) |
|
66 | + if (class_exists('AppLocalize\Localization')) |
|
67 | 67 | { |
68 | 68 | \AppLocalize\Localization::onLocaleChanged(array(self::class, 'handle_localeChanged')); |
69 | 69 | } |
@@ -108,7 +108,7 @@ discard block |
||
108 | 108 | { |
109 | 109 | self::init(); |
110 | 110 | |
111 | - if(isset(self::$sizes[$name])) { |
|
111 | + if (isset(self::$sizes[$name])) { |
|
112 | 112 | return self::$sizes[$name]; |
113 | 113 | } |
114 | 114 | |
@@ -140,9 +140,9 @@ discard block |
||
140 | 140 | |
141 | 141 | $result = array(); |
142 | 142 | |
143 | - foreach(self::$sizes as $size) |
|
143 | + foreach (self::$sizes as $size) |
|
144 | 144 | { |
145 | - if($size->getBase() === $base) { |
|
145 | + if ($size->getBase() === $base) { |
|
146 | 146 | $result[] = $size; |
147 | 147 | } |
148 | 148 | } |
@@ -17,21 +17,20 @@ discard block |
||
17 | 17 | * @package Application Utils |
18 | 18 | * @subpackage ConvertHelper |
19 | 19 | * @author Sebastian Mordziol <[email protected]> |
20 | - |
|
21 | 20 | * @see ConvertHelper::interval2string() |
22 | 21 | */ |
23 | 22 | class ConvertHelper_IntervalConverter |
24 | 23 | { |
25 | 24 | const ERROR_MISSING_TRANSLATION = 43501; |
26 | 25 | |
27 | - /** |
|
28 | - * @var array |
|
29 | - */ |
|
26 | + /** |
|
27 | + * @var array |
|
28 | + */ |
|
30 | 29 | protected static $texts; |
31 | 30 | |
32 | - /** |
|
33 | - * @var array |
|
34 | - */ |
|
31 | + /** |
|
32 | + * @var array |
|
33 | + */ |
|
35 | 34 | protected $tokens = array('y', 'm', 'd', 'h', 'i', 's'); |
36 | 35 | |
37 | 36 | public function __construct() |
@@ -41,25 +40,25 @@ discard block |
||
41 | 40 | } |
42 | 41 | } |
43 | 42 | |
44 | - /** |
|
45 | - * Called whenever the application locale has changed, |
|
46 | - * to reset the internal translation cache. |
|
47 | - */ |
|
43 | + /** |
|
44 | + * Called whenever the application locale has changed, |
|
45 | + * to reset the internal translation cache. |
|
46 | + */ |
|
48 | 47 | public function handle_localeChanged() |
49 | 48 | { |
50 | 49 | self::$texts = null; |
51 | 50 | } |
52 | 51 | |
53 | - /** |
|
54 | - * Converts the specified interval to a human readable |
|
55 | - * string, e.g. "2 hours and 4 minutes". |
|
56 | - * |
|
57 | - * @param \DateInterval $interval |
|
58 | - * @return string |
|
59 | - * @throws ConvertHelper_Exception |
|
60 | - * |
|
61 | - * @see ConvertHelper_IntervalConverter::ERROR_MISSING_TRANSLATION |
|
62 | - */ |
|
52 | + /** |
|
53 | + * Converts the specified interval to a human readable |
|
54 | + * string, e.g. "2 hours and 4 minutes". |
|
55 | + * |
|
56 | + * @param \DateInterval $interval |
|
57 | + * @return string |
|
58 | + * @throws ConvertHelper_Exception |
|
59 | + * |
|
60 | + * @see ConvertHelper_IntervalConverter::ERROR_MISSING_TRANSLATION |
|
61 | + */ |
|
63 | 62 | public function toString(\DateInterval $interval) : string |
64 | 63 | { |
65 | 64 | $this->initTexts(); |
@@ -88,14 +87,14 @@ discard block |
||
88 | 87 | return t('%1$s and %2$s', implode(', ', $parts), $last); |
89 | 88 | } |
90 | 89 | |
91 | - /** |
|
92 | - * Translates the selected time token, e.g. "y" (for year). |
|
93 | - * |
|
94 | - * @param string $token |
|
95 | - * @param ConvertHelper_DateInterval $interval |
|
96 | - * @throws ConvertHelper_Exception |
|
97 | - * @return string |
|
98 | - */ |
|
90 | + /** |
|
91 | + * Translates the selected time token, e.g. "y" (for year). |
|
92 | + * |
|
93 | + * @param string $token |
|
94 | + * @param ConvertHelper_DateInterval $interval |
|
95 | + * @throws ConvertHelper_Exception |
|
96 | + * @return string |
|
97 | + */ |
|
99 | 98 | protected function translateToken(string $token, ConvertHelper_DateInterval $interval) : string |
100 | 99 | { |
101 | 100 | $value = $interval->getToken($token); |
@@ -123,13 +122,13 @@ discard block |
||
123 | 122 | ); |
124 | 123 | } |
125 | 124 | |
126 | - /** |
|
127 | - * Resolves all time tokens that need to be translated in |
|
128 | - * the subject interval, depending on its length. |
|
129 | - * |
|
130 | - * @param ConvertHelper_DateInterval $interval |
|
131 | - * @return array |
|
132 | - */ |
|
125 | + /** |
|
126 | + * Resolves all time tokens that need to be translated in |
|
127 | + * the subject interval, depending on its length. |
|
128 | + * |
|
129 | + * @param ConvertHelper_DateInterval $interval |
|
130 | + * @return array |
|
131 | + */ |
|
133 | 132 | protected function resolveTokens(ConvertHelper_DateInterval $interval) : array |
134 | 133 | { |
135 | 134 | $offset = 0; |
@@ -147,9 +146,9 @@ discard block |
||
147 | 146 | return array(); |
148 | 147 | } |
149 | 148 | |
150 | - /** |
|
151 | - * Initializes the translateable strings. |
|
152 | - */ |
|
149 | + /** |
|
150 | + * Initializes the translateable strings. |
|
151 | + */ |
|
153 | 152 | protected function initTexts() : void |
154 | 153 | { |
155 | 154 | if(isset(self::$texts)) { |
@@ -160,41 +160,41 @@ discard block |
||
160 | 160 | return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last; |
161 | 161 | } |
162 | 162 | |
163 | - /** |
|
164 | - * Converts a timestamp into an easily understandable |
|
165 | - * format, e.g. "2 hours", "1 day", "3 months" |
|
166 | - * |
|
167 | - * If you set the date to parameter, the difference |
|
168 | - * will be calculated between the two dates and not |
|
169 | - * the current time. |
|
170 | - * |
|
171 | - * @param integer|\DateTime $datefrom |
|
172 | - * @param integer|\DateTime $dateto |
|
173 | - * @return string |
|
174 | - */ |
|
163 | + /** |
|
164 | + * Converts a timestamp into an easily understandable |
|
165 | + * format, e.g. "2 hours", "1 day", "3 months" |
|
166 | + * |
|
167 | + * If you set the date to parameter, the difference |
|
168 | + * will be calculated between the two dates and not |
|
169 | + * the current time. |
|
170 | + * |
|
171 | + * @param integer|\DateTime $datefrom |
|
172 | + * @param integer|\DateTime $dateto |
|
173 | + * @return string |
|
174 | + */ |
|
175 | 175 | public static function duration2string($datefrom, $dateto = -1) : string |
176 | 176 | { |
177 | - $converter = new ConvertHelper_DurationConverter(); |
|
177 | + $converter = new ConvertHelper_DurationConverter(); |
|
178 | 178 | |
179 | - if($datefrom instanceof \DateTime) |
|
180 | - { |
|
181 | - $converter->setDateFrom($datefrom); |
|
182 | - } |
|
183 | - else |
|
184 | - { |
|
185 | - $converter->setDateFrom(self::timestamp2date($datefrom)); |
|
186 | - } |
|
179 | + if($datefrom instanceof \DateTime) |
|
180 | + { |
|
181 | + $converter->setDateFrom($datefrom); |
|
182 | + } |
|
183 | + else |
|
184 | + { |
|
185 | + $converter->setDateFrom(self::timestamp2date($datefrom)); |
|
186 | + } |
|
187 | 187 | |
188 | - if($dateto instanceof \DateTime) |
|
189 | - { |
|
190 | - $converter->setDateTo($dateto); |
|
191 | - } |
|
192 | - else if($dateto > 0) |
|
193 | - { |
|
194 | - $converter->setDateTo(self::timestamp2date($dateto)); |
|
195 | - } |
|
188 | + if($dateto instanceof \DateTime) |
|
189 | + { |
|
190 | + $converter->setDateTo($dateto); |
|
191 | + } |
|
192 | + else if($dateto > 0) |
|
193 | + { |
|
194 | + $converter->setDateTo(self::timestamp2date($dateto)); |
|
195 | + } |
|
196 | 196 | |
197 | - return $converter->convert(); |
|
197 | + return $converter->convert(); |
|
198 | 198 | } |
199 | 199 | |
200 | 200 | /** |
@@ -233,44 +233,44 @@ discard block |
||
233 | 233 | return $geshi->parse_code(); |
234 | 234 | } |
235 | 235 | |
236 | - /** |
|
237 | - * Converts a number of bytes to a human readable form, |
|
238 | - * e.g. xx Kb / xx Mb / xx Gb |
|
239 | - * |
|
240 | - * @param int $bytes The amount of bytes to convert. |
|
241 | - * @param int $precision The amount of decimals |
|
242 | - * @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). |
|
243 | - * @return string |
|
244 | - * |
|
245 | - * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
246 | - */ |
|
236 | + /** |
|
237 | + * Converts a number of bytes to a human readable form, |
|
238 | + * e.g. xx Kb / xx Mb / xx Gb |
|
239 | + * |
|
240 | + * @param int $bytes The amount of bytes to convert. |
|
241 | + * @param int $precision The amount of decimals |
|
242 | + * @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). |
|
243 | + * @return string |
|
244 | + * |
|
245 | + * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
246 | + */ |
|
247 | 247 | public static function bytes2readable(int $bytes, int $precision = 1, int $base = ConvertHelper_StorageSizeEnum::BASE_10) : string |
248 | 248 | { |
249 | 249 | return self::parseBytes($bytes)->toString($precision, $base); |
250 | 250 | } |
251 | 251 | |
252 | - /** |
|
253 | - * Parses a number of bytes, and creates a converter instance which |
|
254 | - * allows doing common operations with it. |
|
255 | - * |
|
256 | - * @param int $bytes |
|
257 | - * @return ConvertHelper_ByteConverter |
|
258 | - */ |
|
252 | + /** |
|
253 | + * Parses a number of bytes, and creates a converter instance which |
|
254 | + * allows doing common operations with it. |
|
255 | + * |
|
256 | + * @param int $bytes |
|
257 | + * @return ConvertHelper_ByteConverter |
|
258 | + */ |
|
259 | 259 | public static function parseBytes(int $bytes) : ConvertHelper_ByteConverter |
260 | 260 | { |
261 | 261 | return new ConvertHelper_ByteConverter($bytes); |
262 | 262 | } |
263 | 263 | |
264 | - /** |
|
265 | - * Cuts a text to the specified length if it is longer than the |
|
266 | - * target length. Appends a text to signify it has been cut at |
|
267 | - * the end of the string. |
|
268 | - * |
|
269 | - * @param string $text |
|
270 | - * @param int $targetLength |
|
271 | - * @param string $append |
|
272 | - * @return string |
|
273 | - */ |
|
264 | + /** |
|
265 | + * Cuts a text to the specified length if it is longer than the |
|
266 | + * target length. Appends a text to signify it has been cut at |
|
267 | + * the end of the string. |
|
268 | + * |
|
269 | + * @param string $text |
|
270 | + * @param int $targetLength |
|
271 | + * @param string $append |
|
272 | + * @return string |
|
273 | + */ |
|
274 | 274 | public static function text_cut(string $text, int $targetLength, string $append = '...') : string |
275 | 275 | { |
276 | 276 | $length = mb_strlen($text); |
@@ -340,27 +340,27 @@ discard block |
||
340 | 340 | return self::$booleanStrings[$string]; |
341 | 341 | } |
342 | 342 | |
343 | - /** |
|
344 | - * Whether the specified string is a boolean string or boolean value. |
|
345 | - * Alias for {@link ConvertHelper::isBoolean()}. |
|
346 | - * |
|
347 | - * @param mixed $string |
|
348 | - * @return bool |
|
349 | - * @deprecated |
|
350 | - * @see ConvertHelper::isBoolean() |
|
351 | - */ |
|
343 | + /** |
|
344 | + * Whether the specified string is a boolean string or boolean value. |
|
345 | + * Alias for {@link ConvertHelper::isBoolean()}. |
|
346 | + * |
|
347 | + * @param mixed $string |
|
348 | + * @return bool |
|
349 | + * @deprecated |
|
350 | + * @see ConvertHelper::isBoolean() |
|
351 | + */ |
|
352 | 352 | public static function isBooleanString($string) : bool |
353 | 353 | { |
354 | 354 | return self::isBoolean($string); |
355 | 355 | } |
356 | 356 | |
357 | - /** |
|
358 | - * Alias for the {@\AppUtils\XMLHelper::string2xml()} method. |
|
359 | - * |
|
360 | - * @param string $text |
|
361 | - * @return string |
|
362 | - * @deprecated |
|
363 | - */ |
|
357 | + /** |
|
358 | + * Alias for the {@\AppUtils\XMLHelper::string2xml()} method. |
|
359 | + * |
|
360 | + * @param string $text |
|
361 | + * @return string |
|
362 | + * @deprecated |
|
363 | + */ |
|
364 | 364 | public static function text_makeXMLCompliant($text) |
365 | 365 | { |
366 | 366 | return XMLHelper::string2xml($text); |
@@ -462,13 +462,13 @@ discard block |
||
462 | 462 | return $translit->convert($string); |
463 | 463 | } |
464 | 464 | |
465 | - /** |
|
466 | - * Retrieves the HEX character codes for all control |
|
467 | - * characters that the {@link stripControlCharacters()} |
|
468 | - * method will remove. |
|
469 | - * |
|
470 | - * @return string[] |
|
471 | - */ |
|
465 | + /** |
|
466 | + * Retrieves the HEX character codes for all control |
|
467 | + * characters that the {@link stripControlCharacters()} |
|
468 | + * method will remove. |
|
469 | + * |
|
470 | + * @return string[] |
|
471 | + */ |
|
472 | 472 | public static function getControlCharactersAsHex() |
473 | 473 | { |
474 | 474 | $hexAlphabet = array('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'); |
@@ -504,13 +504,13 @@ discard block |
||
504 | 504 | return $stack; |
505 | 505 | } |
506 | 506 | |
507 | - /** |
|
508 | - * Retrieves an array of all control characters that |
|
509 | - * the {@link stripControlCharacters()} method will |
|
510 | - * remove, as the actual UTF-8 characters. |
|
511 | - * |
|
512 | - * @return string[] |
|
513 | - */ |
|
507 | + /** |
|
508 | + * Retrieves an array of all control characters that |
|
509 | + * the {@link stripControlCharacters()} method will |
|
510 | + * remove, as the actual UTF-8 characters. |
|
511 | + * |
|
512 | + * @return string[] |
|
513 | + */ |
|
514 | 514 | public static function getControlCharactersAsUTF8() |
515 | 515 | { |
516 | 516 | $chars = self::getControlCharactersAsHex(); |
@@ -523,12 +523,12 @@ discard block |
||
523 | 523 | return $result; |
524 | 524 | } |
525 | 525 | |
526 | - /** |
|
527 | - * Retrieves all control characters as JSON encoded |
|
528 | - * characters, e.g. "\u200b". |
|
529 | - * |
|
530 | - * @return string[] |
|
531 | - */ |
|
526 | + /** |
|
527 | + * Retrieves all control characters as JSON encoded |
|
528 | + * characters, e.g. "\u200b". |
|
529 | + * |
|
530 | + * @return string[] |
|
531 | + */ |
|
532 | 532 | public static function getControlCharactersAsJSON() |
533 | 533 | { |
534 | 534 | $chars = self::getControlCharactersAsHex(); |
@@ -585,20 +585,20 @@ discard block |
||
585 | 585 | return preg_replace(self::$controlCharsRegex, '', $string); |
586 | 586 | } |
587 | 587 | |
588 | - /** |
|
589 | - * Converts a unicode character to the PHPO notation. |
|
590 | - * |
|
591 | - * Example: |
|
592 | - * |
|
593 | - * <pre>unicodeChar2php('"\u0000"')</pre> |
|
594 | - * |
|
595 | - * Returns |
|
596 | - * |
|
597 | - * <pre>\x0</pre> |
|
598 | - * |
|
599 | - * @param string $unicodeChar |
|
600 | - * @return string |
|
601 | - */ |
|
588 | + /** |
|
589 | + * Converts a unicode character to the PHPO notation. |
|
590 | + * |
|
591 | + * Example: |
|
592 | + * |
|
593 | + * <pre>unicodeChar2php('"\u0000"')</pre> |
|
594 | + * |
|
595 | + * Returns |
|
596 | + * |
|
597 | + * <pre>\x0</pre> |
|
598 | + * |
|
599 | + * @param string $unicodeChar |
|
600 | + * @return string |
|
601 | + */ |
|
602 | 602 | public static function unicodeChar2php($unicodeChar) |
603 | 603 | { |
604 | 604 | $unicodeChar = json_decode($unicodeChar); |
@@ -721,25 +721,25 @@ discard block |
||
721 | 721 | return 'false'; |
722 | 722 | } |
723 | 723 | |
724 | - /** |
|
725 | - * Converts an associative array with attribute name > value pairs |
|
726 | - * to an attribute string that can be used in an HTML tag. Empty |
|
727 | - * attribute values are ignored. |
|
728 | - * |
|
729 | - * Example: |
|
730 | - * |
|
731 | - * array2attributeString(array( |
|
732 | - * 'id' => 45, |
|
733 | - * 'href' => 'http://www.mistralys.com' |
|
734 | - * )); |
|
735 | - * |
|
736 | - * Result: |
|
737 | - * |
|
738 | - * id="45" href="http://www.mistralys.com" |
|
739 | - * |
|
740 | - * @param array $array |
|
741 | - * @return string |
|
742 | - */ |
|
724 | + /** |
|
725 | + * Converts an associative array with attribute name > value pairs |
|
726 | + * to an attribute string that can be used in an HTML tag. Empty |
|
727 | + * attribute values are ignored. |
|
728 | + * |
|
729 | + * Example: |
|
730 | + * |
|
731 | + * array2attributeString(array( |
|
732 | + * 'id' => 45, |
|
733 | + * 'href' => 'http://www.mistralys.com' |
|
734 | + * )); |
|
735 | + * |
|
736 | + * Result: |
|
737 | + * |
|
738 | + * id="45" href="http://www.mistralys.com" |
|
739 | + * |
|
740 | + * @param array $array |
|
741 | + * @return string |
|
742 | + */ |
|
743 | 743 | public static function array2attributeString($array) |
744 | 744 | { |
745 | 745 | $tokens = array(); |
@@ -758,14 +758,14 @@ discard block |
||
758 | 758 | return ' '.implode(' ', $tokens); |
759 | 759 | } |
760 | 760 | |
761 | - /** |
|
762 | - * Converts a string so it can safely be used in a javascript |
|
763 | - * statement in an HTML tag: uses single quotes around the string |
|
764 | - * and encodes all special characters as needed. |
|
765 | - * |
|
766 | - * @param string $string |
|
767 | - * @return string |
|
768 | - */ |
|
761 | + /** |
|
762 | + * Converts a string so it can safely be used in a javascript |
|
763 | + * statement in an HTML tag: uses single quotes around the string |
|
764 | + * and encodes all special characters as needed. |
|
765 | + * |
|
766 | + * @param string $string |
|
767 | + * @return string |
|
768 | + */ |
|
769 | 769 | public static function string2attributeJS($string, $quoted=true) |
770 | 770 | { |
771 | 771 | $converted = addslashes(htmlspecialchars(strip_tags($string), ENT_QUOTES, 'UTF-8')); |
@@ -776,15 +776,15 @@ discard block |
||
776 | 776 | return $converted; |
777 | 777 | } |
778 | 778 | |
779 | - /** |
|
780 | - * Checks if the specified string is a boolean value, which |
|
781 | - * includes string representations of boolean values, like |
|
782 | - * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
783 | - * or <code>false</code>. |
|
784 | - * |
|
785 | - * @param mixed $value |
|
786 | - * @return boolean |
|
787 | - */ |
|
779 | + /** |
|
780 | + * Checks if the specified string is a boolean value, which |
|
781 | + * includes string representations of boolean values, like |
|
782 | + * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
783 | + * or <code>false</code>. |
|
784 | + * |
|
785 | + * @param mixed $value |
|
786 | + * @return boolean |
|
787 | + */ |
|
788 | 788 | public static function isBoolean($value) : bool |
789 | 789 | { |
790 | 790 | if(is_bool($value)) { |
@@ -798,12 +798,12 @@ discard block |
||
798 | 798 | return array_key_exists($value, self::$booleanStrings); |
799 | 799 | } |
800 | 800 | |
801 | - /** |
|
802 | - * Converts an associative array to an HTML style attribute value string. |
|
803 | - * |
|
804 | - * @param array $subject |
|
805 | - * @return string |
|
806 | - */ |
|
801 | + /** |
|
802 | + * Converts an associative array to an HTML style attribute value string. |
|
803 | + * |
|
804 | + * @param array $subject |
|
805 | + * @return string |
|
806 | + */ |
|
807 | 807 | public static function array2styleString(array $subject) : string |
808 | 808 | { |
809 | 809 | $tokens = array(); |
@@ -814,23 +814,23 @@ discard block |
||
814 | 814 | return implode(';', $tokens); |
815 | 815 | } |
816 | 816 | |
817 | - /** |
|
818 | - * Converts a DateTime object to a timestamp, which |
|
819 | - * is PHP 5.2 compatible. |
|
820 | - * |
|
821 | - * @param \DateTime $date |
|
822 | - * @return integer |
|
823 | - */ |
|
817 | + /** |
|
818 | + * Converts a DateTime object to a timestamp, which |
|
819 | + * is PHP 5.2 compatible. |
|
820 | + * |
|
821 | + * @param \DateTime $date |
|
822 | + * @return integer |
|
823 | + */ |
|
824 | 824 | public static function date2timestamp(\DateTime $date) : int |
825 | 825 | { |
826 | 826 | return (int)$date->format('U'); |
827 | 827 | } |
828 | 828 | |
829 | - /** |
|
830 | - * Converts a timestamp into a DateTime instance. |
|
831 | - * @param int $timestamp |
|
832 | - * @return \DateTime |
|
833 | - */ |
|
829 | + /** |
|
830 | + * Converts a timestamp into a DateTime instance. |
|
831 | + * @param int $timestamp |
|
832 | + * @return \DateTime |
|
833 | + */ |
|
834 | 834 | public static function timestamp2date(int $timestamp) : \DateTime |
835 | 835 | { |
836 | 836 | $date = new \DateTime(); |
@@ -838,50 +838,50 @@ discard block |
||
838 | 838 | return $date; |
839 | 839 | } |
840 | 840 | |
841 | - /** |
|
842 | - * Strips an absolute path to a file within the application |
|
843 | - * to make the path relative to the application root path. |
|
844 | - * |
|
845 | - * @param string $path |
|
846 | - * @return string |
|
847 | - * |
|
848 | - * @see FileHelper::relativizePath() |
|
849 | - * @see FileHelper::relativizePathByDepth() |
|
850 | - */ |
|
841 | + /** |
|
842 | + * Strips an absolute path to a file within the application |
|
843 | + * to make the path relative to the application root path. |
|
844 | + * |
|
845 | + * @param string $path |
|
846 | + * @return string |
|
847 | + * |
|
848 | + * @see FileHelper::relativizePath() |
|
849 | + * @see FileHelper::relativizePathByDepth() |
|
850 | + */ |
|
851 | 851 | public static function fileRelativize(string $path) : string |
852 | 852 | { |
853 | 853 | return FileHelper::relativizePathByDepth($path); |
854 | 854 | } |
855 | 855 | |
856 | 856 | /** |
857 | - * Converts a PHP regex to a javascript RegExp object statement. |
|
858 | - * |
|
859 | - * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
860 | - * More details are available on its usage there. |
|
861 | - * |
|
862 | - * @param string $regex A PHP preg regex |
|
863 | - * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
864 | - * @return array|string Depending on the specified return type. |
|
865 | - * |
|
866 | - * @see JSHelper::buildRegexStatement() |
|
867 | - */ |
|
857 | + * Converts a PHP regex to a javascript RegExp object statement. |
|
858 | + * |
|
859 | + * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
860 | + * More details are available on its usage there. |
|
861 | + * |
|
862 | + * @param string $regex A PHP preg regex |
|
863 | + * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
864 | + * @return array|string Depending on the specified return type. |
|
865 | + * |
|
866 | + * @see JSHelper::buildRegexStatement() |
|
867 | + */ |
|
868 | 868 | public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) |
869 | 869 | { |
870 | 870 | return JSHelper::buildRegexStatement($regex, $statementType); |
871 | 871 | } |
872 | 872 | |
873 | - /** |
|
874 | - * Converts the specified variable to JSON. Works just |
|
875 | - * like the native `json_encode` method, except that it |
|
876 | - * will trigger an exception on failure, which has the |
|
877 | - * json error details included in its developer details. |
|
878 | - * |
|
879 | - * @param mixed $variable |
|
880 | - * @param int|NULL $options JSON encode options. |
|
881 | - * @param int|NULL $depth |
|
882 | - * @throws ConvertHelper_Exception |
|
883 | - * @return string |
|
884 | - */ |
|
873 | + /** |
|
874 | + * Converts the specified variable to JSON. Works just |
|
875 | + * like the native `json_encode` method, except that it |
|
876 | + * will trigger an exception on failure, which has the |
|
877 | + * json error details included in its developer details. |
|
878 | + * |
|
879 | + * @param mixed $variable |
|
880 | + * @param int|NULL $options JSON encode options. |
|
881 | + * @param int|NULL $depth |
|
882 | + * @throws ConvertHelper_Exception |
|
883 | + * @return string |
|
884 | + */ |
|
885 | 885 | public static function var2json($variable, int $options=0, int $depth=512) : string |
886 | 886 | { |
887 | 887 | $result = json_encode($variable, $options, $depth); |
@@ -902,12 +902,12 @@ discard block |
||
902 | 902 | ); |
903 | 903 | } |
904 | 904 | |
905 | - /** |
|
906 | - * Strips all known UTF byte order marks from the specified string. |
|
907 | - * |
|
908 | - * @param string $string |
|
909 | - * @return string |
|
910 | - */ |
|
905 | + /** |
|
906 | + * Strips all known UTF byte order marks from the specified string. |
|
907 | + * |
|
908 | + * @param string $string |
|
909 | + * @return string |
|
910 | + */ |
|
911 | 911 | public static function stripUTFBom($string) |
912 | 912 | { |
913 | 913 | $boms = FileHelper::getUTFBOMs(); |
@@ -922,13 +922,13 @@ discard block |
||
922 | 922 | return $string; |
923 | 923 | } |
924 | 924 | |
925 | - /** |
|
926 | - * Converts a string to valid utf8, regardless |
|
927 | - * of the string's encoding(s). |
|
928 | - * |
|
929 | - * @param string $string |
|
930 | - * @return string |
|
931 | - */ |
|
925 | + /** |
|
926 | + * Converts a string to valid utf8, regardless |
|
927 | + * of the string's encoding(s). |
|
928 | + * |
|
929 | + * @param string $string |
|
930 | + * @return string |
|
931 | + */ |
|
932 | 932 | public static function string2utf8($string) |
933 | 933 | { |
934 | 934 | if(!self::isStringASCII($string)) { |
@@ -938,15 +938,15 @@ discard block |
||
938 | 938 | return $string; |
939 | 939 | } |
940 | 940 | |
941 | - /** |
|
942 | - * Checks whether the specified string is an ASCII |
|
943 | - * string, without any special or UTF8 characters. |
|
944 | - * Note: empty strings and NULL are considered ASCII. |
|
945 | - * Any variable types other than strings are not. |
|
946 | - * |
|
947 | - * @param mixed $string |
|
948 | - * @return boolean |
|
949 | - */ |
|
941 | + /** |
|
942 | + * Checks whether the specified string is an ASCII |
|
943 | + * string, without any special or UTF8 characters. |
|
944 | + * Note: empty strings and NULL are considered ASCII. |
|
945 | + * Any variable types other than strings are not. |
|
946 | + * |
|
947 | + * @param mixed $string |
|
948 | + * @return boolean |
|
949 | + */ |
|
950 | 950 | public static function isStringASCII($string) : bool |
951 | 951 | { |
952 | 952 | if($string === '' || $string === NULL) { |
@@ -971,22 +971,22 @@ discard block |
||
971 | 971 | return $url; |
972 | 972 | } |
973 | 973 | |
974 | - /** |
|
975 | - * Calculates a percentage match of the source string with the target string. |
|
976 | - * |
|
977 | - * Options are: |
|
978 | - * |
|
979 | - * - maxLevenshtein, default: 10 |
|
980 | - * Any levenshtein results above this value are ignored. |
|
981 | - * |
|
982 | - * - precision, default: 1 |
|
983 | - * The precision of the percentage float value |
|
984 | - * |
|
985 | - * @param string $source |
|
986 | - * @param string $target |
|
987 | - * @param array $options |
|
988 | - * @return float |
|
989 | - */ |
|
974 | + /** |
|
975 | + * Calculates a percentage match of the source string with the target string. |
|
976 | + * |
|
977 | + * Options are: |
|
978 | + * |
|
979 | + * - maxLevenshtein, default: 10 |
|
980 | + * Any levenshtein results above this value are ignored. |
|
981 | + * |
|
982 | + * - precision, default: 1 |
|
983 | + * The precision of the percentage float value |
|
984 | + * |
|
985 | + * @param string $source |
|
986 | + * @param string $target |
|
987 | + * @param array $options |
|
988 | + * @return float |
|
989 | + */ |
|
990 | 990 | public static function matchString($source, $target, $options=array()) |
991 | 991 | { |
992 | 992 | $defaults = array( |
@@ -1010,14 +1010,14 @@ discard block |
||
1010 | 1010 | return round(100 - $percent, $options['precision']); |
1011 | 1011 | } |
1012 | 1012 | |
1013 | - /** |
|
1014 | - * Converts a date interval to a human readable string with |
|
1015 | - * all necessary time components, e.g. "1 year, 2 months and 4 days". |
|
1016 | - * |
|
1017 | - * @param \DateInterval $interval |
|
1018 | - * @return string |
|
1019 | - * @see ConvertHelper_IntervalConverter |
|
1020 | - */ |
|
1013 | + /** |
|
1014 | + * Converts a date interval to a human readable string with |
|
1015 | + * all necessary time components, e.g. "1 year, 2 months and 4 days". |
|
1016 | + * |
|
1017 | + * @param \DateInterval $interval |
|
1018 | + * @return string |
|
1019 | + * @see ConvertHelper_IntervalConverter |
|
1020 | + */ |
|
1021 | 1021 | public static function interval2string(\DateInterval $interval) : string |
1022 | 1022 | { |
1023 | 1023 | $converter = new ConvertHelper_IntervalConverter(); |
@@ -1032,60 +1032,60 @@ discard block |
||
1032 | 1032 | |
1033 | 1033 | const INTERVAL_SECONDS = 'seconds'; |
1034 | 1034 | |
1035 | - /** |
|
1036 | - * Converts an interval to its total amount of days. |
|
1037 | - * @param \DateInterval $interval |
|
1038 | - * @return int |
|
1039 | - */ |
|
1035 | + /** |
|
1036 | + * Converts an interval to its total amount of days. |
|
1037 | + * @param \DateInterval $interval |
|
1038 | + * @return int |
|
1039 | + */ |
|
1040 | 1040 | public static function interval2days(\DateInterval $interval) : int |
1041 | 1041 | { |
1042 | 1042 | return self::interval2total($interval, self::INTERVAL_DAYS); |
1043 | 1043 | } |
1044 | 1044 | |
1045 | - /** |
|
1046 | - * Converts an interval to its total amount of hours. |
|
1047 | - * @param \DateInterval $interval |
|
1048 | - * @return int |
|
1049 | - */ |
|
1045 | + /** |
|
1046 | + * Converts an interval to its total amount of hours. |
|
1047 | + * @param \DateInterval $interval |
|
1048 | + * @return int |
|
1049 | + */ |
|
1050 | 1050 | public static function interval2hours(\DateInterval $interval) : int |
1051 | 1051 | { |
1052 | 1052 | return self::interval2total($interval, self::INTERVAL_HOURS); |
1053 | 1053 | } |
1054 | 1054 | |
1055 | - /** |
|
1056 | - * Converts an interval to its total amount of minutes. |
|
1057 | - * @param \DateInterval $interval |
|
1058 | - * @return int |
|
1059 | - */ |
|
1055 | + /** |
|
1056 | + * Converts an interval to its total amount of minutes. |
|
1057 | + * @param \DateInterval $interval |
|
1058 | + * @return int |
|
1059 | + */ |
|
1060 | 1060 | public static function interval2minutes(\DateInterval $interval) : int |
1061 | 1061 | { |
1062 | 1062 | return self::interval2total($interval, self::INTERVAL_MINUTES); |
1063 | 1063 | } |
1064 | 1064 | |
1065 | - /** |
|
1066 | - * Converts an interval to its total amount of seconds. |
|
1067 | - * @param \DateInterval $interval |
|
1068 | - * @return int |
|
1069 | - */ |
|
1065 | + /** |
|
1066 | + * Converts an interval to its total amount of seconds. |
|
1067 | + * @param \DateInterval $interval |
|
1068 | + * @return int |
|
1069 | + */ |
|
1070 | 1070 | public static function interval2seconds(\DateInterval $interval) : int |
1071 | 1071 | { |
1072 | 1072 | return self::interval2total($interval, self::INTERVAL_SECONDS); |
1073 | 1073 | } |
1074 | 1074 | |
1075 | - /** |
|
1076 | - * Calculates the total amount of days / hours / minutes or seconds |
|
1077 | - * of a date interval object (depending in the specified units), and |
|
1078 | - * returns the total amount. |
|
1079 | - * |
|
1080 | - * @param \DateInterval $interval |
|
1081 | - * @param string $unit What total value to calculate. |
|
1082 | - * @return integer |
|
1083 | - * |
|
1084 | - * @see ConvertHelper::INTERVAL_SECONDS |
|
1085 | - * @see ConvertHelper::INTERVAL_MINUTES |
|
1086 | - * @see ConvertHelper::INTERVAL_HOURS |
|
1087 | - * @see ConvertHelper::INTERVAL_DAYS |
|
1088 | - */ |
|
1075 | + /** |
|
1076 | + * Calculates the total amount of days / hours / minutes or seconds |
|
1077 | + * of a date interval object (depending in the specified units), and |
|
1078 | + * returns the total amount. |
|
1079 | + * |
|
1080 | + * @param \DateInterval $interval |
|
1081 | + * @param string $unit What total value to calculate. |
|
1082 | + * @return integer |
|
1083 | + * |
|
1084 | + * @see ConvertHelper::INTERVAL_SECONDS |
|
1085 | + * @see ConvertHelper::INTERVAL_MINUTES |
|
1086 | + * @see ConvertHelper::INTERVAL_HOURS |
|
1087 | + * @see ConvertHelper::INTERVAL_DAYS |
|
1088 | + */ |
|
1089 | 1089 | public static function interval2total(\DateInterval $interval, $unit=self::INTERVAL_SECONDS) : int |
1090 | 1090 | { |
1091 | 1091 | $total = (int)$interval->format('%a'); |
@@ -1125,13 +1125,13 @@ discard block |
||
1125 | 1125 | 'Sunday' |
1126 | 1126 | ); |
1127 | 1127 | |
1128 | - /** |
|
1129 | - * Converts a date to the corresponding day name. |
|
1130 | - * |
|
1131 | - * @param \DateTime $date |
|
1132 | - * @param bool $short |
|
1133 | - * @return string|NULL |
|
1134 | - */ |
|
1128 | + /** |
|
1129 | + * Converts a date to the corresponding day name. |
|
1130 | + * |
|
1131 | + * @param \DateTime $date |
|
1132 | + * @param bool $short |
|
1133 | + * @return string|NULL |
|
1134 | + */ |
|
1135 | 1135 | public static function date2dayName(\DateTime $date, bool $short=false) |
1136 | 1136 | { |
1137 | 1137 | $day = $date->format('l'); |
@@ -1146,21 +1146,21 @@ discard block |
||
1146 | 1146 | return null; |
1147 | 1147 | } |
1148 | 1148 | |
1149 | - /** |
|
1150 | - * Retrieves a list of english day names. |
|
1151 | - * @return string[] |
|
1152 | - */ |
|
1149 | + /** |
|
1150 | + * Retrieves a list of english day names. |
|
1151 | + * @return string[] |
|
1152 | + */ |
|
1153 | 1153 | public static function getDayNamesInvariant() |
1154 | 1154 | { |
1155 | 1155 | return self::$daysInvariant; |
1156 | 1156 | } |
1157 | 1157 | |
1158 | - /** |
|
1159 | - * Retrieves the day names list for the current locale. |
|
1160 | - * |
|
1161 | - * @param bool $short |
|
1162 | - * @return array |
|
1163 | - */ |
|
1158 | + /** |
|
1159 | + * Retrieves the day names list for the current locale. |
|
1160 | + * |
|
1161 | + * @param bool $short |
|
1162 | + * @return array |
|
1163 | + */ |
|
1164 | 1164 | public static function getDayNames(bool $short=false) : array |
1165 | 1165 | { |
1166 | 1166 | if($short) { |
@@ -1220,16 +1220,16 @@ discard block |
||
1220 | 1220 | return $last; |
1221 | 1221 | } |
1222 | 1222 | |
1223 | - /** |
|
1224 | - * Splits a string into an array of all characters it is composed of. |
|
1225 | - * Unicode character safe. |
|
1226 | - * |
|
1227 | - * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
1228 | - * characters. |
|
1229 | - * |
|
1230 | - * @param string $string |
|
1231 | - * @return array |
|
1232 | - */ |
|
1223 | + /** |
|
1224 | + * Splits a string into an array of all characters it is composed of. |
|
1225 | + * Unicode character safe. |
|
1226 | + * |
|
1227 | + * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
1228 | + * characters. |
|
1229 | + * |
|
1230 | + * @param string $string |
|
1231 | + * @return array |
|
1232 | + */ |
|
1233 | 1233 | public static function string2array(string $string) : array |
1234 | 1234 | { |
1235 | 1235 | $result = preg_split('//u', $string, null, PREG_SPLIT_NO_EMPTY); |
@@ -1240,12 +1240,12 @@ discard block |
||
1240 | 1240 | return array(); |
1241 | 1241 | } |
1242 | 1242 | |
1243 | - /** |
|
1244 | - * Checks whether the specified string contains HTML code. |
|
1245 | - * |
|
1246 | - * @param string $string |
|
1247 | - * @return boolean |
|
1248 | - */ |
|
1243 | + /** |
|
1244 | + * Checks whether the specified string contains HTML code. |
|
1245 | + * |
|
1246 | + * @param string $string |
|
1247 | + * @return boolean |
|
1248 | + */ |
|
1249 | 1249 | public static function isStringHTML(string $string) : bool |
1250 | 1250 | { |
1251 | 1251 | if(preg_match('%<[a-z/][\s\S]*>%siU', $string)) { |
@@ -1260,17 +1260,17 @@ discard block |
||
1260 | 1260 | return false; |
1261 | 1261 | } |
1262 | 1262 | |
1263 | - /** |
|
1264 | - * UTF8-safe wordwrap method: works like the regular wordwrap |
|
1265 | - * PHP function but compatible with UTF8. Otherwise the lengths |
|
1266 | - * are not calculated correctly. |
|
1267 | - * |
|
1268 | - * @param string $str |
|
1269 | - * @param int $width |
|
1270 | - * @param string $break |
|
1271 | - * @param bool $cut |
|
1272 | - * @return string |
|
1273 | - */ |
|
1263 | + /** |
|
1264 | + * UTF8-safe wordwrap method: works like the regular wordwrap |
|
1265 | + * PHP function but compatible with UTF8. Otherwise the lengths |
|
1266 | + * are not calculated correctly. |
|
1267 | + * |
|
1268 | + * @param string $str |
|
1269 | + * @param int $width |
|
1270 | + * @param string $break |
|
1271 | + * @param bool $cut |
|
1272 | + * @return string |
|
1273 | + */ |
|
1274 | 1274 | public static function wordwrap(string $str, int $width = 75, string $break = "\n", bool $cut = false) : string |
1275 | 1275 | { |
1276 | 1276 | $wrapper = new ConvertHelper_WordWrapper(); |
@@ -1282,27 +1282,27 @@ discard block |
||
1282 | 1282 | ->wrapText($str); |
1283 | 1283 | } |
1284 | 1284 | |
1285 | - /** |
|
1286 | - * Calculates the byte length of a string, taking into |
|
1287 | - * account any unicode characters. |
|
1288 | - * |
|
1289 | - * @param string $string |
|
1290 | - * @return int |
|
1291 | - * @see https://stackoverflow.com/a/9718273/2298192 |
|
1292 | - */ |
|
1285 | + /** |
|
1286 | + * Calculates the byte length of a string, taking into |
|
1287 | + * account any unicode characters. |
|
1288 | + * |
|
1289 | + * @param string $string |
|
1290 | + * @return int |
|
1291 | + * @see https://stackoverflow.com/a/9718273/2298192 |
|
1292 | + */ |
|
1293 | 1293 | public static function string2bytes($string) |
1294 | 1294 | { |
1295 | 1295 | return mb_strlen($string, '8bit'); |
1296 | 1296 | } |
1297 | 1297 | |
1298 | - /** |
|
1299 | - * Creates a short, 8-character long hash for the specified string. |
|
1300 | - * |
|
1301 | - * WARNING: Not cryptographically safe. |
|
1302 | - * |
|
1303 | - * @param string $string |
|
1304 | - * @return string |
|
1305 | - */ |
|
1298 | + /** |
|
1299 | + * Creates a short, 8-character long hash for the specified string. |
|
1300 | + * |
|
1301 | + * WARNING: Not cryptographically safe. |
|
1302 | + * |
|
1303 | + * @param string $string |
|
1304 | + * @return string |
|
1305 | + */ |
|
1306 | 1306 | public static function string2shortHash($string) |
1307 | 1307 | { |
1308 | 1308 | return hash('crc32', $string, false); |
@@ -1328,40 +1328,40 @@ discard block |
||
1328 | 1328 | return ConvertHelper_ThrowableInfo::fromThrowable($e); |
1329 | 1329 | } |
1330 | 1330 | |
1331 | - /** |
|
1332 | - * Parses the specified query string like the native |
|
1333 | - * function <code>parse_str</code>, without the key |
|
1334 | - * naming limitations. |
|
1335 | - * |
|
1336 | - * Using parse_str, dots or spaces in key names are |
|
1337 | - * replaced by underscores. This method keeps all names |
|
1338 | - * intact. |
|
1339 | - * |
|
1340 | - * It still uses the parse_str implementation as it |
|
1341 | - * is tested and tried, but fixes the parameter names |
|
1342 | - * after parsing, as needed. |
|
1343 | - * |
|
1344 | - * @param string $queryString |
|
1345 | - * @return array |
|
1346 | - * @see ConvertHelper_QueryParser |
|
1347 | - */ |
|
1331 | + /** |
|
1332 | + * Parses the specified query string like the native |
|
1333 | + * function <code>parse_str</code>, without the key |
|
1334 | + * naming limitations. |
|
1335 | + * |
|
1336 | + * Using parse_str, dots or spaces in key names are |
|
1337 | + * replaced by underscores. This method keeps all names |
|
1338 | + * intact. |
|
1339 | + * |
|
1340 | + * It still uses the parse_str implementation as it |
|
1341 | + * is tested and tried, but fixes the parameter names |
|
1342 | + * after parsing, as needed. |
|
1343 | + * |
|
1344 | + * @param string $queryString |
|
1345 | + * @return array |
|
1346 | + * @see ConvertHelper_QueryParser |
|
1347 | + */ |
|
1348 | 1348 | public static function parseQueryString(string $queryString) : array |
1349 | 1349 | { |
1350 | 1350 | $parser = new ConvertHelper_QueryParser(); |
1351 | 1351 | return $parser->parse($queryString); |
1352 | 1352 | } |
1353 | 1353 | |
1354 | - /** |
|
1355 | - * Searches for needle in the specified string, and returns a list |
|
1356 | - * of all occurrences, including the matched string. The matched |
|
1357 | - * string is useful when doing a case insensitive search, as it |
|
1358 | - * shows the exact matched case of needle. |
|
1359 | - * |
|
1360 | - * @param string $needle |
|
1361 | - * @param string $haystack |
|
1362 | - * @param bool $caseInsensitive |
|
1363 | - * @return ConvertHelper_StringMatch[] |
|
1364 | - */ |
|
1354 | + /** |
|
1355 | + * Searches for needle in the specified string, and returns a list |
|
1356 | + * of all occurrences, including the matched string. The matched |
|
1357 | + * string is useful when doing a case insensitive search, as it |
|
1358 | + * shows the exact matched case of needle. |
|
1359 | + * |
|
1360 | + * @param string $needle |
|
1361 | + * @param string $haystack |
|
1362 | + * @param bool $caseInsensitive |
|
1363 | + * @return ConvertHelper_StringMatch[] |
|
1364 | + */ |
|
1365 | 1365 | public static function findString(string $needle, string $haystack, bool $caseInsensitive=false) |
1366 | 1366 | { |
1367 | 1367 | if($needle === '') { |
@@ -1387,14 +1387,14 @@ discard block |
||
1387 | 1387 | return $positions; |
1388 | 1388 | } |
1389 | 1389 | |
1390 | - /** |
|
1391 | - * Like explode, but trims all entries, and removes |
|
1392 | - * empty entries from the resulting array. |
|
1393 | - * |
|
1394 | - * @param string $delimiter |
|
1395 | - * @param string $string |
|
1396 | - * @return string[] |
|
1397 | - */ |
|
1390 | + /** |
|
1391 | + * Like explode, but trims all entries, and removes |
|
1392 | + * empty entries from the resulting array. |
|
1393 | + * |
|
1394 | + * @param string $delimiter |
|
1395 | + * @param string $string |
|
1396 | + * @return string[] |
|
1397 | + */ |
|
1398 | 1398 | public static function explodeTrim(string $delimiter, string $string) : array |
1399 | 1399 | { |
1400 | 1400 | if(empty($string) || empty($delimiter)) { |
@@ -1416,12 +1416,12 @@ discard block |
||
1416 | 1416 | |
1417 | 1417 | protected static $eolChars; |
1418 | 1418 | |
1419 | - /** |
|
1420 | - * Detects the most used end-of-line character in the subject string. |
|
1421 | - * |
|
1422 | - * @param string $str The string to check. |
|
1423 | - * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
1424 | - */ |
|
1419 | + /** |
|
1420 | + * Detects the most used end-of-line character in the subject string. |
|
1421 | + * |
|
1422 | + * @param string $str The string to check. |
|
1423 | + * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
1424 | + */ |
|
1425 | 1425 | public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL |
1426 | 1426 | { |
1427 | 1427 | if(empty($subjectString)) { |
@@ -1433,27 +1433,27 @@ discard block |
||
1433 | 1433 | $cr = chr((int)hexdec('0d')); |
1434 | 1434 | $lf = chr((int)hexdec('0a')); |
1435 | 1435 | |
1436 | - self::$eolChars = array( |
|
1437 | - array( |
|
1438 | - 'char' => $cr.$lf, |
|
1439 | - 'type' => ConvertHelper_EOL::TYPE_CRLF, |
|
1440 | - 'description' => t('Carriage return followed by a line feed'), |
|
1441 | - ), |
|
1442 | - array( |
|
1443 | - 'char' => $lf.$cr, |
|
1444 | - 'type' => ConvertHelper_EOL::TYPE_LFCR, |
|
1445 | - 'description' => t('Line feed followed by a carriage return'), |
|
1446 | - ), |
|
1447 | - array( |
|
1448 | - 'char' => $lf, |
|
1449 | - 'type' => ConvertHelper_EOL::TYPE_LF, |
|
1450 | - 'description' => t('Line feed'), |
|
1451 | - ), |
|
1452 | - array( |
|
1453 | - 'char' => $cr, |
|
1454 | - 'type' => ConvertHelper_EOL::TYPE_CR, |
|
1455 | - 'description' => t('Carriage Return'), |
|
1456 | - ), |
|
1436 | + self::$eolChars = array( |
|
1437 | + array( |
|
1438 | + 'char' => $cr.$lf, |
|
1439 | + 'type' => ConvertHelper_EOL::TYPE_CRLF, |
|
1440 | + 'description' => t('Carriage return followed by a line feed'), |
|
1441 | + ), |
|
1442 | + array( |
|
1443 | + 'char' => $lf.$cr, |
|
1444 | + 'type' => ConvertHelper_EOL::TYPE_LFCR, |
|
1445 | + 'description' => t('Line feed followed by a carriage return'), |
|
1446 | + ), |
|
1447 | + array( |
|
1448 | + 'char' => $lf, |
|
1449 | + 'type' => ConvertHelper_EOL::TYPE_LF, |
|
1450 | + 'description' => t('Line feed'), |
|
1451 | + ), |
|
1452 | + array( |
|
1453 | + 'char' => $cr, |
|
1454 | + 'type' => ConvertHelper_EOL::TYPE_CR, |
|
1455 | + 'description' => t('Carriage Return'), |
|
1456 | + ), |
|
1457 | 1457 | ); |
1458 | 1458 | } |
1459 | 1459 | |
@@ -1481,13 +1481,13 @@ discard block |
||
1481 | 1481 | ); |
1482 | 1482 | } |
1483 | 1483 | |
1484 | - /** |
|
1485 | - * Removes the specified keys from the target array, |
|
1486 | - * if they exist. |
|
1487 | - * |
|
1488 | - * @param array $array |
|
1489 | - * @param array $keys |
|
1490 | - */ |
|
1484 | + /** |
|
1485 | + * Removes the specified keys from the target array, |
|
1486 | + * if they exist. |
|
1487 | + * |
|
1488 | + * @param array $array |
|
1489 | + * @param array $keys |
|
1490 | + */ |
|
1491 | 1491 | public static function arrayRemoveKeys(array &$array, array $keys) : void |
1492 | 1492 | { |
1493 | 1493 | foreach($keys as $key) |
@@ -1498,13 +1498,13 @@ discard block |
||
1498 | 1498 | } |
1499 | 1499 | } |
1500 | 1500 | |
1501 | - /** |
|
1502 | - * Checks if the specified variable is an integer or a string containing an integer. |
|
1503 | - * Accepts both positive and negative integers. |
|
1504 | - * |
|
1505 | - * @param mixed $value |
|
1506 | - * @return bool |
|
1507 | - */ |
|
1501 | + /** |
|
1502 | + * Checks if the specified variable is an integer or a string containing an integer. |
|
1503 | + * Accepts both positive and negative integers. |
|
1504 | + * |
|
1505 | + * @param mixed $value |
|
1506 | + * @return bool |
|
1507 | + */ |
|
1508 | 1508 | public static function isInteger($value) : bool |
1509 | 1509 | { |
1510 | 1510 | if(is_int($value)) { |
@@ -1524,40 +1524,40 @@ discard block |
||
1524 | 1524 | return false; |
1525 | 1525 | } |
1526 | 1526 | |
1527 | - /** |
|
1528 | - * Converts an amount of seconds to a DateInterval object. |
|
1529 | - * |
|
1530 | - * @param int $seconds |
|
1531 | - * @return \DateInterval |
|
1532 | - * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
1533 | - * |
|
1534 | - * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
1535 | - */ |
|
1527 | + /** |
|
1528 | + * Converts an amount of seconds to a DateInterval object. |
|
1529 | + * |
|
1530 | + * @param int $seconds |
|
1531 | + * @return \DateInterval |
|
1532 | + * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
1533 | + * |
|
1534 | + * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
1535 | + */ |
|
1536 | 1536 | public static function seconds2interval(int $seconds) : \DateInterval |
1537 | 1537 | { |
1538 | 1538 | return ConvertHelper_DateInterval::fromSeconds($seconds)->getInterval(); |
1539 | 1539 | } |
1540 | 1540 | |
1541 | - /** |
|
1542 | - * Converts a size string like "50 MB" to the corresponding byte size. |
|
1543 | - * It is case insensitive, ignores spaces, and supports both traditional |
|
1544 | - * "MB" and "MiB" notations. |
|
1545 | - * |
|
1546 | - * @param string $size |
|
1547 | - * @return int |
|
1548 | - */ |
|
1541 | + /** |
|
1542 | + * Converts a size string like "50 MB" to the corresponding byte size. |
|
1543 | + * It is case insensitive, ignores spaces, and supports both traditional |
|
1544 | + * "MB" and "MiB" notations. |
|
1545 | + * |
|
1546 | + * @param string $size |
|
1547 | + * @return int |
|
1548 | + */ |
|
1549 | 1549 | public static function size2bytes(string $size) : int |
1550 | 1550 | { |
1551 | 1551 | return self::parseSize($size)->toBytes(); |
1552 | 1552 | } |
1553 | 1553 | |
1554 | - /** |
|
1555 | - * Parses a size string like "50 MB" and returns a size notation instance |
|
1556 | - * that has utility methods to access information on it, and convert it. |
|
1557 | - * |
|
1558 | - * @param string $size |
|
1559 | - * @return ConvertHelper_SizeNotation |
|
1560 | - */ |
|
1554 | + /** |
|
1555 | + * Parses a size string like "50 MB" and returns a size notation instance |
|
1556 | + * that has utility methods to access information on it, and convert it. |
|
1557 | + * |
|
1558 | + * @param string $size |
|
1559 | + * @return ConvertHelper_SizeNotation |
|
1560 | + */ |
|
1561 | 1561 | public static function parseSize(string $size) : ConvertHelper_SizeNotation |
1562 | 1562 | { |
1563 | 1563 | return new ConvertHelper_SizeNotation($size); |
@@ -57,7 +57,7 @@ discard block |
||
57 | 57 | $amount = substr_count($line, "\t") - $min; |
58 | 58 | $line = trim($line); |
59 | 59 | if ($amount >= 1) { |
60 | - $line = str_repeat("\t", $amount) . $line; |
|
60 | + $line = str_repeat("\t", $amount).$line; |
|
61 | 61 | } |
62 | 62 | |
63 | 63 | $converted[] = $line; |
@@ -129,10 +129,10 @@ discard block |
||
129 | 129 | |
130 | 130 | // specifically handle zero |
131 | 131 | if ($seconds <= 0) { |
132 | - return '0 ' . t('seconds'); |
|
132 | + return '0 '.t('seconds'); |
|
133 | 133 | } |
134 | 134 | |
135 | - if($seconds < 1) { |
|
135 | + if ($seconds < 1) { |
|
136 | 136 | return t('less than a second'); |
137 | 137 | } |
138 | 138 | |
@@ -140,7 +140,7 @@ discard block |
||
140 | 140 | foreach ($units as $def) { |
141 | 141 | $quot = intval($seconds / $def['value']); |
142 | 142 | if ($quot) { |
143 | - $item = $quot . ' '; |
|
143 | + $item = $quot.' '; |
|
144 | 144 | if (abs($quot) > 1) { |
145 | 145 | $item .= $def['plural']; |
146 | 146 | } else { |
@@ -157,7 +157,7 @@ discard block |
||
157 | 157 | return $last; |
158 | 158 | } |
159 | 159 | |
160 | - return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last; |
|
160 | + return implode(', ', $tokens).' '.t('and').' '.$last; |
|
161 | 161 | } |
162 | 162 | |
163 | 163 | /** |
@@ -176,7 +176,7 @@ discard block |
||
176 | 176 | { |
177 | 177 | $converter = new ConvertHelper_DurationConverter(); |
178 | 178 | |
179 | - if($datefrom instanceof \DateTime) |
|
179 | + if ($datefrom instanceof \DateTime) |
|
180 | 180 | { |
181 | 181 | $converter->setDateFrom($datefrom); |
182 | 182 | } |
@@ -185,11 +185,11 @@ discard block |
||
185 | 185 | $converter->setDateFrom(self::timestamp2date($datefrom)); |
186 | 186 | } |
187 | 187 | |
188 | - if($dateto instanceof \DateTime) |
|
188 | + if ($dateto instanceof \DateTime) |
|
189 | 189 | { |
190 | 190 | $converter->setDateTo($dateto); |
191 | 191 | } |
192 | - else if($dateto > 0) |
|
192 | + else if ($dateto > 0) |
|
193 | 193 | { |
194 | 194 | $converter->setDateTo(self::timestamp2date($dateto)); |
195 | 195 | } |
@@ -209,9 +209,9 @@ discard block |
||
209 | 209 | return $geshi->parse_code(); |
210 | 210 | } |
211 | 211 | |
212 | - public static function highlight_xml($xml, $formatSource=false) |
|
212 | + public static function highlight_xml($xml, $formatSource = false) |
|
213 | 213 | { |
214 | - if($formatSource) |
|
214 | + if ($formatSource) |
|
215 | 215 | { |
216 | 216 | $dom = new \DOMDocument(); |
217 | 217 | $dom->loadXML($xml); |
@@ -278,34 +278,34 @@ discard block |
||
278 | 278 | return $text; |
279 | 279 | } |
280 | 280 | |
281 | - $text = trim(mb_substr($text, 0, $targetLength)) . $append; |
|
281 | + $text = trim(mb_substr($text, 0, $targetLength)).$append; |
|
282 | 282 | |
283 | 283 | return $text; |
284 | 284 | } |
285 | 285 | |
286 | - public static function var_dump($var, $html=true) |
|
286 | + public static function var_dump($var, $html = true) |
|
287 | 287 | { |
288 | 288 | $info = parseVariable($var); |
289 | 289 | |
290 | - if($html) { |
|
290 | + if ($html) { |
|
291 | 291 | return $info->toHTML(); |
292 | 292 | } |
293 | 293 | |
294 | 294 | return $info->toString(); |
295 | 295 | } |
296 | 296 | |
297 | - public static function print_r($var, $return=false, $html=true) |
|
297 | + public static function print_r($var, $return = false, $html = true) |
|
298 | 298 | { |
299 | 299 | $result = self::var_dump($var, $html); |
300 | 300 | |
301 | - if($html) { |
|
301 | + if ($html) { |
|
302 | 302 | $result = |
303 | 303 | '<pre style="background:#fff;color:#333;padding:16px;border:solid 1px #bbb;border-radius:4px">'. |
304 | 304 | $result. |
305 | 305 | '</pre>'; |
306 | 306 | } |
307 | 307 | |
308 | - if($return) { |
|
308 | + if ($return) { |
|
309 | 309 | return $result; |
310 | 310 | } |
311 | 311 | |
@@ -325,7 +325,7 @@ discard block |
||
325 | 325 | |
326 | 326 | public static function string2bool($string) |
327 | 327 | { |
328 | - if($string === '' || $string === null) { |
|
328 | + if ($string === '' || $string === null) { |
|
329 | 329 | return false; |
330 | 330 | } |
331 | 331 | |
@@ -380,10 +380,10 @@ discard block |
||
380 | 380 | public static function date2listLabel(\DateTime $date, $includeTime = false, $shortMonth = false) |
381 | 381 | { |
382 | 382 | $today = new \DateTime(); |
383 | - if($date->format('d.m.Y') == $today->format('d.m.Y')) { |
|
383 | + if ($date->format('d.m.Y') == $today->format('d.m.Y')) { |
|
384 | 384 | $label = t('Today'); |
385 | 385 | } else { |
386 | - $label = $date->format('d') . '. ' . self::month2string((int)$date->format('m'), $shortMonth) . ' '; |
|
386 | + $label = $date->format('d').'. '.self::month2string((int)$date->format('m'), $shortMonth).' '; |
|
387 | 387 | if ($date->format('Y') != date('Y')) { |
388 | 388 | $label .= $date->format('Y'); |
389 | 389 | } |
@@ -474,28 +474,28 @@ discard block |
||
474 | 474 | $hexAlphabet = array('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'); |
475 | 475 | |
476 | 476 | $stack = array(); |
477 | - foreach(self::$controlChars as $char) |
|
477 | + foreach (self::$controlChars as $char) |
|
478 | 478 | { |
479 | 479 | $tokens = explode('-', $char); |
480 | 480 | $start = $tokens[0]; |
481 | 481 | $end = $tokens[1]; |
482 | 482 | $prefix = substr($start, 0, 3); |
483 | 483 | $range = array(); |
484 | - foreach($hexAlphabet as $number) { |
|
484 | + foreach ($hexAlphabet as $number) { |
|
485 | 485 | $range[] = $prefix.$number; |
486 | 486 | } |
487 | 487 | |
488 | 488 | $use = false; |
489 | - foreach($range as $number) { |
|
490 | - if($number == $start) { |
|
489 | + foreach ($range as $number) { |
|
490 | + if ($number == $start) { |
|
491 | 491 | $use = true; |
492 | 492 | } |
493 | 493 | |
494 | - if($use) { |
|
494 | + if ($use) { |
|
495 | 495 | $stack[] = $number; |
496 | 496 | } |
497 | 497 | |
498 | - if($number == $end) { |
|
498 | + if ($number == $end) { |
|
499 | 499 | break; |
500 | 500 | } |
501 | 501 | } |
@@ -516,7 +516,7 @@ discard block |
||
516 | 516 | $chars = self::getControlCharactersAsHex(); |
517 | 517 | |
518 | 518 | $result = array(); |
519 | - foreach($chars as $char) { |
|
519 | + foreach ($chars as $char) { |
|
520 | 520 | $result[] = hex2bin($char); |
521 | 521 | } |
522 | 522 | |
@@ -534,14 +534,14 @@ discard block |
||
534 | 534 | $chars = self::getControlCharactersAsHex(); |
535 | 535 | |
536 | 536 | $result = array(); |
537 | - foreach($chars as $char) { |
|
537 | + foreach ($chars as $char) { |
|
538 | 538 | $result[] = '\u'.strtolower($char); |
539 | 539 | } |
540 | 540 | |
541 | 541 | return $result; |
542 | 542 | } |
543 | 543 | |
544 | - protected static $controlChars = array( |
|
544 | + protected static $controlChars = array( |
|
545 | 545 | '0000-0008', // control chars |
546 | 546 | '000E-000F', // control chars |
547 | 547 | '0010-001F', // control chars |
@@ -563,19 +563,19 @@ discard block |
||
563 | 563 | */ |
564 | 564 | public static function stripControlCharacters(string $string) : string |
565 | 565 | { |
566 | - if(empty($string)) { |
|
566 | + if (empty($string)) { |
|
567 | 567 | return $string; |
568 | 568 | } |
569 | 569 | |
570 | 570 | // create the regex from the unicode characters list |
571 | - if(!isset(self::$controlCharsRegex)) |
|
571 | + if (!isset(self::$controlCharsRegex)) |
|
572 | 572 | { |
573 | 573 | $chars = self::getControlCharactersAsHex(); |
574 | 574 | |
575 | 575 | // we use the notation \x{0000} to specify the unicode character key |
576 | 576 | // in the regular expression. |
577 | 577 | $stack = array(); |
578 | - foreach($chars as $char) { |
|
578 | + foreach ($chars as $char) { |
|
579 | 579 | $stack[] = '\x{'.$char.'}'; |
580 | 580 | } |
581 | 581 | |
@@ -609,7 +609,7 @@ discard block |
||
609 | 609 | $ordInt = ord($octet); |
610 | 610 | // Convert from int (base 10) to hex (base 16), for PHP \x syntax |
611 | 611 | $ordHex = base_convert($ordInt, 10, 16); |
612 | - $output .= '\x' . $ordHex; |
|
612 | + $output .= '\x'.$ordHex; |
|
613 | 613 | } |
614 | 614 | return $output; |
615 | 615 | } |
@@ -641,19 +641,19 @@ discard block |
||
641 | 641 | |
642 | 642 | protected static function convertScalarForComparison($scalar) |
643 | 643 | { |
644 | - if($scalar === '' || is_null($scalar)) { |
|
644 | + if ($scalar === '' || is_null($scalar)) { |
|
645 | 645 | return null; |
646 | 646 | } |
647 | 647 | |
648 | - if(is_bool($scalar)) { |
|
648 | + if (is_bool($scalar)) { |
|
649 | 649 | return self::bool2string($scalar); |
650 | 650 | } |
651 | 651 | |
652 | - if(is_array($scalar)) { |
|
652 | + if (is_array($scalar)) { |
|
653 | 653 | $scalar = md5(serialize($scalar)); |
654 | 654 | } |
655 | 655 | |
656 | - if($scalar !== null && !is_scalar($scalar)) { |
|
656 | + if ($scalar !== null && !is_scalar($scalar)) { |
|
657 | 657 | throw new ConvertHelper_Exception( |
658 | 658 | 'Not a scalar value in comparison', |
659 | 659 | null, |
@@ -702,7 +702,7 @@ discard block |
||
702 | 702 | public static function bool2string($boolean, bool $yesno = false) : string |
703 | 703 | { |
704 | 704 | // allow 'yes', 'true', 'no', 'false' string notations as well |
705 | - if(!is_bool($boolean)) { |
|
705 | + if (!is_bool($boolean)) { |
|
706 | 706 | $boolean = self::string2bool($boolean); |
707 | 707 | } |
708 | 708 | |
@@ -743,15 +743,15 @@ discard block |
||
743 | 743 | public static function array2attributeString($array) |
744 | 744 | { |
745 | 745 | $tokens = array(); |
746 | - foreach($array as $attr => $value) { |
|
747 | - if($value == '' || $value == null) { |
|
746 | + foreach ($array as $attr => $value) { |
|
747 | + if ($value == '' || $value == null) { |
|
748 | 748 | continue; |
749 | 749 | } |
750 | 750 | |
751 | 751 | $tokens[] = $attr.'="'.$value.'"'; |
752 | 752 | } |
753 | 753 | |
754 | - if(empty($tokens)) { |
|
754 | + if (empty($tokens)) { |
|
755 | 755 | return ''; |
756 | 756 | } |
757 | 757 | |
@@ -766,10 +766,10 @@ discard block |
||
766 | 766 | * @param string $string |
767 | 767 | * @return string |
768 | 768 | */ |
769 | - public static function string2attributeJS($string, $quoted=true) |
|
769 | + public static function string2attributeJS($string, $quoted = true) |
|
770 | 770 | { |
771 | 771 | $converted = addslashes(htmlspecialchars(strip_tags($string), ENT_QUOTES, 'UTF-8')); |
772 | - if($quoted) { |
|
772 | + if ($quoted) { |
|
773 | 773 | $converted = "'".$converted."'"; |
774 | 774 | } |
775 | 775 | |
@@ -787,11 +787,11 @@ discard block |
||
787 | 787 | */ |
788 | 788 | public static function isBoolean($value) : bool |
789 | 789 | { |
790 | - if(is_bool($value)) { |
|
790 | + if (is_bool($value)) { |
|
791 | 791 | return true; |
792 | 792 | } |
793 | 793 | |
794 | - if(!is_scalar($value)) { |
|
794 | + if (!is_scalar($value)) { |
|
795 | 795 | return false; |
796 | 796 | } |
797 | 797 | |
@@ -807,7 +807,7 @@ discard block |
||
807 | 807 | public static function array2styleString(array $subject) : string |
808 | 808 | { |
809 | 809 | $tokens = array(); |
810 | - foreach($subject as $name => $value) { |
|
810 | + foreach ($subject as $name => $value) { |
|
811 | 811 | $tokens[] = $name.':'.$value; |
812 | 812 | } |
813 | 813 | |
@@ -865,7 +865,7 @@ discard block |
||
865 | 865 | * |
866 | 866 | * @see JSHelper::buildRegexStatement() |
867 | 867 | */ |
868 | - public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) |
|
868 | + public static function regex2js(string $regex, string $statementType = JSHelper::JS_REGEX_OBJECT) |
|
869 | 869 | { |
870 | 870 | return JSHelper::buildRegexStatement($regex, $statementType); |
871 | 871 | } |
@@ -882,11 +882,11 @@ discard block |
||
882 | 882 | * @throws ConvertHelper_Exception |
883 | 883 | * @return string |
884 | 884 | */ |
885 | - public static function var2json($variable, int $options=0, int $depth=512) : string |
|
885 | + public static function var2json($variable, int $options = 0, int $depth = 512) : string |
|
886 | 886 | { |
887 | 887 | $result = json_encode($variable, $options, $depth); |
888 | 888 | |
889 | - if($result !== false) { |
|
889 | + if ($result !== false) { |
|
890 | 890 | return $result; |
891 | 891 | } |
892 | 892 | |
@@ -911,10 +911,10 @@ discard block |
||
911 | 911 | public static function stripUTFBom($string) |
912 | 912 | { |
913 | 913 | $boms = FileHelper::getUTFBOMs(); |
914 | - foreach($boms as $bomChars) { |
|
914 | + foreach ($boms as $bomChars) { |
|
915 | 915 | $length = mb_strlen($bomChars); |
916 | 916 | $text = mb_substr($string, 0, $length); |
917 | - if($text==$bomChars) { |
|
917 | + if ($text == $bomChars) { |
|
918 | 918 | return mb_substr($string, $length); |
919 | 919 | } |
920 | 920 | } |
@@ -931,7 +931,7 @@ discard block |
||
931 | 931 | */ |
932 | 932 | public static function string2utf8($string) |
933 | 933 | { |
934 | - if(!self::isStringASCII($string)) { |
|
934 | + if (!self::isStringASCII($string)) { |
|
935 | 935 | return \ForceUTF8\Encoding::toUTF8($string); |
936 | 936 | } |
937 | 937 | |
@@ -949,11 +949,11 @@ discard block |
||
949 | 949 | */ |
950 | 950 | public static function isStringASCII($string) : bool |
951 | 951 | { |
952 | - if($string === '' || $string === NULL) { |
|
952 | + if ($string === '' || $string === NULL) { |
|
953 | 953 | return true; |
954 | 954 | } |
955 | 955 | |
956 | - if(!is_string($string)) { |
|
956 | + if (!is_string($string)) { |
|
957 | 957 | return false; |
958 | 958 | } |
959 | 959 | |
@@ -987,7 +987,7 @@ discard block |
||
987 | 987 | * @param array $options |
988 | 988 | * @return float |
989 | 989 | */ |
990 | - public static function matchString($source, $target, $options=array()) |
|
990 | + public static function matchString($source, $target, $options = array()) |
|
991 | 991 | { |
992 | 992 | $defaults = array( |
993 | 993 | 'maxLevenshtein' => 10, |
@@ -997,12 +997,12 @@ discard block |
||
997 | 997 | $options = array_merge($defaults, $options); |
998 | 998 | |
999 | 999 | // avoid doing this via levenshtein |
1000 | - if($source == $target) { |
|
1000 | + if ($source == $target) { |
|
1001 | 1001 | return 100; |
1002 | 1002 | } |
1003 | 1003 | |
1004 | 1004 | $diff = levenshtein($source, $target); |
1005 | - if($diff > $options['maxLevenshtein']) { |
|
1005 | + if ($diff > $options['maxLevenshtein']) { |
|
1006 | 1006 | return 0; |
1007 | 1007 | } |
1008 | 1008 | |
@@ -1086,24 +1086,24 @@ discard block |
||
1086 | 1086 | * @see ConvertHelper::INTERVAL_HOURS |
1087 | 1087 | * @see ConvertHelper::INTERVAL_DAYS |
1088 | 1088 | */ |
1089 | - public static function interval2total(\DateInterval $interval, $unit=self::INTERVAL_SECONDS) : int |
|
1089 | + public static function interval2total(\DateInterval $interval, $unit = self::INTERVAL_SECONDS) : int |
|
1090 | 1090 | { |
1091 | 1091 | $total = (int)$interval->format('%a'); |
1092 | 1092 | if ($unit == self::INTERVAL_DAYS) { |
1093 | 1093 | return $total; |
1094 | 1094 | } |
1095 | 1095 | |
1096 | - $total = ($total * 24) + ((int)$interval->h ); |
|
1096 | + $total = ($total * 24) + ((int)$interval->h); |
|
1097 | 1097 | if ($unit == self::INTERVAL_HOURS) { |
1098 | 1098 | return $total; |
1099 | 1099 | } |
1100 | 1100 | |
1101 | - $total = ($total * 60) + ((int)$interval->i ); |
|
1101 | + $total = ($total * 60) + ((int)$interval->i); |
|
1102 | 1102 | if ($unit == self::INTERVAL_MINUTES) { |
1103 | 1103 | return $total; |
1104 | 1104 | } |
1105 | 1105 | |
1106 | - $total = ($total * 60) + ((int)$interval->s ); |
|
1106 | + $total = ($total * 60) + ((int)$interval->s); |
|
1107 | 1107 | if ($unit == self::INTERVAL_SECONDS) { |
1108 | 1108 | return $total; |
1109 | 1109 | } |
@@ -1132,13 +1132,13 @@ discard block |
||
1132 | 1132 | * @param bool $short |
1133 | 1133 | * @return string|NULL |
1134 | 1134 | */ |
1135 | - public static function date2dayName(\DateTime $date, bool $short=false) |
|
1135 | + public static function date2dayName(\DateTime $date, bool $short = false) |
|
1136 | 1136 | { |
1137 | 1137 | $day = $date->format('l'); |
1138 | 1138 | $invariant = self::getDayNamesInvariant(); |
1139 | 1139 | |
1140 | 1140 | $idx = array_search($day, $invariant); |
1141 | - if($idx !== false) { |
|
1141 | + if ($idx !== false) { |
|
1142 | 1142 | $localized = self::getDayNames($short); |
1143 | 1143 | return $localized[$idx]; |
1144 | 1144 | } |
@@ -1161,10 +1161,10 @@ discard block |
||
1161 | 1161 | * @param bool $short |
1162 | 1162 | * @return array |
1163 | 1163 | */ |
1164 | - public static function getDayNames(bool $short=false) : array |
|
1164 | + public static function getDayNames(bool $short = false) : array |
|
1165 | 1165 | { |
1166 | - if($short) { |
|
1167 | - if(!isset(self::$daysShort)) { |
|
1166 | + if ($short) { |
|
1167 | + if (!isset(self::$daysShort)) { |
|
1168 | 1168 | self::$daysShort = array( |
1169 | 1169 | t('Mon'), |
1170 | 1170 | t('Tue'), |
@@ -1179,7 +1179,7 @@ discard block |
||
1179 | 1179 | return self::$daysShort; |
1180 | 1180 | } |
1181 | 1181 | |
1182 | - if(!isset(self::$days)) { |
|
1182 | + if (!isset(self::$days)) { |
|
1183 | 1183 | self::$days = array( |
1184 | 1184 | t('Monday'), |
1185 | 1185 | t('Tuesday'), |
@@ -1204,17 +1204,17 @@ discard block |
||
1204 | 1204 | */ |
1205 | 1205 | public static function implodeWithAnd(array $list, $sep = ', ', $conjunction = null) |
1206 | 1206 | { |
1207 | - if(empty($list)) { |
|
1207 | + if (empty($list)) { |
|
1208 | 1208 | return ''; |
1209 | 1209 | } |
1210 | 1210 | |
1211 | - if(empty($conjunction)) { |
|
1211 | + if (empty($conjunction)) { |
|
1212 | 1212 | $conjunction = t('and'); |
1213 | 1213 | } |
1214 | 1214 | |
1215 | 1215 | $last = array_pop($list); |
1216 | - if($list) { |
|
1217 | - return implode($sep, $list) . $conjunction . ' ' . $last; |
|
1216 | + if ($list) { |
|
1217 | + return implode($sep, $list).$conjunction.' '.$last; |
|
1218 | 1218 | } |
1219 | 1219 | |
1220 | 1220 | return $last; |
@@ -1233,7 +1233,7 @@ discard block |
||
1233 | 1233 | public static function string2array(string $string) : array |
1234 | 1234 | { |
1235 | 1235 | $result = preg_split('//u', $string, null, PREG_SPLIT_NO_EMPTY); |
1236 | - if($result !== false) { |
|
1236 | + if ($result !== false) { |
|
1237 | 1237 | return $result; |
1238 | 1238 | } |
1239 | 1239 | |
@@ -1248,12 +1248,12 @@ discard block |
||
1248 | 1248 | */ |
1249 | 1249 | public static function isStringHTML(string $string) : bool |
1250 | 1250 | { |
1251 | - if(preg_match('%<[a-z/][\s\S]*>%siU', $string)) { |
|
1251 | + if (preg_match('%<[a-z/][\s\S]*>%siU', $string)) { |
|
1252 | 1252 | return true; |
1253 | 1253 | } |
1254 | 1254 | |
1255 | 1255 | $decoded = html_entity_decode($string); |
1256 | - if($decoded !== $string) { |
|
1256 | + if ($decoded !== $string) { |
|
1257 | 1257 | return true; |
1258 | 1258 | } |
1259 | 1259 | |
@@ -1362,14 +1362,14 @@ discard block |
||
1362 | 1362 | * @param bool $caseInsensitive |
1363 | 1363 | * @return ConvertHelper_StringMatch[] |
1364 | 1364 | */ |
1365 | - public static function findString(string $needle, string $haystack, bool $caseInsensitive=false) |
|
1365 | + public static function findString(string $needle, string $haystack, bool $caseInsensitive = false) |
|
1366 | 1366 | { |
1367 | - if($needle === '') { |
|
1367 | + if ($needle === '') { |
|
1368 | 1368 | return array(); |
1369 | 1369 | } |
1370 | 1370 | |
1371 | 1371 | $function = 'mb_strpos'; |
1372 | - if($caseInsensitive) { |
|
1372 | + if ($caseInsensitive) { |
|
1373 | 1373 | $function = 'mb_stripos'; |
1374 | 1374 | } |
1375 | 1375 | |
@@ -1377,7 +1377,7 @@ discard block |
||
1377 | 1377 | $positions = array(); |
1378 | 1378 | $length = mb_strlen($needle); |
1379 | 1379 | |
1380 | - while( ($pos = $function($haystack, $needle, $pos)) !== false) |
|
1380 | + while (($pos = $function($haystack, $needle, $pos)) !== false) |
|
1381 | 1381 | { |
1382 | 1382 | $match = mb_substr($haystack, $pos, $length); |
1383 | 1383 | $positions[] = new ConvertHelper_StringMatch($pos, $match); |
@@ -1397,7 +1397,7 @@ discard block |
||
1397 | 1397 | */ |
1398 | 1398 | public static function explodeTrim(string $delimiter, string $string) : array |
1399 | 1399 | { |
1400 | - if(empty($string) || empty($delimiter)) { |
|
1400 | + if (empty($string) || empty($delimiter)) { |
|
1401 | 1401 | return array(); |
1402 | 1402 | } |
1403 | 1403 | |
@@ -1405,8 +1405,8 @@ discard block |
||
1405 | 1405 | $tokens = array_map('trim', $tokens); |
1406 | 1406 | |
1407 | 1407 | $keep = array(); |
1408 | - foreach($tokens as $token) { |
|
1409 | - if($token !== '') { |
|
1408 | + foreach ($tokens as $token) { |
|
1409 | + if ($token !== '') { |
|
1410 | 1410 | $keep[] = $token; |
1411 | 1411 | } |
1412 | 1412 | } |
@@ -1424,11 +1424,11 @@ discard block |
||
1424 | 1424 | */ |
1425 | 1425 | public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL |
1426 | 1426 | { |
1427 | - if(empty($subjectString)) { |
|
1427 | + if (empty($subjectString)) { |
|
1428 | 1428 | return null; |
1429 | 1429 | } |
1430 | 1430 | |
1431 | - if(!isset(self::$eolChars)) |
|
1431 | + if (!isset(self::$eolChars)) |
|
1432 | 1432 | { |
1433 | 1433 | $cr = chr((int)hexdec('0d')); |
1434 | 1434 | $lf = chr((int)hexdec('0a')); |
@@ -1459,18 +1459,18 @@ discard block |
||
1459 | 1459 | |
1460 | 1460 | $max = 0; |
1461 | 1461 | $results = array(); |
1462 | - foreach(self::$eolChars as $def) |
|
1462 | + foreach (self::$eolChars as $def) |
|
1463 | 1463 | { |
1464 | 1464 | $amount = substr_count($subjectString, $def['char']); |
1465 | 1465 | |
1466 | - if($amount > $max) |
|
1466 | + if ($amount > $max) |
|
1467 | 1467 | { |
1468 | 1468 | $max = $amount; |
1469 | 1469 | $results[] = $def; |
1470 | 1470 | } |
1471 | 1471 | } |
1472 | 1472 | |
1473 | - if(empty($results)) { |
|
1473 | + if (empty($results)) { |
|
1474 | 1474 | return null; |
1475 | 1475 | } |
1476 | 1476 | |
@@ -1490,9 +1490,9 @@ discard block |
||
1490 | 1490 | */ |
1491 | 1491 | public static function arrayRemoveKeys(array &$array, array $keys) : void |
1492 | 1492 | { |
1493 | - foreach($keys as $key) |
|
1493 | + foreach ($keys as $key) |
|
1494 | 1494 | { |
1495 | - if(array_key_exists($key, $array)) { |
|
1495 | + if (array_key_exists($key, $array)) { |
|
1496 | 1496 | unset($array[$key]); |
1497 | 1497 | } |
1498 | 1498 | } |
@@ -1507,17 +1507,17 @@ discard block |
||
1507 | 1507 | */ |
1508 | 1508 | public static function isInteger($value) : bool |
1509 | 1509 | { |
1510 | - if(is_int($value)) { |
|
1510 | + if (is_int($value)) { |
|
1511 | 1511 | return true; |
1512 | 1512 | } |
1513 | 1513 | |
1514 | 1514 | // booleans get converted to numbers, so they would |
1515 | 1515 | // actually match the regex. |
1516 | - if(is_bool($value)) { |
|
1516 | + if (is_bool($value)) { |
|
1517 | 1517 | return false; |
1518 | 1518 | } |
1519 | 1519 | |
1520 | - if(is_string($value) && $value !== '') { |
|
1520 | + if (is_string($value) && $value !== '') { |
|
1521 | 1521 | return preg_match('/\A-?\d+\z/', $value) === 1; |
1522 | 1522 | } |
1523 | 1523 |