1. sfValidatorDate.class.php
  2. /**
 * sfValidatorDate validates a date. It also converts the input value to a valid date.
 *
 * @package    symfony
 * @subpackage validator
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfValidatorDate.class.php 26871 2010-01-19 10:43:09Z fabien $
 */
  3. class sfValidatorDate extends sfValidatorBase
  4. {
  5.   /**
  6.    * Configures the current validator.
  7.    *
  8.    * Available options:
  9.    *
  10.    *  * date_format:             A regular expression that dates must match
  11.    *  * with_time:               true if the validator must return a time, false otherwise
  12.    *  * date_output:             The format to use when returning a date (default to Y-m-d)
  13.    *  * datetime_output:         The format to use when returning a date with time (default to Y-m-d H:i:s)
  14.    *  * date_format_error:       The date format to use when displaying an error for a bad_format error (use date_format if not provided)
  15.    *  * max:                     The maximum date allowed (as a timestamp or accecpted date() format)
  16.    *  * min:                     The minimum date allowed (as a timestamp or accecpted date() format)
  17.    *  * date_format_range_error: The date format to use when displaying an error for min/max (default to d/m/Y H:i:s)
  18.    *
  19.    * Available error codes:
  20.    *
  21.    *  * bad_format
  22.    *  * min
  23.    *  * max
  24.    *
  25.    * @param array $options    An array of options
  26.    * @param array $messages   An array of error messages
  27.    *
  28.    * @see sfValidatorBase
  29.    */
  30.   protected function configure($options = array(), $messages = array())
  31.   {
  32.     $this->addMessage('bad_format', '"%value%" does not match the date format (%date_format%).');
  33.     $this->addMessage('max', 'The date must be before %max%.');
  34.     $this->addMessage('min', 'The date must be after %min%.');
  36.     $this->addOption('date_format', null);
  37.     $this->addOption('with_time', false);
  38.     $this->addOption('date_output', 'Y-m-d');
  39.     $this->addOption('datetime_output', 'Y-m-d H:i:s');
  40.     $this->addOption('date_format_error');
  41.     $this->addOption('min', null);
  42.     $this->addOption('max', null);
  43.     $this->addOption('date_format_range_error', 'd/m/Y H:i:s');
  44.   }
  46.   /**
  47.    * @see sfValidatorBase
  48.    */
  49.   protected function doClean($value)
  50.   {
  51.     // check date format
  52.     if (is_string($value) && $regex = $this->getOption('date_format'))
  53.     {
  54.       if (!preg_match($regex, $value, $match))
  55.       {
  56.         throw new sfValidatorError($this, 'bad_format', array('value' => $value, 'date_format' => $this->getOption('date_format_error') ? $this->getOption('date_format_error') : $this->getOption('date_format')));
  57.       }
  59.       $value = $match;
  60.     }
  62.     // convert array to date string
  63.     if (is_array($value))
  64.     {
  65.       $value = $this->convertDateArrayToString($value);
  66.     }
  68.     // convert timestamp to date number format
  69.     if (is_numeric($value))
  70.     {
  71.       $cleanTime = (integer) $value;
  72.       $clean     = date('YmdHis', $cleanTime);
  73.     }
  74.     // convert string to date number format
  75.     else
  76.     {
  77.       try
  78.       {
  79.         $date = new DateTime($value);
  80.         $date->setTimezone(new DateTimeZone(date_default_timezone_get()));
  81.         $clean = $date->format('YmdHis');
  82.       }
  83.       catch (Exception $e)
  84.       {
  85.         throw new sfValidatorError($this, 'invalid', array('value' => $value));
  86.       }
  87.     }
  89.     // check max
  90.     if ($max = $this->getOption('max'))
  91.     {
  92.       // convert timestamp to date number format
  93.       if (is_numeric($max))
  94.       {
  95.         $maxError = date($this->getOption('date_format_range_error'), $max);
  96.         $max      = date('YmdHis', $max);
  97.       }
  98.       // convert string to date number
  99.       else
  100.       {
  101.         $dateMax  = new DateTime($max);
  102.         $max      = $dateMax->format('YmdHis');
  103.         $maxError = $dateMax->format($this->getOption('date_format_range_error'));
  104.       }
  106.       if ($clean > $max)
  107.       {
  108.         throw new sfValidatorError($this, 'max', array('value' => $value, 'max' => $maxError));
  109.       }
  110.     }
  112.     // check min
  113.     if ($min = $this->getOption('min'))
  114.     {
  115.       // convert timestamp to date number
  116.       if (is_numeric($min))
  117.       {
  118.         $minError = date($this->getOption('date_format_range_error'), $min);
  119.         $min      = date('YmdHis', $min);
  120.       }
  121.       // convert string to date number
  122.       else
  123.       {
  124.         $dateMin  = new DateTime($min);
  125.         $min      = $dateMin->format('YmdHis');
  126.         $minError = $dateMin->format($this->getOption('date_format_range_error'));
  127.       }
  129.       if ($clean < $min)
  130.       {
  131.         throw new sfValidatorError($this, 'min', array('value' => $value, 'min' => $minError));
  132.       }
  133.     }
  135.     if ($clean === $this->getEmptyValue())
  136.     {
  137.       return $cleanTime;
  138.     }
  140.     $format = $this->getOption('with_time') ? $this->getOption('datetime_output') : $this->getOption('date_output');
  142.     return isset($date) ? $date->format($format) : date($format, $cleanTime);
  143.   }
  145.   /**
  146.    * Converts an array representing a date to a timestamp.
  147.    *
  148.    * The array can contains the following keys: year, month, day, hour, minute, second
  149.    *
  150.    * @param  array $value  An array of date elements
  151.    *
  152.    * @return int A timestamp
  153.    */
  154.   protected function convertDateArrayToString($value)
  155.   {
  156.     // all elements must be empty or a number
  157.     foreach (array('year', 'month', 'day', 'hour', 'minute', 'second') as $key)
  158.     {
  159.       if (isset($value[$key]) && !preg_match('#^\d+$#', $value[$key]) && !empty($value[$key]))
  160.       {
  161.         throw new sfValidatorError($this, 'invalid', array('value' => $value));
  162.       }
  163.     }
  165.     // if one date value is empty, all others must be empty too
  166.     $empties =
  167.       (!isset($value['year']) || !$value['year'] ? 1 : 0) +
  168.       (!isset($value['month']) || !$value['month'] ? 1 : 0) +
  169.       (!isset($value['day']) || !$value['day'] ? 1 : 0)
  170.     ;
  171.     if ($empties > 0 && $empties < 3)
  172.     {
  173.       throw new sfValidatorError($this, 'invalid', array('value' => $value));
  174.     }
  175.     else if (3 == $empties)
  176.     {
  177.       return $this->getEmptyValue();
  178.     }
  180.     if (!checkdate(intval($value['month']), intval($value['day']), intval($value['year'])))
  181.     {
  182.       throw new sfValidatorError($this, 'invalid', array('value' => $value));
  183.     }
  185.     if ($this->getOption('with_time'))
  186.     {
  187.       // if second is set, minute and hour must be set
  188.       // if minute is set, hour must be set
  189.       if (
  190.         $this->isValueSet($value, 'second') && (!$this->isValueSet($value, 'minute') || !$this->isValueSet($value, 'hour'))
  191.         ||
  192.         $this->isValueSet($value, 'minute') && !$this->isValueSet($value, 'hour')
  193.       )
  194.       {
  195.         throw new sfValidatorError($this, 'invalid', array('value' => $value));
  196.       }
  198.       $clean = sprintf(
  199.         "%04d-%02d-%02d %02d:%02d:%02d",
  200.         intval($value['year']),
  201.         intval($value['month']),
  202.         intval($value['day']),
  203.         isset($value['hour']) ? intval($value['hour']) : 0,
  204.         isset($value['minute']) ? intval($value['minute']) : 0,
  205.         isset($value['second']) ? intval($value['second']) : 0
  206.       );
  207.     }
  208.     else
  209.     {
  210.       $clean = sprintf(
  211.         "%04d-%02d-%02d %02d:%02d:%02d",
  212.         intval($value['year']),
  213.         intval($value['month']),
  214.         intval($value['day']),
  215.         0,
  216.         0,
  217.         0
  218.       );
  219.     }
  221.     return $clean;
  222.   }
  224.   protected function isValueSet($values, $key)
  225.   {
  226.     return isset($values[$key]) && !in_array($values[$key], array(null, ''), true);
  227.   }
  229.   /**
  230.    * @see sfValidatorBase
  231.    */
  232.   protected function isEmpty($value)
  233.   {
  234.     if (is_array($value))
  235.     {
  236.       $filtered = array_filter($value);
  238.       return empty($filtered);
  239.     }
  241.     return parent::isEmpty($value);
  242.   }
  243. }
Debug toolbar