Mistralys / application-utils

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/Request/Param.php

Indentation +135 added lines, -135 removed lines

@@ -111,18 +111,18 @@ 
         }
     }
     
-   /**
-    * Adds a callback as a validation method. The callback gets the
-    * value to validate as first parameter, and any additional 
-    * parameters passed here get appended to that.
-    * 
-    * The callback must return boolean true or false depending on
-    * whether the value is valid.
-    * 
-    * @param mixed $callback
-    * @param array $args
-    * @return Request_Param
-    */
+    /**
+     * Adds a callback as a validation method. The callback gets the
+     * value to validate as first parameter, and any additional 
+     * parameters passed here get appended to that.
+     * 
+     * The callback must return boolean true or false depending on
+     * whether the value is valid.
+     * 
+     * @param mixed $callback
+     * @param array $args
+     * @return Request_Param
+     */
     public function setCallback($callback, $args=array())
     {
         if(!is_callable($callback)) {
@@ -264,13 +264,13 @@ 
     
     protected $valueType = self::VALUE_TYPE_STRING;
 
-   /**
-    * Sets the variable to contain a comma-separated list of integer IDs.
-    * Example: <code>145,248,4556</code>. A single ID is also allowed, e.g.
-    * <code>145</code>.
-    * 
-    * @return Request_Param
-    */
+    /**
+     * Sets the variable to contain a comma-separated list of integer IDs.
+     * Example: <code>145,248,4556</code>. A single ID is also allowed, e.g.
+     * <code>145</code>.
+     * 
+     * @return Request_Param
+     */
     public function setIDList()
     {
         $this->valueType = self::VALUE_TYPE_ID_LIST;
@@ -279,13 +279,13 @@ 
         return $this;
     }
     
-   /**
-    * Sets the variable to be an alias, as defined by the
-    * {@link RegexHelper::REGEX_ALIAS} regular expression.
-    * 
-    * @return Request_Param
-    * @see RegexHelper::REGEX_ALIAS
-    */
+    /**
+     * Sets the variable to be an alias, as defined by the
+     * {@link RegexHelper::REGEX_ALIAS} regular expression.
+     * 
+     * @return Request_Param
+     * @see RegexHelper::REGEX_ALIAS
+     */
     public function setAlias()
     {
         return $this->setRegex(RegexHelper::REGEX_ALIAS);
@@ -326,12 +326,12 @@ 
         return $this->setValidation(self::VALIDATION_TYPE_ALPHA);
     }
     
-   /**
-    * Sets the parameter value as a string containing lowercase
-    * and/or uppercase letters, as well as numbers.
-    * 
-    * @return Request_Param
-    */
+    /**
+     * Sets the parameter value as a string containing lowercase
+     * and/or uppercase letters, as well as numbers.
+     * 
+     * @return Request_Param
+     */
     public function setAlnum()
     {
         return $this->setValidation(self::VALIDATION_TYPE_ALNUM);   
@@ -359,17 +359,17 @@ 
         return $this->setValidation(self::VALIDATION_TYPE_ENUM, $args);
     }
     
-   /**
-    * Only available for array values: the parameter must be
-    * an array value, and the array may only contain values 
-    * specified in the values array.
-    * 
-    * Submitted values that are not in the allowed list of
-    * values are stripped from the value.
-    *  
-    * @param array $values List of allowed values
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Only available for array values: the parameter must be
+     * an array value, and the array may only contain values 
+     * specified in the values array.
+     * 
+     * Submitted values that are not in the allowed list of
+     * values are stripped from the value.
+     *  
+     * @param array $values List of allowed values
+     * @return \AppUtils\Request_Param
+     */
     public function setValuesList(array $values)
     {
         $this->setArray();
@@ -382,39 +382,39 @@ 
         return $this->setValidation(self::VALIDATION_TYPE_ARRAY);
     }
     
-   /**
-    * Specifies that a JSON-encoded string is expected.
-    * 
-    * NOTE: Numbers or quoted strings are technically valid
-    * JSON, but are not accepted, because it is assumed
-    * at least an array or object are expected.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Specifies that a JSON-encoded string is expected.
+     * 
+     * NOTE: Numbers or quoted strings are technically valid
+     * JSON, but are not accepted, because it is assumed
+     * at least an array or object are expected.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function setJSON() : Request_Param
     {
         return $this->setValidation(self::VALIDATION_TYPE_JSON, array('arrays' => true));
     }
     
-   /**
-    * Like {@link Request_Param::setJSON()}, but accepts
-    * only JSON objects. Arrays will not be accepted.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Like {@link Request_Param::setJSON()}, but accepts
+     * only JSON objects. Arrays will not be accepted.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function setJSONObject() : Request_Param
     {
         return $this->setValidation(self::VALIDATION_TYPE_JSON, array('arrays' => false));
     }
     
-   /**
-    * The parameter is a string boolean representation. This means
-    * it can be any of the following: "yes", "true", "no", "false".
-    * The value is automatically converted to a boolean when retrieving
-    * the parameter.
-    * 
-    * @return Request_Param
-    */
+    /**
+     * The parameter is a string boolean representation. This means
+     * it can be any of the following: "yes", "true", "no", "false".
+     * The value is automatically converted to a boolean when retrieving
+     * the parameter.
+     * 
+     * @return Request_Param
+     */
     public function setBoolean() : Request_Param
     {
         $this->addCallbackFilter(array($this, 'applyFilter_boolean'));
@@ -478,15 +478,15 @@ 
         return $keep;
     }
     
-   /**
-    * Validates the request parameter as an MD5 string,
-    * so that only values resembling md5 values are accepted.
-    * 
-    * NOTE: This can only guarantee the format, not whether
-    * it is an actual valid hash of something.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Validates the request parameter as an MD5 string,
+     * so that only values resembling md5 values are accepted.
+     * 
+     * NOTE: This can only guarantee the format, not whether
+     * it is an actual valid hash of something.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function setMD5() : Request_Param
     {
         return $this->setRegex(RegexHelper::REGEX_MD5);
@@ -528,14 +528,14 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves the value of the request parameter,
-    * applying all filters (if any) and validation
-    * (if any).
-    * 
-    * @param mixed $default
-    * @return mixed
-    */
+    /**
+     * Retrieves the value of the request parameter,
+     * applying all filters (if any) and validation
+     * (if any).
+     * 
+     * @param mixed $default
+     * @return mixed
+     */
     public function get($default=null)
     {
         $value = $this->request->getParam($this->paramName);
@@ -565,12 +565,12 @@ 
         return null;
     }
     
-   /**
-    * Validates the syntax of an URL, but not its actual validity. 
-    * 
-    * @param mixed $value
-    * @return string
-    */
+    /**
+     * Validates the syntax of an URL, but not its actual validity. 
+     * 
+     * @param mixed $value
+     * @return string
+     */
     protected function validate_url($value) : string
     {
         if(!is_string($value)) {
@@ -710,10 +710,10 @@ 
         return null;
     }
     
-   /**
-    * Makes sure that the value is a JSON-encoded string.
-    * @param string $value
-    */
+    /**
+     * Makes sure that the value is a JSON-encoded string.
+     * @param string $value
+     */
     protected function validate_json($value)
     {
         if(!is_string($value)) {
@@ -730,7 +730,7 @@ 
         if($this->validationParams['arrays'] === false) 
         {
             if(is_object(json_decode($value))) {
-               return $value; 
+                return $value; 
             }
         } 
         else 
@@ -811,12 +811,12 @@ 
         return $this;
     }
     
-   /**
-    * Adds a filter that trims whitespace from the request
-    * parameter using the PHP <code>trim</code> function.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Adds a filter that trims whitespace from the request
+     * parameter using the PHP <code>trim</code> function.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function addFilterTrim() : Request_Param
     {
         // to guarantee we only work with strings
@@ -825,13 +825,13 @@ 
         return $this->addCallbackFilter('trim');
     }
 
-   /**
-    * Converts the value to a string, even if it is not
-    * a string value. Complex types like arrays and objects
-    * are converted to an empty string.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Converts the value to a string, even if it is not
+     * a string value. Complex types like arrays and objects
+     * are converted to an empty string.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function addStringFilter() : Request_Param
     {
         return $this->addCallbackFilter(array($this, 'applyFilter_string'));
@@ -881,12 +881,12 @@ 
         return $this->addCallbackFilter('strip_tags', array($allowedTags));
     }
     
-   /**
-    * Adds a filter that strips all whitespace from the
-    * request parameter, from spaces to tabs and newlines.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Adds a filter that strips all whitespace from the
+     * request parameter, from spaces to tabs and newlines.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function addStripWhitespaceFilter() : Request_Param
     {
         // to ensure we only work with strings.
@@ -895,14 +895,14 @@ 
         return $this->addCallbackFilter(array($this, 'applyFilter_stripWhitespace'));
     }   
     
-   /**
-    * Adds a filter that transforms comma separated values
-    * into an array of values.
-    * 
-    * @param bool $trimEntries Trim whitespace from each entry?
-    * @param bool $stripEmptyEntries Remove empty entries from the array?
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Adds a filter that transforms comma separated values
+     * into an array of values.
+     * 
+     * @param bool $trimEntries Trim whitespace from each entry?
+     * @param bool $stripEmptyEntries Remove empty entries from the array?
+     * @return \AppUtils\Request_Param
+     */
     public function addCommaSeparatedFilter(bool $trimEntries=true, bool $stripEmptyEntries=true) : Request_Param
     {
         $this->setArray();
@@ -916,12 +916,12 @@ 
         );
     }
     
-   /**
-    * Adds a filter that encodes all HTML special characters
-    * using the PHP <code>htmlspecialchars</code> function.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Adds a filter that encodes all HTML special characters
+     * using the PHP <code>htmlspecialchars</code> function.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function addHTMLSpecialcharsFilter() : Request_Param
     {
         return $this->addCallbackFilter('htmlspecialchars', array(ENT_QUOTES, 'UTF-8'));
@@ -934,14 +934,14 @@ 
     
     protected $required = false;
     
-   /**
-    * Marks this request parameter as required. To use this feature,
-    * you have to call the request's {@link Request::validate()}
-    * method.
-    * 
-    * @return Request_Param
-    * @see Request::validate()
-    */
+    /**
+     * Marks this request parameter as required. To use this feature,
+     * you have to call the request's {@link Request::validate()}
+     * method.
+     * 
+     * @return Request_Param
+     * @see Request::validate()
+     */
     public function makeRequired() : Request_Param
     {
         $this->required = true;

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/Request.php

Indentation +86 added lines, -86 removed lines

@@ -108,12 +108,12 @@ 
         return $this->buildURL($params, $dispatcher);
     }
     
-   /**
-    * Retrieves the name of the current dispatcher script / page.
-    * This is made to be extended and implemented in a subclass.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the name of the current dispatcher script / page.
+     * This is made to be extended and implemented in a subclass.
+     * 
+     * @return string
+     */
     public function getDispatcher() : string
     {
         return '';
@@ -200,13 +200,13 @@ 
         return $this->knownParams[$name];
     }
     
-   /**
-    * Retrieves a previously registered parameter instance.
-    * 
-    * @param string $name
-    * @throws Request_Exception
-    * @return Request_Param
-    */
+    /**
+     * Retrieves a previously registered parameter instance.
+     * 
+     * @param string $name
+     * @throws Request_Exception
+     * @return Request_Param
+     */
     public function getRegisteredParam(string $name) : Request_Param
     {
         if(isset($this->knownParams[$name])) {
@@ -223,13 +223,13 @@ 
         );
     }
     
-   /**
-    * Checks whether a parameter with the specified name 
-    * has been registered.
-    * 
-    * @param string $name
-    * @return bool
-    */
+    /**
+     * Checks whether a parameter with the specified name 
+     * has been registered.
+     * 
+     * @param string $name
+     * @return bool
+     */
     public function hasRegisteredParam(string $name) : bool
     {
         return isset($this->knownParams[$name]);
@@ -358,14 +358,14 @@ 
         return false;
     }
     
-   /**
-    * Removes a single parameter from the request.
-    * If the parameter has been registered, also
-    * removes the registration info.
-    * 
-    * @param string $name
-    * @return Request
-    */
+    /**
+     * Removes a single parameter from the request.
+     * If the parameter has been registered, also
+     * removes the registration info.
+     * 
+     * @param string $name
+     * @return Request
+     */
     public function removeParam(string $name) : Request
     {
         if(isset($_REQUEST[$name])) {
@@ -379,12 +379,12 @@ 
         return $this;
     }
     
-   /**
-    * Removes several parameters from the request.
-    * 
-    * @param string[] $names
-    * @return Request
-    */
+    /**
+     * Removes several parameters from the request.
+     * 
+     * @param string[] $names
+     * @return Request
+     */
     public function removeParams(array $names) : Request
     {
         foreach($names as $name) {
@@ -449,18 +449,18 @@ 
         return $val;
     }
     
-   /**
-    * Treats the request parameter as a JSON string, and
-    * if it exists and contains valid JSON, returns the
-    * decoded JSON value as an array (default).
-    *
-    * @param string $name
-    * @param bool $assoc
-    * @return array|object
-    * 
-    * @see Request::getJSONAssoc()
-    * @see Request::getJSONObject()
-    */
+    /**
+     * Treats the request parameter as a JSON string, and
+     * if it exists and contains valid JSON, returns the
+     * decoded JSON value as an array (default).
+     *
+     * @param string $name
+     * @param bool $assoc
+     * @return array|object
+     * 
+     * @see Request::getJSONAssoc()
+     * @see Request::getJSONObject()
+     */
     public function getJSON(string $name, bool $assoc=true)
     {
         $value = $this->getParam($name);
@@ -485,13 +485,13 @@ 
         return new \stdClass();
     }
     
-   /**
-    * Like {@link Request::getJSON()}, but omitting the second
-    * parameter. Use this for more readable code.
-    * 
-    * @param string $name
-    * @return array
-    */
+    /**
+     * Like {@link Request::getJSON()}, but omitting the second
+     * parameter. Use this for more readable code.
+     * 
+     * @param string $name
+     * @return array
+     */
     public function getJSONAssoc(string $name) : array
     {
         $result = $this->getJSON($name);
@@ -502,13 +502,13 @@ 
         return array();
     }
     
-   /**
-    * Like {@link Request::getJSON()}, but omitting the second
-    * parameter. Use this for more readable code.
-    *
-    * @param string $name
-    * @return object
-    */
+    /**
+     * Like {@link Request::getJSON()}, but omitting the second
+     * parameter. Use this for more readable code.
+     *
+     * @param string $name
+     * @return object
+     */
     public function getJSONObject(string $name) : object
     {
         $result = $this->getJSON($name, false);
@@ -519,12 +519,12 @@ 
         return new \stdClass();
     }
     
-   /**
-    * Sends a JSON response with the correct headers.
-    *
-    * @param array|string $data
-    * @param bool $exit Whether to exit the script afterwards.
-    */
+    /**
+     * Sends a JSON response with the correct headers.
+     *
+     * @param array|string $data
+     * @param bool $exit Whether to exit the script afterwards.
+     */
     public static function sendJSON($data, bool $exit=true)
     {
         $payload = $data;
@@ -544,12 +544,12 @@ 
         }
     }
     
-   /**
-    * Sends HTML to the browser with the correct headers.
-    * 
-    * @param string $html
-    * @param bool $exit Whether to exit the script afterwards.
-    */
+    /**
+     * Sends HTML to the browser with the correct headers.
+     * 
+     * @param string $html
+     * @param bool $exit Whether to exit the script afterwards.
+     */
     public static function sendHTML(string $html, bool $exit=true)
     {
         header('Cache-Control: no-cache, must-revalidate');
@@ -564,16 +564,16 @@ 
         }
     }
     
-   /**
-    * Creates a new instance of the URL comparer, which can check 
-    * whether the specified URLs match, regardless of the order in 
-    * which the query parameters are, if any.
-    * 
-    * @param string $sourceURL
-    * @param string $targetURL
-    * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present)
-    * @return Request_URLComparer
-    */
+    /**
+     * Creates a new instance of the URL comparer, which can check 
+     * whether the specified URLs match, regardless of the order in 
+     * which the query parameters are, if any.
+     * 
+     * @param string $sourceURL
+     * @param string $targetURL
+     * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present)
+     * @return Request_URLComparer
+     */
     public function createURLComparer(string $sourceURL, string $targetURL, array $limitParams=array()) : Request_URLComparer
     {
         $comparer = new Request_URLComparer($this, $sourceURL, $targetURL);
@@ -582,10 +582,10 @@ 
         return $comparer;
     }
     
-   /**
-    * Retrieves the full URL that was used to access the current page.
-    * @return string
-    */
+    /**
+     * Retrieves the full URL that was used to access the current page.
+     * @return string
+     */
     public function getCurrentURL() : string
     {
         return $_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI'];

src/ConvertHelper/ThrowableInfo.php

Indentation +103 added lines, -103 removed lines

@@ -14,49 +14,49 @@ 
     const CONTEXT_COMMAND_LINE = 'cli';
     const CONTEXT_WEB = 'web';
     
-   /**
-    * @var \Throwable
-    */
+    /**
+     * @var \Throwable
+     */
     protected $exception;
     
-   /**
-    * @var ConvertHelper_ThrowableInfo_Call[]
-    */
+    /**
+     * @var ConvertHelper_ThrowableInfo_Call[]
+     */
     protected $calls = array();
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $code;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $message;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $callsCount = 0;
     
-   /**
-    * @var ConvertHelper_ThrowableInfo
-    */
+    /**
+     * @var ConvertHelper_ThrowableInfo
+     */
     protected $previous;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $referer = '';
     
-   /**
-    * @var \DateTime
-    */
+    /**
+     * @var \DateTime
+     */
     protected $date;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $context = self::CONTEXT_WEB;
     
     protected function __construct($subject)
@@ -103,16 +103,16 @@ 
         return isset($this->previous);
     }
     
-   /**
-    * Retrieves the information on the previous exception.
-    * 
-    * NOTE: Throws an exception if there is no previous 
-    * exception. Use hasPrevious() first to avoid this.
-    * 
-    * @throws ConvertHelper_Exception
-    * @return ConvertHelper_ThrowableInfo
-    * @see ConvertHelper_ThrowableInfo::ERROR_NO_PREVIOUS_EXCEPTION
-    */
+    /**
+     * Retrieves the information on the previous exception.
+     * 
+     * NOTE: Throws an exception if there is no previous 
+     * exception. Use hasPrevious() first to avoid this.
+     * 
+     * @throws ConvertHelper_Exception
+     * @return ConvertHelper_ThrowableInfo
+     * @see ConvertHelper_ThrowableInfo::ERROR_NO_PREVIOUS_EXCEPTION
+     */
     public function getPrevious() : ConvertHelper_ThrowableInfo
     {
         if(isset($this->previous)) {
@@ -131,9 +131,9 @@ 
         return !empty($this->code);
     }
     
-   /**
-    * Improved textonly exception trace.
-    */
+    /**
+     * Improved textonly exception trace.
+     */
     public function toString() : string
     {
         $calls = $this->getCalls();
@@ -161,73 +161,73 @@ 
         return $string;
     }
     
-   /**
-    * Retrieves the URL of the page in which the exception
-    * was thrown, if applicable: in CLI context, this will
-    * return an empty string.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the URL of the page in which the exception
+     * was thrown, if applicable: in CLI context, this will
+     * return an empty string.
+     * 
+     * @return string
+     */
     public function getReferer() : string
     {
         return $this->referer;
     }
     
-   /**
-    * Whether the exception occurred in a command line context.
-    * @return bool
-    */
+    /**
+     * Whether the exception occurred in a command line context.
+     * @return bool
+     */
     public function isCommandLine() : bool
     {
         return $this->getContext() === self::CONTEXT_COMMAND_LINE;
     }
     
-   /**
-    * Whether the exception occurred during an http request.
-    * @return bool
-    */
+    /**
+     * Whether the exception occurred during an http request.
+     * @return bool
+     */
     public function isWebRequest() : bool
     {
         return $this->getContext() === self::CONTEXT_WEB;
     }
     
-   /**
-    * Retrieves the context identifier, i.e. if the exception
-    * occurred in a command line context or regular web request.
-    * 
-    * @return string
-    * 
-    * @see ConvertHelper_ThrowableInfo::isCommandLine()
-    * @see ConvertHelper_ThrowableInfo::isWebRequest()
-    * @see ConvertHelper_ThrowableInfo::CONTEXT_COMMAND_LINE
-    * @see ConvertHelper_ThrowableInfo::CONTEXT_WEB
-    */
+    /**
+     * Retrieves the context identifier, i.e. if the exception
+     * occurred in a command line context or regular web request.
+     * 
+     * @return string
+     * 
+     * @see ConvertHelper_ThrowableInfo::isCommandLine()
+     * @see ConvertHelper_ThrowableInfo::isWebRequest()
+     * @see ConvertHelper_ThrowableInfo::CONTEXT_COMMAND_LINE
+     * @see ConvertHelper_ThrowableInfo::CONTEXT_WEB
+     */
     public function getContext() : string
     {
         return $this->context;
     }
     
-   /**
-    * Retrieves the date of the exception, and approximate time:
-    * since exceptions do not store time, this is captured the 
-    * moment the ThrowableInfo is created.
-    * 
-    * @return \DateTime
-    */
+    /**
+     * Retrieves the date of the exception, and approximate time:
+     * since exceptions do not store time, this is captured the 
+     * moment the ThrowableInfo is created.
+     * 
+     * @return \DateTime
+     */
     public function getDate() : \DateTime
     {
         return $this->date;
     }
     
-   /**
-    * Serializes all information on the exception to an
-    * associative array. This can be saved (file, database, 
-    * session...), and later be restored into a throwable
-    * info instance using the fromSerialized() method.
-    * 
-    * @return array
-    * @see ConvertHelper_ThrowableInfo::fromSerialized()
-    */
+    /**
+     * Serializes all information on the exception to an
+     * associative array. This can be saved (file, database, 
+     * session...), and later be restored into a throwable
+     * info instance using the fromSerialized() method.
+     * 
+     * @return array
+     * @see ConvertHelper_ThrowableInfo::fromSerialized()
+     */
     public function serialize() : array
     {
         $result = array(
@@ -254,24 +254,24 @@ 
         return $result;
     }
 
-   /**
-    * Sets the maximum folder depth to show in the 
-    * file paths, to avoid them being too long.
-    * 
-    * @param int $depth
-    * @return ConvertHelper_ThrowableInfo
-    */
+    /**
+     * Sets the maximum folder depth to show in the 
+     * file paths, to avoid them being too long.
+     * 
+     * @param int $depth
+     * @return ConvertHelper_ThrowableInfo
+     */
     public function setFolderDepth(int $depth) : ConvertHelper_ThrowableInfo
     {
         return $this->setOption('folder-depth', $depth);
     }
     
-   /**
-    * Retrieves the current folder depth option value.
-    * 
-    * @return int
-    * @see ConvertHelper_ThrowableInfo::setFolderDepth()
-    */
+    /**
+     * Retrieves the current folder depth option value.
+     * 
+     * @return int
+     * @see ConvertHelper_ThrowableInfo::setFolderDepth()
+     */
     public function getFolderDepth() : int
     {
         $depth = $this->getOption('folder-depth');
@@ -282,19 +282,19 @@ 
         return 2;
     }
     
-   /**
-    * Retrieves all function calls that led to the error.
-    * @return ConvertHelper_ThrowableInfo_Call[]
-    */
+    /**
+     * Retrieves all function calls that led to the error.
+     * @return ConvertHelper_ThrowableInfo_Call[]
+     */
     public function getCalls()
     {
         return $this->calls;
     }
     
-   /**
-    * Returns the amount of function and method calls in the stack trace.
-    * @return int
-    */
+    /**
+     * Returns the amount of function and method calls in the stack trace.
+     * @return int
+     */
     public function countCalls() : int
     {
         return $this->callsCount;

src/ConvertHelper/EOL.php

Indentation +26 added lines, -26 removed lines

@@ -29,19 +29,19 @@ 
     const TYPE_LF = 'LF';
     const TYPE_CR = 'CR';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $char;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $description;
     
     public function __construct(string $char, string $type, string $description)
@@ -51,33 +51,33 @@ 
         $this->description = $description;
     }
     
-   /**
-    * The actual EOL character.
-    * @return string
-    */
+    /**
+     * The actual EOL character.
+     * @return string
+     */
     public function getCharacter() : string
     {
         return $this->char;
     }
     
-   /**
-    * A more detailed, human readable description of the character.
-    * @return string
-    */
+    /**
+     * A more detailed, human readable description of the character.
+     * @return string
+     */
     public function getDescription() : string
     {
         return $this->description;
     }
     
-   /**
-    * The EOL character type, e.g. "CR+LF", "CR"...
-    * @return string
-    * 
-    * @see ConvertHelper_EOL::TYPE_CR
-    * @see ConvertHelper_EOL::TYPE_CRLF
-    * @see ConvertHelper_EOL::TYPE_LF
-    * @see ConvertHelper_EOL::TYPE_LFCR
-    */
+    /**
+     * The EOL character type, e.g. "CR+LF", "CR"...
+     * @return string
+     * 
+     * @see ConvertHelper_EOL::TYPE_CR
+     * @see ConvertHelper_EOL::TYPE_CRLF
+     * @see ConvertHelper_EOL::TYPE_LF
+     * @see ConvertHelper_EOL::TYPE_LFCR
+     */
     public function getType() : string
     {
         return $this->type;