Mistralys / application-utils

src/XMLHelper/Converter.php

Indentation +41 added lines, -41 removed lines

@@ -41,14 +41,14 @@ 
 {
     const ERROR_FAILED_CONVERTING_TO_JSON = 37901;
     
-   /**
-    * @var \SimpleXMLElement
-    */
+    /**
+     * @var \SimpleXMLElement
+     */
     protected $xml;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $json;
     
     protected function __construct(\SimpleXMLElement $element)
@@ -56,24 +56,24 @@ 
         $this->xml = $element;
     }
     
-   /**
-    * Factory method: creates a converter from an XML file on disk.
-    * 
-    * @param string $path
-    * @return \AppUtils\XMLHelper_Converter
-    */
+    /**
+     * Factory method: creates a converter from an XML file on disk.
+     * 
+     * @param string $path
+     * @return \AppUtils\XMLHelper_Converter
+     */
     public static function fromFile(string $path)
     {
         $xmlString = file_get_contents($path);
         return self::fromString($xmlString);
     }
  
-   /**
-    * Factory method: creates a converter from an XML string.
-    * 
-    * @param string $xmlString
-    * @return \AppUtils\XMLHelper_Converter
-    */
+    /**
+     * Factory method: creates a converter from an XML string.
+     * 
+     * @param string $xmlString
+     * @return \AppUtils\XMLHelper_Converter
+     */
     public static function fromString(string $xmlString)
     {
         $element = new \SimpleXMLElement($xmlString);
@@ -81,36 +81,36 @@ 
         return self::fromElement($element);
     }
     
-   /**
-    * Factory method: creates a converter from an existing SimpleXMLElement instance.
-    * 
-    * @param \SimpleXMLElement $element
-    * @return \AppUtils\XMLHelper_Converter
-    */
+    /**
+     * Factory method: creates a converter from an existing SimpleXMLElement instance.
+     * 
+     * @param \SimpleXMLElement $element
+     * @return \AppUtils\XMLHelper_Converter
+     */
     public static function fromElement(\SimpleXMLElement $element)
     {
         $obj = new XMLHelper_Converter($element);
         return $obj;
     }
 
-   /**
-    * Factory method: creates a converter from an existing SimpleXMLElement instance.
-    *
-    * @param \DOMElement $element
-    * @return \AppUtils\XMLHelper_Converter
-    */
+    /**
+     * Factory method: creates a converter from an existing SimpleXMLElement instance.
+     *
+     * @param \DOMElement $element
+     * @return \AppUtils\XMLHelper_Converter
+     */
     public static function fromDOMElement(\DOMElement $element)
     {
         $obj = new XMLHelper_Converter(simplexml_import_dom($element));
         return $obj;
     }
     
-   /**
-    * Converts the XML to JSON.
-    * 
-    * @throws XMLHelper_Exception
-    * @return string
-    */
+    /**
+     * Converts the XML to JSON.
+     * 
+     * @throws XMLHelper_Exception
+     * @return string
+     */
     public function toJSON() : string
     {
         if(isset($this->json)) {
@@ -138,11 +138,11 @@ 
         );
     }
     
-   /**
-    * Converts the XML to an associative array.
-    * @return array
-    * @throws XMLHelper_Exception
-    */
+    /**
+     * Converts the XML to an associative array.
+     * @return array
+     * @throws XMLHelper_Exception
+     */
     public function toArray() : array 
     {
         $json = $this->toJSON();

src/XMLHelper/SimpleXML.php

Indentation +16 added lines, -16 removed lines

@@ -11,27 +11,27 @@
     
     protected $errors = array();
     
-   /**
-    * Creates a simplexml instance from an XML string.
-    *
-    * NOTE: returns false in case of a fatal error.
-    *
-    * @param string $string
-    * @return \SimpleXMLElement|bool
-    */
+    /**
+     * Creates a simplexml instance from an XML string.
+     *
+     * NOTE: returns false in case of a fatal error.
+     *
+     * @param string $string
+     * @return \SimpleXMLElement|bool
+     */
     public function loadString($string)
     {
         return $this->load('string', $string);
     }
     
-   /**
-    * Creates a simplexml instance from an XML file.
-    * 
-    * NOTE: returns false in case of a fatal error.
-    * 
-    * @param string $file
-    * @return \SimpleXMLElement|bool
-    */
+    /**
+     * Creates a simplexml instance from an XML file.
+     * 
+     * NOTE: returns false in case of a fatal error.
+     * 
+     * @param string $file
+     * @return \SimpleXMLElement|bool
+     */
     public function loadFile($file)
     {
         return $this->load('file', $file);

src/Request/Param.php

Indentation +134 added lines, -134 removed lines

@@ -111,18 +111,18 @@ 
         }
     }
     
-   /**
-    * Adds a callback as a validation method. The callback gets the
-    * value to validate as first parameter, and any additional 
-    * parameters passed here get appended to that.
-    * 
-    * The callback must return boolean true or false depending on
-    * whether the value is valid.
-    * 
-    * @param mixed $callback
-    * @param array $args
-    * @return Request_Param
-    */
+    /**
+     * Adds a callback as a validation method. The callback gets the
+     * value to validate as first parameter, and any additional 
+     * parameters passed here get appended to that.
+     * 
+     * The callback must return boolean true or false depending on
+     * whether the value is valid.
+     * 
+     * @param mixed $callback
+     * @param array $args
+     * @return Request_Param
+     */
     public function setCallback($callback, $args=array())
     {
         if(!is_callable($callback)) {
@@ -264,13 +264,13 @@ 
     
     protected $valueType = self::VALUE_TYPE_STRING;
 
-   /**
-    * Sets the variable to contain a comma-separated list of integer IDs.
-    * Example: <code>145,248,4556</code>. A single ID is also allowed, e.g.
-    * <code>145</code>.
-    * 
-    * @return Request_Param
-    */
+    /**
+     * Sets the variable to contain a comma-separated list of integer IDs.
+     * Example: <code>145,248,4556</code>. A single ID is also allowed, e.g.
+     * <code>145</code>.
+     * 
+     * @return Request_Param
+     */
     public function setIDList()
     {
         $this->valueType = self::VALUE_TYPE_ID_LIST;
@@ -279,13 +279,13 @@ 
         return $this;
     }
     
-   /**
-    * Sets the variable to be an alias, as defined by the
-    * {@link RegexHelper::REGEX_ALIAS} regular expression.
-    * 
-    * @return Request_Param
-    * @see RegexHelper::REGEX_ALIAS
-    */
+    /**
+     * Sets the variable to be an alias, as defined by the
+     * {@link RegexHelper::REGEX_ALIAS} regular expression.
+     * 
+     * @return Request_Param
+     * @see RegexHelper::REGEX_ALIAS
+     */
     public function setAlias()
     {
         return $this->setRegex(RegexHelper::REGEX_ALIAS);
@@ -326,12 +326,12 @@ 
         return $this->setValidation(self::VALIDATION_TYPE_ALPHA);
     }
     
-   /**
-    * Sets the parameter value as a string containing lowercase
-    * and/or uppercase letters, as well as numbers.
-    * 
-    * @return Request_Param
-    */
+    /**
+     * Sets the parameter value as a string containing lowercase
+     * and/or uppercase letters, as well as numbers.
+     * 
+     * @return Request_Param
+     */
     public function setAlnum()
     {
         return $this->setValidation(self::VALIDATION_TYPE_ALNUM);   
@@ -359,17 +359,17 @@ 
         return $this->setValidation(self::VALIDATION_TYPE_ENUM, $args);
     }
     
-   /**
-    * Only available for array values: the parameter must be
-    * an array value, and the array may only contain values 
-    * specified in the values array.
-    * 
-    * Submitted values that are not in the allowed list of
-    * values are stripped from the value.
-    *  
-    * @param array $values List of allowed values
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Only available for array values: the parameter must be
+     * an array value, and the array may only contain values 
+     * specified in the values array.
+     * 
+     * Submitted values that are not in the allowed list of
+     * values are stripped from the value.
+     *  
+     * @param array $values List of allowed values
+     * @return \AppUtils\Request_Param
+     */
     public function setValuesList(array $values)
     {
         $this->setArray();
@@ -382,39 +382,39 @@ 
         return $this->setValidation(self::VALIDATION_TYPE_ARRAY);
     }
     
-   /**
-    * Specifies that a JSON-encoded string is expected.
-    * 
-    * NOTE: Numbers or quoted strings are technically valid
-    * JSON, but are not accepted, because it is assumed
-    * at least an array or object are expected.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Specifies that a JSON-encoded string is expected.
+     * 
+     * NOTE: Numbers or quoted strings are technically valid
+     * JSON, but are not accepted, because it is assumed
+     * at least an array or object are expected.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function setJSON() : Request_Param
     {
         return $this->setValidation(self::VALIDATION_TYPE_JSON, array('arrays' => true));
     }
     
-   /**
-    * Like {@link Request_Param::setJSON()}, but accepts
-    * only JSON objects. Arrays will not be accepted.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Like {@link Request_Param::setJSON()}, but accepts
+     * only JSON objects. Arrays will not be accepted.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function setJSONObject() : Request_Param
     {
         return $this->setValidation(self::VALIDATION_TYPE_JSON, array('arrays' => false));
     }
     
-   /**
-    * The parameter is a string boolean representation. This means
-    * it can be any of the following: "yes", "true", "no", "false".
-    * The value is automatically converted to a boolean when retrieving
-    * the parameter.
-    * 
-    * @return Request_Param
-    */
+    /**
+     * The parameter is a string boolean representation. This means
+     * it can be any of the following: "yes", "true", "no", "false".
+     * The value is automatically converted to a boolean when retrieving
+     * the parameter.
+     * 
+     * @return Request_Param
+     */
     public function setBoolean() : Request_Param
     {
         $this->addCallbackFilter(array($this, 'applyFilter_boolean'));
@@ -478,15 +478,15 @@ 
         return $keep;
     }
     
-   /**
-    * Validates the request parameter as an MD5 string,
-    * so that only values resembling md5 values are accepted.
-    * 
-    * NOTE: This can only guarantee the format, not whether
-    * it is an actual valid hash of something.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Validates the request parameter as an MD5 string,
+     * so that only values resembling md5 values are accepted.
+     * 
+     * NOTE: This can only guarantee the format, not whether
+     * it is an actual valid hash of something.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function setMD5() : Request_Param
     {
         return $this->setRegex(RegexHelper::REGEX_MD5);
@@ -528,14 +528,14 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves the value of the request parameter,
-    * applying all filters (if any) and validation
-    * (if any).
-    * 
-    * @param mixed $default
-    * @return mixed
-    */
+    /**
+     * Retrieves the value of the request parameter,
+     * applying all filters (if any) and validation
+     * (if any).
+     * 
+     * @param mixed $default
+     * @return mixed
+     */
     public function get($default=null)
     {
         $value = $this->validate($this->request->getParam($this->paramName));
@@ -566,11 +566,11 @@ 
         return $int;
     }
     
-   /**
-    * Validates the syntax of an URL, but not its actual validity. 
-    * @param string $value
-    * @return string
-    */
+    /**
+     * Validates the syntax of an URL, but not its actual validity. 
+     * @param string $value
+     * @return string
+     */
     protected function validate_url($value) : string
     {
         if(!is_string($value)) {
@@ -689,10 +689,10 @@ 
         return null;
     }
     
-   /**
-    * Makes sure that the value is a JSON-encoded string.
-    * @param string $value
-    */
+    /**
+     * Makes sure that the value is a JSON-encoded string.
+     * @param string $value
+     */
     protected function validate_json($value)
     {
         if(!is_string($value)) {
@@ -709,7 +709,7 @@ 
         if($this->validationParams['arrays'] === false) 
         {
             if(is_object(json_decode($value))) {
-               return $value; 
+                return $value; 
             }
         } 
         else 
@@ -790,12 +790,12 @@ 
         return $this;
     }
     
-   /**
-    * Adds a filter that trims whitespace from the request
-    * parameter using the PHP <code>trim</code> function.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Adds a filter that trims whitespace from the request
+     * parameter using the PHP <code>trim</code> function.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function addFilterTrim() : Request_Param
     {
         // to guarantee we only work with strings
@@ -804,13 +804,13 @@ 
         return $this->addCallbackFilter('trim');
     }
 
-   /**
-    * Converts the value to a string, even if it is not
-    * a string value. Complex types like arrays and objects
-    * are converted to an empty string.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Converts the value to a string, even if it is not
+     * a string value. Complex types like arrays and objects
+     * are converted to an empty string.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function addStringFilter() : Request_Param
     {
         return $this->addCallbackFilter(array($this, 'applyFilter_string'));
@@ -860,12 +860,12 @@ 
         return $this->addCallbackFilter('strip_tags', array($allowedTags));
     }
     
-   /**
-    * Adds a filter that strips all whitespace from the
-    * request parameter, from spaces to tabs and newlines.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Adds a filter that strips all whitespace from the
+     * request parameter, from spaces to tabs and newlines.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function addStripWhitespaceFilter() : Request_Param
     {
         // to ensure we only work with strings.
@@ -874,14 +874,14 @@ 
         return $this->addCallbackFilter(array($this, 'applyFilter_stripWhitespace'));
     }   
     
-   /**
-    * Adds a filter that transforms comma separated values
-    * into an array of values.
-    * 
-    * @param bool $trimEntries Trim whitespace from each entry?
-    * @param bool $stripEmptyEntries Remove empty entries from the array?
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Adds a filter that transforms comma separated values
+     * into an array of values.
+     * 
+     * @param bool $trimEntries Trim whitespace from each entry?
+     * @param bool $stripEmptyEntries Remove empty entries from the array?
+     * @return \AppUtils\Request_Param
+     */
     public function addCommaSeparatedFilter(bool $trimEntries=true, bool $stripEmptyEntries=true) : Request_Param
     {
         $this->setArray();
@@ -895,12 +895,12 @@ 
         );
     }
     
-   /**
-    * Adds a filter that encodes all HTML special characters
-    * using the PHP <code>htmlspecialchars</code> function.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Adds a filter that encodes all HTML special characters
+     * using the PHP <code>htmlspecialchars</code> function.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function addHTMLSpecialcharsFilter() : Request_Param
     {
         return $this->addCallbackFilter('htmlspecialchars', array(ENT_QUOTES, 'UTF-8'));
@@ -913,14 +913,14 @@ 
     
     protected $required = false;
     
-   /**
-    * Marks this request parameter as required. To use this feature,
-    * you have to call the request's {@link Request::validate()}
-    * method.
-    * 
-    * @return Request_Param
-    * @see Request::validate()
-    */
+    /**
+     * Marks this request parameter as required. To use this feature,
+     * you have to call the request's {@link Request::validate()}
+     * method.
+     * 
+     * @return Request_Param
+     * @see Request::validate()
+     */
     public function makeRequired() : Request_Param
     {
         $this->required = true;

src/RegexHelper.php

Indentation +12 added lines, -12 removed lines

@@ -42,10 +42,10 @@ 
     
     const REGEX_MD5 = '/^[a-f0-9]{32}$/i';
 
-   /**
-    * @var string
-    * @see https://en.wikipedia.org/wiki/Email_address#Local-part
-    */
+    /**
+     * @var string
+     * @see https://en.wikipedia.org/wiki/Email_address#Local-part
+     */
     const REGEX_EMAIL = '/[a-z0-9!#$%&\'*+\/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&\'*+\/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?/i';
     
     const REGEX_PHONE = '/\A[+0-9][0-9 +\-()]+\z/m';
@@ -97,13 +97,13 @@ 
      */
     const REGEX_IS_HTML = '%<{0,1}[a-z\/][\s\S]*>|<[a-z\/][\s\S]*>{0,1}%i';
     
-   /**
-    * Hexadecimal color codes. Allows the following formats:
-    * 
-    * FFFFFF
-    * FFF
-    * 
-    * @var string
-    */
+    /**
+     * Hexadecimal color codes. Allows the following formats:
+     * 
+     * FFFFFF
+     * FFF
+     * 
+     * @var string
+     */
     const REGEX_HEX_COLOR_CODE = '/\A(?:[0-9a-fA-F]{6}|[0-9a-fA-F]{3})\z/iU';
 }

src/VariableInfo.php

Indentation +19 added lines, -19 removed lines

@@ -32,24 +32,24 @@ 
         self::TYPE_CALLABLE => 'cf5e20'
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $string;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $value;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type;
     
-   /**
-    * @param mixed $value
-    */
+    /**
+     * @param mixed $value
+     */
     public function __construct($value, $serialized=null)
     {
         if(is_array($serialized))
@@ -105,13 +105,13 @@ 
         );
     }
     
-   /**
-    * Whether to prepend the variable type before the value, 
-    * like the var_dump function. Example: <code>string "Some text"</code>.
-    * 
-    * @param bool $enable
-    * @return VariableInfo
-    */
+    /**
+     * Whether to prepend the variable type before the value, 
+     * like the var_dump function. Example: <code>string "Some text"</code>.
+     * 
+     * @param bool $enable
+     * @return VariableInfo
+     */
     public function enableType(bool $enable=true) : VariableInfo
     {
         return $this->setOption('prepend-type', $enable);

src/BaseException.php

Indentation +24 added lines, -24 removed lines

@@ -13,10 +13,10 @@ 
         $this->details = $details;
     }
     
-   /**
-    * Retrieves the detailed error description, if any.
-    * @return string
-    */
+    /**
+     * Retrieves the detailed error description, if any.
+     * @return string
+     */
     public function getDetails() : string
     {
         if($this->details !== null) {
@@ -26,10 +26,10 @@ 
         return '';
     }
     
-   /**
-    * Displays pertinent information on the exception in
-    * the browser, and exits the script.
-    */
+    /**
+     * Displays pertinent information on the exception in
+     * the browser, and exits the script.
+     */
     public function display()
     {
         if(!headers_sent()) {
@@ -40,20 +40,20 @@ 
         exit;
     }
     
-   /**
-    * Retrieves information on the exception that can be
-    * easily accessed.
-    * 
-    * @return ConvertHelper_ThrowableInfo
-    */
+    /**
+     * Retrieves information on the exception that can be
+     * easily accessed.
+     * 
+     * @return ConvertHelper_ThrowableInfo
+     */
     public function getInfo() : ConvertHelper_ThrowableInfo
     {
         return ConvertHelper::throwable2info($this);
     }
     
-   /**
-    * Dumps a current PHP function trace, as a textonly string.
-    */
+    /**
+     * Dumps a current PHP function trace, as a textonly string.
+     */
     public static function dumpTraceAsString()
     {
         try
@@ -83,13 +83,13 @@ 
         }
     }
     
-   /**
-    * Creates an exception info instance from a throwable instance.
-    * 
-    * @param \Throwable $e
-    * @return ConvertHelper_ThrowableInfo
-    * @see ConvertHelper::throwable2info()
-    */
+    /**
+     * Creates an exception info instance from a throwable instance.
+     * 
+     * @param \Throwable $e
+     * @return ConvertHelper_ThrowableInfo
+     * @see ConvertHelper::throwable2info()
+     */
     public static function createInfo(\Throwable $e) : ConvertHelper_ThrowableInfo
     {
         return ConvertHelper::throwable2info($e);

src/CSVHelper.php

Indentation +124 added lines, -124 removed lines

@@ -52,12 +52,12 @@ 
         
     }
 
-   /**
-    * Creates and returns a new instance of the CSV builder which
-    * can be used to build CSV from scratch.
-    * 
-    * @return CSVHelper_Builder
-    */
+    /**
+     * Creates and returns a new instance of the CSV builder which
+     * can be used to build CSV from scratch.
+     * 
+     * @return CSVHelper_Builder
+     */
     public static function createBuilder()
     {
         return new CSVHelper_Builder();
@@ -71,16 +71,16 @@ 
     
     protected $headersPosition = self::HEADERS_NONE;
     
-   /**
-    * Loads CSV data from a string. 
-    * 
-    * Note: Use the {@link hasErrors()} method to 
-    * check if the string could be parsed correctly
-    * afterwards.
-    * 
-    * @param string $string
-    * @return CSVHelper
-    */
+    /**
+     * Loads CSV data from a string. 
+     * 
+     * Note: Use the {@link hasErrors()} method to 
+     * check if the string could be parsed correctly
+     * afterwards.
+     * 
+     * @param string $string
+     * @return CSVHelper
+     */
     public function loadString($string)
     {
         // remove any UTF byte order marks that may still be present in the string
@@ -94,17 +94,17 @@ 
         return $this;
     }
     
-   /**
-    * Loads CSV data from a file.
-    * 
-    * Note: Use the {@link hasErrors()} method to 
-    * check if the string could be parsed correctly
-    * afterwards.
-    * 
-    * @param string $file
-    * @throws CSVHelper_Exception
-    * @return boolean
-    */
+    /**
+     * Loads CSV data from a file.
+     * 
+     * Note: Use the {@link hasErrors()} method to 
+     * check if the string could be parsed correctly
+     * afterwards.
+     * 
+     * @param string $file
+     * @throws CSVHelper_Exception
+     * @return boolean
+     */
     public function loadFile($file)
     {
         $csv = file_get_contents($file);
@@ -128,28 +128,28 @@ 
     
     protected $rowCount = 0;
     
-   /**
-    * Specifies that headers are positioned on top, horizontally.
-    * @return CSVHelper
-    */
+    /**
+     * Specifies that headers are positioned on top, horizontally.
+     * @return CSVHelper
+     */
     public function setHeadersTop()
     {
         return $this->setHeadersPosition(self::HEADERS_TOP);
     }
     
-   /**
-    * Specifies that headers are positioned on the left, vertically.
-    * @return CSVHelper
-    */
+    /**
+     * Specifies that headers are positioned on the left, vertically.
+     * @return CSVHelper
+     */
     public function setHeadersLeft()
     {
         return $this->setHeadersPosition(self::HEADERS_LEFT);
     }
     
-   /**
-    * Specifies that there are no headers in the file (default).
-    * @return CSVHelper
-    */
+    /**
+     * Specifies that there are no headers in the file (default).
+     * @return CSVHelper
+     */
     public function setHeadersNone()
     {
         return $this->setHeadersPosition(self::HEADERS_NONE);
@@ -179,18 +179,18 @@ 
         return false;
     }
     
-   /**
-    * Specifies where the headers are positioned in the
-    * CSV, or turns them off entirely. Use the class constants
-    * to ensure the value is correct.
-    * 
-    * @param string $position
-    * @throws CSVHelper_Exception
-    * @return CSVHelper
-    * @see CSVHelper::HEADERS_LEFT
-    * @see CSVHelper::HEADERS_TOP
-    * @see CSVHelper::HEADERS_NONE
-    */
+    /**
+     * Specifies where the headers are positioned in the
+     * CSV, or turns them off entirely. Use the class constants
+     * to ensure the value is correct.
+     * 
+     * @param string $position
+     * @throws CSVHelper_Exception
+     * @return CSVHelper
+     * @see CSVHelper::HEADERS_LEFT
+     * @see CSVHelper::HEADERS_TOP
+     * @see CSVHelper::HEADERS_NONE
+     */
     public function setHeadersPosition($position)
     {
         $validPositions = array(
@@ -217,13 +217,13 @@ 
         return $this;
     }
     
-   /**
-    * Resets all internal data, allowing to start entirely anew
-    * with a new file, or to start building a new CSV file from
-    * scratch.
-    * 
-    * @return CSVHelper
-    */
+    /**
+     * Resets all internal data, allowing to start entirely anew
+     * with a new file, or to start building a new CSV file from
+     * scratch.
+     * 
+     * @return CSVHelper
+     */
     public function reset()
     {
         $this->data = array();
@@ -240,19 +240,19 @@ 
         return $this->data;
     }
     
-   /**
-    * Retrieves the row at the specified index.
-    * If there is no data at the index, this will
-    * return an array populated with empty strings
-    * for all available columns.
-    * 
-    * Tip: Use the {@link rowExists()} method to check
-    * whether the specified row exists.
-    * 
-    * @param integer $index
-    * @return array()
-    * @see rowExists()
-    */
+    /**
+     * Retrieves the row at the specified index.
+     * If there is no data at the index, this will
+     * return an array populated with empty strings
+     * for all available columns.
+     * 
+     * Tip: Use the {@link rowExists()} method to check
+     * whether the specified row exists.
+     * 
+     * @param integer $index
+     * @return array()
+     * @see rowExists()
+     */
     public function getRow($index)
     {
         if(isset($this->data[$index])) {
@@ -262,63 +262,63 @@ 
         return array_fill(0, $this->rowCount, '');
     }
     
-   /**
-    * Checks whether the specified row exists in the data set.
-    * @param integer $index
-    * @return boolean
-    */
+    /**
+     * Checks whether the specified row exists in the data set.
+     * @param integer $index
+     * @return boolean
+     */
     public function rowExists($index)
     {
         return isset($this->data[$index]);
     }
     
-   /**
-    * Counts the amount of rows in the parsed CSV,
-    * excluding the headers if any, depending on 
-    * their position.
-    * 
-    * @return integer
-    */
+    /**
+     * Counts the amount of rows in the parsed CSV,
+     * excluding the headers if any, depending on 
+     * their position.
+     * 
+     * @return integer
+     */
     public function countRows()
     {
         return $this->rowCount;
     }
     
-   /**
-    * Counts the amount of rows in the parsed CSV, 
-    * excluding the headers if any, depending on
-    * their position.
-    * 
-    * @return integer
-    */
+    /**
+     * Counts the amount of rows in the parsed CSV, 
+     * excluding the headers if any, depending on
+     * their position.
+     * 
+     * @return integer
+     */
     public function countColumns()
     {
         return $this->columnCount;
     }
     
-   /**
-    * Retrieves the headers, if any. Specify the position of the
-    * headers first to ensure this works correctly.
-    * 
-    * @return array Indexed array with header names.
-    */
+    /**
+     * Retrieves the headers, if any. Specify the position of the
+     * headers first to ensure this works correctly.
+     * 
+     * @return array Indexed array with header names.
+     */
     public function getHeaders()
     {
         return $this->headers;
     }
     
-   /**
-    * Retrieves the column at the specified index. If there
-    * is no column at the index, this returns an array
-    * populated with empty strings.
-    * 
-    * Tip: Use the {@link columnExists()} method to check
-    * whether a column exists.
-    * 
-    * @param integer $index
-    * @return string[]
-    * @see columnExists()
-    */
+    /**
+     * Retrieves the column at the specified index. If there
+     * is no column at the index, this returns an array
+     * populated with empty strings.
+     * 
+     * Tip: Use the {@link columnExists()} method to check
+     * whether a column exists.
+     * 
+     * @param integer $index
+     * @return string[]
+     * @see columnExists()
+     */
     public function getColumn($index)
     {
         $data = array();
@@ -334,11 +334,11 @@ 
         return $data;
     }
     
-   /**
-    * Checks whether the specified column exists in the data set.
-    * @param integer $index
-    * @return boolean
-    */
+    /**
+     * Checks whether the specified column exists in the data set.
+     * @param integer $index
+     * @return boolean
+     */
     public function columnExists($index)
     {
         if($index < $this->columnCount) {
@@ -402,22 +402,22 @@ 
         }
     }
     
-   /**
-    * Checks whether any errors have been encountered
-    * while parsing the CSV.
-    * 
-    * @return boolean
-    * @see getErrorMessages()
-    */
+    /**
+     * Checks whether any errors have been encountered
+     * while parsing the CSV.
+     * 
+     * @return boolean
+     * @see getErrorMessages()
+     */
     public function hasErrors()
     {
         return !empty($this->errors);
     }
     
-   /**
-    * Retrieves all error messages.
-    * @return array
-    */
+    /**
+     * Retrieves all error messages.
+     * @return array
+     */
     public function getErrorMessages()
     {
         return $this->errors;

src/IniHelper/Line.php

Indentation +18 added lines, -18 removed lines

@@ -38,38 +38,38 @@
      */
     protected $text;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $trimmed;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $lineNumber;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $varName = '';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $varValue = '';
     
     protected $valueUnquoted = '';
     
     protected $quoteStyle = '';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $sectionName = '';
     
     public function __construct(string $text, int $lineNumber)

src/IniHelper/Section.php

Indentation +65 added lines, -65 removed lines

@@ -21,19 +21,19 @@ 
  */
 class IniHelper_Section
 {
-   /**
-    * @var IniHelper
-    */
+    /**
+     * @var IniHelper
+     */
     protected $ini;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $name;
     
-   /**
-    * @var IniHelper_Line[]
-    */
+    /**
+     * @var IniHelper_Line[]
+     */
     protected $lines = array();
     
     public function __construct(IniHelper $ini, string $name)
@@ -42,33 +42,33 @@ 
         $this->name = $name;
     }
     
-   /**
-    * The section's name.
-    * @return string
-    */
+    /**
+     * The section's name.
+     * @return string
+     */
     public function getName() : string
     {
         return $this->name;
     }
     
-   /**
-    * Whether this is the default section: this 
-    * is used internally to store all variables that
-    * are not in any specific section.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether this is the default section: this 
+     * is used internally to store all variables that
+     * are not in any specific section.
+     * 
+     * @return bool
+     */
     public function isDefault() : bool
     {
         return $this->name === IniHelper::SECTION_DEFAULT;
     }
     
-   /**
-    * Adds a line instance to the section.
-    * 
-    * @param IniHelper_Line $line
-    * @return IniHelper_Section
-    */
+    /**
+     * Adds a line instance to the section.
+     * 
+     * @param IniHelper_Line $line
+     * @return IniHelper_Section
+     */
     public function addLine(IniHelper_Line $line) : IniHelper_Section
     {
         $this->lines[] = $line;
@@ -76,12 +76,12 @@ 
         return $this;
     }
     
-   /**
-    * Converts the values contained in the section into 
-    * an associative array.
-    * 
-    * @return array
-    */
+    /**
+     * Converts the values contained in the section into 
+     * an associative array.
+     * 
+     * @return array
+     */
     public function toArray() : array
     {
         $result = array();
@@ -114,11 +114,11 @@ 
         return $result;
     }
     
-   /**
-    * Converts the section's lines into an INI string.
-    * 
-    * @return string
-    */
+    /**
+     * Converts the section's lines into an INI string.
+     * 
+     * @return string
+     */
     public function toString()
     {
         $lines = array();
@@ -140,12 +140,12 @@ 
         return implode($this->ini->getEOLChar(), $lines);
     }
 
-   /**
-    * Deletes a line from the section.
-    * 
-    * @param IniHelper_Line $toDelete
-    * @return IniHelper_Section
-    */
+    /**
+     * Deletes a line from the section.
+     * 
+     * @param IniHelper_Line $toDelete
+     * @return IniHelper_Section
+     */
     public function deleteLine(IniHelper_Line $toDelete) : IniHelper_Section
     {
         $keep = array();
@@ -162,13 +162,13 @@ 
         return $this;
     }
     
-   /**
-    * Sets the value of a variable, overwriting any existing value.
-    * 
-    * @param string $name
-    * @param mixed $value If an array is specified, it is treated as duplicate keys and will add a line for each value.
-    * @return IniHelper_Section
-    */
+    /**
+     * Sets the value of a variable, overwriting any existing value.
+     * 
+     * @param string $name
+     * @param mixed $value If an array is specified, it is treated as duplicate keys and will add a line for each value.
+     * @return IniHelper_Section
+     */
     public function setValue(string $name, $value) : IniHelper_Section
     {
         $lines = $this->getLinesByVariable($name);
@@ -229,15 +229,15 @@ 
         return $this;
     }
     
-   /**
-    * Adds a variable value to the section. Unlike setValue(), this
-    * will not overwrite any existing value. If the name is an existing
-    * variable name, it will be converted to duplicate keys.
-    * 
-    * @param string $name
-    * @param mixed $value If this is an array, it will be treated as duplicate keys, and all values that are not present yet will be added.
-    * @return IniHelper_Section
-    */
+    /**
+     * Adds a variable value to the section. Unlike setValue(), this
+     * will not overwrite any existing value. If the name is an existing
+     * variable name, it will be converted to duplicate keys.
+     * 
+     * @param string $name
+     * @param mixed $value If this is an array, it will be treated as duplicate keys, and all values that are not present yet will be added.
+     * @return IniHelper_Section
+     */
     public function addValue(string $name, $value) : IniHelper_Section
     {
         // array value? Treat it as duplicate keys.
@@ -295,12 +295,12 @@ 
     }
     
     
-   /**
-    * Retrieves all lines for the specified variable name.
-    *  
-    * @param string $name
-    * @return \AppUtils\IniHelper_Line[]
-    */
+    /**
+     * Retrieves all lines for the specified variable name.
+     *  
+     * @param string $name
+     * @return \AppUtils\IniHelper_Line[]
+     */
     public function getLinesByVariable(string $name)
     {
         $result = array();