1. sfValidatorChoice.class.php
  2. /**
 * sfValidatorChoice validates than the value is one of the expected values.
 *
 * @package    symfony
 * @subpackage validator
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfValidatorChoice.class.php 22264 2009-09-23 05:54:32Z fabien $
 */
  3. class sfValidatorChoice extends sfValidatorBase
  4. {
  5.   /**
  6.    * Configures the current validator.
  7.    *
  8.    * Available options:
  9.    *
  10.    *  * choices:  An array of expected values (required)
  11.    *  * multiple: true if the select tag must allow multiple selections
  12.    *  * min:      The minimum number of values that need to be selected (this option is only active if multiple is true)
  13.    *  * max:      The maximum number of values that need to be selected (this option is only active if multiple is true)
  14.    *
  15.    * @param array $options    An array of options
  16.    * @param array $messages   An array of error messages
  17.    *
  18.    * @see sfValidatorBase
  19.    */
  20.   protected function configure($options = array(), $messages = array())
  21.   {
  22.     $this->addRequiredOption('choices');
  23.     $this->addOption('multiple', false);
  24.     $this->addOption('min');
  25.     $this->addOption('max');
  27.     $this->addMessage('min', 'At least %min% values must be selected (%count% values selected).');
  28.     $this->addMessage('max', 'At most %max% values must be selected (%count% values selected).');
  29.   }
  31.   /**
  32.    * @see sfValidatorBase
  33.    */
  34.   protected function doClean($value)
  35.   {
  36.     $choices = $this->getChoices();
  38.     if ($this->getOption('multiple'))
  39.     {
  40.       $value = $this->cleanMultiple($value, $choices);
  41.     }
  42.     else
  43.     {
  44.       if (!self::inChoices($value, $choices))
  45.       {
  46.         throw new sfValidatorError($this, 'invalid', array('value' => $value));
  47.       }
  48.     }
  50.     return $value;
  51.   }
  53.   public function getChoices()
  54.   {
  55.     $choices = $this->getOption('choices');
  56.     if ($choices instanceof sfCallable)
  57.     {
  58.       $choices = $choices->call();
  59.     }
  61.     return $choices;
  62.   }
  64.   /**
  65.    * Cleans a value when multiple is true.
  66.    *
  67.    * @param  mixed $value The submitted value
  68.    *
  69.    * @return array The cleaned value
  70.    */
  71.   protected function cleanMultiple($value, $choices)
  72.   {
  73.     if (!is_array($value))
  74.     {
  75.       $value = array($value);
  76.     }
  78.     foreach ($value as $v)
  79.     {
  80.       if (!self::inChoices($v, $choices))
  81.       {
  82.         throw new sfValidatorError($this, 'invalid', array('value' => $v));
  83.       }
  84.     }
  86.     $count = count($value);
  88.     if ($this->hasOption('min') && $count < $this->getOption('min'))
  89.     {
  90.       throw new sfValidatorError($this, 'min', array('count' => $count, 'min' => $this->getOption('min')));
  91.     }
  93.     if ($this->hasOption('max') && $count > $this->getOption('max'))
  94.     {
  95.       throw new sfValidatorError($this, 'max', array('count' => $count, 'max' => $this->getOption('max')));
  96.     }
  98.     return $value;
  99.   }
  101.   /**
  102.    * Checks if a value is part of given choices (see bug #4212)
  103.    *
  104.    * @param  mixed $value   The value to check
  105.    * @param  array $choices The array of available choices
  106.    *
  107.    * @return Boolean
  108.    */
  109.   static protected function inChoices($value, array $choices = array())
  110.   {
  111.     foreach ($choices as $choice)
  112.     {
  113.       if ((string) $choice == (string) $value)
  114.       {
  115.         return true;
  116.       }
  117.     }
  119.     return false;
  120.   }
  121. }
Debug toolbar