Mistralys / application-utils

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;

Spacing +15 added lines, -15 removed lines

@@ -40,7 +40,7 @@ 
     */
     public function setOption(string $name, $value)
     {
-        if(!isset($this->options)) {
+        if (!isset($this->options)) {
             $this->options = $this->getDefaultOptions();
         }
         
@@ -56,7 +56,7 @@ 
     */
     public function setOptions(array $options)
     {
-        foreach($options as $name => $value) {
+        foreach ($options as $name => $value) {
             $this->setOption($name, $value);
         }
         
@@ -73,13 +73,13 @@ 
     * @param mixed $default The default value to return if the option does not exist.
     * @return mixed
     */
-    public function getOption(string $name, $default=null)
+    public function getOption(string $name, $default = null)
     {
-        if(!isset($this->options)) {
+        if (!isset($this->options)) {
             $this->options = $this->getDefaultOptions();
         }
         
-        if(isset($this->options[$name])) {
+        if (isset($this->options[$name])) {
             return $this->options[$name];
         }
         
@@ -96,11 +96,11 @@ 
     * @param string $default Used if the option does not exist, is invalid, or empty.
     * @return string
     */
-    public function getStringOption(string $name, string $default='') : string
+    public function getStringOption(string $name, string $default = '') : string
     {
         $value = $this->getOption($name, false);
         
-        if((is_string($value) || is_numeric($value)) && !empty($value)) {
+        if ((is_string($value) || is_numeric($value)) && !empty($value)) {
             return (string)$value;
         }
         
@@ -116,9 +116,9 @@ 
     * @param string $name
     * @return bool
     */
-    public function getBoolOption(string $name, bool $default=false) : bool
+    public function getBoolOption(string $name, bool $default = false) : bool
     {
-        if($this->getOption($name) === true) {
+        if ($this->getOption($name) === true) {
             return true;
         }
         
@@ -134,10 +134,10 @@ 
     * @param int $default
     * @return int
     */
-    public function getIntOption(string $name, int $default=0) : int
+    public function getIntOption(string $name, int $default = 0) : int
     {
         $value = $this->getOption($name);
-        if(ConvertHelper::isInteger($value)) {
+        if (ConvertHelper::isInteger($value)) {
             return (int)$value;
         }
         
@@ -155,7 +155,7 @@ 
     public function getArrayOption(string $name) : array
     {
         $val = $this->getOption($name);
-        if(is_array($val)) {
+        if (is_array($val)) {
             return $val;
         }
         
@@ -171,7 +171,7 @@ 
     */
     public function hasOption(string $name) : bool
     {
-        if(!isset($this->options)) {
+        if (!isset($this->options)) {
             $this->options = $this->getDefaultOptions();
         }
         
@@ -184,7 +184,7 @@ 
     */
     public function getOptions() : array
     {
-        if(!isset($this->options)) {
+        if (!isset($this->options)) {
             $this->options = $this->getDefaultOptions();
         }
         
@@ -238,7 +238,7 @@ 
     * @param mixed $default
     * @return $this
     */
-    function getOption(string $name, $default=null);
+    function getOption(string $name, $default = null);
     
    /**
     * @param array $options

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();

Spacing +15 added lines, -15 removed lines

@@ -77,7 +77,7 @@ 
             'fragment'
         );
         
-        foreach($parts as $part) 
+        foreach ($parts as $part) 
         {
             $method = 'render_'.$part;
             $result[] = (string)$this->$method();
@@ -88,7 +88,7 @@ 
     
     protected function render_scheme() : string
     {
-        if(!$this->info->hasScheme()) {
+        if (!$this->info->hasScheme()) {
             return '';
         }
         
@@ -103,7 +103,7 @@ 
     
     protected function render_username() : string
     {
-        if(!$this->info->hasUsername()) {
+        if (!$this->info->hasUsername()) {
             return '';
         }
         
@@ -119,7 +119,7 @@ 
     
     protected function render_host() : string
     {
-        if(!$this->info->hasHost()) {
+        if (!$this->info->hasHost()) {
             return '';
         }
         
@@ -131,7 +131,7 @@ 
     
     protected function render_port() : string
     {
-        if(!$this->info->hasPort()) {
+        if (!$this->info->hasPort()) {
             return '';
         }
         
@@ -144,7 +144,7 @@ 
        
     protected function render_path() : string
     {
-        if(!$this->info->hasPath()) {
+        if (!$this->info->hasPath()) {
             return '';
         }
         
@@ -169,7 +169,7 @@ 
     {
         $previous = $this->info->isParamExclusionEnabled();
         
-        if($previous)
+        if ($previous)
         {
             $this->info->setParamExclusion(false);
         }
@@ -185,19 +185,19 @@ 
     {
         $params = $this->resolveParams();
         
-        if(empty($params)) {
+        if (empty($params)) {
             return '';
         }
         
         $tokens = array();
         $excluded = array();
         
-        if($this->info->isParamExclusionEnabled())
+        if ($this->info->isParamExclusionEnabled())
         {
             $excluded = $this->info->getExcludedParams();
         }
         
-        foreach($params as $param => $value)
+        foreach ($params as $param => $value)
         {
             $parts = sprintf(
                 '<span class="link-param-name">%s</span>'.
@@ -214,7 +214,7 @@ 
             
             $tag = $this->resolveTag($excluded, $param);
             
-            if(!empty($tag))
+            if (!empty($tag))
             {
                 $tokens[] = sprintf($tag, $parts);
             }
@@ -228,13 +228,13 @@ 
     protected function resolveTag(array $excluded, string $paramName) : string
     {
         // regular, non-excluded parameter
-        if(!isset($excluded[$paramName]))
+        if (!isset($excluded[$paramName]))
         {
             return '<span class="link-param">%s</span>';
         }
 
         // highlight excluded parameters is disabled, ignore this parameter
-        if(!$this->info->isHighlightExcludeEnabled())
+        if (!$this->info->isHighlightExcludeEnabled())
         {
             return '';
         }
@@ -250,7 +250,7 @@ 
      
     protected function render_fragment() : string
     {
-        if(!$this->info->hasFragment()) {
+        if (!$this->info->hasFragment()) {
             return '';
         }
         
@@ -265,7 +265,7 @@ 
     {
         $cssFolder = realpath(__DIR__.'/../../css');
         
-        if($cssFolder === false) {
+        if ($cssFolder === false) {
             throw new BaseException(
                 'Cannot find package CSS folder.',
                 null,

src/URLInfo/Parser.php

Indentation +17 added lines, -17 removed lines

@@ -20,24 +20,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;
     
     /**
@@ -177,11 +177,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();

Spacing +21 added lines, -21 removed lines

@@ -59,7 +59,7 @@ 
         
         $this->parse();
         
-        if(!$this->detectType()) {
+        if (!$this->detectType()) {
             $this->validate();
         }
     }
@@ -93,11 +93,11 @@ 
             'phoneLink'
         );
         
-        foreach($types as $type)
+        foreach ($types as $type)
         {
             $method = 'detectType_'.$type;
             
-            if($this->$method() === true) 
+            if ($this->$method() === true) 
             {
                 $this->isValid = true;
                 return true;
@@ -115,11 +115,11 @@ 
             'hostIsPresent'
         );
         
-        foreach($validations as $validation) 
+        foreach ($validations as $validation) 
         {
             $method = 'validate_'.$validation;
             
-            if($this->$method() !== true) {
+            if ($this->$method() !== true) {
                 return;
             }
         }
@@ -132,13 +132,13 @@ 
         // 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'])) {
             return true;
         }
         
         $this->setError(
             URLInfo::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.')
         );
 
@@ -147,7 +147,7 @@ 
     
     protected function validate_schemeIsSet() : bool
     {
-        if(isset($this->info['scheme'])) {
+        if (isset($this->info['scheme'])) {
             return true;
         }
         
@@ -164,13 +164,13 @@ 
     
     protected function validate_schemeIsKnown() : bool
     {
-        if(in_array($this->info['scheme'], $this->knownSchemes)) {
+        if (in_array($this->info['scheme'], $this->knownSchemes)) {
             return true;
         }
         
         $this->setError(
             URLInfo::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))
         );
 
@@ -187,23 +187,23 @@ 
         $this->info['params'] = array();
         $this->info['type'] = URLInfo::TYPE_URL;
         
-        if(isset($this->info['user'])) {
+        if (isset($this->info['user'])) {
             $this->info['user'] = urldecode($this->info['user']);
         }
 
-        if(isset($this->info['pass'])) {
+        if (isset($this->info['pass'])) {
             $this->info['pass'] = urldecode($this->info['pass']);
         }
         
-        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']);
         }
         
-        if(isset($this->info['query']) && !empty($this->info['query']))
+        if (isset($this->info['query']) && !empty($this->info['query']))
         {
             $this->info['params'] = \AppUtils\ConvertHelper::parseQueryString($this->info['query']);
             ksort($this->info['params']);
@@ -212,12 +212,12 @@ 
     
     protected function detectType_email() : bool
     {
-        if(isset($this->info['scheme']) && $this->info['scheme'] == 'mailto') {
+        if (isset($this->info['scheme']) && $this->info['scheme'] == 'mailto') {
             $this->info['type'] = URLInfo::TYPE_EMAIL;
             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'] = 'mailto';
             $this->info['type'] = URLInfo::TYPE_EMAIL;
@@ -229,7 +229,7 @@ 
     
     protected function detectType_fragmentLink() : bool
     {
-        if(isset($this->info['fragment']) && !isset($this->info['scheme'])) {
+        if (isset($this->info['fragment']) && !isset($this->info['scheme'])) {
             $this->info['type'] = URLInfo::TYPE_FRAGMENT;
             return true;
         }
@@ -239,7 +239,7 @@ 
     
     protected function detectType_phoneLink() : bool
     {
-        if(isset($this->info['scheme']) && $this->info['scheme'] == 'tel') {
+        if (isset($this->info['scheme']) && $this->info['scheme'] == 'tel') {
             $this->info['type'] = URLInfo::TYPE_PHONE;
             return true;
         }
@@ -264,7 +264,7 @@ 
 
     public function getErrorMessage() : string
     {
-        if(isset($this->error)) {
+        if (isset($this->error)) {
             return $this->error['message'];
         }
         
@@ -273,7 +273,7 @@ 
     
     public function getErrorCode() : int
     {
-        if(isset($this->error)) {
+        if (isset($this->error)) {
             return $this->error['code'];
         }