Mistralys / application-utils

src/Request/Param/Filter.php

Indentation +3 added lines, -3 removed lines

@@ -22,9 +22,9 @@
 {
     use Traits_Optionable;
     
-   /**
-    * @var Request_Param
-    */
+    /**
+     * @var Request_Param
+     */
     protected $param;
     
     protected $value;

src/Request/Param.php

Indentation +134 added lines, -134 removed lines

@@ -114,18 +114,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 callable $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 callable $callback
+     * @param array $args
+     * @return Request_Param
+     */
     public function setCallback($callback, array $args=array()) : Request_Param
     {
         if(!is_callable($callback)) {
@@ -169,16 +169,16 @@ 
         return $value;
     }
     
-   /**
-    * Validates the specified value using the validation type. Returns
-    * the validated value. 
-    * 
-    * @param mixed $value
-    * @param string $type
-    * @param array $params
-    * @throws Request_Exception
-    * @return mixed
-    */
+    /**
+     * Validates the specified value using the validation type. Returns
+     * the validated value. 
+     * 
+     * @param mixed $value
+     * @param string $type
+     * @param array $params
+     * @throws Request_Exception
+     * @return mixed
+     */
     protected function validateType($value, string $type, array $params)
     {
         $class = '\AppUtils\Request_Param_Validator_'.ucfirst($type);
@@ -276,13 +276,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;
@@ -291,13 +291,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);
@@ -338,12 +338,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);   
@@ -376,17 +376,17 @@ 
         );
     }
     
-   /**
-    * 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();
@@ -404,53 +404,53 @@ 
         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
     {
         return $this->addClassFilter('Boolean');
     }
     
-   /**
-    * 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);
@@ -492,14 +492,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);
@@ -587,12 +587,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
@@ -601,13 +601,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->addClassFilter('String');
@@ -657,12 +657,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.
@@ -671,14 +671,14 @@ 
         return $this->addClassFilter('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();
@@ -703,12 +703,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'));
@@ -721,14 +721,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;