symfony & mark fields as required

By default required fields in symfony form framework are not marked with '*'

How could we do this ?
- you could manually create form with fields (a lot of code, a lot of efforts)
- create own form formatter and using it with form class. It will automatically mark fields as we need ! (that's nice news :)

so - let's go !
1. Create own formatter (sfWidgetFormSchemaFormatter%)

1. <!--php<br /-->class sfWidgetFormSchemaFormatterStore extends sfWidgetFormSchemaFormatter  
2. {  
3.  protected  
4.  $rowFormat       = "\n  %label%\n  <span class="errorFormItem">%error%</span>%field%%help%%hidden_fields%\n\n",  
5.  $errorRowFormat  = "\n%errors%\n",  
6.  $helpFormat = '  
7. <span class="helpFormItem">%help%</span>',  
8.  $decoratorFormat = "\n  %content%<table></table>",  
9.  $requiredTemplate= ' <pow class="requiredFormItem">*</pow>',  
10.  $validatorSchema = null;  
11.   
12.  /** 
13.   * Generates the label name for the given field name. 
14.   * 
15.   * @param  string $name  The field name 
16.   * @return string The label name 
17.   */  
18.  public function generateLabelName($name)  
19.  {  
20.   $label = parent::generateLabelName($name);  
21.   
22.   $fields = $this->validatorSchema->getFields();  
23.   if($fields[$name] != null) {  
24.    $field = $fields[$name];  
25.    if($field->hasOption('required') && $field->getOption('required')) {  
26.     $label .= $this->requiredTemplate;  
27.    }  
28.   }  
29.   return $label;  
30.  }  
31.   
32.  public function setValidatorSchema(sfValidatorSchema $validatorSchema)  
33.  {  
34.   $this->validatorSchema = $validatorSchema;  
35.  }  
36. }  

class sfWidgetFormSchemaFormatterStore extends sfWidgetFormSchemaFormatter
{
 protected
 $rowFormat       = "\n  %label%\n  %error%%field%%help%%hidden_fields%\n\n",
 $errorRowFormat  = "\n%errors%\n",
 $helpFormat = '
%help%',
 $decoratorFormat = "\n  %content%",
 $requiredTemplate= ' *',
 $validatorSchema = null;

 /**
  * Generates the label name for the given field name.
  *
  * @param  string $name  The field name
  * @return string The label name
  */
 public function generateLabelName($name)
 {
  $label = parent::generateLabelName($name);

  $fields = $this->validatorSchema->getFields();
  if($fields[$name] != null) {
   $field = $fields[$name];
   if($field->hasOption('required') && $field->getOption('required')) {
    $label .= $this->requiredTemplate;
   }
  }
  return $label;
 }

 public function setValidatorSchema(sfValidatorSchema $validatorSchema)
 {
  $this->validatorSchema = $validatorSchema;
 }
}

we have some useful changes:
- add css classes
- add $requiredTemplate with required field template
- add injection of validatorSchema

2. Owerride __toString method (form class) - for using own formatter

1. <!--php<br /-->class StoreRegistrationForm extends BaseStoreDetailsForm  
2. {  
3.  public function configure()  
4.  {  
5.            // ...  
6.  }  
7.   
8.  public function render($attributes = array())  
9.  {  
10.   $formatterObj = $this->widgetSchema->getFormFormatter();  
11.   if(!is_null($formatterObj)) {   $formatterObj->setValidatorSchema($this->getValidatorSchema());   $this->widgetSchema->getFormFormatter()->setTranslationCatalogue("register_store_form");  
12.   }  
13.   return parent::render($attributes);  
14.  }  
15.   
16.  public function __toString()  
17.  {  
18.   try  
19.   {  
20.    return $this->renderUsing('Store');  
21.   }  
22.   catch (Exception $e)  
23.   {  
24.    self::setToStringException($e);  
25.    // we return a simple Exception message in case the form framework is used out of symfony.  
26.    return 'Exception: '.$e->getMessage();  
27.   }  
28.  }  
29. }  

class StoreRegistrationForm extends BaseStoreDetailsForm
{
 public function configure()
 {
           // ...
 }

 public function render($attributes = array())
 {
  $formatterObj = $this->widgetSchema->getFormFormatter();
  if(!is_null($formatterObj)) {   $formatterObj->setValidatorSchema($this->getValidatorSchema());   $this->widgetSchema->getFormFormatter()->setTranslationCatalogue("register_store_form");
  }
  return parent::render($attributes);
 }

 public function __toString()
 {
  try
  {
   return $this->renderUsing('Store');
  }
  catch (Exception $e)
  {
   self::setToStringException($e);
   // we return a simple Exception message in case the form framework is used out of symfony.
   return 'Exception: '.$e->getMessage();
  }
 }
}

3. as you see - TranslationCatalogue has been injected not in configure method.
If you use other than messages.xml - you should call setTranslationCatalogue in render block

1. public function render($attributes = array())  
2. {  
3.  $formatterObj = $this->widgetSchema->getFormFormatter();  
4.   
5.  if(!is_null($formatterObj)) {  
6.   $formatterObj->setValidatorSchema($this->getValidatorSchema());  
7.   $this->widgetSchema->getFormFormatter()->setTranslationCatalogue("register_store_form");  
8.  }  
9.   
10.  return parent::render($attributes);  
11. }  

 public function render($attributes = array())
 {
  $formatterObj = $this->widgetSchema->getFormFormatter();

  if(!is_null($formatterObj)) {
   $formatterObj->setValidatorSchema($this->getValidatorSchema());
   $this->widgetSchema->getFormFormatter()->setTranslationCatalogue("register_store_form");
  }

  return parent::render($attributes);
 }

that's all )