Mistralys / application-utils

src/ConvertHelper/SizeNotation.php

Indentation +89 added lines, -89 removed lines

@@ -31,9 +31,9 @@ 
     
     const VALIDATION_ERROR_NEGATIVE_VALUE = 43803;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $sizeString;
 
     /**
@@ -41,44 +41,44 @@ 
      */
     protected $sizeDefinition;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $bytes = 0;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $valid = true;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $units = null;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $number = '';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $errorMessage = '';
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $errorCode = 0;
     
-   /**
-    * Create a new instance for the specified size string.
-    * 
-    * @param string $sizeString 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".
-    *
-    * @throws ConvertHelper_Exception
-    * @see ConvertHelper_StorageSizeEnum::ERROR_UNKNOWN_UNIT_NAME
-    */
+    /**
+     * Create a new instance for the specified size string.
+     * 
+     * @param string $sizeString 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".
+     *
+     * @throws ConvertHelper_Exception
+     * @see ConvertHelper_StorageSizeEnum::ERROR_UNKNOWN_UNIT_NAME
+     */
     public function __construct(string $sizeString)
     {
         $this->sizeString = $this->cleanString($sizeString);
@@ -86,31 +86,31 @@ 
         $this->convert();
     }
     
-   /**
-    * Gets the amount of bytes contained in the size notation.
-    * @return int
-    */
+    /**
+     * Gets the amount of bytes contained in the size notation.
+     * @return int
+     */
     public function toBytes() : int
     {
         return $this->bytes;
     }
     
-   /**
-    * Converts the size notation to a human-readable string, e.g. "50 MB".
-    * 
-    * @param int $precision
-    * @return string
-    * @see ConvertHelper::bytes2readable()
-    */
+    /**
+     * Converts the size notation to a human-readable string, e.g. "50 MB".
+     * 
+     * @param int $precision
+     * @return string
+     * @see ConvertHelper::bytes2readable()
+     */
     public function toString(int $precision=1) : string
     {
         return ConvertHelper::bytes2readable($this->bytes, $precision, $this->getBase());
     }
     
-   /**
-    * Retrieves the detected number's base.
-    * @return int The base number (1000 for Base 10, or 1024 for Base 2), or 0 if it is not valid.
-    */
+    /**
+     * Retrieves the detected number's base.
+     * @return int The base number (1000 for Base 10, or 1024 for Base 2), or 0 if it is not valid.
+     */
     public function getBase() : int
     {
         if($this->isValid()) {
@@ -120,13 +120,13 @@ 
         return 0;
     }
     
-   /**
-    * Retrieves the detected storage size instance, if 
-    * the size string is valid.
-    * 
-    * @return ConvertHelper_StorageSizeEnum_Size|NULL
-    * @see ConvertHelper_StorageSizeEnum_Size
-    */
+    /**
+     * Retrieves the detected storage size instance, if 
+     * the size string is valid.
+     * 
+     * @return ConvertHelper_StorageSizeEnum_Size|NULL
+     * @see ConvertHelper_StorageSizeEnum_Size
+     */
     public function getSizeDefinition() : ?ConvertHelper_StorageSizeEnum_Size
     {
         if($this->isValid()) {
@@ -136,27 +136,27 @@ 
         return null;
     }
     
-   /**
-    * Checks whether the size notation was valid and could be parsed
-    * into a meaningful byte value. If this returns `false`, it is 
-    * possible to use the `getErrorXXX` methods to retrieve information
-    * on what went wrong. 
-    * 
-    * @return bool
-    * @see ConvertHelper_SizeNotation::getErrorMessage()
-    * @see ConvertHelper_SizeNotation::getErrorCode()
-    */
+    /**
+     * Checks whether the size notation was valid and could be parsed
+     * into a meaningful byte value. If this returns `false`, it is 
+     * possible to use the `getErrorXXX` methods to retrieve information
+     * on what went wrong. 
+     * 
+     * @return bool
+     * @see ConvertHelper_SizeNotation::getErrorMessage()
+     * @see ConvertHelper_SizeNotation::getErrorCode()
+     */
     public function isValid() : bool
     {
         return $this->valid;
     }
     
-   /**
-    * Retrieves the error message if the size notation validation failed.
-    * 
-    * @return string
-    * @see ConvertHelper_SizeNotation::getErrorCode()
-    */
+    /**
+     * Retrieves the error message if the size notation validation failed.
+     * 
+     * @return string
+     * @see ConvertHelper_SizeNotation::getErrorCode()
+     */
     public function getErrorMessage() : string
     {
         return $this->errorMessage;
@@ -201,12 +201,12 @@ 
         );
     }
     
-   /**
-    * Detects the units and the number in the size notation string.
-    * Populates the `units` and `number` properties.
-    * 
-    * @return bool Whether the string could be parsed successfully.
-    */
+    /**
+     * Detects the units and the number in the size notation string.
+     * Populates the `units` and `number` properties.
+     * 
+     * @return bool Whether the string could be parsed successfully.
+     */
     protected function detectParts() : bool
     {
         $units = ConvertHelper_StorageSizeEnum::getSizeNames();
@@ -242,16 +242,16 @@ 
         return true;
     }
     
-   /**
-    * If the validation fails, this is used to store the reason for retrieval later.
-    *  
-    * @param string $message
-    * @param int $code
-    * 
-    * @see ConvertHelper_SizeNotation::isValid()
-    * @see ConvertHelper_SizeNotation::getErrorMessage()
-    * @see ConvertHelper_SizeNotation::getErrorCode()
-    */
+    /**
+     * If the validation fails, this is used to store the reason for retrieval later.
+     *  
+     * @param string $message
+     * @param int $code
+     * 
+     * @see ConvertHelper_SizeNotation::isValid()
+     * @see ConvertHelper_SizeNotation::getErrorMessage()
+     * @see ConvertHelper_SizeNotation::getErrorCode()
+     */
     protected function setError(string $message, int $code) : void
     {
         $this->valid = false;
@@ -259,12 +259,12 @@ 
         $this->errorCode = $code;
     }
     
-   /**
-    * Retrieves the error code, if the size notation validation failed.
-    * 
-    * @return int
-    * @see ConvertHelper_SizeNotation::getErrorMessage()
-    */
+    /**
+     * Retrieves the error code, if the size notation validation failed.
+     * 
+     * @return int
+     * @see ConvertHelper_SizeNotation::getErrorMessage()
+     */
     public function getErrorCode() : int
     {
         return $this->errorCode;

src/ConvertHelper/StorageSizeEnum.php

Indentation +54 added lines, -54 removed lines

@@ -31,17 +31,17 @@ 
     
     const BASE_2 = 1024;
     
-   /**
-    * @var ConvertHelper_StorageSizeEnum_Size[]
-    */
+    /**
+     * @var ConvertHelper_StorageSizeEnum_Size[]
+     */
     protected static $sizes = array();
     
-   /**
-    * Initializes the supported unit notations, and
-    * how they are supposed to be calculated.
-    *
-    * @see ConvertHelper_SizeNotation::parseSize()
-    */
+    /**
+     * Initializes the supported unit notations, and
+     * how they are supposed to be calculated.
+     *
+     * @see ConvertHelper_SizeNotation::parseSize()
+     */
     protected static function init() : void
     {
         if(!empty(self::$sizes)) {
@@ -68,28 +68,28 @@ 
         }
     }
     
-   /**
-    * Called whenever the application locale is changed,
-    * to reset the size definitions so the labels get 
-    * translated to the new locale.
-    */
+    /**
+     * Called whenever the application locale is changed,
+     * to reset the size definitions so the labels get 
+     * translated to the new locale.
+     */
     public static function handle_localeChanged() : void
     {
         self::$sizes = array();
     }
     
-   /**
-    * Adds a storage size to the internal collection.
-    * 
-    * @param string $name The lowercase size name, e.g. "kb", "mib"
-    * @param int $base This defines how many bytes there are in a kilobyte, to differentiate with the two common way to calculate sizes: base 10 or base 2. See the Wikipedia link for more details.
-    * @param int $exponent The multiplier of the base to get the byte value
-    * @param string $suffix The localized short suffix, e.g. "KB", "MiB"
-    * @param string $singular The localized singular label of the size, e.g. "Kilobyte".
-    * @param string $plural The localized plural label of the size, e.g. "Kilobytes".
-    * 
-    * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions
-    */
+    /**
+     * Adds a storage size to the internal collection.
+     * 
+     * @param string $name The lowercase size name, e.g. "kb", "mib"
+     * @param int $base This defines how many bytes there are in a kilobyte, to differentiate with the two common way to calculate sizes: base 10 or base 2. See the Wikipedia link for more details.
+     * @param int $exponent The multiplier of the base to get the byte value
+     * @param string $suffix The localized short suffix, e.g. "KB", "MiB"
+     * @param string $singular The localized singular label of the size, e.g. "Kilobyte".
+     * @param string $plural The localized plural label of the size, e.g. "Kilobytes".
+     * 
+     * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions
+     */
     protected static function addSize(string $name, int $base, int $exponent, string $suffix, string $singular, string $plural) : void
     {
         self::$sizes[$name] = new ConvertHelper_StorageSizeEnum_Size(
@@ -102,11 +102,11 @@ 
         );
     }
     
-   /**
-    * Retrieves all known sizes.
-    * 
-    * @return ConvertHelper_StorageSizeEnum_Size[]
-    */
+    /**
+     * Retrieves all known sizes.
+     * 
+     * @return ConvertHelper_StorageSizeEnum_Size[]
+     */
     public static function getSizes() : array
     {
         self::init();
@@ -114,15 +114,15 @@ 
         return self::$sizes;
     }
     
-   /**
-    * Retrieves a size definition instance by its name.
-    * 
-    * @param string $name Case-insensitive. For example "kb", "MiB"...
-    * @throws ConvertHelper_Exception
-    * @return ConvertHelper_StorageSizeEnum_Size
-    * 
-    * @see ConvertHelper_StorageSizeEnum::ERROR_UNKNOWN_UNIT_NAME
-    */
+    /**
+     * Retrieves a size definition instance by its name.
+     * 
+     * @param string $name Case-insensitive. For example "kb", "MiB"...
+     * @throws ConvertHelper_Exception
+     * @return ConvertHelper_StorageSizeEnum_Size
+     * 
+     * @see ConvertHelper_StorageSizeEnum::ERROR_UNKNOWN_UNIT_NAME
+     */
     public static function getSizeByName(string $name) : ConvertHelper_StorageSizeEnum_Size
     {
         self::init();
@@ -144,10 +144,10 @@ 
         );
     }
     
-   /**
-    * Retrieves a list of all size names, e.g. "mb", "kib" (lowercase).
-    * @return array
-    */
+    /**
+     * Retrieves a list of all size names, e.g. "mb", "kib" (lowercase).
+     * @return array
+     */
     public static function getSizeNames() : array
     {
         self::init();
@@ -155,16 +155,16 @@ 
         return array_keys(self::$sizes);
     }
    
-   /**
-    * Retrieves all available storage sizes for the specified
-    * base value.
-    * 
-    * @param int $base
-    * @return ConvertHelper_StorageSizeEnum_Size[]
-    * 
-    * @see ConvertHelper_StorageSizeEnum::BASE_10
-    * @see ConvertHelper_StorageSizeEnum::BASE_2
-    */
+    /**
+     * Retrieves all available storage sizes for the specified
+     * base value.
+     * 
+     * @param int $base
+     * @return ConvertHelper_StorageSizeEnum_Size[]
+     * 
+     * @see ConvertHelper_StorageSizeEnum::BASE_10
+     * @see ConvertHelper_StorageSizeEnum::BASE_2
+     */
     public static function getSizesByBase(int $base) : array
     {
         self::init();