1. sfWidgetFormChoice.class.php
  2. /**
 * sfWidgetFormChoice represents a choice widget.
 *
 * @package    symfony
 * @subpackage widget
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfWidgetFormChoice.class.php 23994 2009-11-15 22:55:24Z bschussek $
 */
  3. class sfWidgetFormChoice extends sfWidgetFormChoiceBase
  4. {
  5.   /**
  6.    * Constructor.
  7.    *
  8.    * Available options:
  9.    *
  10.    *  * choices:          An array of possible choices (required)
  11.    *  * multiple:         true if the select tag must allow multiple selections
  12.    *  * expanded:         true to display an expanded widget
  13.    *                        if expanded is false, then the widget will be a select
  14.    *                        if expanded is true and multiple is false, then the widget will be a list of radio
  15.    *                        if expanded is true and multiple is true, then the widget will be a list of checkbox
  16.    *  * renderer_class:   The class to use instead of the default ones
  17.    *  * renderer_options: The options to pass to the renderer constructor
  18.    *  * renderer:         A renderer widget (overrides the expanded and renderer_options options)
  19.    *                      The choices option must be: new sfCallable($thisWidgetInstance, 'getChoices')
  20.    * @param array $options     An array of options
  21.    * @param array $attributes  An array of default HTML attributes
  22.    *
  23.    * @see sfWidgetFormChoiceBase
  24.    */
  25.   protected function configure($options = array(), $attributes = array())
  26.   {
  27.     parent::configure($options, $attributes);
  29.     $this->addOption('multiple', false);
  30.     $this->addOption('expanded', false);
  31.     $this->addOption('renderer_class', false);
  32.     $this->addOption('renderer_options', array());
  33.     $this->addOption('renderer', false);
  34.   }
  36.   /**
  37.    * Sets the format for HTML id attributes. This is made avaiable to the renderer,
  38.    * as this widget does not render itself, but delegates to the renderer instead.
  39.    *
  40.    * @param string $format  The format string (must contain a %s for the id placeholder)
  41.    *
  42.    * @see sfWidgetForm
  43.    */
  44.   public function setIdFormat($format)
  45.   {
  46.     $this->options['renderer_options']['id_format'] = $format;
  47.   }
  49.   /**
  50.    * @param  string $name        The element name
  51.    * @param  string $value       The value selected in this widget
  52.    * @param  array  $attributes  An array of HTML attributes to be merged with the default HTML attributes
  53.    * @param  array  $errors      An array of errors for the field
  54.    *
  55.    * @return string An HTML tag string
  56.    *
  57.    * @see sfWidgetForm
  58.    */
  59.   public function render($name, $value = null, $attributes = array(), $errors = array())
  60.   {
  61.     if ($this->getOption('multiple'))
  62.     {
  63.       $attributes['multiple'] = 'multiple';
  65.       if ('[]' != substr($name, -2))
  66.       {
  67.         $name .= '[]';
  68.       }
  69.     }
  71.     if (!$this->getOption('renderer') && !$this->getOption('renderer_class') && $this->getOption('expanded'))
  72.     {
  73.       unset($attributes['multiple']);
  74.     }
  76.     return $this->getRenderer()->render($name, $value, $attributes, $errors);
  77.   }
  79.   /**
  80.    * Gets the stylesheet paths associated with the widget.
  81.    *
  82.    * @return array An array of stylesheet paths
  83.    */
  84.   public function getStylesheets()
  85.   {
  86.     return $this->getRenderer()->getStylesheets();
  87.   }
  89.   /**
  90.    * Gets the JavaScript paths associated with the widget.
  91.    *
  92.    * @return array An array of JavaScript paths
  93.    */
  94.   public function getJavaScripts()
  95.   {
  96.     return $this->getRenderer()->getJavaScripts();
  97.   }
  99.   public function getRenderer()
  100.   {
  101.     if ($this->getOption('renderer'))
  102.     {
  103.       return $this->getOption('renderer');
  104.     }
  106.     if (!$class = $this->getOption('renderer_class'))
  107.     {
  108.       $type = !$this->getOption('expanded') ? '' : ($this->getOption('multiple') ? 'checkbox' : 'radio');
  109.       $class = sprintf('sfWidgetFormSelect%s', ucfirst($type));
  110.     }
  112.     return new $class(array_merge(array('choices' => new sfCallable(array($this, 'getChoices'))), $this->options['renderer_options']), $this->getAttributes());
  113.   }
  114. }
Debug toolbar