Mistralys / application-utils

src/Request.php

Indentation +97 added lines, -97 removed lines

@@ -39,9 +39,9 @@ 
      */
     protected static $instance;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $baseURL = '';
     
     public function __construct()
@@ -51,10 +51,10 @@ 
         $this->init();
     }
     
-   /**
-    * Can be extended in a subclass, to avoid
-    * redefining the constructor.
-    */
+    /**
+     * Can be extended in a subclass, to avoid
+     * redefining the constructor.
+     */
     protected function init()
     {
         
@@ -124,12 +124,12 @@ 
         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 '';
@@ -198,10 +198,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;
@@ -231,13 +231,13 @@ 
         return $this->knownParams[$name];
     }
     
-   /**
-    * Retrieves a previously registered parameter instance.
-    * 
-    * @param string $name
-    * @throws Request_Exception
-    * @return Request_Param
-    */
+    /**
+     * Retrieves a previously registered parameter instance.
+     * 
+     * @param string $name
+     * @throws Request_Exception
+     * @return Request_Param
+     */
     public function getRegisteredParam(string $name) : Request_Param
     {
         if(isset($this->knownParams[$name])) {
@@ -254,13 +254,13 @@ 
         );
     }
     
-   /**
-    * 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]);
@@ -389,14 +389,14 @@ 
         return false;
     }
     
-   /**
-    * 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])) {
@@ -410,12 +410,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) {
@@ -480,18 +480,18 @@ 
         return $val;
     }
     
-   /**
-    * Treats the request parameter as a JSON string, and
-    * if it exists and contains valid JSON, returns the
-    * decoded JSON value as an array (default).
-    *
-    * @param string $name
-    * @param bool $assoc
-    * @return array|object
-    * 
-    * @see Request::getJSONAssoc()
-    * @see Request::getJSONObject()
-    */
+    /**
+     * Treats the request parameter as a JSON string, and
+     * if it exists and contains valid JSON, returns the
+     * decoded JSON value as an array (default).
+     *
+     * @param string $name
+     * @param bool $assoc
+     * @return array|object
+     * 
+     * @see Request::getJSONAssoc()
+     * @see Request::getJSONObject()
+     */
     public function getJSON(string $name, bool $assoc=true)
     {
         $value = $this->getParam($name);
@@ -516,13 +516,13 @@ 
         return new \stdClass();
     }
     
-   /**
-    * Like {@link Request::getJSON()}, but omitting the second
-    * parameter. Use this for more readable code.
-    * 
-    * @param string $name
-    * @return array
-    */
+    /**
+     * Like {@link Request::getJSON()}, but omitting the second
+     * parameter. Use this for more readable code.
+     * 
+     * @param string $name
+     * @return array
+     */
     public function getJSONAssoc(string $name) : array
     {
         $result = $this->getJSON($name);
@@ -533,13 +533,13 @@ 
         return array();
     }
     
-   /**
-    * Like {@link Request::getJSON()}, but omitting the second
-    * parameter. Use this for more readable code.
-    *
-    * @param string $name
-    * @return object
-    */
+    /**
+     * Like {@link Request::getJSON()}, but omitting the second
+     * parameter. Use this for more readable code.
+     *
+     * @param string $name
+     * @return object
+     */
     public function getJSONObject(string $name) : object
     {
         $result = $this->getJSON($name, false);
@@ -550,12 +550,12 @@ 
         return new \stdClass();
     }
     
-   /**
-    * Sends a JSON response with the correct headers.
-    *
-    * @param array|string $data
-    * @param bool $exit Whether to exit the script afterwards.
-    */
+    /**
+     * Sends a JSON response with the correct headers.
+     *
+     * @param array|string $data
+     * @param bool $exit Whether to exit the script afterwards.
+     */
     public static function sendJSON($data, bool $exit=true)
     {
         $payload = $data;
@@ -575,12 +575,12 @@ 
         }
     }
     
-   /**
-    * Sends HTML to the browser with the correct headers.
-    * 
-    * @param string $html
-    * @param bool $exit Whether to exit the script afterwards.
-    */
+    /**
+     * Sends HTML to the browser with the correct headers.
+     * 
+     * @param string $html
+     * @param bool $exit Whether to exit the script afterwards.
+     */
     public static function sendHTML(string $html, bool $exit=true)
     {
         header('Cache-Control: no-cache, must-revalidate');
@@ -595,16 +595,16 @@ 
         }
     }
     
-   /**
-    * 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 array $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 array $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);
@@ -613,10 +613,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 +36 added lines, -36 removed lines

@@ -90,11 +90,11 @@ 
     public function getParam($name, $default = null)
     {
         $value = $default;
-        if(isset($_REQUEST[$name])) {
+        if (isset($_REQUEST[$name])) {
             $value = $_REQUEST[$name];
         }
         
-        if(isset($this->knownParams[$name])) {
+        if (isset($this->knownParams[$name])) {
             $value = $this->knownParams[$name]->validate($value);
         }
         
@@ -137,8 +137,8 @@ 
     
     public function getRefreshParams($params = array(), $exclude = array())
     {
-        if(empty($params)) { $params = array(); }
-        if(empty($exclude)) { $exclude = array(); }
+        if (empty($params)) { $params = array(); }
+        if (empty($exclude)) { $exclude = array(); }
         
         $vars = $_REQUEST;
 
@@ -158,8 +158,8 @@ 
         // remove the quickform form variable if present, to 
         // avoid redirect loops when using the refresh URL in
         // a page in which a form has been submitted.
-        foreach($names as $name) {
-            if(strstr($name, '_qf__')) {
+        foreach ($names as $name) {
+            if (strstr($name, '_qf__')) {
                 unset($vars[$name]);
                 break;
             }
@@ -186,13 +186,13 @@ 
      * @param string $dispatcher Relative path to script to use for the URL. Append trailing slash if needed.
      * @return string
      */
-    public function buildURL($params = array(), string $dispatcher='')
+    public function buildURL($params = array(), string $dispatcher = '')
     {
-        $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, null, '&');
+            $url .= '?'.http_build_query($params, null, '&');
         }
         
         return $url;
@@ -223,7 +223,7 @@ 
      */
     public function registerParam($name)
     {
-        if(!isset($this->knownParams[$name])) {
+        if (!isset($this->knownParams[$name])) {
             $param = new Request_Param($this, $name);
             $this->knownParams[$name] = $param;
         }
@@ -240,7 +240,7 @@ 
     */
     public function getRegisteredParam(string $name) : Request_Param
     {
-        if(isset($this->knownParams[$name])) {
+        if (isset($this->knownParams[$name])) {
             return $this->knownParams[$name];
         }
         
@@ -307,12 +307,12 @@ 
             {
                 $entry['type'] = $matches[1];
                 
-                if(isset($matches[2]) && !empty($matches[2])) 
+                if (isset($matches[2]) && !empty($matches[2])) 
                 {
                     $params = ConvertHelper::parseQueryString($matches[2]);
                     $entry['params'] = $params;
                      
-                    if(isset($params['q'])) {
+                    if (isset($params['q'])) {
                         $entry['quality'] = (double)$params['q'];
                     }
                 }
@@ -365,7 +365,7 @@ 
     {
         $_REQUEST[$name] = $value;
         
-        if(isset($this->knownParams[$name])) {
+        if (isset($this->knownParams[$name])) {
             unset($this->knownParams[$name]);
         }
         
@@ -399,11 +399,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]);
         }
         
@@ -418,7 +418,7 @@ 
     */
     public function removeParams(array $names) : Request
     {
-        foreach($names as $name) {
+        foreach ($names as $name) {
             $this->removeParam($name);
         }
         
@@ -434,10 +434,10 @@ 
      * @param string $name
      * @return bool
      */
-    public function getBool($name, $default=false)
+    public function getBool($name, $default = false)
     {
         $value = $this->getParam($name, $default);
-        if(ConvertHelper::isBoolean($value)) {
+        if (ConvertHelper::isBoolean($value)) {
             return ConvertHelper::string2bool($value);
         }
         
@@ -446,9 +446,9 @@ 
     
     public function validate()
     {
-        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,
                     sprintf(
@@ -470,10 +470,10 @@ 
      * @param mixed $default
      * @return string
      */
-    public function getFilteredParam($name, $default=null)
+    public function getFilteredParam($name, $default = null)
     {
         $val = $this->getParam($name, $default);
-        if(is_string($val)) {
+        if (is_string($val)) {
             $val = htmlspecialchars(trim(strip_tags($val)), ENT_QUOTES, 'UTF-8');
         }
         
@@ -492,24 +492,24 @@ 
     * @see Request::getJSONAssoc()
     * @see Request::getJSONObject()
     */
-    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)) 
         {
             $data = json_decode($value, $assoc);
             
-            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();
         }
         
@@ -526,7 +526,7 @@ 
     public function getJSONAssoc(string $name) : array
     {
         $result = $this->getJSON($name);
-        if(is_array($result)) {
+        if (is_array($result)) {
             return $result;
         }
         
@@ -543,7 +543,7 @@ 
     public function getJSONObject(string $name) : object
     {
         $result = $this->getJSON($name, false);
-        if(is_object($result)) {
+        if (is_object($result)) {
             return $result;
         }
         
@@ -556,10 +556,10 @@ 
     * @param array|string $data
     * @param bool $exit Whether to exit the script afterwards.
     */
-    public static function sendJSON($data, bool $exit=true)
+    public static function sendJSON($data, bool $exit = true)
     {
         $payload = $data;
-        if(!is_string($payload)) {
+        if (!is_string($payload)) {
             $payload = json_encode($payload);
         }
         
@@ -569,7 +569,7 @@ 
         
         echo $payload;
         
-        if($exit) 
+        if ($exit) 
         {
             exit;
         }
@@ -581,7 +581,7 @@ 
     * @param string $html
     * @param bool $exit Whether to exit the script afterwards.
     */
-    public static function sendHTML(string $html, bool $exit=true)
+    public static function sendHTML(string $html, bool $exit = true)
     {
         header('Cache-Control: no-cache, must-revalidate');
         header('Expires: Mon, 26 Jul 1997 05:00:00 GMT');
@@ -589,7 +589,7 @@ 
         
         echo $html;
         
-        if($exit)
+        if ($exit)
         {
             exit;
         }
@@ -605,7 +605,7 @@ 
     * @param array $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);

src/Request/Param.php

Indentation +135 added lines, -135 removed lines

@@ -111,18 +111,18 @@ 
         }
     }
     
-   /**
-    * Adds a callback as a validation method. The callback gets the
-    * value to validate as first parameter, and any additional 
-    * parameters passed here get appended to that.
-    * 
-    * The callback must return boolean true or false depending on
-    * whether the value is valid.
-    * 
-    * @param mixed $callback
-    * @param array $args
-    * @return Request_Param
-    */
+    /**
+     * Adds a callback as a validation method. The callback gets the
+     * value to validate as first parameter, and any additional 
+     * parameters passed here get appended to that.
+     * 
+     * The callback must return boolean true or false depending on
+     * whether the value is valid.
+     * 
+     * @param mixed $callback
+     * @param array $args
+     * @return Request_Param
+     */
     public function setCallback($callback, $args=array())
     {
         if(!is_callable($callback)) {
@@ -264,13 +264,13 @@ 
     
     protected $valueType = self::VALUE_TYPE_STRING;
 
-   /**
-    * 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 Request_Param
-    */
+    /**
+     * 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 Request_Param
+     */
     public function setIDList()
     {
         $this->valueType = self::VALUE_TYPE_ID_LIST;
@@ -279,13 +279,13 @@ 
         return $this;
     }
     
-   /**
-    * Sets the variable to be an alias, as defined by the
-    * {@link RegexHelper::REGEX_ALIAS} regular expression.
-    * 
-    * @return Request_Param
-    * @see RegexHelper::REGEX_ALIAS
-    */
+    /**
+     * Sets the variable to be an alias, as defined by the
+     * {@link RegexHelper::REGEX_ALIAS} regular expression.
+     * 
+     * @return Request_Param
+     * @see RegexHelper::REGEX_ALIAS
+     */
     public function setAlias()
     {
         return $this->setRegex(RegexHelper::REGEX_ALIAS);
@@ -326,12 +326,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 Request_Param
-    */
+    /**
+     * Sets the parameter value as a string containing lowercase
+     * and/or uppercase letters, as well as numbers.
+     * 
+     * @return Request_Param
+     */
     public function setAlnum()
     {
         return $this->setValidation(self::VALIDATION_TYPE_ALNUM);   
@@ -359,17 +359,17 @@ 
         return $this->setValidation(self::VALIDATION_TYPE_ENUM, $args);
     }
     
-   /**
-    * Only available for array values: the parameter must be
-    * an array value, and the array may only contain values 
-    * specified in the values array.
-    * 
-    * Submitted values that are not in the allowed list of
-    * values are stripped from the value.
-    *  
-    * @param array $values List of allowed values
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Only available for array values: the parameter must be
+     * an array value, and the array may only contain values 
+     * specified in the values array.
+     * 
+     * Submitted values that are not in the allowed list of
+     * values are stripped from the value.
+     *  
+     * @param array $values List of allowed values
+     * @return \AppUtils\Request_Param
+     */
     public function setValuesList(array $values)
     {
         $this->setArray();
@@ -382,39 +382,39 @@ 
         return $this->setValidation(self::VALIDATION_TYPE_ARRAY);
     }
     
-   /**
-    * Specifies that a JSON-encoded string is expected.
-    * 
-    * NOTE: Numbers or quoted strings are technically valid
-    * JSON, but are not accepted, because it is assumed
-    * at least an array or object are expected.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Specifies that a JSON-encoded string is expected.
+     * 
+     * NOTE: Numbers or quoted strings are technically valid
+     * JSON, but are not accepted, because it is assumed
+     * at least an array or object are expected.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function setJSON() : Request_Param
     {
         return $this->setValidation(self::VALIDATION_TYPE_JSON, array('arrays' => true));
     }
     
-   /**
-    * Like {@link Request_Param::setJSON()}, but accepts
-    * only JSON objects. Arrays will not be accepted.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Like {@link Request_Param::setJSON()}, but accepts
+     * only JSON objects. Arrays will not be accepted.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function setJSONObject() : Request_Param
     {
         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 Request_Param
-    */
+    /**
+     * 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 Request_Param
+     */
     public function setBoolean() : Request_Param
     {
         $this->addCallbackFilter(array($this, 'applyFilter_boolean'));
@@ -478,15 +478,15 @@ 
         return $keep;
     }
     
-   /**
-    * 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 \AppUtils\Request_Param
-    */
+    /**
+     * 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 \AppUtils\Request_Param
+     */
     public function setMD5() : Request_Param
     {
         return $this->setRegex(RegexHelper::REGEX_MD5);
@@ -528,14 +528,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);
@@ -565,12 +565,12 @@ 
         return null;
     }
     
-   /**
-    * Validates the syntax of an URL, but not its actual validity. 
-    * 
-    * @param mixed $value
-    * @return string
-    */
+    /**
+     * Validates the syntax of an URL, but not its actual validity. 
+     * 
+     * @param mixed $value
+     * @return string
+     */
     protected function validate_url($value) : string
     {
         if(!is_string($value)) {
@@ -710,10 +710,10 @@ 
         return null;
     }
     
-   /**
-    * Makes sure that the value is a JSON-encoded string.
-    * @param mixed $value
-    */
+    /**
+     * Makes sure that the value is a JSON-encoded string.
+     * @param mixed $value
+     */
     protected function validate_json($value) : string
     {
         if(!is_string($value)) {
@@ -730,7 +730,7 @@ 
         if($this->validationParams['arrays'] === false) 
         {
             if(is_object(json_decode($value))) {
-               return $value; 
+                return $value; 
             }
         } 
         else 
@@ -810,12 +810,12 @@ 
         return $this;
     }
     
-   /**
-    * Adds a filter that trims whitespace from the request
-    * parameter using the PHP <code>trim</code> function.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Adds a filter that trims whitespace from the request
+     * parameter using the PHP <code>trim</code> function.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function addFilterTrim() : Request_Param
     {
         // to guarantee we only work with strings
@@ -824,13 +824,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 \AppUtils\Request_Param
-    */
+    /**
+     * 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 \AppUtils\Request_Param
+     */
     public function addStringFilter() : Request_Param
     {
         return $this->addCallbackFilter(array($this, 'applyFilter_string'));
@@ -880,12 +880,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 \AppUtils\Request_Param
-    */
+    /**
+     * Adds a filter that strips all whitespace from the
+     * request parameter, from spaces to tabs and newlines.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function addStripWhitespaceFilter() : Request_Param
     {
         // to ensure we only work with strings.
@@ -894,14 +894,14 @@ 
         return $this->addCallbackFilter(array($this, 'applyFilter_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 \AppUtils\Request_Param
-    */
+    /**
+     * 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 \AppUtils\Request_Param
+     */
     public function addCommaSeparatedFilter(bool $trimEntries=true, bool $stripEmptyEntries=true) : Request_Param
     {
         $this->setArray();
@@ -915,12 +915,12 @@ 
         );
     }
     
-   /**
-    * Adds a filter that encodes all HTML special characters
-    * using the PHP <code>htmlspecialchars</code> function.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Adds a filter that encodes all HTML special characters
+     * using the PHP <code>htmlspecialchars</code> function.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function addHTMLSpecialcharsFilter() : Request_Param
     {
         return $this->addCallbackFilter('htmlspecialchars', array(ENT_QUOTES, 'UTF-8'));
@@ -933,14 +933,14 @@ 
     
     protected $required = false;
     
-   /**
-    * Marks this request parameter as required. To use this feature,
-    * you have to call the request's {@link Request::validate()}
-    * method.
-    * 
-    * @return Request_Param
-    * @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 Request_Param
+     * @see Request::validate()
+     */
     public function makeRequired() : Request_Param
     {
         $this->required = true;

Spacing +38 added lines, -38 removed lines

@@ -123,9 +123,9 @@ 
     * @param array $args
     * @return Request_Param
     */
-    public function setCallback($callback, $args=array())
+    public function setCallback($callback, $args = array())
     {
-        if(!is_callable($callback)) {
+        if (!is_callable($callback)) {
             throw new Request_Exception(
                 'Not a valid callback',
                 'The specified callback is not a valid callable entity.',
@@ -148,7 +148,7 @@ 
         array_unshift($args, $value);
         
         $result = call_user_func_array($this->validationParams['callback'], $args);
-        if($result !== false) {
+        if ($result !== false) {
             return $value;
         }
         
@@ -175,13 +175,13 @@ 
         
         // 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) 
         {
             $this->validationType = $validateDef['type'];
             $this->validationParams = $validateDef['params'];
             
             // and now, see if we have to validate the value as well
-            $method = 'validate_' . $this->validationType;
+            $method = 'validate_'.$this->validationType;
             if (!method_exists($this, $method)) {
                 throw new Request_Exception(
                     'Unknown validation type.',
@@ -195,19 +195,19 @@ 
                 );
             }
          
-            if($this->valueType === self::VALUE_TYPE_ID_LIST) 
+            if ($this->valueType === self::VALUE_TYPE_ID_LIST) 
             {
-                if(!is_array($value)) {
+                if (!is_array($value)) {
                     $value = explode(',', $value);
                 }
                 
                 $keep = array();
-                foreach($value as $subval) 
+                foreach ($value as $subval) 
                 {
                     $subval = trim($subval);
                     $subval = $this->$method($subval);
                     
-                    if($subval !== null) {
+                    if ($subval !== null) {
                         $keep[] = intval($subval);
                     }
                 }
@@ -423,7 +423,7 @@ 
     
     protected function applyFilter_boolean($value)
     {
-        if($value == 'yes' || $value == 'true') {
+        if ($value == 'yes' || $value == 'true') {
             return true;
         }
         
@@ -437,7 +437,7 @@ 
     
     protected function applyFilter_string($value)
     {
-        if(!is_scalar($value)) {
+        if (!is_scalar($value)) {
             return '';
         }
         
@@ -446,29 +446,29 @@ 
     
     protected function applyFilter_commaSeparated($value, bool $trimEntries, bool $stripEmptyEntries)
     {
-        if(is_array($value)) {
+        if (is_array($value)) {
             return $value;
         }
         
-        if($value === '' || $value === null || !is_string($value)) {
+        if ($value === '' || $value === null || !is_string($value)) {
             return array();
         }
         
         $result = explode(',', $value);
         
-        if(!$trimEntries && !$stripEmptyEntries) {
+        if (!$trimEntries && !$stripEmptyEntries) {
             return $result;
         }
         
         $keep = array();
         
-        foreach($result as $entry) 
+        foreach ($result as $entry) 
         {
-            if($trimEntries === true) {
+            if ($trimEntries === true) {
                 $entry = trim($entry);
             }
             
-            if($stripEmptyEntries === true && $entry === '') {
+            if ($stripEmptyEntries === true && $entry === '') {
                 continue;
             }
             
@@ -536,10 +536,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;
         }
 
@@ -558,7 +558,7 @@ 
      */
     protected function validate_integer($value) : ?int
     {
-        if(ConvertHelper::isInteger($value)) {
+        if (ConvertHelper::isInteger($value)) {
             return intval($value);
         }
         
@@ -573,12 +573,12 @@ 
     */
     protected function validate_url($value) : string
     {
-        if(!is_string($value)) {
+        if (!is_string($value)) {
             return '';
         }
         
         $info = parse_url($value);
-        if(isset($info['host'])) {
+        if (isset($info['host'])) {
             return $value;
         }
         
@@ -594,7 +594,7 @@ 
      */
     protected function validate_numeric($value) : ?float
     {
-        if(is_numeric($value)) {
+        if (is_numeric($value)) {
             return $value * 1;
         }
 
@@ -610,7 +610,7 @@ 
      */
     protected function validate_regex($value) : ?string
     {
-        if(!is_scalar($value)) {
+        if (!is_scalar($value)) {
             return null;
         }
         
@@ -618,13 +618,13 @@ 
         // is a boolan, which is converted to an integer when
         // converted to string, which in turn can be validated
         // with a regex.
-        if(is_bool($value)) {
+        if (is_bool($value)) {
             return null;
         }
         
         $value = (string)$value;
         
-        if(preg_match($this->validationParams['regex'], $value)) {
+        if (preg_match($this->validationParams['regex'], $value)) {
             return $value;
         }
 
@@ -640,11 +640,11 @@ 
      */
     protected function validate_alpha($value)
     {
-        if(!is_scalar($value)) {
+        if (!is_scalar($value)) {
             return null;
         }
         
-        if(preg_match('/\A[a-zA-Z]+\z/', $value)) {
+        if (preg_match('/\A[a-zA-Z]+\z/', $value)) {
             return $value;
         }
 
@@ -653,13 +653,13 @@ 
     
     protected function validate_valueslist($value)
     {
-        if(!is_array($value)) {
+        if (!is_array($value)) {
             return array();
         }
         
         $keep = array();
-        foreach($value as $item) {
-            if(in_array($item, $this->validationParams)) {
+        foreach ($value as $item) {
+            if (in_array($item, $this->validationParams)) {
                 $keep[] = $item;
             }
         }
@@ -716,26 +716,26 @@ 
     */
     protected function validate_json($value) : string
     {
-        if(!is_string($value)) {
+        if (!is_string($value)) {
             return '';
         }
         
         $value = trim($value);
         
-        if(empty($value)) {
+        if (empty($value)) {
             return '';
         }
         
         // strictly validate for objects?
-        if($this->validationParams['arrays'] === false) 
+        if ($this->validationParams['arrays'] === false) 
         {
-            if(is_object(json_decode($value))) {
+            if (is_object(json_decode($value))) {
                return $value; 
             }
         } 
         else 
         {
-            if(is_array(json_decode($value, true))) {
+            if (is_array(json_decode($value, true))) {
                 return $value;
             }
         }
@@ -755,7 +755,7 @@ 
     {
         $total = count($this->filters);
         for ($i = 0; $i < $total; $i++) {
-            $method = 'applyFilter_' . $this->filters[$i]['type'];
+            $method = 'applyFilter_'.$this->filters[$i]['type'];
             $value = $this->$method($value, $this->filters[$i]['params']);
         }
 
@@ -902,7 +902,7 @@ 
     * @param bool $stripEmptyEntries Remove empty entries from the array?
     * @return \AppUtils\Request_Param
     */
-    public function addCommaSeparatedFilter(bool $trimEntries=true, bool $stripEmptyEntries=true) : Request_Param
+    public function addCommaSeparatedFilter(bool $trimEntries = true, bool $stripEmptyEntries = true) : Request_Param
     {
         $this->setArray();
         

src/ConvertHelper.php

Spacing +118 added lines, -118 removed lines

@@ -59,7 +59,7 @@ 
             $amount = substr_count($line, "\t") - $min;
             $line = trim($line);
             if ($amount >= 1) {
-                $line = str_repeat("\t", $amount) . $line;
+                $line = str_repeat("\t", $amount).$line;
             }
 
             $converted[] = $line;
@@ -131,10 +131,10 @@ 
 
         // specifically handle zero
         if ($seconds <= 0) {
-            return '0 ' . t('seconds');
+            return '0 '.t('seconds');
         }
         
-        if($seconds < 1) {
+        if ($seconds < 1) {
             return t('less than a second');
         }
 
@@ -142,7 +142,7 @@ 
         foreach ($units as $def) {
             $quot = intval($seconds / $def['value']);
             if ($quot) {
-                $item = $quot . ' ';
+                $item = $quot.' ';
                 if (abs($quot) > 1) {
                     $item .= $def['plural'];
                 } else {
@@ -159,7 +159,7 @@ 
             return $last;
         }
 
-        return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last;
+        return implode(', ', $tokens).' '.t('and').' '.$last;
     }
 
     /**
@@ -177,13 +177,13 @@ 
      */
     public static function duration2string($datefrom, $dateto = -1) : string
     {
-        if($datefrom instanceof \DateTime) {
+        if ($datefrom instanceof \DateTime) {
             $datefrom = ConvertHelper::date2timestamp($datefrom);
         } else {
             $datefrom = intval($datefrom);
         }
         
-        if($dateto instanceof \DateTime) {
+        if ($dateto instanceof \DateTime) {
             $dateto = ConvertHelper::date2timestamp($dateto);
         } else {
             $dateto = intval($dateto);
@@ -192,11 +192,11 @@ 
         // Defaults and assume if 0 is passed in that
         // its an error rather than the epoch
 
-        if($datefrom <= 0) {
+        if ($datefrom <= 0) {
             return t('A long time ago');
         }
         
-        if($dateto == -1) {
+        if ($dateto == -1) {
             $dateto = time();
         }
 
@@ -207,7 +207,7 @@ 
         $interval = "";
         
         $future = false;
-        if($difference < 0) {
+        if ($difference < 0) {
             $difference = $difference * -1;
             $future = true;
         }
@@ -282,7 +282,7 @@ 
                 $day = (int)date("j", $dateto);
                 $year = (int)date("Y", $datefrom);
                 
-                while(mktime($hour, $min, $sec, $month + ($months_difference), $day, $year) < $dateto) 
+                while (mktime($hour, $min, $sec, $month + ($months_difference), $day, $year) < $dateto) 
                 {
                     $months_difference++;
                 }
@@ -297,7 +297,7 @@ 
                     $datediff--;
                 }
 
-                if($future) {
+                if ($future) {
                     $result = ($datediff == 1) ? t('In one month', $datediff) : t('In %1s months', $datediff);
                 } else {
                     $result = ($datediff == 1) ? t('One month ago', $datediff) : t('%1s months ago', $datediff);
@@ -306,7 +306,7 @@ 
 
             case "y":
                 $datediff = floor($difference / 60 / 60 / 24 / 365);
-                if($future) {
+                if ($future) {
                     $result = ($datediff == 1) ? t('In one year', $datediff) : t('In %1s years', $datediff);
                 } else {
                     $result = ($datediff == 1) ? t('One year ago', $datediff) : t('%1s years ago', $datediff);
@@ -315,7 +315,7 @@ 
 
             case "d":
                 $datediff = floor($difference / 60 / 60 / 24);
-                if($future) {
+                if ($future) {
                     $result = ($datediff == 1) ? t('In one day', $datediff) : t('In %1s days', $datediff);
                 } else {
                     $result = ($datediff == 1) ? t('One day ago', $datediff) : t('%1s days ago', $datediff);
@@ -324,7 +324,7 @@ 
 
             case "ww":
                 $datediff = floor($difference / 60 / 60 / 24 / 7);
-                if($future) {
+                if ($future) {
                     $result = ($datediff == 1) ? t('In one week', $datediff) : t('In %1s weeks', $datediff);
                 } else {
                     $result = ($datediff == 1) ? t('One week ago', $datediff) : t('%1s weeks ago', $datediff);
@@ -333,7 +333,7 @@ 
 
             case "h":
                 $datediff = floor($difference / 60 / 60);
-                if($future) {
+                if ($future) {
                     $result = ($datediff == 1) ? t('In one hour', $datediff) : t('In %1s hours', $datediff);
                 } else {
                     $result = ($datediff == 1) ? t('One hour ago', $datediff) : t('%1s hours ago', $datediff);
@@ -342,7 +342,7 @@ 
 
             case "n":
                 $datediff = floor($difference / 60);
-                if($future) {
+                if ($future) {
                     $result = ($datediff == 1) ? t('In one minute', $datediff) : t('In %1s minutes', $datediff);
                 } else {
                     $result = ($datediff == 1) ? t('One minute ago', $datediff) : t('%1s minutes ago', $datediff);
@@ -351,7 +351,7 @@ 
 
             case "s":
                 $datediff = $difference;
-                if($future) {
+                if ($future) {
                     $result = ($datediff == 1) ? t('In one second', $datediff) : t('In %1s seconds', $datediff);
                 } else {
                     $result = ($datediff == 1) ? t('One second ago', $datediff) : t('%1s seconds ago', $datediff);
@@ -374,9 +374,9 @@ 
         return $geshi->parse_code();
     }
     
-    public static function highlight_xml($xml, $formatSource=false)
+    public static function highlight_xml($xml, $formatSource = false)
     {
-        if($formatSource) 
+        if ($formatSource) 
         {
             $dom = new \DOMDocument();
             $dom->loadXML($xml);
@@ -414,22 +414,22 @@ 
         $terabyte = $gigabyte * 1024;
 
         if (($bytes >= 0) && ($bytes < $kilobyte)) {
-            return $bytes . ' ' . t('B');
+            return $bytes.' '.t('B');
 
         } elseif (($bytes >= $kilobyte) && ($bytes < $megabyte)) {
-            return round($bytes / $kilobyte, $precision) . ' ' . t('Kb');
+            return round($bytes / $kilobyte, $precision).' '.t('Kb');
 
         } elseif (($bytes >= $megabyte) && ($bytes < $gigabyte)) {
-            return round($bytes / $megabyte, $precision) . ' ' . t('Mb');
+            return round($bytes / $megabyte, $precision).' '.t('Mb');
 
         } elseif (($bytes >= $gigabyte) && ($bytes < $terabyte)) {
-            return round($bytes / $gigabyte, $precision) . ' ' . t('Gb');
+            return round($bytes / $gigabyte, $precision).' '.t('Gb');
 
         } elseif ($bytes >= $terabyte) {
-            return round($bytes / $gigabyte, $precision) . ' ' . t('Tb');
+            return round($bytes / $gigabyte, $precision).' '.t('Tb');
         }
 
-        return $bytes . ' ' . t('B');
+        return $bytes.' '.t('B');
     }
 
    /**
@@ -449,34 +449,34 @@ 
             return $text;
         }
 
-        $text = trim(mb_substr($text, 0, $targetLength)) . $append;
+        $text = trim(mb_substr($text, 0, $targetLength)).$append;
 
         return $text;
     }
 
-    public static function var_dump($var, $html=true)
+    public static function var_dump($var, $html = true)
     {
         $info = parseVariable($var);
         
-        if($html) {
+        if ($html) {
             return $info->toHTML();
         }
         
         return $info->toString();
     }
     
-    public static function print_r($var, $return=false, $html=true)
+    public static function print_r($var, $return = false, $html = true)
     {
         $result = self::var_dump($var, $html);
         
-        if($html) {
+        if ($html) {
             $result = 
             '<pre style="background:#fff;color:#333;padding:16px;border:solid 1px #bbb;border-radius:4px">'.
                 $result.
             '</pre>';
         }
         
-        if($return) {
+        if ($return) {
             return $result;
         }
         
@@ -496,7 +496,7 @@ 
 
     public static function string2bool($string)
     {
-        if($string === '' || $string === null) {
+        if ($string === '' || $string === null) {
             return false;
         }
         
@@ -551,10 +551,10 @@ 
     public static function date2listLabel(\DateTime $date, $includeTime = false, $shortMonth = false)
     {
         $today = new \DateTime();
-        if($date->format('d.m.Y') == $today->format('d.m.Y')) {
+        if ($date->format('d.m.Y') == $today->format('d.m.Y')) {
             $label = t('Today');
         } else {
-            $label = $date->format('d') . '. ' . self::month2string((int)$date->format('m'), $shortMonth) . ' ';
+            $label = $date->format('d').'. '.self::month2string((int)$date->format('m'), $shortMonth).' ';
             if ($date->format('Y') != date('Y')) {
                 $label .= $date->format('Y');
             }
@@ -645,28 +645,28 @@ 
         $hexAlphabet = array('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F');
         
         $stack = array();
-        foreach(self::$controlChars as $char)
+        foreach (self::$controlChars as $char)
         {
             $tokens = explode('-', $char);
             $start = $tokens[0];
             $end = $tokens[1];
             $prefix = substr($start, 0, 3);
             $range = array();
-            foreach($hexAlphabet as $number) {
+            foreach ($hexAlphabet as $number) {
                 $range[] = $prefix.$number;
             }
             
             $use = false;
-            foreach($range as $number) {
-                if($number == $start) {
+            foreach ($range as $number) {
+                if ($number == $start) {
                     $use = true;
                 }
                 
-                if($use) {
+                if ($use) {
                     $stack[] = $number;
                 }
                 
-                if($number == $end) {
+                if ($number == $end) {
                     break;
                 }
             }
@@ -687,7 +687,7 @@ 
         $chars = self::getControlCharactersAsHex();
         
         $result = array();
-        foreach($chars as $char) {
+        foreach ($chars as $char) {
             $result[] = hex2bin($char);
         }
         
@@ -705,14 +705,14 @@ 
         $chars = self::getControlCharactersAsHex();
         
         $result = array();
-        foreach($chars as $char) {
+        foreach ($chars as $char) {
             $result[] = '\u'.strtolower($char);
         }
         
         return $result;
     }
     
-    protected static $controlChars =  array(
+    protected static $controlChars = array(
         '0000-0008', // control chars
         '000E-000F', // control chars
         '0010-001F', // control chars
@@ -734,19 +734,19 @@ 
      */
     public static function stripControlCharacters(string $string) : string
     {
-        if(empty($string)) {
+        if (empty($string)) {
             return $string;
         }
         
         // create the regex from the unicode characters list
-        if(!isset(self::$controlCharsRegex)) 
+        if (!isset(self::$controlCharsRegex)) 
         {
             $chars = self::getControlCharactersAsHex();
 
             // we use the notation \x{0000} to specify the unicode character key
             // in the regular expression.
             $stack = array();
-            foreach($chars as $char) {
+            foreach ($chars as $char) {
                 $stack[] = '\x{'.$char.'}';
             }
             
@@ -780,7 +780,7 @@ 
             $ordInt = ord($octet);
             // Convert from int (base 10) to hex (base 16), for PHP \x syntax
             $ordHex = base_convert($ordInt, 10, 16);
-            $output .= '\x' . $ordHex;
+            $output .= '\x'.$ordHex;
         }
         return $output;
     }
@@ -812,19 +812,19 @@ 
     
     protected static function convertScalarForComparison($scalar)
     {
-        if($scalar === '' || is_null($scalar)) {
+        if ($scalar === '' || is_null($scalar)) {
             return null;
         }
         
-        if(is_bool($scalar)) {
+        if (is_bool($scalar)) {
             return self::bool2string($scalar);
         }
         
-        if(is_array($scalar)) {
+        if (is_array($scalar)) {
             $scalar = md5(serialize($scalar));
         }
         
-        if($scalar !== null && !is_scalar($scalar)) {
+        if ($scalar !== null && !is_scalar($scalar)) {
             throw new ConvertHelper_Exception(
                 'Not a scalar value in comparison',
                 null,
@@ -873,7 +873,7 @@ 
     public static function bool2string($boolean, bool $yesno = false) : string
     {
         // allow 'yes', 'true', 'no', 'false' string notations as well
-        if(!is_bool($boolean)) {
+        if (!is_bool($boolean)) {
             $boolean = self::string2bool($boolean);
         }
         
@@ -914,15 +914,15 @@ 
     public static function array2attributeString($array)
     {
         $tokens = array();
-        foreach($array as $attr => $value) {
-            if($value == '' || $value == null) {
+        foreach ($array as $attr => $value) {
+            if ($value == '' || $value == null) {
                 continue;
             }
             
             $tokens[] = $attr.'="'.$value.'"';
         }
         
-        if(empty($tokens)) {
+        if (empty($tokens)) {
             return '';
         }
         
@@ -937,10 +937,10 @@ 
     * @param string $string
     * @return string
     */
-    public static function string2attributeJS($string, $quoted=true)
+    public static function string2attributeJS($string, $quoted = true)
     {
         $converted = addslashes(htmlspecialchars(strip_tags($string), ENT_QUOTES, 'UTF-8'));
-        if($quoted) {
+        if ($quoted) {
             $converted = "'".$converted."'";
         } 
         
@@ -958,11 +958,11 @@ 
     */
     public static function isBoolean($value) : bool
     {
-        if(is_bool($value)) {
+        if (is_bool($value)) {
             return true;
         }
         
-        if(!is_scalar($value)) {
+        if (!is_scalar($value)) {
             return false;
         }
         
@@ -978,7 +978,7 @@ 
     public static function array2styleString(array $subject) : string
     {
         $tokens = array();
-        foreach($subject as $name => $value) {
+        foreach ($subject as $name => $value) {
             $tokens[] = $name.':'.$value;
         }
         
@@ -1036,7 +1036,7 @@ 
     * 
     * @see JSHelper::buildRegexStatement()
     */
-    public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT)
+    public static function regex2js(string $regex, string $statementType = JSHelper::JS_REGEX_OBJECT)
     {
         return JSHelper::buildRegexStatement($regex, $statementType);
     }
@@ -1053,11 +1053,11 @@ 
     * @throws ConvertHelper_Exception
     * @return string
     */
-    public static function var2json($variable, int $options=0, int $depth=512) : string
+    public static function var2json($variable, int $options = 0, int $depth = 512) : string
     {
         $result = json_encode($variable, $options, $depth);
         
-        if($result !== false) {
+        if ($result !== false) {
             return $result;
         }
         
@@ -1082,10 +1082,10 @@ 
     public static function stripUTFBom($string)
     {
         $boms = FileHelper::getUTFBOMs();
-        foreach($boms as $bomChars) {
+        foreach ($boms as $bomChars) {
             $length = mb_strlen($bomChars);
             $text = mb_substr($string, 0, $length);
-            if($text==$bomChars) {
+            if ($text == $bomChars) {
                 return mb_substr($string, $length);
             }
         }
@@ -1102,7 +1102,7 @@ 
     */
     public static function string2utf8($string)
     {
-        if(!self::isStringASCII($string)) {
+        if (!self::isStringASCII($string)) {
             return \ForceUTF8\Encoding::toUTF8($string);
         }
         
@@ -1120,11 +1120,11 @@ 
     */
     public static function isStringASCII($string)
     {
-        if($string === '' || $string === NULL) {
+        if ($string === '' || $string === NULL) {
             return true;
         }
         
-        if(!is_string($string)) {
+        if (!is_string($string)) {
             return false;
         }
         
@@ -1158,7 +1158,7 @@ 
     * @param array $options
     * @return float
     */
-    public static function matchString($source, $target, $options=array())
+    public static function matchString($source, $target, $options = array())
     {
         $defaults = array(
             'maxLevenshtein' => 10,
@@ -1168,12 +1168,12 @@ 
         $options = array_merge($defaults, $options);
         
         // avoid doing this via levenshtein
-        if($source == $target) {
+        if ($source == $target) {
             return 100;
         }
         
         $diff = levenshtein($source, $target);
-        if($diff > $options['maxLevenshtein']) {
+        if ($diff > $options['maxLevenshtein']) {
             return 0;
         }
         
@@ -1187,8 +1187,8 @@ 
         
         $offset = 0;
         $keep = array();
-        foreach($tokens as $token) {
-            if($interval->$token > 0) {
+        foreach ($tokens as $token) {
+            if ($interval->$token > 0) {
                 $keep = array_slice($tokens, $offset);
                 break;
             }
@@ -1197,16 +1197,16 @@ 
         }
         
         $parts = array();
-        foreach($keep as $token) 
+        foreach ($keep as $token) 
         {
             $value = $interval->$token;
             $label = '';
             
             $suffix = 'p';
-            if($value == 1) { $suffix = 's'; }
+            if ($value == 1) { $suffix = 's'; }
             $token .= $suffix;
             
-            switch($token) {
+            switch ($token) {
                 case 'ys': $label = t('1 year'); break;
                 case 'yp': $label = t('%1$s years', $value); break;
                 case 'ms': $label = t('1 month'); break;
@@ -1224,7 +1224,7 @@ 
             $parts[] = $label;
         }
         
-        if(count($parts) == 1) {
+        if (count($parts) == 1) {
             return $parts[0];
         } 
         
@@ -1295,24 +1295,24 @@ 
     * @see ConvertHelper::INTERVAL_HOURS
     * @see ConvertHelper::INTERVAL_DAYS
     */
-    public static function interval2total(\DateInterval $interval, $unit=self::INTERVAL_SECONDS) : int
+    public static function interval2total(\DateInterval $interval, $unit = self::INTERVAL_SECONDS) : int
     {
         $total = $interval->format('%a');
         if ($unit == self::INTERVAL_DAYS) {
             return (int)$total;
         }
         
-        $total = ($total * 24) + ($interval->h );
+        $total = ($total * 24) + ($interval->h);
         if ($unit == self::INTERVAL_HOURS) {
             return (int)$total;
         }
     
-        $total = ($total * 60) + ($interval->i );
+        $total = ($total * 60) + ($interval->i);
         if ($unit == self::INTERVAL_MINUTES) {
             return (int)$total;
         }
 
-        $total = ($total * 60) + ($interval->s );
+        $total = ($total * 60) + ($interval->s);
         if ($unit == self::INTERVAL_SECONDS) {
             return (int)$total;
         }
@@ -1341,13 +1341,13 @@ 
     * @param string $short
     * @return string|NULL
     */
-    public static function date2dayName(\DateTime $date, $short=false)
+    public static function date2dayName(\DateTime $date, $short = false)
     {
         $day = $date->format('l');
         $invariant = self::getDayNamesInvariant();
         
         $idx = array_search($day, $invariant);
-        if($idx !== false) {
+        if ($idx !== false) {
             $localized = self::getDayNames($short);
             return $localized[$idx];
         }
@@ -1370,10 +1370,10 @@ 
     * @param string $short
     * @return string[]
     */
-    public static function getDayNames($short=false)
+    public static function getDayNames($short = false)
     {
-        if($short) {
-            if(!isset(self::$daysShort)) {
+        if ($short) {
+            if (!isset(self::$daysShort)) {
                 self::$daysShort = array(
                     t('Mon'),
                     t('Tue'),
@@ -1388,7 +1388,7 @@ 
             return self::$daysShort;
         }
         
-        if(!isset(self::$days)) {
+        if (!isset(self::$days)) {
             self::$days = array(
                 t('Monday'),
                 t('Tuesday'),
@@ -1413,17 +1413,17 @@ 
      */
     public static function implodeWithAnd(array $list, $sep = ', ', $conjunction = null)
     {
-        if(empty($list)) {
+        if (empty($list)) {
             return '';
         }
         
-        if(empty($conjunction)) {
+        if (empty($conjunction)) {
             $conjunction = t('and');
         }
         
         $last = array_pop($list);
-        if($list) {
-            return implode($sep, $list) . $conjunction . ' ' . $last;
+        if ($list) {
+            return implode($sep, $list).$conjunction.' '.$last;
         }
         
         return $last;
@@ -1442,7 +1442,7 @@ 
     public static function string2array(string $string) : array
     {
         $result = preg_split('//u', $string, null, PREG_SPLIT_NO_EMPTY);
-        if($result !== false) {
+        if ($result !== false) {
             return $result;
         }
         
@@ -1457,12 +1457,12 @@ 
     */
     public static function isStringHTML(string $string) : bool
     {
-        if(preg_match('%<[a-z/][\s\S]*>%siU', $string)) {
+        if (preg_match('%<[a-z/][\s\S]*>%siU', $string)) {
             return true;
         }
         
         $decoded = html_entity_decode($string);
-        if($decoded !== $string) {
+        if ($decoded !== $string) {
             return true;
         }
         
@@ -1599,7 +1599,7 @@ 
         // extract parameter names from the query string
         $result = array();
         preg_match_all('/&?([^&]+)=.*/sixU', $queryString, $result, PREG_PATTERN_ORDER);
-        if(isset($result[1])) {
+        if (isset($result[1])) {
             $paramNames = $result[1];
         }
         
@@ -1622,11 +1622,11 @@ 
         // possible naming conflicts like having both parameters "foo.bar" 
         // and "foo_bar" in the query string: since "foo.bar" would be converted
         // to "foo_bar", one of the two would be replaced.
-        if($fixRequired) 
+        if ($fixRequired) 
         {
             $counter = 1;
             $placeholders = array();
-            foreach($paramNames as $paramName)
+            foreach ($paramNames as $paramName)
             {
                  // create a unique placeholder name
                  $placeholder = '__PLACEHOLDER'.$counter.'__';
@@ -1656,13 +1656,13 @@ 
         parse_str($queryString, $parsed);
         
         // do any of the parameter names need to be fixed?
-        if(!$fixRequired) {
+        if (!$fixRequired) {
             return $parsed;
         }
         
         $keep = array();
         
-        foreach($parsed as $name => $value)
+        foreach ($parsed as $name => $value)
         {
              $keep[$table[$name]] = $value;
         }
@@ -1681,14 +1681,14 @@ 
     * @param bool $caseInsensitive
     * @return ConvertHelper_StringMatch[]
     */
-    public static function findString(string $needle, string $haystack, bool $caseInsensitive=false)
+    public static function findString(string $needle, string $haystack, bool $caseInsensitive = false)
     {
-        if($needle === '') {
+        if ($needle === '') {
             return array();
         }
         
         $function = 'mb_strpos';
-        if($caseInsensitive) {
+        if ($caseInsensitive) {
             $function = 'mb_stripos';
         }
         
@@ -1696,7 +1696,7 @@ 
         $positions = array();
         $length = mb_strlen($needle);
         
-        while( ($pos = $function($haystack, $needle, $pos)) !== false) 
+        while (($pos = $function($haystack, $needle, $pos)) !== false) 
         {
             $match = mb_substr($haystack, $pos, $length);
             $positions[] = new ConvertHelper_StringMatch($pos, $match);
@@ -1716,7 +1716,7 @@ 
     */
     public static function explodeTrim(string $delimiter, string $string) : array
     {
-        if(empty($string) || empty($delimiter)) {
+        if (empty($string) || empty($delimiter)) {
             return array();
         }
         
@@ -1724,8 +1724,8 @@ 
         $tokens = array_map('trim', $tokens);
         
         $keep = array();
-        foreach($tokens as $token) {
-            if($token !== '') {
+        foreach ($tokens as $token) {
+            if ($token !== '') {
                 $keep[] = $token;
             }
         }
@@ -1743,11 +1743,11 @@ 
     */
     public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL
     {
-        if(empty($subjectString)) {
+        if (empty($subjectString)) {
             return null;
         }
         
-        if(!isset(self::$eolChars))
+        if (!isset(self::$eolChars))
         {
             $cr = chr((int)hexdec('0d'));
             $lf = chr((int)hexdec('0a'));
@@ -1778,18 +1778,18 @@ 
         
         $max = 0;
         $results = array();
-        foreach(self::$eolChars as $def) 
+        foreach (self::$eolChars as $def) 
         {
             $amount = substr_count($subjectString, $def['char']);
             
-            if($amount > $max)
+            if ($amount > $max)
             {
                 $max = $amount;
                 $results[] = $def;
             }
         }
         
-        if(empty($results)) {
+        if (empty($results)) {
             return null;
         }
         
@@ -1809,9 +1809,9 @@ 
     */
     public static function arrayRemoveKeys(array &$array, array $keys) : void
     {
-        foreach($keys as $key) 
+        foreach ($keys as $key) 
         {
-            if(array_key_exists($key, $array)) {
+            if (array_key_exists($key, $array)) {
                 unset($array[$key]); 
             }
         }
@@ -1826,17 +1826,17 @@ 
     */
     public static function isInteger($value) : bool
     {
-        if(is_int($value)) {
+        if (is_int($value)) {
             return true;
         }
         
         // booleans get converted to numbers, so they would
         // actually match the regex.
-        if(is_bool($value)) {
+        if (is_bool($value)) {
             return false;
         }
         
-        if(is_string($value) && $value !== '') {
+        if (is_string($value) && $value !== '') {
             return preg_match('/\A-?\d+\z/', $value) === 1;
         }
         
@@ -1863,7 +1863,7 @@ 
         $d2->add(new \DateInterval('PT'.$seconds.'S'));
         
         $result = $d2->diff($d1);
-        if($result !== false) {
+        if ($result !== false) {
             return $result;
         }