1. sfValidatorTime.class.php
  2. /**
 * sfValidatorTime validates a time. It also converts the input value to a valid time.
 *
 * @package    symfony
 * @subpackage validator
 * @author     Fabien Potencier 
 * @author     Fabian Lange 
 * @version    SVN: $Id: sfValidatorTime.class.php 23810 2009-11-12 11:07:44Z Kris.Wallsmith $
 */
  3. class sfValidatorTime extends sfValidatorBase
  4. {
  5.   /**
  6.    * Configures the current validator.
  7.    *
  8.    * Available options:
  9.    *
  10.    *  * time_format:       A regular expression that dates must match
  11.    *  * time_output:       The format to use when returning a date with time (default to H:i:s)
  12.    *  * time_format_error: The date format to use when displaying an error for a bad_format error
  13.    *
  14.    * Available error codes:
  15.    *
  16.    *  * bad_format
  17.    *
  18.    * @param array $options    An array of options
  19.    * @param array $messages   An array of error messages
  20.    *
  21.    * @see sfValidatorBase
  22.    */
  23.   protected function configure($options = array(), $messages = array())
  24.   {
  25.     $this->addMessage('bad_format', '"%value%" does not match the time format (%time_format%).');
  27.     $this->addOption('time_format', null);
  28.     $this->addOption('time_output', 'H:i:s');
  29.     $this->addOption('time_format_error');
  30.   }
  32.   /**
  33.    * @see sfValidatorBase
  34.    */
  35.   protected function doClean($value)
  36.   {
  37.     if (is_array($value))
  38.     {
  39.       $clean = $this->convertTimeArrayToTimestamp($value);
  40.     }
  41.     else if ($regex = $this->getOption('time_format'))
  42.     {
  43.       if (!preg_match($regex, $value, $match))
  44.       {
  45.         throw new sfValidatorError($this, 'bad_format', array('value' => $value, 'time_format' => $this->getOption('time_format_error') ? $this->getOption('time_format_error') : $this->getOption('time_format')));
  46.       }
  48.       $clean = $this->convertTimeArrayToTimestamp($match);
  49.     }
  50.     else if (!ctype_digit($value))
  51.     {
  52.       $clean = strtotime($value);
  53.       if (false === $clean)
  54.       {
  55.         throw new sfValidatorError($this, 'invalid', array('value' => $value));
  56.       }
  57.     }
  58.     else
  59.     {
  60.       $clean = (integer) $value;
  61.     }
  63.     return $clean === $this->getEmptyValue() ? $clean : date($this->getOption('time_output'), $clean);
  64.   }
  66.   /**
  67.    * Converts an array representing a time to a timestamp.
  68.    *
  69.    * The array can contains the following keys: hour, minute, second
  70.    *
  71.    * @param  array $value  An array of date elements
  72.    *
  73.    * @return int A timestamp
  74.    */
  75.   protected function convertTimeArrayToTimestamp($value)
  76.   {
  77.     // all elements must be empty or a number
  78.     foreach (array('hour', 'minute', 'second') as $key)
  79.     {
  80.       if (isset($value[$key]) && !preg_match('#^\d+$#', $value[$key]) && !empty($value[$key]))
  81.       {
  82.         throw new sfValidatorError($this, 'invalid', array('value' => $value));
  83.       }
  84.     }
  86.     // if second is set, minute and hour must be set
  87.     // if minute is set, hour must be set
  88.     if (
  89.       $this->isValueSet($value, 'second') && (!$this->isValueSet($value, 'minute') || !$this->isValueSet($value, 'hour'))
  90.       ||
  91.       $this->isValueSet($value, 'minute') && !$this->isValueSet($value, 'hour')
  92.     )
  93.     {
  94.       throw new sfValidatorError($this, 'invalid', array('value' => $value));
  95.     }
  97.     $clean = mktime(
  98.       isset($value['hour']) ? intval($value['hour']) : 0,
  99.       isset($value['minute']) ? intval($value['minute']) : 0,
  100.       isset($value['second']) ? intval($value['second']) : 0
  101.     );
  103.     if (false === $clean)
  104.     {
  105.       throw new sfValidatorError($this, 'invalid', array('value' => var_export($value, true)));
  106.     }
  108.     return $clean;
  109.   }
  111.   protected function isValueSet($values, $key)
  112.   {
  113.     return isset($values[$key]) && !in_array($values[$key], array(null, ''), true);
  114.   }
  116.   /**
  117.    * @see sfValidatorBase
  118.    */
  119.   protected function isEmpty($value)
  120.   {
  121.     if (is_array($value))
  122.     {
  123.       // array is not empty when a value is found
  124.       foreach($value as $key => $val)
  125.       {
  126.         // int and string '0' are 'empty' values that are explicitly accepted
  127.         if ($val === 0 || $val === '0' || !empty($val)) return false;
  128.       }
  129.       return true;
  130.     }
  132.     return parent::isEmpty($value);
  133.   }
  134. }
Debug toolbar