Mistralys / application-utils

src/ConvertHelper/TimeConverter.php

Indentation +17 added lines, -17 removed lines

@@ -23,19 +23,19 @@ 
  */
 class ConvertHelper_TimeConverter
 {
-   /**
-    * @var float
-    */
+    /**
+     * @var float
+     */
     private $seconds;
 
-   /**
-    * @var array<int,array<string,string|int>>
-    */
+    /**
+     * @var array<int,array<string,string|int>>
+     */
     private static $units;
     
-   /**
-    * @param float $seconds
-    */
+    /**
+     * @param float $seconds
+     */
     public function __construct($seconds)
     {
         $this->seconds = $seconds;   
@@ -43,9 +43,9 @@ 
         $this->initUnits();
     }
     
-   /**
-    * Creates the list of units once per request as needed.
-    */
+    /**
+     * Creates the list of units once per request as needed.
+     */
     private function initUnits() : void
     {
         if(isset(self::$units))
@@ -112,11 +112,11 @@ 
         return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last;
     }
     
-   /**
-    * Resolves the list of converted units.
-    * 
-    * @return string[]
-    */
+    /**
+     * Resolves the list of converted units.
+     * 
+     * @return string[]
+     */
     private function resolveTokens() : array
     {
         $seconds = $this->seconds;

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;
 
     /**
@@ -56,33 +56,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/URLInfo/ConnectionTester.php

Indentation +19 added lines, -19 removed lines

@@ -22,9 +22,9 @@ 
 {
     use Traits_Optionable;
     
-   /**
-    * @var URLInfo
-    */
+    /**
+     * @var URLInfo
+     */
     private $url;
     
     public function __construct(URLInfo $url)
@@ -41,13 +41,13 @@ 
         );
     }
     
-   /**
-    * Whether to verify the host's SSL certificate, in
-    * case of an https connection.
-    * 
-    * @param bool $verifySSL
-    * @return URLInfo_ConnectionTester
-    */
+    /**
+     * Whether to verify the host's SSL certificate, in
+     * case of an https connection.
+     * 
+     * @param bool $verifySSL
+     * @return URLInfo_ConnectionTester
+     */
     public function setVerifySSL(bool $verifySSL=true) : URLInfo_ConnectionTester
     {
         $this->setOption('verify-ssl', $verifySSL);
@@ -81,12 +81,12 @@ 
         return $this->getIntOption('timeout');
     }
     
-   /**
-    * Initializes the CURL instance.
-    * 
-    * @throws BaseException
-    * @return resource
-    */
+    /**
+     * Initializes the CURL instance.
+     * 
+     * @throws BaseException
+     * @return resource
+     */
     private function initCURL()
     {
         $ch = curl_init();
@@ -103,9 +103,9 @@ 
         return $ch;
     }
     
-   /**
-    * @param resource $ch
-    */
+    /**
+     * @param resource $ch
+     */
     private function configureOptions($ch) : void
     {
         if($this->isVerboseModeEnabled())

src/FileHelper/FileFinder.php

Indentation +137 added lines, -137 removed lines

@@ -33,24 +33,24 @@ 
     
     const PATH_MODE_STRIP = 'strip';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $path;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $found;
     
-   /**
-    * The path must exist when the class is instantiated: its
-    * real path will be determined to work with.
-    * 
-    * @param string $path The absolute path to the target folder.
-    * @throws FileHelper_Exception
-    * @see FileHelper_FileFinder::ERROR_PATH_DOES_NOT_EXIST
-    */
+    /**
+     * The path must exist when the class is instantiated: its
+     * real path will be determined to work with.
+     * 
+     * @param string $path The absolute path to the target folder.
+     * @throws FileHelper_Exception
+     * @see FileHelper_FileFinder::ERROR_PATH_DOES_NOT_EXIST
+     */
     public function __construct(string $path)
     {
         $real = realpath($path);
@@ -82,66 +82,66 @@ 
         );
     }
     
-   /**
-    * Enables extension stripping, to return file names without extension.
-    * 
-    * @return FileHelper_FileFinder
-    */
+    /**
+     * Enables extension stripping, to return file names without extension.
+     * 
+     * @return FileHelper_FileFinder
+     */
     public function stripExtensions() : FileHelper_FileFinder
     {
         return $this->setOption('strip-extensions', true);
     }
     
-   /**
-    * Enables recursing into subfolders.
-    * 
-    * @return FileHelper_FileFinder
-    */
+    /**
+     * Enables recursing into subfolders.
+     * 
+     * @return FileHelper_FileFinder
+     */
     public function makeRecursive() : FileHelper_FileFinder
     {
         return $this->setOption('recursive', true);
     }
     
-   /**
-    * Retrieves all extensions that were added to
-    * the include list.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves all extensions that were added to
+     * the include list.
+     * 
+     * @return string[]
+     */
     public function getIncludeExtensions() : array
     {
         return $this->getArrayOption('include-extensions');
     }
     
-   /**
-    * Includes a single extension in the file search: only
-    * files with this extension will be used in the results.
-    * 
-    * NOTE: Included extensions take precedence before excluded
-    * extensions. If any excluded extensions are specified, they
-    * will be ignored.
-    * 
-    * @param string $extension Extension name, without dot (`php` for example).
-    * @return FileHelper_FileFinder
-    * @see FileHelper_FileFinder::includeExtensions()
-    */
+    /**
+     * Includes a single extension in the file search: only
+     * files with this extension will be used in the results.
+     * 
+     * NOTE: Included extensions take precedence before excluded
+     * extensions. If any excluded extensions are specified, they
+     * will be ignored.
+     * 
+     * @param string $extension Extension name, without dot (`php` for example).
+     * @return FileHelper_FileFinder
+     * @see FileHelper_FileFinder::includeExtensions()
+     */
     public function includeExtension(string $extension) : FileHelper_FileFinder
     {
         return $this->includeExtensions(array($extension));
     }
     
-   /**
-    * Includes several extensions in the file search: only
-    * files with these extensions wil be used in the results.
-    * 
-    * NOTE: Included extensions take precedence before excluded
-    * extensions. If any excluded extensions are specified, they
-    * will be ignored.
-    * 
-    * @param array $extensions Extension names, without dot (`php` for example).
-    * @return FileHelper_FileFinder
-    * @see FileHelper_FileFinder::includeExtension()
-    */
+    /**
+     * Includes several extensions in the file search: only
+     * files with these extensions wil be used in the results.
+     * 
+     * NOTE: Included extensions take precedence before excluded
+     * extensions. If any excluded extensions are specified, they
+     * will be ignored.
+     * 
+     * @param array $extensions Extension names, without dot (`php` for example).
+     * @return FileHelper_FileFinder
+     * @see FileHelper_FileFinder::includeExtension()
+     */
     public function includeExtensions(array $extensions) : FileHelper_FileFinder
     {
         $items = $this->getIncludeExtensions();
@@ -152,37 +152,37 @@ 
         return $this;
     }
 
-   /**
-    * Retrieves a list of all extensions currently set as 
-    * excluded from the search.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all extensions currently set as 
+     * excluded from the search.
+     * 
+     * @return string[]
+     */
     public function getExcludeExtensions() : array
     {
         return $this->getArrayOption('exclude-extensions');
     }
     
-   /**
-    * Excludes a single extension from the search.
-    * 
-    * @param string $extension Extension name, without dot (`php` for example).
-    * @return FileHelper_FileFinder
-    * @see FileHelper_FileFinder::excludeExtensions()
-    */
+    /**
+     * Excludes a single extension from the search.
+     * 
+     * @param string $extension Extension name, without dot (`php` for example).
+     * @return FileHelper_FileFinder
+     * @see FileHelper_FileFinder::excludeExtensions()
+     */
     public function excludeExtension(string $extension) : FileHelper_FileFinder
     {
         return $this->excludeExtensions(array($extension));
     }
 
-   /**
-    * Add several extensions to the list of extensions to
-    * exclude from the file search.
-    *  
-    * @param array $extensions Extension names, without dot (`php` for example).
-    * @return FileHelper_FileFinder
-    * @see FileHelper_FileFinder::excludeExtension()
-    */
+    /**
+     * Add several extensions to the list of extensions to
+     * exclude from the file search.
+     *  
+     * @param array $extensions Extension names, without dot (`php` for example).
+     * @return FileHelper_FileFinder
+     * @see FileHelper_FileFinder::excludeExtension()
+     */
     public function excludeExtensions(array $extensions) : FileHelper_FileFinder
     {
         $items = $this->getExcludeExtensions();
@@ -193,52 +193,52 @@ 
         return $this;
     }
     
-   /**
-    * In this mode, the entire path to the file will be stripped,
-    * leaving only the file name in the files list.
-    * 
-    * @return FileHelper_FileFinder
-    */
+    /**
+     * In this mode, the entire path to the file will be stripped,
+     * leaving only the file name in the files list.
+     * 
+     * @return FileHelper_FileFinder
+     */
     public function setPathmodeStrip() : FileHelper_FileFinder
     {
         return $this->setPathmode(self::PATH_MODE_STRIP);
     }
     
-   /**
-    * In this mode, only the path relative to the source folder
-    * will be included in the files list.
-    * 
-    * @return FileHelper_FileFinder
-    */
+    /**
+     * In this mode, only the path relative to the source folder
+     * will be included in the files list.
+     * 
+     * @return FileHelper_FileFinder
+     */
     public function setPathmodeRelative() : FileHelper_FileFinder
     {
         return $this->setPathmode(self::PATH_MODE_RELATIVE);
     }
     
-   /**
-    * In this mode, the full, absolute paths to the files will
-    * be included in the files list.
-    * 
-    * @return FileHelper_FileFinder
-    */
+    /**
+     * In this mode, the full, absolute paths to the files will
+     * be included in the files list.
+     * 
+     * @return FileHelper_FileFinder
+     */
     public function setPathmodeAbsolute() : FileHelper_FileFinder
     {
         return $this->setPathmode(self::PATH_MODE_ABSOLUTE);
     }
     
-   /**
-    * This sets a character or string to replace the slashes
-    * in the paths with. 
-    * 
-    * This is used for example in the `getPHPClassNames()` 
-    * method, to return files from subfolders as class names
-    * using the "_" character:
-    * 
-    * Subfolder/To/File.php => Subfolder_To_File.php
-    * 
-    * @param string $character
-    * @return FileHelper_FileFinder
-    */
+    /**
+     * This sets a character or string to replace the slashes
+     * in the paths with. 
+     * 
+     * This is used for example in the `getPHPClassNames()` 
+     * method, to return files from subfolders as class names
+     * using the "_" character:
+     * 
+     * Subfolder/To/File.php => Subfolder_To_File.php
+     * 
+     * @param string $character
+     * @return FileHelper_FileFinder
+     */
     public function setSlashReplacement(string $character) : FileHelper_FileFinder
     {
         return $this->setOption('slash-replacement', $character);
@@ -249,12 +249,12 @@ 
         return $this->setOption('pathmode', $mode);
     }
     
-   /**
-    * Retrieves a list of all matching file names/paths,
-    * depending on the selected options.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all matching file names/paths,
+     * depending on the selected options.
+     * 
+     * @return string[]
+     */
     public function getAll() : array
     {
         $this->find($this->path, true);
@@ -262,24 +262,24 @@ 
         return $this->found;
     }
     
-   /**
-    * Retrieves only PHP files. Can be combined with other
-    * options like enabling recursion into subfolders.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves only PHP files. Can be combined with other
+     * options like enabling recursion into subfolders.
+     * 
+     * @return string[]
+     */
     public function getPHPFiles() : array
     {
         $this->includeExtensions(array('php'));
         return $this->getAll();
     }
     
-   /**
-    * Generates PHP class names from file paths: it replaces
-    * slashes with underscores, and removes file extensions.
-    * 
-    * @return string[] An array of PHP file names without extension.
-    */
+    /**
+     * Generates PHP class names from file paths: it replaces
+     * slashes with underscores, and removes file extensions.
+     * 
+     * @return string[] An array of PHP file names without extension.
+     */
     public function getPHPClassNames() : array
     {
         $this->includeExtensions(array('php'));
@@ -350,13 +350,13 @@ 
         return $path;
     }
     
-   /**
-    * Checks whether the specified extension is allowed 
-    * with the current settings.
-    * 
-    * @param string $extension
-    * @return bool
-    */
+    /**
+     * Checks whether the specified extension is allowed 
+     * with the current settings.
+     * 
+     * @param string $extension
+     * @return bool
+     */
     protected function filterExclusion(string $extension) : bool
     {
         $include = $this->getOption('include-extensions');
@@ -378,12 +378,12 @@ 
         return true;
     }
     
-   /**
-    * Adjusts the path according to the selected path mode.
-    * 
-    * @param string $path
-    * @return string
-    */
+    /**
+     * Adjusts the path according to the selected path mode.
+     * 
+     * @param string $path
+     * @return string
+     */
     protected function filterPath(string $path) : string
     {
         switch($this->getStringOption('pathmode'))

src/FileHelper.php

Indentation +341 added lines, -341 removed lines

@@ -60,31 +60,31 @@ 
     protected static $utfBoms;
 
     /**
-    * 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) : array
     {
         self::requireFileExists($file);
@@ -160,13 +160,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(string $path) : void
     {
         if(is_dir($path) || mkdir($path, 0777, true)) {
@@ -213,22 +213,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(string $sourcePath, string $targetPath) : void
     {
         self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND);
@@ -268,15 +268,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)) {
@@ -298,15 +298,15 @@ 
     }
 
     /**
-    * Creates a new CSV parser instance and returns it.
-    * 
-    * @param string $delimiter
-    * @param string $enclosure
-    * @param string $escape
-    * @param bool $heading
-    * @return Csv
+     * Creates a new CSV parser instance and returns it.
+     * 
+     * @param string $delimiter
+     * @param string $enclosure
+     * @param string $escape
+     * @param bool $heading
+     * @return Csv
      * @see CSVHelper::createParser()
-    */
+     */
     public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : Csv
     {
         if($delimiter==='') { $delimiter = ';'; }
@@ -319,21 +319,21 @@ 
         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
-    * 
-    * @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
+     * 
+     * @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, '\\', $heading);
@@ -521,27 +521,27 @@ 
         );
     }
     
-   /**
-    * 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) : bool
     {
-    	return self::getExtension($pathOrDirIterator) === 'php';
+        return self::getExtension($pathOrDirIterator) === 'php';
     }
     
-   /**
-    * 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) {
@@ -552,38 +552,38 @@ 
          
         $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) : string
     {
         $path = strval($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); 
     }
 
     /**
@@ -624,16 +624,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);
@@ -715,20 +715,20 @@ 
         return self::findFiles($targetFolder, array('php'), $options);
     }
     
-   /**
-    * Finds files according to the specified options.
-    * 
-    * NOTE: This method only exists for backwards compatibility.
-    * Use the `createFileFinder()` method instead, which offers
-    * an object oriented interface that is much easier to use.
-    *  
-    * @param string $targetFolder
-    * @param string[] $extensions
-    * @param array<string,mixed> $options
-    * @throws FileHelper_Exception
-    * @return string[]
-    * @see FileHelper::createFileFinder()
-    */
+    /**
+     * Finds files according to the specified options.
+     * 
+     * NOTE: This method only exists for backwards compatibility.
+     * Use the `createFileFinder()` method instead, which offers
+     * an object oriented interface that is much easier to use.
+     *  
+     * @param string $targetFolder
+     * @param string[] $extensions
+     * @param array<string,mixed> $options
+     * @throws FileHelper_Exception
+     * @return string[]
+     * @see FileHelper::createFileFinder()
+     */
     public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array()) : array
     {
         $finder = self::createFileFinder($targetFolder);
@@ -758,14 +758,14 @@ 
         return $finder->getAll();
     }
 
-   /**
-    * Removes the extension from the specified path or file name,
-    * if any, and returns the name without the extension.
-    * 
-    * @param string $filename
-    * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to.
-    * @return string
-    */
+    /**
+     * Removes the extension from the specified path or file name,
+     * if any, and returns the name without the extension.
+     * 
+     * @param string $filename
+     * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to.
+     * @return string
+     */
     public static function removeExtension(string $filename, bool $keepPath=false) : string
     {
         // normalize paths to allow windows style slashes even on nix servers
@@ -833,13 +833,13 @@ 
         return null;
     }
 
-   /**
-    * Retrieves a list of all UTF byte order mark character
-    * sequences, as an associative array with UTF encoding => bom sequence
-    * pairs.
-    * 
-    * @return array<string,string>
-    */
+    /**
+     * Retrieves a list of all UTF byte order mark character
+     * sequences, as an associative array with UTF encoding => bom sequence
+     * pairs.
+     * 
+     * @return array<string,string>
+     */
     public static function getUTFBOMs() : array
     {
         if(!isset(self::$utfBoms)) {
@@ -855,15 +855,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();
@@ -882,40 +882,40 @@ 
         return in_array($encoding, $keep);
     }
     
-   /**
-    * Retrieves a list of all known unicode file encodings.
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all known unicode file encodings.
+     * @return string[]
+     */
     public static function getKnownUnicodeEncodings() : array
     {
         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);
     }
     
-   /**
-    * Saves the specified data to a file, JSON encoded.
-    * 
-    * @param mixed $data
-    * @param string $file
-    * @param bool $pretty
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_JSON_ENCODE_ERROR
-    * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
-    * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
-    * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
-    */
+    /**
+     * Saves the specified data to a file, JSON encoded.
+     * 
+     * @param mixed $data
+     * @param string $file
+     * @param bool $pretty
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_JSON_ENCODE_ERROR
+     * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
+     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
+     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
+     */
     public static function saveAsJSON($data, string $file, bool $pretty=false) : void
     {
         $options = null;
@@ -939,18 +939,18 @@ 
         self::saveFile($file, $json);
     }
    
-   /**
-    * 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
     {
         $filePath = self::normalizePath($filePath);
@@ -1134,14 +1134,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(string $path) : ?DateTime
     {
         $time = filemtime($path);
@@ -1154,25 +1154,25 @@ 
         return $date;
     }
     
-   /**
-    * 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|DirectoryIterator $targetFolder
-    * @param array $options
-    * @throws FileHelper_Exception
-    * @return string[]
-    *
-    * @see FileHelper::ERROR_FIND_SUBFOLDERS_FOLDER_DOES_NOT_EXIST
-    * @todo Move this to a separate class.
-    */
+    /**
+     * 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|DirectoryIterator $targetFolder
+     * @param array $options
+     * @throws FileHelper_Exception
+     * @return string[]
+     *
+     * @see FileHelper::ERROR_FIND_SUBFOLDERS_FOLDER_DOES_NOT_EXIST
+     * @todo Move this to a separate class.
+     */
     public static function getSubfolders($targetFolder, $options = array())
     {
         if($targetFolder instanceof DirectoryIterator) {
@@ -1237,16 +1237,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;
@@ -1284,16 +1284,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);
@@ -1331,23 +1331,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);
@@ -1359,17 +1359,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, ?int $errorCode=null) : string
     {
         $result = realpath($path);
@@ -1413,18 +1413,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);
@@ -1440,19 +1440,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);
@@ -1482,26 +1482,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.
@@ -1514,18 +1514,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);
@@ -1578,16 +1578,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);
@@ -1608,18 +1608,18 @@ 
         );
     }
 
-   /**
-    * Ensures that the target path exists on disk, and is a folder.
-    * 
-    * @param string $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 $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(string $path) : string
     {
         $actual = realpath($path);

src/VariableInfo.php

Indentation +31 added lines, -31 removed lines

@@ -37,19 +37,19 @@ 
 
     const ERROR_INVALID_SERIALIZED_DATA = 56301;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $string;
     
-   /**
-    * @var mixed
-    */
+    /**
+     * @var mixed
+     */
     protected $value;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type;
 
     /**
@@ -106,15 +106,15 @@ 
         return new VariableInfo(null, $serialized);
     }
     
-   /**
-    * Parses a previously serialized data set to restore the 
-    * variable information from it.
-    * 
-    * @param array $serialized
-    * @throws BaseException
-    * 
-    * @see VariableInfo::ERROR_INVALID_SERIALIZED_DATA
-    */
+    /**
+     * Parses a previously serialized data set to restore the 
+     * variable information from it.
+     * 
+     * @param array $serialized
+     * @throws BaseException
+     * 
+     * @see VariableInfo::ERROR_INVALID_SERIALIZED_DATA
+     */
     protected function parseSerialized(array $serialized) : void
     {
         if(!isset($serialized['string']) || !isset($serialized['type']) || !isset($serialized['options']))
@@ -156,12 +156,12 @@ 
         return $this->value;
     }
     
-   /**
-    * 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;
@@ -175,13 +175,13 @@ 
         );
     }
     
-   /**
-    * Whether to prepend the variable type before the value, 
-    * like the var_dump function. Example: <code>string "Some text"</code>.
-    * 
-    * @param bool $enable
-    * @return VariableInfo
-    */
+    /**
+     * Whether to prepend the variable type before the value, 
+     * like the var_dump function. Example: <code>string "Some text"</code>.
+     * 
+     * @param bool $enable
+     * @return VariableInfo
+     */
     public function enableType(bool $enable=true) : VariableInfo
     {
         return $this->setOption('prepend-type', $enable);

src/Traits/Optionable.php

Indentation +72 added lines, -72 removed lines

@@ -26,9 +26,9 @@ 
  */
 trait Traits_Optionable
 {
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $options;
 
     /**
@@ -49,13 +49,13 @@ 
         return $this;
     }
     
-   /**
-    * Sets a collection of options at once, from an
-    * associative array.
-    * 
-    * @param array<string,mixed> $options
-    * @return $this
-    */
+    /**
+     * Sets a collection of options at once, from an
+     * associative array.
+     * 
+     * @param array<string,mixed> $options
+     * @return $this
+     */
     public function setOptions(array $options)
     {
         foreach($options as $name => $value) {
@@ -65,16 +65,16 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves an option's value.
-    * 
-    * NOTE: Use the specialized type getters to ensure an option
-    * contains the expected type (for ex. getArrayOption()). 
-    * 
-    * @param string $name
-    * @param mixed $default The default value to return if the option does not exist.
-    * @return mixed
-    */
+    /**
+     * Retrieves an option's value.
+     * 
+     * NOTE: Use the specialized type getters to ensure an option
+     * contains the expected type (for ex. getArrayOption()). 
+     * 
+     * @param string $name
+     * @param mixed $default The default value to return if the option does not exist.
+     * @return mixed
+     */
     public function getOption(string $name, $default=null)
     {
         if(!isset($this->options)) {
@@ -88,16 +88,16 @@ 
         return $default;
     }
     
-   /**
-    * Enforces that the option value is a string. Numbers are converted
-    * to string, strings are passed through, and all other types will 
-    * return the default value. The default value is also returned if
-    * the string is empty.
-    * 
-    * @param string $name
-    * @param string $default Used if the option does not exist, is invalid, or empty.
-    * @return string
-    */
+    /**
+     * Enforces that the option value is a string. Numbers are converted
+     * to string, strings are passed through, and all other types will 
+     * return the default value. The default value is also returned if
+     * the string is empty.
+     * 
+     * @param string $name
+     * @param string $default Used if the option does not exist, is invalid, or empty.
+     * @return string
+     */
     public function getStringOption(string $name, string $default='') : string
     {
         $value = $this->getOption($name, false);
@@ -128,15 +128,15 @@ 
         return $default;
     }
     
-   /**
-    * Treats the option value as an integer value: will return
-    * valid integer values (also from integer strings), or the
-    * default value otherwise.
-    * 
-    * @param string $name
-    * @param int $default
-    * @return int
-    */
+    /**
+     * Treats the option value as an integer value: will return
+     * valid integer values (also from integer strings), or the
+     * default value otherwise.
+     * 
+     * @param string $name
+     * @param int $default
+     * @return int
+     */
     public function getIntOption(string $name, int $default=0) : int
     {
         $value = $this->getOption($name);
@@ -147,14 +147,14 @@ 
         return $default;
     }
     
-   /**
-    * Treats an option as an array, and returns its value
-    * only if it contains an array - otherwise, an empty
-    * array is returned.
-    * 
-    * @param string $name
-    * @return array
-    */
+    /**
+     * Treats an option as an array, and returns its value
+     * only if it contains an array - otherwise, an empty
+     * array is returned.
+     * 
+     * @param string $name
+     * @return array
+     */
     public function getArrayOption(string $name) : array
     {
         $val = $this->getOption($name);
@@ -165,13 +165,13 @@ 
         return array();
     }
     
-   /**
-    * Checks whether the specified option exists - even
-    * if it has a NULL value.
-    * 
-    * @param string $name
-    * @return bool
-    */
+    /**
+     * Checks whether the specified option exists - even
+     * if it has a NULL value.
+     * 
+     * @param string $name
+     * @return bool
+     */
     public function hasOption(string $name) : bool
     {
         if(!isset($this->options)) {
@@ -181,11 +181,11 @@ 
         return array_key_exists($name, $this->options);
     }
     
-   /**
-    * Returns all options in one associative array.
-    *
-    * @return array<string,mixed>
-    */
+    /**
+     * Returns all options in one associative array.
+     *
+     * @return array<string,mixed>
+     */
     public function getOptions() : array
     {
         if(!isset($this->options)) {
@@ -195,23 +195,23 @@ 
         return $this->options;
     }
     
-   /**
-    * Checks whether the option's value is the one specified.
-    * 
-    * @param string $name
-    * @param mixed $value
-    * @return bool
-    */
+    /**
+     * Checks whether the option's value is the one specified.
+     * 
+     * @param string $name
+     * @param mixed $value
+     * @return bool
+     */
     public function isOption(string $name, $value) : bool
     {
         return $this->getOption($name) === $value;
     }
     
-   /**
-    * Retrieves the default available options as an
-    * associative array with option name => value pairs.
-    *
-    * @return array<string,mixed>
-    */
+    /**
+     * Retrieves the default available options as an
+     * associative array with option name => value pairs.
+     *
+     * @return array<string,mixed>
+     */
     abstract public function getDefaultOptions() : array;
 }

src/Traits/Classable.php

Indentation +17 added lines, -17 removed lines

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

src/URLInfo.php

Indentation +199 added lines, -199 removed lines

@@ -34,42 +34,42 @@ 
     const TYPE_PHONE = 'phone';
     const TYPE_URL = 'url';
     
-   /**
-    * The original URL that was passed to the constructor.
-    * @var string
-    */
+    /**
+     * The original URL that was passed to the constructor.
+     * @var string
+     */
     protected $rawURL;
 
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $info;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $excludedParams = array();
     
-   /**
-    * @var bool
-    * @see URLInfo::setParamExclusion()
-    */
+    /**
+     * @var bool
+     * @see URLInfo::setParamExclusion()
+     */
     protected $paramExclusion = false;
     
-   /**
-    * @var array
-    * @see URLInfo::getTypeLabel()
-    */
+    /**
+     * @var array
+     * @see URLInfo::getTypeLabel()
+     */
     protected static $typeLabels;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $highlightExcluded = false;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $infoKeys = array(
         'scheme',
         'host',
@@ -81,24 +81,24 @@ 
         'fragment'
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $url;
     
-   /**
-    * @var URLInfo_Parser
-    */
+    /**
+     * @var URLInfo_Parser
+     */
     protected $parser;
     
-   /**
-    * @var URLInfo_Normalizer
-    */
+    /**
+     * @var URLInfo_Normalizer
+     */
     protected $normalizer;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $encodeUTFChars = false;
     
     public function __construct(string $url)
@@ -115,14 +115,14 @@ 
         $this->info = $this->parser->getInfo();
     }
     
-   /**
-    * Whether to URL encode any non-encoded UTF8 characters in the URL.
-    * Default is to leave them as-is for better readability, since 
-    * browsers handle this well.
-    * 
-    * @param bool $enabled
-    * @return URLInfo
-    */
+    /**
+     * Whether to URL encode any non-encoded UTF8 characters in the URL.
+     * Default is to leave them as-is for better readability, since 
+     * browsers handle this well.
+     * 
+     * @param bool $enabled
+     * @return URLInfo
+     */
     public function setUTFEncoding(bool $enabled=true) : URLInfo
     {
         if($this->encodeUTFChars !== $enabled)
@@ -139,13 +139,13 @@ 
         return $this->encodeUTFChars;
     }
     
-   /**
-    * Filters an URL: removes control characters and the
-    * like to have a clean URL to work with.
-    * 
-    * @param string $url
-    * @return string
-    */
+    /**
+     * Filters an URL: removes control characters and the
+     * like to have a clean URL to work with.
+     * 
+     * @param string $url
+     * @return string
+     */
     public static function filterURL(string $url)
     {
         return URLInfo_Filter::filter($url);
@@ -175,12 +175,12 @@ 
         return $this->info['type'] === self::TYPE_PHONE;
     }
     
-   /**
-    * Whether the URL is a regular URL, not one of the 
-    * other types like a phone number or email address.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the URL is a regular URL, not one of the 
+     * other types like a phone number or email address.
+     * 
+     * @return bool
+     */
     public function isURL() : bool
     {
         $host = $this->getHost();
@@ -192,20 +192,20 @@ 
         return $this->parser->isValid();
     }
     
-   /**
-    * Retrieves the host name, or an empty string if none is present.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the host name, or an empty string if none is present.
+     * 
+     * @return string
+     */
     public function getHost() : string
     {
         return $this->getInfoKey('host');
     }
     
-   /**
-    * Retrieves the path, or an empty string if none is present.
-    * @return string
-    */
+    /**
+     * Retrieves the path, or an empty string if none is present.
+     * @return string
+     */
     public function getPath() : string
     {
         return $this->getInfoKey('path');
@@ -221,10 +221,10 @@ 
         return $this->getInfoKey('scheme');
     }
     
-   /**
-    * Retrieves the port specified in the URL, or -1 if none is preseent.
-    * @return int
-    */
+    /**
+     * Retrieves the port specified in the URL, or -1 if none is preseent.
+     * @return int
+     */
     public function getPort() : int
     {
         $port = $this->getInfoKey('port');
@@ -236,13 +236,13 @@ 
         return -1;
     }
     
-   /**
-    * Retrieves the raw query string, or an empty string if none is present.
-    * 
-    * @return string
-    * 
-    * @see URLInfo::getParams()
-    */
+    /**
+     * Retrieves the raw query string, or an empty string if none is present.
+     * 
+     * @return string
+     * 
+     * @see URLInfo::getParams()
+     */
     public function getQuery() : string
     {
         return $this->getInfoKey('query');
@@ -258,20 +258,20 @@ 
         return $this->getInfoKey('pass');
     }
     
-   /**
-    * Whether the URL contains a port number.
-    * @return bool
-    */
+    /**
+     * Whether the URL contains a port number.
+     * @return bool
+     */
     public function hasPort() : bool
     {
         return $this->getPort() !== -1;
     }
     
-   /**
-    * Alias for the hasParams() method.
-    * @return bool
-    * @see URLInfo::hasParams()
-    */
+    /**
+     * Alias for the hasParams() method.
+     * @return bool
+     * @see URLInfo::hasParams()
+     */
     public function hasQuery() : bool
     {
         return $this->hasParams();
@@ -316,23 +316,23 @@ 
         return '';
     }
 
-   /**
-    * Retrieves a normalized URL: this ensures that all parameters
-    * in the URL are always in the same order.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves a normalized URL: this ensures that all parameters
+     * in the URL are always in the same order.
+     * 
+     * @return string
+     */
     public function getNormalized() : string
     {
         return $this->normalize(true);
     }
     
-   /**
-    * Like getNormalized(), but if a username and password are present
-    * in the URL, returns the URL without them.
-    * 
-    * @return string
-    */
+    /**
+     * Like getNormalized(), but if a username and password are present
+     * in the URL, returns the URL without them.
+     * 
+     * @return string
+     */
     public function getNormalizedWithoutAuth() : string
     {
         return $this->normalize(false);
@@ -353,25 +353,25 @@ 
         return $this->normalizer->normalize();
     }
     
-   /**
-    * Creates a hash of the URL, which can be used for comparisons.
-    * Since any parameters in the URL's query are sorted alphabetically,
-    * the same links with a different parameter order will have the 
-    * same hash.
-    * 
-    * @return string
-    */
+    /**
+     * Creates a hash of the URL, which can be used for comparisons.
+     * Since any parameters in the URL's query are sorted alphabetically,
+     * the same links with a different parameter order will have the 
+     * same hash.
+     * 
+     * @return string
+     */
     public function getHash()
     {
         return \AppUtils\ConvertHelper::string2shortHash($this->getNormalized());
     }
 
-   /**
-    * Highlights the URL using HTML tags with specific highlighting
-    * class names.
-    * 
-    * @return string Will return an empty string if the URL is not valid.
-    */
+    /**
+     * Highlights the URL using HTML tags with specific highlighting
+     * class names.
+     * 
+     * @return string Will return an empty string if the URL is not valid.
+     */
     public function getHighlighted() : string
     {
         if(!$this->isValid()) {
@@ -405,15 +405,15 @@ 
         return count($params);
     }
     
-   /**
-    * Retrieves all parameters specified in the url,
-    * if any, as an associative array. 
-    * 
-    * NOTE: Ignores parameters that have been added
-    * to the excluded parameters list.
-    *
-    * @return array
-    */
+    /**
+     * Retrieves all parameters specified in the url,
+     * if any, as an associative array. 
+     * 
+     * NOTE: Ignores parameters that have been added
+     * to the excluded parameters list.
+     *
+     * @return array
+     */
     public function getParams() : array
     {
         if(!$this->paramExclusion || empty($this->excludedParams)) {
@@ -431,22 +431,22 @@ 
         return $keep;
     }
     
-   /**
-    * Retrieves the names of all parameters present in the URL, if any.
-    * @return string[]
-    */
+    /**
+     * Retrieves the names of all parameters present in the URL, if any.
+     * @return string[]
+     */
     public function getParamNames() : array
     {
         $params = $this->getParams();
         return array_keys($params);
     }
     
-   /**
-    * Retrieves a specific parameter value from the URL.
-    * 
-    * @param string $name
-    * @return string The parameter value, or an empty string if it does not exist.
-    */
+    /**
+     * Retrieves a specific parameter value from the URL.
+     * 
+     * @param string $name
+     * @return string The parameter value, or an empty string if it does not exist.
+     */
     public function getParam(string $name) : string
     {
         if(isset($this->info['params'][$name])) {
@@ -456,16 +456,16 @@ 
         return '';
     }
     
-   /**
-    * Excludes an URL parameter entirely if present:
-    * the parser will act as if the parameter was not
-    * even present in the source URL, effectively
-    * stripping it.
-    *
-    * @param string $name
-    * @param string $reason A human readable explanation why this is excluded - used when highlighting links.
-    * @return URLInfo
-    */
+    /**
+     * Excludes an URL parameter entirely if present:
+     * the parser will act as if the parameter was not
+     * even present in the source URL, effectively
+     * stripping it.
+     *
+     * @param string $name
+     * @param string $reason A human readable explanation why this is excluded - used when highlighting links.
+     * @return URLInfo
+     */
     public function excludeParam(string $name, string $reason='') : URLInfo
     {
         if(!isset($this->excludedParams[$name]))
@@ -518,25 +518,25 @@ 
         return self::$typeLabels[$this->getType()];
     }
 
-   /**
-    * Whether excluded parameters should be highlighted in
-    * a different color in the URL when using the
-    * {@link URLInfo::getHighlighted()} method.
-    *
-    * @param bool $highlight
-    * @return URLInfo
-    */
+    /**
+     * Whether excluded parameters should be highlighted in
+     * a different color in the URL when using the
+     * {@link URLInfo::getHighlighted()} method.
+     *
+     * @param bool $highlight
+     * @return URLInfo
+     */
     public function setHighlightExcluded(bool $highlight=true) : URLInfo
     {
         $this->highlightExcluded = $highlight;
         return $this;
     }
     
-   /**
-    * Returns an array with all relevant URL information.
-    * 
-    * @return array
-    */
+    /**
+     * Returns an array with all relevant URL information.
+     * 
+     * @return array
+     */
     public function toArray() : array
     {
         return array(
@@ -580,24 +580,24 @@ 
         return $this;
     }
     
-   /**
-    * Whether the parameter exclusion mode is enabled:
-    * In this case, if any parameters have been added to the
-    * exclusion list, all relevant methods will exclude these.
-    *
-    * @return bool
-    */
+    /**
+     * Whether the parameter exclusion mode is enabled:
+     * In this case, if any parameters have been added to the
+     * exclusion list, all relevant methods will exclude these.
+     *
+     * @return bool
+     */
     public function isParamExclusionEnabled() : bool
     {
         return $this->paramExclusion;
     }
     
-   /**
-    * Checks whether the link contains any parameters that
-    * are on the list of excluded parameters.
-    *
-    * @return bool
-    */
+    /**
+     * Checks whether the link contains any parameters that
+     * are on the list of excluded parameters.
+     *
+     * @return bool
+     */
     public function containsExcludedParams() : bool
     {
         if(empty($this->excludedParams)) {
@@ -665,16 +665,16 @@ 
         return $this->highlightExcluded;
     }
     
-   /**
-    * Checks if the URL exists, i.e. can be connected to. Will return
-    * true if the returned HTTP status code is `200` or `302`.
-    * 
-    * NOTE: If the target URL requires HTTP authentication, the username
-    * and password should be integrated into the URL.
-    * 
-    * @return bool
-    * @throws BaseException
-    */
+    /**
+     * Checks if the URL exists, i.e. can be connected to. Will return
+     * true if the returned HTTP status code is `200` or `302`.
+     * 
+     * NOTE: If the target URL requires HTTP authentication, the username
+     * and password should be integrated into the URL.
+     * 
+     * @return bool
+     * @throws BaseException
+     */
     public function tryConnect(bool $verifySSL=true) : bool
     {
         return $this->createConnectionTester()
@@ -682,26 +682,26 @@ 
         ->canConnect();
     }
     
-   /**
-    * Creates the connection tester instance that is used
-    * to check if a URL can be connected to, and which is
-    * used in the {@see URLInfo::tryConnect()} method. It
-    * allows more settings to be used.
-    * 
-    * @return URLInfo_ConnectionTester
-    */
+    /**
+     * Creates the connection tester instance that is used
+     * to check if a URL can be connected to, and which is
+     * used in the {@see URLInfo::tryConnect()} method. It
+     * allows more settings to be used.
+     * 
+     * @return URLInfo_ConnectionTester
+     */
     public function createConnectionTester() : URLInfo_ConnectionTester
     {
         return new URLInfo_ConnectionTester($this);
     }
     
-   /**
-    * Adds/overwrites an URL parameter.
-    *  
-    * @param string $name
-    * @param string $val
-    * @return URLInfo
-    */
+    /**
+     * Adds/overwrites an URL parameter.
+     *  
+     * @param string $name
+     * @param string $val
+     * @return URLInfo
+     */
     public function setParam(string $name, string $val) : URLInfo
     {
         $this->info['params'][$name] = $val;
@@ -709,13 +709,13 @@ 
         return $this;
     }
     
-   /**
-    * Removes an URL parameter. Has no effect if the 
-    * parameter is not present to begin with.
-    * 
-    * @param string $param
-    * @return URLInfo
-    */
+    /**
+     * Removes an URL parameter. Has no effect if the 
+     * parameter is not present to begin with.
+     * 
+     * @param string $param
+     * @return URLInfo
+     */
     public function removeParam(string $param) : URLInfo
     {
         if(isset($this->info['params'][$param]))