Changeset 3703

Timestamp:

04/03/07 08:23:18 (2 years ago)

Author:

fabien

Message:

added a way to register custom config handlers (closes #1624)

Files:

• doc/trunk/book/19-Mastering-Symfony-s-Configuration-Files.txt (modified) (1 diff)
• trunk/lib/config/sfConfigCache.class.php (modified) (4 diffs)
• trunk/test/unit/config/sfConfigCacheTest.php (added)

doc/trunk/book/19-Mastering-Symfony-s-Configuration-Files.txt

@@ -514 +514 @@
->The `class` must either be autoloaded (that's the case here) or defined in the file whose path is written in a `file` parameter under the `param` key.
-
+As with many other symfony configuration files, you can also register a configuration handler directly in your PHP code:
+
+    sfConfigCache::getInstance()->registerConfigHandler('config/map.yml', myMapConfigHandler, array());
+
-When you need the code based on the `map.yml` file and generated by the `myMapConfigHandler` handler in your application, call the following line:
-

trunk/lib/config/sfConfigCache.class.php

@@ -24 +24 @@
-{
-  protected
-
+
+
-
-  protected static
@@ -59 +60 @@
-      // we need to load the handlers first
-      $this->loadConfigHandlers();
+    }
+
+    if (count($this->userHandlers) != 0)
+    {
+      // we load user defined handlers
+      $this->mergeUserConfigHandlers();
-    }
-
@@ -319 +326 @@
-    {
-      // module directory doesn't exist or isn't readable
-
-
+
-      throw new sfConfigurationException($error);
-    }
@@ -340 +346 @@
-    $fileCache->set(basename($cache), '', $data);
-  }
+
+  /**
+   * Registers a configuration handler.
+   *
+   * @param string The handler to use when parsing a configuration file
+   * @param class  A configuration handler class
+   * @param string An array of options for the handler class initialization
+   */
+  public function registerConfigHandler($handler, $class, $params = array())
+  {
+    $this->userHandlers[$handler] = new $class();
+    $this->userHandlers[$handler]->initialize($params);
+  }
+
+  /**
+   * Merges configuration handlers from the config_handlers.yml  
+   * and the ones defined with registerConfigHandler()
+   *
+   */
+  protected function mergeUserConfigHandlers()
+  {
+    // user defined configuration handlers
+    $this->handlers = array_merge($this->handlers, $this->userHandlers);
+
+    $this->userHandlers = array();
+  }
-}