#7 - Add formatting for units

Author: technicalguru

README.md

@@ -9,6 +9,7 @@ This is a collection of useful classes and functions for every day PHP life. It
 * Obfuscating sensitive information to protect data against spambots
 * Slugifying strings for usage in URLs
 * Generating random strings
+* Formatting prices and units
 
 These classes are no rocket science, just simple helpers that prevent from wiriting the
 same code in various flavours over and over again.
@@ -226,6 +227,8 @@ There are some daily tasks that need to be done in applications. The `Utils` cla
 
 ```
 use TgUtils\Utils;
+use TgUtils\FormatUtils;
+use TgUtils\Slugify;
 
 // create a random string
 $myId = Utils::generateRandomString(20);
@@ -253,6 +256,12 @@ $masked = Utils::anonymize($aPhoneNumber);
 
 // Slugify a string
 $slug = Slugify::slugify('A text that turn into an URL');
+
+// Format a price
+$priceString = FormatUtils::formatPrice(3000.643, 'EUR');
+
+// Format a file size
+$fileSize = FormatUtils::formatUnit(3000643, 'B');
 ```
 
 Inspect the [source code](https://github.com/technicalguru/php-utils/blob/src/TgUtils/Utils.php) to find more about the methods available.

src/TgUtils/FormatUtils.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace TgUtils;
+
+use \TgI18n\I18N;
+
+I18N::addI18nFile(__DIR__ . '/../utils_i18n.php', FALSE);
+
+/**
+ * Provides some formatting utils.
+ * @author ralph
+ *        
+ */
+class FormatUtils {
+
+	/**
+	 * Format a price value using localization.
+	 * @param float $value - the value
+	 * @param string $currency - the currency
+	 * @param string $language - the language code (optional, default language of I18N class).
+	 * @param string $spaceChar - the space character to be used between value and currency (optional, default is HTML non-breaking space).
+	 * @return string the formatted price in localized manner.
+	 */
+    public static function formatPrice($value, $currency, $language = null, $spaceChar = '&nbsp;') {
+		return number_format(floatval($value), 2, I18N::_('decimal_point', $language), I18N::_('thousand_sep', $language)).$spaceChar.$currency;
+	}
+	
+	/**
+	 * Format a unit by using prefixes (decimal and computer bytes only).
+	 * @param int $size - the size to be formatted
+	 * @param string $unit - the unit string
+	 * @param int $precision - how many digits after decimal point shall be displayed (optional, default is 1)
+	 * @param string $language - the language to be used for number formatting separators (optional, default is NULL)
+	 * @param bool $bytes - TRUE when computer byte counting is used, FALSE when decimal base shall be applied (optional, default is TRUE)
+	 * @return string a formatted string
+	 */
+	public static function formatUnit($size, $unit, $precision = 1, $language = NULL, $bytes = TRUE) {
+	    $prefixes = $bytes ? array('K', 'M', 'G', 'T' ) : array('k', 'M', 'G', 'T');  
+	    $rc       = $unit;
+	    $base     = $bytes ? 1024 : 1000;
+		// Only until GB
+		if ($size > $base) {
+			$size = $size/$base;
+			$rc   = $prefixes[0].$unit;
+		}
+		if ($size > $base) {
+			$size = $size/$base;
+			$rc   = $prefixes[1].$unit;
+		}
+		if ($size > $base) {
+			$size = $size/$base;
+			$rc   = $prefixes[2].$unit;
+		}
+		if ($size > $base) {
+			$size = $size/$base;
+			$rc   = $prefixes[3].$unit;
+		}
+		$size = $rc != $unit ? number_format($size, $precision, I18N::_('decimal_point', $language), I18N::_('thousand_sep', $language)) : number_format($size, 0, I18N::_('decimal_point', $language), I18N::_('thousand_sep', $language));
+		return $size.' '.$rc;
+	}
+}
+

src/TgUtils/Utils.php

@@ -2,10 +2,6 @@
 
 namespace TgUtils;
 
-use \TgI18n\I18N;
-
-I18N::addI18nFile(__DIR__ . '/../utils_i18n.php', FALSE);
-
 class Utils {
 
     /**
@@ -105,17 +101,4 @@ public static function findBy($list, $attr, $value) {
 		}
 		return $rc;
 	}
-	
-	/**
-	 * Format a price value using localization.
-	 * @param float $value - the value
-	 * @param string $currency - the currency
-	 * @param string $language - the language code (optional, default language of I18N class).
-	 * @param string $spaceChar - the space character to be used between value and currency (optional, default is HTML non-breaking space).
-	 * @return string the formatted price in localized manner.
-	 */
-    public static function formatPrice($value, $currency, $language = null, $spaceChar = ' ') {
-		return number_format(floatval($value), 2, I18N::_('decimal_point', $language), I18N::_('thousand_sep', $language)).$spaceChar.$currency;
-	}
-	
 }

tests/TgUtils/FormatUtilsTest.php

@@ -0,0 +1,31 @@
+<?php declare(strict_types=1);
+
+namespace TgUtils;
+
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Tests some slugify methods.
+ * @author ralph
+ *        
+ */
+class FormatUtilsTest extends TestCase {
+
+    public function testFormatPrice(): void {
+        $value = 3000.643;
+        $this->assertEquals('3.000,64 EUR', FormatUtils::formatPrice($value, 'EUR', 'de', ' '));
+    }
+    
+    public function testFormatUnitWithBytes(): void {
+        $value = 3000643;
+        $this->assertEquals('2,86 MB', FormatUtils::formatUnit($value, 'B', 2, 'de'));
+    }
+    
+    
+    public function testFormatUnitWithDecimal(): void {
+        $value = 303400643;
+        $this->assertEquals('303,401 MW', FormatUtils::formatUnit($value, 'W', 3, 'de', FALSE));
+    }
+    
+}
+