1. sfModelGenerator.class.php
  2. /**
 * Model generator.
 *
 * @package    symfony
 * @subpackage generator
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfModelGenerator.class.php 25459 2009-12-16 13:08:43Z fabien $
 */
  3. abstract class sfModelGenerator extends sfGenerator
  4. {
  5.   protected
  6.     $configuration = null,
  7.     $primaryKey    = array(),
  8.     $modelClass    = '',
  9.     $params        = array(),
  10.     $config        = array(),
  11.     $formObject    = null;
  13.   /**
  14.    * Generates classes and templates in cache.
  15.    *
  16.    * @param array $params The parameters
  17.    *
  18.    * @return string The data to put in configuration cache
  19.    */
  20.   public function generate($params = array())
  21.   {
  22.     $this->validateParameters($params);
  24.     $this->modelClass = $this->params['model_class'];
  26.     // generated module name
  27.     $this->setModuleName($this->params['moduleName']);
  28.     $this->setGeneratedModuleName('auto'.ucfirst($this->params['moduleName']));
  30.     // theme exists?
  31.     $theme = isset($this->params['theme']) ? $this->params['theme'] : 'default';
  32.     $this->setTheme($theme);
  33.     $themeDir = $this->generatorManager->getConfiguration()->getGeneratorTemplate($this->getGeneratorClass(), $theme, '');
  34.     if (!is_dir($themeDir))
  35.     {
  36.       throw new sfConfigurationException(sprintf('The theme "%s" does not exist.', $theme));
  37.     }
  39.     // configure the model
  40.     $this->configure();
  42.     $this->configuration = $this->loadConfiguration();
  44.     // generate files
  45.     $this->generatePhpFiles($this->generatedModuleName, sfFinder::type('file')->relative()->in($themeDir));
  47.     // move helper file
  48.     if (file_exists($file = $this->generatorManager->getBasePath().'/'.$this->getGeneratedModuleName().'/lib/helper.php'))
  49.     {
  50.       @rename($file, $this->generatorManager->getBasePath().'/'.$this->getGeneratedModuleName().'/lib/Base'.ucfirst($this->moduleName).'GeneratorHelper.class.php');
  51.     }
  53.     return "require_once(sfConfig::get('sf_module_cache_dir').'/".$this->generatedModuleName."/actions/actions.class.php');";
  54.   }
  56.   /**
  57.    * Gets the actions base class for the generated module.
  58.    *
  59.    * @return string The actions base class
  60.    */
  61.   public function getActionsBaseClass()
  62.   {
  63.     return isset($this->params['actions_base_class']) ? $this->params['actions_base_class'] : 'sfActions';
  64.   }
  66.   /**
  67.    * Gets the class name for current model.
  68.    *
  69.    * @return string
  70.    */
  71.   public function getModelClass()
  72.   {
  73.     return $this->modelClass;
  74.   }
  76.   /**
  77.    * Gets the primary key name.
  78.    *
  79.    * @param Boolean $firstOne Whether to return the first PK or not
  80.    *
  81.    * @return array An array of primary keys
  82.    */
  83.   public function getPrimaryKeys($firstOne = false)
  84.   {
  85.     return $firstOne ? $this->primaryKey[0] : $this->primaryKey;
  86.   }
  88.   /**
  89.    * Gets the singular name for current model.
  90.    *
  91.    * @return string
  92.    */
  93.   public function getSingularName()
  94.   {
  95.     return isset($this->params['singular']) ? $this->params['singular'] : sfInflector::underscore($this->getModelClass());
  96.   }
  98.   /**
  99.    * Gets the plural name for current model.
  100.    *
  101.    * @return string
  102.    */
  103.   public function getPluralName()
  104.   {
  105.     return isset($this->params['plural']) ? $this->params['plural'] : $this->getSingularName().'_list';
  106.   }
  108.   /**
  109.    * Gets the i18n catalogue to use for user strings.
  110.    *
  111.    * @return string The i18n catalogue
  112.    */
  113.   public function getI18nCatalogue()
  114.   {
  115.     return isset($this->params['i18n_catalogue']) ? $this->params['i18n_catalogue'] : 'messages';
  116.   }
  118.   /**
  119.    * Returns PHP code for primary keys parameters.
  120.    *
  121.    * @param integer $indent The indentation value
  122.    * @param string  $callee The function to call
  123.    *
  124.    * @return string The PHP code
  125.    */
  126.   public function getRetrieveByPkParamsForAction($indent)
  127.   {
  128.     $params = array();
  129.     foreach ($this->getPrimaryKeys() as $pk)
  130.     {
  131.       $params[] = sprintf("\$request->getParameter('%s')", sfInflector::underscore($pk));
  132.     }
  134.     return implode(",\n".str_repeat(' ', max(0, $indent - strlen($this->getSingularName().$this->modelClass))), $params);
  135.   }
  137.   /**
  138.    * Returns PHP code to add to a URL for primary keys.
  139.    *
  140.    * @param string $prefix The prefix value
  141.    *
  142.    * @return string PHP code
  143.    */
  144.   public function getPrimaryKeyUrlParams($prefix = '', $full = false)
  145.   {
  146.     $params = array();
  147.     foreach ($this->getPrimaryKeys() as $pk)
  148.     {
  149.       $fieldName = sfInflector::underscore($pk);
  151.       if ($full)
  152.       {
  153.         $params[] = sprintf("%s='.%s->%s()", $fieldName, $prefix, $this->getColumnGetter($fieldName, false));
  154.       }
  155.       else
  156.       {
  157.         $params[] = sprintf("%s='.%s", $fieldName, $this->getColumnGetter($fieldName, true, $prefix));
  158.       }
  159.     }
  161.     return implode(".'&", $params);
  162.   }
  164.   /** 
  165.    * Configures this generator.
  166.    */
  167.   abstract protected function configure();
  169.   abstract public function getType($column);
  171.   abstract public function getAllFieldNames();
  173.   /**
  174.    * Returns the getter either non-developped: 'getFoo' or developped: '$class->getFoo()'.
  175.    *
  176.    * This method is ORM dependant.
  177.    *
  178.    * @param string  $column    The column name
  179.    * @param boolean $developed true if you want developped method names, false otherwise
  180.    * @param string  $prefix    The prefix value
  181.    *
  182.    * @return string PHP code
  183.    */
  184.   abstract public function getColumnGetter($column, $developed = false , $prefix = '');
  186.   abstract public function getManyToManyTables();
  188.   /**
  189.    * Returns HTML code for an action link.
  190.    *
  191.    * @param string  $actionName The action name
  192.    * @param array   $params     The parameters
  193.    * @param boolean $pk_link    Whether to add a primary key link or not
  194.    *
  195.    * @return string HTML code
  196.    */
  197.   public function getLinkToAction($actionName, $params, $pk_link = false)
  198.   {
  199.     $action = isset($params['action']) ? $params['action'] : 'List'.sfInflector::camelize($actionName);
  201.     $url_params = $pk_link ? '?'.$this->getPrimaryKeyUrlParams() : '\'';
  203.     return '[?php echo link_to(__(\''.$params['label'].'\', array(), \''.$this->getI18nCatalogue().'\'), \''.$this->getModuleName().'/'.$action.$url_params.', '.$this->asPhp($params['params']).') ?]';
  204.   }
  206.   /**
  207.    * Wraps content with a credential condition.
  208.    *
  209.    * @param string $content The content
  210.    * @param array  $params  The parameters
  211.    *
  212.    * @return string HTML code
  213.    */
  214.   public function addCredentialCondition($content, $params = array())
  215.   {
  216.     if (isset($params['credentials']))
  217.     {
  218.       $credentials = $this->asPhp($params['credentials']);
  220.       return <<<EOF
  221. [?php if (\$sf_user->hasCredential($credentials)): ?]
  222. $content
  223. [?php endif; ?]
  225. EOF;
  226.     }
  227.     else
  228.     {
  229.       return $content;
  230.     }
  231.   }
  233.   /**
  234.    * Returns HTML code for a field.
  235.    *
  236.    * @param sfModelGeneratorConfigurationField $field The field
  237.    *
  238.    * @return string HTML code
  239.    */
  240.   public function renderField($field)
  241.   {
  242.     $html = $this->getColumnGetter($field->getName(), true);
  244.     if ($renderer = $field->getRenderer())
  245.     {
  246.       $html = sprintf("$html ? call_user_func_array(%s, array_merge(array(%s), %s)) : '&nbsp;'", $this->asPhp($renderer), $html, $this->asPhp($field->getRendererArguments()));
  247.     }
  248.     else if ($field->isComponent())
  249.     {
  250.       return sprintf("get_component('%s', '%s', array('type' => 'list', '%s' => \$%s))", $this->getModuleName(), $field->getName(), $this->getSingularName(), $this->getSingularName());
  251.     }
  252.     else if ($field->isPartial())
  253.     {
  254.       return sprintf("get_partial('%s/%s', array('type' => 'list', '%s' => \$%s))", $this->getModuleName(), $field->getName(), $this->getSingularName(), $this->getSingularName());
  255.     }
  256.     else if ('Date' == $field->getType())
  257.     {
  258.       $html = sprintf("false !== strtotime($html) ? format_date(%s, \"%s\") : '&nbsp;'", $html, $field->getConfig('date_format', 'f'));
  259.     }
  260.     else if ('Boolean' == $field->getType())
  261.     {
  262.       $html = sprintf("get_partial('%s/list_field_boolean', array('value' => %s))", $this->getModuleName(), $html);
  263.     }
  265.     if ($field->isLink())
  266.     {
  267.       $html = sprintf("link_to(%s, '%s', \$%s)", $html, $this->getUrlForAction('edit'), $this->getSingularName());
  268.     }
  270.     return $html;
  271.   }
  273.   /**
  274.    * Wraps a content for I18N.
  275.    *
  276.    * @param string $key The configuration key name
  277.    *
  278.    * @return string HTML code
  279.    */
  280.   public function getI18NString($key)
  281.   {
  282.     $value = $this->configuration->getValue($key, '', true);
  284.     $parts = explode('.', $key);
  285.     $context = $parts[0];
  287.     // find %%xx%% strings
  288.     preg_match_all('/%%([^%]+)%%/', $value, $matches, PREG_PATTERN_ORDER);
  289.     $fields = array();
  290.     foreach ($matches[1] as $name)
  291.     {
  292.       $fields[] = $name;
  293.     }
  295.     $vars = array();
  296.     foreach ($this->configuration->getContextConfiguration($context, $fields) as $field)
  297.     {
  298.       $vars[] = '\'%%'.$field->getName().'%%\' => '.$this->renderField($field);
  299.     }
  301.     return sprintf("__('%s', array(%s), '%s')", $value, implode(', ', $vars), $this->getI18nCatalogue());
  302.   }
  304.   /**
  305.    * Gets the form object
  306.    *
  307.    * @return sfForm
  308.    */
  309.   public function getFormObject()
  310.   {
  311.     if (null === $this->formObject)
  312.     {
  313.       $class = null === $this->configuration ? $this->getModelClass().'Form' : $this->configuration->getFormClass();
  315.       $this->formObject = new $class();
  316.     }
  318.     return $this->formObject;
  319.   }
  321.   /**
  322.    * Gets the HTML to add to the form tag if the form is multipart.
  323.    *
  324.    * @return string
  325.    */
  326.   public function getFormMultipartHtml()
  327.   {
  328.     if (isset($this->params['non_verbose_templates']) && $this->params['non_verbose_templates'])
  329.     {
  330.       return '[?php $form->isMultipart() and print \' enctype="multipart/form-data"\' ?]';
  331.     }
  332.     else
  333.     {
  334.       return $this->getFormObject()->isMultipart() ? ' enctype="multipart/form-data"' : '';
  335.     }
  336.   }
  338.   /**
  339.    * Validates the basic structure of the parameters.
  340.    *
  341.    * @param array $params An array of parameters
  342.    */
  343.   protected function validateParameters($params)
  344.   {
  345.     foreach (array('model_class', 'moduleName') as $key)
  346.     {
  347.       if (!isset($params[$key]))
  348.       {
  349.         throw new sfParseException(sprintf('sfModelGenerator must have a "%s" parameter.', $key));
  350.       }
  351.     }
  353.     if (!class_exists($params['model_class']))
  354.     {
  355.       throw new sfInitializationException(sprintf('Unable to generate a module for non-existent model "%s".', $params['model_class']));
  356.     }
  358.     $this->config = isset($params['config']) ? $params['config'] : array();
  360.     unset($params['config']);
  361.     $this->params = $params;
  362.   }
  364.   /**
  365.    * Loads the configuration for this generated module.
  366.    */
  367.   protected function loadConfiguration()
  368.   {
  369.     try
  370.     {
  371.       $this->generatorManager->getConfiguration()->getGeneratorTemplate($this->getGeneratorClass(), $this->getTheme(), '../parts/configuration.php');
  372.     }
  373.     catch (sfException $e)
  374.     {
  375.       return null;
  376.     }
  378.     $config = $this->getGeneratorManager()->getConfiguration();
  379.     if (!$config instanceof sfApplicationConfiguration)
  380.     {
  381.       throw new LogicException('The sfModelGenerator can only operates with an application configuration.');
  382.     }
  384.     $basePath = $this->getGeneratedModuleName().'/lib/Base'.ucfirst($this->getModuleName()).'GeneratorConfiguration.class.php';
  385.     $this->getGeneratorManager()->save($basePath, $this->evalTemplate('../parts/configuration.php'));
  387.     require_once $this->getGeneratorManager()->getBasePath().'/'.$basePath;
  389.     $class = 'Base'.ucfirst($this->getModuleName()).'GeneratorConfiguration';
  390.     foreach ($config->getLibDirs($this->getModuleName()) as $dir)
  391.     {
  392.       if (!is_file($configuration = $dir.'/'.$this->getModuleName().'GeneratorConfiguration.class.php'))
  393.       {
  394.         continue;
  395.       }
  397.       require_once $configuration;
  398.       $class = $this->getModuleName().'GeneratorConfiguration';
  399.       break;
  400.     }
  402.     // validate configuration
  403.     foreach ($this->config as $context => $value)
  404.     {
  405.       if (!$value)
  406.       {
  407.         continue;
  408.       }
  410.       throw new InvalidArgumentException(sprintf('Your generator configuration contains some errors for the "%s" context. The following configuration cannot be parsed: %s.', $context, $this->asPhp($value)));
  411.     }
  413.     return new $class();
  414.   }
  416.   /**
  417.    * Returns the URL for a given action.
  418.    *
  419.    * @return string The URL related to a given action
  420.    */
  421.   public function getUrlForAction($action)
  422.   {
  423.     if (isset($this->params['route_prefix']))
  424.     {
  425.       return 'list' == $action ? $this->params['route_prefix'] : $this->params['route_prefix'].'_'.$action;
  426.     }
  427.     else
  428.     {
  429.       return $this->getModuleName().'/'.$action;
  430.     }
  431.   }
  433.   public function asPhp($variable)
  434.   {
  435.     return str_replace(array("\n", 'array ('), array('', 'array('), var_export($variable, true));
  436.   }
  438.   public function escapeString($string)
  439.   {
  440.     return str_replace("'", "\\'", $string);
  441.   }
  442. }
Debug toolbar