Mistralys / application-utils

src/URLInfo.php

Indentation +144 added lines, -144 removed lines

@@ -37,42 +37,42 @@ 
     const TYPE_PHONE = 'phone';
     const TYPE_URL = 'url';
     
-   /**
-    * The original URL that was passed to the constructor.
-    * @var string
-    */
+    /**
+     * The original URL that was passed to the constructor.
+     * @var string
+     */
     protected $rawURL;
 
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $info;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $excludedParams = array();
     
-   /**
-    * @var bool
-    * @see URLInfo::setParamExclusion()
-    */
+    /**
+     * @var bool
+     * @see URLInfo::setParamExclusion()
+     */
     protected $paramExclusion = false;
     
-   /**
-    * @var array
-    * @see URLInfo::getTypeLabel()
-    */
+    /**
+     * @var array
+     * @see URLInfo::getTypeLabel()
+     */
     protected static $typeLabels;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $highlightExcluded = false;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $infoKeys = array(
         'scheme',
         'host',
@@ -84,19 +84,19 @@ 
         'fragment'
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $url;
     
-   /**
-    * @var URLInfo_Parser
-    */
+    /**
+     * @var URLInfo_Parser
+     */
     protected $parser;
     
-   /**
-    * @var URLInfo_Normalizer
-    */
+    /**
+     * @var URLInfo_Normalizer
+     */
     protected $normalizer;
     
     public function __construct(string $url)
@@ -108,13 +108,13 @@ 
         $this->info = $this->parser->getInfo();
     }
     
-   /**
-    * Filters an URL: removes control characters and the
-    * like to have a clean URL to work with.
-    * 
-    * @param string $url
-    * @return string
-    */
+    /**
+     * Filters an URL: removes control characters and the
+     * like to have a clean URL to work with.
+     * 
+     * @param string $url
+     * @return string
+     */
     public static function filterURL(string $url)
     {
         return URLInfo_Filter::filter($url);
@@ -144,12 +144,12 @@ 
         return $this->info['type'] === self::TYPE_PHONE;
     }
     
-   /**
-    * Whether the URL is a regular URL, not one of the 
-    * other types like a phone number or email address.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the URL is a regular URL, not one of the 
+     * other types like a phone number or email address.
+     * 
+     * @return bool
+     */
     public function isURL() : bool
     {
         $host = $this->getHost();
@@ -161,20 +161,20 @@ 
         return $this->parser->isValid();
     }
     
-   /**
-    * Retrieves the host name, or an empty string if none is present.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the host name, or an empty string if none is present.
+     * 
+     * @return string
+     */
     public function getHost() : string
     {
         return $this->getInfoKey('host');
     }
     
-   /**
-    * Retrieves the path, or an empty string if none is present.
-    * @return string
-    */
+    /**
+     * Retrieves the path, or an empty string if none is present.
+     * @return string
+     */
     public function getPath() : string
     {
         return $this->getInfoKey('path');
@@ -190,10 +190,10 @@ 
         return $this->getInfoKey('scheme');
     }
     
-   /**
-    * Retrieves the port specified in the URL, or -1 if none is preseent.
-    * @return int
-    */
+    /**
+     * Retrieves the port specified in the URL, or -1 if none is preseent.
+     * @return int
+     */
     public function getPort() : int
     {
         $port = $this->getInfoKey('port');
@@ -205,13 +205,13 @@ 
         return -1;
     }
     
-   /**
-    * Retrieves the raw query string, or an empty string if none is present.
-    * 
-    * @return string
-    * 
-    * @see URLInfo::getParams()
-    */
+    /**
+     * Retrieves the raw query string, or an empty string if none is present.
+     * 
+     * @return string
+     * 
+     * @see URLInfo::getParams()
+     */
     public function getQuery() : string
     {
         return $this->getInfoKey('query');
@@ -227,20 +227,20 @@ 
         return $this->getInfoKey('pass');
     }
     
-   /**
-    * Whether the URL contains a port number.
-    * @return bool
-    */
+    /**
+     * Whether the URL contains a port number.
+     * @return bool
+     */
     public function hasPort() : bool
     {
         return $this->getPort() !== -1;
     }
     
-   /**
-    * Alias for the hasParams() method.
-    * @return bool
-    * @see URLInfo::hasParams()
-    */
+    /**
+     * Alias for the hasParams() method.
+     * @return bool
+     * @see URLInfo::hasParams()
+     */
     public function hasQuery() : bool
     {
         return $this->hasParams();
@@ -298,25 +298,25 @@ 
         return $this->normalizer->normalize();
     }
     
-   /**
-    * Creates a hash of the URL, which can be used for comparisons.
-    * Since any parameters in the URL's query are sorted alphabetically,
-    * the same links with a different parameter order will have the 
-    * same hash.
-    * 
-    * @return string
-    */
+    /**
+     * Creates a hash of the URL, which can be used for comparisons.
+     * Since any parameters in the URL's query are sorted alphabetically,
+     * the same links with a different parameter order will have the 
+     * same hash.
+     * 
+     * @return string
+     */
     public function getHash()
     {
         return \AppUtils\ConvertHelper::string2shortHash($this->getNormalized());
     }
 
-   /**
-    * Highlights the URL using HTML tags with specific highlighting
-    * class names.
-    * 
-    * @return string Will return an empty string if the URL is not valid.
-    */
+    /**
+     * Highlights the URL using HTML tags with specific highlighting
+     * class names.
+     * 
+     * @return string Will return an empty string if the URL is not valid.
+     */
     public function getHighlighted() : string
     {
         if(!$this->isValid()) {
@@ -350,15 +350,15 @@ 
         return count($params);
     }
     
-   /**
-    * Retrieves all parameters specified in the url,
-    * if any, as an associative array. 
-    * 
-    * NOTE: Ignores parameters that have been added
-    * to the excluded parameters list.
-    *
-    * @return array
-    */
+    /**
+     * Retrieves all parameters specified in the url,
+     * if any, as an associative array. 
+     * 
+     * NOTE: Ignores parameters that have been added
+     * to the excluded parameters list.
+     *
+     * @return array
+     */
     public function getParams() : array
     {
         if(!$this->paramExclusion || empty($this->excludedParams)) {
@@ -376,22 +376,22 @@ 
         return $keep;
     }
     
-   /**
-    * Retrieves the names of all parameters present in the URL, if any.
-    * @return string[]
-    */
+    /**
+     * Retrieves the names of all parameters present in the URL, if any.
+     * @return string[]
+     */
     public function getParamNames() : array
     {
         $params = $this->getParams();
         return array_keys($params);
     }
     
-   /**
-    * Retrieves a specific parameter value from the URL.
-    * 
-    * @param string $name
-    * @return string The parameter value, or an empty string if it does not exist.
-    */
+    /**
+     * Retrieves a specific parameter value from the URL.
+     * 
+     * @param string $name
+     * @return string The parameter value, or an empty string if it does not exist.
+     */
     public function getParam(string $name) : string
     {
         if(isset($this->info['params'][$name])) {
@@ -401,16 +401,16 @@ 
         return '';
     }
     
-   /**
-    * Excludes an URL parameter entirely if present:
-    * the parser will act as if the parameter was not
-    * even present in the source URL, effectively
-    * stripping it.
-    *
-    * @param string $name
-    * @param string $reason A human readable explanation why this is excluded - used when highlighting links.
-    * @return URLInfo
-    */
+    /**
+     * Excludes an URL parameter entirely if present:
+     * the parser will act as if the parameter was not
+     * even present in the source URL, effectively
+     * stripping it.
+     *
+     * @param string $name
+     * @param string $reason A human readable explanation why this is excluded - used when highlighting links.
+     * @return URLInfo
+     */
     public function excludeParam(string $name, string $reason) : URLInfo
     {
         if(!isset($this->excludedParams[$name]))
@@ -463,25 +463,25 @@ 
         return self::$typeLabels[$this->getType()];
     }
 
-   /**
-    * Whether excluded parameters should be highlighted in
-    * a different color in the URL when using the
-    * {@link URLInfo::getHighlighted()} method.
-    *
-    * @param bool $highlight
-    * @return URLInfo
-    */
+    /**
+     * Whether excluded parameters should be highlighted in
+     * a different color in the URL when using the
+     * {@link URLInfo::getHighlighted()} method.
+     *
+     * @param bool $highlight
+     * @return URLInfo
+     */
     public function setHighlightExcluded(bool $highlight=true) : URLInfo
     {
         $this->highlightExcluded = $highlight;
         return $this;
     }
     
-   /**
-    * Returns an array with all relevant URL information.
-    * 
-    * @return array
-    */
+    /**
+     * Returns an array with all relevant URL information.
+     * 
+     * @return array
+     */
     public function toArray() : array
     {
         return array(
@@ -525,24 +525,24 @@ 
         return $this;
     }
     
-   /**
-    * Whether the parameter exclusion mode is enabled:
-    * In this case, if any parameters have been added to the
-    * exclusion list, all relevant methods will exclude these.
-    *
-    * @return bool
-    */
+    /**
+     * Whether the parameter exclusion mode is enabled:
+     * In this case, if any parameters have been added to the
+     * exclusion list, all relevant methods will exclude these.
+     *
+     * @return bool
+     */
     public function isParamExclusionEnabled() : bool
     {
         return $this->paramExclusion;
     }
     
-   /**
-    * Checks whether the link contains any parameters that
-    * are on the list of excluded parameters.
-    *
-    * @return bool
-    */
+    /**
+     * Checks whether the link contains any parameters that
+     * are on the list of excluded parameters.
+     *
+     * @return bool
+     */
     public function containsExcludedParams() : bool
     {
         if(empty($this->excludedParams)) {

Spacing +20 added lines, -20 removed lines

@@ -198,7 +198,7 @@ 
     {
         $port = $this->getInfoKey('port');
         
-        if(!empty($port)) {
+        if (!empty($port)) {
             return (int)$port;
         }
         
@@ -278,7 +278,7 @@ 
     
     protected function getInfoKey(string $name) : string
     {
-        if(isset($this->info[$name])) {
+        if (isset($this->info[$name])) {
             return (string)$this->info[$name];
         }
         
@@ -287,11 +287,11 @@ 
 
     public function getNormalized() : string
     {
-        if(!$this->isValid()) {
+        if (!$this->isValid()) {
             return '';
         }
         
-        if(!isset($this->normalizer)) {
+        if (!isset($this->normalizer)) {
             $this->normalizer = new URLInfo_Normalizer($this);
         }
         
@@ -319,7 +319,7 @@ 
     */
     public function getHighlighted() : string
     {
-        if(!$this->isValid()) {
+        if (!$this->isValid()) {
             return '';
         }
         
@@ -361,14 +361,14 @@ 
     */
     public function getParams() : array
     {
-        if(!$this->paramExclusion || empty($this->excludedParams)) {
+        if (!$this->paramExclusion || empty($this->excludedParams)) {
             return $this->info['params'];
         }
         
         $keep = array();
-        foreach($this->info['params'] as $name => $value) 
+        foreach ($this->info['params'] as $name => $value) 
         {
-            if(!isset($this->excludedParams[$name])) {
+            if (!isset($this->excludedParams[$name])) {
                 $keep[$name] = $value;
             }
         }
@@ -394,7 +394,7 @@ 
     */
     public function getParam(string $name) : string
     {
-        if(isset($this->info['params'][$name])) {
+        if (isset($this->info['params'][$name])) {
             return $this->info['params'][$name];
         }
         
@@ -413,7 +413,7 @@ 
     */
     public function excludeParam(string $name, string $reason) : URLInfo
     {
-        if(!isset($this->excludedParams[$name]))
+        if (!isset($this->excludedParams[$name]))
         {
             $this->excludedParams[$name] = $reason;
             $this->setParamExclusion();
@@ -439,7 +439,7 @@ 
     
     public function getTypeLabel() : string
     {
-        if(!isset(self::$typeLabels))
+        if (!isset(self::$typeLabels))
         {
             self::$typeLabels = array(
                 self::TYPE_EMAIL => t('Email'),
@@ -451,7 +451,7 @@ 
         
         $type = $this->getType();
         
-        if(!isset(self::$typeLabels[$type]))
+        if (!isset(self::$typeLabels[$type]))
         {
             throw new BaseException(
                 sprintf('Unknown URL type label for type [%s].', $type),
@@ -471,7 +471,7 @@ 
     * @param bool $highlight
     * @return URLInfo
     */
-    public function setHighlightExcluded(bool $highlight=true) : URLInfo
+    public function setHighlightExcluded(bool $highlight = true) : URLInfo
     {
         $this->highlightExcluded = $highlight;
         return $this;
@@ -519,7 +519,7 @@ 
      * @see URLInfo::isParamExclusionEnabled()
      * @see URLInfo::setHighlightExcluded()
      */
-    public function setParamExclusion(bool $enabled=true) : URLInfo
+    public function setParamExclusion(bool $enabled = true) : URLInfo
     {
         $this->paramExclusion = $enabled;
         return $this;
@@ -545,13 +545,13 @@ 
     */
     public function containsExcludedParams() : bool
     {
-        if(empty($this->excludedParams)) {
+        if (empty($this->excludedParams)) {
             return false;
         }
         
         $names = array_keys($this->info['params']);
-        foreach($names as $name) {
-            if(isset($this->excludedParams[$name])) {
+        foreach ($names as $name) {
+            if (isset($this->excludedParams[$name])) {
                 return true;
             }
         }
@@ -567,7 +567,7 @@ 
 
     public function offsetSet($offset, $value) 
     {
-        if(in_array($offset, $this->infoKeys)) {
+        if (in_array($offset, $this->infoKeys)) {
             $this->info[$offset] = $value;
         }
     }
@@ -584,11 +584,11 @@ 
     
     public function offsetGet($offset) 
     {
-        if($offset === 'port') {
+        if ($offset === 'port') {
             return $this->getPort();
         }
         
-        if(in_array($offset, $this->infoKeys)) {
+        if (in_array($offset, $this->infoKeys)) {
             return $this->getInfoKey($offset);
         }
         

src/URLInfo/Normalizer.php

Spacing +3 added lines, -3 removed lines

@@ -56,16 +56,16 @@
     {
         $normalized = $this->info->getScheme().'://'.$this->info->getHost();
         
-        if($this->info->hasPath()) {
+        if ($this->info->hasPath()) {
             $normalized .= $this->info->getPath();
         }
         
         $params = $this->info->getParams();
-        if(!empty($params)) {
+        if (!empty($params)) {
             $normalized .= '?'.http_build_query($params);
         }
         
-        if($this->info->hasFragment()) {
+        if ($this->info->hasFragment()) {
             $normalized .= '#'.$this->info->getFragment();
         }
         

src/Request.php

Indentation +122 added lines, -122 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,48 +254,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 array
-    * @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 array
+     * @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;
@@ -343,14 +343,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])) {
@@ -364,12 +364,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) {
@@ -434,18 +434,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);
@@ -470,13 +470,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);
@@ -487,13 +487,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);
@@ -504,12 +504,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;
@@ -529,12 +529,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');
@@ -549,16 +549,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);
@@ -567,10 +567,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 +35 added lines, -35 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);
         }
         
@@ -143,9 +143,9 @@ 
         
         $exclude = array_merge($exclude, $this->getExcludeParams());
         
-        foreach($exclude as $name) 
+        foreach ($exclude as $name) 
         {
-            if(isset($vars[$name])) 
+            if (isset($vars[$name])) 
             {
                 unset($vars[$name]);
             }
@@ -156,9 +156,9 @@ 
         // remove the HTML_QuickForm2 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) 
+        foreach ($names as $name) 
         {
-            if(strstr($name, '_qf__')) 
+            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];
         }
         
@@ -300,7 +300,7 @@ 
     {
         static $accept;
         
-        if(!isset($accept)) {
+        if (!isset($accept)) {
             $accept = new Request_AcceptHeaders();
         }
         
@@ -319,7 +319,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);
         }
         
@@ -388,10 +388,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);
         }
         
@@ -400,9 +400,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(
@@ -424,10 +424,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');
         }
         
@@ -446,24 +446,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();
         }
         
@@ -480,7 +480,7 @@ 
     public function getJSONAssoc(string $name) : array
     {
         $result = $this->getJSON($name);
-        if(is_array($result)) {
+        if (is_array($result)) {
             return $result;
         }
         
@@ -497,7 +497,7 @@ 
     public function getJSONObject(string $name) : object
     {
         $result = $this->getJSON($name, false);
-        if(is_object($result)) {
+        if (is_object($result)) {
             return $result;
         }
         
@@ -510,10 +510,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);
         }
         
@@ -523,7 +523,7 @@ 
         
         echo $payload;
         
-        if($exit) 
+        if ($exit) 
         {
             exit;
         }
@@ -535,7 +535,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');
@@ -543,7 +543,7 @@ 
         
         echo $html;
         
-        if($exit)
+        if ($exit)
         {
             exit;
         }
@@ -559,7 +559,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/AcceptHeaders.php

Indentation +37 added lines, -37 removed lines

@@ -28,20 +28,20 @@ 
         $this->parse();
     }
     
-   /**
-    * 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'
-    *     ...
-    * )
-    */
+    /**
+     * 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'
+     *     ...
+     * )
+     */
     public function getMimeStrings() : array
     {
         $result = array();
@@ -54,9 +54,9 @@ 
         return $result;
     }
     
-   /**
-    * Checks that an accept header string exists, and tries to parse it.
-    */
+    /**
+     * Checks that an accept header string exists, and tries to parse it.
+     */
     protected function parse() : void
     {
         // we may be in a CLI environment where the headers
@@ -68,11 +68,11 @@ 
         $this->headers = $this->parseHeader($_SERVER['HTTP_ACCEPT']);
     }
     
-   /**
-    * Splits the accept header string and parses the mime types.
-    *  
-    * @param string $acceptHeader 
-    */
+    /**
+     * Splits the accept header string and parses the mime types.
+     *  
+     * @param string $acceptHeader 
+     */
     protected function parseHeader(string $acceptHeader) : array
     {
         $tokens = preg_split('/\s*,\s*/', $acceptHeader);
@@ -89,13 +89,13 @@ 
         return $accept;
     }
     
-   /**
-    * Parses a single mime type entry.
-    * 
-    * @param int $i The position in the accept string
-    * @param string $mime The mime type
-    * @return array
-    */
+    /**
+     * Parses a single mime type entry.
+     * 
+     * @param int $i The position in the accept string
+     * @param string $mime The mime type
+     * @return array
+     */
     protected function parseEntry(int $i, string $mime) : array
     {
         $entry = array(
@@ -125,14 +125,14 @@ 
         return $entry;
     }
     
-   /**
-    * Sorts the mime types collection, first by quality
-    * and then by position in the list.
-    * 
-    * @param array $a
-    * @param array $b
-    * @return number
-    */
+    /**
+     * Sorts the mime types collection, first by quality
+     * and then by position in the list.
+     * 
+     * @param array $a
+     * @param array $b
+     * @return number
+     */
     protected function sortMimeTypes(array $a, array $b)
     {
         /* first tier: highest q factor wins */

Spacing +5 added lines, -5 removed lines

@@ -46,7 +46,7 @@ 
     {
         $result = array();
         
-        foreach($this->headers as $header)
+        foreach ($this->headers as $header)
         {
             $result[] = $header['type'];
         }
@@ -61,7 +61,7 @@ 
     {
         // we may be in a CLI environment where the headers
         // are not populated.
-        if(!isset($_SERVER['HTTP_ACCEPT'])) {
+        if (!isset($_SERVER['HTTP_ACCEPT'])) {
             return;
         }
         
@@ -79,7 +79,7 @@ 
         
         $accept = array();
         
-        foreach($tokens as $i => $term)
+        foreach ($tokens as $i => $term)
         {
             $accept[] = $this->parseEntry($i, $term);
         }
@@ -105,7 +105,7 @@ 
             'type' => null
         );
         
-        if(strstr($mime, ';'))
+        if (strstr($mime, ';'))
         {
             $parts = explode(';', $mime);
             $mime = array_shift($parts);
@@ -114,7 +114,7 @@ 
             // like an URL query string if separated by ampersands;
             $entry['params'] = ConvertHelper::parseQueryString(implode('&', $parts));
                 
-            if(isset($entry['params']['q'])) 
+            if (isset($entry['params']['q'])) 
             {
                 $entry['quality'] = (double)$entry['params']['q'];
             } 

Braces +2 added lines, -4 removed lines

@@ -141,14 +141,12 @@
         if ($diff > 0) 
         {
             $diff = 1;
-        } 
-        else 
+        } else 
         {
             if ($diff < 0) 
             {
                 $diff = -1;
-            } 
-            else 
+            } else 
             {
                 /* tie-breaker: first listed item wins */
                 $diff = $a['pos'] - $b['pos'];