1. sfWidgetForm.class.php
  2. /**
 * sfWidgetForm is the base class for all form widgets.
 *
 * @package    symfony
 * @subpackage widget
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfWidgetForm.class.php 24137 2009-11-18 13:12:40Z fabien $
 */
  3. abstract class sfWidgetForm extends sfWidget
  4. {
  5.   protected
  6.     $parent   = null;
  8.   /**
  9.    * Constructor.
  10.    *
  11.    * Available options:
  12.    *
  13.    *  * id_format:       The format for the generated HTML id attributes (%s by default)
  14.    *  * is_hidden:       true if the form widget must be hidden, false otherwise (false by default)
  15.    *  * needs_multipart: true if the form widget needs a multipart form, false otherwise (false by default)
  16.    *  * default:         The default value to use when rendering the widget
  17.    *  * label:           The label to use when the widget is rendered by a widget schema
  18.    *
  19.    * @param array $options     An array of options
  20.    * @param array $attributes  An array of default HTML attributes
  21.    *
  22.    * @see sfWidget
  23.    */
  24.   public function __construct($options = array(), $attributes = array())
  25.   {
  26.     $this->addOption('id_format', '%s');
  27.     $this->addOption('is_hidden', false);
  28.     $this->addOption('needs_multipart', false);
  29.     $this->addOption('default', null);
  30.     $this->addOption('label', null);
  32.     parent::__construct($options, $attributes);
  33.   }
  35.   /**
  36.    * Sets the default value for the widget.
  37.    *
  38.    * @param string $value The default value
  39.    *
  40.    * @return sfWidget The current widget instance
  41.    */
  42.   public function setDefault($value)
  43.   {
  44.     $this->setOption('default', $value);
  46.     return $this;
  47.   }
  49.   /**
  50.    * Returns the default value for the widget.
  51.    *
  52.    * @return string The default value
  53.    */
  54.   public function getDefault()
  55.   {
  56.     return $this->getOption('default');
  57.   }
  59.   /**
  60.    * Sets the label for the widget.
  61.    *
  62.    * @param string $value The label
  63.    *
  64.    * @return sfWidget The current widget instance
  65.    */
  66.   public function setLabel($value)
  67.   {
  68.     $this->setOption('label', $value);
  70.     return $this;
  71.   }
  73.   /**
  74.    * Returns the label for the widget.
  75.    *
  76.    * @return string The label
  77.    */
  78.   public function getLabel()
  79.   {
  80.     return $this->getOption('label');
  81.   }
  83.   /**
  84.    * Sets the format for HTML id attributes.
  85.    *
  86.    * @param string $format  The format string (must contain a %s for the id placeholder)
  87.    *
  88.    * @return sfWidget The current widget instance
  89.    */
  90.   public function setIdFormat($format)
  91.   {
  92.     $this->setOption('id_format', $format);
  94.     return $this;
  95.   }
  97.   /**
  98.    * Gets the HTML format string for id attributes.
  99.    *
  100.    * @return string The format string
  101.    */
  102.   public function getIdFormat()
  103.   {
  104.     return $this->getOption('id_format');
  105.   }
  107.   /**
  108.    * Returns true if the widget is hidden.
  109.    *
  110.    * @return Boolean true if the widget is hidden, false otherwise
  111.    */
  112.   public function isHidden()
  113.   {
  114.     return $this->getOption('is_hidden');
  115.   }
  117.   /**
  118.    * Sets the hidden flag for the widget.
  119.    *
  120.    * @param bool $boolean  true if the widget must be hidden, false otherwise
  121.    *
  122.    * @return sfWidget The current widget instance
  123.    */
  124.   public function setHidden($boolean)
  125.   {
  126.     $this->setOption('is_hidden', (boolean) $boolean);
  128.     return $this;
  129.   }
  131.   /**
  132.    * Returns true if the widget needs a multipart form.
  133.    *
  134.    * @return bool true if the widget needs a multipart form, false otherwise
  135.    */
  136.   public function needsMultipartForm()
  137.   {
  138.     return $this->getOption('needs_multipart');
  139.   }
  141.   /**
  142.    * Renders a HTML tag.
  143.    *
  144.    * The id attribute is added automatically to the array of attributes if none is specified.
  145.    * If uses for "id_format" option to generate the id.
  146.    *
  147.    * @param  string $tag        The tag name
  148.    * @param  array  $attributes An array of HTML attributes to be merged with the default HTML attributes
  149.    *
  150.    * @return string An HTML tag string
  151.    */
  152.   public function renderTag($tag, $attributes = array())
  153.   {
  154.     if (empty($tag))
  155.     {
  156.       return '';
  157.     }
  159.     $attributes = $this->fixFormId($attributes);
  161.     return parent::renderTag($tag, $attributes);
  162.   }
  164.   /**
  165.    * Renders a HTML content tag.
  166.    *
  167.    * The id attribute is added automatically to the array of attributes if none is specified.
  168.    * If uses for "id_format" option to generate the id.
  169.    *
  170.    * @param  string $tag         The tag name
  171.    * @param  string $content     The content of the tag
  172.    * @param  array  $attributes  An array of HTML attributes to be merged with the default HTML attributes
  173.    *
  174.    * @return string An HTML tag string
  175.    */
  176.   public function renderContentTag($tag, $content = null, $attributes = array())
  177.   {
  178.     return parent::renderContentTag($tag, $content, $this->fixFormId($attributes));
  179.   }
  181.   /**
  182.    * Adds an HTML id attributes to the array of attributes if none is given and a name attribute exists.
  183.    *
  184.    * @param  array $attributes  An array of attributes
  185.    *
  186.    * @return array An array of attributes with an id.
  187.    */
  188.   protected function fixFormId($attributes)
  189.   {
  190.     if (!isset($attributes['id']) && isset($attributes['name']))
  191.     {
  192.       $attributes['id'] = $this->generateId($attributes['name'], isset($attributes['value']) ? $attributes['value'] : null);
  193.     }
  195.     return $attributes;
  196.   }
  198.   /**
  199.    * Returns a formatted id based on the field name and optionally on the field value.
  200.    *
  201.    * This method determines the proper form field id name based on the parameters. If a form field has an
  202.    * array value as a name we need to convert them to proper and unique ids like so:
  203.    *
  204.    * <samp>
  205.    *  name[] => name (if value == null)
  206.    *  name[] => name_value (if value != null)
  207.    *  name[bob] => name_bob
  208.    *  name[item][total] => name_item_total
  209.    * </samp>
  210.    *
  211.    * This method also changes all invalid characters to an underscore (_):
  212.    *
  213.    * Ids must begin with a letter ([A-Za-z]) and may be followed by any number of letters, digits
  214.    * ([0-9]), hyphens ("-"), underscores ("_"), colons (":"), and periods (".").
  215.    *
  216.    * @param  string $name   The field name
  217.    * @param  string $value  The field value
  218.    *
  219.    * @return string The field id or null.
  220.    */
  221.   public function generateId($name, $value = null)
  222.   {
  223.     if (false === $this->getOption('id_format'))
  224.     {
  225.       return null;
  226.     }
  228.     // check to see if we have an array variable for a field name
  229.     if (strstr($name, '['))
  230.     {
  231.       $name = str_replace(array('[]', '][', '[', ']'), array((null !== $value ? '_'.$value : ''), '_', '_', ''), $name);
  232.     }
  234.     if (false !== strpos($this->getOption('id_format'), '%s'))
  235.     {
  236.       $name = sprintf($this->getOption('id_format'), $name);
  237.     }
  239.     // remove illegal characters
  240.     $name = preg_replace(array('/^[^A-Za-z]+/', '/[^A-Za-z0-9\:_\.\-]/'), array('', '_'), $name);
  242.     return $name;
  243.   }
  245.   /**
  246.    * Generates a two chars range
  247.    *
  248.    * @param  int  $start
  249.    * @param  int  $stop
  250.    * @return array
  251.    */
  252.   static protected function generateTwoCharsRange($start, $stop)
  253.   {
  254.     $results = array();
  255.     for ($i = $start; $i <= $stop; $i++)
  256.     {
  257.       $results[$i] = sprintf('%02d', $i);
  258.     }
  259.     return $results;
  260.   }
  262.   /**
  263.    * Sets the parent widget schema.
  264.    *
  265.    * @param  sfWidgetFormSchema|null $widgetSchema
  266.    *
  267.    * @return sfWidgetForm The current widget instance
  268.    */
  269.   public function setParent(sfWidgetFormSchema $widgetSchema = null)
  270.   {
  271.     $this->parent = $widgetSchema;
  273.     return $this;
  274.   }
  276.   /**
  277.    * Returns the parent widget schema.
  278.    *
  279.    * If no schema has been set with setWidgetSchema(), NULL is returned.
  280.    *
  281.    * @return sfWidgetFormSchema|null
  282.    */
  283.   public function getParent()
  284.   {
  285.     return $this->parent;
  286.   }
  288.   /**
  289.    * Translates the given text.
  290.    *
  291.    * @param  string $text       The text with optional placeholders
  292.    * @param  array $parameters  The values to replace the placeholders
  293.    *
  294.    * @return string             The translated text
  295.    *
  296.    * @see sfWidgetFormSchemaFormatter::translate()
  297.    */
  298.   protected function translate($text, array $parameters = array())
  299.   {
  300.     if (null === $this->parent)
  301.     {
  302.       return $text;
  303.     }
  304.     else
  305.     {
  306.       return $this->parent->getFormFormatter()->translate($text, $parameters);
  307.     }
  308.   }
  310.   /**
  311.    * Translates all values of the given array.
  312.    *
  313.    * @param  array $texts       The texts with optional placeholders
  314.    * @param  array $parameters  The values to replace the placeholders
  315.    *
  316.    * @return array              The translated texts
  317.    * 
  318.    * @see sfWidgetFormSchemaFormatter::translate()
  319.    */
  320.   protected function translateAll(array $texts, array $parameters = array())
  321.   {
  322.     if (null === $this->parent)
  323.     {
  324.       return $texts;
  325.     }
  326.     else
  327.     {
  328.       $result = array();
  330.       foreach ($texts as $key => $text)
  331.       {
  332.         $result[$key] = $this->parent->getFormFormatter()->translate($text, $parameters);
  333.       }
  335.       return $result;
  336.     }
  337.   }
  338. }
Debug toolbar