Mistralys / application-utils

src/Request/Param/Filter.php

Indentation +3 added lines, -3 removed lines

@@ -24,9 +24,9 @@
 {
     use Traits_Optionable;
     
-   /**
-    * @var RequestParam
-    */
+    /**
+     * @var RequestParam
+     */
     protected $param;
     
     protected $value;

src/Request/Param/Validator.php

Indentation +6 added lines, -6 removed lines

@@ -29,14 +29,14 @@
      */
     protected $param;
     
-   /**
-    * @var mixed
-    */
+    /**
+     * @var mixed
+     */
     protected $value;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $isSubvalue = false;
     
     public function __construct(RequestParam $param, bool $subval)

src/CSVHelper.php

Spacing +18 added lines, -18 removed lines

@@ -170,7 +170,7 @@ 
     
     public function isHeadersPosition($position)
     {
-        if($this->headersPosition === $position) {
+        if ($this->headersPosition === $position) {
             return true;
         }
         
@@ -197,7 +197,7 @@ 
             self::HEADERS_TOP
         );
         
-        if(!in_array($position, $validPositions)) {
+        if (!in_array($position, $validPositions)) {
             throw new CSVHelper_Exception(
                 'Invalid headers position',
                 sprintf(
@@ -253,7 +253,7 @@ 
     */
     public function getRow($index)
     {
-        if(isset($this->data[$index])) {
+        if (isset($this->data[$index])) {
             return $this->data[$index];
         }
         
@@ -320,9 +320,9 @@ 
     public function getColumn($index)
     {
         $data = array();
-        for($i=0; $i < $this->rowCount; $i++) {
+        for ($i = 0; $i < $this->rowCount; $i++) {
             $value = '';
-            if(isset($this->data[$i][$index])) {
+            if (isset($this->data[$i][$index])) {
                 $value = $this->data[$i][$index];
             }
             
@@ -339,7 +339,7 @@ 
     */
     public function columnExists($index)
     {
-        if($index < $this->columnCount) {
+        if ($index < $this->columnCount) {
             return true;
         }
         
@@ -350,7 +350,7 @@ 
     {
         $this->reset();
         
-        if(empty(trim($this->csv))) {
+        if (empty(trim($this->csv))) {
             $this->addError('Tried to parse an empty CSV string.');
             return;
         }
@@ -362,14 +362,14 @@ 
         
         $parser = self::createParser();
 
-        if(!$parser->parse($this->csv)) {
+        if (!$parser->parse($this->csv)) {
             $this->addError('The CSV string could not be parsed.');
             return;
         }
 
         $result = $parser->data;
 
-        switch($this->headersPosition)
+        switch ($this->headersPosition)
         {
             case self::HEADERS_TOP:
                 $this->headers = array_shift($result);
@@ -378,7 +378,7 @@ 
             case self::HEADERS_LEFT:
                 $keep = array();
                 $total = count($result);
-                for($i=0; $i < $total; $i++) {
+                for ($i = 0; $i < $total; $i++) {
                     $row = $result[$i];
                     $this->headers[] = array_shift($row);
                     $keep[] = $row;
@@ -391,9 +391,9 @@ 
         $this->data = $result;
         $this->rowCount = count($this->data);
         
-        for($i=0; $i < $this->rowCount; $i++) {
+        for ($i = 0; $i < $this->rowCount; $i++) {
             $amount = count($this->data[$i]);
-            if($amount > $this->columnCount) {
+            if ($amount > $this->columnCount) {
                 $this->columnCount = $amount;
             }
         }
@@ -437,8 +437,8 @@ 
             ',,' => ','
         );
         
-        foreach($search as $char => $separator) {
-            if(strstr($this->csv, $char)) {
+        foreach ($search as $char => $separator) {
+            if (strstr($this->csv, $char)) {
                 return $separator;
             }
         }
@@ -452,11 +452,11 @@ 
      * @param string $delimiter
      * @return Csv
      */
-    public static function createParser(string $delimiter=self::DELIMITER_AUTO) : Csv
+    public static function createParser(string $delimiter = self::DELIMITER_AUTO) : Csv
     {
         $csv = new Csv();
 
-        if($delimiter !== self::DELIMITER_AUTO) {
+        if ($delimiter !== self::DELIMITER_AUTO) {
             $csv->delimiter = $delimiter;
         }
 
@@ -484,7 +484,7 @@ 
 
         $result = $parser->auto($path);
 
-        if(is_string($result)) {
+        if (is_string($result)) {
             return $parser->data;
         }
 
@@ -517,7 +517,7 @@ 
         $parser = self::createParser();
         $result = $parser->parse($string);
 
-        if($result === true) {
+        if ($result === true) {
             return $parser->data;
         }
 

src/BaseException.php

Indentation +33 added lines, -33 removed lines

@@ -25,12 +25,12 @@ 
 {
     protected ?string $details = null;
     
-   /**
-    * @param string $message
-    * @param string|NULL $details
-    * @param int|NULL $code
-    * @param Throwable|NULL $previous
-    */
+    /**
+     * @param string $message
+     * @param string|NULL $details
+     * @param int|NULL $code
+     * @param Throwable|NULL $previous
+     */
     public function __construct(string $message, ?string $details=null, $code=null, $previous=null)
     {
         if(defined('APP_UTILS_TESTSUITE') && APP_UTILS_TESTSUITE === 'true')
@@ -40,7 +40,7 @@ 
 
         if($code === null)
         {
-             $code = 0;
+                $code = 0;
         }
 
         parent::__construct($message, $code, $previous);
@@ -48,18 +48,18 @@ 
         $this->details = $details;
     }
     
-   /**
-    * Retrieves the detailed error description, if any.
-    * @return string
-    */
+    /**
+     * Retrieves the detailed error description, if any.
+     * @return string
+     */
     public function getDetails() : string
     {
         return $this->details ?? '';
     }
     
-   /**
-    * Displays pertinent information on the exception.
-    */
+    /**
+     * Displays pertinent information on the exception.
+     */
     public function display() : void
     {
         if(!headers_sent()) {
@@ -69,20 +69,20 @@ 
         echo $this->getInfo();
     }
     
-   /**
-    * Retrieves information on the exception that can be
-    * easily accessed.
-    * 
-    * @return ConvertHelper_ThrowableInfo
-    */
+    /**
+     * Retrieves information on the exception that can be
+     * easily accessed.
+     * 
+     * @return ConvertHelper_ThrowableInfo
+     */
     public function getInfo() : ConvertHelper_ThrowableInfo
     {
         return ConvertHelper::throwable2info($this);
     }
     
-   /**
-    * Dumps a current PHP function trace, as a text only string.
-    */
+    /**
+     * Dumps a current PHP function trace, as a text only string.
+     */
     public static function dumpTraceAsString() : void
     {
         try
@@ -95,9 +95,9 @@ 
         }
     }
 
-   /**
-    * Dumps a current PHP function trace, with HTML styling.
-    */
+    /**
+     * Dumps a current PHP function trace, with HTML styling.
+     */
     public static function dumpTraceAsHTML() : void
     {
         try
@@ -112,13 +112,13 @@ 
         }
     }
     
-   /**
-    * Creates an exception info instance from a throwable instance.
-    * 
-    * @param Throwable $e
-    * @return ConvertHelper_ThrowableInfo
-    * @see ConvertHelper::throwable2info()
-    */
+    /**
+     * Creates an exception info instance from a throwable instance.
+     * 
+     * @param Throwable $e
+     * @return ConvertHelper_ThrowableInfo
+     * @see ConvertHelper::throwable2info()
+     */
     public static function createInfo(Throwable $e) : ConvertHelper_ThrowableInfo
     {
         return ConvertHelper::throwable2info($e);

Spacing +6 added lines, -6 removed lines

@@ -31,14 +31,14 @@ 
     * @param int|NULL $code
     * @param Throwable|NULL $previous
     */
-    public function __construct(string $message, ?string $details=null, $code=null, $previous=null)
+    public function __construct(string $message, ?string $details = null, $code = null, $previous = null)
     {
-        if(defined('APP_UTILS_TESTSUITE') && APP_UTILS_TESTSUITE === 'true')
+        if (defined('APP_UTILS_TESTSUITE') && APP_UTILS_TESTSUITE === 'true')
         {
             $message .= PHP_EOL.$details;
         }
 
-        if($code === null)
+        if ($code === null)
         {
              $code = 0;
         }
@@ -62,7 +62,7 @@ 
     */
     public function display() : void
     {
-        if(!headers_sent()) {
+        if (!headers_sent()) {
             header('Content-type:text/plain; charset=utf-8');
         }
         
@@ -89,7 +89,7 @@ 
         {
             throw new BaseException('');
         }
-        catch(BaseException $e) 
+        catch (BaseException $e) 
         {
             echo self::createInfo($e)->toString();
         }
@@ -104,7 +104,7 @@ 
         {
             throw new BaseException('');
         }
-        catch(BaseException $e)
+        catch (BaseException $e)
         {
             echo '<pre style="background:#fff;font-family:monospace;font-size:14px;color:#444;padding:16px;border:solid 1px #999;border-radius:4px;">';
             echo self::createInfo($e)->toString();

src/Request.php

Indentation +108 added lines, -108 removed lines

@@ -56,12 +56,12 @@ 
         $this->init();
     }
     
-   /**
-    * Can be extended in a subclass, to avoid
-    * redefining the constructor.
-    *
-    * @return void
-    */
+    /**
+     * Can be extended in a subclass, to avoid
+     * redefining the constructor.
+     *
+     * @return void
+     */
     protected function init() : void
     {
         
@@ -126,30 +126,30 @@ 
         return $this->buildURL($params, $dispatcher);
     }
     
-   /**
-    * Retrieves the name of the current dispatcher script / page.
-    * This is made to be extended and implemented in a subclass.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the name of the current dispatcher script / page.
+     * This is made to be extended and implemented in a subclass.
+     * 
+     * @return string
+     */
     public function getDispatcher() : string
     {
         return '';
     }
     
-   /**
-    * Filters and retrieves the current request variables 
-    * to be used to build a URL to refresh the current page.
-    * 
-    * For further customization options, use the 
-    * {@see Request::createRefreshParams()} method.
-    * 
-    * @param array<string,mixed> $params Key => value pairs of parameters to always include in the result.
-    * @param string[] $exclude Names of parameters to exclude from the result.
-    * @return array<string,mixed>
-    * 
-    * @see Request::createRefreshParams()
-    */
+    /**
+     * Filters and retrieves the current request variables 
+     * to be used to build a URL to refresh the current page.
+     * 
+     * For further customization options, use the 
+     * {@see Request::createRefreshParams()} method.
+     * 
+     * @param array<string,mixed> $params Key => value pairs of parameters to always include in the result.
+     * @param string[] $exclude Names of parameters to exclude from the result.
+     * @return array<string,mixed>
+     * 
+     * @see Request::createRefreshParams()
+     */
     public function getRefreshParams(array $params = array(), array $exclude = array()) : array
     {
         return $this->createRefreshParams()
@@ -158,13 +158,13 @@ 
             ->getParams();
     }
     
-   /**
-    * Creates an instance of the helper that can be used to
-    * retrieve the request's parameters collection, with the
-    * possibility to exclude and override some by rules.
-    * 
-    * @return Request_RefreshParams
-    */
+    /**
+     * Creates an instance of the helper that can be used to
+     * retrieve the request's parameters collection, with the
+     * possibility to exclude and override some by rules.
+     * 
+     * @return Request_RefreshParams
+     */
     public function createRefreshParams() : Request_RefreshParams
     {
         return new Request_RefreshParams();
@@ -200,10 +200,10 @@ 
         return $url;
     }
     
-   /**
-    * Retrieves the base URL of the application.
-    * @return string
-    */
+    /**
+     * Retrieves the base URL of the application.
+     * @return string
+     */
     public function getBaseURL() : string
     {
         return $this->baseURL;
@@ -233,13 +233,13 @@ 
         return $this->knownParams[$name];
     }
     
-   /**
-    * Retrieves a previously registered parameter instance.
-    * 
-    * @param string $name
-    * @return RequestParam
-    *@throws Request_Exception
-    */
+    /**
+     * Retrieves a previously registered parameter instance.
+     * 
+     * @param string $name
+     * @return RequestParam
+     *@throws Request_Exception
+     */
     public function getRegisteredParam(string $name) : RequestParam
     {
         if(isset($this->knownParams[$name])) {
@@ -256,48 +256,48 @@ 
         );
     }
     
-   /**
-    * Checks whether a parameter with the specified name 
-    * has been registered.
-    * 
-    * @param string $name
-    * @return bool
-    */
+    /**
+     * Checks whether a parameter with the specified name 
+     * has been registered.
+     * 
+     * @param string $name
+     * @return bool
+     */
     public function hasRegisteredParam(string $name) : bool
     {
         return isset($this->knownParams[$name]);
     }
     
-   /**
-    * Retrieves an indexed array with accept mime types
-    * that the client sent, in the order of preference
-    * the client specified.
-    *
-    * Example:
-    *
-    * array(
-    *     'text/html',
-    *     'application/xhtml+xml',
-    *     'image/webp'
-    *     ...
-    * )
-    * 
-    * @return string[]
-    * @see Request::parseAcceptHeaders()
-    */
+    /**
+     * Retrieves an indexed array with accept mime types
+     * that the client sent, in the order of preference
+     * the client specified.
+     *
+     * Example:
+     *
+     * array(
+     *     'text/html',
+     *     'application/xhtml+xml',
+     *     'image/webp'
+     *     ...
+     * )
+     * 
+     * @return string[]
+     * @see Request::parseAcceptHeaders()
+     */
     public static function getAcceptHeaders() : array
     {
         return self::parseAcceptHeaders()->getMimeStrings();
     }
     
-   /**
-    * Returns an instance of the "accept" headers parser,
-    * to access information on the browser's accepted
-    * mime types.
-    *  
-    * @return Request_AcceptHeaders
-    * @see Request::getAcceptHeaders()
-    */
+    /**
+     * Returns an instance of the "accept" headers parser,
+     * to access information on the browser's accepted
+     * mime types.
+     *  
+     * @return Request_AcceptHeaders
+     * @see Request::getAcceptHeaders()
+     */
     public static function parseAcceptHeaders() : Request_AcceptHeaders
     {
         static $accept;
@@ -341,14 +341,14 @@ 
         return $this->getParam($name) !== null;
     }
     
-   /**
-    * Removes a single parameter from the request.
-    * If the parameter has been registered, also
-    * removes the registration info.
-    * 
-    * @param string $name
-    * @return Request
-    */
+    /**
+     * Removes a single parameter from the request.
+     * If the parameter has been registered, also
+     * removes the registration info.
+     * 
+     * @param string $name
+     * @return Request
+     */
     public function removeParam(string $name) : Request
     {
         if(isset($_REQUEST[$name])) {
@@ -362,12 +362,12 @@ 
         return $this;
     }
     
-   /**
-    * Removes several parameters from the request.
-    * 
-    * @param string[] $names
-    * @return Request
-    */
+    /**
+     * Removes several parameters from the request.
+     * 
+     * @param string[] $names
+     * @return Request
+     */
     public function removeParams(array $names) : Request
     {
         foreach($names as $name) {
@@ -563,11 +563,11 @@ 
         exit;
     }
     
-   /**
-    * Sends HTML to the browser with the correct headers.
-    * 
-    * @param string $html
-    */
+    /**
+     * Sends HTML to the browser with the correct headers.
+     * 
+     * @param string $html
+     */
     public static function sendHTML(string $html) : void
     {
         header('Cache-Control: no-cache, must-revalidate');
@@ -588,16 +588,16 @@ 
         exit;
     }
     
-   /**
-    * Creates a new instance of the URL comparer, which can check 
-    * whether the specified URLs match, regardless of the order in 
-    * which the query parameters are, if any.
-    * 
-    * @param string $sourceURL
-    * @param string $targetURL
-    * @param string[] $limitParams Whether to limit the comparison to these specific parameter names (if present)
-    * @return Request_URLComparer
-    */
+    /**
+     * Creates a new instance of the URL comparer, which can check 
+     * whether the specified URLs match, regardless of the order in 
+     * which the query parameters are, if any.
+     * 
+     * @param string $sourceURL
+     * @param string $targetURL
+     * @param string[] $limitParams Whether to limit the comparison to these specific parameter names (if present)
+     * @return Request_URLComparer
+     */
     public function createURLComparer(string $sourceURL, string $targetURL, array $limitParams=array()) : Request_URLComparer
     {
         $comparer = new Request_URLComparer($this, $sourceURL, $targetURL);
@@ -606,10 +606,10 @@ 
         return $comparer;
     }
     
-   /**
-    * Retrieves the full URL that was used to access the current page.
-    * @return string
-    */
+    /**
+     * Retrieves the full URL that was used to access the current page.
+     * @return string
+     */
     public function getCurrentURL() : string
     {
         return $_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI'];

Spacing +29 added lines, -29 removed lines

@@ -91,7 +91,7 @@ 
     {
         $value = $_REQUEST[$name] ?? $default;
 
-        if(isset($this->knownParams[$name])) {
+        if (isset($this->knownParams[$name])) {
             $value = $this->knownParams[$name]->validate($value);
         }
         
@@ -188,13 +188,13 @@ 
      * @param string $dispatcher Relative path to script to use for the URL. Append trailing slash if needed.
      * @return string
      */
-    public function buildURL(array $params = array(), string $dispatcher='') : string
+    public function buildURL(array $params = array(), string $dispatcher = '') : string
     {
-        $url = rtrim($this->getBaseURL(), '/') . '/' . $dispatcher;
+        $url = rtrim($this->getBaseURL(), '/').'/'.$dispatcher;
         
         // append any leftover parameters to the end of the URL
         if (!empty($params)) {
-            $url .= '?' . http_build_query($params, '', '&');
+            $url .= '?'.http_build_query($params, '', '&');
         }
         
         return $url;
@@ -225,7 +225,7 @@ 
      */
     public function registerParam(string $name) : RequestParam
     {
-        if(!isset($this->knownParams[$name])) {
+        if (!isset($this->knownParams[$name])) {
             $param = new RequestParam($this, $name);
             $this->knownParams[$name] = $param;
         }
@@ -242,7 +242,7 @@ 
     */
     public function getRegisteredParam(string $name) : RequestParam
     {
-        if(isset($this->knownParams[$name])) {
+        if (isset($this->knownParams[$name])) {
             return $this->knownParams[$name];
         }
         
@@ -302,7 +302,7 @@ 
     {
         static $accept;
         
-        if(!isset($accept)) {
+        if (!isset($accept)) {
             $accept = new Request_AcceptHeaders();
         }
         
@@ -321,7 +321,7 @@ 
     {
         $_REQUEST[$name] = $value;
         
-        if(isset($this->knownParams[$name])) {
+        if (isset($this->knownParams[$name])) {
             unset($this->knownParams[$name]);
         }
         
@@ -351,11 +351,11 @@ 
     */
     public function removeParam(string $name) : Request
     {
-        if(isset($_REQUEST[$name])) {
+        if (isset($_REQUEST[$name])) {
             unset($_REQUEST[$name]);
         }
         
-        if(isset($this->knownParams[$name])) {
+        if (isset($this->knownParams[$name])) {
             unset($this->knownParams[$name]);
         }
         
@@ -370,7 +370,7 @@ 
     */
     public function removeParams(array $names) : Request
     {
-        foreach($names as $name) {
+        foreach ($names as $name) {
             $this->removeParam($name);
         }
         
@@ -388,11 +388,11 @@ 
      * @return bool
      * @throws ConvertHelper_Exception
      */
-    public function getBool(string $name, bool $default=false) : bool
+    public function getBool(string $name, bool $default = false) : bool
     {
         $value = $this->getParam($name, $default);
 
-        if(ConvertHelper::isBoolean($value)) {
+        if (ConvertHelper::isBoolean($value)) {
             return ConvertHelper::string2bool($value);
         }
         
@@ -401,11 +401,11 @@ 
     
     public function validate() : void
     {
-        foreach($this->knownParams as $param) 
+        foreach ($this->knownParams as $param) 
         {
             $name = $param->getName();
             
-            if($param->isRequired() && !$this->hasParam($name)) 
+            if ($param->isRequired() && !$this->hasParam($name)) 
             {
                 throw new Request_Exception(
                     'Missing request parameter '.$name,
@@ -427,26 +427,26 @@ 
      * @param mixed $default
      * @return mixed
      */
-    public function getFilteredParam(string $name, $default=null)
+    public function getFilteredParam(string $name, $default = null)
     {
         $val = $this->getParam($name, $default);
 
-        if(is_string($val))
+        if (is_string($val))
         {
             return htmlspecialchars(trim(strip_tags($val)), ENT_QUOTES, 'UTF-8');
         }
 
-        if(is_bool($val))
+        if (is_bool($val))
         {
             return ConvertHelper::boolStrict2string($val);
         }
 
-        if(is_numeric($val))
+        if (is_numeric($val))
         {
             return (string)$val;
         }
 
-        if(is_null($val))
+        if (is_null($val))
         {
             return '';
         }
@@ -466,11 +466,11 @@ 
      * @see Request::getJSONObject()
      * @see Request::getJSONAssoc()
      */
-    public function getJSON(string $name, bool $assoc=true)
+    public function getJSON(string $name, bool $assoc = true)
     {
         $value = $this->getParam($name);
         
-        if(!empty($value) && is_string($value)) 
+        if (!empty($value) && is_string($value)) 
         {
             try
             {
@@ -481,16 +481,16 @@ 
                 return array();
             }
             
-            if($assoc && is_array($data)) {
+            if ($assoc && is_array($data)) {
                 return $data;
             }
             
-            if(is_object($data)) {
+            if (is_object($data)) {
                 return $data;
             }
         }
         
-        if($assoc) {
+        if ($assoc) {
             return array();
         }
         
@@ -507,7 +507,7 @@ 
     public function getJSONAssoc(string $name) : array
     {
         $result = $this->getJSON($name);
-        if(is_array($result)) {
+        if (is_array($result)) {
             return $result;
         }
         
@@ -524,7 +524,7 @@ 
     public function getJSONObject(string $name) : object
     {
         $result = $this->getJSON($name, false);
-        if(is_object($result)) {
+        if (is_object($result)) {
             return $result;
         }
         
@@ -541,7 +541,7 @@ 
     {
         $payload = $data;
 
-        if(!is_string($payload)) {
+        if (!is_string($payload)) {
             $payload = json_encode($payload, JSON_THROW_ON_ERROR);
         }
         
@@ -598,7 +598,7 @@ 
     * @param string[] $limitParams Whether to limit the comparison to these specific parameter names (if present)
     * @return Request_URLComparer
     */
-    public function createURLComparer(string $sourceURL, string $targetURL, array $limitParams=array()) : Request_URLComparer
+    public function createURLComparer(string $sourceURL, string $targetURL, array $limitParams = array()) : Request_URLComparer
     {
         $comparer = new Request_URLComparer($this, $sourceURL, $targetURL);
         $comparer->addLimitParams($limitParams);

Braces +1 added lines, -2 removed lines

@@ -475,8 +475,7 @@
             try
             {
                 $data = json_decode($value, $assoc, 512, JSON_THROW_ON_ERROR);
-            }
-            catch (JsonException $e)
+            } catch (JsonException $e)
             {
                 return array();
             }