Changeset 2641

Timestamp:

08/01/08 13:06:36 (5 months ago)

Author:

impl

Message:

branches/david-xml_only_config_system (refs #519): introduce annotation namespace for internal matched attribute; refactoring

Location:

branches/david-xml_only_config_system/src/config

Files:

• AgaviConfigCache.class.php (modified) (1 diff)
• AgaviConfigParser.class.php (modified) (2 diffs)
• AgaviFactoryConfigHandler.class.php (modified) (1 diff)
• AgaviXmlConfigParser.class.php (modified) (11 diffs)
• rng/_common.rng (modified) (4 diffs)
• rng/factories.rng (modified) (1 diff)
• util/dom/AgaviXmlConfigDomDocument.class.php (modified) (2 diffs)
• util/dom/AgaviXmlConfigDomElement.class.php (modified) (2 diffs)
• xsl/_common.xsl (modified) (1 diff)
• xsl/factories.xsl (modified) (2 diffs)

branches/david-xml_only_config_system/src/config/AgaviConfigCache.class.php

@@ -112 +112 @@
         $data = $handler->execute($doc);
       } catch(AgaviException $e) {
-        throw new $e(sprintf("Compliation of configuration file '%s' failed for the following reason(s):\n\n%s", $config, $e->getMessage()));
+        throw new $e(sprintf("Compilation of configuration file '%s' failed for the following reason(s):\n\n%s", $config, $e->getMessage()));
       }
     } else {

branches/david-xml_only_config_system/src/config/AgaviConfigParser.class.php

@@ -84 +84 @@
   {
     foreach($nodes as $node) {
-      if($node->nodeType == XML_ELEMENT_NODE && (!$node->namespaceURI || $node->namespaceURI == AgaviXmlConfigParser::AGAVI_ENVELOPE_NAMESPACE_0_11)) {
+      if($node->nodeType == XML_ELEMENT_NODE && (!$node->namespaceURI || $node->namespaceURI == AgaviXmlConfigParser::NAMESPACE_AGAVI_ENVELOPE_0_11)) {
         $vh = new AgaviConfigValueHolder();
         $nodeName = $this->convertEncoding($node->localName);
@@ -91 +91 @@
 
         foreach($node->attributes as $attribute) {
-          if((!$attribute->namespaceURI || $attribute->namespaceURI == AgaviXmlConfigParser::AGAVI_ENVELOPE_NAMESPACE_0_11)) {
+          if((!$attribute->namespaceURI || $attribute->namespaceURI == AgaviXmlConfigParser::NAMESPACE_AGAVI_ENVELOPE_0_11)) {
             $vh->setAttribute($this->convertEncoding($attribute->localName), $this->convertEncoding($attribute->nodeValue));
           }

branches/david-xml_only_config_system/src/config/AgaviFactoryConfigHandler.class.php

@@ -33 +33 @@
 class AgaviFactoryConfigHandler extends AgaviXmlConfigHandler
 {
-  const NAMESPACE = 'http://agavi.org/agavi/config/factories/1.0';
+  const NAMESPACE = 'http://agavi.org/agavi/config/item/factories/1.0';
   
   /**

branches/david-xml_only_config_system/src/config/AgaviXmlConfigParser.class.php

@@ -32 +32 @@
 class AgaviXmlConfigParser
 {
-  const AGAVI_ENVELOPE_NAMESPACE_0_11 = 'http://agavi.org/agavi/1.0/config';
-  
-  const AGAVI_ENVELOPE_NAMESPACE_1_0 = 'http://agavi.org/agavi/config/1.0';
-  
-  const AGAVI_ENVELOPE_NAMESPACE_LATEST = self::AGAVI_ENVELOPE_NAMESPACE_1_0;
+  const NAMESPACE_AGAVI_ENVELOPE_0_11 = 'http://agavi.org/agavi/1.0/config';
+  
+  const NAMESPACE_AGAVI_ENVELOPE_1_0 = 'http://agavi.org/agavi/config/envelope/1.0';
+  
+  const NAMESPACE_AGAVI_ENVELOPE_LATEST = self::NAMESPACE_AGAVI_ENVELOPE_1_0;
+  
+  const NAMESPACE_AGAVI_ANNOTATION_1_0 = 'http://agavi.org/agavi/config/annotation/1.0';
+  
+  const NAMESPACE_AGAVI_ANNOTATION_LATEST = self::NAMESPACE_AGAVI_ANNOTATION_1_0;
   
   const VALIDATION_TYPE_XMLSCHEMA = 'xml_schema';
@@ -44 +48 @@
   const VALIDATION_TYPE_SCHEMATRON = 'schematron';
   
-  const SCHEMATRON_ISO_NAMESPACE = 'http://purl.oclc.org/dsdl/schematron';
-  
-  const SVRL_ISO_NAMESPACE = 'http://purl.oclc.org/dsdl/svrl';
-  
-  const XSL_NAMESPACE_1999 = 'http://www.w3.org/1999/XSL/Transform';
+  const NAMESPACE_SCHEMATRON_ISO = 'http://purl.oclc.org/dsdl/schematron';
+  
+  const NAMESPACE_SVRL_ISO = 'http://purl.oclc.org/dsdl/svrl';
+  
+  const NAMESPACE_XSL_1999 = 'http://www.w3.org/1999/XSL/Transform';
   
   /**
@@ -55 +59 @@
    */
   public static $agaviEnvelopeNamespaces = array(
-    self::AGAVI_ENVELOPE_NAMESPACE_0_11 => 'agavi_envelope_0_11',
-    self::AGAVI_ENVELOPE_NAMESPACE_1_0 => 'agavi_envelope_1_0',
+    self::NAMESPACE_AGAVI_ENVELOPE_0_11 => 'agavi_envelope_0_11',
+    self::NAMESPACE_AGAVI_ENVELOPE_1_0 => 'agavi_envelope_1_0',
   );
   
   /**
+   * @var        array A list of all XML namespaces that are used internally by
+   *                   the configuration parser.
+   */
+  public static $agaviNamespaces = array(
+    self::NAMESPACE_AGAVI_ENVELOPE_0_11 => 'agavi_envelope_0_11',
+    self::NAMESPACE_AGAVI_ENVELOPE_1_0 => 'agavi_envelope_1_0',
+    
+    self::NAMESPACE_AGAVI_ANNOTATION_1_0 => 'agavi_annotation_1_0'
+  );
+  
+  /**
    * @var        string Path to the config file we're parsing in this instance.
    */
@@ -107 +122 @@
   {
     return isset(self::$agaviEnvelopeNamespaces[$namespaceUri]);
+  }
+  
+  /**
+   * Check if a given namespace URI is a valid Agavi namespace.
+   *
+   * @param      string The namespace URI.
+   *
+   * @return     bool True if the given URI is a valid namespace URI,
+   *                  false otherwise.
+   *
+   * @author     Noah Fontes <noah.fontes@bitextender.com>
+   * @since      1.0.0
+   */
+  public static function isAgaviNamespace($namespaceUri)
+  {
+    return isset(self::$agaviNamespaces[$namespaceUri]);
   }
   
@@ -120 +151 @@
    * @since      1.0.0
    */
-  public static function getAgaviEnvelopePrefix($namespaceUri)
-  {
-    if(self::isAgaviEnvelopeNamespace($namespaceUri)) {
-      return self::$agaviEnvelopeNamespaces[$namespaceUri];
+  public static function getAgaviNamespacePrefix($namespaceUri)
+  {
+    if(self::isAgaviNamespace($namespaceUri)) {
+      return self::$agaviNamespaces[$namespaceUri];
     }
     return null;
+  }
+  
+  /**
+   * Register Agavi namespace prefixes in a given document.
+   *
+   * @param      AgaviXmlConfigDomDocument The document.
+   *
+   * @author     Noah Fontes <noah.fontes@bitextender.com>
+   * @since      1.0.0
+   */
+  public static function registerAgaviNamespaces(AgaviXmlConfigDomDocument $document)
+  {
+    $xpath = $document->getXpath();
+    
+    foreach(self::$agaviNamespaces as $namespaceUri => $prefix) {
+      $xpath->registerNamespace($prefix, $namespaceUri);
+    }
+    
+    /* Register the latest namespaces. */
+    $xpath->registerNamespace('agavi_envelope_latest', self::NAMESPACE_AGAVI_ENVELOPE_LATEST);
+    $xpath->registerNamespace('agavi_annotation_latest', self::NAMESPACE_AGAVI_ANNOTATION_LATEST);
   }
   
@@ -176 +228 @@
     if($isAgaviConfigFormat) {
       // if it is an Agavi config, we'll create a new document with all files' <configuration> blocks inside
-      $retval->appendChild(new AgaviXmlConfigDomElement('configurations', null, self::AGAVI_ENVELOPE_NAMESPACE_LATEST));
+      $retval->appendChild(new AgaviXmlConfigDomElement('configurations', null, self::NAMESPACE_AGAVI_ENVELOPE_LATEST));
       
       // reverse the array - we want the parents first!
@@ -201 +253 @@
       // generic <configuration> first, then those with an environment attribute, then those with context, then those with both
       $configurationOrder = array(
-        'count(self::node()[@agavi_envelope_1_0:matched and not(@environment) and not(@context)])',
-        'count(self::node()[@agavi_envelope_1_0:matched and @environment and not(@context)])',
-        'count(self::node()[@agavi_envelope_1_0:matched and not(@environment) and @context])',
-        'count(self::node()[@agavi_envelope_1_0:matched and @environment and @context])',
+        'count(self::node()[@agavi_annotation_latest:matched and not(@environment) and not(@context)])',
+        'count(self::node()[@agavi_annotation_latest:matched and @environment and not(@context)])',
+        'count(self::node()[@agavi_annotation_latest:matched and not(@environment) and @context])',
+        'count(self::node()[@agavi_annotation_latest:matched and @environment and @context])',
       );
       
@@ -424 +476 @@
         if($matched) {
           // if all was fine, we set the attribute. the element will then be kept in the merged result doc later
-          $configuration->setAttributeNS(self::AGAVI_ENVELOPE_NAMESPACE_LATEST, 'agavi:matched', 'true');
+          $configuration->setAttributeNS(self::NAMESPACE_AGAVI_ANNOTATION_LATEST, 'agavi_annotation_latest:matched', 'true');
         }
       }
@@ -697 +749 @@
       
       // is it an ISO Schematron file?
-      if(!$sch->documentElement || $sch->documentElement->namespaceURI != self::SCHEMATRON_ISO_NAMESPACE) {
+      if(!$sch->documentElement || $sch->documentElement->namespaceURI != self::NAMESPACE_SCHEMATRON_ISO) {
         throw new AgaviParseException(sprintf('Schematron validation of configuration file "%s" failed because schema file "%s" is invalid', $this->path, $href));
       }
@@ -709 +761 @@
       
       // it transformed fine. but did we get a proper stylesheet instance at all? wrong namespaces can lead to empty docs that only have an XML prolog
-      if(!$schema->documentElement || $schema->documentElement->namespaceURI != self::XSL_NAMESPACE_1999) {
+      if(!$schema->documentElement || $schema->documentElement->namespaceURI != self::NAMESPACE_XSL_1999) {
         throw new AgaviParseException(sprintf('Schematron validation of configuration file "%s" failed because schema file "%s" resulted in an invalid stylesheet', $this->path, $href));
       }
@@ -730 +782 @@
       // validation ran okay, now we need to look at the result document to see if there are errors
       $xpath = $result->getXpath();
-      $xpath->registerNamespace('svrl', self::SVRL_ISO_NAMESPACE);
+      $xpath->registerNamespace('svrl', self::NAMESPACE_SVRL_ISO);
       
       $results = $xpath->query('//svrl:failed-assert | //svrl:successful-report');

branches/david-xml_only_config_system/src/config/rng/_common.rng

@@ -1 +1 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <grammar xmlns="http://relaxng.org/ns/structure/1.0"
-  xmlns:agavi="http://agavi.org/agavi/config/1.0"
-  ns="http://agavi.org/agavi/config/1.0"
+  xmlns:envelope_1_0="http://agavi.org/agavi/config/envelope/1.0"
+  xmlns:annotation_1_0="http://agavi.org/agavi/config/annotation/1.0"
+  ns="http://agavi.org/agavi/config/envelope/1.0"
   datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
   
@@ -43 +44 @@
     <!-- XXX: Here, or no? -->
     <optional>
-      <attribute name="agavi:matched">
+      <attribute name="annotation_1_0:matched">
         <ref name="data-matched" />
       </attribute>
@@ -149 +150 @@
             <nsName />
             <nsName ns="" />
-            <nsName ns="http://agavi.org/agavi/config/1.0" />
+            <nsName ns="http://agavi.org/agavi/config/envelope/1.0" />
+            <nsName ns="http://agavi.org/agavi/config/annotation/1.0" />
           </except>
         </anyName>
@@ -164 +166 @@
             <nsName />
             <nsName ns="" />
-            <nsName ns="http://agavi.org/agavi/config/1.0" />
+            <nsName ns="http://agavi.org/agavi/config/envelope/1.0" />
+            <nsName ns="http://agavi.org/agavi/config/annotation/1.0" />
           </except>
         </anyName>

branches/david-xml_only_config_system/src/config/rng/factories.rng

@@ -1 +1 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <grammar xmlns="http://relaxng.org/ns/structure/1.0"
-  xmlns:factories="http://agavi.org/agavi/config/factories/1.0"
-  ns="http://agavi.org/agavi/config/factories/1.0"
+  xmlns:factories_1_0="http://agavi.org/agavi/config/item/factories/1.0"
+  ns="http://agavi.org/agavi/config/item/factories/1.0"
   datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
   

branches/david-xml_only_config_system/src/config/util/dom/AgaviXmlConfigDomDocument.class.php

@@ -102 +102 @@
     
     if($this->isAgaviConfiguration()) {
-      /* Register Agavi namespace prefixes. */
-      foreach(AgaviXmlConfigParser::$agaviEnvelopeNamespaces as $namespaceUri => $prefix) {
-        $this->xpath->registerNamespace($prefix, $namespaceUri);
-      }
-      
-      /* Register the default envelope namespace. */
-      $this->xpath->registerNamespace('agavi_envelope_latest', AgaviXmlConfigParser::AGAVI_ENVELOPE_NAMESPACE_LATEST);
+      AgaviXmlConfigParser::registerAgaviNamespaces($this);
     }
     
@@ -154 +148 @@
     
     if($this->isAgaviConfiguration()) {
-      /* Register Agavi namespace prefixes. */
-      foreach(AgaviXmlConfigParser::$agaviEnvelopeNamespaces as $namespaceUri => $prefix) {
-        $this->xpath->registerNamespace($prefix, $namespaceUri);
-      }
-      
-      /* Register the default envelope namespace. */
-      $this->xpath->registerNamespace('agavi_envelope_latest', AgaviXmlConfigParser::AGAVI_ENVELOPE_NAMESPACE_LATEST);
+      AgaviXmlConfigParser::registerAgaviNamespaces($this);
     }
     

branches/david-xml_only_config_system/src/config/util/dom/AgaviXmlConfigDomElement.class.php

@@ -268 +268 @@
     
     if($this->ownerDocument->isAgaviConfiguration()) {
-      $elements = $this->getChildren('parameters', AgaviXmlConfigParser::AGAVI_ENVELOPE_NAMESPACE_LATEST);
+      $elements = $this->getChildren('parameters', AgaviXmlConfigParser::NAMESPACE_AGAVI_ENVELOPE_LATEST);
       
       foreach($elements as $element) {
@@ -280 +280 @@
         }
         
-        if($element->hasChildren('parameters', AgaviXmlConfigParser::AGAVI_ENVELOPE_NAMESPACE_LATEST)) {
+        if($element->hasChildren('parameters', AgaviXmlConfigParser::NAMESPACE_AGAVI_ENVELOPE_LATEST)) {
           $result[$key] = isset($result[$key]) && is_array($result[$key]) ? $result[$key] : array();
           $result[$key] = $element->getAgaviParameters($result[$key], $literalize);

branches/david-xml_only_config_system/src/config/xsl/_common.xsl

@@ -4 +4 @@
   xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
   xmlns:envelope_0_11="http://agavi.org/agavi/1.0/config"
-  xmlns:envelope_1_0="http://agavi.org/agavi/config/1.0">
+  xmlns:envelope_1_0="http://agavi.org/agavi/config/envelope/1.0">
   
   <xsl:variable name="envelope_0_11" select="'http://agavi.org/agavi/1.0/config'" />
-  <xsl:variable name="envelope_1_0" select="'http://agavi.org/agavi/config/1.0'" />
+  <xsl:variable name="envelope_1_0" select="'http://agavi.org/agavi/config/envelope/1.0'" />
   
   <xsl:template match="envelope_0_11:configurations | envelope_0_11:configuration | envelope_0_11:sandbox | envelope_0_11:parameters | envelope_0_11:parameter">

branches/david-xml_only_config_system/src/config/xsl/factories.xsl

@@ -4 +4 @@
   xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
   xmlns:envelope_0_11="http://agavi.org/agavi/1.0/config"
-  xmlns:factories_1_0="http://agavi.org/agavi/config/factories/1.0"
+  xmlns:factories_1_0="http://agavi.org/agavi/config/item/factories/1.0"
 >
   <!--xmlns:factories_1_1="http://agavi.org/agavi/1.1/config/factories"-->
@@ -12 +12 @@
   <xsl:include href="_common.xsl" />
   
-  <xsl:variable name="factories_1_0" select="'http://agavi.org/agavi/config/factories/1.0'" />
+  <xsl:variable name="factories_1_0" select="'http://agavi.org/agavi/config/item/factories/1.0'" />
   <!--<xsl:variable name="factories11" select="'http://agavi.org/agavi/1.1/config/factories'" />-->