Mistralys / application-utils

src/CSVHelper.php

Indentation +116 added lines, -116 removed lines

@@ -78,12 +78,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() : CSVHelper_Builder
     {
         return new CSVHelper_Builder();
@@ -91,16 +91,16 @@ 
 
 
 
-   /**
-    * 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 $this
-    */
+    /**
+     * 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 $this
+     */
     public function loadString(string $string) : self
     {
         // remove any UTF byte order marks that may still be present in the string
@@ -114,20 +114,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) : self
     {
         $csv = FileHelper::readContents($file);
@@ -188,19 +188,19 @@ 
         return $this->headersPosition === $position;
     }
     
-   /**
-    * 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 $this
-    *
-    * @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 $this
+     *
+     * @see CSVHelper::HEADERS_LEFT
+     * @see CSVHelper::HEADERS_TOP
+     * @see CSVHelper::HEADERS_NONE
+     */
     public function setHeadersPosition(string $position) : self
     {
         $validPositions = array(
@@ -227,13 +227,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 $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 $this
+     */
     public function reset() : self
     {
         $this->data = array();
@@ -253,81 +253,81 @@ 
         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<int,mixed>
-    * @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<int,mixed>
+     * @see rowExists()
+     */
     public function getRow(int $index) : array
     {
         return $this->data[$index] ?? 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(int $index) : bool
     {
         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() : int
     {
         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() : int
     {
         return $this->columnCount;
     }
     
-   /**
-    * Retrieves the headers, if any. Specify the position of the
-    * headers first to ensure this works correctly.
-    * 
-    * @return string[] Indexed array with header names.
-    */
+    /**
+     * Retrieves the headers, if any. Specify the position of the
+     * headers first to ensure this works correctly.
+     * 
+     * @return string[] Indexed array with header names.
+     */
     public function getHeaders() : array
     {
         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(int $index) : array
     {
         $data = array();
@@ -342,11 +342,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(int $index) : bool
     {
         return $index < $this->columnCount;
@@ -406,22 +406,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() : bool
     {
         return !empty($this->errors);
     }
     
-   /**
-    * Retrieves all error messages.
-    * @return string[]
-    */
+    /**
+     * Retrieves all error messages.
+     * @return string[]
+     */
     public function getErrorMessages() : array
     {
         return $this->errors;

src/URLInfo/URIConnectionTester.php

Indentation +10 added lines, -10 removed lines

@@ -43,13 +43,13 @@ 
         );
     }
     
-   /**
-    * Whether to verify the host's SSL certificate, in
-    * case of a https connection.
-    * 
-    * @param bool $verifySSL
-    * @return URIConnectionTester
-    */
+    /**
+     * Whether to verify the host's SSL certificate, in
+     * case of a https connection.
+     * 
+     * @param bool $verifySSL
+     * @return URIConnectionTester
+     */
     public function setVerifySSL(bool $verifySSL=true) : URIConnectionTester
     {
         $this->setOption('verify-ssl', $verifySSL);
@@ -83,9 +83,9 @@ 
         return $this->getIntOption('timeout');
     }
     
-   /**
-    * @param resource|CurlHandle $ch
-    */
+    /**
+     * @param resource|CurlHandle $ch
+     */
     private function configureOptions($ch) : void
     {
         if($this->isVerboseModeEnabled())

src/RequestHelper.php

Indentation +103 added lines, -103 removed lines

@@ -46,19 +46,19 @@ 
     protected int $contentLength = 0;
 
     /**
-    * @var array<string,string>
-    */
+     * @var array<string,string>
+     */
     protected $headers = array();
 
-   /**
-    * @var resource|NULL
-    */
+    /**
+     * @var resource|NULL
+     */
     protected $logfilePointer;
     
-   /**
-    * Creates a new request helper to send POST data to the specified destination URL.
-    * @param string $destinationURL
-    */
+    /**
+     * Creates a new request helper to send POST data to the specified destination URL.
+     * @param string $destinationURL
+     */
     public function __construct(string $destinationURL)
     {
         $this->destination = $destinationURL;
@@ -81,13 +81,13 @@ 
         return $this->eol;
     }
     
-   /**
-    * Sets the timeout for the request, in seconds. If the request
-    * takes longer, it will be cancelled and an exception triggered.
-    * 
-    * @param int $seconds
-    * @return RequestHelper
-    */
+    /**
+     * Sets the timeout for the request, in seconds. If the request
+     * takes longer, it will be cancelled and an exception triggered.
+     * 
+     * @param int $seconds
+     * @return RequestHelper
+     */
     public function setTimeout(int $seconds) : RequestHelper
     {
         $this->timeout = $seconds;
@@ -100,13 +100,13 @@ 
         return $this->timeout;
     }
     
-   /**
-    * Enables verbose logging of the CURL request, which
-    * is then redirected to the target file.
-    * 
-    * @param string $targetFile
-    * @return RequestHelper
-    */
+    /**
+     * Enables verbose logging of the CURL request, which
+     * is then redirected to the target file.
+     * 
+     * @param string $targetFile
+     * @return RequestHelper
+     */
     public function enableLogging(string $targetFile) : RequestHelper
     {
         $this->logfile = $targetFile;
@@ -114,15 +114,15 @@ 
         return $this;
     }
 
-   /**
-    * Adds a file to be sent with the request.
-    *
-    * @param string $varName The variable name to send the file in
-    * @param string $fileName The name of the file as it should be received at the destination
-    * @param string $content The raw content of the file
-    * @param string $contentType The content type, use the constants to specify this
-    * @param string $encoding The encoding of the file, use the constants to specify this
-    */
+    /**
+     * Adds a file to be sent with the request.
+     *
+     * @param string $varName The variable name to send the file in
+     * @param string $fileName The name of the file as it should be received at the destination
+     * @param string $content The raw content of the file
+     * @param string $contentType The content type, use the constants to specify this
+     * @param string $encoding The encoding of the file, use the constants to specify this
+     */
     public function addFile(string $varName, string $fileName, string $content, string $contentType = '', string $encoding = '') : RequestHelper
     {
         $this->boundaries->addFile($varName, $fileName, $content, $contentType, $encoding);
@@ -160,13 +160,13 @@ 
         return $this;
     }
     
-   /**
-    * Sets an HTTP header to include in the request.
-    * 
-    * @param string $name
-    * @param string $value
-    * @return RequestHelper
-    */
+    /**
+     * Sets an HTTP header to include in the request.
+     * 
+     * @param string $name
+     * @param string $value
+     * @return RequestHelper
+     */
     public function setHeader(string $name, string $value) : RequestHelper
     {
         $this->headers[$name] = $value;
@@ -174,31 +174,31 @@ 
         return $this;
     }
     
-   /**
-    * Disables SSL certificate checking.
-    * 
-    * @return RequestHelper
-    */
+    /**
+     * Disables SSL certificate checking.
+     * 
+     * @return RequestHelper
+     */
     public function disableSSLChecks() : RequestHelper
     {
         $this->verifySSL = false;
         return $this;
     }
    
-   /**
-    * Sends the POST request to the destination, and returns
-    * the response text.
-    *
-    * The response object is stored internally, so after calling
-    * this method it may be retrieved at any moment using the
-    * {@link getResponse()} method.
-    *
-    * @return string
-    * @see RequestHelper::getResponse()
-    * @throws RequestHelper_Exception
-    * 
-    * @see RequestHelper::ERROR_REQUEST_FAILED
-    */
+    /**
+     * Sends the POST request to the destination, and returns
+     * the response text.
+     *
+     * The response object is stored internally, so after calling
+     * this method it may be retrieved at any moment using the
+     * {@link getResponse()} method.
+     *
+     * @return string
+     * @see RequestHelper::getResponse()
+     * @throws RequestHelper_Exception
+     * 
+     * @see RequestHelper::ERROR_REQUEST_FAILED
+     */
     public function send() : string
     {
         $info = parseURL($this->destination);
@@ -238,13 +238,13 @@ 
         return $this->response->getResponseBody();
     }
     
-   /**
-    * Retrieves the request's body content. This is an alias
-    * for {@see RequestHelper::getMimeBody()}.
-    * 
-    * @return string
-    * @see RequestHelper::getMimeBody()
-    */
+    /**
+     * Retrieves the request's body content. This is an alias
+     * for {@see RequestHelper::getMimeBody()}.
+     * 
+     * @return string
+     * @see RequestHelper::getMimeBody()
+     */
     public function getBody() : string
     {
         return $this->getMimeBody();
@@ -276,14 +276,14 @@ 
         );
     }
 
-   /**
-    * Creates a new CURL resource configured according to the
-    * request's settings.
-    * 
-    * @param URLInfo $url
-    * @throws RequestHelper_Exception
-    * @return resource
-    */
+    /**
+     * Creates a new CURL resource configured according to the
+     * request's settings.
+     * 
+     * @param URLInfo $url
+     * @throws RequestHelper_Exception
+     * @return resource
+     */
     protected function configureCURL(URLInfo $url)
     {
         $ch = self::createCURL();
@@ -353,13 +353,13 @@ 
         return true;
     }
 
-   /**
-    * Compiles the associative headers array into
-    * the format understood by CURL, namely an indexed
-    * array with one header string per entry.
-    * 
-    * @return string[]
-    */
+    /**
+     * Compiles the associative headers array into
+     * the format understood by CURL, namely an indexed
+     * array with one header string per entry.
+     * 
+     * @return string[]
+     */
     protected function renderHeaders() : array
     {
         $result = array();
@@ -373,12 +373,12 @@ 
         return $result;
     }
     
-   /**
-    * Retrieves the raw response header, in the form of an indexed
-    * array containing all response header lines.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves the raw response header, in the form of an indexed
+     * array containing all response header lines.
+     * 
+     * @return string[]
+     */
     public function getResponseHeader() : array
     {
         $response = $this->getResponse();
@@ -390,33 +390,33 @@ 
         return array();
     }
 
-   /**
-    * After calling the {@link send()} method, this may be used to
-    * retrieve the response text from the POST request.
-    *
-    * @return RequestHelper_Response|NULL
-    */
+    /**
+     * After calling the {@link send()} method, this may be used to
+     * retrieve the response text from the POST request.
+     *
+     * @return RequestHelper_Response|NULL
+     */
     public function getResponse() : ?RequestHelper_Response
     {
         return $this->response;
     }
     
-   /**
-    * Retrieves all headers set until now.
-    * 
-    * @return array<string,string>
-    */
+    /**
+     * Retrieves all headers set until now.
+     * 
+     * @return array<string,string>
+     */
     public function getHeaders() : array
     {
         return $this->headers;
     }
     
-   /**
-    * Retrieves the value of a header by its name.
-    * 
-    * @param string $name
-    * @return string The header value, or an empty string if not set.
-    */
+    /**
+     * Retrieves the value of a header by its name.
+     * 
+     * @param string $name
+     * @return string The header value, or an empty string if not set.
+     */
     public function getHeader(string $name) : string
     {
         return $this->headers[$name] ?? '';

src/ImageHelper.php

Indentation +213 added lines, -213 removed lines

@@ -73,13 +73,13 @@ 
     protected array $colors = array();
 
     /**
-    * @var resource|NULL
-    */
+     * @var resource|NULL
+     */
     protected $newImage;
 
-   /**
-    * @var resource
-    */
+    /**
+     * @var resource
+     */
     protected $sourceImage;
 
     /**
@@ -188,17 +188,17 @@ 
         }
     }
 
-   /**
-    * Factory method: creates a new helper with a blank image.
-    * 
-    * @param integer $width
-    * @param integer $height
-    * @param string $type The target file type when saving
-    * @return ImageHelper
-    * @throws ImageHelper_Exception
-    *
-    * @see ImageHelper::ERROR_CANNOT_CREATE_IMAGE_OBJECT
-    */
+    /**
+     * Factory method: creates a new helper with a blank image.
+     * 
+     * @param integer $width
+     * @param integer $height
+     * @param string $type The target file type when saving
+     * @return ImageHelper
+     * @throws ImageHelper_Exception
+     *
+     * @see ImageHelper::ERROR_CANNOT_CREATE_IMAGE_OBJECT
+     */
     public static function createNew(int $width, int $height, string $type='png') : self
     {
         $img = imagecreatetruecolor($width, $height);
@@ -249,17 +249,17 @@ 
         return new ImageHelper($file, null, self::getFileImageType($file));
     }
     
-   /**
-    * Sets a global image helper configuration value. Available
-    * configuration settings are:
-    * 
-    * <ul>
-    * <li><code>auto-memory-adjustment</code> <i>boolean</i> Whether to try and adjust the memory limit automatically so there will be enough to load/process the target image.</li>
-    * </ul>
-    * 
-    * @param string $name
-    * @param mixed|NULL $value
-    */
+    /**
+     * Sets a global image helper configuration value. Available
+     * configuration settings are:
+     * 
+     * <ul>
+     * <li><code>auto-memory-adjustment</code> <i>boolean</i> Whether to try and adjust the memory limit automatically so there will be enough to load/process the target image.</li>
+     * </ul>
+     * 
+     * @param string $name
+     * @param mixed|NULL $value
+     */
     public static function setConfig(string $name, $value) : void
     {
         if(isset(self::$config[$name])) {
@@ -267,13 +267,13 @@ 
         }
     }
 
-   /**
-    * Shorthand for setting the automatic memory adjustment
-    * global configuration setting.
-    *
-    * @param bool $enabled
-    * @return void
-    */
+    /**
+     * Shorthand for setting the automatic memory adjustment
+     * global configuration setting.
+     *
+     * @param bool $enabled
+     * @return void
+     */
     public static function setAutoMemoryAdjustment(bool $enabled=true) : void
     {
         self::setConfig('auto-memory-adjustment', $enabled);
@@ -747,12 +747,12 @@ 
         return $this;
     }
 
-   /**
-    * Attempts to adjust the memory to the required size
-    * to work with the current image.
-    * 
-    * @return boolean
-    */
+    /**
+     * Attempts to adjust the memory to the required size
+     * to work with the current image.
+     * 
+     * @return boolean
+     */
     protected function adjustMemory() : bool
     {
         if(!self::$config['auto-memory-adjustment']) {
@@ -805,15 +805,15 @@ 
         return $this->resampleImage($width, $height);
     }
 
-   /**
-    * Creates a new image from the current image,
-    * resampling it to the new size.
-    * 
-    * @param int $newWidth
-    * @param int $newHeight   
-    * @throws ImageHelper_Exception
-    * @return ImageHelper
-    */
+    /**
+     * Creates a new image from the current image,
+     * resampling it to the new size.
+     * 
+     * @param int $newWidth
+     * @param int $newHeight   
+     * @throws ImageHelper_Exception
+     * @return ImageHelper
+     */
     protected function resampleImage(int $newWidth, int $newHeight) : ImageHelper
     {
         if($this->isVector()) {
@@ -885,17 +885,17 @@ 
         return array_unique($types);
     }
     
-   /**
-    * Displays an existing image resource.
-    *
-    * @param resource $resource
-    * @param string $imageType The image format to send, i.e. "jpeg", "png"
-    * @param int $quality The quality to use for the image. This is 0-9 (0=no compression, 9=max) for PNG, and 0-100 (0=lowest, 100=highest quality) for JPG
-    *
-    * @throws ImageHelper_Exception
-    * @see ImageHelper::ERROR_NOT_A_RESOURCE
-    * @see ImageHelper::ERROR_INVALID_STREAM_IMAGE_TYPE
-    */
+    /**
+     * Displays an existing image resource.
+     *
+     * @param resource $resource
+     * @param string $imageType The image format to send, i.e. "jpeg", "png"
+     * @param int $quality The quality to use for the image. This is 0-9 (0=no compression, 9=max) for PNG, and 0-100 (0=lowest, 100=highest quality) for JPG
+     *
+     * @throws ImageHelper_Exception
+     * @see ImageHelper::ERROR_NOT_A_RESOURCE
+     * @see ImageHelper::ERROR_INVALID_STREAM_IMAGE_TYPE
+     */
     public static function displayImageStream($resource, string $imageType, int $quality=-1) : void
     {
         self::requireResource($resource);
@@ -979,11 +979,11 @@ 
         readfile($imageFile);
     }
     
-   /**
-    * Displays the current image.
-    *
-    * NOTE: You must call `exit()` manually after this.
-    */
+    /**
+     * Displays the current image.
+     *
+     * NOTE: You must call `exit()` manually after this.
+     */
     public function display() : void
     {
         self::displayImageStream(
@@ -1097,14 +1097,14 @@ 
         return $this;
     }
     
-   /**
-    * Requires the subject to be a resource.
-    * 
-    * @param resource|GdImage|mixed $subject
-    *
-    * @throws ImageHelper_Exception
-    * @see ImageHelper::ERROR_NOT_A_RESOURCE
-    */
+    /**
+     * Requires the subject to be a resource.
+     * 
+     * @param resource|GdImage|mixed $subject
+     *
+     * @throws ImageHelper_Exception
+     * @see ImageHelper::ERROR_NOT_A_RESOURCE
+     */
     public static function requireResource($subject) : void
     {
         if(is_resource($subject) && imagesx($subject)) {
@@ -1125,14 +1125,14 @@ 
         );
     }
     
-   /**
-    * Creates a new image resource, with transparent background.
-    * 
-    * @param int $width
-    * @param int $height
-    * @throws ImageHelper_Exception
-    * @return resource
-    */
+    /**
+     * Creates a new image resource, with transparent background.
+     * 
+     * @param int $width
+     * @param int $height
+     * @throws ImageHelper_Exception
+     * @return resource
+     */
     public function createNewImage(int $width, int $height)
     {
         $img = imagecreatetruecolor($width, $height);
@@ -1156,38 +1156,38 @@ 
      * @param int $y
      * @return $this
      */
-	public function fillWhite(int $x=0, int $y=0) : self
-	{
-	    $this->addRGBColor('white', 255, 255, 255);
+    public function fillWhite(int $x=0, int $y=0) : self
+    {
+        $this->addRGBColor('white', 255, 255, 255);
         return $this->fill('white', $x, $y);
-	}
+    }
 
     /**
      * @return $this
      * @throws ImageHelper_Exception
      */
-	public function fillTransparent() : self
-	{
+    public function fillTransparent() : self
+    {
         $this->enableAlpha();
 	    
-	    self::fillImageTransparent($this->newImage);
+        self::fillImageTransparent($this->newImage);
 	    
-	    return $this;
-	}
+        return $this;
+    }
 
     /**
      * @param resource $resource
      * @return void
      * @throws ImageHelper_Exception
      */
-	public static function fillImageTransparent($resource) : void
-	{
-	    self::requireResource($resource);
+    public static function fillImageTransparent($resource) : void
+    {
+        self::requireResource($resource);
 	    
-	    $transparent = imagecolorallocatealpha($resource, 89, 14, 207, 127);
-	    imagecolortransparent ($resource, $transparent);
-	    imagefill($resource, 0, 0, $transparent);
-	}
+        $transparent = imagecolorallocatealpha($resource, 89, 14, 207, 127);
+        imagecolortransparent ($resource, $transparent);
+        imagefill($resource, 0, 0, $transparent);
+    }
 
     /**
      * @param string $colorName
@@ -1195,11 +1195,11 @@ 
      * @param int $y
      * @return $this
      */
-	public function fill(string $colorName, int $x=0, int $y=0) : self
-	{
-	    imagefill($this->newImage, $x, $y, $this->colors[$colorName]);
-	    return $this;
-	}
+    public function fill(string $colorName, int $x=0, int $y=0) : self
+    {
+        imagefill($this->newImage, $x, $y, $this->colors[$colorName]);
+        return $this;
+    }
 
     /**
      * @param string $name
@@ -1243,9 +1243,9 @@ 
         return $this;
     }
     
-   /**
-    * @return resource
-    */
+    /**
+     * @return resource
+     */
     public function getImage()
     {
         return $this->newImage;
@@ -1293,17 +1293,17 @@ 
      *
      * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE
      */
-	public function getSize() : ImageHelper_Size
+    public function getSize() : ImageHelper_Size
     {
-	    return self::getImageSize($this->newImage);
+        return self::getImageSize($this->newImage);
     }
     
-   /**
-    * Sets the TTF font file to use for text operations.
-    * 
-    * @param string $filePath
-    * @return $this
-    */
+    /**
+     * Sets the TTF font file to use for text operations.
+     * 
+     * @param string $filePath
+     * @return $this
+     */
     public function setFontTTF(string $filePath) : self
     {
         $this->TTFFile = $filePath;
@@ -1381,7 +1381,7 @@ 
             return;
         }
         
-	    throw new ImageHelper_Exception(
+        throw new ImageHelper_Exception(
             'No true type font specified',
             'This functionality requires a TTF font file to be specified with the [setFontTTF] method.',
             self::ERROR_NO_TRUE_TYPE_FONT_SET    
@@ -1404,37 +1404,37 @@ 
      * @see ImageHelper::ERROR_SVG_SOURCE_VIEWBOX_MISSING
      * @see ImageHelper::ERROR_SVG_VIEWBOX_INVALID
      */
-	public static function getImageSize($pathOrResource) : ImageHelper_Size
-	{
-	    if(is_resource($pathOrResource) || $pathOrResource instanceof GdImage)
-	    {
-	        return new ImageHelper_Size(array(
-	            'width' => imagesx($pathOrResource),
-	            'height' => imagesy($pathOrResource),
-	            'channels' => 1,
-	            'bits' => 8
-	        ));
-	    }
+    public static function getImageSize($pathOrResource) : ImageHelper_Size
+    {
+        if(is_resource($pathOrResource) || $pathOrResource instanceof GdImage)
+        {
+            return new ImageHelper_Size(array(
+                'width' => imagesx($pathOrResource),
+                'height' => imagesy($pathOrResource),
+                'channels' => 1,
+                'bits' => 8
+            ));
+        }
 
-	    $type = self::getFileImageType($pathOrResource);
+        $type = self::getFileImageType($pathOrResource);
 
         $sizeMethods = array(
             'svg' => array(self::class, 'getImageSize_svg')
         );
 
-	    if(isset($sizeMethods[$type]))
-	    {
-	        return ClassHelper::requireObjectInstanceOf(
+        if(isset($sizeMethods[$type]))
+        {
+            return ClassHelper::requireObjectInstanceOf(
                 ImageHelper_Size::class,
                 $sizeMethods[$type]($pathOrResource)
             );
-	    }
+        }
 
-	    $info = getimagesize($pathOrResource);
+        $info = getimagesize($pathOrResource);
 
-	    if($info !== false) {
-	        return new ImageHelper_Size($info);
-	    }
+        if($info !== false) {
+            return new ImageHelper_Size($info);
+        }
 	    
         throw new ImageHelper_Exception(
             'Error opening image file',
@@ -1444,7 +1444,7 @@ 
             ),
             self::ERROR_CANNOT_GET_IMAGE_SIZE
         );
-	}
+    }
 
     /**
      * @param string $imagePath
@@ -1454,78 +1454,78 @@ 
      * @throws XMLHelper_Exception
      * @throws JsonException
      */
-	protected static function getImageSize_svg(string $imagePath) : ImageHelper_Size
-	{
-	    $xml = XMLHelper::createSimplexml();
-	    $xml->loadFile($imagePath);
+    protected static function getImageSize_svg(string $imagePath) : ImageHelper_Size
+    {
+        $xml = XMLHelper::createSimplexml();
+        $xml->loadFile($imagePath);
 	    
-	    if($xml->hasErrors()) {
-	        throw new ImageHelper_Exception(
-	            'Error opening SVG image',
-	            sprintf(
-	                'The XML content of the image [%s] could not be parsed.',
-	                $imagePath
+        if($xml->hasErrors()) {
+            throw new ImageHelper_Exception(
+                'Error opening SVG image',
+                sprintf(
+                    'The XML content of the image [%s] could not be parsed.',
+                    $imagePath
                 ),
-	            self::ERROR_CANNOT_READ_SVG_IMAGE
+                self::ERROR_CANNOT_READ_SVG_IMAGE
             );
-	    }
+        }
 	    
-	    $data = $xml->toArray();
-	    $xml->dispose();
-	    unset($xml);
+        $data = $xml->toArray();
+        $xml->dispose();
+        unset($xml);
 	    
-	    if(!isset($data['@attributes']['viewBox'])) {
-	        throw new ImageHelper_Exception(
-	            'SVG Image is corrupted',
-	            sprintf(
-	                'The [viewBox] attribute is missing in the XML of the image at path [%s].',
-	                $imagePath
+        if(!isset($data['@attributes']['viewBox'])) {
+            throw new ImageHelper_Exception(
+                'SVG Image is corrupted',
+                sprintf(
+                    'The [viewBox] attribute is missing in the XML of the image at path [%s].',
+                    $imagePath
                 ),
-	            self::ERROR_SVG_SOURCE_VIEWBOX_MISSING
+                self::ERROR_SVG_SOURCE_VIEWBOX_MISSING
             );
-	    }
+        }
 	    
-	    $svgWidth = parseNumber($data['@attributes']['width'])->getNumber();
-	    $svgHeight = parseNumber($data['@attributes']['height'])->getNumber();
+        $svgWidth = parseNumber($data['@attributes']['width'])->getNumber();
+        $svgHeight = parseNumber($data['@attributes']['height'])->getNumber();
 	    
-	    $viewBox = str_replace(' ', ',', $data['@attributes']['viewBox']);
-	    $size = explode(',', $viewBox);
+        $viewBox = str_replace(' ', ',', $data['@attributes']['viewBox']);
+        $size = explode(',', $viewBox);
 	    
-	    if(count($size) !== 4)
-	    {
-	        throw new ImageHelper_Exception(
-	            'SVG image has an invalid viewBox attribute',
-	            sprintf(
-	               'The [viewBox] attribute does not have an expected value: [%s] in path [%s].',
-	                $viewBox,
-	                $imagePath
+        if(count($size) !== 4)
+        {
+            throw new ImageHelper_Exception(
+                'SVG image has an invalid viewBox attribute',
+                sprintf(
+                    'The [viewBox] attribute does not have an expected value: [%s] in path [%s].',
+                    $viewBox,
+                    $imagePath
                 ),
-	            self::ERROR_SVG_VIEWBOX_INVALID
+                self::ERROR_SVG_VIEWBOX_INVALID
             );
-	    }
+        }
 	    
-	    $boxWidth = (float)$size[2];
-	    $boxHeight = (float)$size[3];
+        $boxWidth = (float)$size[2];
+        $boxHeight = (float)$size[3];
 	    
-	    // calculate the x and y units of the document: 
-	    // @see http://tutorials.jenkov.com/svg/svg-viewport-view-box.html#viewbox
-	    //
-	    // The viewbox combined with the width and height of the svg
-	    // allow calculating how many pixels are in one unit of the 
-	    // width and height of the document.
+        // calculate the x and y units of the document: 
+        // @see http://tutorials.jenkov.com/svg/svg-viewport-view-box.html#viewbox
         //
-	    $xUnits = $svgWidth / $boxWidth;
-	    $yUnits = $svgHeight / $boxHeight;
+        // The viewbox combined with the width and height of the svg
+        // allow calculating how many pixels are in one unit of the 
+        // width and height of the document.
+        //
+        $xUnits = $svgWidth / $boxWidth;
+        $yUnits = $svgHeight / $boxHeight;
 	    
-	    $pxWidth = $xUnits * $svgWidth;
-	    $pxHeight = $yUnits * $svgHeight;
+        $pxWidth = $xUnits * $svgWidth;
+        $pxHeight = $yUnits * $svgHeight;
 	    
-	    return new ImageHelper_Size(array(
+        return new ImageHelper_Size(array(
             (int)$pxWidth,
             (int)$pxHeight,
-	        'bits' => 8
-	    ));
-	}
+            'bits' => 8
+        ));
+    }
 
     /**
      * Crops the image to the specified width and height, optionally
@@ -1584,26 +1584,26 @@ 
         return $image->getColorAt(0, 0);
     }
     
-   /**
-    * Calculates the image's average color value, and
-    * returns an associative array with red, green,
-    * blue and alpha keys.
-    * 
-    * @throws ImageHelper_Exception
-    * @return RGBAColor
-    */
+    /**
+     * Calculates the image's average color value, and
+     * returns an associative array with red, green,
+     * blue and alpha keys.
+     * 
+     * @throws ImageHelper_Exception
+     * @return RGBAColor
+     */
     public function calcAverageColorRGB() : RGBAColor
     {
-       return $this->calcAverageColor();
+        return $this->calcAverageColor();
     }
     
-   /**
-    * Calculates the image's average color value, and
-    * returns a hex color string (without the #).
-    * 
-    * @throws ImageHelper_Exception
-    * @return string
-    */
+    /**
+     * Calculates the image's average color value, and
+     * returns a hex color string (without the #).
+     * 
+     * @throws ImageHelper_Exception
+     * @return string
+     */
     public function calcAverageColorHex() : string
     {
         return $this->calcAverageColor()->toHEX();
@@ -1653,15 +1653,15 @@ 
         return $this->calcAverageColorRGB()->getBrightness();
     }
     
-   /**
-    * Retrieves a md5 hash of the source image file.
-    * 
-    * NOTE: Only works when the helper has been created
-    * from a file. Otherwise, an exception is thrown.
-    * 
-    * @return string
-    * @throws ImageHelper_Exception|OutputBuffering_Exception
-    */
+    /**
+     * Retrieves a md5 hash of the source image file.
+     * 
+     * NOTE: Only works when the helper has been created
+     * from a file. Otherwise, an exception is thrown.
+     * 
+     * @return string
+     * @throws ImageHelper_Exception|OutputBuffering_Exception
+     */
     public function getHash() : string
     {
         if($this->newImage === null)

src/FileHelper.php

Indentation +162 added lines, -162 removed lines

@@ -73,18 +73,18 @@ 
     public const ERROR_PATH_INVALID = 340040;
     public const ERROR_CANNOT_COPY_FILE_TO_FOLDER = 340041;
 
-   /**
-    * Opens a serialized file and returns the unserialized data.
-    *
-    * @param string|PathInfoInterface|SplFileInfo $file
-    * @throws FileHelper_Exception
-    * @return array<int|string,mixed>
-    * @see SerializedFile::parse()
-    * 
-    * @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|PathInfoInterface|SplFileInfo $file
+     * @throws FileHelper_Exception
+     * @return array<int|string,mixed>
+     * @see SerializedFile::parse()
+     * 
+     * @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($file) : array
     {
         return SerializedFile::factory($file)->parse();
@@ -103,13 +103,13 @@ 
         return FolderTree::delete($rootFolder);
     }
     
-   /**
-    * Create a folder, if it does not exist yet.
-    *  
-    * @param string|PathInfoInterface $path
-    * @throws FileHelper_Exception
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
-    */
+    /**
+     * Create a folder, if it does not exist yet.
+     *  
+     * @param string|PathInfoInterface $path
+     * @throws FileHelper_Exception
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
+     */
     public static function createFolder($path) : FolderInfo
     {
         return self::getFolderInfo($path)->create();
@@ -138,36 +138,36 @@ 
         FolderTree::copy($source, $target);
     }
     
-   /**
-    * 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|PathInfoInterface|SplFileInfo $sourcePath
-    * @param string|PathInfoInterface|SplFileInfo $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|PathInfoInterface|SplFileInfo $sourcePath
+     * @param string|PathInfoInterface|SplFileInfo $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) : void
     {
         self::getFileInfo($sourcePath)->copyTo($targetPath);
     }
     
-   /**
-    * Deletes the target file. Ignored if it cannot be found,
-    * and throws an exception if it fails.
-    * 
-    * @param string|PathInfoInterface|SplFileInfo $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|PathInfoInterface|SplFileInfo $filePath
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_CANNOT_DELETE_FILE
+     */
     public static function deleteFile($filePath) : void
     {
         self::getFileInfo($filePath)->delete();
@@ -288,7 +288,7 @@ 
      */
     public static function isPHPFile($filePath) : bool
     {
-    	return self::getExtension($filePath) === 'php';
+        return self::getExtension($filePath) === 'php';
     }
 
     /**
@@ -354,16 +354,16 @@ 
             ->parse();
     }
     
-   /**
-    * 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
     {
         return NameFixer::fixName($name);
@@ -423,23 +423,23 @@ 
         return self::findFiles($targetFolder, array('php'), $options);
     }
     
-   /**
-    * Finds files according to the specified options.
-    * 
-    * NOTE: This method only exists for backwards compatibility.
-    * Use the {@see FileHelper::createFileFinder()} method instead,
-    * which offers an object-oriented interface that is much easier
-    * to use.
-    *  
-    * @param string|PathInfoInterface|SplFileInfo $targetFolder
-    * @param string[] $extensions
-    * @param array<string,mixed> $options
-    * @throws FileHelper_Exception
-    * @return string[]
-    *
-    * @see FileHelper::createFileFinder()
-    * @deprecated Use the file finder instead.
-    */
+    /**
+     * Finds files according to the specified options.
+     * 
+     * NOTE: This method only exists for backwards compatibility.
+     * Use the {@see FileHelper::createFileFinder()} method instead,
+     * which offers an object-oriented interface that is much easier
+     * to use.
+     *  
+     * @param string|PathInfoInterface|SplFileInfo $targetFolder
+     * @param string[] $extensions
+     * @param array<string,mixed> $options
+     * @throws FileHelper_Exception
+     * @return string[]
+     *
+     * @see FileHelper::createFileFinder()
+     * @deprecated Use the file finder instead.
+     */
     public static function findFiles($targetFolder, array $extensions=array(), array $options=array()) : array
     {
         $finder = self::createFileFinder($targetFolder);
@@ -510,13 +510,13 @@ 
         return self::$unicodeHandling;
     }
     
-   /**
-    * Normalizes the slash style in a file or folder path,
-    * by replacing any anti-slashes with forward slashes.
-    * 
-    * @param string $path
-    * @return string
-    */
+    /**
+     * Normalizes the slash style in a file or folder path,
+     * by replacing any anti-slashes with forward slashes.
+     * 
+     * @param string $path
+     * @return string
+     */
     public static function normalizePath(string $path) : string
     {
         return str_replace(array('\\', '//'), array('/', '/'), $path);
@@ -641,70 +641,70 @@ 
             ->getPaths();
     }
 
-   /**
-    * 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
     {
         return UploadFileSizeInfo::getFileSize();
     }
    
-   /**
-    * 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
     {
         return PathRelativizer::relativizeByDepth($path, $depth);
     }
     
-   /**
-    * 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
     {
         return PathRelativizer::relativize($path, $relativeTo);
     }
     
-   /**
-    * Checks that the target file exists, and throws an exception
-    * if it does not. 
-    * 
-    * @param string|SplFileInfo $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
-    * @see FileHelper::ERROR_REAL_PATH_NOT_FOUND
-    */
+    /**
+     * Checks that the target file exists, and throws an exception
+     * if it does not. 
+     * 
+     * @param string|SplFileInfo $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
+     * @see FileHelper::ERROR_REAL_PATH_NOT_FOUND
+     */
     public static function requireFileExists($path, ?int $errorCode=null) : string
     {
         return self::getPathInfo($path)
@@ -727,18 +727,18 @@ 
             ->getPath();
     }
     
-   /**
-    * 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|PathInfoInterface|SplFileInfo $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|PathInfoInterface|SplFileInfo $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($path, int $lineNumber) : ?string
     {
         return self::getFileInfo($path)->getLine($lineNumber);
@@ -804,33 +804,33 @@ 
             ->getLines($amount);
     }
     
-   /**
-    * Reads all content from a file.
-    * 
-    * @param string|PathInfoInterface|SplFileInfo $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|PathInfoInterface|SplFileInfo $filePath
+     * @throws FileHelper_Exception
+     * @return string
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
+     */
     public static function readContents($filePath) : string
     {
         return self::getFileInfo($filePath)->getContents();
     }
 
-   /**
-    * Ensures that the target path exists on disk, and is a folder.
-    * 
-    * @param string|PathInfoInterface|SplFileInfo $path
-    * @return string The real path, with normalized slashes.
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::normalizePath()
-    * 
-    * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER
-    */
+    /**
+     * Ensures that the target path exists on disk, and is a folder.
+     * 
+     * @param string|PathInfoInterface|SplFileInfo $path
+     * @return string The real path, with normalized slashes.
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::normalizePath()
+     * 
+     * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER
+     */
     public static function requireFolderExists($path) : string
     {
         return self::getFolderInfo($path)