1. sfModelGeneratorConfiguration.class.php
  2. /**
 * Model generator configuration.
 *
 * @package    symfony
 * @subpackage generator
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfModelGeneratorConfiguration.class.php 23898 2009-11-14 13:14:04Z bschussek $
 */
  3. abstract class sfModelGeneratorConfiguration
  4. {
  5.   protected
  6.     $configuration = array();
  8.   abstract public function getActionsDefault();
  10.   abstract public function getFormActions();
  12.   abstract public function getNewActions();
  14.   abstract public function getEditActions();
  16.   abstract public function getListObjectActions();
  18.   abstract public function getListActions();
  20.   abstract public function getListBatchActions();
  22.   abstract public function getListParams();
  24.   abstract public function getListLayout();
  26.   abstract public function getListTitle();
  28.   abstract public function getEditTitle();
  30.   abstract public function getNewTitle();
  32.   abstract public function getFilterDisplay();
  34.   abstract public function getFormDisplay();
  36.   abstract public function getNewDisplay();
  38.   abstract public function getEditDisplay();
  40.   abstract public function getListDisplay();
  42.   abstract public function getFieldsDefault();
  44.   abstract public function getFieldsList();
  46.   abstract public function getFieldsFilter();
  48.   abstract public function getFieldsForm();
  50.   abstract public function getFieldsEdit();
  52.   abstract public function getFieldsNew();
  54.   abstract public function getFormClass();
  56.   abstract public function hasFilterForm();
  58.   abstract public function getFilterFormClass();
  60.   /**
  61.    * Constructor.
  62.    */
  63.   public function __construct()
  64.   {
  65.     $this->compile();
  66.   }
  68.   protected function compile()
  69.   {
  70.     $config = $this->getConfig();
  72.     // inheritance rules:
  73.     // new|edit < form < default
  74.     // list < default
  75.     // filter < default
  76.     $this->configuration = array(
  77.       'list'   => array(
  78.         'fields'         => array(),
  79.         'layout'         => $this->getListLayout(),
  80.         'title'          => $this->getListTitle(),
  81.         'actions'        => $this->getListActions(),
  82.         'object_actions' => $this->getListObjectActions(),
  83.         'params'         => $this->getListParams(),
  84.       ),
  85.       'filter' => array(
  86.         'fields'  => array(),
  87.       ),
  88.       'form'   => array(
  89.         'fields'  => array(),
  90.       ),
  91.       'new'    => array(
  92.         'fields'  => array(),
  93.         'title'   => $this->getNewTitle(),
  94.         'actions' => $this->getNewActions() ? $this->getNewActions() : $this->getFormActions(),
  95.       ),
  96.       'edit'   => array(
  97.         'fields'  => array(),
  98.         'title'   => $this->getEditTitle(),
  99.         'actions' => $this->getEditActions() ? $this->getEditActions() : $this->getFormActions(),
  100.       ),
  101.     );
  103.     foreach (array_keys($config['default']) as $field)
  104.     {
  105.       $formConfig = array_merge($config['default'][$field], isset($config['form'][$field]) ? $config['form'][$field] : array());
  107.       $this->configuration['list']['fields'][$field]   = new sfModelGeneratorConfigurationField($field, array_merge(array('label' => sfInflector::humanize(sfInflector::underscore($field))), $config['default'][$field], isset($config['list'][$field]) ? $config['list'][$field] : array()));
  108.       $this->configuration['filter']['fields'][$field] = new sfModelGeneratorConfigurationField($field, array_merge($config['default'][$field], isset($config['filter'][$field]) ? $config['filter'][$field] : array()));
  109.       $this->configuration['new']['fields'][$field]    = new sfModelGeneratorConfigurationField($field, array_merge($formConfig, isset($config['new'][$field]) ? $config['new'][$field] : array()));
  110.       $this->configuration['edit']['fields'][$field]   = new sfModelGeneratorConfigurationField($field, array_merge($formConfig, isset($config['edit'][$field]) ? $config['edit'][$field] : array()));
  111.     }
  113.     // "virtual" fields for list
  114.     foreach ($this->getListDisplay() as $field)
  115.     {
  116.       list($field, $flag) = sfModelGeneratorConfigurationField::splitFieldWithFlag($field);
  118.       $this->configuration['list']['fields'][$field] = new sfModelGeneratorConfigurationField($field, array_merge(
  119.         array('type' => 'Text', 'label' => sfInflector::humanize(sfInflector::underscore($field))),
  120.         isset($config['default'][$field]) ? $config['default'][$field] : array(),
  121.         isset($config['list'][$field]) ? $config['list'][$field] : array(),
  122.         array('flag' => $flag)
  123.       ));
  124.     }
  126.     // form actions
  127.     foreach (array('edit', 'new') as $context)
  128.     {
  129.       foreach ($this->configuration[$context]['actions'] as $action => $parameters)
  130.       {
  131.         $this->configuration[$context]['actions'][$action] = $this->fixActionParameters($action, $parameters);
  132.       }
  133.     }
  135.     // list actions
  136.     foreach ($this->configuration['list']['actions'] as $action => $parameters)
  137.     {
  138.       $this->configuration['list']['actions'][$action] = $this->fixActionParameters($action, $parameters);
  139.     }
  141.     // list batch actions
  142.     $this->configuration['list']['batch_actions'] = array();
  143.     foreach ($this->getListBatchActions() as $action => $parameters)
  144.     {
  145.       $parameters = $this->fixActionParameters($action, $parameters);
  147.       $action = 'batch'.ucfirst(0 === strpos($action, '_') ? substr($action, 1) : $action);
  149.       $this->configuration['list']['batch_actions'][$action] = $parameters;
  150.     }
  152.     // list object actions
  153.     foreach ($this->configuration['list']['object_actions'] as $action => $parameters)
  154.     {
  155.       $this->configuration['list']['object_actions'][$action] = $this->fixActionParameters($action, $parameters);
  156.     }
  158.     // list field configuration
  159.     $this->configuration['list']['display'] = array();
  160.     foreach ($this->getListDisplay() as $name)
  161.     {
  162.       list($name, $flag) = sfModelGeneratorConfigurationField::splitFieldWithFlag($name);
  163.       if (!isset($this->configuration['list']['fields'][$name]))
  164.       {
  165.         throw new InvalidArgumentException(sprintf('The field "%s" does not exist.', $name));
  166.       }
  167.       $field = $this->configuration['list']['fields'][$name];
  168.       $field->setFlag($flag);
  169.       $this->configuration['list']['display'][$name] = $field;
  170.     }
  172.     // parse the %%..%% variables, remove flags and add default fields where
  173.     // necessary (fixes #7578)
  174.     $this->parseVariables('list', 'params');
  175.     $this->parseVariables('edit', 'title');
  176.     $this->parseVariables('list', 'title');
  177.     $this->parseVariables('new', 'title');
  179.     // action credentials
  180.     $this->configuration['credentials'] = array(
  181.       'list'   => array(),
  182.       'new'    => array(),
  183.       'create' => array(),
  184.       'edit'   => array(),
  185.       'update' => array(),
  186.       'delete' => array(),
  187.     );
  188.     foreach ($this->getActionsDefault() as $action => $params)
  189.     {
  190.       if (0 === strpos($action, '_'))
  191.       {
  192.         $action = substr($action, 1);
  193.       }
  195.       $this->configuration['credentials'][$action] = isset($params['credentials']) ? $params['credentials'] : array();
  196.       $this->configuration['credentials']['batch'.ucfirst($action)] = isset($params['credentials']) ? $params['credentials'] : array();
  197.     }
  198.     $this->configuration['credentials']['create'] = $this->configuration['credentials']['new'];
  199.     $this->configuration['credentials']['update'] = $this->configuration['credentials']['edit'];
  200.   }
  202.   protected function parseVariables($context, $key)
  203.   {
  204.     preg_match_all('/%%([^%]+)%%/', $this->configuration[$context][$key], $matches, PREG_PATTERN_ORDER);
  205.     foreach ($matches[1] as $name)
  206.     {
  207.       list($name, $flag) = sfModelGeneratorConfigurationField::splitFieldWithFlag($name);
  208.       if (!isset($this->configuration[$context]['fields'][$name]))
  209.       {
  210.         $this->configuration[$context]['fields'][$name] = new sfModelGeneratorConfigurationField($name, array_merge(
  211.           array('type' => 'Text', 'label' => sfInflector::humanize(sfInflector::underscore($name))),
  212.           isset($config['default'][$name]) ? $config['default'][$name] : array(),
  213.           isset($config[$context][$name]) ? $config[$context][$name] : array(),
  214.           array('flag' => $flag)
  215.         ));
  216.       }
  217.       else
  218.       {
  219.         $this->configuration[$context]['fields'][$name]->setFlag($flag);
  220.       }
  222.       $this->configuration[$context][$key] = str_replace('%%'.$flag.$name.'%%', '%%'.$name.'%%', $this->configuration[$context][$key]);
  223.     }
  224.   }
  226.   public function getContextConfiguration($context, $fields = null)
  227.   {
  228.     if (!isset($this->configuration[$context]))
  229.     {
  230.       throw new InvalidArgumentException(sprintf('The context "%s" does not exist.', $context));
  231.     }
  233.     if (null === $fields)
  234.     {
  235.       return $this->configuration[$context];
  236.     }
  238.     $f = array();
  239.     foreach ($fields as $field)
  240.     {
  241.       $f[$field] = $this->configuration[$context]['fields'][$field];
  242.     }
  244.     return $f;
  245.   }
  247.   public function getFieldConfiguration($context, $field)
  248.   {
  249.     if (!isset($this->configuration[$context]))
  250.     {
  251.       throw new InvalidArgumentException(sprintf('The context "%s" does not exist.', $context));
  252.     }
  254.     if (!isset($this->configuration[$context]['fields'][$field]))
  255.     {
  256.       throw new InvalidArgumentException(sprintf('Field "%s" does not exist.', $field));
  257.     }
  259.     return $this->configuration[$context]['fields'][$field];
  260.   }
  262.   /**
  263.    * Gets the configuration for a given field.
  264.    *
  265.    * @param string  $key     The configuration key (title.list.name for example)
  266.    * @param mixed   $default The default value if none has been defined
  267.    * @param Boolean $escaped Whether to escape single quote (false by default)
  268.    *
  269.    * @return mixed The configuration value
  270.    */
  271.   public function getValue($key, $default = null, $escaped = false)
  272.   {
  273.     if (preg_match('/^(?P<context>[^\.]+)\.fields\.(?P<field>[^\.]+)\.(?P<key>.+)$/', $key, $matches))
  274.     {
  275.       $v = $this->getFieldConfiguration($matches['context'], $matches['field'])->getConfig($matches['key'], $default);
  276.     }
  277.     else if (preg_match('/^(?P<context>[^\.]+)\.(?P<key>.+)$/', $key, $matches))
  278.     {
  279.       $v = sfModelGeneratorConfiguration::getFieldConfigValue($this->getContextConfiguration($matches['context']), $matches['key'], $default);
  280.     }
  281.     else
  282.     {
  283.       throw new InvalidArgumentException(sprintf('Configuration key "%s" is invalid.', $key));
  284.     }
  286.     return $escaped ? str_replace("'", "\\'", $v) : $v;
  287.   }
  289.   /**
  290.    * Gets the fields that represents the filters.
  291.    *
  292.    * If no filter.display parameter is passed in the configuration,
  293.    * all the fields from the form are returned (dynamically).
  294.    *
  295.    * @param sfForm $form The form with the fields
  296.    */
  297.   public function getFormFilterFields(sfForm $form)
  298.   {
  299.     $config = $this->getConfig();
  301.     if ($this->getFilterDisplay())
  302.     {
  303.       $fields = array();
  304.       foreach ($this->getFilterDisplay() as $name)
  305.       {
  306.         list($name, $flag) = sfModelGeneratorConfigurationField::splitFieldWithFlag($name);
  307.         if (!isset($this->configuration['filter']['fields'][$name]))
  308.         {
  309.           $this->configuration['filter']['fields'][$name] = new sfModelGeneratorConfigurationField($name, array_merge(
  310.             isset($config['default'][$name]) ? $config['default'][$name] : array(),
  311.             isset($config['filter'][$name]) ? $config['filter'][$name] : array(),
  312.             array('is_real' => false, 'type' => 'Text', 'flag' => $flag)
  313.           ));
  314.         }
  315.         $field = $this->configuration['filter']['fields'][$name];
  316.         $field->setFlag($flag);
  317.         $fields[$name] = $field;
  318.       }
  320.       return $fields;
  321.     }
  323.     $fields = array();
  324.     foreach ($form->getWidgetSchema()->getPositions() as $name)
  325.     {
  326.       $fields[$name] = new sfModelGeneratorConfigurationField($name, array_merge(
  327.         array('type' => 'Text'),
  328.         isset($config['default'][$name]) ? $config['default'][$name] : array(),
  329.         isset($config['filter'][$name]) ? $config['filter'][$name] : array(),
  330.         array('is_real' => false)
  331.       ));
  332.     }
  334.     return $fields;
  335.   }
  337.   /**
  338.    * Gets the fields that represents the form.
  339.    *
  340.    * If no form.display parameter is passed in the configuration,
  341.    * all the fields from the form are returned (dynamically).
  342.    *
  343.    * @param sfForm $form    The form with the fields
  344.    * @param string $context The display context
  345.    */
  346.   public function getFormFields(sfForm $form, $context)
  347.   {
  348.     $config = $this->getConfig();
  350.     $method = sprintf('get%sDisplay', ucfirst($context));
  351.     if (!$fieldsets = $this->$method())
  352.     {
  353.       $fieldsets = $this->getFormDisplay();
  354.     }
  356.     if ($fieldsets)
  357.     {
  358.       $fields = array();
  360.       // with fieldsets?
  361.       if (!is_array(reset($fieldsets)))
  362.       {
  363.         $fieldsets = array('NONE' => $fieldsets);
  364.       }
  366.       foreach ($fieldsets as $fieldset => $names)
  367.       {
  368.         if (!$names)
  369.         {
  370.           continue;
  371.         }
  373.         $fields[$fieldset] = array();
  375.         foreach ($names as $name)
  376.         {
  377.           list($name, $flag) = sfModelGeneratorConfigurationField::splitFieldWithFlag($name);
  378.           if (!isset($this->configuration[$context]['fields'][$name]))
  379.           {
  380.             $this->configuration[$context]['fields'][$name] = new sfModelGeneratorConfigurationField($name, array_merge(
  381.               isset($config['default'][$name]) ? $config['default'][$name] : array(),
  382.               isset($config['form'][$name]) ? $config['form'][$name] : array(),
  383.               isset($config[$context][$name]) ? $config[$context][$name] : array(),
  384.               array('is_real' => false, 'type' => 'Text', 'flag' => $flag)
  385.             ));
  386.           }
  388.           $field = $this->configuration[$context]['fields'][$name];
  389.           $field->setFlag($flag);
  390.           $fields[$fieldset][$name] = $field;
  391.         }
  392.       }
  394.       return $fields;
  395.     }
  397.     $fields = array();
  398.     foreach ($form->getWidgetSchema()->getPositions() as $name)
  399.     {
  400.       $fields[$name] = new sfModelGeneratorConfigurationField($name, array_merge(
  401.         array('type' => 'Text'),
  402.         isset($config['default'][$name]) ? $config['default'][$name] : array(),
  403.         isset($config['form'][$name]) ? $config['form'][$name] : array(),
  404.         isset($config[$context][$name]) ? $config[$context][$name] : array(),
  405.         array('is_real' => false)
  406.       ));
  407.     }
  409.     return array('NONE' => $fields);
  410.   }
  412.   /**
  413.    * Gets the value for a given key.
  414.    *
  415.    * @param array  $config  The configuration
  416.    * @param string $key     The key name
  417.    * @param mixed  $default The default value
  418.    *
  419.    * @return mixed The key value
  420.    */
  421.   static public function getFieldConfigValue($config, $key, $default = null)
  422.   {
  423.     $ref   =& $config;
  424.     $parts =  explode('.', $key);
  425.     $count =  count($parts);
  426.     for ($i = 0; $i < $count; $i++)
  427.     {
  428.       $partKey = $parts[$i];
  429.       if (!isset($ref[$partKey]))
  430.       {
  431.         return $default;
  432.       }
  434.       if ($count == $i + 1)
  435.       {
  436.         return $ref[$partKey];
  437.       }
  438.       else
  439.       {
  440.         $ref =& $ref[$partKey];
  441.       }
  442.     }
  444.     return $default;
  445.   }
  447.   public function getCredentials($action)
  448.   {
  449.     if (0 === strpos($action, '_'))
  450.     {
  451.       $action = substr($action, 1);
  452.     }
  454.     return isset($this->configuration['credentials'][$action]) ? $this->configuration['credentials'][$action] : array();
  455.   }
  457.   public function getPager($model)
  458.   {
  459.     $class = $this->getPagerClass();
  461.     return new $class($model, $this->getPagerMaxPerPage());
  462.   }
  464.   /**
  465.    * Gets a new form object.
  466.    *
  467.    * @param  mixed $object
  468.    * @param  array $options An array of options to merge with the options returned by getFormOptions()
  469.    *
  470.    * @return sfForm
  471.    */
  472.   public function getForm($object = null, $options = array())
  473.   {
  474.     $class = $this->getFormClass();
  476.     return new $class($object, array_merge($this->getFormOptions(), $options));
  477.   }
  479.   public function getFormOptions()
  480.   {
  481.     return array();
  482.   }
  484.   public function getFilterForm($filters)
  485.   {
  486.     $class = $this->getFilterFormClass();
  488.     return new $class($filters, $this->getFilterFormOptions());
  489.   }
  491.   public function getFilterFormOptions()
  492.   {
  493.     return array();
  494.   }
  496.   public function getFilterDefaults()
  497.   {
  498.     return array();
  499.   }
  501.   protected function mapFieldName(sfModelGeneratorConfigurationField $field)
  502.   {
  503.     return $field->getName();
  504.   }
  506.   protected function fixActionParameters($action, $parameters)
  507.   {
  508.     if (null === $parameters)
  509.     {
  510.       $parameters = array();
  511.     }
  513.     if (!isset($parameters['params']))
  514.     {
  515.       $parameters['params'] = array();
  516.     }
  518.     if ('_delete' == $action && !isset($parameters['confirm']))
  519.     {
  520.       $parameters['confirm'] = 'Are you sure?';
  521.     }
  523.     $parameters['class_suffix'] = strtolower('_' == $action[0] ? substr($action, 1) : $action);
  525.     // merge with defaults
  526.     $defaults = $this->getActionsDefault();
  527.     if (isset($defaults[$action]))
  528.     {
  529.       $parameters = array_merge($defaults[$action], $parameters);
  530.     }
  532.     if (isset($parameters['label']))
  533.     {
  534.       $label = $parameters['label'];
  535.     }
  536.     else if ('_' != $action[0])
  537.     {
  538.       $label = $action;
  539.     }
  540.     else
  541.     {
  542.       $label = '_list' == $action ? 'Back to list' : substr($action, 1);
  543.     }
  545.     $parameters['label'] = sfInflector::humanize($label);
  547.     return $parameters;
  548.   }
  550.   protected function getConfig()
  551.   {
  552.     return array(
  553.       'default' => $this->getFieldsDefault(),
  554.       'list'    => $this->getFieldsList(),
  555.       'filter'  => $this->getFieldsFilter(),
  556.       'form'    => $this->getFieldsForm(),
  557.       'new'     => $this->getFieldsNew(),
  558.       'edit'    => $this->getFieldsEdit(),
  559.     );
  560.   }
  561. }
Debug toolbar