Mistralys / application-utils

src/URLInfo.php

Indentation +164 added lines, -164 removed lines

@@ -38,40 +38,40 @@ 
     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 bool
-    */
+    /**
+     * @var bool
+     */
     protected $isEmail = false;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $isFragment = false;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $isValid = true;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $isPhone = false;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $knownSchemes = array(
         'ftp',
         'http',
@@ -82,41 +82,41 @@ 
         'file'
     );
 
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $error;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $params = array();
     
-   /**
-    * @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',
@@ -128,9 +128,9 @@ 
         'fragment'
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $url;
     
     public function __construct(string $url)
@@ -216,13 +216,13 @@ 
         $this->isValid = true;
     }
     
-   /**
-    * 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)
     {
         // fix ampersands if it comes from HTML
@@ -245,11 +245,11 @@ 
         return $url;
     }
     
-   /**
-    * Goes through all information in the parse_url result
-    * array, and attempts to fix any user errors in formatting
-    * that can be recovered from, mostly regarding stray spaces.
-    */
+    /**
+     * Goes through all information in the parse_url result
+     * array, and attempts to fix any user errors in formatting
+     * that can be recovered from, mostly regarding stray spaces.
+     */
     protected function filterParsed()
     {
         foreach($this->info as $key => $val)
@@ -333,12 +333,12 @@ 
         return $this->isPhone;
     }
     
-   /**
-    * 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();
@@ -350,20 +350,20 @@ 
         return $this->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');
@@ -379,10 +379,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');
@@ -393,13 +393,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');
@@ -415,20 +415,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();
@@ -509,25 +509,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) {
@@ -711,15 +711,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)) {
@@ -736,22 +736,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->params[$name])) {
@@ -761,16 +761,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]))
@@ -835,25 +835,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(
@@ -897,24 +897,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 +62 added lines, -62 removed lines

@@ -156,26 +156,26 @@ 
 
         $this->filterParsed();
         
-        if($this->detectEmail()) {
+        if ($this->detectEmail()) {
             return;
         }
         
-        if($this->detectFragmentLink()) {
+        if ($this->detectFragmentLink()) {
             return;
         }
         
-        if($this->detectPhoneLink()) {
+        if ($this->detectPhoneLink()) {
             return;
         }
         
-        if(!$this->isValid) {
+        if (!$this->isValid) {
             return;
         }
         
         // no scheme found: it may be an email address without the mailto:
         // It can't be a variable, since without the scheme it would already
         // have been recognized as a vaiable only link.
-        if(!isset($this->info['scheme'])) {
+        if (!isset($this->info['scheme'])) {
             $this->setError(
                 self::ERROR_MISSING_SCHEME,
                 t('Cannot determine the link\'s scheme, e.g. %1$s.', 'http')
@@ -184,10 +184,10 @@ 
             return;
         }
         
-        if(!in_array($this->info['scheme'], $this->knownSchemes)) {
+        if (!in_array($this->info['scheme'], $this->knownSchemes)) {
             $this->setError(
                 self::ERROR_INVALID_SCHEME,
-                t('The scheme %1$s is not supported for links.', $this->info['scheme']) . ' ' .
+                t('The scheme %1$s is not supported for links.', $this->info['scheme']).' '.
                 t('Valid schemes are: %1$s.', implode(', ', $this->knownSchemes))
             );
             $this->isValid = false;
@@ -197,17 +197,17 @@ 
         // every link needs a host. This case can happen for ex, if
         // the link starts with a typo with only one slash, like:
         // "http:/hostname"
-        if(!isset($this->info['host'])) {
+        if (!isset($this->info['host'])) {
             $this->setError(
                 self::ERROR_MISSING_HOST,
-                t('Cannot determine the link\'s host name.') . ' ' .
+                t('Cannot determine the link\'s host name.').' '.
                 t('This usually happens when there\'s a typo somewhere.')
             );
             $this->isValid = false;
             return;
         }
 
-        if(!empty($this->info['query'])) 
+        if (!empty($this->info['query'])) 
         {
             $this->params = \AppUtils\ConvertHelper::parseQueryString($this->info['query']);
             ksort($this->params);
@@ -252,30 +252,30 @@ 
     */
     protected function filterParsed()
     {
-        foreach($this->info as $key => $val)
+        foreach ($this->info as $key => $val)
         {
-            if(is_string($val)) {
+            if (is_string($val)) {
                 $this->info[$key] = trim($val);
             }
         }
         
-        if(isset($this->info['host'])) {
+        if (isset($this->info['host'])) {
             $this->info['host'] = str_replace(' ', '', $this->info['host']);
         }
         
-        if(isset($this->info['path'])) {
+        if (isset($this->info['path'])) {
             $this->info['path'] = str_replace(' ', '', $this->info['path']);
         }
     }
     
     protected function detectEmail()
     {
-        if(isset($this->info['scheme']) && $this->info['scheme'] == 'mailto') {
+        if (isset($this->info['scheme']) && $this->info['scheme'] == 'mailto') {
             $this->isEmail = true;
             return true;
         }
         
-        if(isset($this->info['path']) && preg_match(\AppUtils\RegexHelper::REGEX_EMAIL, $this->info['path'])) 
+        if (isset($this->info['path']) && preg_match(\AppUtils\RegexHelper::REGEX_EMAIL, $this->info['path'])) 
         {
             $this->info['scheme'] = 'email';
             $this->isEmail = true;
@@ -287,7 +287,7 @@ 
     
     protected function detectFragmentLink()
     {
-        if(isset($this->info['fragment']) && !isset($this->info['scheme'])) {
+        if (isset($this->info['fragment']) && !isset($this->info['scheme'])) {
             $this->isFragment = true;
             return true;
         }
@@ -297,7 +297,7 @@ 
     
     protected function detectPhoneLink()
     {
-        if(isset($this->info['scheme']) && $this->info['scheme'] == 'tel') {
+        if (isset($this->info['scheme']) && $this->info['scheme'] == 'tel') {
             $this->isPhone = true;
             return true;
         }
@@ -311,7 +311,7 @@ 
      */
     public function isSecure()
     {
-        if(isset($this->info['scheme']) && $this->info['scheme']=='https') {
+        if (isset($this->info['scheme']) && $this->info['scheme'] == 'https') {
             return true;
         }
         
@@ -386,7 +386,7 @@ 
     public function getPort() : int
     {
         $port = $this->getInfoKey('port');
-        if(!empty($port)) {
+        if (!empty($port)) {
             return (int)$port;
         }
         
@@ -466,7 +466,7 @@ 
     
     protected function getInfoKey(string $name) : string
     {
-        if(isset($this->info[$name])) {
+        if (isset($this->info[$name])) {
             return (string)$this->info[$name];
         }
         
@@ -475,34 +475,34 @@ 
     
     public function getNormalized() : string
     {
-        if(!$this->isValid) {
+        if (!$this->isValid) {
             return '';
         }
         
-        if($this->isFragment === true)
+        if ($this->isFragment === true)
         {
             return '#'.$this->getFragment();
         }
-        else if($this->isPhone === true)
+        else if ($this->isPhone === true)
         {
             return 'tel://'.$this->getHost();
         }
-        else if($this->isEmail === true)
+        else if ($this->isEmail === true)
         {
             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'];
         }
         
@@ -530,11 +530,11 @@ 
     */
     public function getHighlighted() : string
     {
-        if(!$this->isValid) {
+        if (!$this->isValid) {
             return '';
         }
         
-        if($this->isEmail) {
+        if ($this->isEmail) {
             return sprintf(
                 '<span class="link-scheme scheme-mailto">mailto:</span>'.
                 '<span class="link-host">%s</span>',
@@ -542,7 +542,7 @@ 
             );
         }
         
-        if($this->isFragment) {
+        if ($this->isFragment) {
             return sprintf(
                 '<span class="link-fragment-sign">#</span>'.
                 '<span class="link-fragment-value">%s</span>',
@@ -552,7 +552,7 @@ 
         
         $result = '';
         
-        if($this->hasScheme())
+        if ($this->hasScheme())
         {
             $result = sprintf(
                 '<span class="link-scheme scheme-%1$s">'.
@@ -564,7 +564,7 @@ 
 
         $result .= '<span class="link-component double-slashes">//</span>';
         
-        if($this->hasUsername())
+        if ($this->hasUsername())
         {
             $result .= sprintf(
                 '<span class="link-credentials">%s</span>'.
@@ -576,7 +576,7 @@ 
             );
         }
         
-        if($this->hasHost()) 
+        if ($this->hasHost()) 
         {
             $result .=
             sprintf(
@@ -585,7 +585,7 @@ 
             );
         }
         
-        if($this->hasPort()) 
+        if ($this->hasPort()) 
         {
             $result .= sprintf(
                 '<span class="link-component port-separator">:</span>'.
@@ -594,7 +594,7 @@ 
             );
         }
         
-        if($this->hasPath()) 
+        if ($this->hasPath()) 
         {
             $path = str_replace(array(';', '='), array(';<wbr>', '=<wbr>'), $this->getPath());
             $tokens = explode('/', $path);
@@ -605,11 +605,11 @@ 
             );
         }
         
-        if(!empty($this->params))
+        if (!empty($this->params))
         {
             $tokens = array();
             
-            foreach($this->params as $param => $value)
+            foreach ($this->params as $param => $value)
             {
                 $parts = sprintf(
                     '<span class="link-param-name">%s</span>'.
@@ -627,10 +627,10 @@ 
                 $tag = '';
                 
                 // is parameter exclusion enabled, and is this an excluded parameter?
-                if($this->paramExclusion && isset($this->excludedParams[$param]))
+                if ($this->paramExclusion && isset($this->excludedParams[$param]))
                 {
                     // display the excluded parameter, but highlight it
-                    if($this->highlightExcluded)
+                    if ($this->highlightExcluded)
                     {
                         $tooltip = $this->excludedParams[$param];
                         
@@ -660,7 +660,7 @@ 
             '<span class="link-component query-sign">?</span>'.implode('<span class="link-component param-separator">&amp;</span>', $tokens);
         }
         
-        if(isset($this->info['fragment'])) {
+        if (isset($this->info['fragment'])) {
             $result .= sprintf(
                 '<span class="link-fragment-sign">#</span>'.
                 '<span class="link-fragment">%s</span>',
@@ -683,7 +683,7 @@ 
     
     public function getErrorMessage() : string
     {
-        if(isset($this->error)) {
+        if (isset($this->error)) {
             return $this->error['message'];
         }
         
@@ -692,7 +692,7 @@ 
     
     public function getErrorCode() : int
     {
-        if(isset($this->error)) {
+        if (isset($this->error)) {
             return $this->error['code'];
         }
         
@@ -722,13 +722,13 @@ 
     */
     public function getParams() : array
     {
-        if(!$this->paramExclusion || empty($this->excludedParams)) {
+        if (!$this->paramExclusion || empty($this->excludedParams)) {
             return $this->params;
         }
         
         $keep = array();
-        foreach($this->params as $name => $value) {
-            if(!isset($this->excludedParams[$name])) {
+        foreach ($this->params as $name => $value) {
+            if (!isset($this->excludedParams[$name])) {
                 $keep[$name] = $value;
             }
         }
@@ -754,7 +754,7 @@ 
     */
     public function getParam(string $name) : string
     {
-        if(isset($this->params[$name])) {
+        if (isset($this->params[$name])) {
             return $this->params[$name];
         }
         
@@ -773,7 +773,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();
@@ -794,15 +794,15 @@ 
      */
     public function getType() : string
     {
-        if($this->isEmail) {
+        if ($this->isEmail) {
             return self::TYPE_EMAIL;
         }
         
-        if($this->isFragment) {
+        if ($this->isFragment) {
             return self::TYPE_FRAGMENT;
         }
         
-        if($this->isPhone) {
+        if ($this->isPhone) {
             return self::TYPE_PHONE;
         }
         
@@ -811,7 +811,7 @@ 
     
     public function getTypeLabel() : string
     {
-        if(!isset(self::$typeLabels))
+        if (!isset(self::$typeLabels))
         {
             self::$typeLabels = array(
                 self::TYPE_EMAIL => t('Email'),
@@ -823,7 +823,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),
@@ -843,7 +843,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;
@@ -891,7 +891,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;
@@ -917,13 +917,13 @@ 
     */
     public function containsExcludedParams() : bool
     {
-        if(empty($this->excludedParams)) {
+        if (empty($this->excludedParams)) {
             return false;
         }
         
         $names = array_keys($this->params);
-        foreach($names as $name) {
-            if(isset($this->excludedParams[$name])) {
+        foreach ($names as $name) {
+            if (isset($this->excludedParams[$name])) {
                 return true;
             }
         }
@@ -939,7 +939,7 @@ 
 
     public function offsetSet($offset, $value) 
     {
-        if(in_array($offset, $this->infoKeys)) {
+        if (in_array($offset, $this->infoKeys)) {
             $this->info[$offset] = $value;
         }
     }
@@ -956,11 +956,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);
         }
         
@@ -971,7 +971,7 @@ 
     {
         $cssFolder = realpath(__DIR__.'/../css');
         
-        if($cssFolder === false) {
+        if ($cssFolder === false) {
             throw new BaseException(
                 'Cannot find package CSS folder.',
                 null,