Mistralys / application-utils

src/URLInfo/Highlighter.php

Indentation +3 added lines, -3 removed lines

@@ -20,9 +20,9 @@
  */
 class URLInfo_Highlighter
 {
-   /**
-    * @var URLInfo
-    */
+    /**
+     * @var URLInfo
+     */
     protected $info;
     
     public function __construct(URLInfo $info)

Spacing +12 added lines, -12 removed lines

@@ -77,7 +77,7 @@ 
             'fragment'
         );
         
-        foreach($parts as $part) 
+        foreach ($parts as $part) 
         {
             $method = 'render_'.$part;
             $result[] = (string)$this->$method();
@@ -88,7 +88,7 @@ 
     
     protected function render_scheme() : string
     {
-        if(!$this->info->hasScheme()) {
+        if (!$this->info->hasScheme()) {
             return '';
         }
         
@@ -103,7 +103,7 @@ 
     
     protected function render_username() : string
     {
-        if(!$this->info->hasUsername()) {
+        if (!$this->info->hasUsername()) {
             return '';
         }
         
@@ -119,7 +119,7 @@ 
     
     protected function render_host() : string
     {
-        if(!$this->info->hasHost()) {
+        if (!$this->info->hasHost()) {
             return '';
         }
         
@@ -131,7 +131,7 @@ 
     
     protected function render_port() : string
     {
-        if(!$this->info->hasPort()) {
+        if (!$this->info->hasPort()) {
             return '';
         }
         
@@ -144,7 +144,7 @@ 
        
     protected function render_path() : string
     {
-        if(!$this->info->hasPath()) {
+        if (!$this->info->hasPath()) {
             return '';
         }
         
@@ -162,19 +162,19 @@ 
     {
         $params = $this->info->getParams();
         
-        if(empty($params)) {
+        if (empty($params)) {
             return '';
         }
         
         $tokens = array();
         $excluded = array();
         
-        if($this->info->isParamExclusionEnabled())
+        if ($this->info->isParamExclusionEnabled())
         {
             $excluded = $this->info->getExcludedParams();
         }
         
-        foreach($params as $param => $value)
+        foreach ($params as $param => $value)
         {
             $parts = sprintf(
                 '<span class="link-param-name">%s</span>'.
@@ -192,10 +192,10 @@ 
             $tag = '';
             
             // is parameter exclusion enabled, and is this an excluded parameter?
-            if(isset($excluded[$param]))            
+            if (isset($excluded[$param]))            
             {
                 // display the excluded parameter, but highlight it
-                if($this->info->isHighlightExcludeEnabled())
+                if ($this->info->isHighlightExcludeEnabled())
                 {
                     $tooltip = $excluded[$param];
                     
@@ -228,7 +228,7 @@ 
      
     protected function render_fragment() : string
     {
-        if(!$this->info->hasFragment()) {
+        if (!$this->info->hasFragment()) {
             return '';
         }
         

Braces +2 added lines, -4 removed lines

@@ -204,13 +204,11 @@
                         $tooltip,
                         $parts
                     );
-                }
-                else
+                } else
                 {
                     continue;
                 }
-            }
-            else
+            } else
             {
                 $tag = sprintf(
                     '<span class="link-param">%s</span>',

src/URLInfo.php

Indentation +141 added lines, -141 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,14 +84,14 @@ 
         'fragment'
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $url;
     
-   /**
-    * @var URLInfo_Parser
-    */
+    /**
+     * @var URLInfo_Parser
+     */
     protected $parser;
     
     public function __construct(string $url)
@@ -103,13 +103,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);
@@ -143,12 +143,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();
@@ -160,20 +160,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');
@@ -189,10 +189,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');
@@ -203,13 +203,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');
@@ -225,20 +225,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();
@@ -319,25 +319,25 @@ 
         return $normalized;
     }
     
-   /**
-    * 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()) {
@@ -371,15 +371,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)) {
@@ -396,22 +396,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])) {
@@ -421,16 +421,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]))
@@ -483,25 +483,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(
@@ -545,24 +545,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 +27 added lines, -27 removed lines

@@ -121,7 +121,7 @@ 
      */
     public function isSecure() : bool
     {
-        if(isset($this->info['scheme']) && $this->info['scheme'] === 'https') {
+        if (isset($this->info['scheme']) && $this->info['scheme'] === 'https') {
             return true;
         }
         
@@ -196,7 +196,7 @@ 
     public function getPort() : int
     {
         $port = $this->getInfoKey('port');
-        if(!empty($port)) {
+        if (!empty($port)) {
             return (int)$port;
         }
         
@@ -276,7 +276,7 @@ 
     
     protected function getInfoKey(string $name) : string
     {
-        if(isset($this->info[$name])) {
+        if (isset($this->info[$name])) {
             return (string)$this->info[$name];
         }
         
@@ -285,34 +285,34 @@ 
     
     public function getNormalized() : string
     {
-        if(!$this->isValid()) {
+        if (!$this->isValid()) {
             return '';
         }
         
-        if($this->isAnchor())
+        if ($this->isAnchor())
         {
             return '#'.$this->getFragment();
         }
-        else if($this->isPhoneNumber())
+        else if ($this->isPhoneNumber())
         {
             return 'tel://'.$this->getHost();
         }
-        else if($this->isEmail())
+        else if ($this->isEmail())
         {
             return 'mailto:'.$this->getPath();
         }
         
         $normalized = $this->info['scheme'].'://'.$this->info['host'];
-        if(isset($this->info['path'])) {
+        if (isset($this->info['path'])) {
             $normalized .= $this->info['path'];
         }
         
         $params = $this->getParams();
-        if(!empty($params)) {
+        if (!empty($params)) {
             $normalized .= '?'.http_build_query($params);
         }
         
-        if(isset($this->info['fragment'])) {
+        if (isset($this->info['fragment'])) {
             $normalized .= '#'.$this->info['fragment'];
         }
         
@@ -340,7 +340,7 @@ 
     */
     public function getHighlighted() : string
     {
-        if(!$this->isValid()) {
+        if (!$this->isValid()) {
             return '';
         }
         
@@ -382,13 +382,13 @@ 
     */
     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) {
-            if(!isset($this->excludedParams[$name])) {
+        foreach ($this->info['params'] as $name => $value) {
+            if (!isset($this->excludedParams[$name])) {
                 $keep[$name] = $value;
             }
         }
@@ -414,7 +414,7 @@ 
     */
     public function getParam(string $name) : string
     {
-        if(isset($this->info['params'][$name])) {
+        if (isset($this->info['params'][$name])) {
             return $this->info['params'][$name];
         }
         
@@ -433,7 +433,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();
@@ -459,7 +459,7 @@ 
     
     public function getTypeLabel() : string
     {
-        if(!isset(self::$typeLabels))
+        if (!isset(self::$typeLabels))
         {
             self::$typeLabels = array(
                 self::TYPE_EMAIL => t('Email'),
@@ -471,7 +471,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),
@@ -491,7 +491,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;
@@ -539,7 +539,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;
@@ -565,13 +565,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;
             }
         }
@@ -587,7 +587,7 @@ 
 
     public function offsetSet($offset, $value) 
     {
-        if(in_array($offset, $this->infoKeys)) {
+        if (in_array($offset, $this->infoKeys)) {
             $this->info[$offset] = $value;
         }
     }
@@ -604,11 +604,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);
         }
         
@@ -619,7 +619,7 @@ 
     {
         $cssFolder = realpath(__DIR__.'/../css');
         
-        if($cssFolder === false) {
+        if ($cssFolder === false) {
             throw new BaseException(
                 'Cannot find package CSS folder.',
                 null,

Braces +2 added lines, -4 removed lines

@@ -292,12 +292,10 @@
         if($this->isAnchor())
         {
             return '#'.$this->getFragment();
-        }
-        else if($this->isPhoneNumber())
+        } else if($this->isPhoneNumber())
         {
             return 'tel://'.$this->getHost();
-        }
-        else if($this->isEmail())
+        } else if($this->isEmail())
         {
             return 'mailto:'.$this->getPath();
         }