Changeset 7053

Timestamp:

01/14/08 19:57:07 (10 months ago)

Author:

fabien

Message:

refactored form/validators/widgets embedding

• sfWidgetFormSchema clones embedded widgets
  
• sfValidatorSchema clones embedded validators
  
• sfForm::embedForm() and sfForm::embedForEach() name format argument has been removed (see below)
  
• remove the constructor first argument (name format) for sfWidgetFormSchemaForEach
  
• sfWidgetFormSchema name format is forced when a widget schema is embedded in another
  
  • added setParent() and getParent() (the parent widget is now remembered)
    
  • an exception is thrown if the name format does not contains %s
    
  • the widget name generation is now recursive
    

Files:

• branches/1.1/lib/form/sfForm.class.php (modified) (5 diffs)
• branches/1.1/lib/validator/sfValidatorSchema.class.php (modified) (3 diffs)
• branches/1.1/lib/widget/sfWidgetFormSchema.class.php (modified) (7 diffs)
• branches/1.1/lib/widget/sfWidgetFormSchemaDecorator.class.php (modified) (1 diff)
• branches/1.1/lib/widget/sfWidgetFormSchemaForEach.class.php (modified) (3 diffs)
• branches/1.1/test/unit/form/sfFormFieldTest.php (modified) (1 diff)
• branches/1.1/test/unit/form/sfFormTest.php (modified) (8 diffs)
• branches/1.1/test/unit/validator/sfValidatorSchemaTest.php (modified) (7 diffs)
• branches/1.1/test/unit/widget/sfWidgetFormSchemaDecoratorTest.php (modified) (1 diff)
• branches/1.1/test/unit/widget/sfWidgetFormSchemaForEachTest.php (modified) (2 diffs)
• branches/1.1/test/unit/widget/sfWidgetFormSchemaTest.php (modified) (3 diffs)

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

@@ -208 +208 @@
-   * @param string The field name
-   * @param sfForm A sfForm instance
-   * @param string The format to use for widget name
-   * @param string A HTML decorator for the embedded form
-   */
-
-
-
-
-
-
-
-
+
+
-    $form = clone $form;
-    unset($form[self::$CSRFFieldName]);
-
-    $widgetSchema = $form->getWidgetSchema();
-    $widgetSchema->setNameFormat($nameFormat);
-
-    $this->setDefault($name, $form->getDefaults());
@@ -240 +232 @@
-   * @param string  The field name
-   * @param sfForm  A sfForm instance
-
-
+
-   * @param string  A HTML decorator for the main form around embedded forms
-   * @param string  A HTML decorator for each embedded form
-   */
-
-
-
-
-
-
-
-
+
+
-    $form = clone $form;
-    unset($form[self::$CSRFFieldName]);
+
+    $widgetSchema = $form->getWidgetSchema();
-
-    // generate labels and default values
@@ -262 +249 @@
-      if (!isset($labels[$i]))
-      {
-form->getWidgetSchema()
+widgetSchema
-      }
-
@@ -270 +257 @@
-    $this->setDefault($name, $defaults);
-
-form->getWidgetSchema()
-form->getWidgetSchema()
-
-$nameFormat, new sfWidgetFormSchemaDecorator($form->getWidgetSchema()
+widgetSchema
+widgetSchema
+
+new sfWidgetFormSchemaDecorator($widgetSchema
-    $this->validatorSchema[$name] = new sfValidatorSchemaForEach($form->getValidatorSchema(), $n);
-
@@ -621 +608 @@
-
-    return $this->formField;
-  }
-
-  /**
-   * Generates a name format for embedded forms.
-   *
-   * @param  string The widget name
-   * @param  string The current name format
-   *
-   * @return string The name format to use for embedding
-   *
-   * @see embedFormForEach()
-   * @see embedForm()
-   */
-  protected function generateNameFormatForEmbedded($name, $nameFormat)
-  {
-    // if current name format is something[%s], change it to something[$name][%s]
-    // else change it to $name[%s]
-    if ('[%s]' === substr($nameFormat, -4))
-    {
-      return sprintf('%s[%s][%%s]', substr($nameFormat, 0, -4), $name);
-    }
-    else
-    {
-      return sprintf('%s[%%s]', $name);
-    }
-  }
-

branches/1.1/lib/validator/sfValidatorSchema.class.php

@@ -245 +245 @@
-  public function setPreValidator(sfValidator $validator)
-  {
-
+clone 
-  }
-
@@ -265 +265 @@
-  public function setPostValidator(sfValidator $validator)
-  {
-
+clone 
-  }
-
@@ -315 +315 @@
-    }
-
-
+clone 
-  }
-

branches/1.1/lib/widget/sfWidgetFormSchema.class.php

@@ -28 +28 @@
-
-  protected
+    $parent         = null,
-    $formFormatters = array(),
-    $options        = array(),
@@ -58 +59 @@
-  public function __construct($fields = null, $options = array(), $attributes = array(), $labels = array(), $helps = array())
-  {
-    if (is_array($fields))
-    {
-      foreach ($fields as $name => $widget)
-      {
-        $this[$name] = $widget;
-      }
-    }
-    else if (!is_null($fields))
-    {
-      throw new InvalidArgumentException('sfWidgetFormSchema constructor takes an array of sfWidget objects.');
-    }
-
-    $this->labels = $labels;
-    $this->helps  = $helps;
@@ -77 +66 @@
-
-    parent::__construct($options, $attributes);
+
+    if (is_array($fields))
+    {
+      foreach ($fields as $name => $widget)
+      {
+        $this[$name] = $widget;
+      }
+    }
+    else if (!is_null($fields))
+    {
+      throw new InvalidArgumentException('sfWidgetFormSchema constructor takes an array of sfWidget objects.');
+    }
-  }
-
@@ -152 +153 @@
-  public function setNameFormat($format)
-  {
+    if (false !== $format && false === strpos($format, '%s'))
+    {
+      throw new InvalidArgumentException(sprintf('The name format must contain %%s ("%s" given)', $format));
+    }
+
-    $this->options['name_format'] = $format;
-  }
@@ -414 +420 @@
-  public function generateName($name)
-  {
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    }
-
-    return $name;
+  }
+
+  /**
+   * Gets the parent widget schema.
+   *
+   * @return sfWidgetFormSchema The parent widget schema
+   */
+  public function getParent()
+  {
+    return $this->parent;
+  }
+
+  /**
+   * Sets the parent widget schema.
+   *
+   * @parent sfWidgetFormSchema The parent widget schema
+   */
+  public function setParent(sfWidgetFormSchema $parent = null)
+  {
+    $this->parent = $parent;
-  }
-
@@ -469 +508 @@
-    }
-
-
+
+
+
+
+
+
+
-  }
-
@@ -596 +641 @@
-    foreach ($this->fields as $name => $field)
-    {
-
+
+
-    }
-  }

branches/1.1/lib/widget/sfWidgetFormSchemaDecorator.class.php

@@ -228 +228 @@
-   * @see sfWidgetFormSchema
-   */
-
+ = null
-  {
-    $this->widget->setParent($parent);

branches/1.1/lib/widget/sfWidgetFormSchemaForEach.class.php

@@ -10 +10 @@
-
-/**
-
+sfWidgetFormSchemaForEach duplicates a given widget multiple times in a widget schema.
- *
- * @package    symfony
@@ -22 +22 @@
-   * Constructor.
-   *
-   * @param string             The name format string
-   * @param sfWidgetFormSchema A sfWidgetFormSchema instance
-re
+du
-   * @param array              An array of options
-   * @param array              An array of default HTML attributes
@@ -31 +30 @@
-   * @see sfWidgetFormSchema
-   */
-$nameFormat, 
+
-  {
-
-
-
-
-
-
-
-
-
-
+
-  }
-}

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

@@ -39 +39 @@
-// ->getValue() ->getWidget() ->getParent() ->getError() ->hasError()
-$t->diag('->getValue() ->getWidget() ->getParent() ->getError() ->hasError()');
-is($f->getWidget(),
+ok($f->getWidget() ==
-$t->is($f->getValue(), 'symfony', '->getValue() returns the form field value');
-$t->is($f->getParent(), $parent, '->getParent() returns the form field parent');

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

@@ -11 +11 @@
-require_once(dirname(__FILE__).'/../../bootstrap/unit.php');
-
-2
+3
-
-class FormTest extends sfForm
@@ -18 +18 @@
-  {
-    return "*$secret*";
-  }
-
-  public function generateNameFormatForEmbedded($name, $nameFormat)
-  {
-    return parent::generateNameFormatForEmbedded($name, $nameFormat);
-  }
-}
@@ -117 +112 @@
-$f->setValidators($validators);
-$schema = $f->getValidatorSchema();
-is_deeply($schema['first_name'],
-is_deeply($schema['last_name'],
+ok($schema['first_name'] ==
+ok($schema['last_name'] ==
-
-// ->setWidgets() ->setWidgetSchema() ->getWidgetSchema()
@@ -129 +124 @@
-$widgetSchema = new sfWidgetFormSchema($widgets);
-$f->setWidgetSchema($widgetSchema);
-is_deeply($f->getWidgetSchema(),
+ok($f->getWidgetSchema() ==
-$f->setWidgets($widgets);
-$schema = $f->getWidgetSchema();
-is_deeply($schema['first_name'],
-is_deeply($schema['last_name'],
+ok($schema['first_name'] ==
+ok($schema['last_name'] ==
-
-// ArrayAccess interface
@@ -220 +215 @@
-$t->is($f->getErrorSchema()->getCode(), '1 [min_length] file [max_size]', '->bind() behaves correctly with files');
-
-// ->generateNameFormatForEmbedded()
-$t->diag('->generateNameFormatForEmbedded()');
-$f = new FormTest();
-$t->is($f->generateNameFormatForEmbedded('article', '%s'), 'article[%s]', '->generateNameFormatForEmbedded() generates a name format for an embed form');
-$t->is($f->generateNameFormatForEmbedded('author', 'article[%s]'), 'article[author][%s]', '->generateNameFormatForEmbedded() generates a name format for an embed form');
-
-// ->embedForm()
-$t->diag('->embedForm()');
+
-$author = new FormTest(array('first_name' => 'Fabien'));
-$author->setWidgetSchema($author_widget_schema = new sfWidgetFormSchema(array('first_name' => new sfWidgetFormInput())));
-$author->setValidatorSchema($author_validator_schema = new sfValidatorSchema(array('first_name' => new sfValidatorString(array('min_length' => 2)))));
+
+$company = new FormTest();
+$company->setWidgetSchema($company_widget_schema = new sfWidgetFormSchema(array('name' => new sfWidgetFormInput())));
+$company->setValidatorSchema($company_validator_schema = new sfValidatorSchema(array('name' => new sfValidatorString(array('min_length' => 2)))));
+
-$article = new FormTest();
-$article->setWidgetSchema($article_widget_schema = new sfWidgetFormSchema(array('title' => new sfWidgetFormInput())));
-$article->setValidatorSchema($article_validator_schema = new sfValidatorSchema(array('title' => new sfValidatorString(array('min_length' => 2)))));
-
+$author->embedForm('company', $company);
-$article->embedForm('author', $author);
-$v = $article->getValidatorSchema();
-$w = $article->getWidgetSchema();
-$d = $article->getDefaults();
+
+$w->setNameFormat('article[%s]');
-
-$t->ok($v['author']['first_name'] == $author_validator_schema['first_name'], '->embedForm() embeds the validator schema');
@@ -245 +243 @@
-$t->is($v['author'][sfForm::getCSRFFieldName()], null, '->embedForm() removes the CSRF token for the embedded form');
-$t->is($w['author'][sfForm::getCSRFFieldName()], null, '->embedForm() removes the CSRF token for the embedded form');
+
+$t->is($w['author']->generateName('first_name'), 'article[author][first_name]', '->embedForm() changes the name format to reflect the embedding');
+$t->is($w['author']['company']->generateName('name'), 'article[author][company][name]', '->embedForm() changes the name format to reflect the embedding');
-
-// ->embedFormForEach()
@@ -252 +253 @@
-$w = $article->getWidgetSchema();
-$d = $article->getDefaults();
+$w->setNameFormat('article[%s]');
-
-for ($i = 0; $i < 2; $i++)
@@ -261 +263 @@
-  $t->is($w['authors'][$i][sfForm::getCSRFFieldName()], null, '->embedFormForEach() removes the CSRF token for the embedded forms');
-}
+
+$t->is($w['authors'][0]->generateName('first_name'), 'article[authors][0][first_name]', '->embedFormForEach() changes the name format to reflect the embedding');
-
-// ::convertFileInformation()

branches/1.1/test/unit/validator/sfValidatorSchemaTest.php

@@ -88 +88 @@
-
-$v = new sfValidatorSchema(array('s1' => $v1));
-is($v['s1'],
+ok($v['s1'] ==
-$t->is($v['s2'], null, 'sfValidatorSchema implements the ArrayAccess interface for the fields');
-
@@ -161 +161 @@
-$v = new sfValidatorSchema(array('s1' => $v1, 's2' => $v2));
-$v->setPreValidator($preValidator = new PreValidator());
-is($v->getPreValidator(),
+ok($v->getPreValidator() ==
-try
-{
@@ -181 +181 @@
-$v = new sfValidatorSchema(array('s1' => $v1, 's2' => $v2));
-$v->setPostValidator($postValidator = new PostValidator());
-is($v->getPostValidator(),
+ok($v->getPostValidator() ==
-$t->is($v->clean(array('s1' => 'foo', 's2' => 'bar')), array('s1' => '*foo*', 's2' => '*bar*'), '->clean() executes post validators');
-
@@ -221 +221 @@
-
-$t->diag('one validator fails');
-2
+['s2']
-try
-{
@@ -236 +236 @@
-
-$t->diag('several validators fail');
-1
-2
+['s1']
+['s2']
-try
-{
@@ -269 +269 @@
-
-$t->diag('postValidator throws global errors');
-
+
+
+
+
-try
-{
@@ -287 +290 @@
-
-$t->diag('postValidator throws named errors');
-
+
+
+
+
-try
-{

branches/1.1/test/unit/widget/sfWidgetFormSchemaDecoratorTest.php

@@ -58 +58 @@
-
-$w = new sfWidgetFormSchemaDecorator($ws, "<table>\n%content%</table>");
-is($w['w1'],
-is($w['w2'],
-is($ws['w1'],
-is($ws['w2'],
+ok($w['w1'] ==
+ok($w['w2'] ==
+ok($ws['w1'] ==
+ok($ws['w2'] ==
-
-$w = new sfWidgetFormSchemaDecorator($ws, "<table>\n%content%</table>");

branches/1.1/test/unit/widget/sfWidgetFormSchemaForEachTest.php

@@ -11 +11 @@
-require_once(dirname(__FILE__).'/../../bootstrap/unit.php');
-
-1
+4
-
-$w1 = new sfWidgetFormInput();
@@ -18 +18 @@
-// __construct()
-$t->diag('__construct()');
-
-
-
-
-
-
+
+
+
+
+

branches/1.1/test/unit/widget/sfWidgetFormSchemaTest.php

@@ -11 +11 @@
-require_once(dirname(__FILE__).'/../../bootstrap/unit.php');
-
-5
+9
-
-$w1 = new sfWidgetFormInput(array(), array('class' => 'foo1'));
@@ -62 +62 @@
-
-$w = new sfWidgetFormSchema(array('w1' => $w1));
-is($w['w1'],
+ok($w['w1'] ==
-$t->is($w['w2'], null, 'sfWidgetFormSchema implements the ArrayAccess interface for the fields');
-
@@ -103 +103 @@
-$t->is($w->getNameFormat(), 'article[%s]', '->getNameFormat() returns the name format');
-
-$w->setNameFormat('foo');
-$t->is($w->generateName('foo'), 'foo', '->generateName() returns the name unchanged if the format does not contain %s');
-
-$w->setNameFormat(false);
-$t->is($w->generateName('foo'), 'foo', '->generateName() returns the name unchanged if the format is false');
+
+try
+{
+  $w->setNameFormat('foo');
+  $t->fail('->setNameFormat() throws an InvalidArgumentException if the format does not contain %s');
+}
+catch (InvalidArgumentException $e)
+{
+  $t->pass('->setNameFormat() throws an InvalidArgumentException if the format does not contain %s');
+}
+
+$w = new sfWidgetFormSchema(array(
+  'author' => new sfWidgetFormSchema(array(
+    'first_name' => new sfWidgetFormInput(),
+    'company'    => new sfWidgetFormSchema(array(
+      'name' => new sfWidgetFormInput(),
+    )),
+  )),
+));
+$w->setNameFormat('article[%s]');
+$t->is($w['author']->generateName('first_name'), 'article[author][first_name]', '->generateName() returns a HTML name attribute value for a given field name');
+$t->is($w['author']['company']->generateName('name'), 'article[author][company][name]', '->generateName() returns a HTML name attribute value for a given field name');
+
+// ->getParent() ->setParent()
+$t->diag('->getParent() ->setParent()');
+$author = new sfWidgetFormSchema(array('first_name' => new sfWidgetFormInput()));
+$company = new sfWidgetFormSchema(array('name' => new sfWidgetFormInput()));
+$t->is($company->getParent(), null, '->getParent() returns null if there is no parent widget schema');
+$company->setParent($author);
+$t->is($company->getParent(), $author, '->getParent() returns the parent widget schema');
-
-// ->setLabels() ->setLabel() ->getLabels() ->getLabel() ->generateLabelName()