Mistralys / application-utils

src/ConvertHelper/DateInterval.php

Indentation +43 added lines, -43 removed lines

@@ -37,14 +37,14 @@ 
     const TOKEN_MONTHS = 'm';
     const TOKEN_YEARS = 'y';
     
-   /**
-    * @var \DateInterval
-    */
+    /**
+     * @var \DateInterval
+     */
     protected $interval;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $seconds;
     
     protected function __construct(int $seconds)
@@ -69,33 +69,33 @@ 
         $this->interval = $interval;
     }
     
-   /**
-    * Creates the interval from a specific amount of seconds.
-    * 
-    * @param int $seconds
-    * @return \AppUtils\ConvertHelper_DateInterval
-    */
+    /**
+     * Creates the interval from a specific amount of seconds.
+     * 
+     * @param int $seconds
+     * @return \AppUtils\ConvertHelper_DateInterval
+     */
     public static function fromSeconds(int $seconds)
     {
         return new ConvertHelper_DateInterval($seconds);
     }
     
-   /**
-    * Creates the interval from an existing regular interval instance.
-    * 
-    * @param \DateInterval $interval
-    * @return \AppUtils\ConvertHelper_DateInterval
-    */
+    /**
+     * Creates the interval from an existing regular interval instance.
+     * 
+     * @param \DateInterval $interval
+     * @return \AppUtils\ConvertHelper_DateInterval
+     */
     public static function fromInterval(\DateInterval $interval)
     {
         return self::fromSeconds(ConvertHelper::interval2seconds($interval));
     }
     
-   /**
-    * Retrieves the PHP native date interval.
-    * 
-    * @return \DateInterval
-    */
+    /**
+     * Retrieves the PHP native date interval.
+     * 
+     * @return \DateInterval
+     */
     public function getInterval() : \DateInterval
     {
         return $this->interval;
@@ -131,31 +131,31 @@ 
         return $this->getToken(self::TOKEN_YEARS);
     }
     
-   /**
-    * Retrieves a specific time token, e.g. "h" (for hours).
-    * Using the constants to specifiy the tokens is recommended.
-    * 
-    * @param string $token
-    * @return int
-    * 
-    * @see ConvertHelper_DateInterval::TOKEN_SECONDS
-    * @see ConvertHelper_DateInterval::TOKEN_MINUTES
-    * @see ConvertHelper_DateInterval::TOKEN_HOURS
-    * @see ConvertHelper_DateInterval::TOKEN_DAYS
-    * @see ConvertHelper_DateInterval::TOKEN_MONTHS
-    * @see ConvertHelper_DateInterval::TOKEN_YEARS
-    */
+    /**
+     * Retrieves a specific time token, e.g. "h" (for hours).
+     * Using the constants to specifiy the tokens is recommended.
+     * 
+     * @param string $token
+     * @return int
+     * 
+     * @see ConvertHelper_DateInterval::TOKEN_SECONDS
+     * @see ConvertHelper_DateInterval::TOKEN_MINUTES
+     * @see ConvertHelper_DateInterval::TOKEN_HOURS
+     * @see ConvertHelper_DateInterval::TOKEN_DAYS
+     * @see ConvertHelper_DateInterval::TOKEN_MONTHS
+     * @see ConvertHelper_DateInterval::TOKEN_YEARS
+     */
     public function getToken(string $token) : int
     {
         return (int)$this->interval->$token;
     }
     
-   /**
-    * The total amount of seconds in the interval (including
-    * everything, from seconds to days, months, years...).
-    * 
-    * @return int
-    */
+    /**
+     * The total amount of seconds in the interval (including
+     * everything, from seconds to days, months, years...).
+     * 
+     * @return int
+     */
     public function getTotalSeconds() : int
     {
         return $this->seconds;

src/SVNHelper.php

Indentation +167 added lines, -167 removed lines

@@ -23,101 +23,101 @@ 
  */
 class SVNHelper
 {
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     const ERROR_LOCAL_PATH_DOES_NOT_EXIST = 22401;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     const ERROR_INVALID_REP_URL = 22402;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     const ERROR_PATH_IS_OUTSIDE_REPOSITORY = 22403;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     const ERROR_TARGET_FOLDER_IS_A_FILE = 22404;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     const ERROR_CANNOT_ADD_INEXISTENT_FILE = 22405;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     const ERROR_TARGET_PATH_NOT_FOUND = 22406;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     const ERROR_INVALID_TARGET_TYPE = 22407;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     const ERROR_INVALID_LOG_CALLBACK = 22408; 
     
-   /**
-    * @var SVNHelper_Target_Folder
-    */
+    /**
+     * @var SVNHelper_Target_Folder
+     */
     protected $target;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $path;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $url;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $user;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $pass;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $options = array(
         'binaries-path' => ''
     );
     
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     protected $isWindows = false;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $normalize = array(
         'from' => '\\',
         'to' => '/'
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $sourcePath;
     
-   /**
-    * @param string $repPath The path to the repository
-    * @param string $repURL The SVN URL to the repository
-    * @throws SVNHelper_Exception
-    */
+    /**
+     * @param string $repPath The path to the repository
+     * @param string $repURL The SVN URL to the repository
+     * @throws SVNHelper_Exception
+     */
     public function __construct(string $repPath, string $repURL)
     {
         $this->isWindows = substr(PHP_OS, 0, 3) == 'WIN';
@@ -178,16 +178,16 @@ 
         return $this->pass;
     }
     
-   /**
-    * Normalizes slashes in the path according to the
-    * operating system, i.e. forward slashes for NIX-systems
-    * and backward slashes for Windows.
-    *
-    * @param string $path An absolute path to normalize
-    * @param bool $relativize Whether to return a path relative to the repository
-    * @throws SVNHelper_Exception
-    * @return string
-    */
+    /**
+     * Normalizes slashes in the path according to the
+     * operating system, i.e. forward slashes for NIX-systems
+     * and backward slashes for Windows.
+     *
+     * @param string $path An absolute path to normalize
+     * @param bool $relativize Whether to return a path relative to the repository
+     * @throws SVNHelper_Exception
+     * @return string
+     */
     public function normalizePath($path, $relativize=false)
     {
         if(empty($path)) {
@@ -222,32 +222,32 @@ 
         );
     }
     
-   /**
-    * Retrieves the path slash style according to the
-    * current operating system.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the path slash style according to the
+     * current operating system.
+     * 
+     * @return string
+     */
     public function getSlash()
     {
         return $this->normalize['to'];
     }
     
-   /**
-    * Keeps instances of files.
-    * @var SVNHelper_Target[]
-    */
+    /**
+     * Keeps instances of files.
+     * @var SVNHelper_Target[]
+     */
     protected $targets = array();
     
-   /**
-    * Retrieves a file instance from the SVN repository:
-    * this allows all possible operations on the file as
-    * well as accessing more information on it.
-    * 
-    * @param string $path A path to the file, relative to the repository path or absolute.
-    * @return SVNHelper_Target_File
-    * @throws SVNHelper_Exception
-    */
+    /**
+     * Retrieves a file instance from the SVN repository:
+     * this allows all possible operations on the file as
+     * well as accessing more information on it.
+     * 
+     * @param string $path A path to the file, relative to the repository path or absolute.
+     * @return SVNHelper_Target_File
+     * @throws SVNHelper_Exception
+     */
     public function getFile($path)
     {
         $path = $this->filterPath($path);
@@ -255,15 +255,15 @@ 
         return $this->getTarget('File', $this->relativizePath($path));
     }
 
-   /**
-    * Retrieves a folder instance from the SVN repository:
-    * This allows all possible operations on the folder as
-    * well as accessing more information on it.
-    * 
-    * @param string $path
-    * @return SVNHelper_Target_Folder
-    * @throws SVNHelper_Exception
-    */
+    /**
+     * Retrieves a folder instance from the SVN repository:
+     * This allows all possible operations on the folder as
+     * well as accessing more information on it.
+     * 
+     * @param string $path
+     * @return SVNHelper_Target_Folder
+     * @throws SVNHelper_Exception
+     */
     public function getFolder($path)
     {
         $path = $this->filterPath($path);
@@ -271,13 +271,13 @@ 
         return $this->getTarget('Folder', $this->relativizePath($path));
     }
     
-   /**
-    * Passes the path through realpath and ensures it exists.
-    *
-    * @param string $path
-    * @throws SVNHelper_Exception
-    * @return string
-    */
+    /**
+     * Passes the path through realpath and ensures it exists.
+     *
+     * @param string $path
+     * @throws SVNHelper_Exception
+     * @return string
+     */
     protected function filterPath($path)
     {
         if(empty($path)) {
@@ -302,13 +302,13 @@ 
         );
     }
     
-   /**
-    * Retrieves a target file or folder within the repository.
-    *
-    * @param string $type The target type, "File" or "Folder".
-    * @param string $relativePath A path relative to the root folder.
-    * @return SVNHelper_Target
-    */
+    /**
+     * Retrieves a target file or folder within the repository.
+     *
+     * @param string $type The target type, "File" or "Folder".
+     * @param string $relativePath A path relative to the root folder.
+     * @return SVNHelper_Target
+     */
     protected function getTarget($type, $relativePath)
     {
         $key = $type.':'.$relativePath;
@@ -356,33 +356,33 @@ 
         return $this->url;
     }
     
-   /**
-    * Updates the whole SVN repository from the root folder.
-    * @return SVNHelper_CommandResult
-    */
+    /**
+     * Updates the whole SVN repository from the root folder.
+     * @return SVNHelper_CommandResult
+     */
     public function runUpdate()
     {
         return $this->createUpdate($this->target)->execute();
     }
     
-   /**
-    * Creates an update command for the target file or folder.
-    * This can be configured further before it is executed.
-    * 
-    * @param SVNHelper_Target $target
-    * @return SVNHelper_Command_Update
-    */
+    /**
+     * Creates an update command for the target file or folder.
+     * This can be configured further before it is executed.
+     * 
+     * @param SVNHelper_Target $target
+     * @return SVNHelper_Command_Update
+     */
     public function createUpdate(SVNHelper_Target $target)
     {
         return $this->createCommand('Update', $target);
     }
     
-   /**
-    * Creates an add command for the targt file or folder.
-    * 
-    * @param SVNHelper_Target $target
-    * @return SVNHelper_Command_Add
-    */
+    /**
+     * Creates an add command for the targt file or folder.
+     * 
+     * @param SVNHelper_Target $target
+     * @return SVNHelper_Command_Add
+     */
     public function createAdd(SVNHelper_Target $target)
     {
         return $this->createCommand('Add', $target);
@@ -399,12 +399,12 @@ 
         return $this->createCommand('Info', $target);
     }
     
-   /**
-    * Creates a status command for the target file or folder.
-    * 
-    * @param SVNHelper_Target $target
-    * @return SVNHelper_Command_Status
-    */
+    /**
+     * Creates a status command for the target file or folder.
+     * 
+     * @param SVNHelper_Target $target
+     * @return SVNHelper_Command_Status
+     */
     public function createStatus(SVNHelper_Target $target)
     {
         return $this->createCommand('Status', $target);
@@ -429,28 +429,28 @@ 
         return $cmd;
     }
     
-   /**
-    * Creates a path relative to the repository for the target
-    * file or folder, from an absolute path.
-    *
-    * @param string $path An absolute path.
-    * @return string
-    */
+    /**
+     * Creates a path relative to the repository for the target
+     * file or folder, from an absolute path.
+     *
+     * @param string $path An absolute path.
+     * @return string
+     */
     public function relativizePath($path)
     {
         return $this->normalizePath($path, true);
     }
     
-   /**
-    * Adds a folder: creates it as necessary (recursive),
-    * and adds it to be committed if it is not versioned yet.
-    * Use this instead of {@link getFolder()} when you are
-    * not sure that it exists yet, and will need it.
-    * 
-    * @param string $path Absolute or relative path to the folder
-    * @throws SVNHelper_Exception
-    * @return SVNHelper_Target_Folder
-    */
+    /**
+     * Adds a folder: creates it as necessary (recursive),
+     * and adds it to be committed if it is not versioned yet.
+     * Use this instead of {@link getFolder()} when you are
+     * not sure that it exists yet, and will need it.
+     * 
+     * @param string $path Absolute or relative path to the folder
+     * @throws SVNHelper_Exception
+     * @return SVNHelper_Target_Folder
+     */
     public function addFolder($path)
     {
         if(is_dir($path)) {
@@ -500,14 +500,14 @@ 
     
     protected static $logCallback;
 
-   /**
-    * Sets the callback function/method to use for
-    * SVH helper log messages. This gets the message
-    * and the SVNHelper instance as parameters.
-    * 
-    * @param callable $callback
-    * @throws SVNHelper_Exception
-    */
+    /**
+     * Sets the callback function/method to use for
+     * SVH helper log messages. This gets the message
+     * and the SVNHelper instance as parameters.
+     * 
+     * @param callable $callback
+     * @throws SVNHelper_Exception
+     */
     public static function setLogCallback($callback)
     {
         if(!is_callable($callback)) {
@@ -528,22 +528,22 @@ 
         }
     }
 
-   /**
-    * Retrieves information about the file, and adds it
-    * to be committed later if it not versioned yet. 
-    * 
-    * @param string $path
-    * @return SVNHelper_Target_File
-    */
+    /**
+     * Retrieves information about the file, and adds it
+     * to be committed later if it not versioned yet. 
+     * 
+     * @param string $path
+     * @return SVNHelper_Target_File
+     */
     public function addFile($path)
     {
         return $this->getFile($path)->runAdd();        
     }
     
-   /**
-    * Commits all changes in the repository.
-    * @param string $message The commit message to log.
-    */
+    /**
+     * Commits all changes in the repository.
+     * @param string $message The commit message to log.
+     */
     public function runCommit($message)
     {
         $this->createCommit($this->getFolder($this->path), $message)->execute();

src/Traits/Optionable.php

Indentation +100 added lines, -100 removed lines

@@ -26,18 +26,18 @@ 
  */
 trait Traits_Optionable
 {
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $options;
     
-   /**
-    * Sets an option to the specified value. This can be any
-    * kind of variable type, including objects, as needed.
-    * 
-    * @param string $name
-    * @param mixed $default
-    */
+    /**
+     * Sets an option to the specified value. This can be any
+     * kind of variable type, including objects, as needed.
+     * 
+     * @param string $name
+     * @param mixed $default
+     */
     public function setOption(string $name, $value)
     {
         if(!isset($this->options)) {
@@ -48,12 +48,12 @@ 
         return $this;
     }
     
-   /**
-    * Sets a collection of options at once, from an
-    * associative array.
-    * 
-    * @param array $options
-    */
+    /**
+     * Sets a collection of options at once, from an
+     * associative array.
+     * 
+     * @param array $options
+     */
     public function setOptions(array $options)
     {
         foreach($options as $name => $value) {
@@ -63,16 +63,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)) {
@@ -86,16 +86,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);
@@ -107,15 +107,15 @@ 
         return $default;
     }
     
-   /**
-    * Treats the option value as a boolean value: will return
-    * true if the value actually is a boolean true.
-    * 
-    * NOTE: boolean string representations are not accepted.
-    * 
-    * @param string $name
-    * @return bool
-    */
+    /**
+     * Treats the option value as a boolean value: will return
+     * true if the value actually is a boolean true.
+     * 
+     * NOTE: boolean string representations are not accepted.
+     * 
+     * @param string $name
+     * @return bool
+     */
     public function getBoolOption(string $name, bool $default=false) : bool
     {
         if($this->getOption($name) === true) {
@@ -125,15 +125,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);
@@ -144,14 +144,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);
@@ -162,13 +162,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)) {
@@ -178,10 +178,10 @@ 
         return array_key_exists($name, $this->options);
     }
     
-   /**
-    * Returns all options in one associative array.
-    * @return array
-    */
+    /**
+     * Returns all options in one associative array.
+     * @return array
+     */
     public function getOptions() : array
     {
         if(!isset($this->options)) {
@@ -191,24 +191,24 @@ 
         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
-    */
+    /**
+     * Retrieves the default available options as an 
+     * associative array with option name => value pairs.
+     * 
+     * @return array
+     */
     abstract public function getDefaultOptions() : array;
 }
 
@@ -226,24 +226,24 @@ 
  */
 interface Interface_Optionable
 {
-   /**
-    * @param string $name
-    * @param mixed $value
-    * @return Interface_Optionable
-    */
+    /**
+     * @param string $name
+     * @param mixed $value
+     * @return Interface_Optionable
+     */
     function setOption(string $name, $value);
     
-   /**
-    * @param string $name
-    * @param mixed $default
-    * @return Interface_Optionable
-    */
+    /**
+     * @param string $name
+     * @param mixed $default
+     * @return Interface_Optionable
+     */
     function getOption(string $name, $default=null);
     
-   /**
-    * @param array $options
-    * @return Interface_Optionable    
-    */
+    /**
+     * @param array $options
+     * @return Interface_Optionable    
+     */
     function setOptions(array $options);
     function getOptions() : array;
     function isOption(string $name, $value) : bool;

src/ZIPHelper.php

Indentation +55 added lines, -55 removed lines

@@ -36,14 +36,14 @@ 
         'WriteThreshold' => 100
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $file;
     
-   /**
-    * @var \ZipArchive
-    */
+    /**
+     * @var \ZipArchive
+     */
     protected $zip;
     
     public function __construct(string $targetFile)
@@ -51,35 +51,35 @@ 
         $this->file = $targetFile;
     }
     
-   /**
-    * Sets an option, among the available options:
-    * 
-    * <ul>
-    * <li>WriteThreshold: The amount of files to add before the zip is automatically written to disk and re-opened to release the file handles. Set to 0 to disable.</li>
-    * </ul>
-    * 
-    * @param string $name
-    * @param mixed $value
-    * @return ZIPHelper
-    */
+    /**
+     * Sets an option, among the available options:
+     * 
+     * <ul>
+     * <li>WriteThreshold: The amount of files to add before the zip is automatically written to disk and re-opened to release the file handles. Set to 0 to disable.</li>
+     * </ul>
+     * 
+     * @param string $name
+     * @param mixed $value
+     * @return ZIPHelper
+     */
     public function setOption(string $name, $value) : ZIPHelper
     {
         $this->options[$name] = $value;
         return $this;
     }
     
-   /**
-    * Adds a file to the zip. By default, the file is stored
-    * with the same name in the root of the zip. Use the optional
-    * parameter to change the location in the zip.
-    * 
-    * @param string $filePath
-    * @param string|null $zipPath If no path is specified, file will be added with the same name in the ZIP's root.
-    * @throws ZIPHelper_Exception
-    * @return bool
-    * 
-    * @see FileHelper::ERROR_SOURCE_FILE_DOES_NOT_EXIST
-    */
+    /**
+     * Adds a file to the zip. By default, the file is stored
+     * with the same name in the root of the zip. Use the optional
+     * parameter to change the location in the zip.
+     * 
+     * @param string $filePath
+     * @param string|null $zipPath If no path is specified, file will be added with the same name in the ZIP's root.
+     * @throws ZIPHelper_Exception
+     * @return bool
+     * 
+     * @see FileHelper::ERROR_SOURCE_FILE_DOES_NOT_EXIST
+     */
     public function addFile(string $filePath, ?string $zipPath=null) : bool
     {
         $this->open();
@@ -255,13 +255,13 @@ 
         return $fileName;
     }
     
-   /**
-    * Like {@link ZIPHelper::download()}, but deletes the
-    * file after sending it to the browser.
-    * 
-    * @param string|NULL $fileName Override the ZIP's file name for the download
-    * @see ZIPHelper::download()
-    */
+    /**
+     * Like {@link ZIPHelper::download()}, but deletes the
+     * file after sending it to the browser.
+     * 
+     * @param string|NULL $fileName Override the ZIP's file name for the download
+     * @see ZIPHelper::download()
+     */
     public function downloadAndDelete(?string $fileName=null)
     {
         $this->download($fileName);
@@ -269,14 +269,14 @@ 
         FileHelper::deleteFile($this->file);
     }
 
-   /**
-    * Extracts all files and folders from the zip to the 
-    * target folder. If no folder is specified, the files
-    * are extracted into the same folder as the zip itself.
-    * 
-    * @param string|NULL $outputFolder If no folder is specified, uses the target file's folder.
-    * @return boolean
-    */
+    /**
+     * Extracts all files and folders from the zip to the 
+     * target folder. If no folder is specified, the files
+     * are extracted into the same folder as the zip itself.
+     * 
+     * @param string|NULL $outputFolder If no folder is specified, uses the target file's folder.
+     * @return boolean
+     */
     public function extractAll(?string $outputFolder=null) : bool
     {
         if(empty($outputFolder)) {
@@ -289,9 +289,9 @@ 
     }
 
     
-   /**
-    * @return \ZipArchive
-    */
+    /**
+     * @return \ZipArchive
+     */
     public function getArchive() : \ZipArchive
     {
         $this->open();
@@ -299,14 +299,14 @@ 
         return $this->zip;
     }
     
-   /**
-    * JSON encodes the specified data and adds the json as
-    * a file in the ZIP archive.
-    * 
-    * @param mixed $data
-    * @param string $zipPath
-    * @return boolean
-    */
+    /**
+     * JSON encodes the specified data and adds the json as
+     * a file in the ZIP archive.
+     * 
+     * @param mixed $data
+     * @param string $zipPath
+     * @return boolean
+     */
     public function addJSON($data, $zipPath)
     {
         return $this->addString(

src/ImageHelper.php

Indentation +429 added lines, -429 removed lines

@@ -68,54 +68,54 @@ 
     
     const ERROR_UNEXPECTED_COLOR_VALUE = 513025;
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $file;
 
-   /**
-    * @var ImageHelper_Size
-    */
+    /**
+     * @var ImageHelper_Size
+     */
     protected $info;
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type;
 
-   /**
-    * @var resource|NULL
-    */
+    /**
+     * @var resource|NULL
+     */
     protected $newImage;
 
-   /**
-    * @var resource
-    */
+    /**
+     * @var resource
+     */
     protected $sourceImage;
 
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $width;
 
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $height;
 
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $newWidth = 0;
 
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $newHeight = 0;
 
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $quality = 85;
     
     protected static $imageTypes = array(
@@ -203,17 +203,17 @@ 
         }
     }
 
-   /**
-    * Factory method: creates a new helper with a blank image.
-    * 
-    * @param integer $width
-    * @param integer $height
-    * @param string $type The target file type when saving
-    * @return ImageHelper
-    * @throws ImageHelper_Exception
-    *
-    * @see ImageHelper::ERROR_CANNOT_CREATE_IMAGE_OBJECT
-    */
+    /**
+     * Factory method: creates a new helper with a blank image.
+     * 
+     * @param integer $width
+     * @param integer $height
+     * @param string $type The target file type when saving
+     * @return ImageHelper
+     * @throws ImageHelper_Exception
+     *
+     * @see ImageHelper::ERROR_CANNOT_CREATE_IMAGE_OBJECT
+     */
     public static function createNew($width, $height, $type='png')
     {
         $img = imagecreatetruecolor($width, $height);
@@ -228,18 +228,18 @@ 
         );
     }
     
-   /**
-    * Factory method: creates an image helper from an
-    * existing image resource.
-    *
-    * Note: while the resource is type independent, the
-    * type parameter is required for some methods, as well
-    * as to be able to save the image.
-    *
-    * @param resource $resource
-    * @param string $type The target image type, e.g. "jpeg", "png", etc.
-    * @return ImageHelper
-    */
+    /**
+     * Factory method: creates an image helper from an
+     * existing image resource.
+     *
+     * Note: while the resource is type independent, the
+     * type parameter is required for some methods, as well
+     * as to be able to save the image.
+     *
+     * @param resource $resource
+     * @param string $type The target image type, e.g. "jpeg", "png", etc.
+     * @return ImageHelper
+     */
     public static function createFromResource($resource, ?string $type=null)
     {
         self::requireResource($resource);
@@ -247,29 +247,29 @@ 
         return new ImageHelper(null, $resource, $type);
     }
     
-   /**
-    * Factory method: creates an image helper from an
-    * image file on disk.
-    *
-    * @param string $path
-    * @return ImageHelper
-    */
+    /**
+     * Factory method: creates an image helper from an
+     * image file on disk.
+     *
+     * @param string $path
+     * @return ImageHelper
+     */
     public static function createFromFile($file)
     {
         return new ImageHelper($file);
     }
     
-   /**
-    * Sets a global image helper configuration value. Available
-    * configuration settings are:
-    * 
-    * <ul>
-    * <li><code>auto-memory-adjustment</code> <i>boolean</i> Whether totry and adjust the memory limit automatically so there will be enough to load/process the target image.</li>
-    * </ul>
-    * 
-    * @param string $name
-    * @param mixed $value
-    */
+    /**
+     * Sets a global image helper configuration value. Available
+     * configuration settings are:
+     * 
+     * <ul>
+     * <li><code>auto-memory-adjustment</code> <i>boolean</i> Whether totry and adjust the memory limit automatically so there will be enough to load/process the target image.</li>
+     * </ul>
+     * 
+     * @param string $name
+     * @param mixed $value
+     */
     public static function setConfig($name, $value)
     {
         if(isset(self::$config[$name])) {
@@ -277,22 +277,22 @@ 
         }
     }
     
-   /**
-    * Shorthand for setting the automatic memory adjustment
-    * global configuration setting.
-    * 
-    * @param bool $enabled
-    */
+    /**
+     * Shorthand for setting the automatic memory adjustment
+     * global configuration setting.
+     * 
+     * @param bool $enabled
+     */
     public static function setAutoMemoryAdjustment($enabled=true)
     {
         self::setConfig('auto-memory-adjustment', $enabled);
     }
     
-   /**
-    * Duplicates an image resource.
-    * @param resource $img
-    * @return resource
-    */
+    /**
+     * Duplicates an image resource.
+     * @param resource $img
+     * @return resource
+     */
     protected function duplicateImage($img)
     {
         self::requireResource($img);
@@ -304,12 +304,12 @@ 
         return $duplicate;
     }
     
-   /**
-    * Duplicates the current state of the image into a new
-    * image helper instance.
-    * 
-    * @return ImageHelper
-    */
+    /**
+     * Duplicates the current state of the image into a new
+     * image helper instance.
+     * 
+     * @return ImageHelper
+     */
     public function duplicate()
     {
         return ImageHelper::createFromResource($this->duplicateImage($this->newImage));
@@ -497,13 +497,13 @@ 
         ));
     }
     
-   /**
-    * Resamples the image to a new width, maintaining
-    * aspect ratio.
-    * 
-    * @param int $width
-    * @return ImageHelper
-    */
+    /**
+     * Resamples the image to a new width, maintaining
+     * aspect ratio.
+     * 
+     * @param int $width
+     * @return ImageHelper
+     */
     public function resampleByWidth(int $width) : ImageHelper
     {
         $size = $this->getSizeByWidth($width);
@@ -513,12 +513,12 @@ 
         return $this;
     }
 
-   /**
-    * Resamples the image by height, and creates a new image file on disk.
-    * 
-    * @param int $height
-    * @return ImageHelper
-    */
+    /**
+     * Resamples the image by height, and creates a new image file on disk.
+     * 
+     * @param int $height
+     * @return ImageHelper
+     */
     public function resampleByHeight($height) : ImageHelper
     {
         $size = $this->getSizeByHeight($height);
@@ -526,13 +526,13 @@ 
         return $this->resampleImage($size->getWidth(), $size->getHeight());
     }
 
-   /**
-    * Resamples the image without keeping the aspect ratio.
-    * 
-    * @param int $width
-    * @param int $height
-    * @return ImageHelper
-    */
+    /**
+     * Resamples the image without keeping the aspect ratio.
+     * 
+     * @param int $width
+     * @param int $height
+     * @return ImageHelper
+     */
     public function resample(?int $width = null, ?int $height = null) : ImageHelper
     {
         if($this->isVector()) {
@@ -597,12 +597,12 @@ 
     
     protected $alpha = false;
 
-   /**
-    * Configures the specified image resource to make it alpha compatible.
-    * 
-    * @param resource $canvas
-    * @param bool $fill Whether to fill the whole canvas with the transparency
-    */
+    /**
+     * Configures the specified image resource to make it alpha compatible.
+     * 
+     * @param resource $canvas
+     * @param bool $fill Whether to fill the whole canvas with the transparency
+     */
     public static function addAlphaSupport($canvas, $fill=true)
     {
         self::requireResource($canvas);
@@ -717,12 +717,12 @@ 
         $this->quality = $quality * 1;
     }
 
-   /**
-    * Attempts to adjust the memory to the required size
-    * to work with the current image.
-    * 
-    * @return boolean
-    */
+    /**
+     * Attempts to adjust the memory to the required size
+     * to work with the current image.
+     * 
+     * @return boolean
+     */
     protected function adjustMemory() : bool
     {
         if(!self::$config['auto-memory-adjustment']) {
@@ -762,27 +762,27 @@ 
         return false;
     }
 
-   /**
-    * Stretches the image to the specified dimensions.
-    * 
-    * @param int $width
-    * @param int $height
-    * @return ImageHelper
-    */
+    /**
+     * Stretches the image to the specified dimensions.
+     * 
+     * @param int $width
+     * @param int $height
+     * @return ImageHelper
+     */
     public function stretch(int $width, int $height) : ImageHelper
     {
         return $this->resampleImage($width, $height);
     }
 
-   /**
-    * Creates a new image from the current image,
-    * resampling it to the new size.
-    * 
-    * @param int $newWidth
-    * @param int $newHeight   
-    * @throws ImageHelper_Exception
-    * @return ImageHelper
-    */
+    /**
+     * Creates a new image from the current image,
+     * resampling it to the new size.
+     * 
+     * @param int $newWidth
+     * @param int $newHeight   
+     * @throws ImageHelper_Exception
+     * @return ImageHelper
+     */
     protected function resampleImage(int $newWidth, int $newHeight) : ImageHelper
     {
         if($this->isVector()) {
@@ -922,31 +922,31 @@ 
         readfile($imageFile);
     }
     
-   /**
-    * Displays the current image.
-    */
+    /**
+     * Displays the current image.
+     */
     public function display()
     {
         $this->displayImageStream($this->newImage, $this->getType(), $this->resolveQuality());
     }
     
-   /**
-    * Trims the current loaded image.
-    * 
-    * @param array $color A color definition, as an associative array with red, green, and blue keys. If not specified, the color at pixel position 0,0 will be used.
-    */
+    /**
+     * Trims the current loaded image.
+     * 
+     * @param array $color A color definition, as an associative array with red, green, and blue keys. If not specified, the color at pixel position 0,0 will be used.
+     */
     public function trim($color=null)
     {
         return $this->trimImage($this->newImage, $color);
     }
     
-   /**
-    * Retrieves a color definition by its index.
-    * 
-    * @param resource $img A valid image resource.
-    * @param int $colorIndex The color index, as returned by imagecolorat for example.
-    * @return array An array with red, green, blue and alpha keys.
-    */
+    /**
+     * Retrieves a color definition by its index.
+     * 
+     * @param resource $img A valid image resource.
+     * @param int $colorIndex The color index, as returned by imagecolorat for example.
+     * @return array An array with red, green, blue and alpha keys.
+     */
     public function getIndexedColors($img, int $colorIndex) : array
     {
         $color = imagecolorsforindex($img, $colorIndex);
@@ -964,14 +964,14 @@ 
         );
     }
         
-   /**
-    * Trims the specified image resource by removing the specified color.
-    * Also works with transparency.
-    * 
-    * @param resource $img
-    * @param array $color A color definition, as an associative array with red, green, blue and alpha keys. If not specified, the color at pixel position 0,0 will be used.
-    * @return ImageHelper
-    */
+    /**
+     * Trims the specified image resource by removing the specified color.
+     * Also works with transparency.
+     * 
+     * @param resource $img
+     * @param array $color A color definition, as an associative array with red, green, blue and alpha keys. If not specified, the color at pixel position 0,0 will be used.
+     * @return ImageHelper
+     */
     protected function trimImage($img, ?array $color=null) : ImageHelper
     {
         if($this->isVector()) {
@@ -1059,12 +1059,12 @@ 
         return $this;
     }
     
-   /**
-    * Sets the new image after a transformation operation:
-    * automatically adjusts the new size information.
-    * 
-    * @param resource $image
-    */
+    /**
+     * Sets the new image after a transformation operation:
+     * automatically adjusts the new size information.
+     * 
+     * @param resource $image
+     */
     protected function setNewImage($image)
     {
         self::requireResource($image);
@@ -1074,12 +1074,12 @@ 
         $this->newHeight= imagesy($image);
     }
     
-   /**
-    * Requires the subject to be a resource.
-    * 
-    * @param resource $subject
-    * @throws ImageHelper_Exception
-    */
+    /**
+     * Requires the subject to be a resource.
+     * 
+     * @param resource $subject
+     * @throws ImageHelper_Exception
+     */
     protected static function requireResource($subject)
     {
         if(is_resource($subject)) {
@@ -1096,14 +1096,14 @@ 
         );
     }
     
-   /**
-    * Creates a new image resource, with transparent background.
-    * 
-    * @param int $width
-    * @param int $height
-    * @throws ImageHelper_Exception
-    * @return resource
-    */
+    /**
+     * Creates a new image resource, with transparent background.
+     * 
+     * @param int $width
+     * @param int $height
+     * @throws ImageHelper_Exception
+     * @return resource
+     */
     protected function createNewImage(int $width, int $height)
     {
         $img = imagecreatetruecolor($width, $height);
@@ -1122,54 +1122,54 @@ 
         return $img;
     }
     
-   /**
-    * Whether the two specified colors are the same.
-    * 
-    * @param array $a
-    * @param array $b
-    * @return boolean
-    */
-	protected function colorsMatch($a, $b) : bool
-	{
-		$parts = array('red', 'green', 'blue');
-		foreach($parts as $part) {
-			if($a[$part] != $b[$part]) {
-				return false;
-			}
-		} 
+    /**
+     * Whether the two specified colors are the same.
+     * 
+     * @param array $a
+     * @param array $b
+     * @return boolean
+     */
+    protected function colorsMatch($a, $b) : bool
+    {
+        $parts = array('red', 'green', 'blue');
+        foreach($parts as $part) {
+            if($a[$part] != $b[$part]) {
+                return false;
+            }
+        } 
 		
-		return true;
-	}
+        return true;
+    }
 	
-	public function fillWhite($x=0, $y=0)
-	{
-	    $this->addRGBColor('white', 255, 255, 255);
+    public function fillWhite($x=0, $y=0)
+    {
+        $this->addRGBColor('white', 255, 255, 255);
         return $this->fill('white', $x, $y);
-	}
+    }
 	
-	public function fillTransparent() : ImageHelper
-	{
+    public function fillTransparent() : ImageHelper
+    {
         $this->enableAlpha();
 	    
-	    self::fillImageTransparent($this->newImage);
+        self::fillImageTransparent($this->newImage);
 	    
-	    return $this;
-	}
+        return $this;
+    }
 	
-	public static function fillImageTransparent($resource)
-	{
-	    self::requireResource($resource);
+    public static function fillImageTransparent($resource)
+    {
+        self::requireResource($resource);
 	    
-	    $transparent = imagecolorallocatealpha($resource, 89, 14, 207, 127);
-	    imagecolortransparent ($resource, $transparent);
-	    imagefill($resource, 0, 0, $transparent);
-	}
+        $transparent = imagecolorallocatealpha($resource, 89, 14, 207, 127);
+        imagecolortransparent ($resource, $transparent);
+        imagefill($resource, 0, 0, $transparent);
+    }
 	
-	public function fill($colorName, $x=0, $y=0)
-	{
-	    imagefill($this->newImage, $x, $y, $this->colors[$colorName]);
-	    return $this;
-	}
+    public function fill($colorName, $x=0, $y=0)
+    {
+        imagefill($this->newImage, $x, $y, $this->colors[$colorName]);
+        return $this;
+    }
 	
     protected $colors = array();
 
@@ -1190,9 +1190,9 @@ 
         return $this;
     }
     
-   /**
-    * @return resource
-    */
+    /**
+     * @return resource
+     */
     public function getImage()
     {
         return $this->newImage;
@@ -1210,27 +1210,27 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves the size of the image.
-    * 
-    * @param bool $exception Whether to trigger an exception when the image does not exist
-    * @return ImageHelper_Size
-    * @throws ImageHelper_Exception
-    * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE
-    */
-	public function getSize() : ImageHelper_Size
+    /**
+     * Retrieves the size of the image.
+     * 
+     * @param bool $exception Whether to trigger an exception when the image does not exist
+     * @return ImageHelper_Size
+     * @throws ImageHelper_Exception
+     * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE
+     */
+    public function getSize() : ImageHelper_Size
     {
-	    return self::getImageSize($this->newImage);
+        return self::getImageSize($this->newImage);
     }
     
     protected $TTFFile;
     
-   /**
-    * Sets the TTF font file to use for text operations.
-    * 
-    * @param string $filePath
-    * @return ImageHelper
-    */
+    /**
+     * Sets the TTF font file to use for text operations.
+     * 
+     * @param string $filePath
+     * @return ImageHelper
+     */
     public function setFontTTF($filePath)
     {
         $this->TTFFile = $filePath;
@@ -1302,63 +1302,63 @@ 
             return;
         }
         
-	    throw new ImageHelper_Exception(
+        throw new ImageHelper_Exception(
             'No true type font specified',
             'This functionality requires a TTF font file to be specified with the [setFontTTF] method.',
             self::ERROR_NO_TRUE_TYPE_FONT_SET    
         );
     }
     
-   /**
-	 * Retrieves the size of an image file on disk, or
-	 * an existing image resource.
-	 *
-	 * <pre>
-	 * array(
-	 *     0: (width),
-	 *     1: (height),
-	 *     "channels": the amount of channels
-	 *     "bits": bits per channel
+    /**
+     * Retrieves the size of an image file on disk, or
+     * an existing image resource.
+     *
+     * <pre>
+     * array(
+     *     0: (width),
+     *     1: (height),
+     *     "channels": the amount of channels
+     *     "bits": bits per channel
      * )     
-	 * </pre>
-	 *
-	 * @param string|resource $pathOrResource
-	 * @return ImageHelper_Size Size object, can also be accessed like the traditional array from getimagesize
-	 * @see ImageHelper_Size
-	 * @throws ImageHelper_Exception
-	 * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE
-	 * @see ImageHelper::ERROR_CANNOT_READ_SVG_IMAGE
-	 * @see ImageHelper::ERROR_SVG_SOURCE_VIEWBOX_MISSING
-	 * @see ImageHelper::ERROR_SVG_VIEWBOX_INVALID
-	 */
-	public static function getImageSize($pathOrResource) : ImageHelper_Size
-	{
-	    if(is_resource($pathOrResource)) 
-	    {
-	        return new ImageHelper_Size(array(
-	            'width' => imagesx($pathOrResource),
-	            'height' => imagesy($pathOrResource),
-	            'channels' => 1,
-	            'bits' => 8
-	        ));
-	    }
+     * </pre>
+     *
+     * @param string|resource $pathOrResource
+     * @return ImageHelper_Size Size object, can also be accessed like the traditional array from getimagesize
+     * @see ImageHelper_Size
+     * @throws ImageHelper_Exception
+     * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE
+     * @see ImageHelper::ERROR_CANNOT_READ_SVG_IMAGE
+     * @see ImageHelper::ERROR_SVG_SOURCE_VIEWBOX_MISSING
+     * @see ImageHelper::ERROR_SVG_VIEWBOX_INVALID
+     */
+    public static function getImageSize($pathOrResource) : ImageHelper_Size
+    {
+        if(is_resource($pathOrResource)) 
+        {
+            return new ImageHelper_Size(array(
+                'width' => imagesx($pathOrResource),
+                'height' => imagesy($pathOrResource),
+                'channels' => 1,
+                'bits' => 8
+            ));
+        }
 	    
-	    $type = self::getFileImageType($pathOrResource);
+        $type = self::getFileImageType($pathOrResource);
 	    
-	    $info = false;
-	    $method = 'getImageSize_'.$type;
-	    if(method_exists(__CLASS__, $method)) 
-	    {
-	        $info = call_user_func(array(__CLASS__, $method), $pathOrResource);
-	    } 
-	    else 
-	    {
-	        $info = getimagesize($pathOrResource);
-	    }
+        $info = false;
+        $method = 'getImageSize_'.$type;
+        if(method_exists(__CLASS__, $method)) 
+        {
+            $info = call_user_func(array(__CLASS__, $method), $pathOrResource);
+        } 
+        else 
+        {
+            $info = getimagesize($pathOrResource);
+        }
 	    
-	    if($info !== false) {
-	        return new ImageHelper_Size($info);
-	    }
+        if($info !== false) {
+            return new ImageHelper_Size($info);
+        }
 	    
         throw new ImageHelper_Exception(
             'Error opening image file',
@@ -1368,98 +1368,98 @@ 
             ),
             self::ERROR_CANNOT_GET_IMAGE_SIZE
         );
-	}
+    }
 	
-   /**
-    * @param string $imagePath
-    * @throws ImageHelper_Exception
-    * @return array
-    * 
-    * @todo This should return a ImageHelper_Size instance.
-    */
-	protected static function getImageSize_svg(string $imagePath) : array
-	{
-	    $xml = XMLHelper::createSimplexml();
-	    $xml->loadFile($imagePath);
+    /**
+     * @param string $imagePath
+     * @throws ImageHelper_Exception
+     * @return array
+     * 
+     * @todo This should return a ImageHelper_Size instance.
+     */
+    protected static function getImageSize_svg(string $imagePath) : array
+    {
+        $xml = XMLHelper::createSimplexml();
+        $xml->loadFile($imagePath);
 	    
-	    if($xml->hasErrors()) {
-	        throw new ImageHelper_Exception(
-	            'Error opening SVG image',
-	            sprintf(
-	                'The XML content of the image [%s] could not be parsed.',
-	                $imagePath
+        if($xml->hasErrors()) {
+            throw new ImageHelper_Exception(
+                'Error opening SVG image',
+                sprintf(
+                    'The XML content of the image [%s] could not be parsed.',
+                    $imagePath
                 ),
-	            self::ERROR_CANNOT_READ_SVG_IMAGE
+                self::ERROR_CANNOT_READ_SVG_IMAGE
             );
-	    }
+        }
 	    
-	    $data = $xml->toArray();
-	    $xml->dispose();
-	    unset($xml);
+        $data = $xml->toArray();
+        $xml->dispose();
+        unset($xml);
 	    
-	    if(!isset($data['@attributes']) || !isset($data['@attributes']['viewBox'])) {
-	        throw new ImageHelper_Exception(
-	            'SVG Image is corrupted',
-	            sprintf(
-	                'The [viewBox] attribute is missing in the XML of the image at path [%s].',
-	                $imagePath
+        if(!isset($data['@attributes']) || !isset($data['@attributes']['viewBox'])) {
+            throw new ImageHelper_Exception(
+                'SVG Image is corrupted',
+                sprintf(
+                    'The [viewBox] attribute is missing in the XML of the image at path [%s].',
+                    $imagePath
                 ),
-	            self::ERROR_SVG_SOURCE_VIEWBOX_MISSING
+                self::ERROR_SVG_SOURCE_VIEWBOX_MISSING
             );
-	    }
+        }
 	    
-	    $svgWidth = parseNumber($data['@attributes']['width'])->getNumber();
-	    $svgHeight = parseNumber($data['@attributes']['height'])->getNumber();
+        $svgWidth = parseNumber($data['@attributes']['width'])->getNumber();
+        $svgHeight = parseNumber($data['@attributes']['height'])->getNumber();
 	    
-	    $viewBox = str_replace(' ', ',', $data['@attributes']['viewBox']);
-	    $size = explode(',', $viewBox);
+        $viewBox = str_replace(' ', ',', $data['@attributes']['viewBox']);
+        $size = explode(',', $viewBox);
 	    
-	    if(count($size) != 4) 
-	    {
-	        throw new ImageHelper_Exception(
-	            'SVG image has an invalid viewBox attribute',
-	            sprintf(
-	               'The [viewBox] attribute does not have an expected value: [%s] in path [%s].',
-	                $viewBox,
-	                $imagePath
+        if(count($size) != 4) 
+        {
+            throw new ImageHelper_Exception(
+                'SVG image has an invalid viewBox attribute',
+                sprintf(
+                    'The [viewBox] attribute does not have an expected value: [%s] in path [%s].',
+                    $viewBox,
+                    $imagePath
                 ),
-	            self::ERROR_SVG_VIEWBOX_INVALID
+                self::ERROR_SVG_VIEWBOX_INVALID
             );
-	    }
+        }
 	    
-	    $boxWidth = $size[2];
-	    $boxHeight = $size[3];
+        $boxWidth = $size[2];
+        $boxHeight = $size[3];
 	    
-	    // calculate the x and y units of the document: 
-	    // @see http://tutorials.jenkov.com/svg/svg-viewport-view-box.html#viewbox
-	    //
-	    // The viewbox combined with the width and heigt of the svg
-	    // allow calculating how many pixels are in one unit of the 
-	    // width and height of the document.
+        // calculate the x and y units of the document: 
+        // @see http://tutorials.jenkov.com/svg/svg-viewport-view-box.html#viewbox
+        //
+        // The viewbox combined with the width and heigt of the svg
+        // allow calculating how many pixels are in one unit of the 
+        // width and height of the document.
         //
-	    $xUnits = $svgWidth / $boxWidth;
-	    $yUnits = $svgHeight / $boxHeight;
+        $xUnits = $svgWidth / $boxWidth;
+        $yUnits = $svgHeight / $boxHeight;
 	    
-	    $pxWidth = $xUnits * $svgWidth;
-	    $pxHeight = $yUnits * $svgHeight;
+        $pxWidth = $xUnits * $svgWidth;
+        $pxHeight = $yUnits * $svgHeight;
 	    
-	    return array(
-	        $pxWidth,
-	        $pxHeight,
-	        'bits' => 8
-	    );
-	}
+        return array(
+            $pxWidth,
+            $pxHeight,
+            'bits' => 8
+        );
+    }
 	
-	/**
-    * Crops the image to the specified width and height, optionally
-    * specifying the origin position to crop from.
-    * 
-    * @param integer $width
-    * @param integer $height
-    * @param integer $x
-    * @param integer $y
-    * @return ImageHelper
-    */
+    /**
+     * Crops the image to the specified width and height, optionally
+     * specifying the origin position to crop from.
+     * 
+     * @param integer $width
+     * @param integer $height
+     * @param integer $x
+     * @param integer $y
+     * @return ImageHelper
+     */
     public function crop(int $width, int $height, int $x=0, int $y=0) : ImageHelper
     {
         $new = $this->createNewImage($width, $height);
@@ -1481,22 +1481,22 @@ 
         return $this->newHeight;
     }
 
-   /**
-    * Calculates the average color value used in 
-    * the image. Returns an associative array
-    * with the red, green, blue and alpha components,
-    * or a HEX color string depending on the selected
-    * format.
-    * 
-    * NOTE: Use the calcAverageColorXXX methods for
-    * strict return types. 
-    * 
-    * @param int $format The format in which to return the color value.
-    * @return array|string
-    * 
-    * @see ImageHelper::calcAverageColorRGB()
-    * @see ImageHelper::calcAverageColorHEX()
-    */
+    /**
+     * Calculates the average color value used in 
+     * the image. Returns an associative array
+     * with the red, green, blue and alpha components,
+     * or a HEX color string depending on the selected
+     * format.
+     * 
+     * NOTE: Use the calcAverageColorXXX methods for
+     * strict return types. 
+     * 
+     * @param int $format The format in which to return the color value.
+     * @return array|string
+     * 
+     * @see ImageHelper::calcAverageColorRGB()
+     * @see ImageHelper::calcAverageColorHEX()
+     */
     public function calcAverageColor(int $format=self::COLORFORMAT_RGB)
     {
         $image = $this->duplicate();
@@ -1505,35 +1505,35 @@ 
         return $image->getColorAt(0, 0, $format);
     }
     
-   /**
-    * Calculates the image's average color value, and
-    * returns an associative array with red, green,
-    * blue and alpha keys.
-    * 
-    * @throws ImageHelper_Exception
-    * @return array
-    */
+    /**
+     * Calculates the image's average color value, and
+     * returns an associative array with red, green,
+     * blue and alpha keys.
+     * 
+     * @throws ImageHelper_Exception
+     * @return array
+     */
     public function calcAverageColorRGB() : array
     {
-       $result = $this->calcAverageColor(self::COLORFORMAT_RGB);
-       if(is_array($result)) {
-           return $result;
-       }
+        $result = $this->calcAverageColor(self::COLORFORMAT_RGB);
+        if(is_array($result)) {
+            return $result;
+        }
        
-       throw new ImageHelper_Exception(
-           'Unexpected color value',
-           sprintf('Expected an array, got [%s].', gettype($result)),
-           self::ERROR_UNEXPECTED_COLOR_VALUE
-       );
-    }
-    
-   /**
-    * Calculates the image's average color value, and
-    * returns a hex color string (without the #).
-    * 
-    * @throws ImageHelper_Exception
-    * @return string
-    */
+        throw new ImageHelper_Exception(
+            'Unexpected color value',
+            sprintf('Expected an array, got [%s].', gettype($result)),
+            self::ERROR_UNEXPECTED_COLOR_VALUE
+        );
+    }
+    
+    /**
+     * Calculates the image's average color value, and
+     * returns a hex color string (without the #).
+     * 
+     * @throws ImageHelper_Exception
+     * @return string
+     */
     public function calcAverageColorHex() : string
     {
         $result = $this->calcAverageColor(self::COLORFORMAT_HEX);
@@ -1562,18 +1562,18 @@ 
     
     const COLORFORMAT_HEX = 2;
     
-   /**
-    * Retrieves the color value at the specified pixel
-    * coordinates in the image.
-    * 
-    * @param int $x
-    * @param int $y
-    * @param int $format The format in which to return the color value.
-    * @return array|string
-    * 
-    * @see ImageHelper::COLORFORMAT_RGB
-    * @see ImageHelper::COLORFORMAT_HEX
-    */
+    /**
+     * Retrieves the color value at the specified pixel
+     * coordinates in the image.
+     * 
+     * @param int $x
+     * @param int $y
+     * @param int $format The format in which to return the color value.
+     * @return array|string
+     * 
+     * @see ImageHelper::COLORFORMAT_RGB
+     * @see ImageHelper::COLORFORMAT_HEX
+     */
     public function getColorAt(int $x, int $y, int $format=self::COLORFORMAT_RGB)
     {
         if($x > $this->getWidth() || $y > $this->getHeight()) 
@@ -1601,21 +1601,21 @@ 
         return $rgb;
     }
     
-   /**
-    * Converts an RGB value to its luminance equivalent.
-    * 
-    * @param array $rgb
-    * @return integer Integer, from 0 to 255 (0=black, 255=white)
-    */
+    /**
+     * Converts an RGB value to its luminance equivalent.
+     * 
+     * @param array $rgb
+     * @return integer Integer, from 0 to 255 (0=black, 255=white)
+     */
     public static function rgb2luma(array $rgb) : int
     {
         return (int)floor((($rgb['red']*2)+$rgb['blue']+($rgb['green']*3))/6);
     }
     
-   /**
-    * Retrieves the brightness of the image, in percent.
-    * @return number
-    */
+    /**
+     * Retrieves the brightness of the image, in percent.
+     * @return number
+     */
     public function getBrightness()
     {
         $luma = self::rgb2luma($this->calcAverageColorRGB());
@@ -1623,15 +1623,15 @@ 
         return $percent;
     }
     
-   /**
-    * Retrieves an md5 hash of the source image file.
-    * 
-    * NOTE: Only works when the helper has been created
-    * from a file. Otherwise an exception is thrown.
-    * 
-    * @return string
-    * @throws ImageHelper_Exception
-    */
+    /**
+     * Retrieves an md5 hash of the source image file.
+     * 
+     * NOTE: Only works when the helper has been created
+     * from a file. Otherwise an exception is thrown.
+     * 
+     * @return string
+     * @throws ImageHelper_Exception
+     */
     public function getHash()
     {
         ob_start();

src/SVNHelper/CommandResult.php

Indentation +27 added lines, -27 removed lines

@@ -4,37 +4,37 @@ 
 
 class SVNHelper_CommandResult
 {
-   /**
-    * @var SVNHelper_Command
-    */
+    /**
+     * @var SVNHelper_Command
+     */
     protected $command;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $output;
     
-   /**
-    * @var SVNHelper_CommandError[]
-    */
+    /**
+     * @var SVNHelper_CommandError[]
+     */
     protected $errors = array();
     
-   /**
-    * @var SVNHelper_CommandError[]
-    */
+    /**
+     * @var SVNHelper_CommandError[]
+     */
     protected $warnings = array();
     
-   /**
-    * The actual command that has been executed
-    * @var string
-    */
+    /**
+     * The actual command that has been executed
+     * @var string
+     */
     protected $commandLine;
     
-   /**
-    * @param SVNHelper_Command $command
-    * @param string[] $output
-    * @param SVNHelper_CommandError[] $errors
-    */
+    /**
+     * @param SVNHelper_Command $command
+     * @param string[] $output
+     * @param SVNHelper_CommandError[] $errors
+     */
     public function __construct(SVNHelper_Command $command, $commandLine, $output, $errors)
     {
         $this->command = $command;
@@ -86,12 +86,12 @@ 
         return $this->command;
     }
     
-   /**
-    * Retrieves all error messages.
-    * 
-    * @param bool $asString
-    * @return string|string[]
-    */
+    /**
+     * Retrieves all error messages.
+     * 
+     * @param bool $asString
+     * @return string|string[]
+     */
     public function getErrorMessages(bool $asString=false)
     {
         if($asString) {

src/NumberInfo.php

Indentation +78 added lines, -78 removed lines

@@ -38,24 +38,24 @@ 
  */
 class NumberInfo
 {
-   /**
-    * @var mixed
-    */
+    /**
+     * @var mixed
+     */
     protected $rawValue;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $info;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $empty = false;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $knownUnits = array(
         '%' => true,
         'rem' => true,
@@ -95,21 +95,21 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves the raw, internal information array resulting
-    * from the parsing of the number.
-    *  
-    * @return array
-    */
+    /**
+     * Retrieves the raw, internal information array resulting
+     * from the parsing of the number.
+     *  
+     * @return array
+     */
     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;
@@ -532,12 +532,12 @@ 
         return $cache[$key];
     }
     
-   /**
-    * Parses a string number notation with units included, e.g. 14px, 50%...
-    * 
-    * @param string $test
-    * @return array
-    */
+    /**
+     * Parses a string number notation with units included, e.g. 14px, 50%...
+     * 
+     * @param string $test
+     * @return array
+     */
     private function parseStringValue(string $test) : array
     {
         $number = null;
@@ -588,13 +588,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|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|NULL
+     */
     private function findUnits(string $value) : ?array
     {
         $vlength = strlen($value);
@@ -622,12 +622,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))
@@ -640,59 +640,59 @@ 
     
     protected $postProcess = false;
     
-   /**
-    * 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 mixed
-    */
+    /**
+     * 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 mixed
+     */
     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 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 $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 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 $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 NumberInfo
-    * @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 NumberInfo
+     * @see NumberInfo::postProcess()
+     */
     private 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 $info
-    * @return array
-    */
+    /**
+     * Filters the number info array to adjust the units
+     * and number according to the required rules.
+     * 
+     * @param array $info
+     * @return array
+     */
     protected function filterInfo(array $info) : array
     {
         $useUnits = 'px';

src/ConvertHelper/ByteConverter.php

Indentation +63 added lines, -63 removed lines

@@ -23,9 +23,9 @@ 
  */
 class ConvertHelper_ByteConverter
 {
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $bytes;
     
     public function __construct(int $bytes)
@@ -39,12 +39,12 @@ 
         }
     }
     
-   /**
-    * Detects the size matching the byte value for the specified base.
-    * 
-    * @param int $base
-    * @return ConvertHelper_StorageSizeEnum_Size
-    */
+    /**
+     * Detects the size matching the byte value for the specified base.
+     * 
+     * @param int $base
+     * @return ConvertHelper_StorageSizeEnum_Size
+     */
     protected function detectSize(int $base) : ConvertHelper_StorageSizeEnum_Size
     {
         $sizes = $this->getSizesSorted($base);   
@@ -70,13 +70,13 @@ 
         return ConvertHelper_StorageSizeEnum::getSizeByName('b');
     }
     
-   /**
-    * Retrieves all storage sizes for the specified base, 
-    * sorted from smallest byte size to highest.
-    * 
-    * @param int $base
-    * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[]
-    */
+    /**
+     * Retrieves all storage sizes for the specified base, 
+     * sorted from smallest byte size to highest.
+     * 
+     * @param int $base
+     * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[]
+     */
     protected function getSizesSorted(int $base)
     {
         $sizes = ConvertHelper_StorageSizeEnum::getSizesByBase($base);
@@ -89,16 +89,16 @@ 
         return $sizes;
     }
     
-   /**
-    * Converts the byte value to a human readable string, e.g. "5 KB", "140 MB".
-    * 
-    * @param int $precision The amount of decimals (rounded up)
-    * @param int $base The base to calculate bytes with.
-    * @return string
-    * 
-    * @see ConvertHelper_StorageSizeEnum::BASE_10
-    * @see ConvertHelper_StorageSizeEnum::BASE_2
-    */
+    /**
+     * Converts the byte value to a human readable string, e.g. "5 KB", "140 MB".
+     * 
+     * @param int $precision The amount of decimals (rounded up)
+     * @param int $base The base to calculate bytes with.
+     * @return string
+     * 
+     * @see ConvertHelper_StorageSizeEnum::BASE_10
+     * @see ConvertHelper_StorageSizeEnum::BASE_2
+     */
     public function toString(int $precision, int $base=ConvertHelper_StorageSizeEnum::BASE_10) : string
     {
         $size = $this->detectSize($base);
@@ -106,13 +106,13 @@ 
         return round($this->bytes / $size->getBytes(), $precision) . ' ' . $size->getSuffix();
     }
     
-   /**
-    * Converts the byte value to the amount of the corresponding units (KB, MB...).
-    * 
-    * @param int $precision The amount of decimals (rounded up)
-    * @param string $sizeName The lowercase storage size name (e.g. "kb", "kib")
-    * @return float
-    */
+    /**
+     * Converts the byte value to the amount of the corresponding units (KB, MB...).
+     * 
+     * @param int $precision The amount of decimals (rounded up)
+     * @param string $sizeName The lowercase storage size name (e.g. "kb", "kib")
+     * @return float
+     */
     public function toNumber(int $precision, string $sizeName) : float
     {
         $size = ConvertHelper_StorageSizeEnum::getSizeByName($sizeName);
@@ -120,56 +120,56 @@ 
         return round($this->bytes / $size->getBytes(), $precision);
     }
     
-   /**
-    * Converts the bytes to Kilobytes.
-    * 
-    * @param int $precision Amount of decimals (rounded up)
-    * @return float
-    */
+    /**
+     * Converts the bytes to Kilobytes.
+     * 
+     * @param int $precision Amount of decimals (rounded up)
+     * @return float
+     */
     public function toKilobytes(int $precision=1) : float
     {
         return $this->toNumber($precision, 'kb');
     }
     
-   /**
-    * Converts the bytes to Megabytes.
-    *
-    * @param int $precision Amount of decimals (rounded up)
-    * @return float
-    */
+    /**
+     * Converts the bytes to Megabytes.
+     *
+     * @param int $precision Amount of decimals (rounded up)
+     * @return float
+     */
     public function toMegabytes(int $precision=1) : float
     {
         return $this->toNumber($precision, 'mb');
     }
 
-   /**
-    * Converts the bytes to Gigabytes.
-    *
-    * @param int $precision Amount of decimals (rounded up)
-    * @return float
-    */
+    /**
+     * Converts the bytes to Gigabytes.
+     *
+     * @param int $precision Amount of decimals (rounded up)
+     * @return float
+     */
     public function toGigabytes(int $precision=1) : float
     {
         return $this->toNumber($precision, 'gb');
     }
 
-   /**
-    * Converts the bytes to Terabytes.
-    *
-    * @param int $precision Amount of decimals (rounded up)
-    * @return float
-    */
+    /**
+     * Converts the bytes to Terabytes.
+     *
+     * @param int $precision Amount of decimals (rounded up)
+     * @return float
+     */
     public function toTerabytes(int $precision=1) : float
     {
         return $this->toNumber($precision, 'tb');
     }
     
-   /**
-    * Converts the bytes to Petabytes.
-    *
-    * @param int $precision Amount of decimals (rounded up)
-    * @return float
-    */
+    /**
+     * Converts the bytes to Petabytes.
+     *
+     * @param int $precision Amount of decimals (rounded up)
+     * @return float
+     */
     public function toPetabytes(int $precision=1) : float
     {
         return $this->toNumber($precision, 'pb');

src/ConvertHelper/DurationConverter.php

Indentation +47 added lines, -47 removed lines

@@ -26,39 +26,39 @@ 
     const ERROR_NO_DATE_FROM_SET = 43401;
     
     
-   /**
-    * @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
-    */
+    /**
+     * @var array
+     */
     protected static $texts;
     
     public function __construct()
@@ -78,17 +78,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);
@@ -96,13 +96,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);
@@ -110,14 +110,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();