Mistralys / application-utils

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/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/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)

src/IniHelper/Line.php

Indentation +18 added lines, -18 removed lines

@@ -38,38 +38,38 @@
      */
     protected $text;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $trimmed;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $lineNumber;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $varName = '';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $varValue = '';
     
     protected $valueUnquoted = '';
     
     protected $quoteStyle = '';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $sectionName = '';
     
     public function __construct(string $text, int $lineNumber)

src/IniHelper/Section.php

Indentation +65 added lines, -65 removed lines

@@ -21,19 +21,19 @@ 
  */
 class IniHelper_Section
 {
-   /**
-    * @var IniHelper
-    */
+    /**
+     * @var IniHelper
+     */
     protected $ini;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $name;
     
-   /**
-    * @var IniHelper_Line[]
-    */
+    /**
+     * @var IniHelper_Line[]
+     */
     protected $lines = array();
     
     public function __construct(IniHelper $ini, string $name)
@@ -42,33 +42,33 @@ 
         $this->name = $name;
     }
     
-   /**
-    * The section's name.
-    * @return string
-    */
+    /**
+     * The section's name.
+     * @return string
+     */
     public function getName() : string
     {
         return $this->name;
     }
     
-   /**
-    * Whether this is the default section: this 
-    * is used internally to store all variables that
-    * are not in any specific section.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether this is the default section: this 
+     * is used internally to store all variables that
+     * are not in any specific section.
+     * 
+     * @return bool
+     */
     public function isDefault() : bool
     {
         return $this->name === IniHelper::SECTION_DEFAULT;
     }
     
-   /**
-    * Adds a line instance to the section.
-    * 
-    * @param IniHelper_Line $line
-    * @return IniHelper_Section
-    */
+    /**
+     * Adds a line instance to the section.
+     * 
+     * @param IniHelper_Line $line
+     * @return IniHelper_Section
+     */
     public function addLine(IniHelper_Line $line) : IniHelper_Section
     {
         $this->lines[] = $line;
@@ -76,12 +76,12 @@ 
         return $this;
     }
     
-   /**
-    * Converts the values contained in the section into 
-    * an associative array.
-    * 
-    * @return array
-    */
+    /**
+     * Converts the values contained in the section into 
+     * an associative array.
+     * 
+     * @return array
+     */
     public function toArray() : array
     {
         $result = array();
@@ -114,11 +114,11 @@ 
         return $result;
     }
     
-   /**
-    * Converts the section's lines into an INI string.
-    * 
-    * @return string
-    */
+    /**
+     * Converts the section's lines into an INI string.
+     * 
+     * @return string
+     */
     public function toString()
     {
         $lines = array();
@@ -140,12 +140,12 @@ 
         return implode($this->ini->getEOLChar(), $lines);
     }
 
-   /**
-    * Deletes a line from the section.
-    * 
-    * @param IniHelper_Line $toDelete
-    * @return IniHelper_Section
-    */
+    /**
+     * Deletes a line from the section.
+     * 
+     * @param IniHelper_Line $toDelete
+     * @return IniHelper_Section
+     */
     public function deleteLine(IniHelper_Line $toDelete) : IniHelper_Section
     {
         $keep = array();
@@ -162,13 +162,13 @@ 
         return $this;
     }
     
-   /**
-    * Sets the value of a variable, overwriting any existing value.
-    * 
-    * @param string $name
-    * @param mixed $value If an array is specified, it is treated as duplicate keys and will add a line for each value.
-    * @return IniHelper_Section
-    */
+    /**
+     * Sets the value of a variable, overwriting any existing value.
+     * 
+     * @param string $name
+     * @param mixed $value If an array is specified, it is treated as duplicate keys and will add a line for each value.
+     * @return IniHelper_Section
+     */
     public function setValue(string $name, $value) : IniHelper_Section
     {
         $lines = $this->getLinesByVariable($name);
@@ -229,15 +229,15 @@ 
         return $this;
     }
     
-   /**
-    * Adds a variable value to the section. Unlike setValue(), this
-    * will not overwrite any existing value. If the name is an existing
-    * variable name, it will be converted to duplicate keys.
-    * 
-    * @param string $name
-    * @param mixed $value If this is an array, it will be treated as duplicate keys, and all values that are not present yet will be added.
-    * @return IniHelper_Section
-    */
+    /**
+     * Adds a variable value to the section. Unlike setValue(), this
+     * will not overwrite any existing value. If the name is an existing
+     * variable name, it will be converted to duplicate keys.
+     * 
+     * @param string $name
+     * @param mixed $value If this is an array, it will be treated as duplicate keys, and all values that are not present yet will be added.
+     * @return IniHelper_Section
+     */
     public function addValue(string $name, $value) : IniHelper_Section
     {
         // array value? Treat it as duplicate keys.
@@ -295,12 +295,12 @@ 
     }
     
     
-   /**
-    * Retrieves all lines for the specified variable name.
-    *  
-    * @param string $name
-    * @return \AppUtils\IniHelper_Line[]
-    */
+    /**
+     * Retrieves all lines for the specified variable name.
+     *  
+     * @param string $name
+     * @return \AppUtils\IniHelper_Line[]
+     */
     public function getLinesByVariable(string $name)
     {
         $result = array();

examples/URLInfo/highlighting.php

Indentation +3 added lines, -3 removed lines

@@ -7,9 +7,9 @@
  * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
  */
 
-   /**
-    * Examples environment config
-    */
+    /**
+     * Examples environment config
+     */
     require_once '../prepend.php';
 
     use function AppUtils\parseURL;