Mistralys / application-utils

src/Traits/Optionable.php

Indentation +72 added lines, -72 removed lines

@@ -26,9 +26,9 @@ 
  */
 trait Traits_Optionable
 {
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $options;
 
     /**
@@ -49,13 +49,13 @@ 
         return $this;
     }
     
-   /**
-    * Sets a collection of options at once, from an
-    * associative array.
-    * 
-    * @param array<string,mixed> $options
-    * @return $this
-    */
+    /**
+     * Sets a collection of options at once, from an
+     * associative array.
+     * 
+     * @param array<string,mixed> $options
+     * @return $this
+     */
     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);
@@ -128,15 +128,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);
@@ -147,14 +147,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);
@@ -165,13 +165,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)) {
@@ -181,11 +181,11 @@ 
         return array_key_exists($name, $this->options);
     }
     
-   /**
-    * Returns all options in one associative array.
-    *
-    * @return array<string,mixed>
-    */
+    /**
+     * Returns all options in one associative array.
+     *
+     * @return array<string,mixed>
+     */
     public function getOptions() : array
     {
         if(!isset($this->options)) {
@@ -195,23 +195,23 @@ 
         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<string,mixed>
-    */
+    /**
+     * Retrieves the default available options as an
+     * associative array with option name => value pairs.
+     *
+     * @return array<string,mixed>
+     */
     abstract public function getDefaultOptions() : array;
 }

Spacing +14 added lines, -14 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;
         }
         
@@ -119,9 +119,9 @@ 
      * @param bool $default
      * @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;
         }
         
@@ -137,10 +137,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;
         }
         
@@ -158,7 +158,7 @@ 
     public function getArrayOption(string $name) : array
     {
         $val = $this->getOption($name);
-        if(is_array($val)) {
+        if (is_array($val)) {
             return $val;
         }
         
@@ -174,7 +174,7 @@ 
     */
     public function hasOption(string $name) : bool
     {
-        if(!isset($this->options)) {
+        if (!isset($this->options)) {
             $this->options = $this->getDefaultOptions();
         }
         
@@ -188,7 +188,7 @@ 
     */
     public function getOptions() : array
     {
-        if(!isset($this->options)) {
+        if (!isset($this->options)) {
             $this->options = $this->getDefaultOptions();
         }
         

src/Traits/Classable.php

Indentation +17 added lines, -17 removed lines

@@ -25,9 +25,9 @@ 
  */
 trait Traits_Classable
 {
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $classes = array();
     
     public function addClass(string $name)
@@ -65,30 +65,30 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves a list of all classes, if any.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all classes, if any.
+     * 
+     * @return string[]
+     */
     public function getClasses() : array
     {
         return $this->classes;
     }
     
-   /**
-    * Renders the class names list as space-separated string for use in an HTML tag.
-    * 
-    * @return string
-    */
+    /**
+     * Renders the class names list as space-separated string for use in an HTML tag.
+     * 
+     * @return string
+     */
     public function classesToString() : string
     {
         return implode(' ', $this->classes);
     }
     
-   /**
-    * Renders the "class" attribute string for inserting into an HTML tag.
-    * @return string
-    */
+    /**
+     * Renders the "class" attribute string for inserting into an HTML tag.
+     * @return string
+     */
     public function classesToAttribute() : string
     {
         if(!empty($this->classes))

src/StringBuilder.php

Indentation +147 added lines, -147 removed lines

@@ -33,24 +33,24 @@ 
  */
 class StringBuilder implements StringBuilder_Interface
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $separator = ' ';
 
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $strings = array();
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $mode = 'html';
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $noSpace = '§!§';
     
     public function __construct()
@@ -58,12 +58,12 @@ 
         
     }
     
-   /**
-    * Adds a subject as a string. Is ignored if empty.
-    * 
-    * @param string|number|StringBuilder_Interface $string
-    * @return $this
-    */
+    /**
+     * Adds a subject as a string. Is ignored if empty.
+     * 
+     * @param string|number|StringBuilder_Interface $string
+     * @return $this
+     */
     public function add($string) : StringBuilder
     {
         $string = strval($string);
@@ -76,57 +76,57 @@ 
         return $this;
     }
     
-   /**
-    * Adds a string without appending an automatic space.
-    * 
-    * @param string|number|StringBuilder_Interface $string
-    * @return $this
-    */
+    /**
+     * Adds a string without appending an automatic space.
+     * 
+     * @param string|number|StringBuilder_Interface $string
+     * @return $this
+     */
     public function nospace($string) : StringBuilder
     {
         return $this->add($this->noSpace.strval($string));
     }
     
-   /**
-    * Adds raw HTML code. Does not add an automatic space.
-    * 
-    * @param string|number|StringBuilder_Interface $html
-    * @return $this
-    */
+    /**
+     * Adds raw HTML code. Does not add an automatic space.
+     * 
+     * @param string|number|StringBuilder_Interface $html
+     * @return $this
+     */
     public function html($html) : StringBuilder
     {
         return $this->nospace($html);
     }
     
-   /**
-    * Adds an unordered list with the specified items.
-    * 
-    * @param array<int,string|number|StringBuilder_Interface> $items
-    * @return $this
-    */
+    /**
+     * Adds an unordered list with the specified items.
+     * 
+     * @param array<int,string|number|StringBuilder_Interface> $items
+     * @return $this
+     */
     public function ul(array $items) : StringBuilder
     {
         return $this->list('ul', $items);
     }
     
-   /**
-    * Adds an ordered list with the specified items.
-    * 
-    * @param array<int,string|number|StringBuilder_Interface> $items
-    * @return $this
-    */
+    /**
+     * Adds an ordered list with the specified items.
+     * 
+     * @param array<int,string|number|StringBuilder_Interface> $items
+     * @return $this
+     */
     public function ol(array $items) : StringBuilder
     {
         return $this->list('ol', $items);
     }
     
-   /**
-    * Creates a list tag with the items list.
-    * 
-    * @param string $type The list type, `ol` or `ul`.
-    * @param array<int,string|number|StringBuilder_Interface> $items
-    * @return $this
-    */
+    /**
+     * Creates a list tag with the items list.
+     * 
+     * @param string $type The list type, `ol` or `ul`.
+     * @param array<int,string|number|StringBuilder_Interface> $items
+     * @return $this
+     */
     protected function list(string $type, array $items) : StringBuilder
     {
         return $this->html(sprintf(
@@ -136,13 +136,13 @@ 
         ));
     }
     
-   /**
-    * Add a translated string.
-    * 
-    * @param string $format The native string to translate.
-    * @param array<int,mixed> $arguments The variables to inject into the translated string, if any.
-    * @return $this
-    */
+    /**
+     * Add a translated string.
+     * 
+     * @param string $format The native string to translate.
+     * @param array<int,mixed> $arguments The variables to inject into the translated string, if any.
+     * @return $this
+     */
     public function t(string $format, ...$arguments) : StringBuilder
     {
         array_unshift($arguments, $format);
@@ -158,47 +158,47 @@ 
         ));
     }
     
-   /**
-    * Adds a "5 months ago" age since the specified date.
-    * 
-    * @param DateTime $since
-    * @return $this
-    */
+    /**
+     * Adds a "5 months ago" age since the specified date.
+     * 
+     * @param DateTime $since
+     * @return $this
+     */
     public function age(DateTime $since) : StringBuilder
     {
         return $this->add(ConvertHelper::duration2string($since));
     }
     
-   /**
-    * Adds HTML quotes around the string.
-    * 
-    * @param string|number|StringBuilder_Interface $string
-    * @return $this
-    */
+    /**
+     * Adds HTML quotes around the string.
+     * 
+     * @param string|number|StringBuilder_Interface $string
+     * @return $this
+     */
     public function quote($string)
     {
         return $this->sf('&quot;%s&quot;', strval($string));
     }
     
-   /**
-    * Adds a text that is meant as a reference to an UI element,
-    * like a menu item, button, etc.
-    * 
-    * @param string|number|StringBuilder_Interface $string 
-    * @return $this
-    */
+    /**
+     * Adds a text that is meant as a reference to an UI element,
+     * like a menu item, button, etc.
+     * 
+     * @param string|number|StringBuilder_Interface $string 
+     * @return $this
+     */
     public function reference($string) : StringBuilder
     {
         return $this->sf('"%s"', $string);
     }
 
-   /**
-    * Add a string using the `sprintf` method.
-    * 
-    * @param string $format The format string
-    * @param string|number|StringBuilder_Interface ...$arguments The variables to inject
-    * @return $this
-    */
+    /**
+     * Add a string using the `sprintf` method.
+     * 
+     * @param string $format The format string
+     * @param string|number|StringBuilder_Interface ...$arguments The variables to inject
+     * @return $this
+     */
     public function sf(string $format, ...$arguments) : StringBuilder
     {
         array_unshift($arguments, $format);
@@ -206,12 +206,12 @@ 
         return $this->add(call_user_func_array('sprintf', $arguments));
     }
     
-   /**
-    * Adds a bold string.
-    * 
-    * @param string|number|StringBuilder_Interface $string
-    * @return $this
-    */
+    /**
+     * Adds a bold string.
+     * 
+     * @param string|number|StringBuilder_Interface $string
+     * @return $this
+     */
     public function bold($string) : StringBuilder
     {
         return $this->sf(
@@ -220,12 +220,12 @@ 
         );
     }
     
-   /**
-    * Adds a HTML `br` tag.
-    * 
-    * @return $this
-    * @see StringBuilder::eol()
-    */
+    /**
+     * Adds a HTML `br` tag.
+     * 
+     * @return $this
+     * @see StringBuilder::eol()
+     */
     public function nl() : StringBuilder
     {
         return $this->html('<br>');
@@ -242,41 +242,41 @@ 
         return $this->nospace(PHP_EOL);
     }
     
-   /**
-    * Adds the current time, in the format <code>H:i:s</code>.
-    * 
-    * @return $this
-    */
+    /**
+     * Adds the current time, in the format <code>H:i:s</code>.
+     * 
+     * @return $this
+     */
     public function time() : StringBuilder
     {
         return $this->add(date('H:i:s'));
     }
     
-   /**
-    * Adds the "Note:" text.
-    * 
-    * @return $this
-    */
+    /**
+     * Adds the "Note:" text.
+     * 
+     * @return $this
+     */
     public function note() : StringBuilder
     {
         return $this->t('Note:');
     }
     
-   /**
-    * Like `note()`, but as bold text.
-    * 
-    * @return $this
-    */
+    /**
+     * Like `note()`, but as bold text.
+     * 
+     * @return $this
+     */
     public function noteBold() : StringBuilder
     {
         return $this->bold(sb()->note());
     }
     
-   /**
-    * Adds the "Hint:" text.
-    * 
-    * @return $this
-    */
+    /**
+     * Adds the "Hint:" text.
+     * 
+     * @return $this
+     */
     public function hint() : StringBuilder
     {
         return $this->t('Hint:');
@@ -287,12 +287,12 @@ 
         return $this->bold(sb()->hint());
     }
     
-   /**
-    * Adds two linebreaks.
-    *
-    * @param StringBuilder_Interface|string|NULL $content
-    * @return $this
-    */
+    /**
+     * Adds two linebreaks.
+     *
+     * @param StringBuilder_Interface|string|NULL $content
+     * @return $this
+     */
     public function para($content=null) : StringBuilder
     {
         if($content !== null) {
@@ -302,14 +302,14 @@ 
         return $this->nl()->nl();
     }
     
-   /**
-    * Adds an anchor HTML tag.
-    * 
-    * @param string $label
-    * @param string $url
-    * @param bool $newTab
-    * @return $this
-    */
+    /**
+     * Adds an anchor HTML tag.
+     * 
+     * @param string $label
+     * @param string $url
+     * @param bool $newTab
+     * @return $this
+     */
     public function link(string $label, string $url, bool $newTab=false) : StringBuilder
     {
         $target = '';
@@ -325,12 +325,12 @@ 
         );
     }
     
-   /**
-    * Wraps the string in a `code` tag.
-    * 
-    * @param string|number|StringBuilder_Interface $string
-    * @return $this
-    */
+    /**
+     * Wraps the string in a `code` tag.
+     * 
+     * @param string|number|StringBuilder_Interface $string
+     * @return $this
+     */
     public function code($string) : StringBuilder
     {
         return $this->sf(
@@ -339,24 +339,24 @@ 
         );
     }
     
-   /**
-    * Wraps the string in a `pre` tag.
-    * 
-    * @param string|number|StringBuilder_Interface $string
-    * @return $this
-    */
+    /**
+     * Wraps the string in a `pre` tag.
+     * 
+     * @param string|number|StringBuilder_Interface $string
+     * @return $this
+     */
     public function pre($string) : StringBuilder
     {
         return $this->sf('<pre>%s</pre>', strval($string));
     }
     
-   /**
-    * Wraps the text in a `span` tag with the specified classes.
-    * 
-    * @param string|number|StringBuilder_Interface $string
-    * @param string|string[] $classes
-    * @return $this
-    */
+    /**
+     * Wraps the text in a `span` tag with the specified classes.
+     * 
+     * @param string|number|StringBuilder_Interface $string
+     * @param string|string[] $classes
+     * @return $this
+     */
     public function spanned($string, $classes) : StringBuilder
     {
         if(!is_array($classes)) 

Spacing +7 added lines, -7 removed lines

@@ -68,7 +68,7 @@ 
     {
         $string = strval($string);
         
-        if(!empty($string)) 
+        if (!empty($string)) 
         {
             $this->strings[] = $string;
         }
@@ -147,7 +147,7 @@ 
     {
         array_unshift($arguments, $format);
         
-        if(!class_exists('\AppLocalize\Localization'))
+        if (!class_exists('\AppLocalize\Localization'))
         {
             return $this->sf(...$arguments);
         }
@@ -293,9 +293,9 @@ 
     * @param StringBuilder_Interface|string|NULL $content
     * @return $this
     */
-    public function para($content=null) : StringBuilder
+    public function para($content = null) : StringBuilder
     {
-        if($content !== null) {
+        if ($content !== null) {
             return $this->html('<p>')->nospace($content)->html('</p>');
         }
 
@@ -310,10 +310,10 @@ 
     * @param bool $newTab
     * @return $this
     */
-    public function link(string $label, string $url, bool $newTab=false) : StringBuilder
+    public function link(string $label, string $url, bool $newTab = false) : StringBuilder
     {
         $target = '';
-        if($newTab) {
+        if ($newTab) {
             $target = ' target="_blank"';
         }
        
@@ -359,7 +359,7 @@ 
     */
     public function spanned($string, $classes) : StringBuilder
     {
-        if(!is_array($classes)) 
+        if (!is_array($classes)) 
         {
             $classes = array(strval($classes));
         }

src/Interface/Optionable.php

Spacing +1 added lines, -1 removed lines

@@ -45,7 +45,7 @@
      * @param mixed $default The default value to return if the option does not exist.
      * @return mixed
      */
-    function getOption(string $name, $default=null);
+    function getOption(string $name, $default = null);
 
     /**
      * Sets a collection of options at once, from an