Mistralys / application-utils

src/IniHelper.php

Indentation +85 added lines, -85 removed lines

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

src/BaseException.php

Indentation +35 added lines, -35 removed lines

@@ -20,17 +20,17 @@ 
  */
 class BaseException extends \Exception
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $details;
     
-   /**
-    * @param string $message
-    * @param string $details
-    * @param int $code
-    * @param \Exception $previous
-    */
+    /**
+     * @param string $message
+     * @param string $details
+     * @param int $code
+     * @param \Exception $previous
+     */
     public function __construct(string $message, $details=null, $code=null, $previous=null)
     {
         parent::__construct($message, $code, $previous);
@@ -38,10 +38,10 @@ 
         $this->details = $details;
     }
     
-   /**
-    * Retrieves the detailed error description, if any.
-    * @return string
-    */
+    /**
+     * Retrieves the detailed error description, if any.
+     * @return string
+     */
     public function getDetails() : string
     {
         if($this->details !== null) {
@@ -51,9 +51,9 @@ 
         return '';
     }
     
-   /**
-    * Displays pertinent information on the exception.
-    */
+    /**
+     * Displays pertinent information on the exception.
+     */
     public function display()
     {
         if(!headers_sent()) {
@@ -63,20 +63,20 @@ 
         echo $this->getInfo();
     }
     
-   /**
-    * Retrieves information on the exception that can be
-    * easily accessed.
-    * 
-    * @return ConvertHelper_ThrowableInfo
-    */
+    /**
+     * Retrieves information on the exception that can be
+     * easily accessed.
+     * 
+     * @return ConvertHelper_ThrowableInfo
+     */
     public function getInfo() : ConvertHelper_ThrowableInfo
     {
         return ConvertHelper::throwable2info($this);
     }
     
-   /**
-    * Dumps a current PHP function trace, as a textonly string.
-    */
+    /**
+     * Dumps a current PHP function trace, as a textonly string.
+     */
     public static function dumpTraceAsString()
     {
         try
@@ -89,9 +89,9 @@ 
         }
     }
 
-   /**
-    * Dumps a current PHP function trace, with HTML styling.
-    */
+    /**
+     * Dumps a current PHP function trace, with HTML styling.
+     */
     public static function dumpTraceAsHTML()
     {
         try
@@ -106,13 +106,13 @@ 
         }
     }
     
-   /**
-    * Creates an exception info instance from a throwable instance.
-    * 
-    * @param \Throwable $e
-    * @return ConvertHelper_ThrowableInfo
-    * @see ConvertHelper::throwable2info()
-    */
+    /**
+     * Creates an exception info instance from a throwable instance.
+     * 
+     * @param \Throwable $e
+     * @return ConvertHelper_ThrowableInfo
+     * @see ConvertHelper::throwable2info()
+     */
     public static function createInfo(\Throwable $e) : ConvertHelper_ThrowableInfo
     {
         return ConvertHelper::throwable2info($e);

src/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/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/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/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/StorageSizeEnum/Size.php

Indentation +18 added lines, -18 removed lines

@@ -25,34 +25,34 @@
  */
 class ConvertHelper_StorageSizeEnum_Size
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $name;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $base;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $exponent;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $singular;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $plural;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $suffix;
     
     public function __construct(string $name, int $base, int $exponent, string $suffix, string $singular, string $plural)

src/ConvertHelper/SizeNotation.php

Indentation +86 added lines, -86 removed lines

@@ -31,9 +31,9 @@ 
     
     const VALIDATION_ERROR_NEGATIVE_VALUE = 43803;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $sizeString;
 
     /**
@@ -41,41 +41,41 @@ 
      */
     protected $sizeDefinition;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $bytes = 0;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $valid = true;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $units = null;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $number = '';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $errorMessage = '';
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $errorCode = 0;
     
-   /**
-    * Create a new instance for the specified size string.
-    * 
-    * @param string $sizeString A size notation in the format "50 MB", or a number of bytes without units. Spaces are ignored, so "50MB" = "50 MB" = "  50   MB   ". Floating point values are accepted, both with dot and comma notation ("50.5" = "50,5"). To use Base 2 values, ose appropriate units, e.g. "50 MiB", "1.5 GiB". The units are case insensitive, so "50 MB" = "50 mb". 
-    */
+    /**
+     * Create a new instance for the specified size string.
+     * 
+     * @param string $sizeString A size notation in the format "50 MB", or a number of bytes without units. Spaces are ignored, so "50MB" = "50 MB" = "  50   MB   ". Floating point values are accepted, both with dot and comma notation ("50.5" = "50,5"). To use Base 2 values, ose appropriate units, e.g. "50 MiB", "1.5 GiB". The units are case insensitive, so "50 MB" = "50 mb". 
+     */
     public function __construct(string $sizeString)
     {
         $this->sizeString = $this->cleanString($sizeString);
@@ -83,31 +83,31 @@ 
         $this->convert();
     }
     
-   /**
-    * Gets the amount of bytes contained in the size notation.
-    * @return int
-    */
+    /**
+     * Gets the amount of bytes contained in the size notation.
+     * @return int
+     */
     public function toBytes() : int
     {
         return $this->bytes;
     }
     
-   /**
-    * Converts the size notation to a human readable string, e.g. "50 MB".
-    * 
-    * @param int $precision
-    * @return string
-    * @see ConvertHelper::bytes2readable()
-    */
+    /**
+     * Converts the size notation to a human readable string, e.g. "50 MB".
+     * 
+     * @param int $precision
+     * @return string
+     * @see ConvertHelper::bytes2readable()
+     */
     public function toString(int $precision=1) : string
     {
         return ConvertHelper::bytes2readable($this->bytes, $precision, $this->getBase());
     }
     
-   /**
-    * Retrieves the detected number's base.
-    * @return int The base number (1000 for Base 10, or 1024 for Base 2), or 0 if it is not valid.
-    */
+    /**
+     * Retrieves the detected number's base.
+     * @return int The base number (1000 for Base 10, or 1024 for Base 2), or 0 if it is not valid.
+     */
     public function getBase() : int
     {
         if($this->isValid()) {
@@ -117,13 +117,13 @@ 
         return 0;
     }
     
-   /**
-    * Retrieves the detected storage size instance, if 
-    * the size string is valid.
-    * 
-    * @return ConvertHelper_StorageSizeEnum_Size|NULL
-    * @see ConvertHelper_StorageSizeEnum_Size
-    */
+    /**
+     * Retrieves the detected storage size instance, if 
+     * the size string is valid.
+     * 
+     * @return ConvertHelper_StorageSizeEnum_Size|NULL
+     * @see ConvertHelper_StorageSizeEnum_Size
+     */
     public function getSizeDefinition() : ?ConvertHelper_StorageSizeEnum_Size
     {
         if($this->isValid()) {
@@ -133,27 +133,27 @@ 
         return null;
     }
     
-   /**
-    * Checks whether the size notation was valid and could be parsed
-    * into a meaningful byte value. If this returns `false`, it is 
-    * possible to use the `getErrorXXX` methods to retrieve information
-    * on what went wrong. 
-    * 
-    * @return bool
-    * @see ConvertHelper_SizeNotation::getErrorMessage()
-    * @see ConvertHelper_SizeNotation::getErrorCode()
-    */
+    /**
+     * Checks whether the size notation was valid and could be parsed
+     * into a meaningful byte value. If this returns `false`, it is 
+     * possible to use the `getErrorXXX` methods to retrieve information
+     * on what went wrong. 
+     * 
+     * @return bool
+     * @see ConvertHelper_SizeNotation::getErrorMessage()
+     * @see ConvertHelper_SizeNotation::getErrorCode()
+     */
     public function isValid() : bool
     {
         return $this->valid;
     }
     
-   /**
-    * Retrieves the error message if the size notation validation failed.
-    * 
-    * @return string
-    * @see ConvertHelper_SizeNotation::getErrorCode()
-    */
+    /**
+     * Retrieves the error message if the size notation validation failed.
+     * 
+     * @return string
+     * @see ConvertHelper_SizeNotation::getErrorCode()
+     */
     public function getErrorMessage() : string
     {
         return $this->errorMessage;
@@ -200,12 +200,12 @@ 
         );
     }
     
-   /**
-    * Detects the units and the number in the size notation string.
-    * Populates the `units` and `number` properties.
-    * 
-    * @return bool Whether the string could be parsed successfully.
-    */
+    /**
+     * Detects the units and the number in the size notation string.
+     * Populates the `units` and `number` properties.
+     * 
+     * @return bool Whether the string could be parsed successfully.
+     */
     protected function detectParts() : bool
     {
         $units = ConvertHelper_StorageSizeEnum::getSizeNames();
@@ -241,16 +241,16 @@ 
         return true;
     }
     
-   /**
-    * If the validation fails, this is used to store the reason for retrieval later.
-    *  
-    * @param string $message
-    * @param int $code
-    * 
-    * @see ConvertHelper_SizeNotation::isValid()
-    * @see ConvertHelper_SizeNotation::getErrorMessage()
-    * @see ConvertHelper_SizeNotation::getErrorCode()
-    */
+    /**
+     * If the validation fails, this is used to store the reason for retrieval later.
+     *  
+     * @param string $message
+     * @param int $code
+     * 
+     * @see ConvertHelper_SizeNotation::isValid()
+     * @see ConvertHelper_SizeNotation::getErrorMessage()
+     * @see ConvertHelper_SizeNotation::getErrorCode()
+     */
     protected function setError(string $message, int $code) : void
     {
         $this->valid = false;
@@ -258,12 +258,12 @@ 
         $this->errorCode = $code;
     }
     
-   /**
-    * Retrieves the error code, if the size notation validation failed.
-    * 
-    * @return int
-    * @see ConvertHelper_SizeNotation::getErrorMessage()
-    */
+    /**
+     * Retrieves the error code, if the size notation validation failed.
+     * 
+     * @return int
+     * @see ConvertHelper_SizeNotation::getErrorMessage()
+     */
     public function getErrorCode() : int
     {
         return $this->errorCode;