Mistralys / application-utils

src/ConvertHelper/URLFinder.php

Indentation +51 added lines, -51 removed lines

@@ -24,19 +24,19 @@ 
 {
     use Traits_Optionable;
     
-   /**
-    * @see https://gist.github.com/gruber/249502
-    */
+    /**
+     * @see https://gist.github.com/gruber/249502
+     */
     const REGEX_URL = '#(?i)\b((?:[a-z][\w-]+:(?:/{1,3}|[a-z0-9%])|www\d{0,3}[.]|[a-z0-9.\-]+[.][a-z]{2,4}/)(?:[^\s()<>]+|\(([^\s()<>]+|(\([^\s()<>]+\)))*\))+(?:\(([^\s()<>]+|(\([^\s()<>]+\)))*\)|[^\s`!()\[\]{};:\'".,<>?«»“”‘’]))#i';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $subject;
 
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $schemes = array(
         'http',
         'https',
@@ -62,49 +62,49 @@ 
         );
     }
     
-   /**
-    * Whether to enable sorting the URLs alphabetically (disabled by default).
-    * 
-    * @param bool $enabled
-    * @return ConvertHelper_URLFinder
-    */
+    /**
+     * Whether to enable sorting the URLs alphabetically (disabled by default).
+     * 
+     * @param bool $enabled
+     * @return ConvertHelper_URLFinder
+     */
     public function enableSorting(bool $enabled=true) : ConvertHelper_URLFinder
     {
         $this->setOption('sorting', $enabled);
         return $this;
     }
     
-   /**
-    * Whether to include email addresses in the search. 
-    * This is only relevant when using the getURLs()
-    * method.
-    * 
-    * @param bool $include
-    * @return ConvertHelper_URLFinder
-    */
+    /**
+     * Whether to include email addresses in the search. 
+     * This is only relevant when using the getURLs()
+     * method.
+     * 
+     * @param bool $include
+     * @return ConvertHelper_URLFinder
+     */
     public function includeEmails(bool $include=true) : ConvertHelper_URLFinder
     {
         $this->setOption('include-emails', $include);
         return $this;
     }
     
-   /**
-    * Whether to omit the mailto: that is automatically added to all email addresses.
-    * 
-    * @param bool $omit
-    * @return ConvertHelper_URLFinder
-    */
+    /**
+     * Whether to omit the mailto: that is automatically added to all email addresses.
+     * 
+     * @param bool $omit
+     * @return ConvertHelper_URLFinder
+     */
     public function omitMailto(bool $omit=true) : ConvertHelper_URLFinder
     {
         $this->setOption('omit-mailto', $omit);
         return $this;
     }
     
-   /**
-    * Prepares the subject string by adding a newline before all URL schemes,
-    * to make it possible to parse even lists of links separated by commas or
-    * the like (http://domain.com,http://domain2.com).
-    */
+    /**
+     * Prepares the subject string by adding a newline before all URL schemes,
+     * to make it possible to parse even lists of links separated by commas or
+     * the like (http://domain.com,http://domain2.com).
+     */
     private function prepareSubject() : void
     {
         $replaces = array();
@@ -117,11 +117,11 @@ 
         $this->subject = str_replace(array_keys($replaces), array_values($replaces), $this->subject);
     }
     
-   /**
-    * Fetches all URLs that can be found in the subject string.
-    * 
-    * @return string[]
-    */
+    /**
+     * Fetches all URLs that can be found in the subject string.
+     * 
+     * @return string[]
+     */
     public function getURLs() : array
     {
         $this->prepareSubject();
@@ -154,13 +154,13 @@ 
         return $result;
     }
     
-   /**
-    * Retrieves all email addresses from the subject string.
-    * 
-    * @return string[]
-    * 
-    * @see omitMailto()
-    */
+    /**
+     * Retrieves all email addresses from the subject string.
+     * 
+     * @return string[]
+     * 
+     * @see omitMailto()
+     */
     public function getEmails() : array
     {
         $matches = array();
@@ -194,11 +194,11 @@ 
         return 'mailto:';
     }
     
-   /**
-    * Retrieves all URLs as URLInfo instances.
-    * 
-    * @return URLInfo[]
-    */
+    /**
+     * Retrieves all URLs as URLInfo instances.
+     * 
+     * @return URLInfo[]
+     */
     public function getInfos()
     {
         $urls = $this->getURLs();

Spacing +12 added lines, -12 removed lines

@@ -68,7 +68,7 @@ 
     * @param bool $enabled
     * @return ConvertHelper_URLFinder
     */
-    public function enableSorting(bool $enabled=true) : ConvertHelper_URLFinder
+    public function enableSorting(bool $enabled = true) : ConvertHelper_URLFinder
     {
         $this->setOption('sorting', $enabled);
         return $this;
@@ -82,7 +82,7 @@ 
     * @param bool $include
     * @return ConvertHelper_URLFinder
     */
-    public function includeEmails(bool $include=true) : ConvertHelper_URLFinder
+    public function includeEmails(bool $include = true) : ConvertHelper_URLFinder
     {
         $this->setOption('include-emails', $include);
         return $this;
@@ -94,7 +94,7 @@ 
     * @param bool $omit
     * @return ConvertHelper_URLFinder
     */
-    public function omitMailto(bool $omit=true) : ConvertHelper_URLFinder
+    public function omitMailto(bool $omit = true) : ConvertHelper_URLFinder
     {
         $this->setOption('omit-mailto', $omit);
         return $this;
@@ -109,7 +109,7 @@ 
     {
         $replaces = array();
         
-        foreach($this->schemes as $scheme)
+        foreach ($this->schemes as $scheme)
         {
             $replaces[$scheme.':'] = PHP_EOL.$scheme.':';
         }
@@ -131,20 +131,20 @@ 
         
         $result = array();
         
-        foreach($matches[0] as $match)
+        foreach ($matches[0] as $match)
         {
-            if(strstr($match, '://') && !in_array($match, $result))
+            if (strstr($match, '://') && !in_array($match, $result))
             {
                 $result[] = $match;
             }
         }
         
-        if($this->getBoolOption('include-emails'))
+        if ($this->getBoolOption('include-emails'))
         {
             $result = array_merge($result, $this->getEmails());
         }
         
-        if($this->getBoolOption('sorting'))
+        if ($this->getBoolOption('sorting'))
         {
             usort($result, function(string $a, string $b) {
                 return strnatcasecmp($a, $b);
@@ -169,12 +169,12 @@ 
         $result = array();
         $prefix = $this->getEmailPrefix();
         
-        foreach($matches[0] as $email)
+        foreach ($matches[0] as $email)
         {
             $result[] = $prefix.$email;
         }
         
-        if($this->getBoolOption('sorting'))
+        if ($this->getBoolOption('sorting'))
         {
             usort($result, function(string $a, string $b) {
                 return strnatcasecmp($a, $b);
@@ -186,7 +186,7 @@ 
     
     private function getEmailPrefix() : string
     {
-        if($this->getBoolOption('omit-mailto'))
+        if ($this->getBoolOption('omit-mailto'))
         {
             return '';
         }
@@ -205,7 +205,7 @@ 
         
         $result = array();
         
-        foreach($urls as $url)
+        foreach ($urls as $url)
         {
             $result[] = parseURL($url);
         }

src/Request.php

Indentation +142 added lines, -142 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()
     {
         
@@ -126,30 +126,30 @@ 
         return $this->buildURL($params, $dispatcher);
     }
     
-   /**
-    * Retrieves the name of the current dispatcher script / page.
-    * This is made to be extended and implemented in a subclass.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the name of the current dispatcher script / page.
+     * This is made to be extended and implemented in a subclass.
+     * 
+     * @return string
+     */
     public function getDispatcher() : string
     {
         return '';
     }
     
-   /**
-    * Filters and retrieves the current request variables 
-    * to be used to build an URL to refresh the current page.
-    * 
-    * For further customization options, use the 
-    * {@see Request::createRefreshParams()} method.
-    * 
-    * @param array<string,mixed> $params Key => value pairs of parameters to always include in the result.
-    * @param string[] $exclude Names of parameters to exclude from the result.
-    * @return array<string,mixed>
-    * 
-    * @see Request::createRefreshParams()
-    */
+    /**
+     * Filters and retrieves the current request variables 
+     * to be used to build an URL to refresh the current page.
+     * 
+     * For further customization options, use the 
+     * {@see Request::createRefreshParams()} method.
+     * 
+     * @param array<string,mixed> $params Key => value pairs of parameters to always include in the result.
+     * @param string[] $exclude Names of parameters to exclude from the result.
+     * @return array<string,mixed>
+     * 
+     * @see Request::createRefreshParams()
+     */
     public function getRefreshParams(array $params = array(), array $exclude = array())
     {
         return $this->createRefreshParams()
@@ -158,13 +158,13 @@ 
         ->getParams();
     }
     
-   /**
-    * Creates an instance of the helper that can be used to
-    * retrieve the request's parameters collection, with the
-    * possiblity to exlude and override some by rules.
-    * 
-    * @return Request_RefreshParams
-    */
+    /**
+     * Creates an instance of the helper that can be used to
+     * retrieve the request's parameters collection, with the
+     * possiblity to exlude and override some by rules.
+     * 
+     * @return Request_RefreshParams
+     */
     public function createRefreshParams() : Request_RefreshParams
     {
         return new Request_RefreshParams();
@@ -197,10 +197,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;
@@ -230,13 +230,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])) {
@@ -253,48 +253,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;
@@ -342,14 +342,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])) {
@@ -363,12 +363,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) {
@@ -435,18 +435,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);
@@ -471,13 +471,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);
@@ -488,13 +488,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);
@@ -505,12 +505,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;
@@ -530,12 +530,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');
@@ -550,16 +550,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);
@@ -568,10 +568,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 +31 added lines, -31 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);
         }
         
@@ -185,13 +185,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, '', '&');
+            $url .= '?'.http_build_query($params, '', '&');
         }
         
         return $url;
@@ -222,7 +222,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;
         }
@@ -239,7 +239,7 @@ 
     */
     public function getRegisteredParam(string $name) : Request_Param
     {
-        if(isset($this->knownParams[$name])) {
+        if (isset($this->knownParams[$name])) {
             return $this->knownParams[$name];
         }
         
@@ -299,7 +299,7 @@ 
     {
         static $accept;
         
-        if(!isset($accept)) {
+        if (!isset($accept)) {
             $accept = new Request_AcceptHeaders();
         }
         
@@ -318,7 +318,7 @@ 
     {
         $_REQUEST[$name] = $value;
         
-        if(isset($this->knownParams[$name])) {
+        if (isset($this->knownParams[$name])) {
             unset($this->knownParams[$name]);
         }
         
@@ -352,11 +352,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]);
         }
         
@@ -371,7 +371,7 @@ 
     */
     public function removeParams(array $names) : Request
     {
-        foreach($names as $name) {
+        foreach ($names as $name) {
             $this->removeParam($name);
         }
         
@@ -387,10 +387,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);
         }
         
@@ -399,11 +399,11 @@ 
     
     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,
@@ -425,10 +425,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');
         }
         
@@ -447,24 +447,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();
         }
         
@@ -481,7 +481,7 @@ 
     public function getJSONAssoc(string $name) : array
     {
         $result = $this->getJSON($name);
-        if(is_array($result)) {
+        if (is_array($result)) {
             return $result;
         }
         
@@ -498,7 +498,7 @@ 
     public function getJSONObject(string $name) : object
     {
         $result = $this->getJSON($name, false);
-        if(is_object($result)) {
+        if (is_object($result)) {
             return $result;
         }
         
@@ -511,10 +511,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);
         }
         
@@ -524,7 +524,7 @@ 
         
         echo $payload;
         
-        if($exit) 
+        if ($exit) 
         {
             exit;
         }
@@ -536,7 +536,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');
@@ -544,7 +544,7 @@ 
         
         echo $html;
         
-        if($exit)
+        if ($exit)
         {
             exit;
         }
@@ -560,7 +560,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/RefreshParams/Exclude/Name.php

Indentation +3 added lines, -3 removed lines

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

src/Request/RefreshParams/Exclude/Callback.php

Indentation +3 added lines, -3 removed lines

@@ -22,9 +22,9 @@
 {
     const ERROR_INVALID_CALLBACK = 62101;
     
-   /**
-    * @var callable
-    */
+    /**
+     * @var callable
+     */
     private $callback;
     
     public function __construct($callback)

Spacing +1 added lines, -1 removed lines

@@ -29,7 +29,7 @@
     
     public function __construct($callback)
     {
-        if(!is_callable($callback))
+        if (!is_callable($callback))
         {
             throw new Request_Exception(
                 'Invalid exclusion callback',

src/Request/RefreshParams.php

Indentation +96 added lines, -96 removed lines

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

Spacing +11 added lines, -11 removed lines

@@ -48,7 +48,7 @@ 
     * @param bool $exclude
     * @return Request_RefreshParams
     */
-    public function setExcludeSessionName(bool $exclude=true) : Request_RefreshParams
+    public function setExcludeSessionName(bool $exclude = true) : Request_RefreshParams
     {
         $this->setOption('exclude-session-name', $exclude);
         return $this;
@@ -70,7 +70,7 @@ 
     
     public function excludeParamByName(string $paramName) : Request_RefreshParams
     {
-        if($paramName !== '')
+        if ($paramName !== '')
         {
             $this->excludes[] = new Request_RefreshParams_Exclude_Name($paramName);
         }
@@ -107,7 +107,7 @@ 
     */
     public function excludeParamsByName(array $paramNames) : Request_RefreshParams
     {
-        foreach($paramNames as $name)
+        foreach ($paramNames as $name)
         {
             $this->excludeParamByName((string)$name);
         }
@@ -139,7 +139,7 @@ 
     */
     public function overrideParams(array $params) : Request_RefreshParams
     {
-        foreach($params as $name => $value)
+        foreach ($params as $name => $value)
         {
             $this->overrideParam((string)$name, $value);
         }
@@ -173,7 +173,7 @@ 
     */
     private function autoExcludeSessionName(array &$excludes) : void
     {
-        if($this->getBoolOption('exclude-session-name'))
+        if ($this->getBoolOption('exclude-session-name'))
         {
             $excludes[] = new Request_RefreshParams_Exclude_Name(session_name());
         }
@@ -187,7 +187,7 @@ 
     */
     private function autoExcludeQuickform(array &$excludes) : void
     {
-        if($this->getBoolOption('exclude-quickform-submitter'))
+        if ($this->getBoolOption('exclude-quickform-submitter'))
         {
             $excludes[] = new Request_RefreshParams_Exclude_Callback(function(string $paramName)
             {
@@ -209,7 +209,7 @@ 
         // Note: using this loop instead of array_merge,
         // because array_merge has weird behavior when
         // using numeric keys.
-        foreach($this->overrides as $name => $val)
+        foreach ($this->overrides as $name => $val)
         {
             $params[$name] = $val;
         }
@@ -227,11 +227,11 @@ 
     {
         $result = array();
         
-        foreach($params as $name => $value)
+        foreach ($params as $name => $value)
         {
             $name = (string)$name;
             
-            if(!$this->isExcluded($name, $value))
+            if (!$this->isExcluded($name, $value))
             {
                 $result[$name] = $value;
             }
@@ -252,9 +252,9 @@ 
     {
         $excludes = $this->resolveExcludes();
         
-        foreach($excludes as $exclude)
+        foreach ($excludes as $exclude)
         {
-            if($exclude->isExcluded($paramName, $paramValue))
+            if ($exclude->isExcluded($paramName, $paramValue))
             {
                 return true;
             }

src/RequestHelper.php

Spacing +12 added lines, -12 removed lines

@@ -241,7 +241,7 @@ 
 
         $output = curl_exec($ch);
 
-        if(isset($this->logfilePointer))
+        if (isset($this->logfilePointer))
         {
             fclose($this->logfilePointer);
         }
@@ -253,7 +253,7 @@ 
         // CURL will complain about an empty response when the 
         // server sends a 100-continue code. That should not be
         // regarded as an error.
-        if($output === false && $this->response->getCode() !== 100)
+        if ($output === false && $this->response->getCode() !== 100)
         {
             $curlCode = curl_errno($ch);
             
@@ -289,7 +289,7 @@ 
     {
         $ch = curl_init();
         
-        if(!is_resource($ch))
+        if (!is_resource($ch))
         {
             throw new RequestHelper_Exception(
                 'Could not initialize a new cURL instance.',
@@ -299,7 +299,7 @@ 
         }
 
         $this->setHeader('Content-Length', (string)$this->boundaries->getContentLength());
-        $this->setHeader('Content-Type', 'multipart/form-data; boundary=' . $this->mimeBoundary);
+        $this->setHeader('Content-Type', 'multipart/form-data; boundary='.$this->mimeBoundary);
 
         curl_setopt($ch, CURLOPT_POST, true);
         curl_setopt($ch, CURLOPT_URL, $url->getNormalizedWithoutAuth());
@@ -312,18 +312,18 @@ 
         
         $loggingEnabled = $this->configureLogging($ch);
         
-        if(!$loggingEnabled) 
+        if (!$loggingEnabled) 
         {
             curl_setopt($ch, CURLINFO_HEADER_OUT, true);
         }
         
-        if($this->verifySSL)
+        if ($this->verifySSL)
         {
             curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
             curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
         }
         
-        if($url->hasUsername())
+        if ($url->hasUsername())
         {
             curl_setopt($ch, CURLOPT_USERNAME, $url->getUsername());
             curl_setopt($ch, CURLOPT_PASSWORD, $url->getPassword());
@@ -338,14 +338,14 @@ 
     */
     protected function configureLogging($ch) : bool
     {
-        if(empty($this->logfile))
+        if (empty($this->logfile))
         {
             return false;
         }
         
         $res = fopen($this->logfile, 'w+');
         
-        if($res === false)
+        if ($res === false)
         {
             throw new RequestHelper_Exception(
                 'Cannot open logfile for writing.',
@@ -375,7 +375,7 @@ 
         
         $this->setHeader('Expect', '');
         
-        foreach($this->headers as $name => $value) {
+        foreach ($this->headers as $name => $value) {
             $result[] = $name.': '.$value;
         }
         
@@ -392,7 +392,7 @@ 
     {
         $response = $this->getResponse();
         
-        if($response !== null) {
+        if ($response !== null) {
             return $response->getHeaders();
         }
 
@@ -428,7 +428,7 @@ 
     */
     public function getHeader(string $name) : string
     {
-        if(isset($this->headers[$name]))
+        if (isset($this->headers[$name]))
         {
             return $this->headers[$name];
         }

Braces +1 added lines, -2 removed lines

@@ -261,8 +261,7 @@
                 $curlCode,
                 curl_error($ch).' | Explanation: '.curl_strerror($curlCode)
             );
-        }
-        else
+        } else
         {
             $this->response->setBody((string)$output);
         }

Indentation +151 added lines, -151 removed lines

@@ -32,62 +32,62 @@ 
     const ERROR_CURL_INIT_FAILED = 17903;
     const ERROR_CANNOT_OPEN_LOGFILE = 17904;
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $eol = "\r\n";
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $mimeBoundary;
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $destination;
 
-   /**
-    * @var array<string,string>
-    */
+    /**
+     * @var array<string,string>
+     */
     protected $headers = array();
     
-   /**
-    * Whether to verify SSL certificates.
-    * @var bool
-    */
+    /**
+     * Whether to verify SSL certificates.
+     * @var bool
+     */
     protected $verifySSL = true;
     
-   /**
-    * @var RequestHelper_Boundaries
-    */
+    /**
+     * @var RequestHelper_Boundaries
+     */
     protected $boundaries;
     
-   /**
-    * @var RequestHelper_Response|NULL
-    */
+    /**
+     * @var RequestHelper_Response|NULL
+     */
     protected $response;
 
-   /**
-    * Timeout duration, in seconds.
-    * @var integer
-    */
+    /**
+     * Timeout duration, in seconds.
+     * @var integer
+     */
     protected $timeout = 30;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $logfile = '';
 
-   /**
-    * @var resource|NULL
-    */
+    /**
+     * @var resource|NULL
+     */
     protected $logfilePointer = null;
     
-   /**
-    * Creates a new request helper to send POST data to the specified destination URL.
-    * @param string $destinationURL
-    */
+    /**
+     * Creates a new request helper to send POST data to the specified destination URL.
+     * @param string $destinationURL
+     */
     public function __construct(string $destinationURL)
     {
         $this->destination = $destinationURL;
@@ -112,13 +112,13 @@ 
         return $this->eol;
     }
     
-   /**
-    * Sets the timeout for the request, in seconds. If the request
-    * takes longer, it will be cancelled and an exception triggered.
-    * 
-    * @param int $seconds
-    * @return RequestHelper
-    */
+    /**
+     * Sets the timeout for the request, in seconds. If the request
+     * takes longer, it will be cancelled and an exception triggered.
+     * 
+     * @param int $seconds
+     * @return RequestHelper
+     */
     public function setTimeout(int $seconds) : RequestHelper
     {
         $this->timeout = $seconds;
@@ -131,13 +131,13 @@ 
         return $this->timeout;
     }
     
-   /**
-    * Enables verbose logging of the CURL request, which
-    * is then redirected to the target file.
-    * 
-    * @param string $targetFile
-    * @return RequestHelper
-    */
+    /**
+     * Enables verbose logging of the CURL request, which
+     * is then redirected to the target file.
+     * 
+     * @param string $targetFile
+     * @return RequestHelper
+     */
     public function enableLogging(string $targetFile) : RequestHelper
     {
         $this->logfile = $targetFile;
@@ -145,15 +145,15 @@ 
         return $this;
     }
 
-   /**
-    * Adds a file to be sent with the request.
-    *
-    * @param string $varName The variable name to send the file in
-    * @param string $fileName The name of the file as it should be received at the destination
-    * @param string $content The raw content of the file
-    * @param string $contentType The content type, use the constants to specify this
-    * @param string $encoding The encoding of the file, use the constants to specify this
-    */
+    /**
+     * Adds a file to be sent with the request.
+     *
+     * @param string $varName The variable name to send the file in
+     * @param string $fileName The name of the file as it should be received at the destination
+     * @param string $content The raw content of the file
+     * @param string $contentType The content type, use the constants to specify this
+     * @param string $encoding The encoding of the file, use the constants to specify this
+     */
     public function addFile(string $varName, string $fileName, string $content, string $contentType = '', string $encoding = '') : RequestHelper
     {
         $this->boundaries->addFile($varName, $fileName, $content, $contentType, $encoding);
@@ -161,13 +161,13 @@ 
         return $this;
     }
     
-   /**
-    * Adds arbitrary content.
-    * 
-    * @param string $varName The variable name to send the content in.
-    * @param string $content
-    * @param string $contentType
-    */
+    /**
+     * Adds arbitrary content.
+     * 
+     * @param string $varName The variable name to send the content in.
+     * @param string $content
+     * @param string $contentType
+     */
     public function addContent(string $varName, string $content, string $contentType) : RequestHelper
     {
         $this->boundaries->addContent($varName, $content, $contentType);
@@ -175,13 +175,13 @@ 
         return $this;
     }
 
-   /**
-    * Adds a variable to be sent with the request. If it
-    * already exists, its value is overwritten.
-    *
-    * @param string $name
-    * @param string $value
-    */
+    /**
+     * Adds a variable to be sent with the request. If it
+     * already exists, its value is overwritten.
+     *
+     * @param string $name
+     * @param string $value
+     */
     public function addVariable(string $name, string $value) : RequestHelper
     {
         $this->boundaries->addVariable($name, $value);
@@ -189,13 +189,13 @@ 
         return $this;
     }
     
-   /**
-    * Sets an HTTP header to include in the request.
-    * 
-    * @param string $name
-    * @param string $value
-    * @return RequestHelper
-    */
+    /**
+     * Sets an HTTP header to include in the request.
+     * 
+     * @param string $name
+     * @param string $value
+     * @return RequestHelper
+     */
     public function setHeader(string $name, string $value) : RequestHelper
     {
         $this->headers[$name] = $value;
@@ -203,36 +203,36 @@ 
         return $this;
     }
     
-   /**
-    * Disables SSL certificate checking.
-    * 
-    * @return RequestHelper
-    */
+    /**
+     * Disables SSL certificate checking.
+     * 
+     * @return RequestHelper
+     */
     public function disableSSLChecks() : RequestHelper
     {
         $this->verifySSL = false;
         return $this;
     }
    
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $contentLength = 0;
 
-   /**
-    * Sends the POST request to the destination, and returns
-    * the response text.
-    *
-    * The response object is stored internally, so after calling
-    * this method it may be retrieved at any moment using the
-    * {@link getResponse()} method.
-    *
-    * @return string
-    * @see RequestHelper::getResponse()
-    * @throws RequestHelper_Exception
-    * 
-    * @see RequestHelper::ERROR_REQUEST_FAILED
-    */
+    /**
+     * Sends the POST request to the destination, and returns
+     * the response text.
+     *
+     * The response object is stored internally, so after calling
+     * this method it may be retrieved at any moment using the
+     * {@link getResponse()} method.
+     *
+     * @return string
+     * @see RequestHelper::getResponse()
+     * @throws RequestHelper_Exception
+     * 
+     * @see RequestHelper::ERROR_REQUEST_FAILED
+     */
     public function send() : string
     {
         $info = parseURL($this->destination);
@@ -272,26 +272,26 @@ 
         return $this->response->getResponseBody();
     }
     
-   /**
-    * Retrieves the request's body content. This is an alias
-    * for {@see RequestHelper::getMimeBody()}.
-    * 
-    * @return string
-    * @see RequestHelper::getMimeBody()
-    */
+    /**
+     * Retrieves the request's body content. This is an alias
+     * for {@see RequestHelper::getMimeBody()}.
+     * 
+     * @return string
+     * @see RequestHelper::getMimeBody()
+     */
     public function getBody() : string
     {
         return $this->getMimeBody();
     }
     
-   /**
-    * Creates a new CURL resource configured according to the
-    * request's settings.
-    * 
-    * @param URLInfo $url
-    * @throws RequestHelper_Exception
-    * @return resource
-    */
+    /**
+     * Creates a new CURL resource configured according to the
+     * request's settings.
+     * 
+     * @param URLInfo $url
+     * @throws RequestHelper_Exception
+     * @return resource
+     */
     protected function createCURL(URLInfo $url)
     {
         $ch = curl_init();
@@ -339,10 +339,10 @@ 
         return $ch;
     }
     
-   /**
-    * @param resource $ch
-    * @return bool Whether logging is enabled.
-    */
+    /**
+     * @param resource $ch
+     * @return bool Whether logging is enabled.
+     */
     protected function configureLogging($ch) : bool
     {
         if(empty($this->logfile))
@@ -369,13 +369,13 @@ 
         return true;
     }
 
-   /**
-    * Compiles the associative headers array into
-    * the format understood by CURL, namely an indexed
-    * array with one header string per entry.
-    * 
-    * @return array
-    */
+    /**
+     * Compiles the associative headers array into
+     * the format understood by CURL, namely an indexed
+     * array with one header string per entry.
+     * 
+     * @return array
+     */
     protected function renderHeaders() : array
     {
         $result = array();
@@ -389,12 +389,12 @@ 
         return $result;
     }
     
-   /**
-    * Retrieves the raw response header, in the form of an indexed
-    * array containing all response header lines.
-    * 
-    * @return array
-    */
+    /**
+     * Retrieves the raw response header, in the form of an indexed
+     * array containing all response header lines.
+     * 
+     * @return array
+     */
     public function getResponseHeader() : array
     {
         $response = $this->getResponse();
@@ -406,33 +406,33 @@ 
         return array();
     }
 
-   /**
-    * After calling the {@link send()} method, this may be used to
-    * retrieve the response text from the POST request.
-    *
-    * @return RequestHelper_Response|NULL
-    */
+    /**
+     * After calling the {@link send()} method, this may be used to
+     * retrieve the response text from the POST request.
+     *
+     * @return RequestHelper_Response|NULL
+     */
     public function getResponse() : ?RequestHelper_Response
     {
         return $this->response;
     }
     
-   /**
-    * Retrieves all headers set until now.
-    * 
-    * @return array<string,string>
-    */
+    /**
+     * Retrieves all headers set until now.
+     * 
+     * @return array<string,string>
+     */
     public function getHeaders() : array
     {
         return $this->headers;
     }
     
-   /**
-    * Retrieves the value of a header by its name.
-    * 
-    * @param string $name
-    * @return string The header value, or an empty string if not set.
-    */
+    /**
+     * Retrieves the value of a header by its name.
+     * 
+     * @param string $name
+     * @return string The header value, or an empty string if not set.
+     */
     public function getHeader(string $name) : string
     {
         if(isset($this->headers[$name]))

src/StringBuilder/Interface.php

Indentation +3 added lines, -3 removed lines

@@ -25,17 +25,17 @@
      * 
      * @return string
      */
-     function render() : string;
+        function render() : string;
      
     /**
      * Converts the string builder to a string.
      * 
      * @return string
      */
-     function __toString();
+        function __toString();
      
     /**
      * Renders the string and echos it.
      */
-     function display() : void;
+        function display() : void;
 }

src/XMLHelper.php

Indentation +172 added lines, -172 removed lines

@@ -28,9 +28,9 @@ 
 {
     const ERROR_CANNOT_APPEND_FRAGMENT = 491001; 
 
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private static $simulation = false;
 
     /**
@@ -38,11 +38,11 @@ 
      */
     private $dom;
     
-   /**
-    * Creates a new XMLHelper instance.
-    * 
-    * @return XMLHelper
-    */
+    /**
+     * Creates a new XMLHelper instance.
+     * 
+     * @return XMLHelper
+     */
     public static function create() : XMLHelper
     {
         $dom = new DOMDocument('1.0', 'UTF-8');
@@ -51,72 +51,72 @@ 
         return new XMLHelper($dom);
     }
     
-   /**
-    * Creates a converter instance from an XML file.
-    * @param string $xmlFile
-    * @return XMLHelper_Converter
-    */
+    /**
+     * Creates a converter instance from an XML file.
+     * @param string $xmlFile
+     * @return XMLHelper_Converter
+     */
     public static function convertFile(string $xmlFile) : XMLHelper_Converter
     {
         return XMLHelper_Converter::fromFile($xmlFile);
     }
     
-   /**
-    * Creates a converter from an XML string.
-    * @param string $xmlString
-    * @return XMLHelper_Converter
-    */
+    /**
+     * Creates a converter from an XML string.
+     * @param string $xmlString
+     * @return XMLHelper_Converter
+     */
     public static function convertString(string $xmlString) : XMLHelper_Converter
     {
         return XMLHelper_Converter::fromString($xmlString);
     }
 
-   /**
-    * Creates a converter from a SimpleXMLElement instance.
-    * @param SimpleXMLElement $element
-    * @return XMLHelper_Converter
-    */
+    /**
+     * Creates a converter from a SimpleXMLElement instance.
+     * @param SimpleXMLElement $element
+     * @return XMLHelper_Converter
+     */
     public static function convertElement(SimpleXMLElement $element) : XMLHelper_Converter
     {
         return XMLHelper_Converter::fromElement($element);
     }
    
-   /**
-    * Creates a converter from a DOMElement instance.
-    * @param DOMElement $element
-    * @return XMLHelper_Converter
-    */
+    /**
+     * Creates a converter from a DOMElement instance.
+     * @param DOMElement $element
+     * @return XMLHelper_Converter
+     */
     public static function convertDOMElement(DOMElement $element) : XMLHelper_Converter
     {
         return XMLHelper_Converter::fromDOMElement($element);
     }
 
-   /**
-    * Creates a new helper using an existing DOMDocument object.
-    * @param DOMDocument $dom
-    */
+    /**
+     * Creates a new helper using an existing DOMDocument object.
+     * @param DOMDocument $dom
+     */
     public function __construct(DOMDocument $dom)
     {
         $this->dom = $dom;
     }
 
-   /**
-    * @return DOMDocument
-    */
+    /**
+     * @return DOMDocument
+     */
     public function getDOM() : DOMDocument
     {
         return $this->dom;
     }
 
-   /**
-    * Adds an attribute to an existing tag with
-    * the specified value.
-    *
-    * @param DOMNode $parent
-    * @param string $name
-    * @param mixed $value
-    * @return DOMNode
-    */
+    /**
+     * Adds an attribute to an existing tag with
+     * the specified value.
+     *
+     * @param DOMNode $parent
+     * @param string $name
+     * @param mixed $value
+     * @return DOMNode
+     */
     public function addAttribute(DOMNode $parent, string $name, $value)
     {
         $node = $this->dom->createAttribute($name);
@@ -126,12 +126,12 @@ 
         return $parent->appendChild($node);
     }
 
-   /**
-    * Adds several attributes to the target node.
-    * 
-    * @param DOMNode $parent
-    * @param array<string,mixed> $attributes
-    */
+    /**
+     * Adds several attributes to the target node.
+     * 
+     * @param DOMNode $parent
+     * @param array<string,mixed> $attributes
+     */
     public function addAttributes(DOMNode $parent, array $attributes) : void
     {
         foreach ($attributes as $name => $value) {
@@ -139,14 +139,14 @@ 
         }
     }
 
-   /**
-    * Adds a tag without content.
-    *
-    * @param DOMNode $parent
-    * @param string $name
-    * @param integer $indent
-    * @return DOMNode
-    */
+    /**
+     * Adds a tag without content.
+     *
+     * @param DOMNode $parent
+     * @param string $name
+     * @param integer $indent
+     * @return DOMNode
+     */
     public function addTag(DOMNode $parent, string $name, int $indent = 0) : DOMNode
     {
         if ($indent > 0) {
@@ -168,17 +168,17 @@ 
         $parent->appendChild($this->dom->createTextNode(str_repeat("\t", $amount)));
     }
 
-   /**
-    * Adds a tag with textual content, like:
-    *
-    * <tagname>text</tagname>
-    *
-    * @param DOMNode $parent
-    * @param string $name
-    * @param string $text
-    * @param integer $indent
-    * @return DOMNode
-    */
+    /**
+     * Adds a tag with textual content, like:
+     *
+     * <tagname>text</tagname>
+     *
+     * @param DOMNode $parent
+     * @param string $name
+     * @param string $text
+     * @param integer $indent
+     * @return DOMNode
+     */
     public function addTextTag(DOMNode $parent, string $name, string $text, int $indent = 0) : DOMNode
     {
         if ($indent > 0) {
@@ -192,19 +192,19 @@ 
         return $parent->appendChild($tag);
     }
 
-   /**
-    * Adds a tag with textual content, like:
-    *
-    * <tagname>text</tagname>
-    *
-    * and removes <p> tags
-    *
-    * @param DOMNode $parent
-    * @param string $name
-    * @param string $text
-    * @param integer $indent
-    * @return DOMNode
-    */
+    /**
+     * Adds a tag with textual content, like:
+     *
+     * <tagname>text</tagname>
+     *
+     * and removes <p> tags
+     *
+     * @param DOMNode $parent
+     * @param string $name
+     * @param string $text
+     * @param integer $indent
+     * @return DOMNode
+     */
     public function addEscapedTag(DOMNode $parent, string $name, string $text, int $indent = 0)
     {
         if ($indent > 0) {
@@ -220,19 +220,19 @@ 
         return $parent->appendChild($tag);
     }
 
-   /**
-    * Adds a tag with HTML content, like:
-    *
-    * <tagname><i>text</i></tagname>
-    *
-    * Tags will not be escaped.
-    *
-    * @param DOMNode $parent
-    * @param string $name
-    * @param string $text
-    * @param integer $indent
-    * @return DOMNode
-    */
+    /**
+     * Adds a tag with HTML content, like:
+     *
+     * <tagname><i>text</i></tagname>
+     *
+     * Tags will not be escaped.
+     *
+     * @param DOMNode $parent
+     * @param string $name
+     * @param string $text
+     * @param integer $indent
+     * @return DOMNode
+     */
     public function addFragmentTag(DOMNode $parent, string $name, string $text, int $indent = 0)
     {
         if ($indent > 0) {
@@ -260,16 +260,16 @@ 
         return $parent->appendChild($tag);
     }
 
-   /**
-    * Adds a tag with CDATA content, like:
-    *
-    * <tagname><![CDATA[value]]></tagname>
-    *
-    * @param DOMNode $parent
-    * @param string $name
-    * @param string $content
-    * @return DOMNode
-    */
+    /**
+     * Adds a tag with CDATA content, like:
+     *
+     * <tagname><![CDATA[value]]></tagname>
+     *
+     * @param DOMNode $parent
+     * @param string $name
+     * @param string $content
+     * @return DOMNode
+     */
     public function addCDATATag(DOMNode $parent, string $name, string $content) : DOMNode
     {
         $tag = $this->dom->createElement($name);
@@ -279,12 +279,12 @@ 
         return $parent->appendChild($tag);
     }
 
-   /**
-    * Creates the root element of the document.
-    * @param string $name
-    * @param array<string,mixed> $attributes
-    * @return DOMNode
-    */
+    /**
+     * Creates the root element of the document.
+     * @param string $name
+     * @param array<string,mixed> $attributes
+     * @return DOMNode
+     */
     public function createRoot(string $name, array $attributes=array())
     {
         $root = $this->dom->appendChild($this->dom->createElement($name));
@@ -292,12 +292,12 @@ 
         return $root;
     }
 
-   /**
-    * Escaped the string for use in XML.
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Escaped the string for use in XML.
+     * 
+     * @param string $string
+     * @return string
+     */
     public function escape(string $string) : string
     {
         $string = preg_replace('#<p>(.*)</p>#isUm', '$1', $string);
@@ -317,18 +317,18 @@ 
         return $string;
     }
 
-   /**
-    * Sends the specified XML string to the browser with
-    * the correct headers to trigger a download of the XML
-    * to a local file.
-    * 
-    * NOTE: Ensure calling exit after this is done, and to
-    * not send additional content, which would corrupt the 
-    * download.
-    *
-    * @param string $xml
-    * @param string $filename
-    */
+    /**
+     * Sends the specified XML string to the browser with
+     * the correct headers to trigger a download of the XML
+     * to a local file.
+     * 
+     * NOTE: Ensure calling exit after this is done, and to
+     * not send additional content, which would corrupt the 
+     * download.
+     *
+     * @param string $xml
+     * @param string $filename
+     */
     public static function downloadXML(string $xml, string $filename = 'download.xml') : void
     {
         if(!headers_sent() && !self::$simulation) 
@@ -339,12 +339,12 @@ 
         echo $xml;
     }
 
-   /**
-    * Sends the specified XML string to the browser with
-    * the correct headers and terminates the request.
-    *
-    * @param string $xml
-    */
+    /**
+     * Sends the specified XML string to the browser with
+     * the correct headers and terminates the request.
+     *
+     * @param string $xml
+     */
     public static function displayXML(string $xml) : void
     {
         if(!headers_sent() && !self::$simulation) 
@@ -411,23 +411,23 @@ 
         return $xml->saveXML();
     }
 
-   /**
-    * Creates XML markup to describe an application error
-    * when using XML services. Creates XML with the
-    * following structure:
-    *
-    * <error>
-    *     <id>99</id>
-    *     <message>Full error message text</message>
-    *     <title>Short error label</title>
-    * </error>
-    *
-    * @param string|number $code
-    * @param string $message
-    * @param string $title
-    * @param array<string,string> $customInfo
-    * @return string
-    */
+    /**
+     * Creates XML markup to describe an application error
+     * when using XML services. Creates XML with the
+     * following structure:
+     *
+     * <error>
+     *     <id>99</id>
+     *     <message>Full error message text</message>
+     *     <title>Short error label</title>
+     * </error>
+     *
+     * @param string|number $code
+     * @param string $message
+     * @param string $title
+     * @param array<string,string> $customInfo
+     * @return string
+     */
     public static function buildErrorXML($code, string $message, string $title, array $customInfo=array())
     {
         $xml = new DOMDocument('1.0', 'UTF-8');
@@ -460,31 +460,31 @@ 
         return $this->dom->saveXML();
     }
     
-   /**
-    * Creates a new SimpleXML helper instance: this
-    * object is useful to work with loading XML strings
-    * and files with easy access to any errors that 
-    * may occurr, since the simplexml functions can be
-    * somewhat cryptic.
-    * 
-    * @return XMLHelper_SimpleXML
-    */
+    /**
+     * Creates a new SimpleXML helper instance: this
+     * object is useful to work with loading XML strings
+     * and files with easy access to any errors that 
+     * may occurr, since the simplexml functions can be
+     * somewhat cryptic.
+     * 
+     * @return XMLHelper_SimpleXML
+     */
     public static function createSimplexml() : XMLHelper_SimpleXML
     {
         return new XMLHelper_SimpleXML();
     }
     
-   /**
-    * Converts a string to valid XML: can be a text only string
-    * or an HTML string. Returns valid XML code.
-    * 
-    * NOTE: The string may contain custom tags, which are 
-    * preserved.
-    * 
-    * @param string $string
-    * @throws XMLHelper_Exception
-    * @return string
-    */
+    /**
+     * Converts a string to valid XML: can be a text only string
+     * or an HTML string. Returns valid XML code.
+     * 
+     * NOTE: The string may contain custom tags, which are 
+     * preserved.
+     * 
+     * @param string $string
+     * @throws XMLHelper_Exception
+     * @return string
+     */
     public static function string2xml(string $string) : string
     {
         return XMLHelper_HTMLLoader::loadFragment($string)->fragmentToXML();

Spacing +14 added lines, -14 removed lines

@@ -243,7 +243,7 @@ 
 
         if (!empty($text)) {
             $fragment = $this->dom->createDocumentFragment();
-            if(!@$fragment->appendXML($text)) {
+            if (!@$fragment->appendXML($text)) {
                 throw new XMLHelper_Exception(
                     'Cannot append XML fragment',
                     sprintf(
@@ -285,7 +285,7 @@ 
     * @param array<string,mixed> $attributes
     * @return DOMNode
     */
-    public function createRoot(string $name, array $attributes=array())
+    public function createRoot(string $name, array $attributes = array())
     {
         $root = $this->dom->appendChild($this->dom->createElement($name));
         $this->addAttributes($root, $attributes);
@@ -311,8 +311,8 @@ 
         $string = str_replace('&lt;', 'LT_ESCAPE', $string);
         $string = str_replace('&gt;', 'GT_ESCAPE', $string);
 
-        $string = str_replace('&nbsp;',' ',  $string);
-        $string = str_replace('&','&amp;',  $string);
+        $string = str_replace('&nbsp;', ' ', $string);
+        $string = str_replace('&', '&amp;', $string);
 
         return $string;
     }
@@ -331,9 +331,9 @@ 
     */
     public static function downloadXML(string $xml, string $filename = 'download.xml') : void
     {
-        if(!headers_sent() && !self::$simulation) 
+        if (!headers_sent() && !self::$simulation) 
         {
-            header('Content-Disposition: attachment; filename="' . $filename . '"');
+            header('Content-Disposition: attachment; filename="'.$filename.'"');
         }
         
         echo $xml;
@@ -347,12 +347,12 @@ 
     */
     public static function displayXML(string $xml) : void
     {
-        if(!headers_sent() && !self::$simulation) 
+        if (!headers_sent() && !self::$simulation) 
         {
             header('Content-Type:text/xml; charset=utf-8');
         }
         
-        if(self::$simulation) 
+        if (self::$simulation) 
         {
             $xml = '<pre>'.htmlspecialchars($xml).'</pre>';
         }
@@ -370,16 +370,16 @@ 
      * @param array<string,string> $customInfo Associative array with name => value pairs for custom tags to add to the output xml
      * @see buildErrorXML()
      */
-    public static function displayErrorXML($code, string $message, string $title, array $customInfo=array())
+    public static function displayErrorXML($code, string $message, string $title, array $customInfo = array())
     {
-        if(!headers_sent() && !self::$simulation) {
-            header('HTTP/1.1 400 Bad Request: ' . $title, true, 400);
+        if (!headers_sent() && !self::$simulation) {
+            header('HTTP/1.1 400 Bad Request: '.$title, true, 400);
         }
 
         self::displayXML(self::buildErrorXML($code, $message, $title, $customInfo));
     }
     
-    public static function setSimulation(bool $simulate=true) : void
+    public static function setSimulation(bool $simulate = true) : void
     {
         self::$simulation = $simulate;
     }
@@ -428,7 +428,7 @@ 
     * @param array<string,string> $customInfo
     * @return string
     */
-    public static function buildErrorXML($code, string $message, string $title, array $customInfo=array())
+    public static function buildErrorXML($code, string $message, string $title, array $customInfo = array())
     {
         $xml = new DOMDocument('1.0', 'UTF-8');
         $xml->formatOutput = true;
@@ -442,7 +442,7 @@ 
         $helper->addTextTag($root, 'title', $title);
         $helper->addTextTag($root, 'request_uri', $_SERVER['REQUEST_URI']);
         
-        foreach($customInfo as $name => $value) {
+        foreach ($customInfo as $name => $value) {
             $helper->addTextTag($root, $name, $value);
         }
 

src/Highlighter.php

Indentation +70 added lines, -70 removed lines

@@ -41,71 +41,71 @@ 
  */
 class Highlighter
 {
-   /**
-    * Creates a new GeSHi instance from a source code string.
-    * 
-    * @param string $sourceCode
-    * @param string $format
-    * @return GeSHi
-    */
+    /**
+     * Creates a new GeSHi instance from a source code string.
+     * 
+     * @param string $sourceCode
+     * @param string $format
+     * @return GeSHi
+     */
     public static function fromString(string $sourceCode, string $format) : GeSHi
     {
         return new GeSHi($sourceCode, $format);
     }
     
-   /**
-    * Creates a new GeSHi instance from the contents of a file.
-    * 
-    * @param string $path
-    * @param string $format
-    * @return GeSHi
-    */
+    /**
+     * Creates a new GeSHi instance from the contents of a file.
+     * 
+     * @param string $path
+     * @param string $format
+     * @return GeSHi
+     */
     public static function fromFile(string $path, string $format) : GeSHi
     {
         return self::fromString(FileHelper::readContents($path), $format);
     }
     
-   /**
-    * Parses and highlights the target string.
-    * 
-    * @param string $sourceCode
-    * @param string $format
-    * @return string
-    */
+    /**
+     * Parses and highlights the target string.
+     * 
+     * @param string $sourceCode
+     * @param string $format
+     * @return string
+     */
     public static function parseString(string $sourceCode, string $format) : string
     {
         return self::fromString($sourceCode, $format)->parse_code();
     }
     
-   /**
-    * Parses and highlights the contents of the target file.
-    * 
-    * @param string $path
-    * @param string $format
-    * @return string
-    */
+    /**
+     * Parses and highlights the contents of the target file.
+     * 
+     * @param string $path
+     * @param string $format
+     * @return string
+     */
     public static function parseFile(string $path, string $format) : string
     {
         return self::fromFile($path, $format)->parse_code();
     }
     
-   /**
-    * Adds HTML syntax highlighting to the specified SQL string.
-    *
-    * @param string $sql
-    * @return string
-    */
+    /**
+     * Adds HTML syntax highlighting to the specified SQL string.
+     *
+     * @param string $sql
+     * @return string
+     */
     public static function sql(string $sql) : string
     {
         return self::parseString($sql, 'sql');
     }
     
-   /**
-    * Adds HTML syntax highlighting to a JSON string, or a data array/object.
-    *
-    * @param array|object|string $subject A JSON string, or data array/object to convert to JSON to highlight.
-    * @return string
-    */
+    /**
+     * Adds HTML syntax highlighting to a JSON string, or a data array/object.
+     *
+     * @param array|object|string $subject A JSON string, or data array/object to convert to JSON to highlight.
+     * @return string
+     */
     public static function json($subject) : string
     {
         if(!is_string($subject))
@@ -118,13 +118,13 @@ 
         return self::parseString($subject, 'javascript');
     }
     
-   /**
-    * Adds HTML syntax highlighting to the specified XML code.
-    *
-    * @param string $xml The XML to highlight.
-    * @param bool $formatSource Whether to format the source with indentation to make it readable.
-    * @return string
-    */
+    /**
+     * Adds HTML syntax highlighting to the specified XML code.
+     *
+     * @param string $xml The XML to highlight.
+     * @param bool $formatSource Whether to format the source with indentation to make it readable.
+     * @return string
+     */
     public static function xml(string $xml, bool $formatSource=false) : string
     {
         if($formatSource)
@@ -141,13 +141,13 @@ 
         return self::parseString($xml, 'xml');
     }
     
-   /**
-    * Adds HTML syntax highlighting to the specified HTML code.
-    * 
-    * @param string $html
-    * @param bool $formatSource
-    * @return string
-    */
+    /**
+     * Adds HTML syntax highlighting to the specified HTML code.
+     * 
+     * @param string $html
+     * @param bool $formatSource
+     * @return string
+     */
     public static function html(string $html, bool $formatSource=false) : string
     {
         if($formatSource)
@@ -164,27 +164,27 @@ 
         return self::parseString($html, 'xml');
     }
     
-   /**
-    * Adds HTML syntax highlighting to a bit of PHP code.
-    * 
-    * @param string $phpCode
-    * @return string
-    */
+    /**
+     * Adds HTML syntax highlighting to a bit of PHP code.
+     * 
+     * @param string $phpCode
+     * @return string
+     */
     public static function php(string $phpCode) : string
     {
         return self::parseString($phpCode, 'php');
     }
     
-   /**
-    * Adds HTML syntax highlighting to an URL.
-    *
-    * NOTE: Includes the necessary CSS styles. When
-    * highlighting several URLs in the same page,
-    * prefer using the `parseURL` function instead.
-    *
-    * @param string $url
-    * @return string
-    */
+    /**
+     * Adds HTML syntax highlighting to an URL.
+     *
+     * NOTE: Includes the necessary CSS styles. When
+     * highlighting several URLs in the same page,
+     * prefer using the `parseURL` function instead.
+     *
+     * @param string $url
+     * @return string
+     */
     public static function url(string $url) : string
     {
         $info = parseURL($url);

Spacing +5 added lines, -5 removed lines

@@ -108,7 +108,7 @@ 
     */
     public static function json($subject) : string
     {
-        if(!is_string($subject))
+        if (!is_string($subject))
         {
             $subject = json_encode($subject, JSON_PRETTY_PRINT);
         }
@@ -125,9 +125,9 @@ 
     * @param bool $formatSource Whether to format the source with indentation to make it readable.
     * @return string
     */
-    public static function xml(string $xml, bool $formatSource=false) : string
+    public static function xml(string $xml, bool $formatSource = false) : string
     {
-        if($formatSource)
+        if ($formatSource)
         {
             $dom = new DOMDocument();
             $dom->preserveWhiteSpace = false;
@@ -148,9 +148,9 @@ 
     * @param bool $formatSource
     * @return string
     */
-    public static function html(string $html, bool $formatSource=false) : string
+    public static function html(string $html, bool $formatSource = false) : string
     {
-        if($formatSource)
+        if ($formatSource)
         {
             $dom = new DOMDocument();
             $dom->preserveWhiteSpace = false;