Mistralys / application-utils

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

src/FileHelper/PHPClassInfo.php

Indentation +46 added lines, -46 removed lines

@@ -36,17 +36,17 @@ 
     
     protected $classes = array();
     
-   /**
-    * The namespace detected in the file, if any.
-    * @var string
-    */
+    /**
+     * The namespace detected in the file, if any.
+     * @var string
+     */
     protected $namespace = '';
     
-   /**
-    * @param string $path The path to the PHP file to parse.
-    * @throws FileHelper_Exception
-    * @see FileHelper::findPHPClasses()
-    */
+    /**
+     * @param string $path The path to the PHP file to parse.
+     * @throws FileHelper_Exception
+     * @see FileHelper::findPHPClasses()
+     */
     public function __construct(string $path)
     {
         $this->path = realpath($path);
@@ -66,66 +66,66 @@ 
         $this->parseFile();
     }
     
-   /**
-    * The name of the namespace of the classes in the file, if any.
-    * @return string
-    */
+    /**
+     * The name of the namespace of the classes in the file, if any.
+     * @return string
+     */
     public function getNamespace() : string
     {
         return $this->namespace;
     }
     
-   /**
-    * Whether the file contains a namespace.
-    * @return bool
-    */
+    /**
+     * Whether the file contains a namespace.
+     * @return bool
+     */
     public function hasNamespace() : bool
     {
         return !empty($this->namespace);
     }
     
-   /**
-    * The absolute path to the file.
-    * @return string
-    */
+    /**
+     * The absolute path to the file.
+     * @return string
+     */
     public function getPath() : string
     {
         return $this->path;
     }
    
-   /**
-    * Whether any classes were found in the file.
-    * @return bool
-    */
+    /**
+     * Whether any classes were found in the file.
+     * @return bool
+     */
     public function hasClasses() : bool
     {
         return !empty($this->classes);
     }
     
-   /**
-    * The names of the classes that were found in the file (with namespace if any).
-    * @return string[]
-    */
+    /**
+     * The names of the classes that were found in the file (with namespace if any).
+     * @return string[]
+     */
     public function getClassNames() : array
     {
         return array_keys($this->classes);
     }
     
-   /**
-    * Retrieves all classes that were detected in the file,
-    * which can be used to retrieve more information about
-    * them.
-    * 
-    * @return FileHelper_PHPClassInfo_Class[]
-    */
+    /**
+     * Retrieves all classes that were detected in the file,
+     * which can be used to retrieve more information about
+     * them.
+     * 
+     * @return FileHelper_PHPClassInfo_Class[]
+     */
     public function getClasses()
     {
         return $this->classes;
     }
     
-   /**
-    * @throws FileHelper_Exception
-    */
+    /**
+     * @throws FileHelper_Exception
+     */
     protected function parseFile()
     {
         $code = file_get_contents($this->path);
@@ -180,13 +180,13 @@ 
         }
     }
     
-   /**
-    * Strips all whitespace from the string, replacing it with 
-    * regular spaces (newlines, tabs, etc.).
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Strips all whitespace from the string, replacing it with 
+     * regular spaces (newlines, tabs, etc.).
+     * 
+     * @param string $string
+     * @return string
+     */
     protected function stripWhitespace(string $string) : string 
     {
         return preg_replace('/[\s]/', ' ', $string);

src/FileHelper/PHPClassInfo/Class.php

Indentation +70 added lines, -70 removed lines

@@ -22,51 +22,51 @@ 
  */
 class FileHelper_PHPClassInfo_Class 
 {
-   /**
-    * @var FileHelper_PHPClassInfo
-    */
+    /**
+     * @var FileHelper_PHPClassInfo
+     */
     protected $info;
 
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $abstract = false;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $final = false;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $extends = '';
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $implements = array();
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $name;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $declaration;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $keyword;
     
-   /**
-    * @param FileHelper_PHPClassInfo $info The class info instance.
-    * @param string $declaration The full class declaration, e.g. "class SomeName extends SomeOtherClass".
-    * @param string $keyword The class keyword, if any, i.e. "abstract" or "final".
-    */
+    /**
+     * @param FileHelper_PHPClassInfo $info The class info instance.
+     * @param string $declaration The full class declaration, e.g. "class SomeName extends SomeOtherClass".
+     * @param string $keyword The class keyword, if any, i.e. "abstract" or "final".
+     */
     public function __construct(FileHelper_PHPClassInfo $info, string $declaration, string $keyword)
     {
         $this->info = $info;
@@ -76,31 +76,31 @@ 
         $this->analyzeCode();
     }
     
-   /**
-    * Check if this class is a subclass of the specified
-    * class name.
-    * 
-    * @param string $className
-    * @return bool
-    */
+    /**
+     * Check if this class is a subclass of the specified
+     * class name.
+     * 
+     * @param string $className
+     * @return bool
+     */
     public function isSublassOf(string $className) : bool
     {
         return is_subclass_of($this->getNameNS(), $className);
     }
     
-   /**
-    * The class name without namespace.
-    * @return string
-    */
+    /**
+     * The class name without namespace.
+     * @return string
+     */
     public function getName() : string
     {
         return $this->name;
     }
     
-   /**
-    * The absolute class name with namespace (if any).
-    * @return string
-    */
+    /**
+     * The absolute class name with namespace (if any).
+     * @return string
+     */
     public function getNameNS() : string
     {
         $name = $this->getName();
@@ -112,48 +112,48 @@ 
         return $name;
     }
     
-   /**
-    * Whether it is an abstract class.
-    * @return bool
-    */
+    /**
+     * Whether it is an abstract class.
+     * @return bool
+     */
     public function isAbstract() : bool
     {
         return $this->abstract;
     }
     
-   /**
-    * Whether it is a final class.
-    * @return bool
-    */
+    /**
+     * Whether it is a final class.
+     * @return bool
+     */
     public function isFinal() : bool
     {
         return $this->final;
     }
 
-   /**
-    * The name of the class that this class extends (with namespace, if specified).
-    * @return string
-    */
+    /**
+     * The name of the class that this class extends (with namespace, if specified).
+     * @return string
+     */
     public function getExtends() : string
     {
         return $this->extends;
     }
     
-   /**
-    * A list of interfaces the class implements, if any.
-    * @return array
-    */
+    /**
+     * A list of interfaces the class implements, if any.
+     * @return array
+     */
     public function getImplements() : array
     {
         return $this->implements;
     }
     
-   /**
-    * The class declaration string, with normalized spaces and sorted interface names.
-    * NOTE: does not include the keyword "abstract" or "final".
-    * 
-    * @return string
-    */
+    /**
+     * The class declaration string, with normalized spaces and sorted interface names.
+     * NOTE: does not include the keyword "abstract" or "final".
+     * 
+     * @return string
+     */
     public function getDeclaration() : string
     {
         $parts = array();
@@ -173,10 +173,10 @@ 
         return implode(' ', $parts);
     }
     
-   /**
-    * The keyword before "class", e.g. "abstract".
-    * @return string
-    */
+    /**
+     * The keyword before "class", e.g. "abstract".
+     * @return string
+     */
     public function getKeyword() : string
     {
         return $this->keyword;

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;

examples/prepend.php

Indentation +15 added lines, -15 removed lines

@@ -17,33 +17,33 @@
         die('<b>ERROR:</b> Autoloader not present. Run composer update first.');
     }
     
-   /**
-    * The composer autoloader
-    */
+    /**
+     * The composer autoloader
+     */
     require_once $autoload;
 
-   /**
-    * Translation global function.
-    * @return string
-    */
+    /**
+     * Translation global function.
+     * @return string
+     */
     function t()
     {
         return call_user_func_array('\AppLocalize\t', func_get_args());
     }
     
-   /**
-    * Translation global function.
-    * @return string
-    */
+    /**
+     * Translation global function.
+     * @return string
+     */
     function pt()
     {
         return call_user_func_array('\AppLocalize\pt', func_get_args());
     }
     
-   /**
-    * Translation global function.
-    * @return string
-    */
+    /**
+     * Translation global function.
+     * @return string
+     */
     function pts()
     {
         return call_user_func_array('\AppLocalize\pts', func_get_args());

src/CSVHelper.php

Indentation +130 added lines, -130 removed lines

@@ -50,20 +50,20 @@ 
         
     }
 
-   /**
-    * Creates and returns a new instance of the CSV builder which
-    * can be used to build CSV from scratch.
-    * 
-    * @return CSVHelper_Builder
-    */
+    /**
+     * Creates and returns a new instance of the CSV builder which
+     * can be used to build CSV from scratch.
+     * 
+     * @return CSVHelper_Builder
+     */
     public static function createBuilder()
     {
         return new CSVHelper_Builder();
     }
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $csv = '';
     
     protected $data = array();
@@ -72,16 +72,16 @@ 
     
     protected $headersPosition = self::HEADERS_NONE;
     
-   /**
-    * Loads CSV data from a string. 
-    * 
-    * Note: Use the {@link hasErrors()} method to 
-    * check if the string could be parsed correctly
-    * afterwards.
-    * 
-    * @param string $string
-    * @return CSVHelper
-    */
+    /**
+     * Loads CSV data from a string. 
+     * 
+     * Note: Use the {@link hasErrors()} method to 
+     * check if the string could be parsed correctly
+     * afterwards.
+     * 
+     * @param string $string
+     * @return CSVHelper
+     */
     public function loadString($string)
     {
         // remove any UTF byte order marks that may still be present in the string
@@ -95,20 +95,20 @@ 
         return $this;
     }
     
-   /**
-    * Loads CSV data from a file.
-    * 
-    * Note: Use the {@link hasErrors()} method to 
-    * check if the string could be parsed correctly
-    * afterwards.
-    * 
-    * @param string $file
-    * @throws FileHelper_Exception
-    * @return CSVHelper
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
-    */
+    /**
+     * Loads CSV data from a file.
+     * 
+     * Note: Use the {@link hasErrors()} method to 
+     * check if the string could be parsed correctly
+     * afterwards.
+     * 
+     * @param string $file
+     * @throws FileHelper_Exception
+     * @return CSVHelper
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
+     */
     public function loadFile(string $file) : CSVHelper
     {
         $csv = FileHelper::readContents($file);
@@ -122,28 +122,28 @@ 
     
     protected $rowCount = 0;
     
-   /**
-    * Specifies that headers are positioned on top, horizontally.
-    * @return CSVHelper
-    */
+    /**
+     * Specifies that headers are positioned on top, horizontally.
+     * @return CSVHelper
+     */
     public function setHeadersTop()
     {
         return $this->setHeadersPosition(self::HEADERS_TOP);
     }
     
-   /**
-    * Specifies that headers are positioned on the left, vertically.
-    * @return CSVHelper
-    */
+    /**
+     * Specifies that headers are positioned on the left, vertically.
+     * @return CSVHelper
+     */
     public function setHeadersLeft()
     {
         return $this->setHeadersPosition(self::HEADERS_LEFT);
     }
     
-   /**
-    * Specifies that there are no headers in the file (default).
-    * @return CSVHelper
-    */
+    /**
+     * Specifies that there are no headers in the file (default).
+     * @return CSVHelper
+     */
     public function setHeadersNone()
     {
         return $this->setHeadersPosition(self::HEADERS_NONE);
@@ -173,18 +173,18 @@ 
         return false;
     }
     
-   /**
-    * Specifies where the headers are positioned in the
-    * CSV, or turns them off entirely. Use the class constants
-    * to ensure the value is correct.
-    * 
-    * @param string $position
-    * @throws CSVHelper_Exception
-    * @return CSVHelper
-    * @see CSVHelper::HEADERS_LEFT
-    * @see CSVHelper::HEADERS_TOP
-    * @see CSVHelper::HEADERS_NONE
-    */
+    /**
+     * Specifies where the headers are positioned in the
+     * CSV, or turns them off entirely. Use the class constants
+     * to ensure the value is correct.
+     * 
+     * @param string $position
+     * @throws CSVHelper_Exception
+     * @return CSVHelper
+     * @see CSVHelper::HEADERS_LEFT
+     * @see CSVHelper::HEADERS_TOP
+     * @see CSVHelper::HEADERS_NONE
+     */
     public function setHeadersPosition($position)
     {
         $validPositions = array(
@@ -211,13 +211,13 @@ 
         return $this;
     }
     
-   /**
-    * Resets all internal data, allowing to start entirely anew
-    * with a new file, or to start building a new CSV file from
-    * scratch.
-    * 
-    * @return CSVHelper
-    */
+    /**
+     * Resets all internal data, allowing to start entirely anew
+     * with a new file, or to start building a new CSV file from
+     * scratch.
+     * 
+     * @return CSVHelper
+     */
     public function reset()
     {
         $this->data = array();
@@ -234,19 +234,19 @@ 
         return $this->data;
     }
     
-   /**
-    * Retrieves the row at the specified index.
-    * If there is no data at the index, this will
-    * return an array populated with empty strings
-    * for all available columns.
-    * 
-    * Tip: Use the {@link rowExists()} method to check
-    * whether the specified row exists.
-    * 
-    * @param integer $index
-    * @return array()
-    * @see rowExists()
-    */
+    /**
+     * Retrieves the row at the specified index.
+     * If there is no data at the index, this will
+     * return an array populated with empty strings
+     * for all available columns.
+     * 
+     * Tip: Use the {@link rowExists()} method to check
+     * whether the specified row exists.
+     * 
+     * @param integer $index
+     * @return array()
+     * @see rowExists()
+     */
     public function getRow($index)
     {
         if(isset($this->data[$index])) {
@@ -256,63 +256,63 @@ 
         return array_fill(0, $this->rowCount, '');
     }
     
-   /**
-    * Checks whether the specified row exists in the data set.
-    * @param integer $index
-    * @return boolean
-    */
+    /**
+     * Checks whether the specified row exists in the data set.
+     * @param integer $index
+     * @return boolean
+     */
     public function rowExists($index)
     {
         return isset($this->data[$index]);
     }
     
-   /**
-    * Counts the amount of rows in the parsed CSV,
-    * excluding the headers if any, depending on 
-    * their position.
-    * 
-    * @return integer
-    */
+    /**
+     * Counts the amount of rows in the parsed CSV,
+     * excluding the headers if any, depending on 
+     * their position.
+     * 
+     * @return integer
+     */
     public function countRows()
     {
         return $this->rowCount;
     }
     
-   /**
-    * Counts the amount of rows in the parsed CSV, 
-    * excluding the headers if any, depending on
-    * their position.
-    * 
-    * @return integer
-    */
+    /**
+     * Counts the amount of rows in the parsed CSV, 
+     * excluding the headers if any, depending on
+     * their position.
+     * 
+     * @return integer
+     */
     public function countColumns()
     {
         return $this->columnCount;
     }
     
-   /**
-    * Retrieves the headers, if any. Specify the position of the
-    * headers first to ensure this works correctly.
-    * 
-    * @return array Indexed array with header names.
-    */
+    /**
+     * Retrieves the headers, if any. Specify the position of the
+     * headers first to ensure this works correctly.
+     * 
+     * @return array Indexed array with header names.
+     */
     public function getHeaders()
     {
         return $this->headers;
     }
     
-   /**
-    * Retrieves the column at the specified index. If there
-    * is no column at the index, this returns an array
-    * populated with empty strings.
-    * 
-    * Tip: Use the {@link columnExists()} method to check
-    * whether a column exists.
-    * 
-    * @param integer $index
-    * @return string[]
-    * @see columnExists()
-    */
+    /**
+     * Retrieves the column at the specified index. If there
+     * is no column at the index, this returns an array
+     * populated with empty strings.
+     * 
+     * Tip: Use the {@link columnExists()} method to check
+     * whether a column exists.
+     * 
+     * @param integer $index
+     * @return string[]
+     * @see columnExists()
+     */
     public function getColumn($index)
     {
         $data = array();
@@ -328,11 +328,11 @@ 
         return $data;
     }
     
-   /**
-    * Checks whether the specified column exists in the data set.
-    * @param integer $index
-    * @return boolean
-    */
+    /**
+     * Checks whether the specified column exists in the data set.
+     * @param integer $index
+     * @return boolean
+     */
     public function columnExists($index)
     {
         if($index < $this->columnCount) {
@@ -396,22 +396,22 @@ 
         }
     }
     
-   /**
-    * Checks whether any errors have been encountered
-    * while parsing the CSV.
-    * 
-    * @return boolean
-    * @see getErrorMessages()
-    */
+    /**
+     * Checks whether any errors have been encountered
+     * while parsing the CSV.
+     * 
+     * @return boolean
+     * @see getErrorMessages()
+     */
     public function hasErrors()
     {
         return !empty($this->errors);
     }
     
-   /**
-    * Retrieves all error messages.
-    * @return array
-    */
+    /**
+     * Retrieves all error messages.
+     * @return array
+     */
     public function getErrorMessages()
     {
         return $this->errors;

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