1. sfFactoryConfigHandler.class.php
  2. /**
 * sfFactoryConfigHandler allows you to specify which factory implementation the
 * system will use.
 *
 * @package    symfony
 * @subpackage config
 * @author     Fabien Potencier 
 * @author     Sean Kerr 
 * @version    SVN: $Id: sfFactoryConfigHandler.class.php 23810 2009-11-12 11:07:44Z Kris.Wallsmith $
 */
  3. class sfFactoryConfigHandler extends sfYamlConfigHandler
  4. {
  5.   /**
  6.    * Executes this configuration handler.
  7.    *
  8.    * @param array $configFiles An array of absolute filesystem path to a configuration file
  9.    *
  10.    * @return string Data to be written to a cache file
  11.    *
  12.    * @throws <b>sfConfigurationException</b> If a requested configuration file does not exist or is not readable
  13.    * @throws <b>sfParseException</b> If a requested configuration file is improperly formatted
  14.    */
  15.   public function execute($configFiles)
  16.   {
  17.     // parse the yaml
  18.     $config = self::getConfiguration($configFiles);
  20.     // init our data and includes arrays
  21.     $includes  = array();
  22.     $instances = array();
  24.     // available list of factories
  25.     $factories = array('view_cache_manager', 'logger', 'i18n', 'controller', 'request', 'response', 'routing', 'storage', 'user', 'view_cache', 'mailer');
  27.     // let's do our fancy work
  28.     foreach ($factories as $factory)
  29.     {
  30.       // see if the factory exists for this controller
  31.       $keys = $config[$factory];
  33.       if (!isset($keys['class']))
  34.       {
  35.         // missing class key
  36.         throw new sfParseException(sprintf('Configuration file "%s" specifies category "%s" with missing class key.', $configFiles[0], $factory));
  37.       }
  39.       $class = $keys['class'];
  41.       if (isset($keys['file']))
  42.       {
  43.         // we have a file to include
  44.         if (!is_readable($keys['file']))
  45.         {
  46.           // factory file doesn't exist
  47.           throw new sfParseException(sprintf('Configuration file "%s" specifies class "%s" with nonexistent or unreadable file "%s".', $configFiles[0], $class, $keys['file']));
  48.         }
  50.         // append our data
  51.         $includes[] = sprintf("require_once('%s');", $keys['file']);
  52.       }
  54.       // parse parameters
  55.       $parameters = array();
  56.       if (isset($keys['param']))
  57.       {
  58.         if (!is_array($keys['param']))
  59.         {
  60.           throw new InvalidArgumentException(sprintf('The "param" key for the "%s" factory must be an array (in %s).', $class, $configFiles[0]));
  61.         }
  63.         $parameters = $keys['param'];
  64.       }
  66.       // append new data
  67.       switch ($factory)
  68.       {
  69.         case 'controller':
  70.           $instances[] = sprintf("  \$class = sfConfig::get('sf_factory_controller', '%s');\n   \$this->factories['controller'] = new \$class(\$this);", $class);
  71.           break;
  73.         case 'request':
  74.           $parameters['no_script_name'] = sfConfig::get('sf_no_script_name');
  75.           $instances[] = sprintf("  \$class = sfConfig::get('sf_factory_request', '%s');\n   \$this->factories['request'] = new \$class(\$this->dispatcher, array(), array(), sfConfig::get('sf_factory_request_parameters', %s), sfConfig::get('sf_factory_request_attributes', array()));", $class, var_export($parameters, true));
  76.           break;
  78.         case 'response':
  79.           $instances[] = sprintf("  \$class = sfConfig::get('sf_factory_response', '%s');\n  \$this->factories['response'] = new \$class(\$this->dispatcher, sfConfig::get('sf_factory_response_parameters', array_merge(array('http_protocol' => isset(\$_SERVER['SERVER_PROTOCOL']) ? \$_SERVER['SERVER_PROTOCOL'] : null), %s)));", $class, var_export($parameters, true));
  80.           // TODO: this is a bit ugly, as it only works for sfWebRequest & sfWebResponse combination. see #3397
  81.           $instances[] = sprintf("  if (\$this->factories['request'] instanceof sfWebRequest \n      && \$this->factories['response'] instanceof sfWebResponse \n      && 'HEAD' == \$this->factories['request']->getMethod())\n  {  \n    \$this->factories['response']->setHeaderOnly(true);\n  }\n");
  82.           break;
  84.         case 'storage':
  85.           $defaultParameters = array();
  86.           $defaultParameters[] = sprintf("'auto_shutdown' => false, 'session_id' => \$this->getRequest()->getParameter('%s'),", $parameters['session_name']);
  87.           if (is_subclass_of($class, 'sfDatabaseSessionStorage'))
  88.           {
  89.             $defaultParameters[] = sprintf("'database' => \$this->getDatabaseManager()->getDatabase('%s'),", isset($parameters['database']) ? $parameters['database'] : 'default');
  90.             unset($parameters['database']);
  91.           }
  93.           $instances[] = sprintf("  \$class = sfConfig::get('sf_factory_storage', '%s');\n  \$this->factories['storage'] = new \$class(array_merge(array(\n%s\n), sfConfig::get('sf_factory_storage_parameters', %s)));", $class, implode("\n", $defaultParameters), var_export($parameters, true));
  94.           break;
  96.         case 'user':
  97.           $instances[] = sprintf("  \$class = sfConfig::get('sf_factory_user', '%s');\n  \$this->factories['user'] = new \$class(\$this->dispatcher, \$this->factories['storage'], array_merge(array('auto_shutdown' => false, 'culture' => \$this->factories['request']->getParameter('sf_culture')), sfConfig::get('sf_factory_user_parameters', %s)));", $class, var_export($parameters, true));
  98.           break;
  100.         case 'view_cache':
  101.           $instances[] = sprintf("\n  if (sfConfig::get('sf_cache'))\n  {\n".
  102.                              "    \$class = sfConfig::get('sf_factory_view_cache', '%s');\n".
  103.                              "    \$cache = new \$class(sfConfig::get('sf_factory_view_cache_parameters', %s));\n".
  104.                              "    \$this->factories['viewCacheManager'] = new %s(\$this, \$cache, %s);\n".
  105.                              "  }\n".
  106.                              "  else\n".
  107.                              "  {\n".
  108.                              "    \$this->factories['viewCacheManager'] = null;\n".
  109.                              "  }\n",
  110.                              $class, var_export($parameters, true), $config['view_cache_manager']['class'], var_export($config['view_cache_manager']['param'], true));
  111.           break;
  113.         case 'i18n':
  114.           if (isset($parameters['cache']))
  115.           {
  116.             $cache = sprintf("    \$cache = new %s(%s);\n", $parameters['cache']['class'], var_export($parameters['cache']['param'], true));
  117.             unset($parameters['cache']);
  118.           }
  119.           else
  120.           {
  121.             $cache = "    \$cache = null;\n";
  122.           }
  124.           $instances[] = sprintf("\n  if (sfConfig::get('sf_i18n'))\n  {\n".
  125.                      "    \$class = sfConfig::get('sf_factory_i18n', '%s');\n".
  126.                      "%s".
  127.                      "    \$this->factories['i18n'] = new \$class(\$this->configuration, \$cache, %s);\n".
  128.                      "    sfWidgetFormSchemaFormatter::setTranslationCallable(array(\$this->factories['i18n'], '__'));\n".
  129.                      "  }\n"
  130.                      , $class, $cache, var_export($parameters, true)
  131.                      );
  132.           break;
  134.         case 'routing':
  135.           if (isset($parameters['cache']))
  136.           {
  137.             $cache = sprintf("    \$cache = new %s(%s);\n", $parameters['cache']['class'], var_export($parameters['cache']['param'], true));
  138.             unset($parameters['cache']);
  139.           }
  140.           else
  141.           {
  142.             $cache = "    \$cache = null;\n";
  143.           }
  145.           $instances[] = sprintf("  \$class = sfConfig::get('sf_factory_routing', '%s');\n".
  146.                            "  %s\n".
  147.                            "\$this->factories['routing'] = new \$class(\$this->dispatcher, \$cache, array_merge(array('auto_shutdown' => false, 'context' => \$this->factories['request']->getRequestContext()), sfConfig::get('sf_factory_routing_parameters', %s)));\n".
  148.                            "if (\$parameters = \$this->factories['routing']->parse(\$this->factories['request']->getPathInfo()))\n".
  149.                            "{\n".
  150.                            "  \$this->factories['request']->addRequestParameters(\$parameters);\n".
  151.                            "}\n",
  152.                            $class, $cache, var_export($parameters, true)
  153.                          );
  154.           break;
  156.         case 'logger':
  157.           $loggers = '';
  158.           if (isset($parameters['loggers']))
  159.           {
  160.             foreach ($parameters['loggers'] as $name => $keys)
  161.             {
  162.               if (isset($keys['enabled']) && !$keys['enabled'])
  163.               {
  164.                 continue;
  165.               }
  167.               if (!isset($keys['class']))
  168.               {
  169.                 // missing class key
  170.                 throw new sfParseException(sprintf('Configuration file "%s" specifies logger "%s" with missing class key.', $configFiles[0], $name));
  171.               }
  173.               $condition = true;
  174.               if (isset($keys['param']['condition']))
  175.               {
  176.                 $condition = $keys['param']['condition'];
  177.                 unset($keys['param']['condition']);
  178.               }
  180.               if ($condition)
  181.               {
  182.                 // create logger instance
  183.                 $loggers .= sprintf("\n\$logger = new %s(\$this->dispatcher, array_merge(array('auto_shutdown' => false), %s));\n\$this->factories['logger']->addLogger(\$logger);\n",
  184.                               $keys['class'],
  185.                               isset($keys['param']) ? var_export($keys['param'], true) : 'array()'
  186.                             );
  187.               }
  188.             }
  190.             unset($parameters['loggers']);
  191.           }
  193.           $instances[] = sprintf(
  194.                          "  \$class = sfConfig::get('sf_factory_logger', '%s');\n  \$this->factories['logger'] = new \$class(\$this->dispatcher, array_merge(array('auto_shutdown' => false), sfConfig::get('sf_factory_logger_parameters', %s)));\n".
  195.                          "  %s"
  196.                          , $class, var_export($parameters, true), $loggers);
  197.           break;
  199.         case 'mailer':
  200.           $instances[] = sprintf(
  201.                         "require_once sfConfig::get('sf_symfony_lib_dir').'/vendor/swiftmailer/classes/Swift.php';\n".
  202.                         "Swift::registerAutoload();\n".
  203.                         "sfMailer::initialize();\n".
  204.                         "\$this->setMailerConfiguration(array_merge(array('class' => sfConfig::get('sf_factory_mailer', '%s')), sfConfig::get('sf_factory_mailer_parameters', %s)));\n"
  205.                          , $class, var_export($parameters, true));
  206.           break;
  207.       }
  208.     }
  210.     // compile data
  211.     $retval = sprintf("<?php\n".
  212.                       "// auto-generated by sfFactoryConfigHandler\n".
  213.                       "// date: %s\n%s\n%s\n",
  214.                       date('Y/m/d H:i:s'), implode("\n", $includes),
  215.                       implode("\n", $instances));
  217.     return $retval;
  218.   }
  220.   /**
  221.    * @see sfConfigHandler
  222.    */
  223.   static public function getConfiguration(array $configFiles)
  224.   {
  225.     $config = self::replaceConstants(self::flattenConfigurationWithEnvironment(self::parseYamls($configFiles)));
  227.     foreach ($config as $factory => $values)
  228.     {
  229.       if (isset($values['file']))
  230.       {
  231.         $config[$factory]['file'] = self::replacePath($values['file']);
  232.       }
  233.     }
  235.     return $config;
  236.   }
  237. }
Debug toolbar