Changeset 1444

Timestamp:

12/25/06 23:39:25 (2 years ago)

Author:

dominik

Message:

BREAKING CHANGE!
- Reworked the internal error handling in the validation. Now validators have multiple incidents (usually one per failed internal run [one validator internally runs multiple times when you give it a base and it has to validate more then one field that way). An incident can have multiple errors, which can span multiple fields.
- Removed AgaviRequest::removeError (this a) doesn't work anymore and b) was a quite questionable thing to do in your code imho)
- Adjusted error retrieval/setting methods in AgaviRequest? to work with the new system. (please note that the only(!) reliable way to check if the validation failed is AgaviRequest::hasErrors(), the other methods will return the errors with the notice severity too and getErrorNames and hasError will actually return the fields with severity none as well)
- removed getRequest and reportError from validator containers
- fixed operator validators not storing their name
- added new result for not executed validators
- renamed hasAllArgumentsSet to checkAllArgumentsSet
- removed getAffectedFields completely (this currently makes the affects parameter of a validator useless)
- fixed the isset validator when used with a base and when the field was empty
- a whole lot of new methods for the validatorManager

refs #367

Location:

branches/0.11

Files:

• src/request/AgaviRequest.class.php (modified) (11 diffs)
• src/validator/AgaviBaseFileValidator.class.php (modified) (2 diffs)
• src/validator/AgaviIValidatorContainer.interface.php (modified) (2 diffs)
• src/validator/AgaviIssetValidator.class.php (modified) (2 diffs)
• src/validator/AgaviOperatorValidator.class.php (modified) (3 diffs)
• src/validator/AgaviValidationError.class.php (added)
• src/validator/AgaviValidationIncident.class.php (added)
• src/validator/AgaviValidator.class.php (modified) (11 diffs)
• src/validator/AgaviValidatorManager.class.php (modified) (10 diffs)
• tests2/request/RequestTest.php (modified) (3 diffs)

branches/0.11/src/request/AgaviRequest.class.php

@@ -96 +96 @@
   public function getError($name)
   {
-    $errors = $this->getAttribute('errors', 'org.agavi.validation.result', array());
-    $retval = null;
-
-    if(isset($errors[$name]['messages'][0])) {
-      $retval = $errors[$name]['messages'][0];
-    }
-
-    return $retval;
+    $vm = $this->getContext()->getValidatorManager();
+    $incidents = $vm->getFieldIncidents($name, AgaviValidator::NOTICE);
+
+    if(count($incidents) == 0) {
+      return null;
+    }
+
+    $errors = $incidents[0]->getErrors();
+    return $errors[0]->getMessage();
   }
 
@@ -117 +118 @@
   public function getErrorNames()
   {
-    $errors = $this->getAttribute('errors', 'org.agavi.validation.result', array());
-    if(isset($errors[''])) {
-      unset($errors['']);
-    }
-    return array_keys($errors);
+    return $this->getContext()->getValidatorManager()->getFailedFields();
   }
 
@@ -139 +136 @@
   public function getErrors($name = null)
   {
-    $errors = $this->getAttribute('errors', 'org.agavi.validation.result', array());
+    $vm = $this->getContext()->getValidatorManager();
+    $errors = array();
+
+    foreach($vm->getIncidents(AgaviValidator::NOTICE) as $incident) {
+      $validator = $incident->getValidator();
+      foreach($incident->getErrors() as $error) {
+        $msg = $error->getMessage();
+        foreach($error->getFields() as $field) {
+          if(!isset($errors[$field])) {
+            $errors[$field] = array('messages' => array(), 'validators' => array());
+          }
+          $errors[$field]['messages'][] = $msg;
+          if($validator) {
+            $errors[$field]['validators'][] = $validator->getName();
+          }
+        }
+      }
+    }
+
     if($name === null) {
       return $errors;
@@ -161 +176 @@
   public function getErrorMessages($name = null)
   {
-    $errors = $this->getAttribute('errors', 'org.agavi.validation.result', array());
+    $vm = $this->getContext()->getValidatorManager();
 
     if($name !== null) {
-      return isset($errors[$name]['messages']) ? $errors[$name]['messages'] : null;
+      $incidents = $vm->getFieldIncidents($name, AgaviValidator::NOTICE);
+      $msgs = array();
+      foreach($incidents as $incident) {
+        foreach($incident->getErrors() as $error) {
+          $msgs[] = $error->getMessage();
+        }
+      }
+      return $msgs;
     } else {
       $msgs = array();
 
-      foreach($errors as $errorName => $error) {
-        foreach($error['messages'] as $message) {
-          if(!isset($msgs[$message])) {
-            $msgs[$message] = array();
-          }
-          $msgs[$message][] = $errorName;
+      $incidents = $vm->getIncidents(AgaviValidator::NOTICE);
+      $msgs = array();
+      foreach($incidents as $incident) {
+        foreach($incident->getErrors() as $error) {
+          $msgs[] = array('message' => $error->getMessage(), 'errors' => $error->getFields());
         }
       }
-
-      $retMsgs = array();
-      $i = 0;
-      foreach($msgs as $message => $errorNames) {
-        $retMsgs[$i] = array('message' => $message, 'errors' => $errorNames);
-        ++$i;
-      }
-      return $retMsgs;
+      return $msgs;
     }
   }
@@ -214 +228 @@
   public function hasError($name)
   {
-    $errors = $this->getAttribute('errors', 'org.agavi.validation.result', array());
-    return isset($errors[$name]);
+    return $this->getContext()->getValidatorManager()->isFieldFailed($name);
   }
 
@@ -230 +243 @@
   public function hasErrors()
   {
-    return (count($this->getAttribute('errors', 'org.agavi.validation.result', array())) > 0);
+    return $this->getContext()->getValidatorManager()->getResult() > AgaviValidator::NOTICE;
   }
 
@@ -262 +275 @@
 
   /**
-   * Remove an error.
-   *
-   * @param      string An error name.
-   *
-   * @return     string An error message, if the error was removed, otherwise
-   *                    null.
-   *
-   * @author     Sean Kerr <skerr@mojavi.org>
-   * @author     David Zuelke <dz@bitxtender.com>
-   * @author     Dominik del Bondio <ddb@bitxtender.com>
-   * @since      0.9.0
-   */
-  public function removeError($name)
-  {
-    $errors =& $this->getAttribute('errors', 'org.agavi.validation.result', array());
-    $retval = null;
-
-    if(isset($errors[$name])) {
-      $retval = $errors[$name];
-      unset($errors[$name]);
-    }
-
-    return $retval;
-  }
-
-  /**
    * Set an error.
    *
@@ -293 +280 @@
    * @param      string An error message.
    *
-   * @author     Sean Kerr <skerr@mojavi.org>
    * @author     Dominik del Bondio <ddb@bitxtender.com>
    * @since      0.9.0
@@ -299 +285 @@
   public function setError($name, $message)
   {
-    // set the attribute first if it doesn't exist, else we will not a proper 
-    // reference to the attribute.
-    if(!$this->hasAttribute('errors', 'org.agavi.validation.result')) {
-      $this->setAttribute('errors', array(), 'org.agavi.validation.result');
-    }
-    $errors =& $this->getAttribute('errors', 'org.agavi.validation.result');
-    if(!isset($errors[$name])) {
-      $errors[$name] = array('messages' => array(), 'validators' => array());
-    }
-    $errors[$name]['messages'][] = $message;
+    $vm = $this->getContext()->getValidatorManager();
+    $incident = new AgaviValidationIncident(null, AgaviValidator::ERROR);
+    $incident->addError(new AgaviValidationError($message, null, array($name)));
+    $vm->addIncident($incident);
   }
 
@@ -321 +301 @@
    *                   messages.
    *
-   * @author     Sean Kerr <skerr@mojavi.org>
    * @author     Dominik del Bondio <ddb@bitxtender.com>
    * @since      0.9.0
@@ -327 +306 @@
   public function setErrors(array $errors)
   {
-    // set the attribute first if it doesn't exist, else we will not a proper 
-    // reference to the attribute.
-    if(!$this->hasAttribute('errors', 'org.agavi.validation.result')) {
-      $this->setAttribute('errors', array(), 'org.agavi.validation.result');
-    }
-    $storedErrors =& $this->getAttribute('errors', 'org.agavi.validation.result', array());
+    $vm = $this->getContext()->getValidatorManager();
+    $incident = new AgaviValidationIncident(null, AgaviValidator::ERROR);
     foreach($errors as $name => $error) {
-      if(!isset($storedErrors[$name])) {
-        $storedErrors[$name] = array('messages' => array(), 'validators' => array());
-      }
-      if(!is_array($error)) {
-        $storedErrors[$name]['messages'][] = $error;
-      } else {
-        $storedErrors[$name]['messages'] = array_merge($storedErrors[$name]['messages'], $error);
-      }
-    }
+      $incident->addError(new AgaviValidationError($error, null, array($name)));
+    }
+
+    $vm->addIncident($incident);
   }
 

branches/0.11/src/validator/AgaviBaseFileValidator.class.php

@@ -41 +41 @@
 abstract class AgaviBaseFileValidator extends AgaviValidator
 {
+
   /**
-   * Returns whether all arguments are files in the request.
+   * Returns whether all arguments are set in the validation input parameters.
+   * Set means anything but empty string.
+   *
+   * @param      bool Whether an error should be thrown for each missing 
+   *                  argument if this validator is required.
    *
    * @return     bool Whether the arguments are set.
@@ -49 +54 @@
    * @since      0.11.0
    */
-  protected function hasAllArgumentsSet()
+  protected function checkAllArgumentsSet($throwError = true)
   {
     $request = $this->getContext()->getRequest();
+
+    $isRequired = $this->getParameter('required', true);
+    $result = true;
+
+    $array = $this->validationParameters->getParameters();
+    $baseParts = $this->curBase->getParts();
     foreach($this->getArguments() as $argument) {
       $new = $this->curBase->pushRetNew($argument);
       $pName = $this->curBase->pushRetNew($argument)->__toString();
       if(!$request->hasFile($pName)) {
-        return false;
+        if($throwError && $isRequired) {
+          $this->throwError(null, $pName);
+        }
+        $result = false;
       }
     }
-    return true;
+    return $result;
   }
-
 
   /**

branches/0.11/src/validator/AgaviIValidatorContainer.interface.php

@@ -40 +40 @@
   
   /**
-   * Fetches the request.
-   * 
-   * @return     AgaviRequest The request to be used by child validators.
-   * 
-   * @author     Uwe Mesecke <uwe@mesecke.net>
-   * @since      0.11.0
-   */
-  public function getRequest();
-  
-  /**
    * Fetches the dependency manager
    * 
@@ -60 +50 @@
   public function getDependencyManager();
 
-  /**
-   * Reports an error to the parent container.
-   * 
-   * @param      AgaviValidator The validator where the error occured.
-   * @param      string         An error message.
-   * 
-   * @author     Dominik del Bondio <ddb@bitxtender.com>
-   * @since      0.11.0
-   */
-  public function reportError(AgaviValidator $validator, $errorMsg);
 }
 ?>

branches/0.11/src/validator/AgaviIssetValidator.class.php

@@ -32 +32 @@
 {
   /**
+   * We return true here no matter what because we will check for existance
+   * ourself.
+   *
+   * @param      bool Whether an error should be thrown for each missing 
+   *                  argument if this validator is required.
+   *
+   * @return     bool Whether the arguments are set.
+   *
+   * @author     Dominik del Bondio <ddb@bitxtender.com>
+   * @since      0.11.0
+   */
+  protected function checkAllArgumentsSet($throwError = true)
+  {
+    return true;
+  }
+
+  /**
    * Validates the input.
    * 
@@ -41 +58 @@
   protected function validate()
   {
+    $params = $this->validationParameters->getParameters();
+
     foreach($this->getArguments() as $argument) {
-      if(!$this->parentContainer->getRequest()->hasParameter($argument)) {
+      if(!$this->curBase->hasValueByChildPath($argument, $params)) {
         $this->throwError();
         return false;

branches/0.11/src/validator/AgaviOperatorValidator.class.php

@@ -55 +55 @@
    * @since      0.11.0
    */
-  public function __construct(AgaviIValidatorContainer $parent, array $arguments, array $errors = array(), array $parameters = array())
+  public function __construct(AgaviIValidatorContainer $parent, array $arguments, array $errors = array(), array $parameters = array(), $name = '')
   {
-    parent::__construct($parent, $arguments, $errors, $parameters);
+    parent::__construct($parent, $arguments, $errors, $parameters, $name);
     
     if($this->getParameter('skip_errors')) {
@@ -101 +101 @@
   
   /**
-   * Submits an error to the error manager.
-   * 
-   * The stuff in the parameter specified in $index is submitted to the
-   * error manager. If there is no parameter with this name, then 'error'
-   * is tryed as an parameter and if even this fails, the stuff in
-   * $backupError is sent.
-   * 
-   * @param      string The name of the error parameter to fetch the message 
-   *                    from.
-   * @param      string An default error message to be used if the given error 
-   *                    has no message set.
-   *
-   * @author     Uwe Mesecke <uwe@mesecke.net>
-   * @since      0.11.0
-   */
-  protected function throwError($index = null, $backupError = null)
-  {
-    $error = $this->getErrorMessage($index, $backupError);
-
-    // if no error msg was supplied rethrow the child errors
-    if($error === null) {
-      foreach($this->errors as $childError) {
-        $this->parentContainer->reportError($childError[0], $childError[1]);
-      }
-    } else {
-      if($this->hasParameter('translation_domain')) {
-        $error = $this->getContext()->getTranslationManager()->_($error, $this->getParameter('translation_domain'));
-      }
-
-      $this->parentContainer->reportError($this, $error);
-    }
-  }
-
-  /**
-   * Reports an error to the parent container.
-   * 
-   * @param      AgaviValidator The validator where the error occured.
-   * @param      string         An error message.
-   * 
-   * @author     Dominik del Bondio <ddb@bitxtender.com>
-   * @since      0.11.0
-   * @see        AgaviIValidatorContainer::reportError
-   */
-  public function reportError(AgaviValidator $validator, $errorMsg)
-  {
-    $this->errors[] = array($validator, $errorMsg);
-  }
-  
-  /**
    * Adds new child validator.
    * 
@@ -175 +126 @@
       $this->addChild($validator);
     }
-  }
-  
-  /**
-   * Gets the request from the parent.
-   * 
-   * @return     AgaviRequest The parent's request.
-   *
-   * @author     Uwe Mesecke <uwe@mesecke.net>
-   * @since      0.11.0
-   */
-  public function getRequest()
-  {
-    return $this->parentContainer->getRequest();
   }
   

branches/0.11/src/validator/AgaviValidator.class.php

@@ -43 +43 @@
 {
   /**
+   * validator field success flag
+   */
+  const NOT_PROCESSED = -1;
+
+  /**
    * validator error severity (the validator succeeded)
    */
@@ -107 +112 @@
 
   /**
-   * @var        array The field names which have been validated by this
-   *                   validator
-   */
-  protected $validatedFieldnames = array();
-
-  /**
    * @var        array The name of the request parameters serving as argument to
    *                   this validator.
@@ -124 +123 @@
 
   /**
-   * @var        string The last error index. When the validator throws an error
-   *                    the index which was thrown is stored here.
-   */
-  protected $lastErrorIndex = null;
+   * @var        AgaviValidationIncident The current incident.
+   */
+  protected $incident = null;
 
   /**
@@ -382 +380 @@
    * Set means anything but empty string.
    *
+   * @param      bool Whether an error should be thrown for each missing 
+   *                  argument if this validator is required.
+   *
    * @return     bool Whether the arguments are set.
    *
@@ -387 +388 @@
    * @since      0.11.0
    */
-  protected function hasAllArgumentsSet()
-  {
+  protected function checkAllArgumentsSet($throwError = true)
+  {
+    $isRequired = $this->getParameter('required', true);
+    $result = true;
+
     $array = $this->validationParameters->getParameters();
     $baseParts = $this->curBase->getParts();
@@ -395 +399 @@
       $pName = $this->curBase->pushRetNew($argument)->__toString();
       if(!$this->validationParameters->hasParameter($pName) || $this->validationParameters->getParameter($pName) === "") {
-        return false;
-      }
-    }
-    return true;
+        if($throwError && $isRequired) {
+          $this->throwError(null, $pName);
+        }
+        $result = false;
+      }
+    }
+    return $result;
   }
 
@@ -432 +439 @@
    * Submits an error to the error manager.
    *
-   * The stuff in the parameter specified in $index is submitted to the
-   * error manager. If there is no parameter with this name, then 'error'
-   * is tryed as an parameter and if even this fails, the stuff in
-   * $backupError is sent.
+   * Will look up the index in the errors array with automatic fallback to the
+   * default error. You can optionally specify the fields affected by this 
+   * error. The error will be appended to the current incident.
    *
    * @param      string The name of the error parameter to fetch the message 
    *                    from.
-   * @param      string An default error message to be used if the given error 
-   *                    has no message set.
-   *
-   * @author     Uwe Mesecke <uwe@mesecke.net>
-   * @since      0.11.0
-   */
-  protected function throwError($index = null, $backupError = null)
-  {
-    $this->lastErrorIndex = $index;
-
-    $error = $this->getErrorMessage($index, $backupError);
+   * @param      string|array The arguments which are affected by this error.
+   *                          If null is given it will affect all fields
+   *
+   * @author     Dominik del Bondio <ddb@bitxtender.com>
+   * @since      0.11.0
+   */
+  protected function throwError($index = null, $affectedArgument = null)
+  {
+    if($affectedArgument === null) {
+      $affectedArguments = $this->getFullArgumentNames();
+    } else {
+      $affectedArguments = (array) $affectedArgument;
+    }
+
+    $error = $this->getErrorMessage($index);
 
     if($this->hasParameter('translation_domain')) {
@@ -455 +465 @@
     }
 
-    $this->reportError($this, $error);
-  }
-
-
-  /**
-   * Reports an error to the parent container.
-   *
-   * @param      AgaviValidator The validator where the error occured.
-   * @param      string         An error message.
-   *
-   * @author     Dominik del Bondio <ddb@bitxtender.com>
-   * @since      0.11.0
-   * @see        AgaviIValidatorContainer::reportError
-   */
-  public function reportError(AgaviValidator $validator, $errorMsg)
-  {
-    if(self::mapErrorCode($this->getParameter('severity', 'error')) > self::NONE) {
-      $this->parentContainer->reportError($validator, $errorMsg);
-    }
-  }
-
-  /**
-   * Returns a list of input fields that are per default affected by a failure
-   * of the validator
-   *
-   * The list consists of the fields in the parameters that are lists in
-   * affectedFieldNames and the space seperated list of fields in the
-   * parameter 'affects'.
-   *
-   * @return     array The list of fields that are affected by an error.
-   *
-   * @author     Uwe Mesecke <uwe@mesecke.net>
-   * @since      0.11.0
-   */
-  public function getAffectedFields()
-  {
-    $fields = array();
-    $base = $this->curBase->__toString();
-
-    if($this->hasParameter('affects')) {
-      $f = array_map('trim', explode(' ', trim($this->getParameter('affects'))));
-      foreach($f as $n) {
-        if(!strlen($n)) {
-          continue;
-        }
-        $fields[] = $n;
-      }
-    }
-
-    $fields = array_merge($fields, $this->validatedFieldnames);
-    // filter out empty strings
-    $fields = array_filter($fields, 'strlen');
-
-    return array_unique($fields);
-  }
+    if(!$this->incident) {
+      $this->incident = new AgaviValidationIncident($this, self::mapErrorCode($this->getParameter('severity', 'error')));
+    }
+
+    $this->incident->addError(new AgaviValidationError($error, $index, $affectedArguments));
+  }
+
 
   /**
@@ -560 +522 @@
       }
 
-      $fieldNames = array();
-      foreach($this->getArguments() as $argument) {
-        $name = $this->curBase->pushRetNew($argument)->__toString();
-        $fieldNames[] = $name;
-        $this->validatedFieldnames[] = $name;
-      }
+      $fieldnames = $this->getFullArgumentNames();
 
       $result = self::SUCCESS;
       $errorCode = self::mapErrorCode($this->getParameter('severity', 'error'));
 
-      if($this->hasAllArgumentsSet()) {
+      if($this->checkAllArgumentsSet(false)) {
         if(!$this->validate()) {
           // validation failed, exit with configured error code
@@ -580 +537 @@
           $result = $errorCode;
         } else {
-          // no reason to throw any error since it wouldn't be included anyways
-          $result = self::NONE;
+          // we don't throw an error here because this is not an incident per se
+          // but rather a non validated field
+          $result = self::NOT_PROCESSED;
         }
       }
 
       $vm = $this->getContext()->getValidatorManager();
-      foreach($fieldNames as $fieldName) {
-        $vm->addFieldResult($this, $fieldName, $result, $this->lastErrorIndex);
+      foreach($fieldnames as $fieldname) {
+        $vm->addFieldResult($this, $fieldname, $result);
+      }
+
+      if($this->incident) {
+        $vm->addIncident($this->incident);
+        $this->incident = null;
       }
 
@@ -722 +685 @@
   }
 
+  /**
+   * Returns all arguments with their full path.
+   *