Changeset 5882

Timestamp:

11/06/07 20:58:15 (2 years ago)

Author:

fabien

Message:

validators: fixed API docs, added addOption() and addMessage() methods to register options and messages

Files:

• trunk/lib/validator/sfValidator.class.php (modified) (7 diffs)
• trunk/lib/validator/sfValidatorBoolean.class.php (modified) (1 diff)
• trunk/lib/validator/sfValidatorCallback.class.php (modified) (1 diff)
• trunk/lib/validator/sfValidatorDate.class.php (modified) (2 diffs)
• trunk/lib/validator/sfValidatorEmail.class.php (modified) (1 diff)
• trunk/lib/validator/sfValidatorInteger.class.php (modified) (1 diff)
• trunk/lib/validator/sfValidatorNumber.class.php (modified) (1 diff)
• trunk/lib/validator/sfValidatorSchema.class.php (modified) (2 diffs)
• trunk/lib/validator/sfValidatorSchemaCompare.class.php (modified) (1 diff)
• trunk/lib/validator/sfValidatorSchemaFilter.class.php (modified) (1 diff)
• trunk/lib/validator/sfValidatorString.class.php (modified) (1 diff)
• trunk/lib/validator/sfValidatorUrl.class.php (modified) (1 diff)
• trunk/test/unit/validator/sfValidatorChoiceManyTest.php (modified) (2 diffs)
• trunk/test/unit/validator/sfValidatorTest.php (modified) (6 diffs)

trunk/lib/validator/sfValidator.class.php

@@ -40 +40 @@
-   *  * empty_value: empty value when value is not required
-   *
+   * Available error codes:
+   *
+   *  * required
+   *  * invalid
+   *
-   * @param array An array of options
-   * @param array An array of error messages
@@ -66 +71 @@
-
-    // check required options
-keys($options
+merge(array_keys($this->options), array_keys($options)
-    {
-      throw new sfException(sprintf('%s requires the following options: \'%s\'.', get_class($this), implode('\', \'', $diff)));
@@ -107 +112 @@
-
-  /**
-Changes an error message given the error cod
+Adds a new error code with a default error messag
-   *
-   * @param string The error code
-   * @param string The error message
-   */
+  public function addMessage($name, $value)
+  {
+    $this->messages[$name] = $value;
+  }
+
+  /**
+   * Changes an error message given the error code.
+   *
+   * @param string The error code
+   * @param string The error message
+   */
-  public function setMessage($name, $value)
-  {
+    if (!in_array($name, array_keys($this->messages)))
+    {
+      throw new sfException(sprintf('%s does not support the following error code: \'%s\'.', get_class($this), $name));
+    }
+
-    $this->messages[$name] = $value;
-  }
@@ -147 +168 @@
-  {
-    return isset($this->options[$name]) ? $this->options[$name] : null;
+  }
+
+  /**
+   * Adds a new option value with a default value.
+   *
+   * @param string The option name
+   * @param mixed  The default value
+   */
+  public function addOption($name, $value = null)
+  {
+    $this->options[$name] = $value;
-  }
-
@@ -157 +189 @@
-  public function setOption($name, $value)
-  {
+    if (!in_array($name, array_merge(array_keys($this->options), $this->requiredOptions)))
+    {
+      throw new sfException(sprintf('%s does not support the following option: \'%s\'.', get_class($this), $name));
+    }
+
-    $this->options[$name] = $value;
-  }
@@ -190 +227 @@
-  {
-    $this->options = $values;
+  }
+
+  /**
+   * Adds a required option.
+   *
+   * @param string The option name
+   */
+  public function addRequiredOption($name)
+  {
+    $this->requiredOptions[] = $name;
+  }
+
+  /**
+   * Returns all required option names.
+   *
+   * @param array An array of required option names
+   */
+  public function getRequiredOptions()
+  {
+    return $this->requiredOptions;
-  }
-
@@ -333 +390 @@
-  {
-    $this->defaultOptions = $options;
-  }
-
-  /**
-   * Adds a required option.
-   *
-   * @param string The option name
-   */
-  public function addRequiredOption($name)
-  {
-    $this->requiredOptions[] = $name;
-  }
-
-  /**
-   * Returns all required option names.
-   *
-   * @param array An array of required option names
-   */
-  public function getRequiredOptions()
-  {
-    return $this->requiredOptions;
-  }
-

trunk/lib/validator/sfValidatorBoolean.class.php

@@ -31 +31 @@
-  protected function configure($options = array(), $messages = array())
-  {
-
-
+
+
+
-    $this->setOption('required', false);
-  }

trunk/lib/validator/sfValidatorCallback.class.php

@@ -31 +31 @@
-  {
-    $this->addRequiredOption('callback');
+
-    $this->setOption('required', false);
-  }

trunk/lib/validator/sfValidatorDate.class.php

@@ -24 +24 @@
-   * Available options:
-   *
-
-
-
-
+
+
+
+
+
+
+
+
+
-   *
-   * @see sfValidator
@@ -33 +38 @@
-  protected function configure($options = array(), $messages = array())
-  {
-set
+add
-
-
-
-
-
+
+
+
+
+
-  }
-

trunk/lib/validator/sfValidatorEmail.class.php

@@ -24 +24 @@
-  protected function configure($options = array(), $messages = array())
-  {
+    parent::configure($options, $messages);
+
-    $this->setOption('pattern', '/^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i');
-  }

trunk/lib/validator/sfValidatorInteger.class.php

@@ -27 +27 @@
-   *  * min: The minimum value allowed
-   *
+   * Available error codes:
+   *
+   *  * max
+   *  * min
+   *
-   * @see sfValidator
-   */
-  protected function configure($options = array(), $messages = array())
-  {
-
-
+
+
+
+
+
+
-    $this->setMessage('invalid', '"%value%" is not an integer.');
-
-    $this->setOption('min', null);
-    $this->setOption('max', null);
-  }
-

trunk/lib/validator/sfValidatorNumber.class.php

@@ -27 +27 @@
-   *  * min: The minimum value allowed
-   *
+   * Available error codes:
+   *
+   *  * max
+   *  * min
+   *
-   * @see sfValidator
-   */
-  protected function configure($options = array(), $messages = array())
-  {
-
-
+
+
+
+
+
+
-    $this->setMessage('invalid', '"%value%" is not a number.');
-
-    $this->setOption('min', null);
-    $this->setOption('max', null);
-  }
-

trunk/lib/validator/sfValidatorSchema.class.php

@@ -63 +63 @@
-   *  * filter_extra_fields: if true, the validator filters extra fields from the returned array of cleaned values (default to true)
-   *
+   * Available error codes:
+   *
+   *  * extra_fields
+   *
-   * @param array An array of options
-   * @param array An array of error messages
@@ -70 +74 @@
-  public function configure($options = array(), $messages = array())
-  {
-set
-set
-
-set
+add
+add
+
+add
-  }
-

trunk/lib/validator/sfValidatorSchemaCompare.class.php

@@ -48 +48 @@
-  public function __construct($leftField, $operator, $rightField, $options = array(), $messages = array())
-  {
-set
-set
-set
+add
+add
+add
-
-    parent::__construct(null, $options, $messages);

trunk/lib/validator/sfValidatorSchemaFilter.class.php

@@ -31 +31 @@
-  public function __construct($field, sfValidator $validator, $options = array(), $messages = array())
-  {
-set
-set
+add
+add
-
-    parent::__construct(null, $options, $messages);

trunk/lib/validator/sfValidatorString.class.php

@@ -27 +27 @@
-   *  * min_length: The minimum length of the string
-   *
+   * Available error codes:
+   *
+   *  * max_length
+   *  * min_length
+   *
-   * @see sfValidator
-   */
-  protected function configure($options = array(), $messages = array())
-  {
-set
-set
+add
+add
-
-
-
+
+
+
-    $this->setOption('empty_value', '');
-  }

trunk/lib/validator/sfValidatorUrl.class.php

@@ -24 +24 @@
-  public function configure($options = array(), $messages = array())
-  {
+    parent::configure($options, $messages);
+
-    $this->setOption('pattern', '~^
-      https?://                               # http or https

trunk/test/unit/validator/sfValidatorChoiceManyTest.php

@@ -11 +11 @@
-require_once(dirname(__FILE__).'/../../bootstrap/unit.php');
-
-5
+6
-
-$v = new sfValidatorChoiceMany(array('choices' => array('foo', 'bar')));
@@ -40 +40 @@
-  $t->pass('->clean() throws an sfValidatorError if the value is not an expected value');
-}
+
+function choice_callable()
+{
+  return array(1, 2, 3);
+}
+
+// choices as a callable
+$t->diag('choices as a callable');
+$v = new sfValidatorChoiceMany(array('choices' => new sfCallable('choice_callable')));
+$t->is($v->clean(array('2')), array('2'), '__construct() can take a sfCallable object as a choices option');

trunk/test/unit/validator/sfValidatorTest.php

@@ -11 +11 @@
-require_once(dirname(__FILE__).'/../../bootstrap/unit.php');
-
-3
+7
-
-class ValidatorIdentity extends sfValidator
@@ -17 +17 @@
-  protected function configure($options = array(), $messages = array())
-  {
-set
-set
+add
+add
-  }
-
@@ -75 +75 @@
-}
-
+// ->getRequiredOptions()
-$t->diag('getRequiredOptions');
-$v = new ValidatorIdentityWithRequired(array('foo' => 'bar'));
@@ -118 +119 @@
-$v->setOption('trim', true);
-$t->is($v->clean('  foo  '), 'foo', '->setOption() can turn on whitespace trimming');
+try
+{
+  $v->setOption('foobar', 'foo');
+  $t->fail('->setOption() throws an sfException if the option is not registered');
+}
+catch (sfException $e)
+{
+  $t->pass('->setOption() throws an sfException if the option is not registered');
+}
-
-// ->hasOption()
@@ -129 +139 @@
-$t->is($v->getOption('nonexistant'), null, '->getOption() returns null if the option does not exist');
-
+// ->addOption()
+$t->diag('->addOption()');
+$v->addOption('foobar');
+$v->setOption('foobar', 'foo');
+$t->is($v->getOption('foobar'), 'foo', '->addOption() adds a new option to a validator');
+
-// ->getOptions() ->setOptions()
-$t->diag('->getOptions() ->setOptions()');
@@ -156 +172 @@
-}
-
+try
+{
+  $v->setMessage('foobar', 'foo');
+  $t->fail('->setMessage() throws an sfException if the message is not registered');
+}
+catch (sfException $e)
+{
+  $t->pass('->setMessage() throws an sfException if the message is not registered');
+}
+
-// ->setMessages()
-$t->diag('->setMessages()');
-$v->setMessages(array('required' => 'This is required.'));
-$t->is($v->getMessages(), array('required' => 'This is required.'), '->setMessages() changes all error messages');
+
+// ->addMessage()
+$t->diag('->addMessage()');
+$v->addMessage('foobar', 'foo');
+$v->setMessage('foobar', 'bar');
+$t->is($v->getMessage('foobar'), 'bar', '->addMessage() adds a new error code');
-
-// ->getErrorCodes()