Changeset 5923

Timestamp:

01/11/12 22:28:05 (4 months ago)

Author:

vain

Message:

• added form validation, formelement validation and several validators
• fixed unit-test for validateForm accordingly

Location:

trunk

Files:

• core/viewhelper/form/form.core.php (modified) (5 diffs)
• core/viewhelper/form/formelement.core.php (modified) (12 diffs)
• core/viewhelper/form/validator.php (added)
• core/viewhelper/form/validators (added)
• core/viewhelper/form/validators/maxlength.php (added)
• core/viewhelper/form/validators/required.php (added)
• core/viewhelper/form/validators/string.php (added)
• tests/unittests/core/viewhelper/form/form.core.php (modified) (1 diff)

trunk/core/viewhelper/form/form.core.php

@@ -731 +731 @@
     public function formHasErrors()
     {
-        return $this->formerror_flag;
+        return $this->error;
     }
 
@@ -1126 +1126 @@
      *
      * This is the main formular processing loop.
-     * If the form doesn't validate, redisplay it, else present "Success"-Message!
+     * If the form does not validate, then redisplay it,
+     * else present "Success"-Message!
      */
     public function processForm()
     {
         # check if form has been submitted properly
-        if ($this->validateForm() === false)
+        if ($this->validate() === false)
         {
             # if not, redisplay the form (decorate with errors + render)
-            $this->addValidator($validator);
-            $this->renderFormWithErrors();
-
-        }
-        else # form was properly filled, display a success web page
-        {
-            # success!!
-            $this->success();
-        }
-    }
-
-    public function renderFormWithErrors()
-    {
-
+            $this->addDecorator('errors');
+            $this->render();
+
+        }
+        else # form was properly filled, display a success web page or a flashmessage
+        {
+            /**
+             * Success - form content valid.
+             * The "noerror" decorator implementation decides,
+             * if a success web page or a flashmessage is used.
+             */
+            $this->addDecorator('noerror');
+            $this->render();
+        }
     }
 
@@ -1625 +1626 @@
      *
      * The method iterates (loops over) all formelement objects and calls the validation on each object.
+     * In other words: a form is valid, if all formelement are valid. Suprise, suprise.
      *
      * @return boolean Returns true if form validates, false if validation fails, because errors exist.
@@ -1637 +1639 @@
                 $this->setErrorState(true);
 
-                # and transfer errormessage from formelement to form errormessages stack
-                $this->addErrormessage($formelement->getError());
+                # and transfer errormessages from formelement to form errormessages stack
+                #$this->addErrorMessage($formelement->getErrorMessages());
             }
         }
@@ -1679 +1681 @@
      }
 
-     public function addErrormessage($errormessage)
+     public function addErrorMessage($errormessage)
      {
         $this->errormessages[] = $errormessage;
      }
 
-     public function addErrormessages(array $errormessages)
+     public function addErrorMessages(array $errormessages)
      {
         $this->errormessages = $errormessages;

trunk/core/viewhelper/form/formelement.core.php

@@ -50 +50 @@
 class Clansuite_Formelement implements Clansuite_Formelement_Interface
 {
+    /**
+     * @var string
+     */
     public $name, $id, $type, $class, $size, $disabled, $maxlength, $style, $onclick;
 
@@ -61 +64 @@
      * validators are stored into an array. making multiple validators for one formelement possible.
      *
-     * @var validator
+     * @var array
      */
     protected $validators = array();
 
     /**
-     * error stack array storing the incomming errors from validators.
-     *
-     * @var formelement_validation_errors
-     */
-    protected $validation_errors = array();
+     * The error messages array stores the incomming errors fromelement validators.
+     *
+     * @var array
+     */
+    protected $errormessages = array();
 
     /**
@@ -468 +471 @@
      * expect / setRules
      *
-     * set validation rules
-     * $rules['input-firstname']  = "required";
-     * $rules['input-email']      = "required, email";
-     */
-    public function expect($rule)
+     * set validation rules as string
+     * "required, maxlength=20";
+     * "required, email";
+     */
+    public function setRules($rule)
     {
         if(false === is_string($rule))
@@ -483 +486 @@
         foreach($rules as $rule)
         {
-            $this->addValidator($rule);
+            $rule = trim($rule);
+
+            if(false === strpos($rule, '='))
+            {
+                # if there is no "=", then there is no value to set
+                # rule is then the name of a validator
+                $this->addValidator($rule);
+            }
+            else # ok -> property name to value relationship
+            {
+                $array = explode('=', $rule);
+                $this->addValidator($array[0], array($array[0] => $array[1]));
+            }
         }
     }
@@ -492 +507 @@
      * Is a shortcut/proxy/convenience method for addValidator()
      *
+     * @param object|string Formelement Validator
+     * @param mixed A Validator Property Value.
      * WATCH OUT! THIS BREAKS THE CHAINING IN REGARD TO THE FORM
      * @return Clansuite_Formelement_Validator
      */
-    public function addValidator($validator)
+    public function addValidator($validator, $properties = null)
     {
         if(false === is_object($validator))
         {
-
+            if($validator === 'required' and false === $this->isRequired())
+            {
+                $this->setRequired();
+            }
+
+            $validator = $this->getValidator($validator);
+        }
+
+        if(isset($properties))
+        {
+            $validator->setProperties($properties);
         }
 
         $this->setValidator($validator);
 
-        return $this;
+        return $validator;
     }
 
@@ -523 +550 @@
 
     /**
-     * The validation method processes all registered validators of a sinngle formelement.
+     * Returns a form validator object.
+     * Also a factory method, which instantiates and returns a new formvalidator object.
+     *
+     * @return Clansuite_Formvalidator
+     */
+    public function getValidator($validator)
+    {
+        # load baseclass
+        # @todo move to map / autoloader
+        if(false == class_exists('Clansuite_Formelement_Validator', false))
+        {
+            include ROOT_CORE . 'viewhelper/form/validator.php';
+        }
+
+        # construct classname
+        $class = 'Clansuite_Formelement_Validator_' . ucfirst($validator);
+
+        # return early, if this object is already stored
+        if(isset($this->validators[$class]))
+        {
+            return $this->validators[$class];
+        }
+        # autoloader
+        elseif(true === class_exists($class))
+        {
+
+            return new $class;
+        }
+        # factory method part
+        elseif(false == class_exists($class, false))
+        {
+            $file = ROOT_CORE . 'viewhelper/form/validators/' . $validator . '.php';
+
+            if(is_file($file) === true)
+            {
+                include $file;
+            }
+            unset($file);
+
+            return new $class();
+        }
+        # validator not found
+        else
+        {
+            throw new Clansuite_Exception('Validator named ' . $validator . ' not available.');
+        }
+    }
+
+    /**
+     * Validates the value of a formelement.
+     *
+     * The validation method processes the value of the formelement
+     * by passing it to all registered validators of the formelement.
+     * The value of the formelement is valid, when it satisfies
+     * each of the element's validation rules.
      *
      * @see $validators array
@@ -530 +611 @@
     public function validate()
     {
+        $value = $this->getValue();
+
+        # return early, if value empty|null and not required
+        if((('' === $value) or (null === $value)) and false === $this->isRequired())
+        {
+            return true;
+        }
+
+        # no rules / validators
+        if(null === $this->validators)
+        {
+            return true;
+        }
+
         # iterate over all validators
         foreach($this->validators as $validator)
         {
             # ensure element validates
-            if($validator->validates() === true)
+            if($validator->validate($value) === true)
             {
                 # everything is fine, proceed
@@ -545 +640 @@
 
                 # and transfer error message from the validator to the formelement
-                $this->addError($validator->getError());
+                $this->addErrorMessage($validator->getErrorMessage());
 
                 return false;
             }
         }
+
+        # formelement value is valid
+        return true;
     }
 
@@ -555 +653 @@
      * Method adds an validation error to the formelement_validation_error stack.
      *
+     * @param $errormessage
+     */
+    public function addErrorMessage($errormessage)
+    {
+        $this->errormessages[] = $errormessage;
+    }
+
+    /**
+     * Returns the validation_error stack.
+     *
      * @param $validation_error
      */
-    public function addError($validation_error)
-    {
-        $this->validation_errors[] = $validation_error;
+    public function getErrorMessages()
+    {
+        return $this->errormessages;
     }
 
@@ -606 +714 @@
     public function __toString()
     {
-        #var_dump(get_class($this));
         $subclass = get_class($this);
 
@@ -735 +842 @@
      * Factory method. Instantiates and returns a new formdecorator object.
      *
+     * @param string Formelement Decorator.
      * @return Clansuite_Formelement_Decorator
      */
-    public function decoratorFactory($formelementdecorator)
+    public function decoratorFactory($decorator)
     {
         # construct Clansuite_Formdecorator_Name
-        $formelementdecorator_classname = 'Clansuite_Formelement_Decorator_' . ucfirst($formelementdecorator);
+        $class = 'Clansuite_Formelement_Decorator_' . ucfirst($decorator);
 
         # if not already loaded, require forelement file
-        if(false == class_exists($formelementdecorator_classname, false))
-        {
-            $file = ROOT_CORE . 'viewhelper/form/formdecorators/formelement/' . $formelementdecorator . '.form.php';
+        if(false == class_exists($class, false))
+        {
+            $file = ROOT_CORE . 'viewhelper/form/formdecorators/formelement/' . $decorator . '.form.php';
 
             if(is_file($file) === true)
@@ -754 +862 @@
 
         # instantiate the new $formdecorator
-        return new $formelementdecorator_classname;
+        return new $class;
     }
 

trunk/tests/unittests/core/viewhelper/form/form.core.php

@@ -728 +728 @@
     }*/
 
-    public function testValidateForm()
-    {
-        $this->form->addElement('textarea')->setRequired()->expect('required, string, maxlength=100');
-
-
-        $this->form->validateForm();
-
-        // Remove the following lines when you implement this test.
-        $this->markTestIncomplete(
-                'This test has not been implemented yet.'
-        );
+    public function testValidateForm_false()
+    {
+        $this->form->addElement('textarea')
+                ->setName('Textarea-Validate-Test')
+                ->setRequired()
+                ->setRules('required, string, maxlength=100');
+
+        # no value set, but required
+        $this->assertFalse($this->form->validateForm());
+
+        # set a value, exceeding maxlength
+        $element = $this->form->getElementByName('Textarea-Validate-Test');
+        $element->setValue('0123456789-0123456789'); # 21 chars
+
+        # max length exceeded
+        $this->assertFalse($this->form->validateForm());
+    }
+
+    public function testValidateForm_true()
+    {
+        $this->form->addElement('textarea')
+                ->setName('Textarea-Validate-Test')
+                ->setRequired()
+                ->setRules('required, string, maxlength=20');
+
+        # set value, length ok
+        $element = $this->form->getElementByName('Textarea-Validate-Test');
+        $element->setValue('01234567890123456789'); # 20 chars
+
+        $this->assertTrue($this->form->validateForm());
     }