Changeset 5985

Timestamp:

02/01/12 18:58:34 (4 months ago)

Author:

vain

Message:

• added getter and setter for $options on formelementvalidator base class
• replaced $options array with $this->getOptions() accordingly in url and ip validator
• added comments to ip validators
• tixed fypos in validator range.php

Location:

trunk/core/viewhelper/form

Files:

• formelementvalidator.php (modified) (2 diffs)
• validators/ip.php (modified) (2 diffs)
• validators/maxlength.php (modified) (1 diff)
• validators/minlength.php (modified) (1 diff)
• validators/range.php (modified) (2 diffs)
• validators/url.php (modified) (1 diff)

trunk/core/viewhelper/form/formelementvalidator.php

@@ -47 +47 @@
 
     /**
+     * General prupose options array.
+     * For instance, this options array is passed as third parameter to
+     * filter_var($value, FILTER_CONSTANT, $options).
+     *
+     * @var array
+     */
+    public $options = array();
+
+    /**
+     * Getter for Options.
+     *
+     * @return array
+     */
+    public function getOptions()
+    {
+        return $this->options;
+    }
+
+    /**
+     * Setter for Options.
+     *
+     * @param array $options
+     */
+    public function setOptions(array $options)
+    {
+        $this->options = $options;
+    }
+
+    /**
      * Setter for the error state of the validator.
      *
@@ -86 +115 @@
 
     /**
-     * Accepts an options array and assigns object property names (by key) and values (by value) accordingly.
+     * Accepts an array and assigns object property names (by key) and values (by value) accordingly.
      * The objects needs a setter method for the value.
      *

trunk/core/viewhelper/form/validators/ip.php

@@ -37 +37 @@
 }
 
+/**
+ * Validator for an IP address.
+ * The validator accepts IPv4 and IPv6 addresses.
+ * If you want only one version, use the flags FILTER_FLAG_IPV4
+ * or FILTER_FLAG_IPV6 via setOptions().
+ *
+ * @see http://www.php.net/manual/en/filter.filters.validate.php
+ */
 class Clansuite_Formelement_Validator_Ip extends Clansuite_Formelement_Validator
 {
@@ -46 +54 @@
     protected function processValidationLogic($value)
     {
-        $options = array();
-
-        if(true === (bool) filter_var( $value, FILTER_VALIDATE_IP, $options ))
+        if(true === (bool) filter_var( $value, FILTER_VALIDATE_IP, $this->getOptions() ))
         {
             return true;

trunk/core/viewhelper/form/validators/maxlength.php

@@ -37 +37 @@
 }
 
+/**
+ * Validates the lenght of a string with maxlength given.
+ */
 class Clansuite_Formelement_Validator_Maxlength extends Clansuite_Formelement_Validator
 {

trunk/core/viewhelper/form/validators/minlength.php

@@ -37 +37 @@
 }
 
+/**
+ * Validates the lenght of a string with maxlength given.
+ */
 class Clansuite_Formelement_Validator_Minlength extends Clansuite_Formelement_Validator
 {

trunk/core/viewhelper/form/validators/range.php

@@ -58 +58 @@
     public function getErrorMessage()
     {
-        $min = $this->options['options']['min_range']
-        $max = $this->options['options']['max_range']
+        $min = $this->options['options']['min_range'];
+        $max = $this->options['options']['max_range'];
 
         return _('The value is outside the range of ' . $min .' <> '. $max .' chars.');
@@ -66 +66 @@
     protected function processValidationLogic($value)
     {
-        if(filter_var($value, FILTER_VALIDATE_INT, $this->options) !== FALSE))
+        if(filter_var($value, FILTER_VALIDATE_INT, $this->options) !== FALSE)
         {
             return true;

trunk/core/viewhelper/form/validators/url.php

@@ -46 +46 @@
     protected function processValidationLogic($value)
     {
-        $options = array();
-        
-        if(true === (bool) filter_var( $value, FILTER_VALIDATE_URL, $options ))
+        if(true === (bool) filter_var( $value, FILTER_VALIDATE_URL, $this->getOptions() ))
         {
             return true;