Changeset 7811

Timestamp:

03/12/08 01:55:10 (1 year ago)

Author:

fabien

Message:

refactored configuration parsing in config handler classes in a ::getConfiguration() method

Files:

• branches/1.1/lib/config/sfAutoloadConfigHandler.class.php (modified) (5 diffs)
• branches/1.1/lib/config/sfCacheConfigHandler.class.php (modified) (2 diffs)
• branches/1.1/lib/config/sfCompileConfigHandler.class.php (modified) (3 diffs)
• branches/1.1/lib/config/sfConfigHandler.class.php (modified) (2 diffs)
• branches/1.1/lib/config/sfDatabaseConfigHandler.class.php (modified) (5 diffs)
• branches/1.1/lib/config/sfDefineEnvironmentConfigHandler.class.php (modified) (3 diffs)
• branches/1.1/lib/config/sfFactoryConfigHandler.class.php (modified) (7 diffs)
• branches/1.1/lib/config/sfFilterConfigHandler.class.php (modified) (4 diffs)
• branches/1.1/lib/config/sfGeneratorConfigHandler.class.php (modified) (2 diffs)
• branches/1.1/lib/config/sfRootConfigHandler.class.php (modified) (3 diffs)
• branches/1.1/lib/config/sfRoutingConfigHandler.class.php (modified) (2 diffs)
• branches/1.1/lib/config/sfSecurityConfigHandler.class.php (modified) (2 diffs)
• branches/1.1/lib/config/sfSimpleYamlConfigHandler.class.php (modified) (2 diffs)
• branches/1.1/lib/config/sfViewConfigHandler.class.php (modified) (5 diffs)
• branches/1.1/lib/config/sfYamlConfigHandler.class.php (modified) (3 diffs)

branches/1.1/lib/config/sfAutoloadConfigHandler.class.php

@@ -33 +33 @@
-  {
-    // set our required categories list and initialize our handler
-
-
-
+
-
-    // parse the yaml
-myConfig = $this->parseYamls
+config = self::getConfiguration
-
-    // init our data array
@@ -44 +42 @@
-
-    // let's do our fancy work
-myC
+c
-    {
-      if (isset($entry['name']))
@@ -57 +55 @@
-        foreach ($entry['files'] as $class => $path)
-        {
-          $path   = $this->replaceConstants($path);
-
-          $data[] = sprintf("'%s' => '%s',", $class, $path);
-        }
@@ -67 +63 @@
-        $ext  = isset($entry['ext']) ? $entry['ext'] : '.php';
-        $path = $entry['path'];
-
-        $path = $this->replaceConstants($path);
-        $path = $this->replacePath($path);
-
-        // we automatically add our php classes
@@ -128 +121 @@
-    return $retval;
-  }
+
+  /**
+   * @see sfConfigHandler
+   */
+  static public function getConfiguration(array $configFiles)
+  {
+    $config = self::replaceConstants(self::parseYamls($configFiles));
+
+    foreach ($config['autoload'] as $name => $values)
+    {
+      if (isset($values['path']))
+      {
+        $config['autoload'][$name]['path'] = self::replacePath($values['path']);
+      }
+    }
+
+    return $config;
+  }
-}

branches/1.1/lib/config/sfCacheConfigHandler.class.php

@@ -36 +36 @@
-  {
-    // parse the yaml
-
-
-
-
-
-
-
-
-
-
+
-
-    // iterate through all action names
@@ -113 +104 @@
-    return implode("\n", $data);
-  }
+
+  /**
+   * @see sfConfigHandler
+   */
+  static public function getConfiguration(array $configFiles)
+  {
+    return self::flattenConfiguration(self::parseYamls($configFiles));
+  }
-}

branches/1.1/lib/config/sfCompileConfigHandler.class.php

@@ -35 +35 @@
-  {
-    // parse the yaml
-
-
-
-
-
+
-
-    // init our data
@@ -47 +43 @@
-    foreach ($config as $file)
-    {
-      $file = $this->replaceConstants($file);
-      $file = $this->replacePath($file);
-
-      if (!is_readable($file))
-      {
@@ -110 +103 @@
-    return $config;
-  }
+
+  /**
+   * @see sfConfigHandler
+   */
+  static public function getConfiguration(array $configFiles)
+  {
+    $config = array();
+    foreach ($configFiles as $configFile)
+    {
+      $config = array_merge($config, self::parseYaml($configFile));
+    }
+
+    return self::replacePath(self::replaceConstants($config));
+  }
-}

branches/1.1/lib/config/sfConfigHandler.class.php

@@ -72 +72 @@
-   * @return string The new value
-   */
-public stat
+static publ
-  {
-    if (is_array($value))
@@ -113 +113 @@
-    return $this->parameterHolder;
-  }
+
+  /**
+   * Returns the configuration for the current config handler.
+   *
+   * @param array An array of ordered configuration files
+   *
+   * @param array A configuration array
+   */
+  static public function getConfiguration(array $configFiles)
+  {
+    throw new LogicException('You must call the ::getConfiguration() method on a concrete config handler class');
+  }
-}

branches/1.1/lib/config/sfDatabaseConfigHandler.class.php

@@ -36 +36 @@
-  {
-    // parse the yaml
-
-
-
-
-
-
-
+
-
-    // init our data and includes arrays
@@ -50 +44 @@
-
-    // get a list of database connections
-myC
+c
-    {
-      // is this category already registered?
@@ -72 +66 @@
-      {
-        // we have a file to include
-
-
-
+
-        {
-          // database file doesn't exist
-file
+dbConfig['file']
-        }
-
-        // append our data
-file
+dbConfig['file']
-      }
-
@@ -88 +80 @@
-      if (isset($dbConfig['param']))
-      {
-
-
-
-
+
-      }
-      $parameters['name'] = $name;
@@ -105 +94 @@
-                      date('Y/m/d H:i:s'), implode("\n", $includes), implode("\n", $data));
-  }
+
+  /**
+   * @see sfConfigHandler
+   */
+  static public function getConfiguration(array $configFiles)
+  {
+    $config = self::replaceConstants(self::flattenConfigurationWithEnvironment(self::parseYamls($configFiles)));
+
+    foreach ($config as $name => $dbConfig)
+    {
+      if (isset($dbConfig['file']))
+      {
+        $config[$name]['file'] = $this->replacePath($dbConfig['file']);
+      }
+    }
+
+    return $config;
+  }
-}

branches/1.1/lib/config/sfDefineEnvironmentConfigHandler.class.php

@@ -40 +40 @@
-
-    // parse the yaml
-myConfig = $this->mergeEnvironment($this->parseYamls($configFiles)
+config = self::getConfiguration($configFiles
-
-    $values = array();
-myC
+c
-    {
-      $values = array_merge($values, $this->getValues($prefix, $category, $keys));
@@ -110 +110 @@
-  protected function fixCategoryValue($category, $key, $value)
-  {
-
-
-
-
-
-
-
+
-  }
-
@@ -143 +137 @@
-
-  /**
-
-
-
-
-
+
-   */
-protected function mergeEnvironment($config
+static public function getConfiguration(array $configFiles
-  {
-
-
-
-
-
+
-  }
-}

branches/1.1/lib/config/sfFactoryConfigHandler.class.php

@@ -35 +35 @@
-  {
-    // parse the yaml
-
-
-
-
-
-
-
+
-
-    // init our data and includes arrays
@@ -54 +48 @@
-    {
-      // see if the factory exists for this controller
-myC
+c
-
-      if (!isset($keys['class']))
@@ -67 +61 @@
-      {
-        // we have a file to include
-
-
-
-
+
-        {
-          // factory file doesn't exist
-file
+keys['file']
-        }
-
-        // append our data
-file
+keys['file']
-      }
-
@@ -89 +80 @@
-        }
-
-
-
-
-
+
-      }
-
@@ -180 +168 @@
-            foreach ($parameters['loggers'] as $name => $keys)
-            {
-this->replaceConstants($keys['enabled'])
+keys['enabled']
-              {
-                continue;
@@ -194 +182 @@
-              if (isset($keys['param']['condition']))
-              {
-this->replaceConstants($keys['param']['condition'])
+keys['param']['condition']
-                unset($keys['param']['condition']);
-              }
@@ -228 +216 @@
-    return $retval;
-  }
+
+  /**
+   * @see sfConfigHandler
+   */
+  static public function getConfiguration(array $configFiles)
+  {
+    $config = self::replaceConstants(self::flattenConfigurationWithEnvironment(self::parseYamls($configFiles)));
+
+    foreach ($config as $factory => $values)
+    {
+      if (isset($values['file']))
+      {
+        $config[$factory]['file'] = $this->replacePath($values['file']);
+      }
+    }
+
+    return $config;
+  }
-}

branches/1.1/lib/config/sfFilterConfigHandler.class.php

@@ -34 +34 @@
-  {
-    // parse the yaml
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-    // init our data and includes arrays
@@ -82 +61 @@
-      if (isset($keys['file']))
-      {
-
-
-
-
-
+
-        {
-          // filter file doesn't exist
-file
+keys['file']
-        }
-
-        // append our data
-file
+keys['file']
-      }
-
@@ -99 +74 @@
-      if (isset($keys['param']['condition']))
-      {
-this->replaceConstants($keys['param']['condition'])
+keys['param']['condition']
-        unset($keys['param']['condition']);
-      }
@@ -189 +164 @@
-EOF;
-  }
+
+  /**
+   * @see sfConfigHandler
+   */
+  static public function getConfiguration(array $configFiles)
+  {
+    $config = self::parseYaml($configFiles[0]);
+    foreach (array_slice($configFiles, 1) as $i => $configFile)
+    {
+      // we get the order of the new file and merge with the previous configurations
+      $previous = $config;
+
+      $config = array();
+      foreach (self::parseYaml($configFile) as $key => $value)
+      {
+        $value = (array) $value;
+        $config[$key] = isset($previous[$key]) ? sfToolkit::arrayDeepMerge($previous[$key], $value) : $value;
+      }
+
+      // check that every key in previous array is still present (to avoid problem when upgrading)
+      foreach (array_keys($previous) as $key)
+      {
+        if (!isset($config[$key]))
+        {
+          throw new sfConfigurationException(sprintf('The filter name "%s" is defined in "%s" but not present in "%s" file. To disable a filter, add a "enabled" key with a false value.', $key, $configFiles[$i], $configFile));
+        }
+      }
+    }
+
+    $config = self::replaceConstants($config);
+
+    foreach ($config as $category => $keys)
+    {
+      if (isset($keys['file']))
+      {
+        $config['category']['file'] = $this->replacePath($keys['file']);
+      }
+    }
+
+    return $config;
+  }
-}

branches/1.1/lib/config/sfGeneratorConfigHandler.class.php

@@ -33 +33 @@
-  {
-    // parse the yaml
-$this->parseYamls
+self::getConfiguration
-    if (!$config)
-    {
@@ -79 +79 @@
-    return $retval;
-  }
+
+  /**
+   * @see sfConfigHandler
+   */
+  static public function getConfiguration(array $configFiles)
+  {
+    return self::parseYamls($configFiles);
+  }
-}

branches/1.1/lib/config/sfRootConfigHandler.class.php

@@ -33 +33 @@
-  {
-    // parse the yaml
-$this->parseYamls
+self::getConfiguration
-
-    // determine if we're loading the system config_handlers.yml or a module config_handlers.yml
@@ -68 +68 @@
-      if (isset($keys['file']))
-      {
-
-
-
-
-
+
-        {
-          // handler file doesn't exist
-file
+keys['file']
-        }
-
-        // append our data
-file
+keys['file']
-      }
-
@@ -97 +93 @@
-    return $retval;
-  }
+
+  /**
+   * @see sfConfigHandler
+   */
+  static public function getConfiguration(array $configFiles)
+  {
+    $config = self::replaceConstants(self::parseYamls($configFiles));
+
+    foreach ($config as $category => $keys)
+    {
+      if (isset($keys['file']))
+      {
+        $config['category']['file'] = $this->replacePath($keys['file']);
+      }
+    }
+
+    return $config;
+  }
-}

branches/1.1/lib/config/sfRoutingConfigHandler.class.php

@@ -30 +30 @@
-  {
-    // parse the yaml
-$this->parseYamls
+self::getConfiguration
-
-    // connect routes
@@ -49 +49 @@
-    );
-  }
+
+  /**
+   * @see sfConfigHandler
+   */
+  static public function getConfiguration(array $configFiles)
+  {
+    return self::parseYamls($configFiles);
+  }
-}

branches/1.1/lib/config/sfSecurityConfigHandler.class.php

@@ -33 +33 @@
-  {
-    // parse the yaml
-
-
-
-
-
-
-
-
-
-
-
+
-
-    // compile data
@@ -49 +39 @@
-                      "// auto-generated by sfSecurityConfigHandler\n".
-                      "// date: %s\n\$this->security = %s;\n",
-myC
+c
-
-    return $retval;
-  }
+
+  /**
+   * @see sfConfigHandler
+   */
+  static public function getConfiguration(array $configFiles)
+  {
+    $config = self::flattenConfiguration(self::parseYamls($configFiles));
+
+    // change all of the keys to lowercase
+    $config = array_change_key_case($config);
+
+    return $config;
+  }
-}

branches/1.1/lib/config/sfSimpleYamlConfigHandler.class.php

@@ -28 +28 @@
-  public function execute($configFiles)
-  {
-$this->parseYamls
+self::getConfiguration
-
-    // compile data
@@ -38 +38 @@
-    return $retval;
-  }
+
+  /**
+   * @see sfConfigHandler
+   */
+  static public function getConfiguration(array $configFiles)
+  {
+    return self::parseYamls($configFiles);
+  }
-}

branches/1.1/lib/config/sfViewConfigHandler.class.php

@@ -32 +32 @@
-  public function execute($configFiles)
-  {
-    // set our required categories list and initialize our handler
-    $categories = array('required_categories' => array());
-    $this->initialize($categories);
-
-    // parse the yaml
-mergeConfig($this->parseYamls($configFiles)
+yamlConfig = self::getConfiguration($configFiles
-
-    // init our data array
@@ -108 +104 @@
-
-    return $retval;
-  }
-
-  /**
-   * Merges assets and environement configuration.
-   *
-   * @param array A configuration array
-   */
-  protected function mergeConfig($myConfig)
-  {
-    // merge javascripts and stylesheets
-    $myConfig['all']['stylesheets'] = array_merge(isset($myConfig['default']['stylesheets']) && is_array($myConfig['default']['stylesheets']) ? $myConfig['default']['stylesheets'] : array(), isset($myConfig['all']['stylesheets']) && is_array($myConfig['all']['stylesheets']) ? $myConfig['all']['stylesheets'] : array());
-    unset($myConfig['default']['stylesheets']);
-
-    $myConfig['all']['javascripts'] = array_merge(isset($myConfig['default']['javascripts']) && is_array($myConfig['default']['javascripts']) ? $myConfig['default']['javascripts'] : array(), isset($myConfig['all']['javascripts']) && is_array($myConfig['all']['javascripts']) ? $myConfig['all']['javascripts'] : array());
-    unset($myConfig['default']['javascripts']);
-
-    // merge default and all
-    $myConfig['all'] = sfToolkit::arrayDeepMerge(
-      isset($myConfig['default']) && is_array($myConfig['default']) ? $myConfig['default'] : array(),
-      isset($myConfig['all']) && is_array($myConfig['all']) ? $myConfig['all'] : array()
-    );
-
-    unset($myConfig['default']);
-
-    $this->yamlConfig = $myConfig;
-  }
-
@@ -268 +239 @@
-      }
-
-      $key = $this->replaceConstants($key);
-
-      if ('-*' == $key)
-      {
@@ -311 +280 @@
-      }
-
-      $key = $this->replaceConstants($key);
-
-      if ('-*' == $key)
-      {
@@ -352 +319 @@
-    return implode("\n", $data)."\n";
-  }
+
+  /**
+   * @see sfConfigHandler
+   */
+  static public function getConfiguration(array $configFiles)
+  {
+    return self::mergeConfig(self::parseYamls($configFiles));
+  }
+
+  static protected function mergeConfig($config)
+  {
+    // merge javascripts and stylesheets
+    $config['all']['stylesheets'] = array_merge(isset($config['default']['stylesheets']) && is_array($config['default']['stylesheets']) ? $config['default']['stylesheets'] : array(), isset($config['all']['stylesheets']) && is_array($config['all']['stylesheets']) ? $config['all']['stylesheets'] : array());
+    unset($config['default']['stylesheets']);
+
+    $config['all']['javascripts'] = array_merge(isset($config['default']['javascripts']) && is_array($config['default']['javascripts']) ? $config['default']['javascripts'] : array(), isset($config['all']['javascripts']) && is_array($config['all']['javascripts']) ? $config['all']['javascripts'] : array());
+    unset($config['default']['javascripts']);
+
+    // merge default and all
+    $config['all'] = sfToolkit::arrayDeepMerge(
+      isset($config['default']) && is_array($config['default']) ? $config['default'] : array(),
+      isset($config['all']) && is_array($config['all']) ? $config['all'] : array()
+    );
+
+    unset($config['default']);
+
+    return self::replaceConstants($config);
+  }
-}

branches/1.1/lib/config/sfYamlConfigHandler.class.php

@@ -30 +30 @@
-   * @return array A merged configuration array
-   */
-protected
+static public
-  {
-    $config = array();
-    foreach ($configFiles as $configFile)
-    {
-$this->
+self::
-    }
-
@@ -51 +51 @@
-   * @throws sfParseException If a requested configuration file is improperly formatted
-   */
-protected
+static public
-  {
-    if (!is_readable($configFile))
@@ -118 +118 @@
-    return $defaultValue;
-  }
+
+  static public function flattenConfiguration($config)
+  {
+    $config['all'] = sfToolkit::arrayDeepMerge(
+      isset($config['default']) && is_array($config['default']) ? $config['default'] : array(),
+      isset($config['all']) && is_array($config['all']) ? $config['all'] : array()
+    );
+
+    unset($config['default']);
+
+    return $config;
+  }
+
+  /**
+   * Merges default, all and current environment configurations.
+   *
+   * @param array The main configuratino array
+   *
+   * @param array The merged configuration
+   */
+  static public function flattenConfigurationWithEnvironment($config)
+  {
+    return sfToolkit::arrayDeepMerge(
+      isset($config['default']) && is_array($config['default']) ? $config['default'] : array(),
+      isset($config['all']) && is_array($config['all']) ? $config['all'] : array(),
+      isset($config[sfConfig::get('sf_environment')]) && is_array($config[sfConfig::get('sf_environment')]) ? $config[sfConfig::get('sf_environment')] : array()
+    );
+  }
-}