Changeset 2786

Timestamp:

09/04/08 15:54:39 (4 months ago)

Author:

david

Message:

Allow customization of the way Actions, Views etc. are laid out in the filesystem, closes #668

Location:

branches/1.0

Files:

• CHANGELOG (modified) (1 diff)
• RELEASE_NOTES (modified) (1 diff)
• src/controller/AgaviController.class.php (modified) (2 diffs)
• src/filter/AgaviExecutionFilter.class.php (modified) (3 diffs)
• src/view/AgaviFileTemplateLayer.class.php (modified) (1 diff)

branches/1.0/CHANGELOG

@@ -5 +5 @@
 --------------------------------
 
+ADD: Allow customization of the way Actions, Views etc. are laid out in the filesystem (#668) (David)
 ADD: AgaviXmlConfigDomElement::hasAgaviParameters() (#841) (David)
 

branches/1.0/RELEASE_NOTES

@@ -33 +33 @@
 %core.app_dir%/modules/Default/actions/Foo_BarAction.class.php is class Default_Foo_BarAction
 The legacy naming schemes (leaving out module name for Actions, Views and non-global Models; leaving out sub-notation paths except the last one) are not supported anymore.
+
+Finally, you can now define the filesystem structure of the following elements on a per-module basis:
+- Actions
+- Caching XML configs
+- Validation XML configs
+- Views
+You can also customize these aspects:
+- Default template "directory" part
+- View shortname resolution ("Success" => "Default_Sub_MarineSuccess")
+This allows you to put all the files for a feature into a single subdirectory, instead of having the separate files cluttered over action/, template/, view/ etc. subfolders inside the module directory.
+Ticket #668 has more details an an example.
 
 Project development environment

branches/1.0/src/controller/AgaviController.class.php

@@ -288 +288 @@
    */
   public function checkActionFile($moduleName, $actionName)
-  {   
+  {
+    $this->initializeModule($moduleName);
     $actionName = AgaviToolkit::canonicalName($actionName);
-    $file = AgaviConfig::get('core.module_dir') . '/' . $moduleName . '/actions/' . $actionName . 'Action.class.php';
+    $file = AgaviToolkit::expandVariables(
+      AgaviToolkit::expandDirectives(
+        AgaviConfig::get(
+          sprintf('modules.%s.agavi.action.path', strtolower($moduleName)),
+          '%core.module_dir%/${moduleName}/actions/${actionName}Action.class.php'
+        )
+      ),
+      array(
+        'moduleName' => $moduleName,
+        'actionName' => $actionName,
+      )
+    );
     if(is_readable($file) && substr($actionName, 0, 1) !== '/') {
       return $file;
@@ -368 +380 @@
    */
   public function checkViewFile($moduleName, $viewName)
-  { 
+  {
+    $this->initializeModule($moduleName);
     $viewName = AgaviToolkit::canonicalName($viewName);
-    $file = AgaviConfig::get('core.module_dir') . '/' . $moduleName . '/views/' . $viewName . 'View.class.php';
+    $file = AgaviToolkit::expandVariables(
+      AgaviToolkit::expandDirectives(
+        AgaviConfig::get(
+          sprintf('modules.%s.agavi.view.path', strtolower($moduleName)),
+          '%core.module_dir%/${moduleName}/views/${viewName}View.class.php'
+        )
+      ),
+      array(
+        'moduleName' => $moduleName,
+        'viewName' => $viewName,
+      )
+    );
     if(is_readable($file) && substr($viewName, 0, 1) !== '/') {
       return $file;

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

@@ -269 +269 @@
 
     $isCacheable = false;
-    if($this->getParameter('enable_caching', true) && is_readable($cachingDotXml = AgaviConfig::get('core.module_dir') . '/' . $moduleName . DIRECTORY_SEPARATOR . 'cache' . DIRECTORY_SEPARATOR . $actionName . '.xml')) {
+    $cachingDotXml = AgaviToolkit::expandVariables(
+      AgaviToolkit::expandDirectives(
+        AgaviConfig::get(
+          sprintf('modules.%s.agavi.cache.path', strtolower($moduleName)),
+          '%core.module_dir%/${moduleName}/cache/${actionName}.xml'
+        )
+      ),
+      array(
+        'moduleName' => $moduleName,
+        'actionName' => $actionName,
+      )
+    );
+    if($this->getParameter('enable_caching', true) && is_readable($cachingDotXml)) {
       // $lm->log('Caching enabled, configuration file found, loading...');
       // no _once please!
@@ -639 +651 @@
 
       // get the current action validation configuration
-      $validationConfig = AgaviConfig::get('core.module_dir') . '/' . $moduleName . '/validate/' . $actionName . '.xml';
-
+      $validationConfig = AgaviToolkit::expandVariables(
+        AgaviToolkit::expandDirectives(
+          AgaviConfig::get(
+            sprintf('modules.%s.agavi.validate.path', strtolower($moduleName)),
+            '%core.module_dir%/${moduleName}/validate/${actionName}.xml'
+          )
+        ),
+        array(
+          'moduleName' => $moduleName,
+          'actionName' => $actionName,
+        )
+      );
       if(is_readable($validationConfig)) {
         // load validation configuration
@@ -699 +721 @@
     } elseif($viewName !== AgaviView::NONE) {
       // use a view related to this action
-      $viewName = $actionName . $viewName;
+      $viewName = AgaviToolkit::expandVariables(
+        AgaviToolkit::expandDirectives(
+          AgaviConfig::get(
+            sprintf('modules.%s.agavi.view.name', strtolower($moduleName)),
+            '${actionName}${viewName}'
+          )
+        ),
+        array(
+          'actionName' => $actionName,
+          'viewName' => $viewName,
+        )
+      );
       $viewModule = $moduleName;
     } else {

branches/1.0/src/view/AgaviFileTemplateLayer.class.php

@@ -56 +56 @@
   
   /**
+   * Initialize the layer.
+   *
+   * Will try and figure out an alternative default for "directory".
+   *
+   * @param      AgaviContext The current Context instance.
+   * @param      array        An array of initialization parameters.
+   *
+   * @author     David Zülke <david.zuelke@bitextender.com>
+   * @since      1.0.0
+   */
+  public function initialize(AgaviContext $context, array $parameters = array())
+  {
+    $this->setParameter(
+      'directory',
+      AgaviToolkit::expandDirectives(
+        AgaviConfig::get(
+          sprintf('modules.%s.agavi.template.directory', isset($parameters['module']) ? strtolower($parameters['module']) : ''),
+          '%core.module_dir%/${module}/templates'
+        )
+      )
+    );
+    
+    parent::initialize($context, $parameters);
+  }
+  
+  /**
    * Get the full, resolved stream location name to the template resource.
    *