Mistralys / application-utils

src/Request/Param/Validator/Array.php

Spacing +2 added lines, -2 removed lines

@@ -28,11 +28,11 @@
     protected function _validate()
     {
         // subvalues cannot be arrays
-        if($this->isSubvalue) {
+        if ($this->isSubvalue) {
             return $this->value;
         }
         
-        if(is_array($this->value)) {
+        if (is_array($this->value)) {
             return $this->value;
         }
         

src/Request/Param/Validator/Valueslist.php

Spacing +5 added lines, -5 removed lines

@@ -33,22 +33,22 @@
         
         // if we are validating a subvalue, it means we are 
         // validating a single value in the existing list.
-        if($this->isSubvalue) 
+        if ($this->isSubvalue) 
         {
-            if(in_array($this->value, $allowed)) {
+            if (in_array($this->value, $allowed)) {
                 return $this->value;
             }
             
             return null;
         }
         
-        if(!is_array($this->value)) {
+        if (!is_array($this->value)) {
             return array();
         }
         
         $keep = array();
-        foreach($this->value as $item) {
-            if(in_array($item, $allowed)) {
+        foreach ($this->value as $item) {
+            if (in_array($item, $allowed)) {
                 $keep[] = $item;
             }
         }

src/RequestHelper/Boundaries/Boundary.php

Indentation +47 added lines, -47 removed lines

@@ -19,34 +19,34 @@ 
  */
 class RequestHelper_Boundaries_Boundary
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $content;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $dispositionParams = array();
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $contentType = '';
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $contentEncoding = '';
     
-   /**
-    * @var RequestHelper_Boundaries
-    */
+    /**
+     * @var RequestHelper_Boundaries
+     */
     protected $boundaries;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $transferEncoding = '';
     
     public function __construct(RequestHelper_Boundaries $boundaries, string $content)
@@ -60,46 +60,46 @@ 
         return strlen($this->content);
     }
     
-   /**
-    * Sets the name of the request parameter.
-    * 
-    * @param string $name
-    * @return RequestHelper_Boundaries_Boundary
-    */
+    /**
+     * Sets the name of the request parameter.
+     * 
+     * @param string $name
+     * @return RequestHelper_Boundaries_Boundary
+     */
     public function setName(string $name) : RequestHelper_Boundaries_Boundary
     {
         return $this->setDispositionParam('name', $name);
     }
     
-   /**
-    * Sets the filename to use for the content, if applicable.
-    *  
-    * @param string $fileName
-    * @return RequestHelper_Boundaries_Boundary
-    */
+    /**
+     * Sets the filename to use for the content, if applicable.
+     *  
+     * @param string $fileName
+     * @return RequestHelper_Boundaries_Boundary
+     */
     public function setFileName(string $fileName) : RequestHelper_Boundaries_Boundary
     {
         return $this->setDispositionParam('filename', $fileName);
     }
     
-   /**
-    * Sets the content type to use for the content.
-    * 
-    * @param string $contentType
-    * @return RequestHelper_Boundaries_Boundary
-    */
+    /**
+     * Sets the content type to use for the content.
+     * 
+     * @param string $contentType
+     * @return RequestHelper_Boundaries_Boundary
+     */
     public function setContentType(string $contentType) : RequestHelper_Boundaries_Boundary
     {
         $this->contentType = $contentType;
         return $this;
     }
     
-   /**
-    * Sets the encoding to specify for the content.
-    * 
-    * @param string $encoding An encoding string, e.g. "UTF-8", "ASCII"
-    * @return RequestHelper_Boundaries_Boundary
-    */
+    /**
+     * Sets the encoding to specify for the content.
+     * 
+     * @param string $encoding An encoding string, e.g. "UTF-8", "ASCII"
+     * @return RequestHelper_Boundaries_Boundary
+     */
     public function setContentEncoding(string $encoding) : RequestHelper_Boundaries_Boundary
     {
         $this->contentEncoding = $encoding;
@@ -119,11 +119,11 @@ 
         return $this;
     }
     
-   /**
-    * Renders the mime boundary text.
-    * 
-    * @return string
-    */
+    /**
+     * Renders the mime boundary text.
+     * 
+     * @return string
+     */
     public function render()
     {
         $eol = $this->boundaries->getEOL();

Spacing +8 added lines, -8 removed lines

@@ -132,12 +132,12 @@ 
         $lines[] = '--'.$this->boundaries->getMimeBoundary();
         $lines[] = $this->renderContentDisposition();
         
-        if(!empty($this->contentType)) 
+        if (!empty($this->contentType)) 
         {
             $lines[] = $this->renderContentType();
         }
         
-        if(!empty($this->transferEncoding))
+        if (!empty($this->transferEncoding))
         {
             $lines[] = $this->renderTransferEncoding();
         }
@@ -152,9 +152,9 @@ 
     {
         $result = 'Content-Disposition: form-data';
         
-        foreach($this->dispositionParams as $name => $value) 
+        foreach ($this->dispositionParams as $name => $value) 
         {
-            $result .= '; '.$name.'="' . $value . '"';
+            $result .= '; '.$name.'="'.$value.'"';
         }   
         
         return $result;
@@ -162,11 +162,11 @@ 
     
     protected function renderContentType() : string
     {
-        $result = 'Content-Type: ' . $this->contentType; 
+        $result = 'Content-Type: '.$this->contentType; 
         
-        if(!empty($this->contentEncoding)) 
+        if (!empty($this->contentEncoding)) 
         {
-            $result .= '; charset="' . $this->contentEncoding.'"';
+            $result .= '; charset="'.$this->contentEncoding.'"';
         }
         
         return $result;
@@ -174,7 +174,7 @@ 
     
     protected function renderTransferEncoding() : string
     {
-        $result = 'Content-Transfer-Encoding: ' . $this->transferEncoding;
+        $result = 'Content-Transfer-Encoding: '.$this->transferEncoding;
         
         return $result;
     }

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

Spacing +3 added lines, -3 removed lines

@@ -83,7 +83,7 @@ 
     * @param string $message Should not contain a date, just the system specific info.
     * @return OperationResult
     */
-    public function makeSuccess(string $message, int $code=0) : OperationResult
+    public function makeSuccess(string $message, int $code = 0) : OperationResult
     {
         return $this->setMessage($message, $code, true);
     }
@@ -94,7 +94,7 @@ 
     * @param string $message Should be as detailed as possible.
     * @return OperationResult
     */
-    public function makeError(string $message, int $code=0) : OperationResult
+    public function makeError(string $message, int $code = 0) : OperationResult
     {
         return $this->setMessage($message, $code, false);
     }
@@ -140,7 +140,7 @@ 
     
     protected function getMessage(bool $valid) : string
     {
-        if($this->valid === $valid) 
+        if ($this->valid === $valid) 
         {
             return $this->message;
         }

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/RequestHelper/Boundaries.php

Spacing +6 added lines, -6 removed lines

@@ -83,12 +83,12 @@ 
     */
     public function addFile(string $varName, string $fileName, string $content, string $contentType = '', string $encoding = '') : RequestHelper_Boundaries
     {
-        if(empty($contentType))
+        if (empty($contentType))
         {
             $contentType = (string)FileHelper::detectMimeType($fileName);
         }
         
-        if(empty($encoding))
+        if (empty($encoding))
         {
             $encoding = RequestHelper::ENCODING_UTF8;
             $content = ConvertHelper::string2utf8($content);
@@ -153,7 +153,7 @@ 
     */
     public function render() : string
     {
-        if(empty($this->boundaries)) 
+        if (empty($this->boundaries)) 
         {
             throw new RequestHelper_Exception(
                 'No mime boundaries added',
@@ -164,13 +164,13 @@ 
         
         $result = '';
         
-        foreach($this->boundaries as $boundary)
+        foreach ($this->boundaries as $boundary)
         {
             $result .= $boundary->render();
         }
         
-        $result .= "--" . $this->getMimeBoundary() . "--" . 
-        $this->getEOL() . $this->getEOL(); // always finish with two eol's!!
+        $result .= "--".$this->getMimeBoundary()."--". 
+        $this->getEOL().$this->getEOL(); // always finish with two eol's!!
         
         return $result;
     }

Indentation +52 added lines, -52 removed lines

@@ -22,19 +22,19 @@ 
 {
     const ERROR_NO_BOUNDARIES_SPECIFIED = 44401;
     
-   /**
-    * @var RequestHelper
-    */
+    /**
+     * @var RequestHelper
+     */
     protected $helper;
 
-   /**
-    * @var RequestHelper_Boundaries_Boundary[]
-    */
+    /**
+     * @var RequestHelper_Boundaries_Boundary[]
+     */
     protected $boundaries = array();
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $contentLength = 0;
     
     public function __construct(RequestHelper $helper)
@@ -42,31 +42,31 @@ 
         $this->helper = $helper;
     }
     
-   /**
-    * Retrieves the string that is used to separate mime boundaries in the body.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the string that is used to separate mime boundaries in the body.
+     * 
+     * @return string
+     */
     public function getMimeBoundary() : string
     {
         return $this->helper->getMimeBoundary();
     }
     
-   /**
-    * Retrieves the end of line character(s) used in the body.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the end of line character(s) used in the body.
+     * 
+     * @return string
+     */
     public function getEOL() : string
     {
         return $this->helper->getEOL();
     }
     
-   /**
-    * Retrieves the total content length of all boundary contents.
-    * 
-    * @return int
-    */
+    /**
+     * Retrieves the total content length of all boundary contents.
+     * 
+     * @return int
+     */
     public function getContentLength() : int
     {
         // this must use strlen, and not mb_strlen: the content length
@@ -75,15 +75,15 @@ 
         return strlen($this->render());
     }
     
-   /**
-    * Adds a file to be sent with the request.
-    *
-    * @param string $varName The variable name to send the file in
-    * @param string $fileName The name of the file as it should be received at the destination
-    * @param string $content The raw content of the file
-    * @param string $contentType The content type, use the constants to specify this
-    * @param string $encoding The encoding of the file, use the constants to specify this
-    */
+    /**
+     * Adds a file to be sent with the request.
+     *
+     * @param string $varName The variable name to send the file in
+     * @param string $fileName The name of the file as it should be received at the destination
+     * @param string $content The raw content of the file
+     * @param string $contentType The content type, use the constants to specify this
+     * @param string $encoding The encoding of the file, use the constants to specify this
+     */
     public function addFile(string $varName, string $fileName, string $content, string $contentType = '', string $encoding = '') : RequestHelper_Boundaries
     {
         if(empty($contentType))
@@ -107,13 +107,13 @@ 
         return $this->addBoundary($boundary);
     }
     
-   /**
-    * Adds arbitrary content.
-    *
-    * @param string $varName
-    * @param string $content
-    * @param string $contentType
-    */
+    /**
+     * Adds arbitrary content.
+     *
+     * @param string $varName
+     * @param string $content
+     * @param string $contentType
+     */
     public function addContent(string $varName, string $content, string $contentType) : RequestHelper_Boundaries
     {
         $content = ConvertHelper::string2utf8($content);
@@ -127,13 +127,13 @@ 
         return $this->addBoundary($boundary);
     }
     
-   /**
-    * Adds a variable to be sent with the request. If it
-    * already exists, its value is overwritten.
-    *
-    * @param string $name
-    * @param string $value
-    */
+    /**
+     * Adds a variable to be sent with the request. If it
+     * already exists, its value is overwritten.
+     *
+     * @param string $name
+     * @param string $value
+     */
     public function addVariable(string $name, string $value) : RequestHelper_Boundaries
     {
         $boundary = $this->createBoundary($value)
@@ -149,11 +149,11 @@ 
         return $this;
     }
     
-   /**
-    * Renders the response body with all mime boundaries.
-    * 
-    * @return string
-    */
+    /**
+     * Renders the response body with all mime boundaries.
+     * 
+     * @return string
+     */
     public function render() : string
     {
         if(empty($this->boundaries)) 

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/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

Spacing +2 added lines, -2 removed lines

@@ -46,7 +46,7 @@ 
         
         $result = array();
         
-        foreach($parts as $part)
+        foreach ($parts as $part)
         {
             $tokens = explode('=', $part);
             
@@ -55,7 +55,7 @@ 
 
             $trimmed = trim($name);
             
-            if(empty($trimmed))
+            if (empty($trimmed))
             {
                 continue;
             }

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

Spacing +27 added lines, -27 removed lines

@@ -128,9 +128,9 @@ 
     * @param bool $enabled
     * @return URLInfo
     */
-    public function setUTFEncoding(bool $enabled=true) : URLInfo
+    public function setUTFEncoding(bool $enabled = true) : URLInfo
     {
-        if($this->encodeUTFChars !== $enabled)
+        if ($this->encodeUTFChars !== $enabled)
         {
             $this->encodeUTFChars = $enabled;
             $this->parse(); // re-parse the URL to apply the changes
@@ -234,7 +234,7 @@ 
     {
         $port = $this->getInfoKey('port');
         
-        if(!empty($port)) {
+        if (!empty($port)) {
             return (int)$port;
         }
         
@@ -314,7 +314,7 @@ 
     
     protected function getInfoKey(string $name) : string
     {
-        if(isset($this->info[$name])) {
+        if (isset($this->info[$name])) {
             return (string)$this->info[$name];
         }
         
@@ -343,13 +343,13 @@ 
         return $this->normalize(false);
     }
     
-    protected function normalize(bool $auth=true) : string
+    protected function normalize(bool $auth = true) : string
     {
-        if(!$this->isValid()) {
+        if (!$this->isValid()) {
             return '';
         }
         
-        if(!isset($this->normalizer)) {
+        if (!isset($this->normalizer)) {
             $this->normalizer = new URLInfo_Normalizer($this);
         }
         
@@ -379,7 +379,7 @@ 
     */
     public function getHighlighted() : string
     {
-        if(!$this->isValid()) {
+        if (!$this->isValid()) {
             return '';
         }
         
@@ -421,14 +421,14 @@ 
     */
     public function getParams() : array
     {
-        if(!$this->paramExclusion || empty($this->excludedParams)) {
+        if (!$this->paramExclusion || empty($this->excludedParams)) {
             return $this->info['params'];
         }
         
         $keep = array();
-        foreach($this->info['params'] as $name => $value) 
+        foreach ($this->info['params'] as $name => $value) 
         {
-            if(!isset($this->excludedParams[$name])) {
+            if (!isset($this->excludedParams[$name])) {
                 $keep[$name] = $value;
             }
         }
@@ -454,7 +454,7 @@ 
     */
     public function getParam(string $name) : string
     {
-        if(isset($this->info['params'][$name])) {
+        if (isset($this->info['params'][$name])) {
             return $this->info['params'][$name];
         }
         
@@ -473,7 +473,7 @@ 
     */
     public function excludeParam(string $name, string $reason) : URLInfo
     {
-        if(!isset($this->excludedParams[$name]))
+        if (!isset($this->excludedParams[$name]))
         {
             $this->excludedParams[$name] = $reason;
             $this->setParamExclusion();
@@ -499,7 +499,7 @@ 
     
     public function getTypeLabel() : string
     {
-        if(!isset(self::$typeLabels))
+        if (!isset(self::$typeLabels))
         {
             self::$typeLabels = array(
                 self::TYPE_EMAIL => t('Email'),
@@ -511,7 +511,7 @@ 
         
         $type = $this->getType();
         
-        if(!isset(self::$typeLabels[$type]))
+        if (!isset(self::$typeLabels[$type]))
         {
             throw new BaseException(
                 sprintf('Unknown URL type label for type [%s].', $type),
@@ -531,7 +531,7 @@ 
     * @param bool $highlight
     * @return URLInfo
     */
-    public function setHighlightExcluded(bool $highlight=true) : URLInfo
+    public function setHighlightExcluded(bool $highlight = true) : URLInfo
     {
         $this->highlightExcluded = $highlight;
         return $this;
@@ -579,7 +579,7 @@ 
      * @see URLInfo::isParamExclusionEnabled()
      * @see URLInfo::setHighlightExcluded()
      */
-    public function setParamExclusion(bool $enabled=true) : URLInfo
+    public function setParamExclusion(bool $enabled = true) : URLInfo
     {
         $this->paramExclusion = $enabled;
         return $this;
@@ -605,13 +605,13 @@ 
     */
     public function containsExcludedParams() : bool
     {
-        if(empty($this->excludedParams)) {
+        if (empty($this->excludedParams)) {
             return false;
         }
         
         $names = array_keys($this->info['params']);
-        foreach($names as $name) {
-            if(isset($this->excludedParams[$name])) {
+        foreach ($names as $name) {
+            if (isset($this->excludedParams[$name])) {
                 return true;
             }
         }
@@ -627,7 +627,7 @@ 
 
     public function offsetSet($offset, $value) 
     {
-        if(in_array($offset, $this->infoKeys)) {
+        if (in_array($offset, $this->infoKeys)) {
             $this->info[$offset] = $value;
         }
     }
@@ -644,11 +644,11 @@ 
     
     public function offsetGet($offset) 
     {
-        if($offset === 'port') {
+        if ($offset === 'port') {
             return $this->getPort();
         }
         
-        if(in_array($offset, $this->infoKeys)) {
+        if (in_array($offset, $this->infoKeys)) {
             return $this->getInfoKey($offset);
         }
         
@@ -680,12 +680,12 @@ 
     * @return bool
     * @throws BaseException
     */
-    public function tryConnect(bool $verifySSL=true) : bool
+    public function tryConnect(bool $verifySSL = true) : bool
     {
         requireCURL();
         
         $ch = curl_init();
-        if(!is_resource($ch))
+        if (!is_resource($ch))
         {
             throw new BaseException(
                 'Could not initialize a new cURL instance.',
@@ -701,13 +701,13 @@ 
         curl_setopt($ch, CURLOPT_TIMEOUT, 10);
         curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
         
-        if(!$verifySSL) 
+        if (!$verifySSL) 
         {
             curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
             curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
         }
         
-        if($this->hasUsername()) 
+        if ($this->hasUsername()) 
         {
             curl_setopt($ch, CURLOPT_USERNAME, $this->getUsername());
             curl_setopt($ch, CURLOPT_PASSWORD, $this->getPassword());