Changeset 5816

Timestamp:

11/02/07 16:59:47 (10 months ago)

Author:

fabien

Message:

updated validators

• better support for options
  
  • added a addRequiredOption() method
    
  • check option name for typos
    
• check error codes for typos
  
• added 2 methods to get default options and error messages
  
• added support for date as an array to sfValidatorDate
  
• fixed some minor bugs
  

Files:

• trunk/lib/validator/sfValidator.class.php (modified) (6 diffs)
• trunk/lib/validator/sfValidatorAll.class.php (modified) (2 diffs)
• trunk/lib/validator/sfValidatorAny.class.php (modified) (2 diffs)
• trunk/lib/validator/sfValidatorBoolean.class.php (modified) (1 diff)
• trunk/lib/validator/sfValidatorCallback.class.php (modified) (2 diffs)
• trunk/lib/validator/sfValidatorChoice.class.php (modified) (2 diffs)
• trunk/lib/validator/sfValidatorDate.class.php (modified) (4 diffs)
• trunk/lib/validator/sfValidatorDecorator.class.php (modified) (2 diffs)
• trunk/lib/validator/sfValidatorEmail.class.php (modified) (1 diff)
• trunk/lib/validator/sfValidatorInteger.class.php (modified) (2 diffs)
• trunk/lib/validator/sfValidatorNumber.class.php (modified) (2 diffs)
• trunk/lib/validator/sfValidatorRegex.class.php (modified) (2 diffs)
• trunk/lib/validator/sfValidatorSchema.class.php (modified) (2 diffs)
• trunk/lib/validator/sfValidatorSchemaCompare.class.php (modified) (4 diffs)
• trunk/lib/validator/sfValidatorSchemaFilter.class.php (modified) (1 diff)
• trunk/lib/validator/sfValidatorString.class.php (modified) (2 diffs)
• trunk/lib/validator/sfValidatorUrl.class.php (modified) (2 diffs)
• trunk/test/unit/validator/sfValidatorBooleanTest.php (modified) (1 diff)
• trunk/test/unit/validator/sfValidatorDateTest.php (modified) (3 diffs)
• trunk/test/unit/validator/sfValidatorDecoratorTest.php (modified) (3 diffs)
• trunk/test/unit/validator/sfValidatorFromDescriptionTest.php (modified) (1 diff)
• trunk/test/unit/validator/sfValidatorIntegerTest.php (modified) (1 diff)
• trunk/test/unit/validator/sfValidatorNumberTest.php (modified) (1 diff)
• trunk/test/unit/validator/sfValidatorRegexTest.php (modified) (2 diffs)
• trunk/test/unit/validator/sfValidatorSchemaTest.php (modified) (2 diffs)
• trunk/test/unit/validator/sfValidatorStringTest.php (modified) (1 diff)
• trunk/test/unit/validator/sfValidatorTest.php (modified) (4 diffs)

trunk/lib/validator/sfValidator.class.php

@@ -25 +25 @@
-
-  protected
-
-
+
+
+
+
+
-
-  /**
@@ -42 +45 @@
-  public function __construct($options = array(), $messages = array())
-  {
-messages = array('required' => 'Required.', 'invalid' => 'Invalid.'
-options  = array('required' => true, 'trim' => false, 'empty_value' => null
+options  = array_merge(array('required' => true, 'trim' => false, 'empty_value' => null), $this->options
+messages = array_merge(array('required' => 'Required.', 'invalid' => 'Invalid.'), $this->messages
-
-    $this->configure($options, $messages);
+
+    $this->setDefaultOptions($this->getOptions());
+    $this->setDefaultMessages($this->getMessages());
+
+    // check option names
+    if ($diff = array_diff(array_keys($options), array_merge(array_keys($this->options), $this->requiredOptions)))
+    {
+      throw new sfException(sprintf('%s does not support the following options: \'%s\'.', get_class($this), implode('\', \'', $diff)));
+    }
+
+    // check error code names
+    if ($diff = array_diff(array_keys($messages), array_keys($this->messages)))
+    {
+      throw new sfException(sprintf('%s does not support the following error codes: \'%s\'.', get_class($this), implode('\', \'', $diff)));
+    }
+
+    // check required options
+    if ($diff = array_diff($this->requiredOptions, array_keys($options)))
+    {
+      throw new sfException(sprintf('%s requires the following options: \'%s\'.', get_class($this), implode('\', \'', $diff)));
+    }
-
-    $this->options  = array_merge($this->options, $options);
-    $this->messages = array_merge($this->messages, $messages);
+  }
+
+  /**
+   * Configures the current validator.
+   *
+   * This method allows each validator to add options and error messages
+   * during validator creation.
+   *
+   * If some options and messages are given in the sfValidator constructor
+   * they will take precedence over the options and messages you configure
+   * in this method.
+   *
+   * @param array An array of options
+   * @param array An array of error messages
+   *
+   * @see __construct()
+   */
+  protected function configure($options = array(), $messages = array())
+  {
-  }
-
@@ -199 +242 @@
-
-  /**
+   * Sets the charset to use when validating strings.
+   *
+   * @param string The charset
+   */
+  static public function setCharset($charset)
+  {
+    self::$charset = $charset;
+  }
+
+  /**
+   * Returns the charset to use when validating strings.
+   *
+   * @return string The charset (default to UTF-8)
+   */
+  static public function getCharset()
+  {
+    return self::$charset;
+  }
+
+  /**
+   * Returns true if the value is empty.
+   *
+   * @param  mixed   The input value
+   *
+   * @return Boolean true if the value is empty, false otherwise
+   */
+  protected function isEmpty($value)
+  {
+    return in_array($value, array(null, ''));
+  }
+
+  /**
+   * Returns an empty value for this validator.
+   *
+   * @return mixed The empty value for this validator
+   */
+  protected function getEmptyValue()
+  {
+    return $this->getOption('empty_value');
+  }
+
+  /**
-   * Returns an array of all error codes for this validator.
-   *
-   * Subclasses of sfValidator may override this method to register
-   * their own error codes.
-   *
-   * By default this method return required and invalid as errors codes.
-   *
-   * @return array An array of possible error codes
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  }
-
@@ -295 +376 @@
-
-  /**
+   * Returns all error messages with non default values.
+   *
+   * @return string A string representation of the error messages
+   */
+  protected function getMessagesWithoutDefaults()
+  {
+    $messages = $this->messages;
+
+    // remove default option values
+    foreach ($this->getDefaultMessages() as $key => $value)
+    {
+      if (array_key_exists($key, $messages) && $messages[$key] === $value)
+      {
+        unset($messages[$key]);
+      }
+    }
+
+    return $messages;
+  }
+
+  /**
-   * Returns all options with non default values.
-   *
@@ -304 +406 @@
-
-    // remove default option values
-
-
-
+
-    {
-      if (array_key_exists($key, $options) && $options[$key] === $value)
@@ -316 +416 @@
-    return $options;
-  }
-
-  /**
-   * Returns all error messages with non default values.
-   *
-   * @return string A string representation of the error messages
-   */
-  protected function getMessagesWithoutDefaults()
-  {
-    $messages = $this->messages;
-
-    // remove default option values
-    $reflection = new ReflectionClass(get_class($this));
-    $default = $reflection->newInstanceArgs(func_get_args());
-    foreach ($default->getMessages() as $key => $value)
-    {
-      if (array_key_exists($key, $messages) && $messages[$key] === $value)
-      {
-        unset($messages[$key]);
-      }
-    }
-
-    return $messages;
-  }
-}

trunk/lib/validator/sfValidatorAll.class.php

@@ -55 +55 @@
-    }
-
-
-
-
-
+
+
-
-
+
+
+
+
+
+
-  }
-
@@ -145 +148 @@
-    }
-
-
-
-
-
-
+
-  }
-}

trunk/lib/validator/sfValidatorAny.class.php

@@ -55 +55 @@
-    }
-
-
-
-
-
+
+
-
-
+
+
+
+
+
+
-  }
-
@@ -139 +142 @@
-    }
-
-
-
-
-
-
+
-  }
-}

trunk/lib/validator/sfValidatorBoolean.class.php

@@ -33 +33 @@
-    $this->setOption('true_values', array('true', 't', 'yes', 'y', 'on', '1'));
-    $this->setOption('false_values', array('false', 'f', 'no', 'n', 'off', '0'));
-
-    $this->setOption('required', false);
-  }

trunk/lib/validator/sfValidatorCallback.class.php

@@ -20 +20 @@
-{
-  /**
-struc
+figures the current valida
-   *
-   * Available options:
-   *
-
+ (required)
-   *
-   * @see sfValidator
-   */
-  public function __construct($options = array(), $messages = array())
-  {
-    if (!isset($options['callback']))
-    {
-      throw new sfException('The "callback" option is mandatory.');
-    }
-
-    parent::__construct($options, $messages);
-  }
-
-  /**
-   * @see sfValidator
-   */
-  protected function configure($options = array(), $messages = array())
-  {
-
+
+
-  }
-
@@ -53 +41 @@
-    return call_user_func($this->getOption('callback'), $this, $value);
-  }
-
-  /**
-   * @see sfValidator
-   */
-  protected function getOptionsWithoutDefaults()
-  {
-    return parent::getOptionsWithoutDefaults(array('callback' => array('--fake--')));
-  }
-
-  /**
-   * @see sfValidator
-   */
-  protected function getMessagesWithoutDefaults()
-  {
-    return parent::getMessagesWithoutDefaults(array('callback' => array('--fake--')));
-  }
-}

trunk/lib/validator/sfValidatorChoice.class.php

@@ -20 +20 @@
-{
-  /**
-struc
+figures the current valida
-   *
-   * Available options:
-   *
-
+ (required)
-   *
-   * @see sfValidator
-   */
-ublic function __construct
+rotected function configure
-  {
-
-
-
-
-
-
+
-  }
-
@@ -50 +45 @@
-    return $value;
-  }
-
-  /**
-   * @see sfValidator
-   */
-  protected function getOptionsWithoutDefaults()
-  {
-    return parent::getOptionsWithoutDefaults(array('choices' => array('--fake--')));
-  }
-
-  /**
-   * @see sfValidator
-   */
-  protected function getMessagesWithoutDefaults()
-  {
-    return parent::getMessagesWithoutDefaults(array('choices' => array('--fake--')));
-  }
-}

trunk/lib/validator/sfValidatorDate.class.php

@@ -35 +35 @@
-    $this->setMessage('bad_format', '"%value%" does not match the date format (%date_format%).');
-
+    $this->setOption('date_format', null);
-    $this->setOption('with_time', false);
-    $this->setOption('date_output', 'Y-m-d');
@@ -45 +46 @@
-  protected function doClean($value)
-  {
-
+
+
+
+
+
-    {
-      if (!preg_match($regex, $value, $match))
@@ -52 +57 @@
-      }
-
-
-
-
-
-
-
-
-
+
-    }
-    else if (!ctype_digit($value))
-    {
-      $clean = strtotime($value);
-$clean === -1 || $clean === false
+false === $clean
-      {
-        throw new sfValidatorError($this, 'invalid', array('value' => $value));
@@ -78 +76 @@
-
-  /**
-
+
+
+
+
+
+
+
-   */
-ublic function getErrorCodes(
+rotected function convertDateArrayToTimestamp($value
-  {
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  }
-}

trunk/lib/validator/sfValidatorDecorator.class.php

@@ -149 +149 @@
-   * @see sfValidator
-   */
-getErrorCodes(
+asString($indent = 0
-  {
-getValidator()->getErrorCodes(
+validator->asString($indent
-  }
-
@@ -157 +157 @@
-   * @see sfValidator
-   */
-asString($indent = 0
+getDefaultOptions(
-  {
-
+
+
+
+
+
+
+
+
+
-  }
-}

trunk/lib/validator/sfValidatorEmail.class.php

@@ -22 +22 @@
-   * @see sfValidatorRegex
-   */
-ublic function __construct
+rotected function configure
-  {
-
-
-
+
-  }
-}

trunk/lib/validator/sfValidatorInteger.class.php

@@ -34 +34 @@
-    $this->setMessage('min', '"%value%" must be greater than %min%.');
-    $this->setMessage('invalid', '"%value%" is not an integer.');
+
+    $this->setOption('min', null);
+    $this->setOption('max', null);
-  }
-
@@ -60 +63 @@
-    return $clean;
-  }
-
-  /**
-   * @see sfValidator
-   */
-  public function getErrorCodes()
-  {
-    return array_merge(parent::getErrorCodes(), array('max', 'min'));
-  }
-}

trunk/lib/validator/sfValidatorNumber.class.php

@@ -34 +34 @@
-    $this->setMessage('min', '"%value%" is too short (smallest allowed is %min%).');
-    $this->setMessage('invalid', '"%value%" is not a number.');
+
+    $this->setOption('min', null);
+    $this->setOption('max', null);
-  }
-
@@ -60 +63 @@
-    return $clean;
-  }
-
-  /**
-   * @see sfValidator
-   */
-  public function getErrorCodes()
-  {
-    return array_merge(parent::getErrorCodes(), array('max', 'min'));
-  }
-}

trunk/lib/validator/sfValidatorRegex.class.php

@@ -20 +20 @@
-{
-  /**
-struc
+figures the current valida
-   *
-   * Available options:
-   *
-
+ (required)
-   *
-   * @see sfValidator
-   */
-ublic function __construct
+rotected function configure
-  {
-
-
-
-
-
-
+
-  }
-
@@ -52 +47 @@
-    return $clean;
-  }
-
-  /**
-   * @see sfValidator
-   */
-  protected function getOptionsWithoutDefaults()
-  {
-    return parent::getOptionsWithoutDefaults(array('pattern' => array('--fake--')));
-  }
-
-  /**
-   * @see sfValidator
-   */
-  protected function getMessagesWithoutDefaults()
-  {
-    return parent::getMessagesWithoutDefaults(array('pattern' => array('--fake--')));
-  }
-}

trunk/lib/validator/sfValidatorSchema.class.php

@@ -70 +70 @@
-  public function configure($options = array(), $messages = array())
-  {
-options['allow_extra_fields']  = false
-options['filter_extra_fields'] = true
-
-messages['extra_fields'] = 'Extra field %field%.'
+setOption('allow_extra_fields', false)
+setOption('filter_extra_fields', true)
+
+setMessage('extra_fields', 'Extra field %field%.')
-  }
-
@@ -190 +190 @@
-
-  /**
-   * @see sfValidator
-   */
-  public function getErrorCodes()
-  {
-    return array_merge(parent::getErrorCodes(), array('extra_fields'));
-  }
-
-  /**
-   * Returns true if the schema has a field with the given name (implements the ArrayAccess interface).
-   *

trunk/lib/validator/sfValidatorSchemaCompare.class.php

@@ -48 +48 @@
-  public function __construct($leftField, $operator, $rightField, $options = array(), $messages = array())
-  {
-options['leftField']  = $leftField
-options['operator']   = $operator
-options['rightField'] = $rightField
+this->setOption('left_field', $leftField)
+this->setOption('operator', $operator)
+this->setOption('right_field', $rightField)
-
-    parent::__construct(null, $options, $messages);
-  }
-
-  /**
-   * @see sfValidator
-   */
-  public function clean($value)
-  {
-    return $this->doClean($value);
-  }
-
@@ -78 +70 @@
-    }
-
-Field')]) ? $values[$this->getOption('leftF
-Field')]) ? $values[$this->getOption('rightF
+_field')]) ? $values[$this->getOption('left_f
+_field')]) ? $values[$this->getOption('right_f
-
-    switch ($this->getOption('operator'))
@@ -120 +112 @@
-  public function asString($indent = 0)
-  {
-'--fake--', '--', '--fake--'
-'--fake--', '--', '--fake--'
-Field'], $options['operator'], $options['rightF
+
+
+_field'], $options['operator'], $options['right_f
-
-    $arguments = '';
@@ -135 +127 @@
-    return sprintf('%s%s %s%s %s',
-      str_repeat(' ', $indent),
-F
+_f
-      $this->getOption('operator'),
-      $arguments,
-F
+_f
-    );
-  }

trunk/lib/validator/sfValidatorSchemaFilter.class.php

@@ -31 +31 @@
-  public function __construct($field, sfValidator $validator, $options = array(), $messages = array())
-  {
-options['field']     = $field
-options['validator'] = $validator
+this->setOption('field', $field)
+this->setOption('validator', $validator)
-
-    parent::__construct(null, $options, $messages);
-  }
-
-  /**
-   * @see sfValidator
-   */
-  public function clean($value)
-  {
-    return $this->doClean($value);
-  }
-

trunk/lib/validator/sfValidatorString.class.php

@@ -34 +34 @@
-    $this->setMessage('min_length', '"%value%" is too short (%min_length% characters min).');
-
+    $this->setOption('max_length', null);
+    $this->setOption('min_length', null);
-    $this->setOption('empty_value', '');
-  }
@@ -58 +60 @@
-    return $clean;
-  }
-
-  /**
-   * @see sfValidator
-   */
-  public function getErrorCodes()
-  {
-    return array_merge(parent::getErrorCodes(), array('max_length', 'min_length'));
-  }
-}

trunk/lib/validator/sfValidatorUrl.class.php

@@ -22 +22 @@
-   * @see sfValidatorRegex
-   */
-__construct
+configure
-  {
-options['pattern'] =
+this->setOption('pattern',
-      https?://                               # http or https
-      (
@@ -33 +33 @@
-      (:[0-9]+)?                              # a port (optional)
-      (/?|/\S+)                               # a /, nothing or a / with something
-
-
-
+
-  }
-}

trunk/test/unit/validator/sfValidatorBooleanTest.php

@@ -11 +11 @@
-require_once(dirname(__FILE__).'/../../bootstrap/unit.php');
-
-7
+6
-
-$v = new sfValidatorBoolean();
-
-// ->getErrorCodes()
-$t->diag('->getErrorCodes()');
-$t->is($v->getErrorCodes(), array('required', 'invalid'), '->getErrorCodes() returns all possible error codes');
-
-// ->clean()

trunk/test/unit/validator/sfValidatorDateTest.php

@@ -11 +11 @@
-require_once(dirname(__FILE__).'/../../bootstrap/unit.php');
-
-6
+8
-
-$v = new sfValidatorDate();
-
-// ->getErrorCodes()
-$t->diag('->getErrorCodes()');
-$t->is($v->getErrorCodes(), array('required', 'invalid', 'date_format'), '->getErrorCodes() returns all possible error codes');
-
-// ->clean()
@@ -43 +39 @@
-$t->diag('validate timestamp');
-$t->is($v->clean(time()), date('Y-m-d', time()), '->clean() accepts timestamps as input');
+
+// validate date array
+$t->diag('validate date array');
+$t->is($v->clean(array('year' => 2005, 'month' => 10, 'day' => 15)), '2005-10-15', '->clean() accepts an array as an input');
+
+try
+{
+  $v->clean(array('year' => -2, 'month' => 1, 'day' => 15));
+  $t->fail('->clean() throws a sfValidatorError if the date is not valid');
+}
+catch (sfValidatorError $e)
+{
+  $t->pass('->clean() throws a sfValidatorError if the date is not valid');
+}
-
-// validate regex
@@ -77 +87 @@
-$t->diag('option with_time');
-$v->setOption('with_time', true);
+$t->is($v->clean(array('year' => 2005, 'month' => 10, 'day' => 15, 'hour' => 12, 'minute' => 10, 'second' => 15)), '2005-10-15 12:10:15', '->clean() accepts an array as an input');
-$t->is($v->clean('18 october 2005 12:30'), '2005-10-18 12:30:00', '->clean() can accept date time with the with_time option');
-$t->is($v->clean(time()), date('Y-m-d H:i:s', time()), '->clean() can accept date time with the with_time option');

trunk/test/unit/validator/sfValidatorDecoratorTest.php

@@ -11 +11 @@
-require_once(dirname(__FILE__).'/../../bootstrap/unit.php');
-
-5
+8
-
-class MyValidator extends sfValidatorDecorator
-{
-rotected
+ublic
-  {
-    return new sfValidatorString(array('min_length' => 2, 'trim' => true), array('required' => 'This string is required.'));
@@ -38 +38 @@
-}
-
+$v = new MyValidator();
+
-// ->getErrorCodes()
-$t->diag('->getErrorCodes()');
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-// ->getMessage() ->getMessages() ->setMessage() ->setMessages()
@@ -55 +69 @@
-$t->is($v->getOption('trim'), true, '->getOption() returns an option from the embedded validator');
-$v->setOption('trim', false);
-
+, 'max_length' => null
-$t->is($v->hasOption('min_length'), true, '->hasOption() returns true if the embedded validator has a given option');
-$v->setOptions(array('min_length' => 10));

trunk/test/unit/validator/sfValidatorFromDescriptionTest.php

@@ -104 +104 @@
-
-  'email:Email and (age:Integer({min: 18}) or (age:Integer({max: 18}) and is_young:Boolean({required: true})))',
-: 4, max
-invalid: "Passwords must be the same (%left_field% != %right_field%)"}) password_bis and begin_date <= end_date and password:String({min: 4, max
+_length: 4, max_length