Mistralys / application-utils

src/Traits/Optionable.php

Indentation +102 added lines, -102 removed lines

@@ -26,19 +26,19 @@ 
  */
 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 $default
-    * @return Interface_Optionable
-    */
+    /**
+     * Sets an option to the specified value. This can be any
+     * kind of variable type, including objects, as needed.
+     * 
+     * @param string $name
+     * @param mixed $default
+     * @return Interface_Optionable
+     */
     public function setOption(string $name, $value)
     {
         if(!isset($this->options)) {
@@ -49,13 +49,13 @@ 
         return $this;
     }
     
-   /**
-    * Sets a collection of options at once, from an
-    * associative array.
-    * 
-    * @param array $options
-    * @return Interface_Optionable
-    */
+    /**
+     * Sets a collection of options at once, from an
+     * associative array.
+     * 
+     * @param array $options
+     * @return Interface_Optionable
+     */
     public function setOptions(array $options)
     {
         foreach($options as $name => $value) {
@@ -65,16 +65,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)) {
@@ -88,16 +88,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);
@@ -109,15 +109,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) {
@@ -127,15 +127,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);
@@ -146,14 +146,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);
@@ -164,13 +164,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)) {
@@ -180,10 +180,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)) {
@@ -193,24 +193,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;
 }
 
@@ -228,24 +228,24 @@ 
  */
 interface Interface_Optionable
 {
-   /**
-    * @param string $name
-    * @param mixed $value
-    * @return Interface_Optionable
-    */
+    /**
+     * @param string $name
+     * @param mixed $value
+     * @return Interface_Optionable
+     */
     function setOption(string $name, $value);
     
-   /**
-    * @param string $name
-    * @param mixed $default
-    * @return Interface_Optionable
-    */
+    /**
+     * @param string $name
+     * @param mixed $default
+     * @return Interface_Optionable
+     */
     function getOption(string $name, $default=null);
     
-   /**
-    * @param array $options
-    * @return Interface_Optionable    
-    */
+    /**
+     * @param array $options
+     * @return Interface_Optionable    
+     */
     function setOptions(array $options);
     function getOptions() : array;
     function isOption(string $name, $value) : bool;

Spacing +15 added lines, -15 removed lines

@@ -41,7 +41,7 @@ 
     */
     public function setOption(string $name, $value)
     {
-        if(!isset($this->options)) {
+        if (!isset($this->options)) {
             $this->options = $this->getDefaultOptions();
         }
         
@@ -58,7 +58,7 @@ 
     */
     public function setOptions(array $options)
     {
-        foreach($options as $name => $value) {
+        foreach ($options as $name => $value) {
             $this->setOption($name, $value);
         }
         
@@ -75,13 +75,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];
         }
         
@@ -98,11 +98,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;
         }
         
@@ -118,9 +118,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;
         }
         
@@ -136,10 +136,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;
         }
         
@@ -157,7 +157,7 @@ 
     public function getArrayOption(string $name) : array
     {
         $val = $this->getOption($name);
-        if(is_array($val)) {
+        if (is_array($val)) {
             return $val;
         }
         
@@ -173,7 +173,7 @@ 
     */
     public function hasOption(string $name) : bool
     {
-        if(!isset($this->options)) {
+        if (!isset($this->options)) {
             $this->options = $this->getDefaultOptions();
         }
         
@@ -186,7 +186,7 @@ 
     */
     public function getOptions() : array
     {
-        if(!isset($this->options)) {
+        if (!isset($this->options)) {
             $this->options = $this->getDefaultOptions();
         }
         
@@ -240,7 +240,7 @@ 
     * @param mixed $default
     * @return Interface_Optionable
     */
-    function getOption(string $name, $default=null);
+    function getOption(string $name, $default = null);
     
    /**
     * @param array $options