3 namespace Org\Mxchange\CoreFramework\Utils\Strings;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
7 use Org\Mxchange\CoreFramework\Configuration\FrameworkConfiguration;
8 use Org\Mxchange\CoreFramework\Generic\NullPointerException;
9 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
12 use \InvalidArgumentException;
15 * A string utility class
17 * @author Roland Haeder <webmaster@ship-simu.org>
19 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2022 Core Developer Team
20 * @license GNU GPL 3.0 or any newer version
21 * @link http://www.ship-simu.org
23 * This program is free software: you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation, either version 3 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License
34 * along with this program. If not, see <http://www.gnu.org/licenses/>.
36 final class StringUtils extends BaseFrameworkSystem {
40 private static $thousands = ''; // German
45 private static $decimals = ''; // German
48 * In-method cache array
50 private static $cache = [];
53 * Array with bitmasks and such for pack/unpack methods to support both
54 * 32-bit and 64-bit systems
56 private static $packingData = [
60 'right' => 0x0000ffff,
66 'left' => 0xffffffff00000000,
67 'right' => 0x00000000ffffffff,
74 * Hexadecimal->Decimal translation array
76 private static $hexdec = [
96 * Decimal->hexadecimal translation array
98 private static $dechex = [
118 * Simple 64-bit check, thanks to "Salman A" from stackoverflow.com:
120 * The integer size is 4 bytes on 32-bit and 8 bytes on a 64-bit system.
122 private static $archArrayElement = 0;
125 * Private constructor, no instance needed. If PHP would have a static initializer ...
129 private function __construct () {
130 // Call parent constructor
131 parent::__construct(__CLASS__);
134 if (empty(self::$archArrayElement)) {
136 self::$archArrayElement = (PHP_INT_SIZE === 8 ? 64 : 32);
138 // Init from configuration
139 self::$thousands = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('thousands_separator');
140 self::$decimals = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('decimals_separator');
145 * Converts dashes to underscores, e.g. useable for configuration entries
147 * @param $str The string with maybe dashes inside
148 * @return $str The converted string with no dashed, but underscores
149 * @throws NullPointerException If $str is null
150 * @throws InvalidArgumentException If $str is empty
152 public static function convertDashesToUnderscores (string $str) {
153 // Validate parameter
156 throw new InvalidArgumentException('Parameter "str" is empty');
160 $str = str_replace('-', '_', $str);
162 // Return converted string
167 * Encodes raw data (almost any type) by "serializing" it and then pack it
168 * into a "binary format".
170 * @param $rawData Raw data (almost any type)
171 * @return $encoded Encoded data
172 * @throws InvalidArgumentException If $rawData has a non-serializable data type
174 public static function encodeData ($rawData) {
175 // Make sure no objects or resources pass through
176 //* NOISY-DEBUG */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('STRING-UTILS: rawData[]=%s - CALLED!', gettype($rawData)));
177 if (is_object($rawData) || is_resource($rawData)) {
178 // Not all variable types should be serialized here
179 throw new InvalidArgumentException(sprintf('rawData[]=%s cannot be serialized.', gettype($rawData)));
183 $dummyInstance = new StringUtils();
185 // First "serialize" it (json_encode() is faster than serialize())
186 $encoded = self::packString(json_encode($rawData));
189 //* NOISY-DEBUG */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('STRING-UTILS: encoded()=%d - EXIT!', strlen($encoded)));
194 * Converts e.g. a command from URL to a valid class by keeping out bad characters
196 * @param $str The string, what ever it is needs to be converted
197 * @return $className Generated class name
198 * @throws InvalidArgumentException If a paramter is invalid
200 public static final function convertToClassName (string $str) {
201 // Is the parameter valid?
202 //* NOISY-DEBUG */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('STRING-UTILS: str=%s - CALLED!', $str));
204 // No empty strings, please
205 throw new InvalidArgumentException('Parameter "str" is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
206 } elseif (!isset(self::$cache[$str])) {
210 // Convert all dashes in underscores
211 $str = self::convertDashesToUnderscores($str);
213 // Now use that underscores to get classname parts for hungarian style
214 //* NOISY-DEBUG */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('STRING-UTILS: str=%s - AFTER!', $str));
215 foreach (explode('_', $str) as $strPart) {
216 // Make the class name part lower case and first upper case
217 $className .= ucfirst(strtolower($strPart));
221 //* NOISY-DEBUG */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('STRING-UTILS: self[%s]=%s - SET!', $str, $className));
222 self::$cache[$str] = $className;
226 //* NOISY-DEBUG */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('STRING-UTILS: self[%s]=%s - EXIT!', $str, $className));
227 return self::$cache[$str];
231 * Formats computer generated price values into human-understandable formats
232 * with thousand and decimal separators.
234 * @param $value The in computer format value for a price
235 * @param $currency The currency symbol (use HTML-valid characters!)
236 * @param $decNum Number of decimals after commata
237 * @return $price The for the current language formated price string
238 * @throws MissingDecimalsThousandsSeparatorException If decimals or thousands separator is missing
240 public static function formatCurrency (float $value, string $currency = '€', int $decNum = 2) {
242 $dummyInstance = new StringUtils();
244 // Reformat the US number
245 $price = number_format($value, $decNum, self::$decimals, self::$thousands) . $currency;
247 // Return as string...
252 * Converts a hexadecimal string, even with negative sign as first string to
253 * a decimal number using BC functions.
255 * This work is based on comment #86673 on php.net documentation page at:
256 * <http://de.php.net/manual/en/function.dechex.php#86673>
258 * @param $hex Hexadecimal string
259 * @return $dec Decimal number
261 public static function hex2dec (string $hex) {
262 // Convert to all lower-case
263 $hex = strtolower($hex);
265 // Detect sign (negative/positive numbers)
267 if (substr($hex, 0, 1) == '-') {
269 $hex = substr($hex, 1);
272 // Decode the hexadecimal string into a decimal number
274 for ($i = strlen($hex) - 1, $e = 1; $i >= 0; $i--, $e = bcmul($e, 16)) {
275 $factor = self::$hexdec[substr($hex, $i, 1)];
276 $dec = bcadd($dec, bcmul($factor, $e));
279 // Return the decimal number
284 * Converts even very large decimal numbers, also signed, to a hexadecimal
287 * This work is based on comment #97756 on php.net documentation page at:
288 * <http://de.php.net/manual/en/function.hexdec.php#97756>
290 * @param $dec Decimal number, even with negative sign
291 * @param $maxLength Optional maximum length of the string
292 * @return $hex Hexadecimal string
294 public static function dec2hex (string $dec, int $maxLength = 0) {
295 // maxLength can be zero or devideable by 2
296 assert(($maxLength == 0) || (($maxLength % 2) == 0));
298 // Detect sign (negative/positive numbers)
305 // Encode the decimal number into a hexadecimal string
308 $hex = self::$dechex[($dec % (2 ^ 4))] . $hex;
313 * Leading zeros are required for hex-decimal "numbers". In some
314 * situations more leading zeros are wanted, so check for both
317 if ($maxLength > 0) {
318 // Prepend more zeros
319 $hex = str_pad($hex, $maxLength, '0', STR_PAD_LEFT);
320 } elseif ((strlen($hex) % 2) != 0) {
321 // Only make string's length dividable by 2
325 // Return the hexadecimal string
330 * Converts a ASCII string (0 to 255) into a decimal number.
332 * @param $asc The ASCII string to be converted
333 * @return $dec Decimal number
335 public static function asc2dec (string $asc) {
336 // Convert it into a hexadecimal number
337 $hex = bin2hex($asc);
339 // And back into a decimal number
340 $dec = self::hex2dec($hex);
347 * Converts a decimal number into an ASCII string.
349 * @param $dec Decimal number
350 * @return $asc An ASCII string
352 public static function dec2asc (string $dec) {
353 // First convert the number into a hexadecimal string
354 $hex = self::dec2hex($dec);
356 // Then convert it into the ASCII string
357 $asc = self::hex2asc($hex);
364 * Converts a hexadecimal number into an ASCII string. Negative numbers
367 * @param $hex Hexadecimal string
368 * @return $asc An ASCII string
370 public static function hex2asc ($hex) {
371 // Check for length, it must be devideable by 2
372 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('hex='.$hex);
373 assert((strlen($hex) % 2) == 0);
377 for ($idx = 0; $idx < strlen($hex); $idx+=2) {
378 // Get the decimal number of the chunk
379 $part = hexdec(substr($hex, $idx, 2));
381 // Add it to the final string
385 // Return the final string
390 * Pack a string into a "binary format". Please execuse me that this is
391 * widely undocumented. :-(
393 * @param $str Unpacked string
394 * @return $packed Packed string
395 * @todo Improve documentation
397 private static function packString (string $str) {
398 // First compress the string (gzcompress is okay)
399 //* NOISY-DEBUG */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('STRING-UTILS: str=%s - CALLED!', $str));
400 $str = gzcompress($str);
405 // And start the "encoding" loop
406 for ($idx = 0; $idx < strlen($str); $idx += self::$packingData[self::$archArrayElement]['step']) {
408 for ($i = 0; $i < self::$packingData[self::$archArrayElement]['step']; $i++) {
409 $factor = (self::$packingData[self::$archArrayElement]['step'] - 1 - $i);
411 if (($idx + $i) <= strlen($str)) {
412 $ord = ord(substr($str, ($idx + $i), 1));
414 $add = $ord * pow(256, $factor);
418 //print 'idx=' . $idx . ',i=' . $i . ',ord=' . $ord . ',factor=' . $factor . ',add=' . $add . ',big=' . $big . PHP_EOL;
422 // Left/right parts (low/high?)
423 $l = ($big & self::$packingData[self::$archArrayElement]['left']) >>self::$packingData[self::$archArrayElement]['factor'];
424 $r = $big & self::$packingData[self::$archArrayElement]['right'];
427 $chunk = str_pad(pack(self::$packingData[self::$archArrayElement]['format'], $l, $r), 8, '0', STR_PAD_LEFT);
428 //* NOISY-DEBUG */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('STRING-UTILS: big=%d,chunk(%d)=%s', $big, strlen($chunk), md5($chunk)));
434 //* NOISY-DEBUG */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('STRING-UTILS: packed=%s - EXIT!', $packed));
439 * Checks whether the given hexadecimal number is really a hex-number (only chars 0-9,a-f).
441 * @param $num A string consisting only chars between 0 and 9
442 * @param $assertMismatch Whether to assert mismatches
443 * @return $ret The (hopefully) secured hext-numbered value
445 public static function hexval (string $num, bool $assertMismatch = false) {
446 // Filter all numbers out
447 $ret = preg_replace('/[^0123456789abcdefABCDEF]/', '', $num);
449 // Assert only if requested
450 if ($assertMismatch === true) {
451 // Has the whole value changed?
452 assert(('' . $ret . '' != '' . $num . '') && (!is_null($num)));