Mistralys / application-utils

src/URLInfo.php

Indentation +177 added lines, -177 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,24 +86,24 @@ 
         'fragment'
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $url;
     
-   /**
-    * @var URLInfo_Parser
-    */
+    /**
+     * @var URLInfo_Parser
+     */
     protected $parser;
     
-   /**
-    * @var URLInfo_Normalizer
-    */
+    /**
+     * @var URLInfo_Normalizer
+     */
     protected $normalizer;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $encodeUTFChars = false;
     
     public function __construct(string $url)
@@ -120,14 +120,14 @@ 
         $this->info = $this->parser->getInfo();
     }
     
-   /**
-    * Whether to URL encode any non-encoded UTF8 characters in the URL.
-    * Default is to leave them as-is for better readability, since 
-    * browsers handle this well.
-    * 
-    * @param bool $enabled
-    * @return URLInfo
-    */
+    /**
+     * Whether to URL encode any non-encoded UTF8 characters in the URL.
+     * Default is to leave them as-is for better readability, since 
+     * browsers handle this well.
+     * 
+     * @param bool $enabled
+     * @return URLInfo
+     */
     public function setUTFEncoding(bool $enabled=true) : URLInfo
     {
         if($this->encodeUTFChars !== $enabled)
@@ -144,13 +144,13 @@ 
         return $this->encodeUTFChars;
     }
     
-   /**
-    * 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);
@@ -180,12 +180,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();
@@ -197,20 +197,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');
@@ -226,10 +226,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');
@@ -241,13 +241,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');
@@ -263,20 +263,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();
@@ -321,23 +321,23 @@ 
         return '';
     }
 
-   /**
-    * Retrieves a normalized URL: this ensures that all parameters
-    * in the URL are always in the same order.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves a normalized URL: this ensures that all parameters
+     * in the URL are always in the same order.
+     * 
+     * @return string
+     */
     public function getNormalized() : string
     {
         return $this->normalize(true);
     }
     
-   /**
-    * Like getNormalized(), but if a username and password are present
-    * in the URL, returns the URL without them.
-    * 
-    * @return string
-    */
+    /**
+     * Like getNormalized(), but if a username and password are present
+     * in the URL, returns the URL without them.
+     * 
+     * @return string
+     */
     public function getNormalizedWithoutAuth() : string
     {
         return $this->normalize(false);
@@ -358,25 +358,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()) {
@@ -410,15 +410,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)) {
@@ -436,22 +436,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])) {
@@ -461,16 +461,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]))
@@ -523,25 +523,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(
@@ -585,24 +585,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)) {
@@ -670,16 +670,16 @@ 
         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.
-    * 
-    * @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.
+     * 
+     * @return bool
+     * @throws BaseException
+     */
     public function tryConnect(bool $verifySSL=true) : bool
     {
         requireCURL();

src/URLInfo/Parser.php

Indentation +73 added lines, -73 removed lines

@@ -23,24 +23,24 @@ 
  */
 class URLInfo_Parser
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $url;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $isValid = false;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $info;
     
-   /**
-    * @var array|NULL
-    */
+    /**
+     * @var array|NULL
+     */
     protected $error;
     
     /**
@@ -56,25 +56,25 @@ 
         'file'
     );
     
-   /**
-    * Stores a list of all unicode characters in the URL
-    * that have been filtered out before parsing it with
-    * parse_url.
-    * 
-    * @var string[]string
-    */
+    /**
+     * Stores a list of all unicode characters in the URL
+     * that have been filtered out before parsing it with
+     * parse_url.
+     * 
+     * @var string[]string
+     */
     protected $unicodeChars = array();
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $encodeUTF = false;
     
-   /**
-    * 
-    * @param string $url The target URL.
-    * @param bool $encodeUTF Whether to URL encode any plain text unicode characters.
-    */
+    /**
+     * 
+     * @param string $url The target URL.
+     * @param bool $encodeUTF Whether to URL encode any plain text unicode characters.
+     */
     public function __construct(string $url, bool $encodeUTF)
     {
         $this->url = $url;
@@ -87,12 +87,12 @@ 
         }
     }
 
-   /**
-    * Retrieves the array as parsed by PHP's parse_url,
-    * filtered and adjusted as necessary.
-    * 
-    * @return array
-    */
+    /**
+     * Retrieves the array as parsed by PHP's parse_url,
+     * filtered and adjusted as necessary.
+     * 
+     * @return array
+     */
     public function getInfo() : array
     {
         return $this->info;
@@ -114,11 +114,11 @@ 
         }
     }
     
-   /**
-    * Finds any non-url encoded unicode characters in 
-    * the URL, and encodes them before the URL is 
-    * passed to parse_url.
-    */
+    /**
+     * Finds any non-url encoded unicode characters in 
+     * the URL, and encodes them before the URL is 
+     * passed to parse_url.
+     */
     protected function filterUnicodeChars() : void
     {
         $chars = \AppUtils\ConvertHelper::string2array($this->url);
@@ -236,11 +236,11 @@ 
         return false;
     }
 
-   /**
-    * 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()
     {
         $this->info['params'] = array();
@@ -269,13 +269,13 @@ 
         }
     }
     
-   /**
-    * Recursively goes through the array, and converts all previously
-    * URL encoded characters with their unicode character counterparts.
-    * 
-    * @param array $subject
-    * @return array
-    */
+    /**
+     * Recursively goes through the array, and converts all previously
+     * URL encoded characters with their unicode character counterparts.
+     * 
+     * @param array $subject
+     * @return array
+     */
     protected function restoreUnicodeChars(array $subject) : array
     {
         $result = array();
@@ -299,13 +299,13 @@ 
         return $result;
     }
     
-   /**
-    * Replaces all URL encoded unicode characters
-    * in the string with the unicode character.
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Replaces all URL encoded unicode characters
+     * in the string with the unicode character.
+     * 
+     * @param string $string
+     * @return string
+     */
     protected function restoreUnicodeChar(string $string) : string
     {
         if(strstr($string, '%'))
@@ -363,21 +363,21 @@ 
         );
     }
    
-   /**
-    * Checks whether the URL that was parsed is valid.
-    * @return bool
-    */
+    /**
+     * Checks whether the URL that was parsed is valid.
+     * @return bool
+     */
     public function isValid() : bool
     {
         return $this->isValid;
     }
 
-   /**
-    * If the validation failed, retrieves the validation
-    * error message.
-    * 
-    * @return string
-    */
+    /**
+     * If the validation failed, retrieves the validation
+     * error message.
+     * 
+     * @return string
+     */
     public function getErrorMessage() : string
     {
         if(isset($this->error)) {
@@ -387,12 +387,12 @@ 
         return '';
     }
     
-   /**
-    * If the validation failed, retrieves the validation
-    * error code.
-    * 
-    * @return int
-    */
+    /**
+     * If the validation failed, retrieves the validation
+     * error code.
+     * 
+     * @return int
+     */
     public function getErrorCode() : int
     {
         if(isset($this->error)) {