Mistralys / application-utils

src/ConvertHelper/ByteConverter.php

Indentation +63 added lines, -63 removed lines

@@ -23,9 +23,9 @@ 
  */
 class ConvertHelper_ByteConverter
 {
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $bytes;
     
     public function __construct(int $bytes)
@@ -39,12 +39,12 @@ 
         }
     }
     
-   /**
-    * Detects the size matching the byte value for the specified base.
-    * 
-    * @param int $base
-    * @return ConvertHelper_StorageSizeEnum_Size
-    */
+    /**
+     * Detects the size matching the byte value for the specified base.
+     * 
+     * @param int $base
+     * @return ConvertHelper_StorageSizeEnum_Size
+     */
     protected function detectSize(int $base) : ConvertHelper_StorageSizeEnum_Size
     {
         $sizes = $this->getSizesSorted($base);   
@@ -70,13 +70,13 @@ 
         return ConvertHelper_StorageSizeEnum::getSizeByName('b');
     }
     
-   /**
-    * Retrieves all storage sizes for the specified base, 
-    * sorted from smallest byte size to highest.
-    * 
-    * @param int $base
-    * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[]
-    */
+    /**
+     * Retrieves all storage sizes for the specified base, 
+     * sorted from smallest byte size to highest.
+     * 
+     * @param int $base
+     * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[]
+     */
     protected function getSizesSorted(int $base)
     {
         $sizes = ConvertHelper_StorageSizeEnum::getSizesByBase($base);
@@ -89,16 +89,16 @@ 
         return $sizes;
     }
     
-   /**
-    * Converts the byte value to a human readable string, e.g. "5 KB", "140 MB".
-    * 
-    * @param int $precision The amount of decimals (rounded up)
-    * @param int $base The base to calculate bytes with.
-    * @return string
-    * 
-    * @see ConvertHelper_StorageSizeEnum::BASE_10
-    * @see ConvertHelper_StorageSizeEnum::BASE_2
-    */
+    /**
+     * Converts the byte value to a human readable string, e.g. "5 KB", "140 MB".
+     * 
+     * @param int $precision The amount of decimals (rounded up)
+     * @param int $base The base to calculate bytes with.
+     * @return string
+     * 
+     * @see ConvertHelper_StorageSizeEnum::BASE_10
+     * @see ConvertHelper_StorageSizeEnum::BASE_2
+     */
     public function toString(int $precision, int $base=ConvertHelper_StorageSizeEnum::BASE_10) : string
     {
         $size = $this->detectSize($base);
@@ -106,13 +106,13 @@ 
         return round($this->bytes / $size->getBytes(), $precision) . ' ' . $size->getSuffix();
     }
     
-   /**
-    * Converts the byte value to the amount of the corresponding units (KB, MB...).
-    * 
-    * @param int $precision The amount of decimals (rounded up)
-    * @param string $sizeName The lowercase storage size name (e.g. "kb", "kib")
-    * @return float
-    */
+    /**
+     * Converts the byte value to the amount of the corresponding units (KB, MB...).
+     * 
+     * @param int $precision The amount of decimals (rounded up)
+     * @param string $sizeName The lowercase storage size name (e.g. "kb", "kib")
+     * @return float
+     */
     public function toNumber(int $precision, string $sizeName) : float
     {
         $size = ConvertHelper_StorageSizeEnum::getSizeByName($sizeName);
@@ -120,56 +120,56 @@ 
         return round($this->bytes / $size->getBytes(), $precision);
     }
     
-   /**
-    * Converts the bytes to Kilobytes.
-    * 
-    * @param int $precision Amount of decimals (rounded up)
-    * @return float
-    */
+    /**
+     * Converts the bytes to Kilobytes.
+     * 
+     * @param int $precision Amount of decimals (rounded up)
+     * @return float
+     */
     public function toKilobytes(int $precision=1) : float
     {
         return $this->toNumber($precision, 'kb');
     }
     
-   /**
-    * Converts the bytes to Megabytes.
-    *
-    * @param int $precision Amount of decimals (rounded up)
-    * @return float
-    */
+    /**
+     * Converts the bytes to Megabytes.
+     *
+     * @param int $precision Amount of decimals (rounded up)
+     * @return float
+     */
     public function toMegabytes(int $precision=1) : float
     {
         return $this->toNumber($precision, 'mb');
     }
 
-   /**
-    * Converts the bytes to Gigabytes.
-    *
-    * @param int $precision Amount of decimals (rounded up)
-    * @return float
-    */
+    /**
+     * Converts the bytes to Gigabytes.
+     *
+     * @param int $precision Amount of decimals (rounded up)
+     * @return float
+     */
     public function toGigabytes(int $precision=1) : float
     {
         return $this->toNumber($precision, 'gb');
     }
 
-   /**
-    * Converts the bytes to Terabytes.
-    *
-    * @param int $precision Amount of decimals (rounded up)
-    * @return float
-    */
+    /**
+     * Converts the bytes to Terabytes.
+     *
+     * @param int $precision Amount of decimals (rounded up)
+     * @return float
+     */
     public function toTerabytes(int $precision=1) : float
     {
         return $this->toNumber($precision, 'tb');
     }
     
-   /**
-    * Converts the bytes to Petabytes.
-    *
-    * @param int $precision Amount of decimals (rounded up)
-    * @return float
-    */
+    /**
+     * Converts the bytes to Petabytes.
+     *
+     * @param int $precision Amount of decimals (rounded up)
+     * @return float
+     */
     public function toPetabytes(int $precision=1) : float
     {
         return $this->toNumber($precision, 'pb');

src/ConvertHelper/StorageSizeEnum/Size.php

Indentation +18 added lines, -18 removed lines

@@ -25,34 +25,34 @@
  */
 class ConvertHelper_StorageSizeEnum_Size
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $name;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $base;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $exponent;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $singular;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $plural;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $suffix;
     
     public function __construct(string $name, int $base, int $exponent, string $suffix, string $singular, string $plural)

src/VariableInfo/Renderer/String.php

Indentation +3 added lines, -3 removed lines

@@ -6,9 +6,9 @@
 
 abstract class VariableInfo_Renderer_String extends VariableInfo_Renderer
 {
-   /**
-    * @var mixed
-    */
+    /**
+     * @var mixed
+     */
     protected $value;
     
     protected function init()

src/VariableInfo/Renderer.php

Indentation +14 added lines, -14 removed lines

@@ -6,19 +6,19 @@ 
 
 abstract class VariableInfo_Renderer
 {
-   /**
-    * @var mixed
-    */
+    /**
+     * @var mixed
+     */
     protected $value;
     
-   /**
-    * @var VariableInfo
-    */
+    /**
+     * @var VariableInfo
+     */
     protected $info;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type;
     
     public function __construct(VariableInfo $info)
@@ -31,11 +31,11 @@ 
     
     abstract protected function init();
 
-   /**
-    * Renders the value to the target format.
-    * 
-    * @return mixed
-    */
+    /**
+     * Renders the value to the target format.
+     * 
+     * @return mixed
+     */
     public function render()
     {
         return $this->_render();

src/URLInfo/Normalizer.php

Indentation +11 added lines, -11 removed lines

@@ -32,23 +32,23 @@
         $this->info = $info;
     }
     
-   /**
-    * Enables the authentication information in the URL,
-    * if a username and password are present.
-    * 
-    * @param bool $enable Whether to turn it on or off.
-    * @return URLInfo_Normalizer
-    */
+    /**
+     * Enables the authentication information in the URL,
+     * if a username and password are present.
+     * 
+     * @param bool $enable Whether to turn it on or off.
+     * @return URLInfo_Normalizer
+     */
     public function enableAuth(bool $enable=true) : URLInfo_Normalizer
     {
         $this->auth = $enable;
         return $this;
     }
     
-   /**
-    * Retrieves the normalized URL.
-    * @return string
-    */
+    /**
+     * Retrieves the normalized URL.
+     * @return string
+     */
     public function normalize() : string
     {
         $method = 'normalize_'.$this->info->getType();

src/RequestHelper/Boundaries/Boundary.php

Indentation +47 added lines, -47 removed lines

@@ -19,34 +19,34 @@ 
  */
 class RequestHelper_Boundaries_Boundary
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $content;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $dispositionParams = array();
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $contentType = '';
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $contentEncoding = '';
     
-   /**
-    * @var RequestHelper_Boundaries
-    */
+    /**
+     * @var RequestHelper_Boundaries
+     */
     protected $boundaries;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $transferEncoding = '';
     
     public function __construct(RequestHelper_Boundaries $boundaries, string $content)
@@ -60,46 +60,46 @@ 
         return strlen($this->content);
     }
     
-   /**
-    * Sets the name of the request parameter.
-    * 
-    * @param string $name
-    * @return RequestHelper_Boundaries_Boundary
-    */
+    /**
+     * Sets the name of the request parameter.
+     * 
+     * @param string $name
+     * @return RequestHelper_Boundaries_Boundary
+     */
     public function setName(string $name) : RequestHelper_Boundaries_Boundary
     {
         return $this->setDispositionParam('name', $name);
     }
     
-   /**
-    * Sets the filename to use for the content, if applicable.
-    *  
-    * @param string $fileName
-    * @return RequestHelper_Boundaries_Boundary
-    */
+    /**
+     * Sets the filename to use for the content, if applicable.
+     *  
+     * @param string $fileName
+     * @return RequestHelper_Boundaries_Boundary
+     */
     public function setFileName(string $fileName) : RequestHelper_Boundaries_Boundary
     {
         return $this->setDispositionParam('filename', $fileName);
     }
     
-   /**
-    * Sets the content type to use for the content.
-    * 
-    * @param string $contentType
-    * @return RequestHelper_Boundaries_Boundary
-    */
+    /**
+     * Sets the content type to use for the content.
+     * 
+     * @param string $contentType
+     * @return RequestHelper_Boundaries_Boundary
+     */
     public function setContentType(string $contentType) : RequestHelper_Boundaries_Boundary
     {
         $this->contentType = $contentType;
         return $this;
     }
     
-   /**
-    * Sets the encoding to specify for the content.
-    * 
-    * @param string $encoding An encoding string, e.g. "UTF-8", "ASCII"
-    * @return RequestHelper_Boundaries_Boundary
-    */
+    /**
+     * Sets the encoding to specify for the content.
+     * 
+     * @param string $encoding An encoding string, e.g. "UTF-8", "ASCII"
+     * @return RequestHelper_Boundaries_Boundary
+     */
     public function setContentEncoding(string $encoding) : RequestHelper_Boundaries_Boundary
     {
         $this->contentEncoding = $encoding;
@@ -119,11 +119,11 @@ 
         return $this;
     }
     
-   /**
-    * Renders the mime boundary text.
-    * 
-    * @return string
-    */
+    /**
+     * Renders the mime boundary text.
+     * 
+     * @return string
+     */
     public function render()
     {
         $eol = $this->boundaries->getEOL();

docs/libxml/generate-errorcodes.php

Indentation +3 added lines, -3 removed lines

@@ -14,9 +14,9 @@
  * @see http://www.xmlsoft.org/html/libxml-xmlerror.html
  */
 
-   /**
-    * @var string $list
-    */
+    /**
+     * @var string $list
+     */
     $list = file_get_contents('libxmlerrors.txt');
     $outputFile = 'LibXML.php';
     $lines = explode("\n", $list);

src/Request/RefreshParams/Exclude/Name.php

Indentation +3 added lines, -3 removed lines

@@ -19,9 +19,9 @@
  */
 class Request_RefreshParams_Exclude_Name extends Request_RefreshParams_Exclude
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $name;
     
     public function __construct(string $paramName)

src/Request/RefreshParams.php

Indentation +96 added lines, -96 removed lines

@@ -23,14 +23,14 @@ 
 {
     use Traits_Optionable;
     
-   /**
-    * @var array<string,mixed>
-    */
+    /**
+     * @var array<string,mixed>
+     */
     private $overrides = array();
     
-   /**
-    * @var Request_RefreshParams_Exclude[]
-    */
+    /**
+     * @var Request_RefreshParams_Exclude[]
+     */
     private $excludes = array();
     
     public function getDefaultOptions() : array
@@ -41,27 +41,27 @@ 
         );
     }
     
-   /**
-    * Whether to automatically exclude the session variable
-    * from the parameters.
-    * 
-    * @param bool $exclude
-    * @return Request_RefreshParams
-    */
+    /**
+     * Whether to automatically exclude the session variable
+     * from the parameters.
+     * 
+     * @param bool $exclude
+     * @return Request_RefreshParams
+     */
     public function setExcludeSessionName(bool $exclude=true) : Request_RefreshParams
     {
         $this->setOption('exclude-session-name', $exclude);
         return $this;
     }
     
-   /**
-    * Whether to automatically exclude the HTML_QuickForm2
-    * request variable used to track whether a form has been
-    * submitted.
-    * 
-    * @param bool $exclude
-    * @return Request_RefreshParams
-    */
+    /**
+     * Whether to automatically exclude the HTML_QuickForm2
+     * request variable used to track whether a form has been
+     * submitted.
+     * 
+     * @param bool $exclude
+     * @return Request_RefreshParams
+     */
     public function setExcludeQuickform(bool $exclude) : Request_RefreshParams
     {
         $this->setOption('exclude-quickform-submitter', $exclude);
@@ -78,20 +78,20 @@ 
         return $this;
     }
     
-   /**
-    * Exclude a request using a callback function.
-    * 
-    * The function gets two parameters:
-    * 
-    * - The name of the request parameter
-    * - The value of the request parameter
-    * 
-    * If the callback returns a boolean true, the
-    * parameter will be excluded.
-    * 
-    * @param callable $callback
-    * @return Request_RefreshParams
-    */
+    /**
+     * Exclude a request using a callback function.
+     * 
+     * The function gets two parameters:
+     * 
+     * - The name of the request parameter
+     * - The value of the request parameter
+     * 
+     * If the callback returns a boolean true, the
+     * parameter will be excluded.
+     * 
+     * @param callable $callback
+     * @return Request_RefreshParams
+     */
     public function excludeParamByCallback($callback) : Request_RefreshParams
     {
         $this->excludes[] = new Request_RefreshParams_Exclude_Callback($callback);
@@ -99,12 +99,12 @@ 
         return $this;
     }
     
-   /**
-    * Excludes a request parameter by name.
-    * 
-    * @param array $paramNames
-    * @return Request_RefreshParams
-    */
+    /**
+     * Excludes a request parameter by name.
+     * 
+     * @param array $paramNames
+     * @return Request_RefreshParams
+     */
     public function excludeParamsByName(array $paramNames) : Request_RefreshParams
     {
         foreach($paramNames as $name)
@@ -115,15 +115,15 @@ 
         return $this;
     }
     
-   /**
-    * Overrides a parameter: even if it exists, this
-    * value will be used instead - even if it is on 
-    * the list of excluded parameters.
-    * 
-    * @param string $paramName
-    * @param mixed $paramValue
-    * @return Request_RefreshParams
-    */
+    /**
+     * Overrides a parameter: even if it exists, this
+     * value will be used instead - even if it is on 
+     * the list of excluded parameters.
+     * 
+     * @param string $paramName
+     * @param mixed $paramValue
+     * @return Request_RefreshParams
+     */
     public function overrideParam(string $paramName, $paramValue) : Request_RefreshParams
     {
         $this->overrides[$paramName] = $paramValue;
@@ -131,12 +131,12 @@ 
         return $this;
     }
     
-   /**
-    * Overrides an array of parameters. 
-    * 
-    * @param array $params
-    * @return Request_RefreshParams
-    */
+    /**
+     * Overrides an array of parameters. 
+     * 
+     * @param array $params
+     * @return Request_RefreshParams
+     */
     public function overrideParams(array $params) : Request_RefreshParams
     {
         foreach($params as $name => $value)
@@ -147,14 +147,14 @@ 
         return $this;
     }
     
-   /**
-    * Resolves all the parameter exclusions that should
-    * be applied to the list of parameters. This includes
-    * the manually added exclusions and the dynamic exclusions
-    * like the session name.
-    * 
-    * @return Request_RefreshParams_Exclude[]
-    */
+    /**
+     * Resolves all the parameter exclusions that should
+     * be applied to the list of parameters. This includes
+     * the manually added exclusions and the dynamic exclusions
+     * like the session name.
+     * 
+     * @return Request_RefreshParams_Exclude[]
+     */
     private function resolveExcludes() : array
     {
         $excludes = $this->excludes;
@@ -165,12 +165,12 @@ 
         return $excludes;
     }
     
-   /**
-    * Automatically excludes the session name from the
-    * parameters, if present.
-    * 
-    * @param Request_RefreshParams_Exclude[] $excludes
-    */
+    /**
+     * Automatically excludes the session name from the
+     * parameters, if present.
+     * 
+     * @param Request_RefreshParams_Exclude[] $excludes
+     */
     private function autoExcludeSessionName(array &$excludes) : void
     {
         if($this->getBoolOption('exclude-session-name'))
@@ -179,12 +179,12 @@ 
         }
     }
    
-   /**
-    * Automatically excludes the HTML_QuickForm2 submit
-    * tracking variable, when enabled.
-    * 
-    * @param Request_RefreshParams_Exclude[] $excludes
-    */
+    /**
+     * Automatically excludes the HTML_QuickForm2 submit
+     * tracking variable, when enabled.
+     * 
+     * @param Request_RefreshParams_Exclude[] $excludes
+     */
     private function autoExcludeQuickform(array &$excludes) : void
     {
         if($this->getBoolOption('exclude-quickform-submitter'))
@@ -196,12 +196,12 @@ 
         }
     }
     
-   /**
-    * Retrieves the list of parameters matching the 
-    * current settings.
-    * 
-    * @return array<string,mixed>
-    */
+    /**
+     * Retrieves the list of parameters matching the 
+     * current settings.
+     * 
+     * @return array<string,mixed>
+     */
     public function getParams() : array
     {
         $params = $this->removeExcluded($_REQUEST);
@@ -217,12 +217,12 @@ 
         return $params;
     }
     
-   /**
-    * Removes all excluded parameters from the array.
-    * 
-    * @param array<string,mixed> $params
-    * @return array<string,mixed>
-    */
+    /**
+     * Removes all excluded parameters from the array.
+     * 
+     * @param array<string,mixed> $params
+     * @return array<string,mixed>
+     */
     private function removeExcluded(array $params) : array
     {
         $result = array();
@@ -240,14 +240,14 @@ 
         return $result;
     }
     
-   /**
-    * Checks all configured exclusions to see if the 
-    * parameter should be excluded or not.
-    * 
-    * @param string $paramName
-    * @param mixed $paramValue
-    * @return bool
-    */
+    /**
+     * Checks all configured exclusions to see if the 
+     * parameter should be excluded or not.
+     * 
+     * @param string $paramName
+     * @param mixed $paramValue
+     * @return bool
+     */
     public function isExcluded(string $paramName, $paramValue) : bool
     {
         $excludes = $this->resolveExcludes();