Mistralys / application-utils

src/JSHelper.php

Indentation +99 added lines, -99 removed lines

@@ -26,48 +26,48 @@ 
  */
 class JSHelper
 {
-   /**
-    * Quote style using single quotes.
-    * @var integer
-    */
+    /**
+     * Quote style using single quotes.
+     * @var integer
+     */
     const QUOTE_STYLE_SINGLE = 1;
     
-   /**
-    * Quote style using double quotes.
-    * @var integer
-    */
+    /**
+     * Quote style using double quotes.
+     * @var integer
+     */
     const QUOTE_STYLE_DOUBLE = 2;
 
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected static $variableCache = array();
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected static $elementCounter = 0;
 
-   /**
-    * @var string
-    */    
+    /**
+     * @var string
+     */    
     protected static $idPrefix = 'E';
     
-   /**
-    * Builds a javascript statement. The first parameter is the
-    * javascript function to call, any additional parameters are
-    * used as arguments for the javascript function call. Variable
-    * types are automagically converted to the javascript equivalents.
-    *
-    * Examples:
-    *
-    * // add an alert(); statement:
-    * JSHelper::buildStatement('alert');
-    *
-    * // add an alert('Alert text'); statement
-    * JSHelper::buildStatement('alert', 'Alert text');
-    *
-    */
+    /**
+     * Builds a javascript statement. The first parameter is the
+     * javascript function to call, any additional parameters are
+     * used as arguments for the javascript function call. Variable
+     * types are automagically converted to the javascript equivalents.
+     *
+     * Examples:
+     *
+     * // add an alert(); statement:
+     * JSHelper::buildStatement('alert');
+     *
+     * // add an alert('Alert text'); statement
+     * JSHelper::buildStatement('alert', 'Alert text');
+     *
+     */
     public static function buildStatement() : string
     {
         $args = func_get_args();
@@ -75,13 +75,13 @@ 
         return call_user_func_array(array(self::class, 'buildStatementQuoteStyle'), $args);
     }
     
-   /**
-    * Like {@link JSHelper::buildStatement()}, but using single quotes
-    * to make it possible to use the statement in an HTML tag attribute.
-    * 
-    * @return string
-    * @see JSHelper::buildStatement()
-    */
+    /**
+     * Like {@link JSHelper::buildStatement()}, but using single quotes
+     * to make it possible to use the statement in an HTML tag attribute.
+     * 
+     * @return string
+     * @see JSHelper::buildStatement()
+     */
     public static function buildStatementAttribute() : string
     {
         $args = func_get_args();
@@ -111,39 +111,39 @@ 
         return $call . ');';
     }
 
-   /**
-    * Builds a set variable statement. The variable value is
-    * automatically converted to the javascript equivalent.
-    *
-    * Examples:
-    *
-    * // foo = 'bar';
-    * JSHelper::buildVariable('foo', 'bar');
-    *
-    * // foo = 42;
-    * JSHelper::buildVariable('foo', 42);
-    *
-    * // foo = true;
-    * JSHelper::buildVariable('foo', true);
-    *
-    * @param string $varName
-    * @param mixed $varValue
-    * @return string
-    */
+    /**
+     * Builds a set variable statement. The variable value is
+     * automatically converted to the javascript equivalent.
+     *
+     * Examples:
+     *
+     * // foo = 'bar';
+     * JSHelper::buildVariable('foo', 'bar');
+     *
+     * // foo = 42;
+     * JSHelper::buildVariable('foo', 42);
+     *
+     * // foo = true;
+     * JSHelper::buildVariable('foo', true);
+     *
+     * @param string $varName
+     * @param mixed $varValue
+     * @return string
+     */
     public static function buildVariable(string $varName, $varValue) : string
     {
         return $varName . "=" . self::phpVariable2JS($varValue) . ';';
     }
     
-   /**
-    * Converts a PHP variable to its javascript equivalent. Note that
-    * if a variable cannot be converted (like a PHP resource), this will
-    * return a javascript "null".
-    *
-    * @param mixed $variable
-    * @param int $quoteStyle The quote style to use for strings
-    * @return string
-    */
+    /**
+     * Converts a PHP variable to its javascript equivalent. Note that
+     * if a variable cannot be converted (like a PHP resource), this will
+     * return a javascript "null".
+     *
+     * @param mixed $variable
+     * @param int $quoteStyle The quote style to use for strings
+     * @return string
+     */
     public static function phpVariable2JS($variable, int $quoteStyle=self::QUOTE_STYLE_DOUBLE) : string
     {
         // after much profiling, this variant of the method offers
@@ -221,26 +221,26 @@ 
         return $result;
     }
     
-   /**
-    * Converts a variable to a JS string that can be 
-    * used in an HTML attribute: it uses single quotes
-    * instead of the default double quotes.
-    * 
-    * @param mixed $variable
-    * @return string
-    */
+    /**
+     * Converts a variable to a JS string that can be 
+     * used in an HTML attribute: it uses single quotes
+     * instead of the default double quotes.
+     * 
+     * @param mixed $variable
+     * @return string
+     */
     public static function phpVariable2AttributeJS($variable) : string
     {
         return self::phpVariable2JS($variable, self::QUOTE_STYLE_SINGLE);
     }
 
-   /**
-    * Generates a dynamic element ID to be used with dynamically generated
-    * HTML code to tie in with clientside javascript when compact but unique
-    * IDs are needed in a  request.
-    *
-    * @return string
-    */
+    /**
+     * Generates a dynamic element ID to be used with dynamically generated
+     * HTML code to tie in with clientside javascript when compact but unique
+     * IDs are needed in a  request.
+     *
+     * @return string
+     */
     public static function nextElementID() : string
     {
         self::$elementCounter++;
@@ -248,33 +248,33 @@ 
         return self::$idPrefix . self::$elementCounter;
     }
     
-   /**
-    * Retrieves the ID prefix currently used.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the ID prefix currently used.
+     * 
+     * @return string
+     */
     public static function getIDPrefix() : string
     {
         return self::$idPrefix;
     }
     
-   /**
-    * Retrieves the value of the internal elements counter.
-    * 
-    * @return integer
-    */
+    /**
+     * Retrieves the value of the internal elements counter.
+     * 
+     * @return integer
+     */
     public static function getElementCounter() : int
     {
         return self::$elementCounter;
     }
     
-   /**
-    * Sets the prefix that is added in front of all IDs
-    * retrieved using the {@link nextElementID()} method.
-    * 
-    * @param string $prefix
-    * @see JSHelper::nextElementID()
-    */
+    /**
+     * Sets the prefix that is added in front of all IDs
+     * retrieved using the {@link nextElementID()} method.
+     * 
+     * @param string $prefix
+     * @see JSHelper::nextElementID()
+     */
     public static function setIDPrefix(string $prefix)
     {
         self::$idPrefix = $prefix;

src/PaginationHelper.php

Indentation +115 added lines, -115 removed lines

@@ -24,56 +24,56 @@ 
  */
 class PaginationHelper
 {
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $total;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $perPage;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $current;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $next = 0;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $prev = 0;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $last = 0; 
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $adjacentPages = 3;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $offsetEnd = 0;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $offsetStart = 0;
     
-   /**
-    * @param int $totalItems The total amount of items available.
-    * @param int $itemsPerPage How many items to display per page.
-    * @param int $currentPage The current page number (1-based)
-    */
+    /**
+     * @param int $totalItems The total amount of items available.
+     * @param int $itemsPerPage How many items to display per page.
+     * @param int $currentPage The current page number (1-based)
+     */
     public function __construct(int $totalItems, int $itemsPerPage, int $currentPage)
     {
         $this->total = $totalItems;
@@ -83,34 +83,34 @@ 
         $this->calculate();
     }
     
-   /**
-    * Sets the amount of adjacent pages to display next to the
-    * current one when using the pages list.
-    *
-    * @param int $amount
-    * @return PaginationHelper
-    */
+    /**
+     * Sets the amount of adjacent pages to display next to the
+     * current one when using the pages list.
+     *
+     * @param int $amount
+     * @return PaginationHelper
+     */
     public function setAdjacentPages(int $amount) : PaginationHelper
     {
         $this->adjacentPages = $amount;
         return $this;
     }
     
-   /**
-    * Whether there is a next page after the current page.
-    * @return bool
-    */
+    /**
+     * Whether there is a next page after the current page.
+     * @return bool
+     */
     public function hasNextPage() : bool
     {
         return $this->next > 0;
     }
     
-   /**
-    * The next page number. Returns the last page
-    * number if there is no next page.
-    *  
-    * @return int
-    */
+    /**
+     * The next page number. Returns the last page
+     * number if there is no next page.
+     *  
+     * @return int
+     */
     public function getNextPage() : int
     {
         if($this->next === 0) {
@@ -120,21 +120,21 @@ 
         return $this->next;
     }
     
-   /**
-    * Whether there is a previous page before the current page.
-    * @return bool
-    */
+    /**
+     * Whether there is a previous page before the current page.
+     * @return bool
+     */
     public function hasPreviousPage() : bool
     {
         return $this->prev > 0;
     }
     
-   /**
-    * The previous page number. Returns the first page
-    * number if there is no previous page.
-    * 
-    * @return int
-    */
+    /**
+     * The previous page number. Returns the first page
+     * number if there is no previous page.
+     * 
+     * @return int
+     */
     public function getPreviousPage() : int
     {
         if($this->prev === 0) {
@@ -144,21 +144,21 @@ 
         return $this->prev;
     }
     
-   /**
-    * Retrieves the last page number.
-    * @return int
-    */
+    /**
+     * Retrieves the last page number.
+     * @return int
+     */
     public function getLastPage() : int
     {
         return $this->last;
     }
     
-   /**
-    * Whether there is more than one page, i.e. whether
-    * pagination is required at all.
-    *  
-    * @return bool
-    */
+    /**
+     * Whether there is more than one page, i.e. whether
+     * pagination is required at all.
+     *  
+     * @return bool
+     */
     public function hasPages() : bool
     {
         return $this->last > 1;
@@ -169,12 +169,12 @@ 
         return $this->current;
     }
     
-   /**
-    * Retrieves a list of page numbers for a page
-    * navigator, to quickly jump between pages.
-    *
-    * @return int[]
-    */
+    /**
+     * Retrieves a list of page numbers for a page
+     * navigator, to quickly jump between pages.
+     *
+     * @return int[]
+     */
     public function getPageNumbers() : array
     {
         $adjacent = $this->adjacentPages;
@@ -250,66 +250,66 @@ 
         return $numbers;
     }
     
-   /**
-    * Whether the specified page number is the current page.
-    * 
-    * @param int $pageNumber
-    * @return bool
-    */
+    /**
+     * Whether the specified page number is the current page.
+     * 
+     * @param int $pageNumber
+     * @return bool
+     */
     public function isCurrentPage(int $pageNumber) : bool
     {
         return $pageNumber === $this->current;
     }
     
-   /**
-    * Retrieves the 1-based starting offset of
-    * items currently displayed in the page.
-    * 
-    * Note: Use this to create a text like 
-    * "showing entries x to y".
-    * 
-    * @return int
-    * @see PaginationHelper::getOffsetEnd()
-    */
+    /**
+     * Retrieves the 1-based starting offset of
+     * items currently displayed in the page.
+     * 
+     * Note: Use this to create a text like 
+     * "showing entries x to y".
+     * 
+     * @return int
+     * @see PaginationHelper::getOffsetEnd()
+     */
     public function getItemsStart() : int
     {
         return $this->getOffsetStart() + 1;
     }
 
-   /**
-    * Retrieves the 1-based ending offset of
-    * items currently displayed in the page.
-    * 
-    * Note: Use this to create a text like 
-    * "showing entries x to y".
-    * 
-    * @return int
-    * @see PaginationHelper::getOffsetStart()
-    */
+    /**
+     * Retrieves the 1-based ending offset of
+     * items currently displayed in the page.
+     * 
+     * Note: Use this to create a text like 
+     * "showing entries x to y".
+     * 
+     * @return int
+     * @see PaginationHelper::getOffsetStart()
+     */
     public function getItemsEnd() : int
     {
         return $this->getOffsetEnd() + 1;
     }
     
-   /**
-    * Retrieves the 0-based starting offset of
-    * items currently displayed in the page.
-    * 
-    * @return int
-    * @see PaginationHelper::getItemsStart()
-    */
+    /**
+     * Retrieves the 0-based starting offset of
+     * items currently displayed in the page.
+     * 
+     * @return int
+     * @see PaginationHelper::getItemsStart()
+     */
     public function getOffsetStart() : int
     {
         return $this->offsetStart;
     }
     
-   /**
-    * Retrieves the 0-based ending offset of
-    * items currently displayed in the page.
-    * 
-    * @return int
-    * @see PaginationHelper::getItemsEnd()
-    */
+    /**
+     * Retrieves the 0-based ending offset of
+     * items currently displayed in the page.
+     * 
+     * @return int
+     * @see PaginationHelper::getItemsEnd()
+     */
     public function getOffsetEnd() : int
     {
         return $this->offsetEnd;

src/SVNHelper/Target.php

Indentation +45 added lines, -45 removed lines

@@ -76,10 +76,10 @@ 
         return $this instanceof SVNHelper_Target_Folder;
     }
     
-   /**
-    * Runs an update of the file or folder.
-    * @return SVNHelper_Command_Update
-    */
+    /**
+     * Runs an update of the file or folder.
+     * @return SVNHelper_Command_Update
+     */
     public function runUpdate()
     {
         $cmd = $this->createUpdate();
@@ -88,55 +88,55 @@ 
         return $cmd;
     }
     
-   /**
-    * Creates an update command instance for the target file or folder.
-    * @return SVNHelper_Command_Update
-    */
+    /**
+     * Creates an update command instance for the target file or folder.
+     * @return SVNHelper_Command_Update
+     */
     public function createUpdate()
     {
         return $this->helper->createUpdate($this);
     }
     
-   /**
-    * Creates a status command instance for the target file or folder.
-    * @return SVNHelper_Command_Status
-    */
+    /**
+     * Creates a status command instance for the target file or folder.
+     * @return SVNHelper_Command_Status
+     */
     public function createStatus()
     {
         return $this->helper->createStatus($this);
     }
     
-   /**
-    * Creates an info command instance for the target file or folder.
-    * @return SVNHelper_Command_Info
-    */
+    /**
+     * Creates an info command instance for the target file or folder.
+     * @return SVNHelper_Command_Info
+     */
     public function createInfo()
     {
         return $this->helper->createInfo($this);
     }
     
-   /**
-    * Creates a commit command instance for the target file or folder.
-    * @param string $message
-    * @return SVNHelper_Command_Commit
-    */
+    /**
+     * Creates a commit command instance for the target file or folder.
+     * @param string $message
+     * @return SVNHelper_Command_Commit
+     */
     public function createCommit($message)
     {
         return $this->helper->createCommit($this, $message);
     }
 
-   /**
-    * Creates an add command instance for the target file or folder.
-    * @return SVNHelper_Command_Add
-    */
+    /**
+     * Creates an add command instance for the target file or folder.
+     * @return SVNHelper_Command_Add
+     */
     public function createAdd()
     {
         return $this->helper->createAdd($this);
     }
     
-   /**
-    * @return SVNHelper_Command_Status
-    */
+    /**
+     * @return SVNHelper_Command_Status
+     */
     public function getStatus()
     {
         $cmd = $this->createStatus();
@@ -154,10 +154,10 @@ 
         return $this;
     }
     
-   /**
-    * Whether the target is versioned or needs to be added.
-    * @return boolean
-    */
+    /**
+     * Whether the target is versioned or needs to be added.
+     * @return boolean
+     */
     public function isVersioned()
     {
         return $this->getInfo()->isVersioned();
@@ -170,10 +170,10 @@ 
         $this->cache = array();
     }
     
-   /**
-    * Retrieves information on the target.
-    * @return SVNHelper_Command_Info
-    */
+    /**
+     * Retrieves information on the target.
+     * @return SVNHelper_Command_Info
+     */
     public function getInfo()
     {
         if(!isset($this->cache['info'])) {
@@ -183,15 +183,15 @@ 
         return $this->cache['info'];
     }
     
-   /**
-    * Commits the target file or folder. If it has
-    * not been added to the repository yet, it is 
-    * added automatically beforehand. If it does
-    * not need to be committed, no changes are made.
-    * 
-    * @param string $message
-    * @return SVNHelper_Target
-    */
+    /**
+     * Commits the target file or folder. If it has
+     * not been added to the repository yet, it is 
+     * added automatically beforehand. If it does
+     * not need to be committed, no changes are made.
+     * 
+     * @param string $message
+     * @return SVNHelper_Target
+     */
     public function runCommit($message)
     {
         if(!$this->isVersioned()) {

src/SVNHelper/Command.php

Indentation +24 added lines, -24 removed lines

@@ -21,18 +21,18 @@ 
     const SVN_ERROR_TYPE_WARNING = 'warning';
     
     /**
-    * @var SVNHelper
-    */
+     * @var SVNHelper
+     */
     protected $helper;
     
-   /**
-    * @var SVNHelper_Target
-    */
+    /**
+     * @var SVNHelper_Target
+     */
     protected $target;
     
-   /**
-    * @var SVNHelper_CommandResult
-    */
+    /**
+     * @var SVNHelper_CommandResult
+     */
     protected $result;
     
     public function __construct(SVNHelper $helper, SVNHelper_Target $target)
@@ -41,9 +41,9 @@ 
         $this->target = $target;
     }
     
-   /**
-    * @return SVNHelper
-    */
+    /**
+     * @return SVNHelper
+     */
     public function getSVN()
     {
         return $this->helper;
@@ -99,15 +99,15 @@ 
         return $cmd;
     }
 
-   /**
-    * Executes the specified command, and returns a result
-    * instance to read the results.
-    * 
-    * @param string $mode The command mode, e.g. commit / update...
-    * @param string $path The path to apply the command to
-    * @param array $params
-    * @return SVNHelper_CommandResult
-    */
+    /**
+     * Executes the specified command, and returns a result
+     * instance to read the results.
+     * 
+     * @param string $mode The command mode, e.g. commit / update...
+     * @param string $path The path to apply the command to
+     * @param array $params
+     * @return SVNHelper_CommandResult
+     */
     protected function execCommand($mode, $path=null, $params=array())
     {
         $relative = $this->helper->relativizePath($path);
@@ -194,10 +194,10 @@ 
         return $this->result;
     }
     
-   /**
-    * Retrieves the type of command, e.g. "Commit"
-    * @return string
-    */
+    /**
+     * Retrieves the type of command, e.g. "Commit"
+     * @return string
+     */
     public function getType()
     {
         return str_replace('SVNHelper_Command_', '', get_class($this));   

src/SVNHelper/Command/Info.php

Indentation +6 added lines, -6 removed lines

@@ -44,12 +44,12 @@
         return $result;
     }
     
-   /**
-    * Whether the file or folder has already been committed
-    * and has no pending changes.
-    * 
-    * @return boolean
-    */
+    /**
+     * Whether the file or folder has already been committed
+     * and has no pending changes.
+     * 
+     * @return boolean
+     */
     public function isCommitted()
     {
         $status = $this->target->getStatus();

src/SVNHelper/Command/Update.php

Indentation +12 added lines, -12 removed lines

@@ -28,17 +28,17 @@ 
         return $result;
     }
     
-   /**
-    * @var SVNHelper_Command_Update_Status[]
-    */
+    /**
+     * @var SVNHelper_Command_Update_Status[]
+     */
     protected $stati;
     
     protected $revision;
     
-   /**
-    * Parses the command output to find out which files have been modified, and how.
-    * @param SVNHelper_CommandResult $result
-    */
+    /**
+     * Parses the command output to find out which files have been modified, and how.
+     * @param SVNHelper_CommandResult $result
+     */
     protected function parseResult(SVNHelper_CommandResult $result)
     {
         $this->stati = array();
@@ -119,11 +119,11 @@ 
         return $this->getByStatus('a');
     }
     
-   /**
-    * Whether there were files with the specified status code.
-    * @param string $status
-    * @return boolean
-    */
+    /**
+     * Whether there were files with the specified status code.
+     * @param string $status
+     * @return boolean
+     */
     protected function hasStatus($status)
     {
         $this->execute();

src/SVNHelper/Command/Status.php

Indentation +8 added lines, -8 removed lines

@@ -24,10 +24,10 @@ 
     
     const STATUS_FILETYPE_CHANGE = 'filetype-change';
     
-   /**
-    * @var array
-    * @see http://svnbook.red-bean.com/en/1.7/svn.ref.svn.c.status.html
-    */
+    /**
+     * @var array
+     * @see http://svnbook.red-bean.com/en/1.7/svn.ref.svn.c.status.html
+     */
     protected static $knownStati = array(
         'a' => self::STATUS_ADD,
         'd' => self::STATUS_DELETE,
@@ -40,9 +40,9 @@ 
         '~' => self::STATUS_FILETYPE_CHANGE,
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $status;
     
     protected function _execute()
@@ -65,7 +65,7 @@ 
             
             $svnStatusCode = strtolower(substr($lines[0], 0, 1));
             if(isset(self::$knownStati[$svnStatusCode])) {
-               $this->status = self::$knownStati[$svnStatusCode];
+                $this->status = self::$knownStati[$svnStatusCode];
             }
         }
         

src/ConvertHelper/StringMatch.php

Indentation +8 added lines, -8 removed lines

@@ -33,19 +33,19 @@
         $this->match = $matchedString;
     }
     
-   /**
-    * The zero-based start position of the string in the haystack.
-    * @return int
-    */
+    /**
+     * The zero-based start position of the string in the haystack.
+     * @return int
+     */
     public function getPosition() : int
     {
         return $this->position;
     }
     
-   /**
-    * The exact string that was matched, respecting the case as found in needle.
-    * @return string
-    */
+    /**
+     * The exact string that was matched, respecting the case as found in needle.
+     * @return string
+     */
     public function getMatchedString() : string
     {
         return $this->match;

src/XMLHelper/SimpleXML/Error.php

Indentation +3 added lines, -3 removed lines

@@ -6,9 +6,9 @@
 {
     protected $xml;
     
-   /**
-    * @var  \LibXMLError
-    */
+    /**
+     * @var  \LibXMLError
+     */
     protected $nativeError;
     
     public function __construct(XMLHelper_SimpleXML $xml, \LibXMLError $nativeError)