Changeset 3045

Timestamp:

10/16/08 18:06:59 (3 months ago)

Author:

felix

Message:

Merged revisions 3041-3044 via svnmerge from
http://svn.agavi.org/branches/1.0

........

r3041 | david | 2008-10-16 19:50:17 +0200 (Thu, 16 Oct 2008) | 1 line

Ported AgaviValidatorConfigHandler? to XML config system, refs #519

........

r3042 | david | 2008-10-16 19:57:33 +0200 (Thu, 16 Oct 2008) | 1 line

Changelog update, closes #785

........

r3043 | david | 2008-10-16 19:59:20 +0200 (Thu, 16 Oct 2008) | 1 line

Another changelog entry, closes #786

........

r3044 | david | 2008-10-16 20:02:16 +0200 (Thu, 16 Oct 2008) | 1 line

release notes, refs #785

........

Location:

branches/felix-testing-implementation

Files:

• . (modified) (1 prop)
• CHANGELOG (modified) (1 diff)
• RELEASE_NOTES (modified) (1 diff)
• src/config/AgaviValidatorConfigHandler.class.php (modified) (5 diffs)
• src/config/defaults/config_handlers.xml (modified) (1 diff)
• src/config/defaults/validators.xml (copied) (copied from branches/1.0/src/config/defaults/validators.xml)
• src/config/rng/_common.rng (modified) (1 diff)
• src/config/rng/validators.rng (copied) (copied from branches/1.0/src/config/rng/validators.rng)
• src/config/xsl/_common.xsl (modified) (3 diffs)
• src/config/xsl/validators.xsl (copied) (copied from branches/1.0/src/config/xsl/validators.xsl)

branches/felix-testing-implementation/CHANGELOG

@@ -5 +5 @@
 -------------------------------
 
+CHG: Change Form Population Filter to use validation system's ability to more accurately handle different sources of input (#786) (David)
+CHG: Validation system needs to be able to tell two fields of same names, but from different sources, apart (#785) (Dominik)
 CHG: Change singular/plural handling in AgaviXmlConfigDomElement convenience methods (#878) (David)
 

branches/felix-testing-implementation/RELEASE_NOTES

@@ -71 +71 @@
 Validation
 ----------
+A new API for accessing information about the result of a validation run is available through AgaviValidationManager::getReport(). It is more consistent and capable of the previous APIs which have been deprecated. This change also fixes some problems where the validation system could not reliably tell input from different sources apart.
+
 Validators are not handed a "method" parameter anymore with the request method they should run for. This was extremely redundant since the validators weren't even registered if the request method was "wrong". For manual registering, registerReadValidators(), registerWriteValidators() etc are always used in actions anyway, so no problem here, either. As a result, AgaviValidator::validatesInMethod() is gone, too.
 

branches/felix-testing-implementation/src/config/AgaviValidatorConfigHandler.class.php

@@ -30 +30 @@
  * @version    $Id$
  */
-class AgaviValidatorConfigHandler extends AgaviConfigHandler
+class AgaviValidatorConfigHandler extends AgaviXmlConfigHandler
 {
+  const XML_NAMESPACE = 'http://agavi.org/agavi/config/parts/validators/1.0';
+  
   /**
    * @var        array operator => validator mapping
@@ -55 +57 @@
    * @since      0.11.0
    */
-  public function execute($config, $context = null)
+  public function execute(AgaviXmlConfigDomDocument $document)
   {
-    $this->classMap = array(
-      'and' => array('class' => 'AgaviAndoperatorValidator', 'parameters' => array('break' => '1')),
-      'datetime' => array('class' => 'AgaviDateTimeValidator', 'parameters' => array('check' => '1')),
-      'email' => array('class' => 'AgaviEmailValidator', 'parameters' => array()),
-      'equals' => array('class' => 'AgaviEqualsValidator', 'parameters' => array()),
-      'file' => array('class' => 'AgaviFileValidator', 'parameters' => array()),
-      'imagefile' => array('class' => 'AgaviImageFileValidator', 'parameters' => array()),
-      'inarray' => array('class' => 'AgaviInarrayValidator', 'parameters' => array('sep' => ',')),
-      'isset' => array('class' => 'AgaviIssetValidator', 'parameters' => array()),
-      'isnotempty' => array('class' => 'AgaviIsNotEmptyValidator', 'parameters' => array()),
-      'not' => array('class' => 'AgaviNotoperatorValidator', 'parameters' => array()),
-      'number' => array('class' => 'AgaviNumberValidator', 'parameters' => array('type' => 'int')),
-      'or' => array('class' => 'AgaviOroperatorValidator', 'parameters' => array('break' => '1')),
-      'regex' => array('class' => 'AgaviRegexValidator', 'parameters' => array('match' => '1')),
-      'set' => array('class' => 'AgaviSetValidator', 'parameters' => array()),
-      'string' => array('class' => 'AgaviStringValidator', 'parameters' => array('min' => '1')),
-      'xor' => array('class' => 'AgaviXoroperatorValidator', 'parameters' => array()),
-    );
-
-    // parse the config file
-    $configurations = $this->orderConfigurations(AgaviConfigCache::parseConfig($config, true, $this->getValidationFile(), $this->parser)->configurations, AgaviConfig::get('core.environment'), $context);
-
+    $document->setDefaultNamespace(self::XML_NAMESPACE, 'validators');
+    
+    $config = $document->documentURI;
+    
+    $classMap = array();
     $code = array();//array('lines' => array(), 'order' => array());
-
-    foreach($configurations as $cfg) {
-      if(isset($cfg->validator_definitions)) {
-        foreach($cfg->validator_definitions as $vDev) {
-          $name = $vDev->getAttribute('name');
+    
+    foreach($document->getConfigurationElements() as $cfg) {
+      if($cfg->has('validator_definitions')) {
+        foreach($cfg->get('validator_definitions') as $def) {
+          $name = $def->getAttribute('name');
           if(!isset($this->classMap[$name])) {
-            $this->classMap[$name] = array('class' => $vDev->getAttribute('class'), 'parameters' => array());
+            $this->classMap[$name] = array('class' => $def->getAttribute('class'), 'parameters' => array());
           }
-          $this->classMap[$name]['class'] = $vDev->getAttribute('class',$this->classMap[$name]['class']);
-          $this->classMap[$name]['parameters'] = $this->getItemParameters($vDev, $this->classMap[$name]['parameters']);
+          $this->classMap[$name]['class'] = $def->getAttribute('class',$this->classMap[$name]['class']);
+          $this->classMap[$name]['parameters'] = $def->getAgaviParameters($this->classMap[$name]['parameters']);
         }
       }
-
-      if(isset($cfg->validators)) {
-        $hasValidators = false;
-        foreach($cfg->getChildren() as $validators) {
-          if($validators->getName() == 'validators') {
-            $hasValidators = true;
-            $stdSeverity = $validators->getAttribute('severity', 'error');
-            $stdMethod = $validators->getAttribute('method');
-            foreach($validators as $validator) {
-              $code = $this->getValidatorArray($validator, $code, $stdSeverity, 'validationManager', $stdMethod);
-            }
-          }
-        }
-        if(!$hasValidators) {
-          foreach($cfg->validators as $validator) {
-            $code = $this->getValidatorArray($validator, $code, 'error', 'validationManager', null);
-          }
-        }
-      }
+      
+      $code = $this->processValidatorElements($cfg, $code, 'validationManager');
     }
 
@@ -133 +101 @@
    * Builds an array of php code strings, each of them creating a validator
    *
-   * @param      AgaviConfigValueHolder The value holder of this validator.
-   * @param      array  The code of old validators (we simply overwrite "old" 
-   *                    validators here).
-   * @param      string The severity of the parent container.
-   * @param      string The name of the parent container.
-   * @param      string The method of the parent container.
-   * @param      bool Whether the parent container is required.
-   *
-   * @return     array php code blocks that register the validators
+   * @param      AgaviXmlConfigDomElement The value holder of this validator.
+   * @param      array                    The code of old validators (we simply
+   *                                      overwrite "old" validators here).
+   * @param      string                   The name of the parent container.
+   * @param      string                   The severity of the parent container.
+   * @param      string                   The method of the parent container.
+   * @param      bool                     Whether parent container is required.
+   *
+   * @return     array PHP code blocks that register the validators
    *
    * @author     Uwe Mesecke <uwe@mesecke.net>
    * @author     Dominik del Bondio <ddb@bitxtender.com>
+   * @author     David Zülke <david.zuelke@bitextender.com>
    * @since      0.11.0
    */
-  public function getValidatorArray($validator, $code, $stdSeverity, $parent, $stdMethod, $stdRequired = true)
+  protected function getValidatorArray($validator, $code, $parent, $stdSeverity, $stdMethod, $stdRequired = true)
   {
     if(!isset($this->classMap[$validator->getAttribute('class')])) {
@@ -179 +148 @@
     $parameters = array_merge($this->classMap[$validator->getAttribute('class')]['parameters'], $parameters);
     $parameters = array_merge($parameters, $validator->getAttributes());
-    $parameters = $this->getItemParameters($validator, $parameters);
-    if(isset($validator->arguments)) {
-      if($validator->arguments->hasAttribute('base')) {
-        $parameters['base'] = $validator->arguments->getAttribute('base');
-      }
-      $args = array();
-      foreach($validator->arguments as $argument) {
-        if($argument->hasAttribute('name')) {
-          $args[$argument->getAttribute('name')] = $argument->getValue();
-        } else {
-          $args[] = $argument->getValue();
+    $parameters = $validator->getAgaviParameters($parameters);
+    
+    foreach($validator->get('arguments') as $argument) {
+      // let's see if this buddy has a <arguments> parent with valuable information
+      if($argument->parentNode->localName == 'arguments') {
+        if($argument->parentNode->hasAttribute('base')) {
+          $parameters['base'] = $argument->parentNode->getAttribute('base');
         }
       }
-      $arguments = $args;
-    }
-    if(isset($validator->errors)) {
-      foreach($validator->errors as $error) {
-        if($error->hasAttribute('for')) {
-          $errors[$error->getAttribute('for')] = $error->getValue();
-        } else {
-          $errors[''] = $error->getValue();
-        }
-      }
-    }
+      
+      if($argument->hasAttribute('name')) {
+        $arguments[$argument->getAttribute('name')] = $argument->getValue();
+      } else {
+        $arguments[] = $argument->getValue();
+      }
+    }
+    
+    foreach($validator->get('errors') as $error) {
+      if($error->hasAttribute('for')) {
+        $errors[$error->getAttribute('for')] = $error->getValue();
+      } else {
+        $errors[''] = $error->getValue();
+      }
+    }
+    
     if($validator->hasAttribute('required')) {
       $stdRequired = $parameters['required'] = AgaviToolkit::literalize($validator->getAttribute('required'));
@@ -233 +203 @@
       ));
     }
-
-    if(isset($validator->validators)) {
-      $childSeverity = $validator->validators->getAttribute('severity', $stdSeverity);
-      $childMethod = $validator->validators->getAttribute('method', $stdMethod);
-      $childRequired = $stdRequired;
-      if($validator->validators->hasAttribute('required')) {
-        $childRequired = AgaviToolkit::literalize($validator->validators->getAttribute('required'));
-      }
-      foreach($validator->validators as $v) {
-        $code = $this->getValidatorArray($v, $code, $childSeverity, $name, $childMethod, $childRequired);
-      }
-        // create child validators
-    }
-
+    
+    // more <validator> or <validators> children
+    $code = $this->processValidatorElements($validator, $code, $name, $stdSeverity, $stdMethod, $stdRequired);
+    
+    return $code;
+  }
+  
+  /**
+   * Grabs generated code from the given element.
+   *
+   * @see        AgaviValidatorConfigHandler::getValidatorArray()
+   *
+   * @param      AgaviXmlConfigDomElement The value holder of this validator.
+   * @param      array                    The code of old validators (we simply
+   *                                      overwrite "old" validators here).
+   * @param      string                   The severity of the parent container.
+   * @param      string                   The name of the parent container.
+   * @param      string                   The method of the parent container.
+   * @param      bool                     Whether parent container is required.
+   *
+   * @return     array PHP code blocks that register the validators
+   *
+   * @author     Uwe Mesecke <uwe@mesecke.net>
+   * @author     Dominik del Bondio <ddb@bitxtender.com>
+   * @author     David Zülke <david.zuelke@bitextender.com>
+   * @since      0.11.0
+   */
+  protected function processValidatorElements($node, $code, $name, $defaultSeverity = 'error', $defaultMethod = null, $defaultRequired = true)
+  {
+    // the problem here is that the <validators> parent is not just optional, but can also occur more than once
+    foreach($node->get('validators') as $validator) {
+      // let's see if this buddy has a <validators> parent with valuable information
+      if($validator->parentNode->localName == 'validators') {
+        $severity = $validator->parentNode->getAttribute('severity', $defaultSeverity);
+        $method = $validator->parentNode->getAttribute('method', $defaultMethod);
+        $required = $defaultRequired;
+      }
+      
+      // append the code to generate
+      $code = $this->getValidatorArray($validator, $code, $name, $severity, $method, $required);
+    }
+    
     return $code;
   }

branches/felix-testing-implementation/src/config/defaults/config_handlers.xml

@@ -109 +109 @@
 
       <handler pattern="%core.module_dir%/*/validate/*.xml" class="AgaviValidatorConfigHandler">
-        <validation>%core.agavi_dir%/config/xsd/validators.xsd</validation>
+        <validation>%core.agavi_dir%/config/rng/validators.rng</validation>
+        <transformation>%core.agavi_dir%/config/xsl/validators.xsl</transformation>
       </handler>
 

branches/felix-testing-implementation/src/config/rng/_common.rng

@@ -120 +120 @@
   </define>
   
+  <define name="data-nestring">
+    <data type="string">
+      <param name="minLength">1</param>
+    </data>
+  </define>
+  
   <define name="data-identifier">
     <data type="string">

branches/felix-testing-implementation/src/config/xsl/_common.xsl

@@ -3 +3 @@
   version="1.0"
   xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+  xmlns:exslt-common="http://exslt.org/common"
+  xmlns:saxon="http://icl.com/saxon"
   xmlns:envelope_0_11="http://agavi.org/agavi/1.0/config"
   xmlns:envelope_1_0="http://agavi.org/agavi/config/global/envelope/1.0">
@@ -12 +14 @@
   <xsl:template name="_common-migrate-envelope-element">
     <!-- param for the target namespace; defaults to 1.0 -->
-    <xsl:param name="namespace"><xsl:value-of select="$envelope_1_0" /></xsl:param>
+    <xsl:param name="namespace" select="$envelope_1_0" />
+    <!-- attributes to insert, defaults to empty node set -->
+    <xsl:param name="attributes" select="self::node()[false()]" />
     
     <xsl:call-template name="_common-migrate-element">
-      <xsl:with-param name="namespace"><xsl:value-of select="$namespace" /></xsl:with-param>
+      <xsl:with-param name="namespace" select="$namespace" />
+      <xsl:with-param name="attributes" select="$attributes" />
     </xsl:call-template>
   </xsl:template>
@@ -22 +27 @@
     <!-- param for the target namespace; no default -->
     <xsl:param name="namespace" />
+    <!-- attributes to insert, defaults to empty node set -->
+    <xsl:param name="attributes" select="self::node()[false()]" />
     
     <!-- create an element of the same name -->
     <xsl:element name="{local-name()}" namespace="{$namespace}">
-      <xsl:copy-of select="@*" />
       <!-- also copy all namespace declarations, except the one of the current element (otherwise, we'd overwrite the namespace in the <element> above if it's just xmlns etc) -->
       <xsl:copy-of select="namespace::*[not(. = namespace-uri(current()))]" />
+      <xsl:copy-of select="@*" />
+      <xsl:copy-of select="exslt-common:node-set($attributes)//@*" />
       <xsl:apply-templates />
     </xsl:element>