Mistralys / application-utils

src/ConvertHelper/DurationConverter.php

Indentation +47 added lines, -47 removed lines

@@ -34,39 +34,39 @@ 
     const SECONDS_PER_MONTH_APPROX = 2505600; // imprecise - for 29 days, only for approximations. 
     const SECONDS_PER_YEAR = 31536000;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $dateFrom;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $dateTo;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $future = false;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $interval = '';
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $difference = 0;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $dateDiff = 0;
     
-   /**
-    * @var array<string,array<string,string>>|NULL
-    */
+    /**
+     * @var array<string,array<string,string>>|NULL
+     */
     protected static $texts = null;
     
     public function __construct()
@@ -86,17 +86,17 @@ 
         self::$texts = null;
     }
     
-   /**
-    * Sets the origin date to calculate from.
-    * 
-    * NOTE: if this is further in the future than
-    * the to: date, it will be considered as a 
-    * calculation for something to come, i.e. 
-    * "In two days".
-    *  
-    * @param DateTime $date
-    * @return ConvertHelper_DurationConverter
-    */
+    /**
+     * Sets the origin date to calculate from.
+     * 
+     * NOTE: if this is further in the future than
+     * the to: date, it will be considered as a 
+     * calculation for something to come, i.e. 
+     * "In two days".
+     *  
+     * @param DateTime $date
+     * @return ConvertHelper_DurationConverter
+     */
     public function setDateFrom(DateTime $date) : ConvertHelper_DurationConverter
     {
         $this->dateFrom = ConvertHelper::date2timestamp($date);
@@ -104,13 +104,13 @@ 
         return $this;
     }
     
-   /**
-    * Sets the date to calculate to. Defaults to 
-    * the current time if not set.
-    * 
-    * @param DateTime $date
-    * @return ConvertHelper_DurationConverter
-    */
+    /**
+     * Sets the date to calculate to. Defaults to 
+     * the current time if not set.
+     * 
+     * @param DateTime $date
+     * @return ConvertHelper_DurationConverter
+     */
     public function setDateTo(DateTime $date) : ConvertHelper_DurationConverter
     {
         $this->dateTo = ConvertHelper::date2timestamp($date);
@@ -118,14 +118,14 @@ 
         return $this;
     }
     
-   /**
-    * Converts the specified dates to a human-readable string.
-    * 
-    * @throws ConvertHelper_Exception
-    * @return string
-    * 
-    * @see ConvertHelper_DurationConverter::ERROR_NO_DATE_FROM_SET
-    */
+    /**
+     * Converts the specified dates to a human-readable string.
+     * 
+     * @throws ConvertHelper_Exception
+     * @return string
+     * 
+     * @see ConvertHelper_DurationConverter::ERROR_NO_DATE_FROM_SET
+     */
     public function convert() : string
     {
         $this->initTexts();

src/ConvertHelper/ThrowableInfo/Call.php

Indentation +56 added lines, -56 removed lines

@@ -10,45 +10,45 @@ 
     const TYPE_METHOD_CALL = 'method';
     const TYPE_SCRIPT_START = 'start';
     
-   /**
-    * @var ConvertHelper_ThrowableInfo
-    */
+    /**
+     * @var ConvertHelper_ThrowableInfo
+     */
     protected $info;
     
-   /**
-    * @var VariableInfo[]
-    */
+    /**
+     * @var VariableInfo[]
+     */
     protected $args = array();
     
-   /**
-    * The source file, if any
-    * @var string
-    */
+    /**
+     * The source file, if any
+     * @var string
+     */
     protected $file = '';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $class = '';
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $line = 0;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $position = 1;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $function = '';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type = self::TYPE_SCRIPT_START;
 
     /**
@@ -79,10 +79,10 @@ 
         }
     }
     
-   /**
-    * 1-based position of the call in the calls list.
-    * @return int
-    */
+    /**
+     * 1-based position of the call in the calls list.
+     * @return int
+     */
     public function getPosition() : int
     {
         return $this->position;
@@ -93,18 +93,18 @@ 
         return $this->line;
     }
     
-   /**
-    * Whether the call had any arguments.
-    * @return bool
-    */
+    /**
+     * Whether the call had any arguments.
+     * @return bool
+     */
     public function hasArguments() : bool
     {
         return !empty($this->args);
     }
     
-   /**
-    * @return VariableInfo[]
-    */
+    /**
+     * @return VariableInfo[]
+     */
     public function getArguments()
     {
         return $this->args;
@@ -244,31 +244,31 @@ 
         return implode(', ', $tokens); 
     }
     
-   /**
-    * Retrieves the type of call: typically a function
-    * call, or a method call of an object. Note that the
-    * first call in a script does not have either.
-    * 
-    * @return string
-    * 
-    * @see ConvertHelper_ThrowableInfo_Call::TYPE_FUNCTION_CALL
-    * @see ConvertHelper_ThrowableInfo_Call::TYPE_METHOD_CALL
-    * @see ConvertHelper_ThrowableInfo_Call::TYPE_SCRIPT_START
-    * @see ConvertHelper_ThrowableInfo_Call::hasFunction()
-    * @see ConvertHelper_ThrowableInfo_Call::hasClass()
-    */
+    /**
+     * Retrieves the type of call: typically a function
+     * call, or a method call of an object. Note that the
+     * first call in a script does not have either.
+     * 
+     * @return string
+     * 
+     * @see ConvertHelper_ThrowableInfo_Call::TYPE_FUNCTION_CALL
+     * @see ConvertHelper_ThrowableInfo_Call::TYPE_METHOD_CALL
+     * @see ConvertHelper_ThrowableInfo_Call::TYPE_SCRIPT_START
+     * @see ConvertHelper_ThrowableInfo_Call::hasFunction()
+     * @see ConvertHelper_ThrowableInfo_Call::hasClass()
+     */
     public function getType() : string
     {
         return $this->type;
     }
      
-   /**
-    * Serializes the call to an array, with all
-    * necessary information. Can be used to restore
-    * the call later using {@link ConvertHelper_ThrowableInfo_Call::fromSerialized()}.
-    * 
-    * @return array<string,mixed>
-    */
+    /**
+     * Serializes the call to an array, with all
+     * necessary information. Can be used to restore
+     * the call later using {@link ConvertHelper_ThrowableInfo_Call::fromSerialized()}.
+     * 
+     * @return array<string,mixed>
+     */
     public function serialize() : array
     {
         $result = array(

src/ConvertHelper/QueryParser.php

Indentation +10 added lines, -10 removed lines

@@ -27,16 +27,16 @@
         
     }
     
-   /**
-    * We parse the query string ourselves, because the PHP implementation
-    * of parse_str has limitations that do not apply to query strings. This
-    * is due to the fact that parse_str has to create PHP-compatible variable
-    * names from the parameters. URL parameters simply allow way more things
-    * than PHP variable names.
-    * 
-    * @param string $queryString
-    * @return array<string,string>
-    */
+    /**
+     * We parse the query string ourselves, because the PHP implementation
+     * of parse_str has limitations that do not apply to query strings. This
+     * is due to the fact that parse_str has to create PHP-compatible variable
+     * names from the parameters. URL parameters simply allow way more things
+     * than PHP variable names.
+     * 
+     * @param string $queryString
+     * @return array<string,string>
+     */
     public function parse(string $queryString) : array
     {
         // allow HTML entities notation

src/FileHelper.php

Indentation +329 added lines, -329 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<int|string,mixed>
-    * @deprecated Use parseSerializedFile() instead.
-    * @see FileHelper::parseSerializedFile()
-    */
+     * Opens a serialized file and returns the unserialized data.
+     * 
+     * @param string $file
+     * @throws FileHelper_Exception
+     * @return array<int|string,mixed>
+     * @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<int|string,mixed>
-    * @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<int|string,mixed>
+     * @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<int,array<string,string>>
-    * @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<int,array<string,string>>
+     * @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 sub-folders in the specified path.
-    * 
-    * Available options:
-    * 
-    * - recursive: true/false
-    *   Whether to search for sub-folders recursively.
-    *   
-    * - absolute-paths: true/false
-    *   Whether to return a list of absolute paths.
-    * 
-    * @param string|DirectoryIterator $targetFolder
-    * @param array<string,mixed> $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 sub-folders in the specified path.
+     * 
+     * Available options:
+     * 
+     * - recursive: true/false
+     *   Whether to search for sub-folders recursively.
+     *   
+     * - absolute-paths: true/false
+     *   Whether to return a list of absolute paths.
+     * 
+     * @param string|DirectoryIterator $targetFolder
+     * @param array<string,mixed> $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, array $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.
@@ -1579,16 +1579,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);
@@ -1609,18 +1609,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/RequestHelper/Exception.php

Indentation +8 added lines, -8 removed lines

@@ -22,9 +22,9 @@ 
  */
 class RequestHelper_Exception extends BaseException
 {
-   /**
-    * @var RequestHelper_Response|NULL
-    */
+    /**
+     * @var RequestHelper_Response|NULL
+     */
     protected $response = null;
 
     /**
@@ -37,11 +37,11 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves the related response instance, if available.
-    * 
-    * @return RequestHelper_Response|NULL
-    */
+    /**
+     * Retrieves the related response instance, if available.
+     * 
+     * @return RequestHelper_Response|NULL
+     */
     public function getResponse() : ?RequestHelper_Response
     {
         return $this->response;

src/NumberInfo.php

Indentation +77 added lines, -77 removed lines

@@ -40,19 +40,19 @@ 
  */
 class NumberInfo
 {
-   /**
-    * @var string|int|float|null
-    */
+    /**
+     * @var string|int|float|null
+     */
     protected $rawValue;
     
-   /**
-    * @var array<string,mixed>
-    */
+    /**
+     * @var array<string,mixed>
+     */
     protected $info;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $empty = false;
 
     /**
@@ -62,8 +62,8 @@ 
 
     /**
      * Units and whether they allow decimal values.
-    * @var array<string,bool>
-    */
+     * @var array<string,bool>
+     */
     protected $knownUnits = array(
         '%' => true,
         'rem' => true,
@@ -141,21 +141,21 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves the raw, internal information array resulting
-    * from the parsing of the number.
-    *  
-    * @return array<string,mixed>
-    */
+    /**
+     * Retrieves the raw, internal information array resulting
+     * from the parsing of the number.
+     *  
+     * @return array<string,mixed>
+     */
     public function getRawInfo() : array
     {
         return $this->info;
     }
     
-   /**
-    * Whether the number was empty (null or empty string).
-    * @return boolean
-    */
+    /**
+     * Whether the number was empty (null or empty string).
+     * @return boolean
+     */
     public function isEmpty() : bool
     {
         return $this->empty;
@@ -729,12 +729,12 @@ 
         return $cache[$key];
     }
     
-   /**
-    * Parses a string number notation with units included, e.g. 14px, 50%...
-    * 
-    * @param string $test
-    * @return array<string,mixed>
-    */
+    /**
+     * Parses a string number notation with units included, e.g. 14px, 50%...
+     * 
+     * @param string $test
+     * @return array<string,mixed>
+     */
     private function parseStringValue(string $test) : array
     {
         $number = null;
@@ -785,13 +785,13 @@ 
         return $this->filterInfo($result);
     }
     
-   /**
-    * Attempts to determine what kind of units are specified
-    * in the string. Returns NULL if none could be matched.
-    * 
-    * @param string $value
-    * @return array<string,mixed>|NULL
-    */
+    /**
+     * Attempts to determine what kind of units are specified
+     * in the string. Returns NULL if none could be matched.
+     * 
+     * @param string $value
+     * @return array<string,mixed>|NULL
+     */
     private function findUnits(string $value) : ?array
     {
         $vlength = strlen($value);
@@ -819,12 +819,12 @@ 
         return null;
     }
     
-   /**
-    * Creates the cache key for the specified value.
-    * 
-    * @param mixed $value
-    * @return string
-    */
+    /**
+     * Creates the cache key for the specified value.
+     * 
+     * @param mixed $value
+     * @return string
+     */
     private function createValueKey($value) : string
     {
         if(!is_string($value) && !is_numeric($value))
@@ -835,59 +835,59 @@ 
         return (string)$value;
     }
 
-   /**
-    * Called if explicitly enabled: allows filtering the 
-    * number after the detection process has completed.
-    * 
-    * @param string|NULL $number The adjusted number
-    * @param string $originalString The original value before it was parsed
-    * @return string|null
-    */
+    /**
+     * Called if explicitly enabled: allows filtering the 
+     * number after the detection process has completed.
+     * 
+     * @param string|NULL $number The adjusted number
+     * @param string $originalString The original value before it was parsed
+     * @return string|null
+     */
     protected function postProcess(?string $number, /** @scrutinizer ignore-unused */ string $originalString)
     {
         return $number;
     }
     
-   /**
-    * Filters the value before it is parsed, but only if it is a string.
-    * 
-    * NOTE: This may be overwritten in a subclass, to allow custom filtering
-    * the values. An example of a use case would be a preprocessor for
-    * variables in a templating system.
-    * 
-    * @param string $trimmedString The trimmed value.
-    * @param array<string,mixed> $cache The internal values cache array.
-    * @param string $originalValue The original value that the NumberInfo was created for.
-    * @return string
-    * 
-    * @see NumberInfo::enablePostProcess()
-    */
+    /**
+     * Filters the value before it is parsed, but only if it is a string.
+     * 
+     * NOTE: This may be overwritten in a subclass, to allow custom filtering
+     * the values. An example of a use case would be a preprocessor for
+     * variables in a templating system.
+     * 
+     * @param string $trimmedString The trimmed value.
+     * @param array<string,mixed> $cache The internal values cache array.
+     * @param string $originalValue The original value that the NumberInfo was created for.
+     * @return string
+     * 
+     * @see NumberInfo::enablePostProcess()
+     */
     protected function preProcess(string $trimmedString, /** @scrutinizer ignore-unused */ array &$cache, /** @scrutinizer ignore-unused */ string $originalValue) : string
     {
         return str_replace(',', '.', $trimmedString);
     }
     
-   /**
-    * Enables the post-processing so the postProcess method gets called.
-    * This should be called in the {@link NumberInfo::preProcess()}
-    * method as needed.
-    * 
-    * @return $this
-    * @see NumberInfo::postProcess()
-    */
+    /**
+     * Enables the post-processing so the postProcess method gets called.
+     * This should be called in the {@link NumberInfo::preProcess()}
+     * method as needed.
+     * 
+     * @return $this
+     * @see NumberInfo::postProcess()
+     */
     protected function enablePostProcess() : NumberInfo
     {
         $this->postProcess = true;
         return $this;
     }
     
-   /**
-    * Filters the number info array to adjust the units
-    * and number according to the required rules.
-    * 
-    * @param array<string,mixed> $info
-    * @return array<string,mixed>
-    */
+    /**
+     * Filters the number info array to adjust the units
+     * and number according to the required rules.
+     * 
+     * @param array<string,mixed> $info
+     * @return array<string,mixed>
+     */
     protected function filterInfo(array $info) : array
     {
         $useUnits = 'px';

src/FileHelper/FileFinder.php

Indentation +136 added lines, -136 removed lines

@@ -37,23 +37,23 @@ 
     const OPTION_PATHMODE = 'pathmode';
 
     /**
-    * @var string
-    */
+     * @var string
+     */
     protected $path;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     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);
@@ -85,66 +85,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(self::OPTION_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 string[] $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 string[] $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();
@@ -155,37 +155,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(self::OPTION_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 string[] $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 string[] $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();
@@ -196,52 +196,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);
@@ -264,12 +264,12 @@ 
         return $this->setOption(self::OPTION_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);
@@ -277,24 +277,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'));
@@ -365,13 +365,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(self::OPTION_INCLUDE_EXTENSIONS);
@@ -393,12 +393,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(self::OPTION_PATHMODE))

src/FileHelper/PHPClassInfo/Class.php

Indentation +70 added lines, -70 removed lines

@@ -22,51 +22,51 @@ 
  */
 class FileHelper_PHPClassInfo_Class 
 {
-   /**
-    * @var FileHelper_PHPClassInfo
-    */
+    /**
+     * @var FileHelper_PHPClassInfo
+     */
     protected $info;
 
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $abstract = false;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $final = false;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $extends = '';
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $implements = array();
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $name;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $declaration;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $keyword;
     
-   /**
-    * @param FileHelper_PHPClassInfo $info The class info instance.
-    * @param string $declaration The full class declaration, e.g. "class SomeName extends SomeOtherClass".
-    * @param string $keyword The class keyword, if any, i.e. "abstract" or "final".
-    */
+    /**
+     * @param FileHelper_PHPClassInfo $info The class info instance.
+     * @param string $declaration The full class declaration, e.g. "class SomeName extends SomeOtherClass".
+     * @param string $keyword The class keyword, if any, i.e. "abstract" or "final".
+     */
     public function __construct(FileHelper_PHPClassInfo $info, string $declaration, string $keyword)
     {
         $this->info = $info;
@@ -76,31 +76,31 @@ 
         $this->analyzeCode();
     }
     
-   /**
-    * Check if this class is a subclass of the specified
-    * class name.
-    * 
-    * @param string $className
-    * @return bool
-    */
+    /**
+     * Check if this class is a subclass of the specified
+     * class name.
+     * 
+     * @param string $className
+     * @return bool
+     */
     public function isSublassOf(string $className) : bool
     {
         return is_subclass_of($this->getNameNS(), $className);
     }
     
-   /**
-    * The class name without namespace.
-    * @return string
-    */
+    /**
+     * The class name without namespace.
+     * @return string
+     */
     public function getName() : string
     {
         return $this->name;
     }
     
-   /**
-    * The absolute class name with namespace (if any).
-    * @return string
-    */
+    /**
+     * The absolute class name with namespace (if any).
+     * @return string
+     */
     public function getNameNS() : string
     {
         $name = $this->getName();
@@ -112,48 +112,48 @@ 
         return $name;
     }
     
-   /**
-    * Whether it is an abstract class.
-    * @return bool
-    */
+    /**
+     * Whether it is an abstract class.
+     * @return bool
+     */
     public function isAbstract() : bool
     {
         return $this->abstract;
     }
     
-   /**
-    * Whether it is a final class.
-    * @return bool
-    */
+    /**
+     * Whether it is a final class.
+     * @return bool
+     */
     public function isFinal() : bool
     {
         return $this->final;
     }
 
-   /**
-    * The name of the class that this class extends (with namespace, if specified).
-    * @return string
-    */
+    /**
+     * The name of the class that this class extends (with namespace, if specified).
+     * @return string
+     */
     public function getExtends() : string
     {
         return $this->extends;
     }
     
-   /**
-    * A list of interfaces the class implements, if any.
-    * @return string[]
-    */
+    /**
+     * A list of interfaces the class implements, if any.
+     * @return string[]
+     */
     public function getImplements() : array
     {
         return $this->implements;
     }
     
-   /**
-    * The class declaration string, with normalized spaces and sorted interface names.
-    * NOTE: does not include the keyword "abstract" or "final".
-    * 
-    * @return string
-    */
+    /**
+     * The class declaration string, with normalized spaces and sorted interface names.
+     * NOTE: does not include the keyword "abstract" or "final".
+     * 
+     * @return string
+     */
     public function getDeclaration() : string
     {
         $parts = array();
@@ -173,10 +173,10 @@ 
         return implode(' ', $parts);
     }
     
-   /**
-    * The keyword before "class", e.g. "abstract".
-    * @return string
-    */
+    /**
+     * The keyword before "class", e.g. "abstract".
+     * @return string
+     */
     public function getKeyword() : string
     {
         return $this->keyword;

src/FileHelper/PHPClassInfo.php

Indentation +46 added lines, -46 removed lines

@@ -40,17 +40,17 @@ 
      */
     protected $classes = array();
     
-   /**
-    * The namespace detected in the file, if any.
-    * @var string
-    */
+    /**
+     * The namespace detected in the file, if any.
+     * @var string
+     */
     protected $namespace = '';
     
-   /**
-    * @param string $path The path to the PHP file to parse.
-    * @throws FileHelper_Exception
-    * @see FileHelper::findPHPClasses()
-    */
+    /**
+     * @param string $path The path to the PHP file to parse.
+     * @throws FileHelper_Exception
+     * @see FileHelper::findPHPClasses()
+     */
     public function __construct(string $path)
     {
         $this->path = realpath($path);
@@ -70,66 +70,66 @@ 
         $this->parseFile();
     }
     
-   /**
-    * The name of the namespace of the classes in the file, if any.
-    * @return string
-    */
+    /**
+     * The name of the namespace of the classes in the file, if any.
+     * @return string
+     */
     public function getNamespace() : string
     {
         return $this->namespace;
     }
     
-   /**
-    * Whether the file contains a namespace.
-    * @return bool
-    */
+    /**
+     * Whether the file contains a namespace.
+     * @return bool
+     */
     public function hasNamespace() : bool
     {
         return !empty($this->namespace);
     }
     
-   /**
-    * The absolute path to the file.
-    * @return string
-    */
+    /**
+     * The absolute path to the file.
+     * @return string
+     */
     public function getPath() : string
     {
         return $this->path;
     }
    
-   /**
-    * Whether any classes were found in the file.
-    * @return bool
-    */
+    /**
+     * Whether any classes were found in the file.
+     * @return bool
+     */
     public function hasClasses() : bool
     {
         return !empty($this->classes);
     }
     
-   /**
-    * The names of the classes that were found in the file (with namespace if any).
-    * @return string[]
-    */
+    /**
+     * The names of the classes that were found in the file (with namespace if any).
+     * @return string[]
+     */
     public function getClassNames() : array
     {
         return array_keys($this->classes);
     }
     
-   /**
-    * Retrieves all classes that were detected in the file,
-    * which can be used to retrieve more information about
-    * them.
-    * 
-    * @return FileHelper_PHPClassInfo_Class[]
-    */
+    /**
+     * Retrieves all classes that were detected in the file,
+     * which can be used to retrieve more information about
+     * them.
+     * 
+     * @return FileHelper_PHPClassInfo_Class[]
+     */
     public function getClasses() : array
     {
         return array_values($this->classes);
     }
     
-   /**
-    * @throws FileHelper_Exception
-    */
+    /**
+     * @throws FileHelper_Exception
+     */
     protected function parseFile() : void
     {
         $code = file_get_contents($this->path);
@@ -184,13 +184,13 @@ 
         }
     }
     
-   /**
-    * Strips all whitespace from the string, replacing it with 
-    * regular spaces (newlines, tabs, etc.).
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Strips all whitespace from the string, replacing it with 
+     * regular spaces (newlines, tabs, etc.).
+     * 
+     * @param string $string
+     * @return string
+     */
     protected function stripWhitespace(string $string) : string 
     {
         return preg_replace('/[\s]/', ' ', $string);