Changeset 1923

Timestamp:

05/11/07 10:30:50 (20 months ago)

Author:

david

Message:

more work on native XML config handlers, refs #519

Location:

branches/david-xml_config_handlers/src/config

Files:

• AgaviBaseConfigHandler.class.php (modified) (2 diffs)
• AgaviConfigCache.class.php (modified) (3 diffs)
• AgaviConfigHandler.class.php (modified) (1 diff)
• AgaviConfigParser.class.php (modified) (1 diff)
• AgaviILegacyConfigHandler.interface.php (added)
• AgaviIXmlConfigHandler.class.php (modified) (1 diff)
• AgaviXmlConfigHandler.class.php (modified) (1 diff)
• AgaviXmlConfigParser.class.php (modified) (2 diffs)
• defaults/config_handlers.xml (modified) (1 diff)

branches/david-xml_config_handlers/src/config/AgaviBaseConfigHandler.class.php

@@ -103 +103 @@
 
   /**
-   * Execute this configuration handler.
-   *
-   * @param      string An absolute filesystem path to a configuration file.
-   * @param      string Name of the executing context (if any).
-   *
-   * @return     string Data to be written to a cache file.
-   *
-   * @throws     <b>AgaviUnreadableException</b> If a requested configuration
-   *                                             file does not exist or is not
-   *                                             readable.
-   * @throws     <b>AgaviParseException</b> If a requested configuration file is
-   *                                        improperly formatted.
-   *
-   * @author     Sean Kerr <skerr@mojavi.org>
-   * @since      0.9.0
-   */
-  abstract function execute($config, $context = null);
-
-  /**
    * Generate the code for returning from execute().
    *
@@ -145 +126 @@
   }
   
-  /**
-   * Initialize this ConfigHandler.
-   *
-   * @param      string The path to a validation file for this config handler.
-   * @param      string The parser class to use.
-   * @param      array An associative array of initialization parameters.
-   *
-   * @throws     <b>AgaviInitializationException</b> If an error occurs while
-   *                                                 initializing the
-   *                                                 ConfigHandler
-   *
-   * @author     Dominik del Bondio <ddb@bitxtender.com>
-   * @since      0.9.0
-   */
-  public function initialize($validationFile = null, $parser = null, $parameters = array())
-  {
-    $this->validationFile = $validationFile;
-    $this->parser = $parser;
-    $this->setParameters($parameters);
-  }
-
   /**
    * Literalize a string value.

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

@@ -99 +99 @@
     $handler = new $handlerInfo['class'];
     if($handler instanceof AgaviIXmlConfigHandler) {
+      // a new-style config handler
+      // it does not parse the config itself; instead, it is given an array of parsed DOM documents (with parents!)
+      $parser = new AgaviXmlConfigParser();
+      $docs = $parser->parseAll($config, $handlerInfo['validation']);
       
+      if($context !== null) {
+        $context = AgaviContext::getInstance($context);
+      }
+      
+      $handler->initialize($context, $handlerInfo['parameters']);
+      
+      try {
+        $data = $handler->execute($docs);
+      } catch(AgaviException $e) {
+        throw new $e(sprintf("Compliation of configuration file '%s' failed for the following reason(s):\n\n%s", $config, $e->getMessage()));
+      }
     } else {
-      if(isset($handlerInfo['validation']))
-      $handler->initialize($handlerInfo['validation'], null, $handlerInfo['parameters']);
-    }
-    
-    $data = $handler->execute($config, $context);
+      $validationFile = null;
+      if(isset($handlerInfo['validation'][AgaviXmlConfigParser::VALIDATION_TYPE_XMLSCHEMA][0])) {
+        $validationFile = $handlerInfo['validation'][AgaviXmlConfigParser::VALIDATION_TYPE_XMLSCHEMA][0];
+      }
+      $handler->initialize($validationFile, null, $handlerInfo['parameters']);
+      $data = $handler->execute($config, $context);
+    }
+    
     self::writeCacheFile($config, $cache, $data, false);
   }
@@ -240 +258 @@
     // since we only need the parser and handlers when the config is not cached
     // it is sufficient to include them at this stage
+    require(AgaviConfig::get('core.agavi_dir') . '/config/AgaviILegacyConfigHandler.interface.php');
+    require(AgaviConfig::get('core.agavi_dir') . '/config/AgaviIXmlConfigHandler.class.php');
     require(AgaviConfig::get('core.agavi_dir') . '/config/AgaviBaseConfigHandler.class.php');
     require(AgaviConfig::get('core.agavi_dir') . '/config/AgaviConfigHandler.class.php');
-    require(AgaviConfig::get('core.agavi_dir') . '/config/AgaviIXmlConfigHandler.class.php');
     require(AgaviConfig::get('core.agavi_dir') . '/config/AgaviXmlConfigHandler.class.php');
     require(AgaviConfig::get('core.agavi_dir') . '/config/AgaviAutoloadConfigHandler.class.php');
@@ -328 +347 @@
    * @since      0.11.0
    */
-  public static function parseConfig($config, $autoloadParser = true, $validateFile = null, $parserClass = null)
+  public static function parseConfig($config, $autoloadParser = true, $validationFile = null, $parserClass = null)
   {
     $parser = new AgaviConfigParser();
     
-    return $parser->parse($config, $validateFile);
+    return $parser->parse($config, $validationFile);
   }
 }

branches/david-xml_config_handlers/src/config/AgaviConfigHandler.class.php

@@ -33 +33 @@
  * @version    $Id$
  */
-abstract class AgaviConfigHandler extends AgaviBaseConfigHandler
+abstract class AgaviConfigHandler extends AgaviBaseConfigHandler implements AgaviILegacyConfigHandler
 {
+  /**
+   * Initialize this ConfigHandler.
+   *
+   * @param      string The path to a validation file for this config handler.
+   * @param      string The parser class to use.
+   * @param      array An associative array of initialization parameters.
+   *
+   * @throws     <b>AgaviInitializationException</b> If an error occurs while
+   *                                                 initializing the
+   *                                                 ConfigHandler
+   *
+   * @author     Dominik del Bondio <ddb@bitxtender.com>
+   * @since      0.9.0
+   */
+  public function initialize($validationFile = null, $parser = null, $parameters = array())
+  {
+    $this->validationFile = $validationFile;
+    $this->parser = $parser;
+    $this->setParameters($parameters);
+  }
 }
 

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

@@ -48 +48 @@
    * @since      0.11.0
    */
-  public function parse($config, array $validationInfo = array())
+  public function parse($config, $validationFile = null)
   {
     $parser = new AgaviXmlConfigParser();
     
-    $doc = $parser->parse($config, $validationInfo);
+    $validation = array();
+    if($validationFile !== null) {
+      $validation[AgaviXmlConfigParser::VALIDATION_TYPE_XMLSCHEMA] = array($validationFile);
+    }
+    $doc = $parser->parse($config, $validation);
     
     $this->encoding = $doc->encoding;

branches/david-xml_config_handlers/src/config/AgaviIXmlConfigHandler.class.php

@@ -31 +31 @@
 interface AgaviIXmlConfigHandler
 {
+  /**
+   * Initialize this ConfigHandler.
+   *
+   * @param      AgaviContext The context to work with (if available).
+   * @param      array        An associative array of initialization parameters.
+   *
+   * @throws     <b>AgaviInitializationException</b> If an error occurs while
+   *                                                 initializing the
+   *                                                 ConfigHandler
+   *
+   * @author     David Zülke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function initialize(AgaviContext $context = null, $parameters = array());
+  
+  /**
+   * Execute this configuration handler.
+   *
+   * @param      array An array of DOMDocuments (the config and all parents).
+   *
+   * @return     string Data to be written to a cache file.
+   *
+   * @throws     <b>AgaviParseException</b> If a requested configuration file is
+   *                                        improperly formatted.
+   *
+   * @author     David Zülke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function execute(array $array = array());
 }
+
+?>

branches/david-xml_config_handlers/src/config/AgaviXmlConfigHandler.class.php

@@ -28 +28 @@
  * @version    $Id$
  */
-class AgaviXmlConfigHandler extends AgaviBaseConfigHandler implements AgaviIXmlConfigHandler
+abstract class AgaviXmlConfigHandler extends AgaviBaseConfigHandler implements AgaviIXmlConfigHandler
 {
-  public function execute($config, $context = null)
+  /**
+   * @var        AgaviContext The context to work with (if available).
+   */
+  protected $context = null;
+  
+  /**
+   * Initialize this ConfigHandler.
+   *
+   * @param      AgaviContext The context to work with (if available).
+   * @param      array        An associative array of initialization parameters.
+   *
+   * @throws     <b>AgaviInitializationException</b> If an error occurs while
+   *                                                 initializing the
+   *                                                 ConfigHandler
+   *
+   * @author     David Zülke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function initialize(AgaviContext $context = null, $parameters = array())
   {
+    $this->context = $context;
+    $this->setParameters($parameters);
   }
 }
+
+?>

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

@@ -29 +29 @@
  * @version    $Id$
  */
-class AgaviXmlConfigParser extends AgaviConfigParser
+class AgaviXmlConfigParser
 {
   const XML_NAMESPACE = 'http://agavi.org/agavi/1.0/config';
@@ -44 +44 @@
    *
    * @return     array An array of DOMDocuments (from child to parent).
+   *
+   * @author     David Zülke <dz@bitxtender.com>
+   * @author     Dominik del Bondio <ddb@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function parseAll($config, array $validation = array())
+  {
+    $retval = array();
+    
+    $nextConfig = $config;
+    
+    while($nextConfig !== null) {
+      $doc = $this->parse($nextConfig, $validation);
+      
+      if($doc->documentElement->hasAttribute('parent')) {
+        $nextConfig = AgaviBaseConfigHandler::literalize($doc->documentElement->getAttribute('parent'));
+      } else {
+        $nextConfig = null;
+      }
+      
+      $retval[] = $doc;
+    }
+    
+    return $retval;
+  }
+  
+  /**
+   * @param      string An absolute filesystem path to a configuration file.
+   * @param      array  An associative array of validation information.
+   *
+   * @return     DOMDocument A DOMDocument.
    *
    * @author     David Zülke <dz@bitxtender.com>

branches/david-xml_config_handlers/src/config/defaults/config_handlers.xml

@@ -36 +36 @@
       <handler pattern="%core.config_dir%/routing.xml" validate="%core.agavi_dir%/config/xsd/routing.xsd" class="AgaviRoutingConfigHandler" />
 
+      <handler pattern="%core.config_dir%/wsdl.xml" validate="%core.agavi_dir%/config/xsd/routing.xsd" class="AgaviWsdlConfigHandler" />
+
       <handler pattern="%core.config_dir%/translation.xml" validate="%core.agavi_dir%/config/xsd/translation.xsd" class="AgaviTranslationConfigHandler" />