Mistralys / application-utils

src/CSVHelper.php

Indentation +130 added lines, -130 removed lines

@@ -50,20 +50,20 @@ 
         
     }
 
-   /**
-    * 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();
     }
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $csv = '';
     
     protected $data = array();
@@ -72,16 +72,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
@@ -95,20 +95,20 @@ 
         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 FileHelper_Exception
-    * @return CSVHelper
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
-    */
+    /**
+     * 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 FileHelper_Exception
+     * @return CSVHelper
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
+     */
     public function loadFile(string $file) : CSVHelper
     {
         $csv = FileHelper::readContents($file);
@@ -122,28 +122,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);
@@ -173,18 +173,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(
@@ -211,13 +211,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();
@@ -234,19 +234,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])) {
@@ -256,63 +256,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();
@@ -328,11 +328,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) {
@@ -396,22 +396,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/ConvertHelper/ThrowableInfo.php

Indentation +103 added lines, -103 removed lines

@@ -14,49 +14,49 @@ 
     const CONTEXT_COMMAND_LINE = 'cli';
     const CONTEXT_WEB = 'web';
     
-   /**
-    * @var \Throwable
-    */
+    /**
+     * @var \Throwable
+     */
     protected $exception;
     
-   /**
-    * @var ConvertHelper_ThrowableInfo_Call[]
-    */
+    /**
+     * @var ConvertHelper_ThrowableInfo_Call[]
+     */
     protected $calls = array();
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $code;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $message;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $callsCount = 0;
     
-   /**
-    * @var ConvertHelper_ThrowableInfo
-    */
+    /**
+     * @var ConvertHelper_ThrowableInfo
+     */
     protected $previous;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $referer = '';
     
-   /**
-    * @var \DateTime
-    */
+    /**
+     * @var \DateTime
+     */
     protected $date;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $context = self::CONTEXT_WEB;
     
     protected function __construct($subject)
@@ -103,16 +103,16 @@ 
         return isset($this->previous);
     }
     
-   /**
-    * Retrieves the information on the previous exception.
-    * 
-    * NOTE: Throws an exception if there is no previous 
-    * exception. Use hasPrevious() first to avoid this.
-    * 
-    * @throws ConvertHelper_Exception
-    * @return ConvertHelper_ThrowableInfo
-    * @see ConvertHelper_ThrowableInfo::ERROR_NO_PREVIOUS_EXCEPTION
-    */
+    /**
+     * Retrieves the information on the previous exception.
+     * 
+     * NOTE: Throws an exception if there is no previous 
+     * exception. Use hasPrevious() first to avoid this.
+     * 
+     * @throws ConvertHelper_Exception
+     * @return ConvertHelper_ThrowableInfo
+     * @see ConvertHelper_ThrowableInfo::ERROR_NO_PREVIOUS_EXCEPTION
+     */
     public function getPrevious() : ConvertHelper_ThrowableInfo
     {
         if(isset($this->previous)) {
@@ -131,9 +131,9 @@ 
         return !empty($this->code);
     }
     
-   /**
-    * Improved textonly exception trace.
-    */
+    /**
+     * Improved textonly exception trace.
+     */
     public function toString() : string
     {
         $calls = $this->getCalls();
@@ -161,73 +161,73 @@ 
         return $string;
     }
     
-   /**
-    * Retrieves the URL of the page in which the exception
-    * was thrown, if applicable: in CLI context, this will
-    * return an empty string.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the URL of the page in which the exception
+     * was thrown, if applicable: in CLI context, this will
+     * return an empty string.
+     * 
+     * @return string
+     */
     public function getReferer() : string
     {
         return $this->referer;
     }
     
-   /**
-    * Whether the exception occurred in a command line context.
-    * @return bool
-    */
+    /**
+     * Whether the exception occurred in a command line context.
+     * @return bool
+     */
     public function isCommandLine() : bool
     {
         return $this->getContext() === self::CONTEXT_COMMAND_LINE;
     }
     
-   /**
-    * Whether the exception occurred during an http request.
-    * @return bool
-    */
+    /**
+     * Whether the exception occurred during an http request.
+     * @return bool
+     */
     public function isWebRequest() : bool
     {
         return $this->getContext() === self::CONTEXT_WEB;
     }
     
-   /**
-    * Retrieves the context identifier, i.e. if the exception
-    * occurred in a command line context or regular web request.
-    * 
-    * @return string
-    * 
-    * @see ConvertHelper_ThrowableInfo::isCommandLine()
-    * @see ConvertHelper_ThrowableInfo::isWebRequest()
-    * @see ConvertHelper_ThrowableInfo::CONTEXT_COMMAND_LINE
-    * @see ConvertHelper_ThrowableInfo::CONTEXT_WEB
-    */
+    /**
+     * Retrieves the context identifier, i.e. if the exception
+     * occurred in a command line context or regular web request.
+     * 
+     * @return string
+     * 
+     * @see ConvertHelper_ThrowableInfo::isCommandLine()
+     * @see ConvertHelper_ThrowableInfo::isWebRequest()
+     * @see ConvertHelper_ThrowableInfo::CONTEXT_COMMAND_LINE
+     * @see ConvertHelper_ThrowableInfo::CONTEXT_WEB
+     */
     public function getContext() : string
     {
         return $this->context;
     }
     
-   /**
-    * Retrieves the date of the exception, and approximate time:
-    * since exceptions do not store time, this is captured the 
-    * moment the ThrowableInfo is created.
-    * 
-    * @return \DateTime
-    */
+    /**
+     * Retrieves the date of the exception, and approximate time:
+     * since exceptions do not store time, this is captured the 
+     * moment the ThrowableInfo is created.
+     * 
+     * @return \DateTime
+     */
     public function getDate() : \DateTime
     {
         return $this->date;
     }
     
-   /**
-    * Serializes all information on the exception to an
-    * associative array. This can be saved (file, database, 
-    * session...), and later be restored into a throwable
-    * info instance using the fromSerialized() method.
-    * 
-    * @return array
-    * @see ConvertHelper_ThrowableInfo::fromSerialized()
-    */
+    /**
+     * Serializes all information on the exception to an
+     * associative array. This can be saved (file, database, 
+     * session...), and later be restored into a throwable
+     * info instance using the fromSerialized() method.
+     * 
+     * @return array
+     * @see ConvertHelper_ThrowableInfo::fromSerialized()
+     */
     public function serialize() : array
     {
         $result = array(
@@ -254,24 +254,24 @@ 
         return $result;
     }
 
-   /**
-    * Sets the maximum folder depth to show in the 
-    * file paths, to avoid them being too long.
-    * 
-    * @param int $depth
-    * @return ConvertHelper_ThrowableInfo
-    */
+    /**
+     * Sets the maximum folder depth to show in the 
+     * file paths, to avoid them being too long.
+     * 
+     * @param int $depth
+     * @return ConvertHelper_ThrowableInfo
+     */
     public function setFolderDepth(int $depth) : ConvertHelper_ThrowableInfo
     {
         return $this->setOption('folder-depth', $depth);
     }
     
-   /**
-    * Retrieves the current folder depth option value.
-    * 
-    * @return int
-    * @see ConvertHelper_ThrowableInfo::setFolderDepth()
-    */
+    /**
+     * Retrieves the current folder depth option value.
+     * 
+     * @return int
+     * @see ConvertHelper_ThrowableInfo::setFolderDepth()
+     */
     public function getFolderDepth() : int
     {
         $depth = $this->getOption('folder-depth');
@@ -282,19 +282,19 @@ 
         return 2;
     }
     
-   /**
-    * Retrieves all function calls that led to the error.
-    * @return ConvertHelper_ThrowableInfo_Call[]
-    */
+    /**
+     * Retrieves all function calls that led to the error.
+     * @return ConvertHelper_ThrowableInfo_Call[]
+     */
     public function getCalls()
     {
         return $this->calls;
     }
     
-   /**
-    * Returns the amount of function and method calls in the stack trace.
-    * @return int
-    */
+    /**
+     * Returns the amount of function and method calls in the stack trace.
+     * @return int
+     */
     public function countCalls() : int
     {
         return $this->callsCount;

src/ConvertHelper/EOL.php

Indentation +26 added lines, -26 removed lines

@@ -29,19 +29,19 @@ 
     const TYPE_LF = 'LF';
     const TYPE_CR = 'CR';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $char;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $description;
     
     public function __construct(string $char, string $type, string $description)
@@ -51,33 +51,33 @@ 
         $this->description = $description;
     }
     
-   /**
-    * The actual EOL character.
-    * @return string
-    */
+    /**
+     * The actual EOL character.
+     * @return string
+     */
     public function getCharacter() : string
     {
         return $this->char;
     }
     
-   /**
-    * A more detailed, human readable description of the character.
-    * @return string
-    */
+    /**
+     * A more detailed, human readable description of the character.
+     * @return string
+     */
     public function getDescription() : string
     {
         return $this->description;
     }
     
-   /**
-    * The EOL character type, e.g. "CR+LF", "CR"...
-    * @return string
-    * 
-    * @see ConvertHelper_EOL::TYPE_CR
-    * @see ConvertHelper_EOL::TYPE_CRLF
-    * @see ConvertHelper_EOL::TYPE_LF
-    * @see ConvertHelper_EOL::TYPE_LFCR
-    */
+    /**
+     * The EOL character type, e.g. "CR+LF", "CR"...
+     * @return string
+     * 
+     * @see ConvertHelper_EOL::TYPE_CR
+     * @see ConvertHelper_EOL::TYPE_CRLF
+     * @see ConvertHelper_EOL::TYPE_LF
+     * @see ConvertHelper_EOL::TYPE_LFCR
+     */
     public function getType() : string
     {
         return $this->type;

src/FileHelper/FileFinder.php

Indentation +3 added lines, -3 removed lines

@@ -31,9 +31,9 @@
     
     const PATH_MODE_STRIP = 'strip';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $path;
     
     public function __construct(string $path)

src/IniHelper.php

Indentation +85 added lines, -85 removed lines

@@ -60,23 +60,23 @@ 
         }
     }
     
-   /**
-    * The end of line character used in the INI source string.
-    * @return string
-    */
+    /**
+     * The end of line character used in the INI source string.
+     * @return string
+     */
     public function getEOLChar() : string
     {
         return $this->eol;
     }
     
-   /**
-    * Factory method: creates a new helper instance loading the
-    * ini content from the specified file.
-    * 
-    * @param string $iniPath
-    * @throws IniHelper_Exception
-    * @return \AppUtils\IniHelper
-    */
+    /**
+     * Factory method: creates a new helper instance loading the
+     * ini content from the specified file.
+     * 
+     * @param string $iniPath
+     * @throws IniHelper_Exception
+     * @return \AppUtils\IniHelper
+     */
     public static function createFromFile(string $iniPath)
     {
         $iniPath = FileHelper::requireFileExists($iniPath);
@@ -96,35 +96,35 @@ 
         );
     }
     
-   /**
-    * Factory method: Creates a new ini helper instance from an ini string.
-    * 
-    * @param string $iniContent
-    * @return \AppUtils\IniHelper
-    */
+    /**
+     * Factory method: Creates a new ini helper instance from an ini string.
+     * 
+     * @param string $iniContent
+     * @return \AppUtils\IniHelper
+     */
     public static function createFromString(string $iniContent)
     {
         return new IniHelper($iniContent);
     }
     
-   /**
-    * Factory method: Creates a new empty ini helper.
-    *  
-    * @return \AppUtils\IniHelper
-    */
+    /**
+     * Factory method: Creates a new empty ini helper.
+     *  
+     * @return \AppUtils\IniHelper
+     */
     public static function createNew()
     {
         return self::createFromString('');
     }
     
-   /**
-    * Adds a new data section, and returns the section instance.
-    * If a section with the name already exists, returns that
-    * section instead of creating a new one.
-    *  
-    * @param string $name
-    * @return IniHelper_Section
-    */
+    /**
+     * Adds a new data section, and returns the section instance.
+     * If a section with the name already exists, returns that
+     * section instead of creating a new one.
+     *  
+     * @param string $name
+     * @return IniHelper_Section
+     */
     public function addSection(string $name) : IniHelper_Section
     {
         if(!isset($this->sections[$name])) {
@@ -134,12 +134,12 @@ 
         return $this->sections[$name];
     }
     
-   /**
-    * Retrieves a section by its name, if it exists.
-    * 
-    * @param string $name
-    * @return IniHelper_Section|NULL
-    */
+    /**
+     * Retrieves a section by its name, if it exists.
+     * 
+     * @param string $name
+     * @return IniHelper_Section|NULL
+     */
     public function getSection(string $name) : ?IniHelper_Section
     {
         if(isset($this->sections[$name])) {
@@ -149,11 +149,11 @@ 
         return null;
     }
     
-   /**
-    * Gets the data from the INI file as an associative array.
-    * 
-    * @return array
-    */
+    /**
+     * Gets the data from the INI file as an associative array.
+     * 
+     * @return array
+     */
     public function toArray() : array
     {
         $result = array();
@@ -173,17 +173,17 @@ 
         return $result;
     }
     
-   /**
-    * Saves the INI content to the target file.
-    * 
-    * @param string $filePath
-    * @return IniHelper
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
-    * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
-    * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
-    */
+    /**
+     * Saves the INI content to the target file.
+     * 
+     * @param string $filePath
+     * @return IniHelper
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
+     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
+     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
+     */
     public function saveToFile(string $filePath) : IniHelper
     {
         FileHelper::saveFile($filePath, $this->saveToString());
@@ -191,11 +191,11 @@ 
         return $this;
     }
     
-   /**
-    * Returns the INI content as string.
-    * 
-    * @return string
-    */
+    /**
+     * Returns the INI content as string.
+     * 
+     * @return string
+     */
     public function saveToString() : string
     {
         $parts = array();
@@ -208,15 +208,15 @@ 
         return implode($this->eol, $parts);
     }
     
-   /**
-    * Sets or adds the value of a setting in the INI content.
-    * If the setting does not exist, it is added. Otherwise,
-    * the existing value is overwritten.
-    * 
-    * @param string $path A variable path, either <code>varname</code> or <code>section.varname</code>.
-    * @param mixed $value
-    * @return IniHelper
-    */
+    /**
+     * Sets or adds the value of a setting in the INI content.
+     * If the setting does not exist, it is added. Otherwise,
+     * the existing value is overwritten.
+     * 
+     * @param string $path A variable path, either <code>varname</code> or <code>section.varname</code>.
+     * @param mixed $value
+     * @return IniHelper
+     */
     public function setValue(string $path, $value) : IniHelper
     {
         $path = $this->parsePath($path);
@@ -235,12 +235,12 @@ 
         return $this;
     }
     
-   /**
-    * Checks whether a section with the specified name exists.
-    * 
-    * @param string $name
-    * @return bool
-    */
+    /**
+     * Checks whether a section with the specified name exists.
+     * 
+     * @param string $name
+     * @return bool
+     */
     public function sectionExists(string $name) : bool
     {
         foreach($this->sections as $section) {
@@ -252,23 +252,23 @@ 
         return false;
     }
     
-   /**
-    * Retrieves the default section, which is used to add
-    * values in the root of the document.
-    * 
-    * @return IniHelper_Section
-    */
+    /**
+     * Retrieves the default section, which is used to add
+     * values in the root of the document.
+     * 
+     * @return IniHelper_Section
+     */
     public function getDefaultSection() : IniHelper_Section
     {
         return $this->addSection(self::SECTION_DEFAULT);
     }
     
-   /**
-    * Retrieves all variable lines for the specified path.
-    * 
-    * @param string $path A variable path. Either <code>varname</code> or <code>section.varname</code>.
-    * @return array|\AppUtils\IniHelper_Line[]
-    */
+    /**
+     * Retrieves all variable lines for the specified path.
+     * 
+     * @param string $path A variable path. Either <code>varname</code> or <code>section.varname</code>.
+     * @return array|\AppUtils\IniHelper_Line[]
+     */
     public function getLinesByVariable(string $path)
     {
         $path = $this->parsePath($path);

src/VariableInfo.php

Indentation +47 added lines, -47 removed lines

@@ -32,25 +32,25 @@ 
         self::TYPE_CALLABLE => 'cf5e20'
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $string;
     
-   /**
-    * @var mixed
-    */
+    /**
+     * @var mixed
+     */
     protected $value;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type;
     
-   /**
-    * @param mixed $value
-    * @param array|null $serialized
-    */
+    /**
+     * @param mixed $value
+     * @param array|null $serialized
+     */
     public function __construct($value, $serialized=null)
     {
         if(is_array($serialized))
@@ -63,26 +63,26 @@ 
         }
     }
     
-   /**
-    * Creates a new variable info instance from a PHP variable
-    * of any type.
-    * 
-    * @param mixed $variable
-    * @return VariableInfo
-    */
+    /**
+     * Creates a new variable info instance from a PHP variable
+     * of any type.
+     * 
+     * @param mixed $variable
+     * @return VariableInfo
+     */
     public static function fromVariable($variable) : VariableInfo
     {
         return new VariableInfo($variable);
     }
     
-   /**
-    * Restores a variable info instance using a previously serialized
-    * array using the serialize() method.
-    * 
-    * @param array $serialized
-    * @return VariableInfo
-    * @see VariableInfo::serialize()
-    */
+    /**
+     * Restores a variable info instance using a previously serialized
+     * array using the serialize() method.
+     * 
+     * @param array $serialized
+     * @return VariableInfo
+     * @see VariableInfo::serialize()
+     */
     public static function fromSerialized(array $serialized) : VariableInfo
     {
         return new VariableInfo(null, $serialized);
@@ -108,12 +108,12 @@ 
         $this->string = $this->_toString();
     }
     
-   /**
-    * The variable type - this is the same string that
-    * is returned by the PHP function `gettype`.
-    * 
-    * @return string
-    */
+    /**
+     * The variable type - this is the same string that
+     * is returned by the PHP function `gettype`.
+     * 
+     * @return string
+     */
     public function getType() : string
     {
         return $this->type;
@@ -127,13 +127,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);
@@ -203,12 +203,12 @@ 
         return $converted;
     }
     
-   /**
-    * Converts an array to a string.
-    * @return string
-    * 
-    * @todo Create custom dump implementation, using VariableInfo instances.
-    */
+    /**
+     * Converts an array to a string.
+     * @return string
+     * 
+     * @todo Create custom dump implementation, using VariableInfo instances.
+     */
     protected function toString_array() : string
     {
         $result = json_encode($this->value, JSON_PRETTY_PRINT);

src/Request/Param.php

Indentation +135 added lines, -135 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->request->getParam($this->paramName);
@@ -565,12 +565,12 @@ 
         return null;
     }
     
-   /**
-    * Validates the syntax of an URL, but not its actual validity. 
-    * 
-    * @param mixed $value
-    * @return string
-    */
+    /**
+     * Validates the syntax of an URL, but not its actual validity. 
+     * 
+     * @param mixed $value
+     * @return string
+     */
     protected function validate_url($value) : string
     {
         if(!is_string($value)) {
@@ -710,10 +710,10 @@ 
         return null;
     }
     
-   /**
-    * Makes sure that the value is a JSON-encoded string.
-    * @param mixed $value
-    */
+    /**
+     * Makes sure that the value is a JSON-encoded string.
+     * @param mixed $value
+     */
     protected function validate_json($value) : string
     {
         if(!is_string($value)) {
@@ -730,7 +730,7 @@ 
         if($this->validationParams['arrays'] === false) 
         {
             if(is_object(json_decode($value))) {
-               return $value; 
+                return $value; 
             }
         } 
         else 
@@ -810,12 +810,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
@@ -824,13 +824,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'));
@@ -880,12 +880,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.
@@ -894,14 +894,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();
@@ -915,12 +915,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'));
@@ -933,14 +933,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/BaseException.php

Indentation +35 added lines, -35 removed lines

@@ -20,17 +20,17 @@ 
  */
 class BaseException extends \Exception
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $details;
     
-   /**
-    * @param string $message
-    * @param string $details
-    * @param int $code
-    * @param \Exception $previous
-    */
+    /**
+     * @param string $message
+     * @param string $details
+     * @param int $code
+     * @param \Exception $previous
+     */
     public function __construct(string $message, $details=null, $code=null, $previous=null)
     {
         parent::__construct($message, $code, $previous);
@@ -38,10 +38,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) {
@@ -51,9 +51,9 @@ 
         return '';
     }
     
-   /**
-    * Displays pertinent information on the exception.
-    */
+    /**
+     * Displays pertinent information on the exception.
+     */
     public function display()
     {
         if(!headers_sent()) {
@@ -63,20 +63,20 @@ 
         echo $this->getInfo();
     }
     
-   /**
-    * 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
@@ -89,9 +89,9 @@ 
         }
     }
 
-   /**
-    * Dumps a current PHP function trace, with HTML styling.
-    */
+    /**
+     * Dumps a current PHP function trace, with HTML styling.
+     */
     public static function dumpTraceAsHTML()
     {
         try
@@ -106,13 +106,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/FileHelper.php

Indentation +387 added lines, -387 removed lines

@@ -80,32 +80,32 @@ 
     
     const ERROR_CANNOT_OPEN_FILE_TO_DETECT_BOM = 340032;
     
-   /**
-    * Opens a serialized file and returns the unserialized data.
-    * 
-    * @param string $file
-    * @throws FileHelper_Exception
-    * @return array
-    * @deprecated Use parseSerializedFile() instead.
-    * @see FileHelper::parseSerializedFile()
-    */
+    /**
+     * Opens a serialized file and returns the unserialized data.
+     * 
+     * @param string $file
+     * @throws FileHelper_Exception
+     * @return array
+     * @deprecated Use parseSerializedFile() instead.
+     * @see FileHelper::parseSerializedFile()
+     */
     public static function openUnserialized(string $file) : array
     {
         return self::parseSerializedFile($file);
     }
 
-   /**
-    * Opens a serialized file and returns the unserialized data.
-    *
-    * @param string $file
-    * @throws FileHelper_Exception
-    * @return array
-    * @see FileHelper::parseSerializedFile()
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
-    * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
-    */
+    /**
+     * Opens a serialized file and returns the unserialized data.
+     *
+     * @param string $file
+     * @throws FileHelper_Exception
+     * @return array
+     * @see FileHelper::parseSerializedFile()
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
+     * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
+     */
     public static function parseSerializedFile(string $file)
     {
         self::requireFileExists($file);
@@ -174,13 +174,13 @@ 
         return rmdir($rootFolder);
     }
     
-   /**
-    * Create a folder, if it does not exist yet.
-    *  
-    * @param string $path
-    * @throws FileHelper_Exception
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
-    */
+    /**
+     * Create a folder, if it does not exist yet.
+     *  
+     * @param string $path
+     * @throws FileHelper_Exception
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
+     */
     public static function createFolder($path)
     {
         if(is_dir($path) || mkdir($path, 0777, true)) {
@@ -227,22 +227,22 @@ 
         }
     }
     
-   /**
-    * Copies a file to the target location. Includes checks
-    * for most error sources, like the source file not being
-    * readable. Automatically creates the target folder if it
-    * does not exist yet.
-    * 
-    * @param string $sourcePath
-    * @param string $targetPath
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
-    * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND
-    * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE
-    * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE
-    * @see FileHelper::ERROR_CANNOT_COPY_FILE
-    */
+    /**
+     * Copies a file to the target location. Includes checks
+     * for most error sources, like the source file not being
+     * readable. Automatically creates the target folder if it
+     * does not exist yet.
+     * 
+     * @param string $sourcePath
+     * @param string $targetPath
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
+     * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND
+     * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE
+     * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE
+     * @see FileHelper::ERROR_CANNOT_COPY_FILE
+     */
     public static function copyFile($sourcePath, $targetPath)
     {
         self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND);
@@ -293,15 +293,15 @@ 
         );
     }
     
-   /**
-    * Deletes the target file. Ignored if it cannot be found,
-    * and throws an exception if it fails.
-    * 
-    * @param string $filePath
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_CANNOT_DELETE_FILE
-    */
+    /**
+     * Deletes the target file. Ignored if it cannot be found,
+     * and throws an exception if it fails.
+     * 
+     * @param string $filePath
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_CANNOT_DELETE_FILE
+     */
     public static function deleteFile(string $filePath) : void
     {
         if(!file_exists($filePath)) {
@@ -323,15 +323,15 @@ 
     }
 
     /**
-    * Creates a new CSV parser instance and returns it.
-    * 
-    * @param string $delimiter
-    * @param string $enclosure
-    * @param string $escape
-    * @param bool $heading
-    * @return \parseCSV
-    * @todo Move this to the CSV helper.
-    */
+     * Creates a new CSV parser instance and returns it.
+     * 
+     * @param string $delimiter
+     * @param string $enclosure
+     * @param string $escape
+     * @param bool $heading
+     * @return \parseCSV
+     * @todo Move this to the CSV helper.
+     */
     public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV
     {
         if($delimiter==='') { $delimiter = ';'; }
@@ -346,23 +346,23 @@ 
         return $parser;
     }
 
-   /**
-    * Parses all lines in the specified string and returns an
-    * indexed array with all csv values in each line.
-    *
-    * @param string $csv
-    * @param string $delimiter
-    * @param string $enclosure
-    * @param string $escape
-    * @param bool $heading
-    * @return array
-    * @throws FileHelper_Exception
-    * 
-    * @todo Move this to the CSVHelper.
-    *
-    * @see parseCSVFile()
-    * @see FileHelper::ERROR_PARSING_CSV
-    */
+    /**
+     * Parses all lines in the specified string and returns an
+     * indexed array with all csv values in each line.
+     *
+     * @param string $csv
+     * @param string $delimiter
+     * @param string $enclosure
+     * @param string $escape
+     * @param bool $heading
+     * @return array
+     * @throws FileHelper_Exception
+     * 
+     * @todo Move this to the CSVHelper.
+     *
+     * @see parseCSVFile()
+     * @see FileHelper::ERROR_PARSING_CSV
+     */
     public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
     {
         $parser = self::createCSVParser($delimiter, $enclosure, $escape, $heading);
@@ -541,31 +541,31 @@ 
         );
     }
     
-   /**
-    * Verifies whether the target file is a PHP file. The path
-    * to the file can be a path to a file as a string, or a 
-    * DirectoryIterator object instance.
-    * 
-    * @param string|\DirectoryIterator $pathOrDirIterator
-    * @return boolean
-    */
+    /**
+     * Verifies whether the target file is a PHP file. The path
+     * to the file can be a path to a file as a string, or a 
+     * DirectoryIterator object instance.
+     * 
+     * @param string|\DirectoryIterator $pathOrDirIterator
+     * @return boolean
+     */
     public static function isPHPFile($pathOrDirIterator)
     {
-    	if(self::getExtension($pathOrDirIterator) == 'php') {
-    		return true;
-    	}
+        if(self::getExtension($pathOrDirIterator) == 'php') {
+            return true;
+        }
     	
-    	return false;
+        return false;
     }
     
-   /**
-    * Retrieves the extension of the specified file. Can be a path
-    * to a file as a string, or a DirectoryIterator object instance.
-    * 
-    * @param string|\DirectoryIterator $pathOrDirIterator
-    * @param bool $lowercase
-    * @return string
-    */
+    /**
+     * Retrieves the extension of the specified file. Can be a path
+     * to a file as a string, or a DirectoryIterator object instance.
+     * 
+     * @param string|\DirectoryIterator $pathOrDirIterator
+     * @param bool $lowercase
+     * @return string
+     */
     public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string
     {
         if($pathOrDirIterator instanceof \DirectoryIterator) {
@@ -576,51 +576,51 @@ 
          
         $ext = pathinfo($filename, PATHINFO_EXTENSION);
         if($lowercase) {
-        	$ext = mb_strtolower($ext);
+            $ext = mb_strtolower($ext);
         }
         
         return $ext;
     }
     
-   /**
-    * Retrieves the file name from a path, with or without extension.
-    * The path to the file can be a string, or a DirectoryIterator object
-    * instance.
-    * 
-    * In case of folders, behaves like the pathinfo function: returns
-    * the name of the folder.
-    * 
-    * @param string|\DirectoryIterator $pathOrDirIterator
-    * @param bool $extension
-    * @return string
-    */
+    /**
+     * Retrieves the file name from a path, with or without extension.
+     * The path to the file can be a string, or a DirectoryIterator object
+     * instance.
+     * 
+     * In case of folders, behaves like the pathinfo function: returns
+     * the name of the folder.
+     * 
+     * @param string|\DirectoryIterator $pathOrDirIterator
+     * @param bool $extension
+     * @return string
+     */
     public static function getFilename($pathOrDirIterator, $extension = true)
     {
         $path = $pathOrDirIterator;
-    	if($pathOrDirIterator instanceof \DirectoryIterator) {
-    		$path = $pathOrDirIterator->getFilename();
-    	}
+        if($pathOrDirIterator instanceof \DirectoryIterator) {
+            $path = $pathOrDirIterator->getFilename();
+        }
     	
-    	$path = self::normalizePath($path);
+        $path = self::normalizePath($path);
     	
-    	if(!$extension) {
-    	    return pathinfo($path, PATHINFO_FILENAME);
-    	}
+        if(!$extension) {
+            return pathinfo($path, PATHINFO_FILENAME);
+        }
     	
-    	return pathinfo($path, PATHINFO_BASENAME); 
+        return pathinfo($path, PATHINFO_BASENAME); 
     }
    
-   /**
-    * Tries to read the contents of the target file and
-    * treat it as JSON to return the decoded JSON data.
-    * 
-    * @param string $file
-    * @throws FileHelper_Exception
-    * @return array
-    * 
-    * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
-    * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
-    */ 
+    /**
+     * Tries to read the contents of the target file and
+     * treat it as JSON to return the decoded JSON data.
+     * 
+     * @param string $file
+     * @throws FileHelper_Exception
+     * @return array
+     * 
+     * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
+     * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
+     */ 
     public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null)
     {
         self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE);
@@ -656,16 +656,16 @@ 
         return $json;
     }
     
-   /**
-    * Corrects common formatting mistakes when users enter
-    * file names, like too many spaces, dots and the like.
-    * 
-    * NOTE: if the file name contains a path, the path is
-    * stripped, leaving only the file name.
-    * 
-    * @param string $name
-    * @return string
-    */
+    /**
+     * Corrects common formatting mistakes when users enter
+     * file names, like too many spaces, dots and the like.
+     * 
+     * NOTE: if the file name contains a path, the path is
+     * stripped, leaving only the file name.
+     * 
+     * @param string $name
+     * @return string
+     */
     public static function fixFileName(string $name) : string
     {
         $name = trim($name);
@@ -695,60 +695,60 @@ 
         return $name;
     }
     
-   /**
-    * Creates an instance of the file finder, which is an easier
-    * alternative to the other manual findFile methods, since all
-    * options can be set by chaining.
-    * 
-    * @param string $path
-    * @return FileHelper_FileFinder
-    */
+    /**
+     * Creates an instance of the file finder, which is an easier
+     * alternative to the other manual findFile methods, since all
+     * options can be set by chaining.
+     * 
+     * @param string $path
+     * @return FileHelper_FileFinder
+     */
     public static function createFileFinder(string $path) : FileHelper_FileFinder
     {
         return new FileHelper_FileFinder($path);
     }
     
-   /**
-    * Searches for all HTML files in the target folder.
-    * 
-    * @param string $targetFolder
-    * @param array $options
-    * @return array An indexed array with files.
-    * @see FileHelper::createFileFinder()
-    * 
-    * @todo Convert this to use the file finder.
-    */
+    /**
+     * Searches for all HTML files in the target folder.
+     * 
+     * @param string $targetFolder
+     * @param array $options
+     * @return array An indexed array with files.
+     * @see FileHelper::createFileFinder()
+     * 
+     * @todo Convert this to use the file finder.
+     */
     public static function findHTMLFiles(string $targetFolder, array $options=array()) : array
     {
         return self::findFiles($targetFolder, array('html'), $options);
     }
 
-   /**
-    * Searches for all PHP files in the target folder.
-    * 
-    * @param string $targetFolder
-    * @param array $options
-    * @return array An indexed array of PHP files.
-    * @see FileHelper::createFileFinder()
-    * 
-    * @todo Convert this to use the file finder.
-    */
+    /**
+     * Searches for all PHP files in the target folder.
+     * 
+     * @param string $targetFolder
+     * @param array $options
+     * @return array An indexed array of PHP files.
+     * @see FileHelper::createFileFinder()
+     * 
+     * @todo Convert this to use the file finder.
+     */
     public static function findPHPFiles(string $targetFolder, array $options=array()) : array
     {
         return self::findFiles($targetFolder, array('php'), $options);
     }
     
-   /**
-    * 
-    * @param string $targetFolder
-    * @param array $extensions
-    * @param array $options
-    * @param array $files
-    * @throws FileHelper_Exception
-    * @return array
-    * @see FileHelper::createFileFinder()
-    * @todo Convert this to use the file finder. 
-    */
+    /**
+     * 
+     * @param string $targetFolder
+     * @param array $extensions
+     * @param array $options
+     * @param array $files
+     * @throws FileHelper_Exception
+     * @return array
+     * @see FileHelper::createFileFinder()
+     * @todo Convert this to use the file finder. 
+     */
     public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array
     {
         if(!isset($options['strip-extension'])) {
@@ -829,13 +829,13 @@ 
         return $files;
     }
 
-   /**
-    * Removes the extension from the specified path or file name,
-    * if any, and returns the name without the extension.
-    * 
-    * @param string $filename
-    * @return sTring
-    */
+    /**
+     * Removes the extension from the specified path or file name,
+     * if any, and returns the name without the extension.
+     * 
+     * @param string $filename
+     * @return sTring
+     */
     public static function removeExtension(string $filename) : string
     {
         // normalize paths to allow windows style slashes even on nix servers
@@ -844,22 +844,22 @@ 
         return pathinfo($filename, PATHINFO_FILENAME);
     }
     
-   /**
-    * Detects the UTF BOM in the target file, if any. Returns
-    * the encoding matching the BOM, which can be any of the
-    * following:
-    * 
-    * <ul>
-    * <li>UTF32-BE</li>
-    * <li>UTF32-LE</li>
-    * <li>UTF16-BE</li>
-    * <li>UTF16-LE</li>
-    * <li>UTF8</li>
-    * </ul>
-    * 
-    * @param string $filename
-    * @return string|NULL
-    */
+    /**
+     * Detects the UTF BOM in the target file, if any. Returns
+     * the encoding matching the BOM, which can be any of the
+     * following:
+     * 
+     * <ul>
+     * <li>UTF32-BE</li>
+     * <li>UTF32-LE</li>
+     * <li>UTF16-BE</li>
+     * <li>UTF16-LE</li>
+     * <li>UTF8</li>
+     * </ul>
+     * 
+     * @param string $filename
+     * @return string|NULL
+     */
     public static function detectUTFBom(string $filename) : ?string
     {
         $fp = fopen($filename, 'r');
@@ -891,13 +891,13 @@ 
     
     protected static $utfBoms;
     
-   /**
-    * Retrieves a list of all UTF byte order mark character
-    * sequences, as an assocative array with UTF encoding => bom sequence
-    * pairs.
-    * 
-    * @return array
-    */
+    /**
+     * Retrieves a list of all UTF byte order mark character
+     * sequences, as an assocative array with UTF encoding => bom sequence
+     * pairs.
+     * 
+     * @return array
+     */
     public static function getUTFBOMs()
     {
         if(!isset(self::$utfBoms)) {
@@ -913,15 +913,15 @@ 
         return self::$utfBoms;
     }
     
-   /**
-    * Checks whether the specified encoding is a valid
-    * unicode encoding, for example "UTF16-LE" or "UTF8".
-    * Also accounts for alternate way to write the, like
-    * "UTF-8", and omitting little/big endian suffixes.
-    * 
-    * @param string $encoding
-    * @return boolean
-    */
+    /**
+     * Checks whether the specified encoding is a valid
+     * unicode encoding, for example "UTF16-LE" or "UTF8".
+     * Also accounts for alternate way to write the, like
+     * "UTF-8", and omitting little/big endian suffixes.
+     * 
+     * @param string $encoding
+     * @return boolean
+     */
     public static function isValidUnicodeEncoding(string $encoding) : bool
     {
         $encodings = self::getKnownUnicodeEncodings();
@@ -940,22 +940,22 @@ 
         return in_array($encoding, $keep);
     }
     
-   /**
-    * Retrieves a list of all known unicode file encodings.
-    * @return array
-    */
+    /**
+     * Retrieves a list of all known unicode file encodings.
+     * @return array
+     */
     public static function getKnownUnicodeEncodings()
     {
         return array_keys(self::getUTFBOMs());
     }
     
-   /**
-    * Normalizes the slash style in a file or folder path,
-    * by replacing any antislashes with forward slashes.
-    * 
-    * @param string $path
-    * @return string
-    */
+    /**
+     * Normalizes the slash style in a file or folder path,
+     * by replacing any antislashes with forward slashes.
+     * 
+     * @param string $path
+     * @return string
+     */
     public static function normalizePath(string $path) : string
     {
         return str_replace(array('\\', '//'), array('/', '/'), $path);
@@ -988,18 +988,18 @@ 
         }
     }
    
-   /**
-    * Saves the specified content to the target file, creating
-    * the file and the folder as necessary.
-    * 
-    * @param string $filePath
-    * @param string $content
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
-    * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
-    * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
-    */
+    /**
+     * Saves the specified content to the target file, creating
+     * the file and the folder as necessary.
+     * 
+     * @param string $filePath
+     * @param string $content
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
+     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
+     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
+     */
     public static function saveFile(string $filePath, string $content='') : void
     {
         // target file already exists
@@ -1052,12 +1052,12 @@ 
         );
     }
     
-   /**
-    * Checks whether it is possible to run PHP command 
-    * line commands.
-    * 
-    * @return boolean
-    */
+    /**
+     * Checks whether it is possible to run PHP command 
+     * line commands.
+     * 
+     * @return boolean
+     */
     public static function canMakePHPCalls() : bool
     {
         return self::cliCommandExists('php');
@@ -1132,16 +1132,16 @@ 
         return $result;
     }
     
-   /**
-    * Validates a PHP file's syntax.
-    * 
-    * NOTE: This will fail silently if the PHP command line
-    * is not available. Use {@link FileHelper::canMakePHPCalls()}
-    * to check this beforehand as needed.
-    * 
-    * @param string $path
-    * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise.
-    */
+    /**
+     * Validates a PHP file's syntax.
+     * 
+     * NOTE: This will fail silently if the PHP command line
+     * is not available. Use {@link FileHelper::canMakePHPCalls()}
+     * to check this beforehand as needed.
+     * 
+     * @param string $path
+     * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise.
+     */
     public static function checkPHPFileSyntax($path)
     {
         if(!self::canMakePHPCalls()) {
@@ -1165,14 +1165,14 @@ 
         return $output;
     }
     
-   /**
-    * Retrieves the last modified date for the specified file or folder.
-    * 
-    * Note: If the target does not exist, returns null. 
-    * 
-    * @param string $path
-    * @return \DateTime|NULL
-    */
+    /**
+     * Retrieves the last modified date for the specified file or folder.
+     * 
+     * Note: If the target does not exist, returns null. 
+     * 
+     * @param string $path
+     * @return \DateTime|NULL
+     */
     public static function getModifiedDate($path)
     {
         $time = filemtime($path);
@@ -1185,22 +1185,22 @@ 
         return null; 
     }
     
-   /**
-    * Retrieves the names of all subfolders in the specified path.
-    * 
-    * Available options:
-    * 
-    * - recursive: true/false
-    *   Whether to search for subfolders recursively. 
-    *   
-    * - absolute-paths: true/false
-    *   Whether to return a list of absolute paths.
-    * 
-    * @param string $targetFolder
-    * @param array $options
-    * @throws FileHelper_Exception
-    * @return string[]
-    */
+    /**
+     * Retrieves the names of all subfolders in the specified path.
+     * 
+     * Available options:
+     * 
+     * - recursive: true/false
+     *   Whether to search for subfolders recursively. 
+     *   
+     * - absolute-paths: true/false
+     *   Whether to return a list of absolute paths.
+     * 
+     * @param string $targetFolder
+     * @param array $options
+     * @throws FileHelper_Exception
+     * @return string[]
+     */
     public static function getSubfolders($targetFolder, $options = array())
     {
         if(!is_dir($targetFolder)) 
@@ -1261,16 +1261,16 @@ 
         return $result;
     }
 
-   /**
-    * Retrieves the maximum allowed upload file size, in bytes.
-    * Takes into account the PHP ini settings <code>post_max_size</code>
-    * and <code>upload_max_filesize</code>. Since these cannot
-    * be modified at runtime, they are the hard limits for uploads.
-    * 
-    * NOTE: Based on binary values, where 1KB = 1024 Bytes.
-    * 
-    * @return int Will return <code>-1</code> if no limit.
-    */
+    /**
+     * Retrieves the maximum allowed upload file size, in bytes.
+     * Takes into account the PHP ini settings <code>post_max_size</code>
+     * and <code>upload_max_filesize</code>. Since these cannot
+     * be modified at runtime, they are the hard limits for uploads.
+     * 
+     * NOTE: Based on binary values, where 1KB = 1024 Bytes.
+     * 
+     * @return int Will return <code>-1</code> if no limit.
+     */
     public static function getMaxUploadFilesize() : int
     {
         static $max_size = -1;
@@ -1307,16 +1307,16 @@ 
         return round($size);
     }
    
-   /**
-    * Makes a path relative using a folder depth: will reduce the
-    * length of the path so that only the amount of folders defined
-    * in the <code>$depth</code> attribute are shown below the actual
-    * folder or file in the path.
-    *  
-    * @param string  $path The absolute or relative path
-    * @param int $depth The folder depth to reduce the path to
-    * @return string
-    */
+    /**
+     * Makes a path relative using a folder depth: will reduce the
+     * length of the path so that only the amount of folders defined
+     * in the <code>$depth</code> attribute are shown below the actual
+     * folder or file in the path.
+     *  
+     * @param string  $path The absolute or relative path
+     * @param int $depth The folder depth to reduce the path to
+     * @return string
+     */
     public static function relativizePathByDepth(string $path, int $depth=2) : string
     {
         $path = self::normalizePath($path);
@@ -1354,23 +1354,23 @@ 
         return trim(implode('/', $tokens), '/');
     }
     
-   /**
-    * Makes the specified path relative to another path,
-    * by removing one from the other if found. Also 
-    * normalizes the path to use forward slashes. 
-    * 
-    * Example:
-    * 
-    * <pre>
-    * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder');
-    * </pre>
-    * 
-    * Result: <code>to/file.txt</code>
-    * 
-    * @param string $path
-    * @param string $relativeTo
-    * @return string
-    */
+    /**
+     * Makes the specified path relative to another path,
+     * by removing one from the other if found. Also 
+     * normalizes the path to use forward slashes. 
+     * 
+     * Example:
+     * 
+     * <pre>
+     * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder');
+     * </pre>
+     * 
+     * Result: <code>to/file.txt</code>
+     * 
+     * @param string $path
+     * @param string $relativeTo
+     * @return string
+     */
     public static function relativizePath(string $path, string $relativeTo) : string
     {
         $path = self::normalizePath($path);
@@ -1382,17 +1382,17 @@ 
         return $relative;
     }
     
-   /**
-    * Checks that the target file exists, and throws an exception
-    * if it does not. 
-    * 
-    * @param string $path
-    * @param int|NULL $errorCode Optional custom error code
-    * @throws FileHelper_Exception
-    * @return string The real path to the file
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    */
+    /**
+     * Checks that the target file exists, and throws an exception
+     * if it does not. 
+     * 
+     * @param string $path
+     * @param int|NULL $errorCode Optional custom error code
+     * @throws FileHelper_Exception
+     * @return string The real path to the file
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     */
     public static function requireFileExists(string $path, $errorCode=null) : string
     {
         $result = realpath($path);
@@ -1411,18 +1411,18 @@ 
         );
     }
     
-   /**
-    * Reads a specific line number from the target file and returns its
-    * contents, if the file has such a line. Does so with little memory
-    * usage, as the file is not read entirely into memory.
-    * 
-    * @param string $path
-    * @param int $lineNumber Note: 1-based; the first line is number 1.
-    * @return string|NULL Will return null if the requested line does not exist.
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    */
+    /**
+     * Reads a specific line number from the target file and returns its
+     * contents, if the file has such a line. Does so with little memory
+     * usage, as the file is not read entirely into memory.
+     * 
+     * @param string $path
+     * @param int $lineNumber Note: 1-based; the first line is number 1.
+     * @return string|NULL Will return null if the requested line does not exist.
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     */
     public static function getLineFromFile(string $path, int $lineNumber) : ?string
     {
         self::requireFileExists($path);
@@ -1438,19 +1438,19 @@ 
         $file->seek($targetLine);
         
         if($file->key() !== $targetLine) {
-             return null;
+                return null;
         }
         
         return $file->current(); 
     }
     
-   /**
-    * Retrieves the total amount of lines in the file, without 
-    * reading the whole file into memory.
-    * 
-    * @param string $path
-    * @return int
-    */
+    /**
+     * Retrieves the total amount of lines in the file, without 
+     * reading the whole file into memory.
+     * 
+     * @param string $path
+     * @return int
+     */
     public static function countFileLines(string $path) : int
     {
         self::requireFileExists($path);
@@ -1480,26 +1480,26 @@ 
         return $number+1;
     }
     
-   /**
-    * Parses the target file to detect any PHP classes contained
-    * within, and retrieve information on them. Does not use the 
-    * PHP reflection API.
-    * 
-    * @param string $filePath
-    * @return FileHelper_PHPClassInfo
-    */
+    /**
+     * Parses the target file to detect any PHP classes contained
+     * within, and retrieve information on them. Does not use the 
+     * PHP reflection API.
+     * 
+     * @param string $filePath
+     * @return FileHelper_PHPClassInfo
+     */
     public static function findPHPClasses(string $filePath) : FileHelper_PHPClassInfo
     {
         return new FileHelper_PHPClassInfo($filePath);
     }
     
-   /**
-    * Detects the end of line style used in the target file, if any.
-    * Can be used with large files, because it only reads part of it.
-    * 
-    * @param string $filePath The path to the file.
-    * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found.
-    */
+    /**
+     * Detects the end of line style used in the target file, if any.
+     * Can be used with large files, because it only reads part of it.
+     * 
+     * @param string $filePath The path to the file.
+     * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found.
+     */
     public static function detectEOLCharacter(string $filePath) : ?ConvertHelper_EOL
     {
         // 20 lines is enough to get a good picture of the newline style in the file.
@@ -1512,18 +1512,18 @@ 
         return ConvertHelper::detectEOLCharacter($string);
     }
     
-   /**
-    * Reads the specified amount of lines from the target file.
-    * Unicode BOM compatible: any byte order marker is stripped
-    * from the resulting lines.
-    * 
-    * @param string $filePath
-    * @param int $amount Set to 0 to read all lines.
-    * @return array
-    * 
-    * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    */
+    /**
+     * Reads the specified amount of lines from the target file.
+     * Unicode BOM compatible: any byte order marker is stripped
+     * from the resulting lines.
+     * 
+     * @param string $filePath
+     * @param int $amount Set to 0 to read all lines.
+     * @return array
+     * 
+     * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     */
     public static function readLines(string $filePath, int $amount=0) : array
     {
         self::requireFileExists($filePath);
@@ -1574,16 +1574,16 @@ 
         return $result;
     }
     
-   /**
-    * Reads all content from a file.
-    * 
-    * @param string $filePath
-    * @throws FileHelper_Exception
-    * @return string
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
-    */
+    /**
+     * Reads all content from a file.
+     * 
+     * @param string $filePath
+     * @throws FileHelper_Exception
+     * @return string
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
+     */
     public static function readContents(string $filePath) : string
     {
         self::requireFileExists($filePath);