Mistralys / application-utils

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();