symfony & mark fields as required, part 2

In previous post - "symfony & mark fields as required" we have a solution for symfony to mark required forms field automatically.

But - it's not fully OOP. so ...

1. the main idea - create custom formatter.

2. inheritence


Base class for all generated forms - is BaseFormPropel
It's also generated from template sfPropelFormBaseTemplate.php which is in propel plugin.
Fix it. (class will be extends from CustomBaseForm instead of sfFormPropel)

view plainprint?

1. [?php  
2.   
3. /** 
4.  * Project form base class. 
5.  * 
6.  * @package    ##PROJECT_NAME## 
7.  * @subpackage form 
8.  * @author     ##AUTHOR_NAME## 
9.  * @version    SVN: $Id: sfPropelFormBaseTemplate.php 9304 2008-05-27 03:49:32Z dwhittle $ 
10.  */  
11. abstract class BaseFormPropel extends CustomBaseForm  
12. {  
13.   public function setup()  
14.   {  
15.   }  
16. }  

[?php

/**
 * Project form base class.
 *
 * @package    ##PROJECT_NAME##
 * @subpackage form
 * @author     ##AUTHOR_NAME##
 * @version    SVN: $Id: sfPropelFormBaseTemplate.php 9304 2008-05-27 03:49:32Z dwhittle $
 */
abstract class BaseFormPropel extends CustomBaseForm
{
  public function setup()
  {
  }
}

3. create CustomBaseForm (put it to /lib/form )

view plainprint?

1. <!--php<br /-->/** 
2.  * Custom form base class. 
3.  * 
4.  * @package    shopportal 
5.  * @subpackage form 
6.  * @author     gEndelf 
7.  */  
8. abstract class CustomBaseForm extends sfFormPropel  
9. {  
10.  public function getTranslationCatalogue() {  
11.   return "";  
12.  }  
13.   
14.  public function render($attributes = array())  
15.  {  
16.   $formatterObj = $this->widgetSchema->getFormFormatter();  
17.   
18.   if(!is_null($formatterObj)) {  
19.    $formatterObj->setValidatorSchema($this->getValidatorSchema());  
20.   
21.    if(($translationCatalogue = $this->getTranslationCatalogue()) != "") {  
22.     $this->widgetSchema->getFormFormatter()->setTranslationCatalogue($translationCatalogue);  
23.    }  
24.   }  
25.   
26.   return parent::render($attributes);  
27.  }  
28.   
29.  public function __toString()  
30.  {  
31.   try  
32.   {  
33.    return $this->renderUsing("Store");  
34.   }  
35.   catch (Exception $e)  
36.   {  
37.    self::setToStringException($e);  
38.    // we return a simple Exception message in case the form framework is used out of symfony.  
39.    return 'Exception: '.$e->getMessage();  
40.   }  
41.  }  
42. }  

/**
 * Custom form base class.
 *
 * @package    shopportal
 * @subpackage form
 * @author     gEndelf
 */
abstract class CustomBaseForm extends sfFormPropel
{
 public function getTranslationCatalogue() {
  return "";
 }

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

  if(!is_null($formatterObj)) {
   $formatterObj->setValidatorSchema($this->getValidatorSchema());

   if(($translationCatalogue = $this->getTranslationCatalogue()) != "") {
    $this->widgetSchema->getFormFormatter()->setTranslationCatalogue($translationCatalogue);
   }
  }

  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. If your form uses translation catalogue

view plainprint?

1. <!--php<br /-->  
2. /** 
3.  * Contacts form. 
4.  */  
5. class ContactsForm extends BaseContactsForm  
6. {  
7.  public function configure()  
8.  {  
9.           // ...  
10.  }  
11.   
12.  public function getTranslationCatalogue() {  
13.   return "contact_form";  
14.  }  
15. }  

/**
 * Contacts form.
 */
class ContactsForm extends BaseContactsForm
{
 public function configure()
 {
          // ...
 }

 public function getTranslationCatalogue() {
  return "contact_form";
 }
}

4. Last step

   symfony propel:build-all
   symfony cc

Advantages - you form doesn't contain repeatable code (guys - it's OOP :)