Mistralys / application-utils

src/Interfaces/Optionable.php

Spacing +4 added lines, -4 removed lines

@@ -45,7 +45,7 @@ 
      * @param mixed $default The default value to return if the option does not exist.
      * @return mixed
      */
-    public function getOption(string $name, $default=null);
+    public function getOption(string $name, $default = null);
 
     /**
      * @param string $name
@@ -53,11 +53,11 @@ 
      */
     public function getArrayOption(string $name) : array;
 
-    public function getIntOption(string $name, int $default=0) : int;
+    public function getIntOption(string $name, int $default = 0) : int;
 
-    public function getBoolOption(string $name, bool $default=false) : bool;
+    public function getBoolOption(string $name, bool $default = false) : bool;
 
-    public function getStringOption(string $name, string $default='') : string;
+    public function getStringOption(string $name, string $default = '') : string;
 
     /**
      * Sets a collection of options at once, from an

src/Request/URLComparer.php

Indentation +24 added lines, -24 removed lines

@@ -23,44 +23,44 @@
  */
 class Request_URLComparer
 {
-   /**
-    * @var Request
-    */
+    /**
+     * @var Request
+     */
     protected Request $request;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $sourceURL;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $targetURL;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected array $limitParams = array();
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected bool $isMatch = false;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected bool $ignoreFragment = true;
 
-   /**
-    * @var URLInfo
-    */
+    /**
+     * @var URLInfo
+     */
     protected URLInfo $sourceInfo;
     
-   /**
-    * @var URLInfo
-    */
+    /**
+     * @var URLInfo
+     */
     protected URLInfo $targetInfo;
     
     public function __construct(Request $request, string $sourceURL, string $targetURL)

Spacing +12 added lines, -12 removed lines

@@ -81,7 +81,7 @@ 
     
     public function addLimitParam(string $name) : Request_URLComparer
     {
-        if(!in_array($name, $this->limitParams, true))
+        if (!in_array($name, $this->limitParams, true))
         {
             $this->limitParams[] = $name;
         }
@@ -95,7 +95,7 @@ 
      */
     public function addLimitParams(array $names) : Request_URLComparer
     {
-        foreach($names as $name)
+        foreach ($names as $name)
         {
             $this->addLimitParam($name);
         }
@@ -103,7 +103,7 @@ 
         return $this;
     }
     
-    public function setIgnoreFragment(bool $ignore=true) : Request_URLComparer
+    public function setIgnoreFragment(bool $ignore = true) : Request_URLComparer
     {
         $this->ignoreFragment = $ignore;
         return $this;
@@ -126,13 +126,13 @@ 
             'query' 
         );
         
-        if(!$this->ignoreFragment) {
+        if (!$this->ignoreFragment) {
             $keys[] = 'fragment';
         }
         
-        foreach($keys as $key)
+        foreach ($keys as $key)
         {
-            if(!$this->compareKey($key)) {
+            if (!$this->compareKey($key)) {
                 return false;
             }
         }
@@ -147,7 +147,7 @@ 
         
         $filter = 'filter_'.$key;
         
-        if(method_exists($this, $filter)) 
+        if (method_exists($this, $filter)) 
         {
             $sVal = $this->$filter($sVal);
             $tVal = $this->$filter($tVal);
@@ -159,7 +159,7 @@ 
     protected function filter_path(string $path) : string
     {
         // fix double slashes in URLs
-        while(strpos($path, '//') !== false)
+        while (strpos($path, '//') !== false)
         {
             $path = str_replace('//', '/', $path);
         }
@@ -169,7 +169,7 @@ 
     
     protected function filter_query(string $query) : string
     {
-        if(empty($query)) {
+        if (empty($query)) {
             return '';
         }
         
@@ -188,15 +188,15 @@ 
      */
     protected function limitParams(array $params) : array
     {
-        if(empty($this->limitParams)) {
+        if (empty($this->limitParams)) {
             return $params;
         }
         
         $keep = array();
         
-        foreach($this->limitParams as $name)
+        foreach ($this->limitParams as $name)
         {
-            if(isset($params[$name])) {
+            if (isset($params[$name])) {
                 $keep[$name] = $params[$name];
             }
         }

src/Traits/RenderableTrait.php

Braces +1 added lines, -2 removed lines

@@ -35,8 +35,7 @@
         try
         {
             return $this->render();
-        }
-        catch (Throwable $e)
+        } catch (Throwable $e)
         {
             return sprintf(
                 'Exception while rendering [%s]: %s',

src/Traits/RenderableBufferedTrait.php

Braces +1 added lines, -2 removed lines

@@ -35,8 +35,7 @@
         try
         {
             return $this->render();
-        }
-        catch (Throwable $e)
+        } catch (Throwable $e)
         {
             return sprintf(
                 'Exception while rendering [%s]: %s',

src/FileHelper/UploadFileSizeInfo.php

Spacing +1 added lines, -1 removed lines

@@ -51,7 +51,7 @@
         $unit = preg_replace('/[^bkmgtpezy]/i', '', $size); // Remove the non-unit characters from the size.
         $result = (float)preg_replace('/[^0-9\.]/', '', $size); // Remove the non-numeric characters from the size.
 
-        if($unit)
+        if ($unit)
         {
             // Find the position of the unit in the ordered string which is the power of magnitude to multiply a kilobyte by.
             return (int)round($result * (1024 ** stripos('bkmgtpezy', $unit[0])));

src/FileHelper/PathRelativizer.php

Spacing +6 added lines, -6 removed lines

@@ -18,7 +18,7 @@ 
      * @param int $depth The folder depth to reduce the path to
      * @return string
      */
-    public static function relativizeByDepth(string $path, int $depth=2) : string
+    public static function relativizeByDepth(string $path, int $depth = 2) : string
     {
         $path = FileHelper::normalizePath($path);
 
@@ -26,17 +26,17 @@ 
         $tokens = array_filter($tokens); // remove empty entries (trailing slash for example)
         $tokens = array_values($tokens); // re-index keys
 
-        if(empty($tokens)) {
+        if (empty($tokens)) {
             return '';
         }
 
         // remove the drive if present
-        if(strpos($tokens[0], ':') !== false) {
+        if (strpos($tokens[0], ':') !== false) {
             array_shift($tokens);
         }
 
         // path was only the drive
-        if(count($tokens) === 0) {
+        if (count($tokens) === 0) {
             return '';
         }
 
@@ -45,8 +45,8 @@ 
 
         // reduce the path to the specified depth
         $length = count($tokens);
-        if($length > $depth) {
-            $tokens = array_slice($tokens, $length-$depth);
+        if ($length > $depth) {
+            $tokens = array_slice($tokens, $length - $depth);
         }
 
         // append the last element again

src/FileHelper/FileFinder.php

Spacing +16 added lines, -16 removed lines

@@ -7,7 +7,7 @@ 
  * @see \AppUtils\FileHelper\FileFinder
  */
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace AppUtils\FileHelper;
 
@@ -90,7 +90,7 @@ 
      * @param bool $enabled
      * @return FileFinder
      */
-    public function makeRecursive(bool $enabled=true) : FileFinder
+    public function makeRecursive(bool $enabled = true) : FileFinder
     {
         return $this->setOption('recursive', $enabled);
     }
@@ -295,22 +295,22 @@ 
         return $this->getAll();
     }
     
-    protected function find(string $path, bool $isRoot=false) : void
+    protected function find(string $path, bool $isRoot = false) : void
     {
-        if($isRoot) {
+        if ($isRoot) {
             $this->found = array();
         }
         
         $recursive = $this->getBoolOption('recursive');
         
         $d = new DirectoryIterator($path);
-        foreach($d as $item)
+        foreach ($d as $item)
         {
             $pathname = $item->getPathname();
             
-            if($item->isDir())
+            if ($item->isDir())
             {
-                if($recursive && !$item->isDot()) {
+                if ($recursive && !$item->isDot()) {
                     $this->find($pathname);
                 }
                 
@@ -319,7 +319,7 @@ 
             
             $file = $this->filterFile($pathname);
             
-            if($file !== null) 
+            if ($file !== null) 
             {
                 $this->found[] = $file;
             }
@@ -332,23 +332,23 @@ 
         
         $extension = FileHelper::getExtension($path);
         
-        if(!$this->filterExclusion($extension)) {
+        if (!$this->filterExclusion($extension)) {
             return null;
         }
         
         $path = $this->filterPath($path);
         
-        if($this->getOption('strip-extensions') === true)
+        if ($this->getOption('strip-extensions') === true)
         {
             $path = str_replace('.'.$extension, '', $path);
         }
         
-        if($path === '') {
+        if ($path === '') {
             return null;
         }
         
         $replace = $this->getOption('slash-replacement');
-        if(!empty($replace)) {
+        if (!empty($replace)) {
             $path = str_replace('/', $replace, $path);
         }
         
@@ -367,13 +367,13 @@ 
         $include = $this->getOption(self::OPTION_INCLUDE_EXTENSIONS);
         $exclude = $this->getOption(self::OPTION_EXCLUDE_EXTENSIONS);
         
-        if(!empty($include))
+        if (!empty($include))
         {
-            if(!in_array($extension, $include, true)) {
+            if (!in_array($extension, $include, true)) {
                 return false;
             }
         }
-        else if(!empty($exclude) && in_array($extension, $exclude, true))
+        else if (!empty($exclude) && in_array($extension, $exclude, true))
         {
             return false;
         }
@@ -389,7 +389,7 @@ 
     */
     protected function filterPath(string $path) : string
     {
-        switch($this->getStringOption(self::OPTION_PATHMODE))
+        switch ($this->getStringOption(self::OPTION_PATHMODE))
         {
             case self::PATH_MODE_STRIP:
                 return basename($path);

Braces +1 added lines, -2 removed lines

@@ -372,8 +372,7 @@
             if(!in_array($extension, $include, true)) {
                 return false;
             }
-        }
-        else if(!empty($exclude) && in_array($extension, $exclude, true))
+        } else if(!empty($exclude) && in_array($extension, $exclude, true))
         {
             return false;
         }

Indentation +130 added lines, -130 removed lines

@@ -44,20 +44,20 @@ 
 
     protected FolderInfo $path;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected array $found = array();
     
-   /**
-    * The path must exist when the class is instantiated: its
-    * real path will be determined to work with.
-    * 
-    * @param string|PathInfoInterface|SplFileInfo $path The absolute path to the target folder.
-    *
-    * @throws FileHelper_Exception
-    * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER
-    */
+    /**
+     * The path must exist when the class is instantiated: its
+     * real path will be determined to work with.
+     * 
+     * @param string|PathInfoInterface|SplFileInfo $path The absolute path to the target folder.
+     *
+     * @throws FileHelper_Exception
+     * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER
+     */
     public function __construct($path)
     {
         $this->path = AbstractPathInfo::resolveType($path)->requireExists()->requireIsFolder();
@@ -75,11 +75,11 @@ 
         );
     }
     
-   /**
-    * Enables extension stripping, to return file names without extension.
-    * 
-    * @return FileFinder
-    */
+    /**
+     * Enables extension stripping, to return file names without extension.
+     * 
+     * @return FileFinder
+     */
     public function stripExtensions() : FileFinder
     {
         return $this->setOption('strip-extensions', true);
@@ -96,46 +96,46 @@ 
         return $this->setOption('recursive', $enabled);
     }
     
-   /**
-    * Retrieves all extensions that were added to
-    * the list of included extensions.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves all extensions that were added to
+     * the list of included extensions.
+     * 
+     * @return string[]
+     */
     public function getIncludeExtensions() : array
     {
         return $this->getArrayOption(self::OPTION_INCLUDE_EXTENSIONS);
     }
     
-   /**
-    * Includes a single extension in the file search: only
-    * files with this extension will be used in the results.
-    * 
-    * NOTE: Included extensions take precedence before excluded
-    * extensions. If any excluded extensions are specified, they
-    * will be ignored.
-    * 
-    * @param string $extension Extension name, without dot (`php` for example).
-    * @return FileFinder
-    * @see FileFinder::includeExtensions()
-    */
+    /**
+     * Includes a single extension in the file search: only
+     * files with this extension will be used in the results.
+     * 
+     * NOTE: Included extensions take precedence before excluded
+     * extensions. If any excluded extensions are specified, they
+     * will be ignored.
+     * 
+     * @param string $extension Extension name, without dot (`php` for example).
+     * @return FileFinder
+     * @see FileFinder::includeExtensions()
+     */
     public function includeExtension(string $extension) : FileFinder
     {
         return $this->includeExtensions(array($extension));
     }
     
-   /**
-    * Includes several extensions in the file search: only
-    * files with these extensions wil be used in the results.
-    * 
-    * NOTE: Included extensions take precedence before excluded
-    * extensions. If any excluded extensions are specified, they
-    * will be ignored.
-    * 
-    * @param string[] $extensions Extension names, without dot (`php` for example).
-    * @return FileFinder
-    * @see FileFinder::includeExtension()
-    */
+    /**
+     * Includes several extensions in the file search: only
+     * files with these extensions wil be used in the results.
+     * 
+     * NOTE: Included extensions take precedence before excluded
+     * extensions. If any excluded extensions are specified, they
+     * will be ignored.
+     * 
+     * @param string[] $extensions Extension names, without dot (`php` for example).
+     * @return FileFinder
+     * @see FileFinder::includeExtension()
+     */
     public function includeExtensions(array $extensions) : FileFinder
     {
         $items = $this->getIncludeExtensions();
@@ -146,37 +146,37 @@ 
         return $this;
     }
 
-   /**
-    * Retrieves a list of all extensions currently set as 
-    * excluded from the search.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all extensions currently set as 
+     * excluded from the search.
+     * 
+     * @return string[]
+     */
     public function getExcludeExtensions() : array
     {
         return $this->getArrayOption(self::OPTION_EXCLUDE_EXTENSIONS);
     }
     
-   /**
-    * Excludes a single extension from the search.
-    * 
-    * @param string $extension Extension name, without dot (`php` for example).
-    * @return FileFinder
-    * @see FileFinder::excludeExtensions()
-    */
+    /**
+     * Excludes a single extension from the search.
+     * 
+     * @param string $extension Extension name, without dot (`php` for example).
+     * @return FileFinder
+     * @see FileFinder::excludeExtensions()
+     */
     public function excludeExtension(string $extension) : FileFinder
     {
         return $this->excludeExtensions(array($extension));
     }
 
-   /**
-    * Add several extensions to the list of extensions to
-    * exclude from the file search.
-    *  
-    * @param string[] $extensions Extension names, without dot (`php` for example).
-    * @return FileFinder
-    * @see FileFinder::excludeExtension()
-    */
+    /**
+     * Add several extensions to the list of extensions to
+     * exclude from the file search.
+     *  
+     * @param string[] $extensions Extension names, without dot (`php` for example).
+     * @return FileFinder
+     * @see FileFinder::excludeExtension()
+     */
     public function excludeExtensions(array $extensions) : FileFinder
     {
         $items = $this->getExcludeExtensions();
@@ -187,52 +187,52 @@ 
         return $this;
     }
     
-   /**
-    * In this mode, the entire path to the file will be stripped,
-    * leaving only the file name in the files list.
-    * 
-    * @return FileFinder
-    */
+    /**
+     * In this mode, the entire path to the file will be stripped,
+     * leaving only the file name in the files list.
+     * 
+     * @return FileFinder
+     */
     public function setPathmodeStrip() : FileFinder
     {
         return $this->setPathmode(self::PATH_MODE_STRIP);
     }
     
-   /**
-    * In this mode, only the path relative to the source folder
-    * will be included in the files list.
-    * 
-    * @return FileFinder
-    */
+    /**
+     * In this mode, only the path relative to the source folder
+     * will be included in the files list.
+     * 
+     * @return FileFinder
+     */
     public function setPathmodeRelative() : FileFinder
     {
         return $this->setPathmode(self::PATH_MODE_RELATIVE);
     }
     
-   /**
-    * In this mode, the full, absolute paths to the files will
-    * be included in the files list.
-    * 
-    * @return FileFinder
-    */
+    /**
+     * In this mode, the full, absolute paths to the files will
+     * be included in the files list.
+     * 
+     * @return FileFinder
+     */
     public function setPathmodeAbsolute() : FileFinder
     {
         return $this->setPathmode(self::PATH_MODE_ABSOLUTE);
     }
     
-   /**
-    * This sets a character or string to replace the slashes
-    * in the paths with. 
-    * 
-    * This is used for example in the `getPHPClassNames()` 
-    * method, to return files from subfolders as class names
-    * using the "_" character:
-    * 
-    * Subfolder/To/File.php => Subfolder_To_File.php
-    * 
-    * @param string $character
-    * @return FileFinder
-    */
+    /**
+     * This sets a character or string to replace the slashes
+     * in the paths with. 
+     * 
+     * This is used for example in the `getPHPClassNames()` 
+     * method, to return files from subfolders as class names
+     * using the "_" character:
+     * 
+     * Subfolder/To/File.php => Subfolder_To_File.php
+     * 
+     * @param string $character
+     * @return FileFinder
+     */
     public function setSlashReplacement(string $character) : FileFinder
     {
         return $this->setOption('slash-replacement', $character);
@@ -255,12 +255,12 @@ 
         return $this->setOption(self::OPTION_PATHMODE, $mode);
     }
     
-   /**
-    * Retrieves a list of all matching file names/paths,
-    * depending on the selected options.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all matching file names/paths,
+     * depending on the selected options.
+     * 
+     * @return string[]
+     */
     public function getAll() : array
     {
         $this->find((string)$this->path, true);
@@ -268,24 +268,24 @@ 
         return $this->found;
     }
     
-   /**
-    * Retrieves only PHP files. Can be combined with other
-    * options like enabling recursion into sub-folders.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves only PHP files. Can be combined with other
+     * options like enabling recursion into sub-folders.
+     * 
+     * @return string[]
+     */
     public function getPHPFiles() : array
     {
         $this->includeExtensions(array('php'));
         return $this->getAll();
     }
     
-   /**
-    * Generates PHP class names from file paths: it replaces
-    * slashes with underscores, and removes file extensions.
-    * 
-    * @return string[] An array of PHP file names without extension.
-    */
+    /**
+     * Generates PHP class names from file paths: it replaces
+     * slashes with underscores, and removes file extensions.
+     * 
+     * @return string[] An array of PHP file names without extension.
+     */
     public function getPHPClassNames() : array
     {
         $this->includeExtensions(array('php'));
@@ -356,13 +356,13 @@ 
         return $path;
     }
     
-   /**
-    * Checks whether the specified extension is allowed 
-    * with the current settings.
-    * 
-    * @param string $extension
-    * @return bool
-    */
+    /**
+     * Checks whether the specified extension is allowed 
+     * with the current settings.
+     * 
+     * @param string $extension
+     * @return bool
+     */
     protected function filterExclusion(string $extension) : bool
     {
         $include = $this->getOption(self::OPTION_INCLUDE_EXTENSIONS);
@@ -382,12 +382,12 @@ 
         return true;
     }
     
-   /**
-    * Adjusts the path according to the selected path mode.
-    * 
-    * @param string $path
-    * @return string
-    */
+    /**
+     * Adjusts the path according to the selected path mode.
+     * 
+     * @param string $path
+     * @return string
+     */
     protected function filterPath(string $path) : string
     {
         switch($this->getStringOption(self::OPTION_PATHMODE))

src/Request/RequestParam.php

Indentation +119 added lines, -119 removed lines

@@ -177,12 +177,12 @@ 
         return $this->applyValidations($value);
     }
     
-   /**
-    * Runs the value through all validations that were added.
-    * 
-    * @param mixed $value
-    * @return mixed
-    */
+    /**
+     * Runs the value through all validations that were added.
+     * 
+     * @param mixed $value
+     * @return mixed
+     */
     protected function applyValidations($value, bool $subval=false)
     {
         // go through all enqueued validations in turn, each time
@@ -195,17 +195,17 @@ 
         return $value;
     }
     
-   /**
-    * Validates the specified value using the validation type. Returns
-    * the validated value. 
-    * 
-    * @param mixed $value
-    * @param string $type
-    * @param array<string,mixed> $params
-    * @param bool $subval Whether this is a subvalue in a list
-    * @throws Request_Exception
-    * @return mixed
-    */
+    /**
+     * Validates the specified value using the validation type. Returns
+     * the validated value. 
+     * 
+     * @param mixed $value
+     * @param string $type
+     * @param array<string,mixed> $params
+     * @param bool $subval Whether this is a subvalue in a list
+     * @throws Request_Exception
+     * @return mixed
+     */
     protected function validateType($value, string $type, array $params, bool $subval)
     {
         $class = Request_Param_Validator::class.'_'.ucfirst($type);
@@ -270,13 +270,13 @@ 
         return $this->setValidation(self::VALIDATION_TYPE_URL);
     }
     
-   /**
-    * Sets the variable to contain a comma-separated list of integer IDs.
-    * Example: <code>145,248,4556</code>. A single ID is also allowed, e.g.
-    * <code>145</code>.
-    * 
-    * @return $this
-    */
+    /**
+     * Sets the variable to contain a comma-separated list of integer IDs.
+     * Example: <code>145,248,4556</code>. A single ID is also allowed, e.g.
+     * <code>145</code>.
+     * 
+     * @return $this
+     */
     public function setIDList() : self
     {
         $this->valueType = self::VALUE_TYPE_LIST;
@@ -286,13 +286,13 @@ 
         return $this;
     }
     
-   /**
-    * Sets the variable to be an alias, as defined by the
-    * {@link RegexHelper::REGEX_ALIAS} regular expression.
-    * 
-    * @return $this
-    * @see RegexHelper::REGEX_ALIAS
-    */
+    /**
+     * Sets the variable to be an alias, as defined by the
+     * {@link RegexHelper::REGEX_ALIAS} regular expression.
+     * 
+     * @return $this
+     * @see RegexHelper::REGEX_ALIAS
+     */
     public function setAlias() : self
     {
         return $this->setRegex(RegexHelper::REGEX_ALIAS);
@@ -333,12 +333,12 @@ 
         return $this->setValidation(self::VALIDATION_TYPE_ALPHA);
     }
     
-   /**
-    * Sets the parameter value as a string containing lowercase
-    * and/or uppercase letters, as well as numbers.
-    * 
-    * @return $this
-    */
+    /**
+     * Sets the parameter value as a string containing lowercase
+     * and/or uppercase letters, as well as numbers.
+     * 
+     * @return $this
+     */
     public function setAlnum() : self
     {
         return $this->setValidation(self::VALIDATION_TYPE_ALNUM);   
@@ -396,11 +396,11 @@ 
         );
     }
     
-   /**
-    * Whether the parameter is a list of values.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the parameter is a list of values.
+     * 
+     * @return bool
+     */
     public function isList() : bool
     {
         return $this->valueType === self::VALUE_TYPE_LIST;
@@ -442,28 +442,28 @@ 
         return $this->setValidation(self::VALIDATION_TYPE_JSON, array('arrays' => false));
     }
     
-   /**
-    * The parameter is a string boolean representation. This means
-    * it can be any of the following: "yes", "true", "no", "false".
-    * The value is automatically converted to a boolean when retrieving
-    * the parameter.
-    * 
-    * @return $this
-    */
+    /**
+     * The parameter is a string boolean representation. This means
+     * it can be any of the following: "yes", "true", "no", "false".
+     * The value is automatically converted to a boolean when retrieving
+     * the parameter.
+     * 
+     * @return $this
+     */
     public function setBoolean() : self
     {
         return $this->addClassFilter('Boolean');
     }
     
-   /**
-    * Validates the request parameter as an MD5 string,
-    * so that only values resembling md5 values are accepted.
-    * 
-    * NOTE: This can only guarantee the format, not whether
-    * it is an actual valid hash of something.
-    * 
-    * @return $this
-    */
+    /**
+     * Validates the request parameter as an MD5 string,
+     * so that only values resembling md5 values are accepted.
+     * 
+     * NOTE: This can only guarantee the format, not whether
+     * it is an actual valid hash of something.
+     * 
+     * @return $this
+     */
     public function setMD5() : self
     {
         return $this->setRegex(RegexHelper::REGEX_MD5);
@@ -503,14 +503,14 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves the value of the request parameter,
-    * applying all filters (if any) and validation
-    * (if any).
-    * 
-    * @param mixed $default
-    * @return mixed
-    */
+    /**
+     * Retrieves the value of the request parameter,
+     * applying all filters (if any) and validation
+     * (if any).
+     * 
+     * @param mixed $default
+     * @return mixed
+     */
     public function get($default=null)
     {
         $value = $this->request->getParam($this->paramName);
@@ -523,17 +523,17 @@ 
 
     // region: Filtering
 
-   /**
-    * Filters the specified value by going through all available
-    * filters, if any. If none have been set, the value is simply
-    * passed through.
-    *
-    * @param mixed $value
-    * @return mixed
-    *
-    * @see RequestParam::applyFilter_callback()
-    * @see RequestParam::applyFilter_class()
-    */
+    /**
+     * Filters the specified value by going through all available
+     * filters, if any. If none have been set, the value is simply
+     * passed through.
+     *
+     * @param mixed $value
+     * @return mixed
+     *
+     * @see RequestParam::applyFilter_callback()
+     * @see RequestParam::applyFilter_class()
+     */
     protected function filter($value)
     {
         foreach ($this->filters as $filter)
@@ -622,12 +622,12 @@ 
         return $this;
     }
     
-   /**
-    * Adds a filter that trims whitespace from the request
-    * parameter using the PHP <code>trim</code> function.
-    * 
-    * @return $this
-    */
+    /**
+     * Adds a filter that trims whitespace from the request
+     * parameter using the PHP <code>trim</code> function.
+     * 
+     * @return $this
+     */
     public function addFilterTrim() : self
     {
         // to guarantee we only work with strings
@@ -636,13 +636,13 @@ 
         return $this->addCallbackFilter('trim');
     }
 
-   /**
-    * Converts the value to a string, even if it is not
-    * a string value. Complex types like arrays and objects
-    * are converted to an empty string.
-    * 
-    * @return $this
-    */
+    /**
+     * Converts the value to a string, even if it is not
+     * a string value. Complex types like arrays and objects
+     * are converted to an empty string.
+     * 
+     * @return $this
+     */
     public function addStringFilter() : self
     {
         return $this->addClassFilter('String');
@@ -694,12 +694,12 @@ 
         return $this->addCallbackFilter('strip_tags', array($allowedTags));
     }
     
-   /**
-    * Adds a filter that strips all whitespace from the
-    * request parameter, from spaces to tabs and newlines.
-    * 
-    * @return $this
-    */
+    /**
+     * Adds a filter that strips all whitespace from the
+     * request parameter, from spaces to tabs and newlines.
+     * 
+     * @return $this
+     */
     public function addStripWhitespaceFilter() : self
     {
         // to ensure we only work with strings.
@@ -708,14 +708,14 @@ 
         return $this->addClassFilter('StripWhitespace');
     }   
     
-   /**
-    * Adds a filter that transforms comma separated values
-    * into an array of values.
-    * 
-    * @param bool $trimEntries Trim whitespace from each entry?
-    * @param bool $stripEmptyEntries Remove empty entries from the array?
-    * @return $this
-    */
+    /**
+     * Adds a filter that transforms comma separated values
+     * into an array of values.
+     * 
+     * @param bool $trimEntries Trim whitespace from each entry?
+     * @param bool $stripEmptyEntries Remove empty entries from the array?
+     * @return $this
+     */
     public function addCommaSeparatedFilter(bool $trimEntries=true, bool $stripEmptyEntries=true) : self
     {
         $this->setArray();
@@ -746,12 +746,12 @@ 
         );
     }
     
-   /**
-    * Adds a filter that encodes all HTML special characters
-    * using the PHP <code>htmlspecialchars</code> function.
-    * 
-    * @return $this
-    */
+    /**
+     * Adds a filter that encodes all HTML special characters
+     * using the PHP <code>htmlspecialchars</code> function.
+     * 
+     * @return $this
+     */
     public function addHTMLSpecialcharsFilter() : self
     {
         return $this->addCallbackFilter('htmlspecialchars', array(ENT_QUOTES, 'UTF-8'));
@@ -764,14 +764,14 @@ 
         return $this->paramName;
     }
     
-   /**
-    * Marks this request parameter as required. To use this feature,
-    * you have to call the request's {@link Request::validate()}
-    * method.
-    * 
-    * @return RequestParam
-    * @see Request::validate()
-    */
+    /**
+     * Marks this request parameter as required. To use this feature,
+     * you have to call the request's {@link Request::validate()}
+     * method.
+     * 
+     * @return RequestParam
+     * @see Request::validate()
+     */
     public function makeRequired() : RequestParam
     {
         $this->required = true;

Spacing +15 added lines, -15 removed lines

@@ -124,7 +124,7 @@ 
      * @return $this
      * @throws Request_Exception
      */
-    public function setCallback(callable $callback, array $args=array()) : self
+    public function setCallback(callable $callback, array $args = array()) : self
     {
         return $this->setValidation(
             self::VALIDATION_TYPE_CALLBACK, 
@@ -149,22 +149,22 @@ 
         // first off, apply filtering
         $value = $this->filter($value);
         
-        if($this->valueType === self::VALUE_TYPE_LIST)
+        if ($this->valueType === self::VALUE_TYPE_LIST)
         {
-            if(!is_array($value))
+            if (!is_array($value))
             {
                 $value = explode(',', $value);
             }
             
             $keep = array();
             
-            foreach($value as $subval)
+            foreach ($value as $subval)
             {
                 $subval = $this->filter($subval);
                 
                 $subval = $this->applyValidations($subval, true);
 
-                if($subval !== null) {
+                if ($subval !== null) {
                     $keep[] = $subval;
                 }
             }
@@ -183,11 +183,11 @@ 
     * @param mixed $value
     * @return mixed
     */
-    protected function applyValidations($value, bool $subval=false)
+    protected function applyValidations($value, bool $subval = false)
     {
         // go through all enqueued validations in turn, each time
         // replacing the value with the adjusted, validated value.
-        foreach($this->validations as $validateDef)
+        foreach ($this->validations as $validateDef)
         {
             $value = $this->validateType($value, $validateDef['type'], $validateDef['params'], $subval);
         }
@@ -210,7 +210,7 @@ 
     {
         $class = Request_Param_Validator::class.'_'.ucfirst($type);
         
-        if(!class_exists($class))
+        if (!class_exists($class))
         {
             throw new Request_Exception(
                 'Unknown validation type.',
@@ -361,7 +361,7 @@ 
     {
         $args = func_get_args(); // cannot be used as function parameter in some PHP versions
         
-        if(is_array($args[0])) 
+        if (is_array($args[0])) 
         {
             $args = $args[0];
         }
@@ -511,10 +511,10 @@ 
     * @param mixed $default
     * @return mixed
     */
-    public function get($default=null)
+    public function get($default = null)
     {
         $value = $this->request->getParam($this->paramName);
-        if($value !== null && $value !== '') {
+        if ($value !== null && $value !== '') {
             return $value;
         }
 
@@ -538,7 +538,7 @@ 
     {
         foreach ($this->filters as $filter)
         {
-            $method = 'applyFilter_' . $filter['type'];
+            $method = 'applyFilter_'.$filter['type'];
             $value = $this->$method($value, $filter['params']);
         }
 
@@ -557,7 +557,7 @@ 
         
         $filter = new $class($this);
 
-        if($filter instanceof Request_Param_Filter)
+        if ($filter instanceof Request_Param_Filter)
         {
             $filter->setOptions($config['params']);
             return $filter->filter($value);
@@ -716,7 +716,7 @@ 
     * @param bool $stripEmptyEntries Remove empty entries from the array?
     * @return $this
     */
-    public function addCommaSeparatedFilter(bool $trimEntries=true, bool $stripEmptyEntries=true) : self
+    public function addCommaSeparatedFilter(bool $trimEntries = true, bool $stripEmptyEntries = true) : self
     {
         $this->setArray();
         
@@ -735,7 +735,7 @@ 
      * @return $this
      * @throws Request_Exception
      */
-    protected function addClassFilter(string $name, array $params=array()) : self
+    protected function addClassFilter(string $name, array $params = array()) : self
     {
         return $this->addFilter(
             self::FILTER_TYPE_CLASS,

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

@@ -93,7 +93,7 @@ 
     {
         $value = $_REQUEST[$name] ?? $default;
 
-        if(isset($this->knownParams[$name])) {
+        if (isset($this->knownParams[$name])) {
             $value = $this->knownParams[$name]->validate($value);
         }
         
@@ -190,13 +190,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;
@@ -227,7 +227,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;
         }
@@ -244,7 +244,7 @@ 
     */
     public function getRegisteredParam(string $name) : RequestParam
     {
-        if(isset($this->knownParams[$name])) {
+        if (isset($this->knownParams[$name])) {
             return $this->knownParams[$name];
         }
         
@@ -304,7 +304,7 @@ 
     {
         static $accept;
         
-        if(!isset($accept)) {
+        if (!isset($accept)) {
             $accept = new Request_AcceptHeaders();
         }
         
@@ -323,7 +323,7 @@ 
     {
         $_REQUEST[$name] = $value;
         
-        if(isset($this->knownParams[$name])) {
+        if (isset($this->knownParams[$name])) {
             unset($this->knownParams[$name]);
         }
         
@@ -353,11 +353,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]);
         }
         
@@ -372,7 +372,7 @@ 
     */
     public function removeParams(array $names) : Request
     {
-        foreach($names as $name) {
+        foreach ($names as $name) {
             $this->removeParam($name);
         }
         
@@ -390,11 +390,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);
         }
         
@@ -403,11 +403,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,
@@ -429,26 +429,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 '';
         }
@@ -468,24 +468,24 @@ 
      * @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)) 
         {
             $value = JSONConverter::json2varSilent($value, $assoc);
 
-            if($assoc && is_array($value)) {
+            if ($assoc && is_array($value)) {
                 return $value;
             }
             
-            if(is_object($value)) {
+            if (is_object($value)) {
                 return $value;
             }
         }
         
-        if($assoc) {
+        if ($assoc) {
             return array();
         }
         
@@ -502,7 +502,7 @@ 
     public function getJSONAssoc(string $name) : array
     {
         $result = $this->getJSON($name);
-        if(is_array($result)) {
+        if (is_array($result)) {
             return $result;
         }
         
@@ -519,7 +519,7 @@ 
     public function getJSONObject(string $name) : object
     {
         $result = $this->getJSON($name, false);
-        if(is_object($result)) {
+        if (is_object($result)) {
             return $result;
         }
         
@@ -536,7 +536,7 @@ 
     {
         $payload = $data;
 
-        if(!is_string($payload)) {
+        if (!is_string($payload)) {
             $payload = JSONConverter::var2json($payload);
         }
         
@@ -593,7 +593,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);