1. sfWidgetFormSelectCheckbox.class.php
  2. /**
 * sfWidgetFormSelectCheckbox represents an array of checkboxes.
 *
 * @package    symfony
 * @subpackage widget
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfWidgetFormSelectCheckbox.class.php 23994 2009-11-15 22:55:24Z bschussek $
 */
  3. class sfWidgetFormSelectCheckbox extends sfWidgetFormChoiceBase
  4. {
  5.   /**
  6.    * Constructor.
  7.    *
  8.    * Available options:
  9.    *
  10.    *  * choices:         An array of possible choices (required)
  11.    *  * label_separator: The separator to use between the input checkbox and the label
  12.    *  * class:           The class to use for the main <ul> tag
  13.    *  * separator:       The separator to use between each input checkbox
  14.    *  * formatter:       A callable to call to format the checkbox choices
  15.    *                     The formatter callable receives the widget and the array of inputs as arguments
  16.    *  * template:        The template to use when grouping option in groups (%group% %options%)
  17.    *
  18.    * @param array $options     An array of options
  19.    * @param array $attributes  An array of default HTML attributes
  20.    *
  21.    * @see sfWidgetFormChoiceBase
  22.    */
  23.   protected function configure($options = array(), $attributes = array())
  24.   {
  25.     parent::configure($options, $attributes);
  27.     $this->addOption('class', 'checkbox_list');
  28.     $this->addOption('label_separator', '&nbsp;');
  29.     $this->addOption('separator', "\n");
  30.     $this->addOption('formatter', array($this, 'formatter'));
  31.     $this->addOption('template', '%group% %options%');
  32.   }
  34.   /**
  35.    * @param  string $name        The element name
  36.    * @param  string $value       The value selected in this widget
  37.    * @param  array  $attributes  An array of HTML attributes to be merged with the default HTML attributes
  38.    * @param  array  $errors      An array of errors for the field
  39.    *
  40.    * @return string An HTML tag string
  41.    *
  42.    * @see sfWidgetForm
  43.    */
  44.   public function render($name, $value = null, $attributes = array(), $errors = array())
  45.   {
  46.     if ('[]' != substr($name, -2))
  47.     {
  48.       $name .= '[]';
  49.     }
  51.     if (null === $value)
  52.     {
  53.       $value = array();
  54.     }
  56.     $choices = $this->getChoices();
  58.     // with groups?
  59.     if (count($choices) && is_array(current($choices)))
  60.     {
  61.       $parts = array();
  62.       foreach ($choices as $key => $option)
  63.       {
  64.         $parts[] = strtr($this->getOption('template'), array('%group%' => $key, '%options%' => $this->formatChoices($name, $value, $option, $attributes)));
  65.       }
  67.       return implode("\n", $parts);
  68.     }
  69.     else
  70.     {
  71.       return $this->formatChoices($name, $value, $choices, $attributes);
  72.     }
  73.   }
  75.   protected function formatChoices($name, $value, $choices, $attributes)
  76.   {
  77.     $inputs = array();
  78.     foreach ($choices as $key => $option)
  79.     {
  80.       $baseAttributes = array(
  81.         'name'  => $name,
  82.         'type'  => 'checkbox',
  83.         'value' => self::escapeOnce($key),
  84.         'id'    => $id = $this->generateId($name, self::escapeOnce($key)),
  85.       );
  87.       if ((is_array($value) && in_array(strval($key), $value)) || strval($key) == strval($value))
  88.       {
  89.         $baseAttributes['checked'] = 'checked';
  90.       }
  92.       $inputs[$id] = array(
  93.         'input' => $this->renderTag('input', array_merge($baseAttributes, $attributes)),
  94.         'label' => $this->renderContentTag('label', $option, array('for' => $id)),
  95.       );
  96.     }
  98.     return call_user_func($this->getOption('formatter'), $this, $inputs);
  99.   }
  101.   public function formatter($widget, $inputs)
  102.   {
  103.     $rows = array();
  104.     foreach ($inputs as $input)
  105.     {
  106.       $rows[] = $this->renderContentTag('li', $input['input'].$this->getOption('label_separator').$input['label']);
  107.     }
  109.     return !$rows ? '' : $this->renderContentTag('ul', implode($this->getOption('separator'), $rows), array('class' => $this->getOption('class')));
  110.   }
  111. }
Debug toolbar