Mistralys / application-utils

src/OperationResult.php

Indentation +49 added lines, -49 removed lines

@@ -27,73 +27,73 @@ 
  */
 class OperationResult
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $message = '';
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $valid = true;
   
-   /**
-    * @var object
-    */
+    /**
+     * @var object
+     */
     protected $subject;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $code = 0;
     
-   /**
-    * The subject being validated.
-    * 
-    * @param object $subject
-    */
+    /**
+     * The subject being validated.
+     * 
+     * @param object $subject
+     */
     public function __construct(object $subject)
     {
         $this->subject = $subject;
     }
     
-   /**
-    * Whether the validation was successful.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the validation was successful.
+     * 
+     * @return bool
+     */
     public function isValid() : bool
     {
         return $this->valid;
     }
     
-   /**
-    * Retrieves the subject that was validated.
-    * 
-    * @return object
-    */
+    /**
+     * Retrieves the subject that was validated.
+     * 
+     * @return object
+     */
     public function getSubject() : object
     {
         return $this->subject;
     }
     
-   /**
-    * Makes the result a succes, with the specified message.
-    * 
-    * @param string $message Should not contain a date, just the system specific info.
-    * @return OperationResult
-    */
+    /**
+     * Makes the result a succes, with the specified message.
+     * 
+     * @param string $message Should not contain a date, just the system specific info.
+     * @return OperationResult
+     */
     public function makeSuccess(string $message, int $code=0) : OperationResult
     {
         return $this->setMessage($message, $code, true);
     }
     
-   /**
-    * Sets the result as an error.
-    * 
-    * @param string $message Should be as detailed as possible.
-    * @return OperationResult
-    */
+    /**
+     * Sets the result as an error.
+     * 
+     * @param string $message Should be as detailed as possible.
+     * @return OperationResult
+     */
     public function makeError(string $message, int $code=0) : OperationResult
     {
         return $this->setMessage($message, $code, false);
@@ -108,21 +108,21 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves the error message, if an error occurred.
-    * 
-    * @return string The error message, or an empty string if no error occurred.
-    */
+    /**
+     * Retrieves the error message, if an error occurred.
+     * 
+     * @return string The error message, or an empty string if no error occurred.
+     */
     public function getErrorMessage() : string
     {
         return $this->getMessage(false);
     }
     
-   /**
-    * Retrieves the success message, if one has been provided.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the success message, if one has been provided.
+     * 
+     * @return string
+     */
     public function getSuccessMessage() : string
     {
         return $this->getMessage(true);

src/Traits/Classable.php

Indentation +22 added lines, -22 removed lines

@@ -87,37 +87,37 @@
  */
 interface Interface_Classable
 {
-   /**
-    * @param string $name
-    * @return $this
-    */
+    /**
+     * @param string $name
+     * @return $this
+     */
     public function addClass(string $name);
 
-   /**
-    * @param array $names
-    * @return $this
-    */
+    /**
+     * @param array $names
+     * @return $this
+     */
     public function addClasses(array $names);
     
-   /**
-    * @param string $name
-    * @return bool
-    */
+    /**
+     * @param string $name
+     * @return bool
+     */
     public function hasClass(string $name) : bool;
     
-   /**
-    * @param string $name
-    * @return $this
-    */
+    /**
+     * @param string $name
+     * @return $this
+     */
     public function removeClass(string $name);
     
-   /**
-    * @return array
-    */
+    /**
+     * @return array
+     */
     public function getClasses() : array;
     
-   /**
-    * @return string
-    */
+    /**
+     * @return string
+     */
     public function classesToString() : string;
 }

src/Traits/Optionable.php

Indentation +100 added lines, -100 removed lines

@@ -26,18 +26,18 @@ 
  */
 trait Traits_Optionable
 {
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $options;
     
-   /**
-    * Sets an option to the specified value. This can be any
-    * kind of variable type, including objects, as needed.
-    * 
-    * @param string $name
-    * @param mixed $value
-    */
+    /**
+     * Sets an option to the specified value. This can be any
+     * kind of variable type, including objects, as needed.
+     * 
+     * @param string $name
+     * @param mixed $value
+     */
     public function setOption(string $name, $value)
     {
         if(!isset($this->options)) {
@@ -48,12 +48,12 @@ 
         return $this;
     }
     
-   /**
-    * Sets a collection of options at once, from an
-    * associative array.
-    * 
-    * @param array $options
-    */
+    /**
+     * Sets a collection of options at once, from an
+     * associative array.
+     * 
+     * @param array $options
+     */
     public function setOptions(array $options)
     {
         foreach($options as $name => $value) {
@@ -63,16 +63,16 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves an option's value.
-    * 
-    * NOTE: Use the specialized type getters to ensure an option
-    * contains the expected type (for ex. getArrayOption()). 
-    * 
-    * @param string $name
-    * @param mixed $default The default value to return if the option does not exist.
-    * @return mixed
-    */
+    /**
+     * Retrieves an option's value.
+     * 
+     * NOTE: Use the specialized type getters to ensure an option
+     * contains the expected type (for ex. getArrayOption()). 
+     * 
+     * @param string $name
+     * @param mixed $default The default value to return if the option does not exist.
+     * @return mixed
+     */
     public function getOption(string $name, $default=null)
     {
         if(!isset($this->options)) {
@@ -86,16 +86,16 @@ 
         return $default;
     }
     
-   /**
-    * Enforces that the option value is a string. Numbers are converted
-    * to string, strings are passed through, and all other types will 
-    * return the default value. The default value is also returned if
-    * the string is empty.
-    * 
-    * @param string $name
-    * @param string $default Used if the option does not exist, is invalid, or empty.
-    * @return string
-    */
+    /**
+     * Enforces that the option value is a string. Numbers are converted
+     * to string, strings are passed through, and all other types will 
+     * return the default value. The default value is also returned if
+     * the string is empty.
+     * 
+     * @param string $name
+     * @param string $default Used if the option does not exist, is invalid, or empty.
+     * @return string
+     */
     public function getStringOption(string $name, string $default='') : string
     {
         $value = $this->getOption($name, false);
@@ -107,15 +107,15 @@ 
         return $default;
     }
     
-   /**
-    * Treats the option value as a boolean value: will return
-    * true if the value actually is a boolean true.
-    * 
-    * NOTE: boolean string representations are not accepted.
-    * 
-    * @param string $name
-    * @return bool
-    */
+    /**
+     * Treats the option value as a boolean value: will return
+     * true if the value actually is a boolean true.
+     * 
+     * NOTE: boolean string representations are not accepted.
+     * 
+     * @param string $name
+     * @return bool
+     */
     public function getBoolOption(string $name, bool $default=false) : bool
     {
         if($this->getOption($name) === true) {
@@ -125,15 +125,15 @@ 
         return $default;
     }
     
-   /**
-    * Treats the option value as an integer value: will return
-    * valid integer values (also from integer strings), or the
-    * default value otherwise.
-    * 
-    * @param string $name
-    * @param int $default
-    * @return int
-    */
+    /**
+     * Treats the option value as an integer value: will return
+     * valid integer values (also from integer strings), or the
+     * default value otherwise.
+     * 
+     * @param string $name
+     * @param int $default
+     * @return int
+     */
     public function getIntOption(string $name, int $default=0) : int
     {
         $value = $this->getOption($name);
@@ -144,14 +144,14 @@ 
         return $default;
     }
     
-   /**
-    * Treats an option as an array, and returns its value
-    * only if it contains an array - otherwise, an empty
-    * array is returned.
-    * 
-    * @param string $name
-    * @return array
-    */
+    /**
+     * Treats an option as an array, and returns its value
+     * only if it contains an array - otherwise, an empty
+     * array is returned.
+     * 
+     * @param string $name
+     * @return array
+     */
     public function getArrayOption(string $name) : array
     {
         $val = $this->getOption($name);
@@ -162,13 +162,13 @@ 
         return array();
     }
     
-   /**
-    * Checks whether the specified option exists - even
-    * if it has a NULL value.
-    * 
-    * @param string $name
-    * @return bool
-    */
+    /**
+     * Checks whether the specified option exists - even
+     * if it has a NULL value.
+     * 
+     * @param string $name
+     * @return bool
+     */
     public function hasOption(string $name) : bool
     {
         if(!isset($this->options)) {
@@ -178,10 +178,10 @@ 
         return array_key_exists($name, $this->options);
     }
     
-   /**
-    * Returns all options in one associative array.
-    * @return array
-    */
+    /**
+     * Returns all options in one associative array.
+     * @return array
+     */
     public function getOptions() : array
     {
         if(!isset($this->options)) {
@@ -191,24 +191,24 @@ 
         return $this->options;
     }
     
-   /**
-    * Checks whether the option's value is the one specified.
-    * 
-    * @param string $name
-    * @param mixed $value
-    * @return bool
-    */
+    /**
+     * Checks whether the option's value is the one specified.
+     * 
+     * @param string $name
+     * @param mixed $value
+     * @return bool
+     */
     public function isOption(string $name, $value) : bool
     {
         return $this->getOption($name) === $value;
     }
     
-   /**
-    * Retrieves the default available options as an 
-    * associative array with option name => value pairs.
-    * 
-    * @return array
-    */
+    /**
+     * Retrieves the default available options as an 
+     * associative array with option name => value pairs.
+     * 
+     * @return array
+     */
     abstract public function getDefaultOptions() : array;
 }
 
@@ -226,24 +226,24 @@ 
  */
 interface Interface_Optionable
 {
-   /**
-    * @param string $name
-    * @param mixed $value
-    * @return $this
-    */
+    /**
+     * @param string $name
+     * @param mixed $value
+     * @return $this
+     */
     function setOption(string $name, $value);
     
-   /**
-    * @param string $name
-    * @param mixed $default
-    * @return $this
-    */
+    /**
+     * @param string $name
+     * @param mixed $default
+     * @return $this
+     */
     function getOption(string $name, $default=null);
     
-   /**
-    * @param array $options
-    * @return $this    
-    */
+    /**
+     * @param array $options
+     * @return $this    
+     */
     function setOptions(array $options);
     function getOptions() : array;
     function isOption(string $name, $value) : bool;

src/URLInfo/Highlighter.php

Indentation +10 added lines, -10 removed lines

@@ -20,9 +20,9 @@ 
  */
 class URLInfo_Highlighter
 {
-   /**
-    * @var URLInfo
-    */
+    /**
+     * @var URLInfo
+     */
     protected $info;
     
     public function __construct(URLInfo $info)
@@ -158,13 +158,13 @@ 
         );
     }
     
-   /**
-    * Fetches all parameters in the URL, regardless of 
-    * whether parameter exclusion is enabled, so they
-    * can be highlighted is need be.
-    * 
-    * @return array
-    */
+    /**
+     * Fetches all parameters in the URL, regardless of 
+     * whether parameter exclusion is enabled, so they
+     * can be highlighted is need be.
+     * 
+     * @return array
+     */
     protected function resolveParams() : array
     {
         $previous = $this->info->isParamExclusionEnabled();

src/NumberInfo.php

Indentation +78 added lines, -78 removed lines

@@ -38,24 +38,24 @@ 
  */
 class NumberInfo
 {
-   /**
-    * @var mixed
-    */
+    /**
+     * @var mixed
+     */
     protected $rawValue;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $info;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $empty = false;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $knownUnits = array(
         '%' => true,
         'rem' => true,
@@ -95,21 +95,21 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves the raw, internal information array resulting
-    * from the parsing of the number.
-    *  
-    * @return array
-    */
+    /**
+     * Retrieves the raw, internal information array resulting
+     * from the parsing of the number.
+     *  
+     * @return array
+     */
     public function getRawInfo() : array
     {
         return $this->info;
     }
     
-   /**
-    * Whether the number was empty (null or empty string).
-    * @return boolean
-    */
+    /**
+     * Whether the number was empty (null or empty string).
+     * @return boolean
+     */
     public function isEmpty() : bool
     {
         return $this->empty;
@@ -532,12 +532,12 @@ 
         return $cache[$key];
     }
     
-   /**
-    * Parses a string number notation with units included, e.g. 14px, 50%...
-    * 
-    * @param string $test
-    * @return array
-    */
+    /**
+     * Parses a string number notation with units included, e.g. 14px, 50%...
+     * 
+     * @param string $test
+     * @return array
+     */
     private function parseStringValue(string $test) : array
     {
         $number = null;
@@ -588,13 +588,13 @@ 
         return $this->filterInfo($result);
     }
     
-   /**
-    * Attempts to determine what kind of units are specified
-    * in the string. Returns NULL if none could be matched.
-    * 
-    * @param string $value
-    * @return array|NULL
-    */
+    /**
+     * Attempts to determine what kind of units are specified
+     * in the string. Returns NULL if none could be matched.
+     * 
+     * @param string $value
+     * @return array|NULL
+     */
     private function findUnits(string $value) : ?array
     {
         $vlength = strlen($value);
@@ -622,12 +622,12 @@ 
         return null;
     }
     
-   /**
-    * Creates the cache key for the specified value.
-    * 
-    * @param mixed $value
-    * @return string
-    */
+    /**
+     * Creates the cache key for the specified value.
+     * 
+     * @param mixed $value
+     * @return string
+     */
     private function createValueKey($value) : string
     {
         if(!is_string($value) && !is_numeric($value))
@@ -640,59 +640,59 @@ 
     
     protected $postProcess = false;
     
-   /**
-    * Called if explicitly enabled: allows filtering the 
-    * number after the detection process has completed.
-    * 
-    * @param string|NULL $number The adjusted number
-    * @param string $originalString The original value before it was parsed
-    * @return mixed
-    */
+    /**
+     * Called if explicitly enabled: allows filtering the 
+     * number after the detection process has completed.
+     * 
+     * @param string|NULL $number The adjusted number
+     * @param string $originalString The original value before it was parsed
+     * @return mixed
+     */
     protected function postProcess(?string $number, /** @scrutinizer ignore-unused */ string $originalString)
     {
         return $number;
     }
     
-   /**
-    * Filters the value before it is parsed, but only if it is a string.
-    * 
-    * NOTE: This may be overwritten in a subclass, to allow custom filtering
-    * the the values. An example of a use case would be a preprocessor for
-    * variables in a templating system.
-    * 
-    * @param string $trimmedString The trimmed value.
-    * @param array $cache The internal values cache array.
-    * @param string $originalValue The original value that the NumberInfo was created for.
-    * @return string
-    * 
-    * @see NumberInfo::enablePostProcess()
-    */
+    /**
+     * Filters the value before it is parsed, but only if it is a string.
+     * 
+     * NOTE: This may be overwritten in a subclass, to allow custom filtering
+     * the the values. An example of a use case would be a preprocessor for
+     * variables in a templating system.
+     * 
+     * @param string $trimmedString The trimmed value.
+     * @param array $cache The internal values cache array.
+     * @param string $originalValue The original value that the NumberInfo was created for.
+     * @return string
+     * 
+     * @see NumberInfo::enablePostProcess()
+     */
     protected function preProcess(string $trimmedString, /** @scrutinizer ignore-unused */ array &$cache, /** @scrutinizer ignore-unused */ string $originalValue) : string
     {
         return str_replace(',', '.', $trimmedString);
     }
     
-   /**
-    * Enables the post processing so the postProcess method gets called.
-    * This should be called in the {@link NumberInfo::preProcess()}
-    * method as needed.
-    * 
-    * @return NumberInfo
-    * @see NumberInfo::postProcess()
-    */
+    /**
+     * Enables the post processing so the postProcess method gets called.
+     * This should be called in the {@link NumberInfo::preProcess()}
+     * method as needed.
+     * 
+     * @return NumberInfo
+     * @see NumberInfo::postProcess()
+     */
     protected function enablePostProcess() : NumberInfo
     {
         $this->postProcess = true;
         return $this;
     }
     
-   /**
-    * Filters the number info array to adjust the units
-    * and number according to the required rules.
-    * 
-    * @param array $info
-    * @return array
-    */
+    /**
+     * Filters the number info array to adjust the units
+     * and number according to the required rules.
+     * 
+     * @param array $info
+     * @return array
+     */
     protected function filterInfo(array $info) : array
     {
         $useUnits = 'px';

src/ConvertHelper/QueryParser.php

Indentation +10 added lines, -10 removed lines

@@ -27,16 +27,16 @@
         
     }
     
-   /**
-    * We parse the query string ourselves, because the PHP implementation
-    * of parse_str has limitations that do not apply to query strings. This
-    * is due to the fact that parse_str has to create PHP-compatible variable
-    * names from the parameters. URL parameters simply allow way more things
-    * than PHP variable names.
-    * 
-    * @param string $queryString
-    * @return array
-    */
+    /**
+     * We parse the query string ourselves, because the PHP implementation
+     * of parse_str has limitations that do not apply to query strings. This
+     * is due to the fact that parse_str has to create PHP-compatible variable
+     * names from the parameters. URL parameters simply allow way more things
+     * than PHP variable names.
+     * 
+     * @param string $queryString
+     * @return array
+     */
     public function parse(string $queryString) : array
     {
         // allow HTML entities notation

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)) {

src/ConvertHelper/ControlCharacters.php

Indentation +43 added lines, -43 removed lines

@@ -22,9 +22,9 @@ 
 {
     const ERROR_MALFORMATTED_STRING = 53801;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected static $controlChars =  array(
         '0000-0008', // control chars
         '000E-000F', // control chars
@@ -32,19 +32,19 @@ 
         '2000-200F', // non-breaking space and co
     );
     
-   /**
-    * @var string|NULL
-    */
+    /**
+     * @var string|NULL
+     */
     protected static $controlCharsRegex;
 
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected static $hexAlphabet = array('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F');
     
-   /**
-    * @var string[]|NULL
-    */
+    /**
+     * @var string[]|NULL
+     */
     protected static $charsAsHex;
     
     public function __construct()
@@ -67,13 +67,13 @@ 
         }
     }
     
-   /**
-    * Retrieves the HEX character codes for all control
-    * characters that the {@link stripControlCharacters()}
-    * method will remove.
-    *
-    * @return string[]
-    */
+    /**
+     * Retrieves the HEX character codes for all control
+     * characters that the {@link stripControlCharacters()}
+     * method will remove.
+     *
+     * @return string[]
+     */
     public function getCharsAsHex() : array
     {
         if (isset(self::$charsAsHex))
@@ -120,13 +120,13 @@ 
         return $stack;
     }
     
-   /**
-    * Retrieves an array of all control characters that
-    * the {@link stripControlCharacters()} method will
-    * remove, as the actual UTF-8 characters.
-    *
-    * @return string[]
-    */
+    /**
+     * Retrieves an array of all control characters that
+     * the {@link stripControlCharacters()} method will
+     * remove, as the actual UTF-8 characters.
+     *
+     * @return string[]
+     */
     public function getCharsAsUTF8() : array
     {
         $chars = $this->getCharsAsHex();
@@ -139,12 +139,12 @@ 
         return $result;
     }
     
-   /**
-    * Retrieves all control characters as JSON encoded
-    * characters, e.g. "\u200b".
-    *
-    * @return string[]
-    */
+    /**
+     * Retrieves all control characters as JSON encoded
+     * characters, e.g. "\u200b".
+     *
+     * @return string[]
+     */
     public function getCharsAsJSON() : array
     {
         $chars = $this->getCharsAsHex();
@@ -157,17 +157,17 @@ 
         return $result;
     }
     
-   /**
-    * Removes all control characters from the specified string
-    * that can cause problems in some cases, like creating
-    * valid XML documents. This includes invisible non-breaking
-    * spaces.
-    *
-    * @param string $string
-    * @return string
-    * @see https://stackoverflow.com/a/8171868/2298192
-    * @see https://unicode-table.com/en
-    */
+    /**
+     * Removes all control characters from the specified string
+     * that can cause problems in some cases, like creating
+     * valid XML documents. This includes invisible non-breaking
+     * spaces.
+     *
+     * @param string $string
+     * @return string
+     * @see https://stackoverflow.com/a/8171868/2298192
+     * @see https://unicode-table.com/en
+     */
     public function stripControlCharacters(string $string) : string
     {
         if(empty($string))