1. sfFormField.class.php
  2. /**
 * sfFormField represents a widget bind to a name and a value.
 *
 * @package    symfony
 * @subpackage form
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfFormField.class.php 22401 2009-09-25 03:49:27Z Kris.Wallsmith $
 */
  3. class sfFormField
  4. {
  5.   protected static
  6.     $toStringException = null;
  8.   protected
  9.     $widget = null,
  10.     $parent = null,
  11.     $name   = '',
  12.     $value  = null,
  13.     $error  = null;
  15.   /**
  16.    * Constructor.
  17.    *
  18.    * @param sfWidgetForm     $widget A sfWidget instance
  19.    * @param sfFormField      $parent The sfFormField parent instance (null for the root widget)
  20.    * @param string           $name   The field name
  21.    * @param string           $value  The field value
  22.    * @param sfValidatorError $error  A sfValidatorError instance
  23.    */
  24.   public function __construct(sfWidgetForm $widget, sfFormField $parent = null, $name, $value, sfValidatorError $error = null)
  25.   {
  26.     $this->widget = $widget;
  27.     $this->parent = $parent;
  28.     $this->name   = $name;
  29.     $this->value  = $value;
  30.     $this->error  = $error;
  31.   }
  33.   /**
  34.    * Returns the string representation of this form field.
  35.    *
  36.    * @return string The rendered field
  37.    */
  38.   public function __toString()
  39.   {
  40.     try
  41.     {
  42.       return $this->render();
  43.     }
  44.     catch (Exception $e)
  45.     {
  46.       self::setToStringException($e);
  48.       // we return a simple Exception message in case the form framework is used out of symfony.
  49.       return 'Exception: '.$e->getMessage();
  50.     }
  51.   }
  53.   /**
  54.    * Returns true if a form thrown an exception in the __toString() method
  55.    *
  56.    * This is a hack needed because PHP does not allow to throw exceptions in __toString() magic method.
  57.    *
  58.    * @return boolean
  59.    */
  60.   static public function hasToStringException()
  61.   {
  62.     return null !== self::$toStringException;
  63.   }
  65.   /**
  66.    * Gets the exception if one was thrown in the __toString() method.
  67.    *
  68.    * This is a hack needed because PHP does not allow to throw exceptions in __toString() magic method.
  69.    *
  70.    * @return Exception
  71.    */
  72.   static public function getToStringException()
  73.   {
  74.     return self::$toStringException;
  75.   }
  77.   /**
  78.    * Sets an exception thrown by the __toString() method.
  79.    *
  80.    * This is a hack needed because PHP does not allow to throw exceptions in __toString() magic method.
  81.    *
  82.    * @param Exception $e The exception thrown by __toString()
  83.    */
  84.   static public function setToStringException(Exception $e)
  85.   {
  86.     if (null === self::$toStringException)
  87.     {
  88.       self::$toStringException = $e;
  89.     }
  90.   }
  92.   /**
  93.    * Renders the form field.
  94.    *
  95.    * @param array $attributes An array of HTML attributes
  96.    *
  97.    * @return string The rendered widget
  98.    */
  99.   function render($attributes = array())
  100.   {
  101.     if ($this->parent)
  102.     {
  103.       return $this->parent->getWidget()->renderField($this->name, $this->value, $attributes, $this->error);
  104.     }
  105.     else
  106.     {
  107.       return $this->widget->render($this->name, $this->value, $attributes, $this->error);
  108.     }
  109.   }
  111.   /**
  112.    * Returns a formatted row.
  113.    *
  114.    * The formatted row will use the parent widget schema formatter.
  115.    * The formatted row contains the label, the field, the error and
  116.    * the help message.
  117.    *
  118.    * @param array  $attributes An array of HTML attributes to merge with the current attributes
  119.    * @param string $label      The label name (not null to override the current value)
  120.    * @param string $help       The help text (not null to override the current value)
  121.    *
  122.    * @return string The formatted row
  123.    */
  124.   public function renderRow($attributes = array(), $label = null, $help = null)
  125.   {
  126.     if (null === $this->parent)
  127.     {
  128.       throw new LogicException(sprintf('Unable to render the row for "%s".', $this->name));
  129.     }
  131.     $field = $this->parent->getWidget()->renderField($this->name, $this->value, !is_array($attributes) ? array() : $attributes, $this->error);
  133.     $error = $this->error instanceof sfValidatorErrorSchema ? $this->error->getGlobalErrors() : $this->error;
  135.     $help = null === $help ? $this->parent->getWidget()->getHelp($this->name) : $help;
  137.     return strtr($this->parent->getWidget()->getFormFormatter()->formatRow($this->renderLabel($label), $field, $error, $help), array('%hidden_fields%' => ''));
  138.   }
  140.   /**
  141.    * Returns a formatted error list.
  142.    *
  143.    * The formatted list will use the parent widget schema formatter.
  144.    *
  145.    * @return string The formatted error list
  146.    */
  147.   public function renderError()
  148.   {
  149.     if (null === $this->parent)
  150.     {
  151.       throw new LogicException(sprintf('Unable to render the error for "%s".', $this->name));
  152.     }
  154.     $error = $this->getWidget() instanceof sfWidgetFormSchema ? $this->getWidget()->getGlobalErrors($this->error) : $this->error;
  156.     return $this->parent->getWidget()->getFormFormatter()->formatErrorsForRow($error);
  157.   }
  159.   /**
  160.    * Returns the help text.
  161.    *
  162.    * @return string The help text
  163.    */
  164.   public function renderHelp()
  165.   {
  166.     if (null === $this->parent)
  167.     {
  168.       throw new LogicException(sprintf('Unable to render the help for "%s".', $this->name));
  169.     }
  171.     return $this->parent->getWidget()->getFormFormatter()->formatHelp($this->parent->getWidget()->getHelp($this->name));
  172.   }
  174.   /**
  175.    * Returns the label tag.
  176.    *
  177.    * @param string $label      The label name (not null to override the current value)
  178.    * @param array  $attributes Optional html attributes
  179.    *
  180.    * @return string The label tag
  181.    */
  182.   public function renderLabel($label = null, $attributes = array())
  183.   {
  184.     if (null === $this->parent)
  185.     {
  186.       throw new LogicException(sprintf('Unable to render the label for "%s".', $this->name));
  187.     }
  189.     if (null !== $label)
  190.     {
  191.       $currentLabel = $this->parent->getWidget()->getLabel($this->name);
  192.       $this->parent->getWidget()->setLabel($this->name, $label);
  193.     }
  195.     $html = $this->parent->getWidget()->getFormFormatter()->generateLabel($this->name, $attributes);
  197.     if (null !== $label)
  198.     {
  199.       $this->parent->getWidget()->setLabel($this->name, $currentLabel);
  200.     }
  202.     return $html;
  203.   }
  205.   /**
  206.    * Returns the label name given a widget name.
  207.    *
  208.    * @return string The label name
  209.    */
  210.   public function renderLabelName()
  211.   {
  212.     if (null === $this->parent)
  213.     {
  214.       throw new LogicException(sprintf('Unable to render the label name for "%s".', $this->name));
  215.     }
  217.     return $this->parent->getWidget()->getFormFormatter()->generateLabelName($this->name);
  218.   }
  220.   /**
  221.    * Returns the name attribute of the widget.
  222.    * 
  223.    * @return string The name attribute of the widget
  224.    */
  225.   public function renderName()
  226.   {
  227.     return $this->parent ? $this->parent->getWidget()->generateName($this->name) : $this->name;
  228.   }
  230.   /**
  231.    * Returns the id attribute of the widget.
  232.    *
  233.    * @return string The id attribute of the widget
  234.    */
  235.   public function renderId()
  236.   {
  237.     return $this->widget->generateId($this->parent ? $this->parent->getWidget()->generateName($this->name) : $this->name, $this->value);
  238.   }
  240.   /**
  241.    * Returns true if the widget is hidden.
  242.    *
  243.    * @return Boolean true if the widget is hidden, false otherwise
  244.    */
  245.   public function isHidden()
  246.   {
  247.     return $this->widget->isHidden();
  248.   }
  250.   /**
  251.    * Returns the widget name.
  252.    *
  253.    * @return mixed The widget name
  254.    */
  255.   public function getName()
  256.   {
  257.     return $this->name;
  258.   }
  260.   /**
  261.    * Returns the widget value.
  262.    *
  263.    * @return mixed The widget value
  264.    */
  265.   public function getValue()
  266.   {
  267.     return $this->value;
  268.   }
  270.   /**
  271.    * Returns the wrapped widget.
  272.    *
  273.    * @return sfWidget A sfWidget instance
  274.    */
  275.   public function getWidget()
  276.   {
  277.     return $this->widget;
  278.   }
  280.   /**
  281.    * Returns the parent form field.
  282.    *
  283.    * @return sfFormField A sfFormField instance
  284.    */
  285.   public function getParent()
  286.   {
  287.     return $this->parent;
  288.   }
  290.   /**
  291.    * Returns the error for this field.
  292.    *
  293.    * @return sfValidatorError A sfValidatorError instance
  294.    */
  295.   public function getError()
  296.   {
  297.     return $this->error;
  298.   }
  300.   /**
  301.    * Returns true is the field has an error.
  302.    *
  303.    * @return Boolean true if the field has some errors, false otherwise
  304.    */
  305.   public function hasError()
  306.   {
  307.     return null !== $this->error && count($this->error);
  308.   }
  309. }
Debug toolbar