Changeset 1642

Timestamp:

02/04/07 22:18:34 (2 years ago)

Author:

david

Message:

each container has its own validation manager now. all error-related methods moved from request to validation manager. sample app adjusted accordingly. closes #406, fixes #405

Location:

branches/0.11

Files:

• samples/app/modules/Default/templates/Master.php (modified) (1 diff)
• src/config/AgaviFactoryConfigHandler.class.php (modified) (1 diff)
• src/controller/AgaviExecutionContainer.class.php (modified) (2 diffs)
• src/core/AgaviContext.class.php (modified) (3 diffs)
• src/filter/AgaviExecutionFilter.class.php (modified) (1 diff)
• src/filter/AgaviFormPopulationFilter.class.php (modified) (3 diffs)
• src/request/AgaviRequest.class.php (modified) (4 diffs)
• src/validator/AgaviValidationManager.class.php (modified) (1 diff)
• src/validator/AgaviValidator.class.php (modified) (3 diffs)

branches/0.11/samples/app/modules/Default/templates/Master.php

@@ -160 +160 @@
     <div id="content">
       <h2><?php echo $template['title']; ?></h2>
-<?php if($rq->hasErrors()): foreach($rq->getErrorMessages() as $error): ?>
+<?php if($container->getValidationManager()->hasErrors()): foreach($container->getValidationManager()->getErrorMessages() as $error): ?>
       <p class="error"><?php echo $error['message']; ?></p>
 <?php endforeach; endif; ?>

branches/0.11/src/config/AgaviFactoryConfigHandler.class.php

@@ -162 +162 @@
         $data['validation_manager']['params'] = $this->getItemParameters($cfg->validation_manager, $data['validation_manager']['params']);
 
-        $data['validation_manager_code'] =  '$this->validationManager = new ' . $data['validation_manager']['class'] . '();' . "\n" .
-                                          '$this->validationManager->initialize($this, ' . var_export($data['validation_manager']['params'], true) . ');';
+        $data['validation_manager_code'] =  '$this->factories["validation_manager"] = array("class" => "' . $data['validation_manager']['class'] . '", "parameters" => ' . var_export($data['validation_manager']['params'], true) . ');';
       }
 

branches/0.11/src/controller/AgaviExecutionContainer.class.php

@@ -33 +33 @@
    */
   protected $context = null;
+  
+  /**
+   * @var        AgaviValidationManager The validation manager instance.
+   */
+  protected $validationManager = null;
   
   /**
@@ -361 +366 @@
   
   /**
+   * Retrieve the ValidationManager
+   *
+   * @return     AgaviValidationManager The container's ValidationManager 
+   *                                    implementation instance.
+   *
+   * @author     David Zuelke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function getValidationManager()
+  {
+    if($this->validationManager === null) {
+      $vmfi = $this->context->getFactoryInfo('validation_manager');
+      $this->validationManager = new $vmfi['class']();
+      $this->validationManager->initialize($this->context, $vmfi['parameters']);
+    }
+    return $this->validationManager;
+  }
+  
+  /**
    * Retrieve this container's request data holder instance.
    *

branches/0.11/src/core/AgaviContext.class.php

@@ -48 +48 @@
     'execution_filter' => null,
     'filter_chain' => null,
-    'security_filter' => null
+    'response' => null,
+    'security_filter' => null,
+    'validation_manager' => null,
   );
   
@@ -86 +88 @@
    */
   protected $user = null;
-  
-  /**
-   * @var        AgaviValidationManager A ValidationManager instance.
-   */
-  protected $validationManager = null;
   
   /**
@@ -496 +493 @@
     return $this->user;
   }
-  
-  /**
-   * Retrieve the ValidationManager
-   *
-   * @return     AgaviValidationManager The current ValidationManager 
-   *                                    implementation instance.
-   *
-   * @author     David Zuelke <dz@bitxtender.com>
-   * @since      0.11.0
-   */
-  public function getValidationManager()
-  {
-    return $this->validationManager;
-  }
 }
 

branches/0.11/src/filter/AgaviExecutionFilter.class.php

@@ -460 +460 @@
     $controller = $this->context->getController();
     $request = $this->context->getRequest();
-    $validationManager = $this->context->getValidationManager();
-    // clear the validator manager for reuse
-    $validationManager->clear();
+    $validationManager = $container->getValidationManager();
 
     // get the current action instance

branches/0.11/src/filter/AgaviFormPopulationFilter.class.php

@@ -87 +87 @@
     $req = $this->getContext()->getRequest();
     
+    $vm = null;
+    
     $cfg = array_merge(array('populate' => null, 'skip' => null), $this->getParameters(), $req->getAttributes('org.agavi.filter.FormPopulationFilter'));
     
@@ -230 +232 @@
           continue;
         }
+      }
+      
+      // no validation manager set yet? let's do that. the later, the better.
+      if($vm === null) {
+        $vm = $container->getValidationManager();
       }
       
@@ -303 +310 @@
         
         // there's an error with the element's name in the request? good. let's give the baby a class!
-        if($req->hasError($pname)) {
+        if($vm->hasError($pname)) {
           $element->setAttribute('class', preg_replace('/\s*$/', ' ' . $cfg['error_class'], $element->getAttribute('class')));
           // assign the class to all implicit labels

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

@@ -31 +31 @@
 abstract class AgaviRequest extends AgaviAttributeHolder
 {
-
   /**
    * @var        array An associative array of attributes
@@ -86 +85 @@
   }
 
-
-  /**
-   * Retrieve an error message.
-   *
-   * @param      string An error name.
-   *
-   * @return     string The error message.
+  /**
+   * Retrieve this request's method.
+   *
+   * @return     string The request method name
    *
    * @author     Sean Kerr <skerr@mojavi.org>
-   * @author     Dominik del Bondio <ddb@bitxtender.com>
-   * @since      0.9.0
-   */
-  public function getError($name)
-  {
-    $vm = $this->getContext()->getValidationManager();
-    $incidents = $vm->getFieldIncidents($name, AgaviValidator::NOTICE);
-
-    if(count($incidents) == 0) {
-      return null;
-    }
-
-    $errors = $incidents[0]->getErrors();
-    return $errors[0]->getMessage();
-  }
-
-  /**
-   * Retrieve an array of error names.
-   *
-   * @return     array An indexed array of error names.
-   *
-   * @author     Sean Kerr <skerr@mojavi.org>
-   * @author     Dominik del Bondio <ddb@bitxtender.com>
-   * @since      0.9.0
-   */
-  public function getErrorNames()
-  {
-    return $this->getContext()->getValidationManager()->getFailedFields();
-  }
-
-  /**
-   * Retrieve an array of errors.
-   *
-   * @param      string An optional error name.
-   *
-   * @return     array An associative array of errors(if no name was given) as
-   *                   an array with the error messages (key 'messages') and
-   *                   the validators (key 'validators') which failed.
-   *
-   * @author     Sean Kerr <skerr@mojavi.org>
-   * @author     Dominik del Bondio <ddb@bitxtender.com>
-   * @since      0.9.0
-   */
-  public function getErrors($name = null)
-  {
-    $vm = $this->getContext()->getValidationManager();
-    $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;
-    } else {
-      return isset($errors[$name]) ? $errors[$name] : null;
-    }
-  }
-
-  /**
-   * Retrieve an array of error Messages.
-   *
-   * @param      string An optional error name.
-   *
-   * @return     array An indexed array of error messages (if a name was given)
-   *                   or an indexed array in this format:
-   *                   array('message' => string, 'errors' => array(string))
-   *
-   * @author     Dominik del Bondio <ddb@bitxtender.com>
-   * @since      0.11.0
-   */
-  public function getErrorMessages($name = null)
-  {
-    $vm = $this->getContext()->getValidationManager();
-
-    if($name !== 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();
-
-      $incidents = $vm->getIncidents(AgaviValidator::NOTICE);
-      $msgs = array();
-      foreach($incidents as $incident) {
-        foreach($incident->getErrors() as $error) {
-          $msgs[] = array('message' => $error->getMessage(), 'errors' => $error->getFields());
-        }
-      }
-      return $msgs;
-    }
-  }
-
-  /**
-   * Retrieve this request's method.
-   *
-   * @return     string The request method name
-   *
-   * @author     Sean Kerr <skerr@mojavi.org>
    * @author     David Zuelke <dz@bitxtender.com>
    * @since      0.9.0
@@ -217 +97 @@
   {
     return $this->method;
-  }
-
-  /**
-   * Indicates whether or not an error exists.
-   *
-   * @param      string An error name.
-   *
-   * @return     bool true, if the error exists, otherwise false.
-   *
-   * @author     Sean Kerr <skerr@mojavi.org>
-   * @author     Dominik del Bondio <ddb@bitxtender.com>
-   * @since      0.9.0
-   */
-  public function hasError($name)
-  {
-    return $this->getContext()->getValidationManager()->isFieldFailed($name);
-  }
-
-
-  /**
-   * Indicates whether or not any errors exist.
-   *
-   * @return     bool true, if any error exist, otherwise false.
-   *
-   * @author     Sean Kerr <skerr@mojavi.org>
-   * @author     Dominik del Bondio <ddb@bitxtender.com>
-   * @since      0.9.0
-   */
-  public function hasErrors()
-  {
-    return $this->getContext()->getValidationManager()->getResult() > AgaviValidator::NOTICE;
   }
 
@@ -278 +127 @@
       $this->actionAccessor = $parameters['action_accessor'];
     }
-  }
-
-  /**
-   * Set an error.
-   *
-   * @param      string An error name.
-   * @param      string An error message.
-   *
-   * @author     Dominik del Bondio <ddb@bitxtender.com>
-   * @since      0.9.0
-   */
-  public function setError($name, $message)
-  {
-    $vm = $this->getContext()->getValidationManager();
-    $incident = new AgaviValidationIncident(null, AgaviValidator::ERROR);
-    $incident->addError(new AgaviValidationError($message, null, array($name)));
-    $vm->addIncident($incident);
-  }
-
-
-  /**
-   * Set an array of errors
-   *
-   * If an existing error name matches any of the keys in the supplied
-   * array, the associated message will be appended to the messages array.
-   *
-   * @param      array An associative array of errors and their associated
-   *                   messages.
-   *
-   * @author     Dominik del Bondio <ddb@bitxtender.com>
-   * @since      0.9.0
-   */
-  public function setErrors(array $errors)
-  {
-    $vm = $this->getContext()->getValidationManager();
-    $incident = new AgaviValidationIncident(null, AgaviValidator::ERROR);
-    foreach($errors as $name => $error) {
-      $incident->addError(new AgaviValidationError($error, null, array($name)));
-    }
-
-    $vm->addIncident($incident);
   }
 

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

@@ -666 +666 @@
     return array_values(array_unique($fields));
   }
+
+  /**
+   * Retrieve an error message.
+   *
+   * @param      string An error name.
+   *
+   * @return     string The error message.
+   *
+   * @author     Sean Kerr <skerr@mojavi.org>
+   * @author     Dominik del Bondio <ddb@bitxtender.com>
+   * @since      0.9.0
+   */
+  public function getError($name)
+  {
+    $incidents = $this->getFieldIncidents($name, AgaviValidator::NOTICE);
+
+    if(count($incidents) == 0) {
+      return null;
+    }
+
+    $errors = $incidents[0]->getErrors();
+    return $errors[0]->getMessage();
+  }
+
+  /**
+   * Retrieve an array of error names.
+   *
+   * @return     array An indexed array of error names.
+   *
+   * @author     Sean Kerr <skerr@mojavi.org>
+   * @author     Dominik del Bondio <ddb@bitxtender.com>
+   * @since      0.9.0
+   */
+  public function getErrorNames()
+  {
+    return $this->getFailedFields();
+  }
+
+  /**
+   * Retrieve an array of errors.
+   *
+   * @param      string An optional error name.
+   *
+   * @return     array An associative array of errors(if no name was given) as
+   *                   an array with the error messages (key 'messages') and
+   *                   the validators (key 'validators') which failed.
+   *
+   * @author     Sean Kerr <skerr@mojavi.org>
+   * @author     Dominik del Bondio <ddb@bitxtender.com>
+   * @since      0.9.0
+   */
+  public function getErrors($name = null)
+  {
+    $errors = array();
+
+    foreach($this->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;
+    } else {
+      return isset($errors[$name]) ? $errors[$name] : null;
+    }
+  }
+
+  /**
+   * Retrieve an array of error Messages.
+   *
+   * @param      string An optional error name.
+   *
+   * @return     array An indexed array of error messages (if a name was given)
+   *                   or an indexed array in this format:
+   *                   array('message' => string, 'errors' => array(string))
+   *
+   * @author     Dominik del Bondio <ddb@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function getErrorMessages($name = null)
+  {
+
+    if($name !== null) {
+      $incidents = $this->getFieldIncidents($name, AgaviValidator::NOTICE);
+      $msgs = array();
+      foreach($incidents as $incident) {
+        foreach($incident->getErrors() as $error) {
+          $msgs[] = $error->getMessage();
+        }
+      }
+      return $msgs;
+    } else {
+      $msgs = array();
+
+      $incidents = $this->getIncidents(AgaviValidator::NOTICE);
+      $msgs = array();
+      foreach($incidents as $incident) {
+        foreach($incident->getErrors() as $error) {
+          $msgs[] = array('message' => $error->getMessage(), 'errors' => $error->getFields());
+        }
+      }
+      return $msgs;
+    }
+  }
+
+  /**
+   * Indicates whether or not an error exists.
+   *
+   * @param      string An error name.
+   *
+   * @return     bool true, if the error exists, otherwise false.
+   *
+   * @author     Sean Kerr <skerr@mojavi.org>
+   * @author     Dominik del Bondio <ddb@bitxtender.com>
+   * @since      0.9.0
+   */
+  public function hasError($name)
+  {
+    return $this->isFieldFailed($name);
+  }
+
+  /**
+   * Indicates whether or not any errors exist.
+   *
+   * @return     bool true, if any error exist, otherwise false.
+   *
+   * @author     Sean Kerr <skerr@mojavi.org>
+   * @author     Dominik del Bondio <ddb@bitxtender.com>
+   * @since      0.9.0
+   */
+  public function hasErrors()
+  {
+    return $this->getResult() > AgaviValidator::NOTICE;
+  }
+
+  /**
+   * Set an error.
+   *
+   * @param      string An error name.
+   * @param      string An error message.
+   *
+   * @author     Dominik del Bondio <ddb@bitxtender.com>
+   * @since      0.9.0
+   */
+  public function setError($name, $message)
+  {
+    $incident = new AgaviValidationIncident(null, AgaviValidator::ERROR);
+    $incident->addError(new AgaviValidationError($message, null, array($name)));
+    $this->addIncident($incident);
+  }
+
+
+  /**
+   * Set an array of errors
+   *
+   * If an existing error name matches any of the keys in the supplied
+   * array, the associated message will be appended to the messages array.
+   *
+   * @param      array An associative array of errors and their associated
+   *                   messages.
+   *
+   * @author     Dominik del Bondio <ddb@bitxtender.com>
+   * @since      0.9.0
+   */
+  public function setErrors(array $errors)
+  {
+    $incident = new AgaviValidationIncident(null, AgaviValidator::ERROR);
+    foreach($errors as $name => $error) {
+      $incident->addError(new AgaviValidationError($error, null, array($name)));
+    }
+
+    $this->addIncident($incident);
+  }
 }
 ?>

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

@@ -290 +290 @@
     $this->curBase = $parent->getBase();
     $this->parentContainer = $parent;
+    $this->validationManager = $this->parentContainer;
+    while(!($this->validationManager instanceof AgaviValidationManager) && ($this->validationManager = $this->validationManager->getParentContainer())) {
+    }
   }
 
@@ -519 +522 @@
     $cp = $this->curBase->pushRetNew($name);
     $cp->setValueFromArray($array, $value);
-    $this->getContext()->getValidationManager()->addFieldResult($this, $cp->__toString(), AgaviValidator::NOT_PROCESSED);
+    if($this->validationManager !== null) {
+      $this->validationManager->addFieldResult($this, $cp->__toString(), AgaviValidator::NOT_PROCESSED);
+    }
   }
 
@@ -565 +570 @@
       }
 
-      $vm = $this->getContext()->getValidationManager();
-      foreach($fieldnames as $fieldname) {
-        $vm->addFieldResult($this, $fieldname, $result);
-      }
-
-      if($this->incident) {
-        $vm->addIncident($this->incident);
-        $this->incident = null;
-      }
-
+      if($this->validationManager !== null) {
+        foreach($fieldnames as $fieldname) {
+          $this->validationManager->addFieldResult($this, $fieldname, $result);
+        }
+
+        if($this->incident) {
+          $this->validationManager->addIncident($this->incident);
+        }
+      }
+
+      $this->incident = null;
       // put dependencies provided by this validator into manager
       if($result == self::SUCCESS && count($this->getParameter('provides')) > 0) {