Changeset 9498

Timestamp:

06/09/08 19:35:50 (2 years ago)

Author:

nicolas

Message:

Added $sfForm::mergeForm(sfForm $form) method which allows to merge two existing form instances, including:

• widgets
  
• validators
  
• pre and post validators
  
• elements of the form passed as argument will override the existing ones by default
  
• bound forms cannot be merged (this behavior has been replicated in the embedForm and embedFormForEach methods)
  

Files:

• branches/1.1/lib/form/sfForm.class.php (modified) (4 diffs)
• branches/1.1/test/unit/form/sfFormTest.php (modified) (2 diffs)

branches/1.1/lib/form/sfForm.class.php

@@ -254 +254 @@
-  public function embedForm($name, sfForm $form, $decorator = null)
-  {
+    if (true === $this->isBound() || true === $form->isBound())
+    {
+      throw new LogicException('A bound form cannot be embedded');
+    }
+    
-    $form = clone $form;
-    unset($form[self::$CSRFFieldName]);
@@ -265 +270 @@
-    $this->widgetSchema[$name] = new sfWidgetFormSchemaDecorator($widgetSchema, $decorator);
-    $this->validatorSchema[$name] = $form->getValidatorSchema();
-
+
-    $this->resetFormFields();
-  }
@@ -283 +288 @@
-  public function embedFormForEach($name, sfForm $form, $n, $decorator = null, $innerDecorator = null, $attributes = array(), $options = array(), $labels = array())
-  {
+    if (true === $this->isBound() || true === $form->isBound())
+    {
+      throw new LogicException('A bound form cannot be embedded');
+    }
+    
-    $form = clone $form;
-    unset($form[self::$CSRFFieldName]);
@@ -307 +317 @@
-    $this->widgetSchema[$name] = new sfWidgetFormSchemaDecorator(new sfWidgetFormSchemaForEach(new sfWidgetFormSchemaDecorator($widgetSchema, $innerDecorator), $n, $attributes, $options, $labels), $decorator);
-    $this->validatorSchema[$name] = new sfValidatorSchemaForEach($form->getValidatorSchema(), $n);
+
+    $this->resetFormFields();
+  }
+  
+  /**
+   * Merges current form widget and validator schemas with the ones from the 
+   * sfForm object passed as parameter
+   *
+   * @param  sfForm   $form      The sfForm instance to merge with current form
+   * @throws LogicException      If one of the form has already been bound
+   */
+  public function mergeForm(sfForm $form)
+  {
+    if (true === $this->isBound() || true === $form->isBound())
+    {
+      throw new LogicException('A bound form cannot be merged');
+    }
+
+    $form = clone $form;
+    unset($form[self::$CSRFFieldName]);
+
+    $this->defaults = array_merge($this->defaults, $form->getDefaults());
+
+    foreach ($form->getWidgetSchema()->getFields() as $field => $widget)
+    {
+      $this->widgetSchema[$field] = $widget;
+    }
+    
+    foreach ($form->getValidatorSchema()->getFields() as $field => $validator)
+    {
+      $this->validatorSchema[$field] = $validator;
+    }
+    
+    if (!is_null($form->getValidatorSchema()->getPreValidator()))
+    {
+      $this->validatorSchema->setPreValidator(new sfValidatorAnd(array(
+        !is_null($this->validatorSchema->getPreValidator()) ? $this->validatorSchema->getPreValidator() : new sfValidatorPass(), 
+        $form->getValidatorSchema()->getPreValidator(),
+      )));
+    }
+    
+    if (!is_null($form->getValidatorSchema()->getPostValidator()))
+    {
+      $this->validatorSchema->setPostValidator(new sfValidatorAnd(array(
+        !is_null($this->validatorSchema->getPostValidator()) ? $this->validatorSchema->getPostValidator() : new sfValidatorPass(), 
+        $form->getValidatorSchema()->getPostValidator(),
+      )));
+    }
-
-    $this->resetFormFields();

branches/1.1/test/unit/form/sfFormTest.php

@@ -11 +11 @@
-require_once(dirname(__FILE__).'/../../bootstrap/unit.php');
-
-8
+9
-
-class FormTest extends sfForm
@@ -549 +549 @@
-$t->ok($a1->getErrorSchema() !== $a->getErrorSchema(), '__clone() clones the error schema');
-$t->ok($a1->getErrorSchema()->getMessage() == $a->getErrorSchema()->getMessage(), '__clone() clones the error schema');
+
+// mergeForm()
+$t->diag('mergeForm()');
+
+class TestForm1 extends FormTest
+{
+  public function configure()
+  {
+    $this->disableCSRFProtection();
+    $this->setWidgets(array(
+      'a' => new sfWidgetFormInput(),
+      'b' => new sfWidgetFormInput(),
+      'c' => new sfWidgetFormInput(),
+    ));
+    $this->setValidators(array(
+      'a' => new sfValidatorString(array('min_length' => 2)),
+      'b' => new sfValidatorString(array('max_length' => 3)),
+      'c' => new sfValidatorString(array('max_length' => 1000)),
+    ));
+  }
+}
+
+class TestForm2 extends FormTest
+{
+  public function configure()
+  {
+    $this->disableCSRFProtection();
+    $this->setWidgets(array(
+      'c' => new sfWidgetFormTextarea(),
+      'd' => new sfWidgetFormTextarea(),
+    ));
+    $this->setValidators(array(
+      'c' => new sfValidatorPass(),
+      'd' => new sfValidatorString(array('max_length' => 5)),
+    ));
+    $this->validatorSchema->setPreValidator(new sfValidatorPass());
+    $this->validatorSchema->setPostValidator(new sfValidatorPass());
+  }
+}
+
+$f1 = new TestForm1();
+$f2 = new TestForm2();
+$f1->mergeForm($f2);
+
+$widgetSchema = $f1->getWidgetSchema();
+$validatorSchema = $f1->getValidatorSchema();
+$t->is(count($widgetSchema->getFields()), 4, 'mergeForm() merges a widget form schema');
+$t->is(count($validatorSchema->getFields()), 4, 'mergeForm() merges a validator schema');
+$t->is(array_keys($widgetSchema->getFields()), array('a', 'b', 'c', 'd'), 'mergeForms() merges the correct widgets');
+$t->is(array_keys($validatorSchema->getFields()), array('a', 'b', 'c', 'd'), 'mergeForms() merges the correct validators');
+$t->isa_ok($widgetSchema['c'], 'sfWidgetFormTextarea', 'mergeForm() overrides original form widget');
+$t->isa_ok($validatorSchema['c'], 'sfValidatorPass', 'mergeForm() overrides original form validator');
+$t->isa_ok($validatorSchema->getPreValidator(), 'sfValidatorAnd', 'mergeForm() merges pre validator');
+$t->isa_ok($validatorSchema->getPostValidator(), 'sfValidatorAnd', 'mergeForm() merges post validator');
+
+try
+{
+  $f1->bind(array('a' => 'foo', 'b' => 'bar', 'd' => 'far_too_long_value'));
+  $f1->mergeForm($f2);
+  $t->fail('mergeForm() disallows merging already bound forms');
+}
+catch (LogicException $e)
+{
+  $t->pass('mergeForm() disallows merging already bound forms');
+}
+
+$errorSchema = $f1->getErrorSchema();
+$t->ok(array_key_exists('d', $errorSchema->getErrors()), 'mergeForm() merges errors after having been bound');