Changeset 2284

Timestamp:

01/19/08 16:58:06 (10 months ago)

Author:

david

Message:

Deprecated directive "core.use_routing" in favor of a routing config parameter ("enabled"), closes #683

Location:

trunk

Files:

• docs/docbook/manual.xml (modified) (1 diff)
• etc/olson/agavi/app/config/factories.xml (modified) (1 diff)
• etc/olson/agavi/app/config/settings.xml (modified) (1 diff)
• samples/app/config/settings.xml (modified) (1 diff)
• src/buildtools/code_templates/config/settings.xml.tmpl (modified) (1 diff)
• src/controller/AgaviSoapController.class.php (modified) (1 diff)
• src/routing/AgaviRouting.class.php (modified) (6 diffs)
• src/routing/AgaviSoapRouting.class.php (modified) (1 diff)
• src/routing/AgaviWebRouting.class.php (modified) (3 diffs)
• src/routing/AgaviWebserviceRouting.class.php (modified) (1 diff)
• tests2/routing/RoutingTest.php (modified) (1 diff)
• tests2/routing/WebRoutingTest.php (modified) (1 diff)
• tests2/sandbox2/config/factories.xml (modified) (1 diff)
• tests2/sandbox2/config/settings.xml (modified) (1 diff)

trunk/docs/docbook/manual.xml

@@ -1207 +1207 @@
         mod_rewrite for Apache or ISAPI_Rewrite for Microsoft IIS but with a
         lot more power and features. Routes are defined in the file
-        <filename>%core.app_dir%/config/routing.xml</filename>, and to enable
-        routing you must set the "use_routing" option to true in
-        <filename>settings.xml</filename>.</para>
+        <filename>%core.app_dir%/config/routing.xml</filename></para>
 
         <para>Let's look at an example route:<programlisting>&lt;route name="viewproduct" pattern="^/products/(id:\d+)$" module="Shop" action="ViewProduct" /&gt;</programlisting></para>

trunk/etc/olson/agavi/app/config/factories.xml

@@ -20 +20 @@
     <response class="AgaviWebResponse" />
     
-    <routing class="AgaviWebserviceRouting" />
+    <routing class="AgaviWebserviceRouting">
+      <parameter name="enabled">false</parameter>
+    </routing>
     
     <security_filter class="AgaviSecurityFilter" />

trunk/etc/olson/agavi/app/config/settings.xml

@@ -10 +10 @@
       <setting name="use_database">false</setting>
       <setting name="use_logging">false</setting>
-      <setting name="use_routing">false</setting>
       <setting name="use_security">false</setting>
       <setting name="use_translation">true</setting>

trunk/samples/app/config/settings.xml

@@ -46 +46 @@
       <setting name="use_database">false</setting>
       <setting name="use_logging">false</setting>
-      <setting name="use_routing">true</setting>
       <setting name="use_security">true</setting>
       <setting name="use_translation">true</setting>

trunk/src/buildtools/code_templates/config/settings.xml.tmpl

@@ -46 +46 @@
       <setting name="use_database">false</setting>
       <setting name="use_logging">false</setting>
-      <setting name="use_routing">true</setting>
       <setting name="use_security">true</setting>
       <setting name="use_translation">false</setting>

trunk/src/controller/AgaviSoapController.class.php

@@ -73 +73 @@
   
   /**
-   * Initialize this controller.
-   *
-   * @param      AgaviContext An AgaviContext instance.
-   * @param      array        An array of initialization parameters.
-   *
-   * @author     David Zülke <dz@bitxtender.com>
-   * @since      0.9.0
-   */
-  public function initialize(AgaviContext $context, array $parameters = array())
-  {
-    if(!AgaviConfig::get('core.use_routing')) {
-      throw new AgaviInitializationException('Agavi SOAP support requires the Routing to be on, please enable "core.use_routing" in settings.xml.');
-    }
-    
-    parent::initialize($context, $parameters);
-  }
-  
-  /**
    * Do any necessary startup work after initialization.
    *

trunk/src/routing/AgaviRouting.class.php

@@ -37 +37 @@
 
   /**
+   * @var        bool Whether or not routing is enabled.
+   */
+  protected $enabled = true;
+
+  /**
    * @var        array An array of route information
    */
@@ -79 +84 @@
   public function __construct()
   {
+    // for now, we still use this setting as default.
+    // will be removed in 1.1
+    $this->enabled = AgaviConfig::get('core.use_routing', $this->enabled);
+    
     $this->defaultGenOptions = array_merge($this->defaultGenOptions, array(
       'relative' => true,
@@ -102 +111 @@
     $this->setParameters($parameters);
     
-    if(isset($parameters['default_gen_options'])) {
-      $this->defaultGenOptions = array_merge($this->defaultGenOptions, $parameters['default_gen_options']);
-    }
-    
-    if(isset($parameters['gen_options_presets']) && is_array($parameters['gen_options_presets'])) {
-      $this->genOptionsPresets = $parameters['gen_options_presets'];
-    }
+    $this->enabled = $this->getParameter('enabled', $this->enabled);
+    
+    $this->defaultGenOptions = array_merge(
+      $this->defaultGenOptions,
+      $this->getParameter('default_gen_options', array())
+    );
+    
+    $this->genOptionsPresets = array_merge(
+      $this->genOptionsPresets,
+      $this->getParameter('gen_options_presets', array())
+    );
     
     // and load the config.
@@ -124 +137 @@
     $cfg = AgaviConfig::get("core.config_dir") . "/routing.xml";
     // allow missing routing.xml when routing is not enabled
-    if(AgaviConfig::get("core.use_routing", false) || is_readable($cfg)) {
+    if($this->enabled || is_readable($cfg)) {
       include(AgaviConfigCache::checkConfig($cfg, $this->context->getName()));
     }
@@ -156 +169 @@
   public function shutdown()
   {
+  }
+
+  /**
+   * Check if this routing instance is enabled.
+   *
+   * @return     bool Whether or not routing is enabled.
+   *
+   * @author     David Zülke <dz@bitxtender.com>
+   * @since      1.0.0
+   */
+  public function isEnabled()
+  {
+    return $this->enabled;
   }
 
@@ -701 +727 @@
     $container = $this->context->getController()->createExecutionContainer();
     
-    if(!AgaviConfig::get('core.use_routing', false) || count($this->routes) == 0) {
+    if(!$this->enabled || count($this->routes) == 0) {
       // routing disabled, determine module and action manually and bail out
       $container->setModuleName($reqData->getParameter($req->getParameter('module_accessor')));

trunk/src/routing/AgaviSoapRouting.class.php

@@ -31 +31 @@
 {
   /**
+   * Initialize the routing instance.
+   *
+   * @param      AgaviContext A Context instance.
+   * @param      array        An array of initialization parameters.
+   *
+   * @author     David Zülke <dz@bitxtender.com>
+   * @since      0.11.0
+   */
+  public function initialize(AgaviContext $context, array $parameters = array())
+  {
+    // must always be on
+    unset($parameters['enabled']);
+    
+    parent::initialize($context, $parameters);
+  }
+  
+  /**
    * Returns the local filesystem path to the WSDL file built from routing.xml.
    *

trunk/src/routing/AgaviWebRouting.class.php

@@ -111 +111 @@
     $rewritten = (preg_replace('/&+$/D', '', $qs) !== preg_replace('/&+$/D', '', $ru['query']));
 
-    if(AgaviConfig::get("core.use_routing", false) && $rewritten) {
+    if($this->enabled && $rewritten) {
       // strip the one trailing ampersand, see above
       $queryWasEmptied = false;
@@ -272 +272 @@
 
       if($route === null) {
-        if(AgaviConfig::get('core.use_routing')) {
+        if($this->enabled) {
           $routes = array_reverse($req->getAttribute('matched_routes', 'org.agavi.routing'));
           $route = join('+', $routes);
@@ -288 +288 @@
 
       if(count($routes)) {
-        if(AgaviConfig::get('core.use_routing')) {
+        if($this->enabled) {
           // the route exists and routing is enabled, the parent method handles it
 

trunk/src/routing/AgaviWebserviceRouting.class.php

@@ -43 +43 @@
     parent::initialize($context, $parameters);
     
-    if(!AgaviConfig::get("core.use_routing", false)) {
+    if(!$this->enabled) {
       return;
     }

trunk/tests2/routing/RoutingTest.php

@@ -22 +22 @@
     $this->_r = new SampleRouting();
     $this->_r->initialize(AgaviContext::getInstance('test'));
-    AgaviConfig::set('core.use_routing', true);
+    // AgaviConfig::set('core.use_routing', true);
 
   }

trunk/tests2/routing/WebRoutingTest.php

@@ -21 +21 @@
     $this->_ENV = $_ENV;
     $this->_GET = $_GET;
-    AgaviConfig::set('core.use_routing', true);
+    // AgaviConfig::set('core.use_routing', true);
   }
 

trunk/tests2/sandbox2/config/factories.xml

@@ -11 +11 @@
     <request class="AgaviWebRequest" />
     <response class="TestResponse" />
-    <routing class="TestRouting" />
+    <routing class="TestRouting">
+      <parameter name="enabled">false</parameter>
+    </routing>
     <security_filter class="AgaviSecurityFilter" />
     <storage class="AgaviNullStorage" />

trunk/tests2/sandbox2/config/settings.xml

@@ -46 +46 @@
       <setting name="use_database">false</setting>
       <setting name="use_logging">true</setting>
-      <setting name="use_routing">false</setting>
       <setting name="use_security">false</setting>
       <setting name="use_translation">true</setting>