1. sfWidgetFormSchemaFormatter.class.php
  2. /**
 * sfWidgetFormSchemaFormatter allows to format a form schema with HTML formats.
 *
 * @package    symfony
 * @subpackage widget
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfWidgetFormSchemaFormatter.class.php 21908 2009-09-11 12:06:21Z fabien $
 */
  3. abstract class sfWidgetFormSchemaFormatter
  4. {
  5.   protected static
  6.     $translationCallable       = null;
  8.   protected
  9.     $rowFormat                 = '',
  10.     $helpFormat                = '%help%',
  11.     $errorRowFormat            = '%errors%',
  12.     $errorListFormatInARow     = "  <ul class=\"error_list\">\n%errors%  </ul>\n",
  13.     $errorRowFormatInARow      = "    <li>%error%</li>\n",
  14.     $namedErrorRowFormatInARow = "    <li>%name%: %error%</li>\n",
  15.     $decoratorFormat           = '',
  16.     $widgetSchema              = null,
  17.     $translationCatalogue      = null;
  19.   /**
  20.    * Constructor
  21.    *
  22.    * @param sfWidgetFormSchema $widgetSchema
  23.    */
  24.   public function __construct(sfWidgetFormSchema $widgetSchema)
  25.   {
  26.     $this->setWidgetSchema($widgetSchema);
  27.   }
  29.   public function formatRow($label, $field, $errors = array(), $help = '', $hiddenFields = null)
  30.   {
  31.     return strtr($this->getRowFormat(), array(
  32.       '%label%'         => $label,
  33.       '%field%'         => $field,
  34.       '%error%'         => $this->formatErrorsForRow($errors),
  35.       '%help%'          => $this->formatHelp($help),
  36.       '%hidden_fields%' => null === $hiddenFields ? '%hidden_fields%' : $hiddenFields,
  37.     ));
  38.   }
  40.   /**
  41.    * Translates a string using an i18n callable, if it has been provided
  42.    *
  43.    * @param  mixed  $subject     The subject to translate
  44.    * @param  array  $parameters  Additional parameters to pass back to the callable
  45.    * @return string
  46.    */
  47.   public function translate($subject, $parameters = array())
  48.   {
  49.     if (false === $subject)
  50.     {
  51.       return false;
  52.     }
  54.     if (null === self::$translationCallable)
  55.     {
  56.       // replace object with strings
  57.       foreach ($parameters as $key => $value)
  58.       {
  59.         if (is_object($value) && method_exists($value, '__toString'))
  60.         {
  61.           $parameters[$key] = $value->__toString();
  62.         }
  63.       }
  65.       return strtr($subject, $parameters);
  66.     }
  68.     $catalogue = $this->getTranslationCatalogue();
  70.     if (self::$translationCallable instanceof sfCallable)
  71.     {
  72.       return self::$translationCallable->call($subject, $parameters, $catalogue);
  73.     }
  75.     return call_user_func(self::$translationCallable, $subject, $parameters, $catalogue);
  76.   }
  78.   /**
  79.    * Returns the current i18n callable
  80.    *
  81.    * @return mixed
  82.    */
  83.   static public function getTranslationCallable()
  84.   {
  85.     return self::$translationCallable;
  86.   }
  88.   /**
  89.    * Sets a callable which aims to translate form labels, errors and help messages
  90.    *
  91.    * @param  mixed  $callable
  92.    *
  93.    * @throws InvalidArgumentException if an invalid php callable or sfCallable has been provided
  94.    */
  95.   static public function setTranslationCallable($callable)
  96.   {
  97.     if (!$callable instanceof sfCallable && !is_callable($callable))
  98.     {
  99.       throw new InvalidArgumentException('Provided i18n callable should be either an instance of sfCallable or a valid PHP callable');
  100.     }
  102.     self::$translationCallable = $callable;
  103.   }
  105.   public function formatHelp($help)
  106.   {
  107.     if (!$help)
  108.     {
  109.       return '';
  110.     }
  112.     return strtr($this->getHelpFormat(), array('%help%' => $this->translate($help)));
  113.   }
  115.   public function formatErrorRow($errors)
  116.   {
  117.     if (null === $errors || !$errors)
  118.     {
  119.       return '';
  120.     }
  122.     return strtr($this->getErrorRowFormat(), array('%errors%' => $this->formatErrorsForRow($errors)));
  123.   }
  125.   public function formatErrorsForRow($errors)
  126.   {
  127.     if (null === $errors || !$errors)
  128.     {
  129.       return '';
  130.     }
  132.     if (!is_array($errors))
  133.     {
  134.       $errors = array($errors);
  135.     }
  137.     return strtr($this->getErrorListFormatInARow(), array('%errors%' => implode('', $this->unnestErrors($errors))));
  138.   }
  140.   /**
  141.    * Generates a label for the given field name.
  142.    *
  143.    * @param  string $name        The field name
  144.    * @param  array  $attributes  Optional html attributes for the label tag
  145.    *
  146.    * @return string The label tag
  147.    */
  148.   public function generateLabel($name, $attributes = array())
  149.   {
  150.     $labelName = $this->generateLabelName($name);
  152.     if (false === $labelName)
  153.     {
  154.       return '';
  155.     }
  157.     if (!isset($attributes['for']))
  158.     {
  159.       $attributes['for'] = $this->widgetSchema->generateId($this->widgetSchema->generateName($name));
  160.     }
  162.     return $this->widgetSchema->renderContentTag('label', $labelName, $attributes);
  163.   }
  165.   /**
  166.    * Generates the label name for the given field name.
  167.    *
  168.    * @param  string $name  The field name
  169.    *
  170.    * @return string The label name
  171.    */
  172.   public function generateLabelName($name)
  173.   {
  174.     $label = $this->widgetSchema->getLabel($name);
  176.     if (!$label && false !== $label)
  177.     {
  178.       $label = str_replace('_', ' ', ucfirst('_id' == substr($name, -3) ? substr($name, 0, -3) : $name));
  179.     }
  181.     return $this->translate($label);
  182.   }
  184.   /**
  185.    * Get i18n catalogue name
  186.    *
  187.    * @return string
  188.    */
  189.   public function getTranslationCatalogue()
  190.   {
  191.     return $this->translationCatalogue;
  192.   }
  194.   /**
  195.    * Set an i18n catalogue name
  196.    *
  197.    * @param  string  $catalogue
  198.    *
  199.    * @throws InvalidArgumentException when the catalogue is not a string
  200.    */
  201.   public function setTranslationCatalogue($catalogue)
  202.   {
  203.     if (!is_string($catalogue))
  204.     {
  205.       throw new InvalidArgumentException('Catalogue name must be a string');
  206.     }
  208.     $this->translationCatalogue = $catalogue;
  209.   }
  211.   protected function unnestErrors($errors, $prefix = '')
  212.   {
  213.     $newErrors = array();
  215.     foreach ($errors as $name => $error)
  216.     {
  217.       if ($error instanceof ArrayAccess || is_array($error))
  218.       {
  219.         $newErrors = array_merge($newErrors, $this->unnestErrors($error, ($prefix ? $prefix.' > ' : '').$name));
  220.       }
  221.       else
  222.       {
  223.         if ($error instanceof sfValidatorError)
  224.         {
  225.           $err = $this->translate($error->getMessageFormat(), $error->getArguments());
  226.         }
  227.         else
  228.         {
  229.           $err = $this->translate($error);
  230.         }
  232.         if (!is_integer($name))
  233.         {
  234.           $newErrors[] = strtr($this->getNamedErrorRowFormatInARow(), array('%error%' => $err, '%name%' => ($prefix ? $prefix.' > ' : '').$name));
  235.         }
  236.         else
  237.         {
  238.           $newErrors[] = strtr($this->getErrorRowFormatInARow(), array('%error%' => $err));
  239.         }
  240.       }
  241.     }
  243.     return $newErrors;
  244.   }
  246.   public function setRowFormat($format)
  247.   {
  248.     $this->rowFormat = $format;
  249.   }
  251.   public function getRowFormat()
  252.   {
  253.     return $this->rowFormat;
  254.   }
  256.   public function setErrorRowFormat($format)
  257.   {
  258.     $this->errorRowFormat = $format;
  259.   }
  261.   public function getErrorRowFormat()
  262.   {
  263.     return $this->errorRowFormat;
  264.   }
  266.   public function setErrorListFormatInARow($format)
  267.   {
  268.     $this->errorListFormatInARow = $format;
  269.   }
  271.   public function getErrorListFormatInARow()
  272.   {
  273.     return $this->errorListFormatInARow;
  274.   }
  276.   public function setErrorRowFormatInARow($format)
  277.   {
  278.     $this->errorRowFormatInARow = $format;
  279.   }
  281.   public function getErrorRowFormatInARow()
  282.   {
  283.     return $this->errorRowFormatInARow;
  284.   }
  286.   public function setNamedErrorRowFormatInARow($format)
  287.   {
  288.     $this->namedErrorRowFormatInARow = $format;
  289.   }
  291.   public function getNamedErrorRowFormatInARow()
  292.   {
  293.     return $this->namedErrorRowFormatInARow;
  294.   }
  296.   public function setDecoratorFormat($format)
  297.   {
  298.     $this->decoratorFormat = $format;
  299.   }
  301.   public function getDecoratorFormat()
  302.   {
  303.     return $this->decoratorFormat;
  304.   }
  306.   public function setHelpFormat($format)
  307.   {
  308.     $this->helpFormat = $format;
  309.   }
  311.   public function getHelpFormat()
  312.   {
  313.     return $this->helpFormat;
  314.   }
  316.   /**
  317.    * Sets the widget schema associated with this formatter instance.
  318.    *
  319.    * @param sfWidgetFormSchema $widgetSchema A sfWidgetFormSchema instance
  320.    */
  321.   public function setWidgetSchema(sfWidgetFormSchema $widgetSchema)
  322.   {
  323.     $this->widgetSchema = $widgetSchema;
  324.   }
  326.   public function getWidgetSchema()
  327.   {
  328.     return $this->widgetSchema;
  329.   }
  330. }
Debug toolbar