Mistralys / application-utils

src/URLInfo.php

Indentation +155 added lines, -155 removed lines

@@ -39,42 +39,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',
@@ -86,19 +86,19 @@ 
         'fragment'
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $url;
     
-   /**
-    * @var URLInfo_Parser
-    */
+    /**
+     * @var URLInfo_Parser
+     */
     protected $parser;
     
-   /**
-    * @var URLInfo_Normalizer
-    */
+    /**
+     * @var URLInfo_Normalizer
+     */
     protected $normalizer;
     
     public function __construct(string $url)
@@ -110,13 +110,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);
@@ -146,12 +146,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();
@@ -163,20 +163,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');
@@ -192,10 +192,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');
@@ -207,13 +207,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');
@@ -229,20 +229,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();
@@ -300,25 +300,25 @@ 
         return $this->normalizer->normalize();
     }
     
-   /**
-    * Creates a hash of the URL, which can be used for comparisons.
-    * Since any parameters in the URL's query are sorted alphabetically,
-    * the same links with a different parameter order will have the 
-    * same hash.
-    * 
-    * @return string
-    */
+    /**
+     * Creates a hash of the URL, which can be used for comparisons.
+     * Since any parameters in the URL's query are sorted alphabetically,
+     * the same links with a different parameter order will have the 
+     * same hash.
+     * 
+     * @return string
+     */
     public function getHash()
     {
         return \AppUtils\ConvertHelper::string2shortHash($this->getNormalized());
     }
 
-   /**
-    * Highlights the URL using HTML tags with specific highlighting
-    * class names.
-    * 
-    * @return string Will return an empty string if the URL is not valid.
-    */
+    /**
+     * Highlights the URL using HTML tags with specific highlighting
+     * class names.
+     * 
+     * @return string Will return an empty string if the URL is not valid.
+     */
     public function getHighlighted() : string
     {
         if(!$this->isValid()) {
@@ -352,15 +352,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)) {
@@ -378,22 +378,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])) {
@@ -403,16 +403,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]))
@@ -465,25 +465,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(
@@ -527,24 +527,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)) {
@@ -612,17 +612,17 @@ 
         return $this->highlightExcluded;
     }
     
-   /**
-    * Checks if the URL exists, i.e. can be connected to. Will return
-    * true if the returned HTTP status code is `200` or `302`.
-    * 
-    * NOTE: If the target URL requires HTTP authentication, the username
-    * and password should be integrated into the URL.
-    * 
-    * @param bool $verifySSL Whether to enable SSL certificate checks. Warning: do not use this in production.
-    * @return bool
-    * @throws BaseException
-    */
+    /**
+     * Checks if the URL exists, i.e. can be connected to. Will return
+     * true if the returned HTTP status code is `200` or `302`.
+     * 
+     * NOTE: If the target URL requires HTTP authentication, the username
+     * and password should be integrated into the URL.
+     * 
+     * @param bool $verifySSL Whether to enable SSL certificate checks. Warning: do not use this in production.
+     * @return bool
+     * @throws BaseException
+     */
     public function tryConnect(bool $verifySSL=true) : bool
     {
         requireCURL();

Spacing +24 added lines, -24 removed lines

@@ -200,7 +200,7 @@ 
     {
         $port = $this->getInfoKey('port');
         
-        if(!empty($port)) {
+        if (!empty($port)) {
             return (int)$port;
         }
         
@@ -280,7 +280,7 @@ 
     
     protected function getInfoKey(string $name) : string
     {
-        if(isset($this->info[$name])) {
+        if (isset($this->info[$name])) {
             return (string)$this->info[$name];
         }
         
@@ -289,11 +289,11 @@ 
 
     public function getNormalized() : string
     {
-        if(!$this->isValid()) {
+        if (!$this->isValid()) {
             return '';
         }
         
-        if(!isset($this->normalizer)) {
+        if (!isset($this->normalizer)) {
             $this->normalizer = new URLInfo_Normalizer($this);
         }
         
@@ -321,7 +321,7 @@ 
     */
     public function getHighlighted() : string
     {
-        if(!$this->isValid()) {
+        if (!$this->isValid()) {
             return '';
         }
         
@@ -363,14 +363,14 @@ 
     */
     public function getParams() : array
     {
-        if(!$this->paramExclusion || empty($this->excludedParams)) {
+        if (!$this->paramExclusion || empty($this->excludedParams)) {
             return $this->info['params'];
         }
         
         $keep = array();
-        foreach($this->info['params'] as $name => $value) 
+        foreach ($this->info['params'] as $name => $value) 
         {
-            if(!isset($this->excludedParams[$name])) {
+            if (!isset($this->excludedParams[$name])) {
                 $keep[$name] = $value;
             }
         }
@@ -396,7 +396,7 @@ 
     */
     public function getParam(string $name) : string
     {
-        if(isset($this->info['params'][$name])) {
+        if (isset($this->info['params'][$name])) {
             return $this->info['params'][$name];
         }
         
@@ -415,7 +415,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();
@@ -441,7 +441,7 @@ 
     
     public function getTypeLabel() : string
     {
-        if(!isset(self::$typeLabels))
+        if (!isset(self::$typeLabels))
         {
             self::$typeLabels = array(
                 self::TYPE_EMAIL => t('Email'),
@@ -453,7 +453,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),
@@ -473,7 +473,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;
@@ -521,7 +521,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;
@@ -547,13 +547,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;
             }
         }
@@ -569,7 +569,7 @@ 
 
     public function offsetSet($offset, $value) 
     {
-        if(in_array($offset, $this->infoKeys)) {
+        if (in_array($offset, $this->infoKeys)) {
             $this->info[$offset] = $value;
         }
     }
@@ -586,11 +586,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);
         }
         
@@ -623,12 +623,12 @@ 
     * @return bool
     * @throws BaseException
     */
-    public function tryConnect(bool $verifySSL=true) : bool
+    public function tryConnect(bool $verifySSL = true) : bool
     {
         requireCURL();
         
         $ch = curl_init();
-        if($ch === false)
+        if ($ch === false)
         {
             throw new BaseException(
                 'Could not initialize a new cURL instance.',
@@ -644,13 +644,13 @@ 
         curl_setopt($ch, CURLOPT_TIMEOUT, 10);
         curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
         
-        if(!$verifySSL) 
+        if (!$verifySSL) 
         {
             curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
             curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
         }
         
-        if($this->hasUsername()) 
+        if ($this->hasUsername()) 
         {
             curl_setopt($ch, CURLOPT_USERNAME, $this->getUsername());
             curl_setopt($ch, CURLOPT_PASSWORD, $this->getPassword());