Jérôme Tamarelle I share so I am

sfWidget rendu via un composant Symfony

Les formulaires créés en utilisant Symfony sont composés de widgets et de validators. Les widgets décrivent l'apparence des champs du formulaire alors que les validators décrivent leur contenu. Il est actuellement possible de choisir parmi plus de 80 types de widget différents (entre ceux de l'API et les plugins). Ils correspondent globalement à des éléments d'interface standardisés.

Si vous avez essayé de créer votre propre widget, vous avez du vous apercevoir que le rendu est fait a l'intérieur de la fonction sfWidget->render(). Ce qui suffit pour des rendus simples, mais s'avère inapproprié lorsque votre champ de formulaire se complexifie. La structure vue-contrôleur du framework n'est pas respectée.

Pour compenser ce manque, j'ai créé un widget dont le rendu se fait via un composant (component) ou une vue partielle (partial). Ce widget est destiné à faciliter la création de champ de formulaire spécifiques pouvant utiliser entre autre AJAX, le profil de l'utilisateur, l'objet sfContext et sfRequest...

# /lib/widget/sfWidgetFormComponent.class.php
/**
 * sfWidgetComponent is a widget rendered on a component.
 * The component will recieve this vars :
 *  * $name        The element name
 *  * $value       The value selected in this widget
 *  * $attributes  An array of HTML attributes to be merged with the default HTML attributes
 *  * $errors      An array of errors for the field
 *  * $id          An unique id
 *  * $is_hidden   Is the field hidden ?
 *
 * @package    core
 * @subpackage widget
 * @author     Jerome TAMARELLE <http://jerome.tamarelle.net/>
 */
class sfWidgetFormComponent extends sfWidgetForm
{
  /**
   * Constructor.
   *
   * Available options:
   *  * module:       The module name
   *  * component:    The component name
   *  * context:      Current context object
   *
   * @param array $options     An array of options
   * @param array $attributes  An array of default HTML attributes
   * @see sfWidgetForm
   */
  protected function configure($options = array(), $attributes = array()) {
    $this->addRequiredOption('module');
    $this->addRequiredOption('component');
    $this->addOption('is_partial', false);
    $this->addOption('context', sfContext::hasInstance() ? sfContext::getInstance() : null);
  }

  /**
   * @param  string $name        The element name
   * @param  string $value       The value selected in this widget
   * @param  array  $attributes  An array of HTML attributes to be merged with the default HTML attributes
   * @param  array  $errors      An array of errors for the field
   * @return string The rendered component
   * @see sfWidgetForm
   */
  public function render($name, $value = null, $attributes = array(), $errors = array()) {
    try {
      $this->getOption('context')->getConfiguration()->loadHelpers('Partial');
    } catch (Exception $e) {
      throw new Exception('sfWidgetFormComponent requires &quot;context&quot; option to be an instance of sfContext.');
    }

    $vars = array(
      'name'        => $name,
      'value'       => $value,
      'attributes'  => $attributes,
      'errors'      => $errors,
      'id'          => $this->generateId($name),
      'is_hidden'   => $this->getOption('is_hidden'),
    );

    if($this->getOption('is_partial')) {
      return get_partial($this->getOption('module').'/'.$this->getOption('component'), $vars);
    } else {
      return get_component($this->getOption('module'), $this->getOption('component'), $vars);
    }
  }
}

sfWidgetFormComponent est un widget comme les autres ! Pour l'utiliser il suffit de l'ajouter à votre formulaire dans la fonction configure() de celui-ci.

# /lib/form/MyModelForm.class.php
class MyModelForm extends BaseMyModelForm {
  public function configure() {
    $this->setWidget('field',
      new sfWidgetFormComponent(array(
                      'module'=>'ajax',
                      'component'=>'myModelWidget'
    )));
  }
}

Il ne vous reste plus qu'à créer le composant qui conviendra le mieux à votre besoin !

• Widgets de l'API Symfony
• Plugins Symfony de la catégorie Widget
• Au Coeur des Widgets et Validateurs
• Personnaliser le code d'un widget
• Générer un formulaire en fonction de l'utilisateur