interface/modules/zend_modules/library/Zend/Validator/StringLength.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Validator;
  11
  12 use Zend\Stdlib\StringUtils;
  13 use Zend\Stdlib\StringWrapper\StringWrapperInterface as StringWrapper;
  14
  15 class StringLength extends AbstractValidator
  16 {
  17     const INVALID   = 'stringLengthInvalid';
  18     const TOO_SHORT = 'stringLengthTooShort';
  19     const TOO_LONG  = 'stringLengthTooLong';
  20
  21     /**
  22      * @var array
  23      */
  24     protected $messageTemplates = array(
  25         self::INVALID   => "Invalid type given. String expected",
  26         self::TOO_SHORT => "The input is less than %min% characters long",
  27         self::TOO_LONG  => "The input is more than %max% characters long",
  28     );
  29
  30     /**
  31      * @var array
  32      */
  33     protected $messageVariables = array(
  34         'min' => array('options' => 'min'),
  35         'max' => array('options' => 'max'),
  36     );
  37
  38     protected $options = array(
  39         'min'      => 0,       // Minimum length
  40         'max'      => null,    // Maximum length, null if there is no length limitation
  41         'encoding' => 'UTF-8', // Encoding to use
  42     );
  43
  44     protected $stringWrapper;
  45
  46     /**
  47      * Sets validator options
  48      *
  49      * @param  int|array|\Traversable $options
  50      */
  51     public function __construct($options = array())
  52     {
  53         if (!is_array($options)) {
  54             $options     = func_get_args();
  55             $temp['min'] = array_shift($options);
  56             if (!empty($options)) {
  57                 $temp['max'] = array_shift($options);
  58             }
  59
  60             if (!empty($options)) {
  61                 $temp['encoding'] = array_shift($options);
  62             }
  63
  64             $options = $temp;
  65         }
  66
  67         parent::__construct($options);
  68     }
  69
  70     /**
  71      * Returns the min option
  72      *
  73      * @return int
  74      */
  75     public function getMin()
  76     {
  77         return $this->options['min'];
  78     }
  79
  80     /**
  81      * Sets the min option
  82      *
  83      * @param  int $min
  84      * @throws Exception\InvalidArgumentException
  85      * @return StringLength Provides a fluent interface
  86      */
  87     public function setMin($min)
  88     {
  89         if (null !== $this->getMax() && $min > $this->getMax()) {
  90             throw new Exception\InvalidArgumentException("The minimum must be less than or equal to the maximum length, but $min >"
  91                                             . " " . $this->getMax());
  92         }
  93
  94         $this->options['min'] = max(0, (int) $min);
  95         return $this;
  96     }
  97
  98     /**
  99      * Returns the max option
 100      *
 101      * @return int|null
 102      */
 103     public function getMax()
 104     {
 105         return $this->options['max'];
 106     }
 107
 108     /**
 109      * Sets the max option
 110      *
 111      * @param  int|null $max
 112      * @throws Exception\InvalidArgumentException
 113      * @return StringLength Provides a fluent interface
 114      */
 115     public function setMax($max)
 116     {
 117         if (null === $max) {
 118             $this->options['max'] = null;
 119         } elseif ($max < $this->getMin()) {
 120             throw new Exception\InvalidArgumentException("The maximum must be greater than or equal to the minimum length, but "
 121                                             . "$max < " . $this->getMin());
 122         } else {
 123             $this->options['max'] = (int) $max;
 124         }
 125
 126         return $this;
 127     }
 128
 129     /**
 130      * Get the string wrapper to detect the string length
 131      *
 132      * @return StringWrapper
 133      */
 134     public function getStringWrapper()
 135     {
 136         if (!$this->stringWrapper) {
 137             $this->stringWrapper = StringUtils::getWrapper($this->getEncoding());
 138         }
 139         return $this->stringWrapper;
 140     }
 141
 142     /**
 143      * Set the string wrapper to detect the string length
 144      *
 145      * @param StringWrapper $stringWrapper
 146      * @return StringLength
 147      */
 148     public function setStringWrapper(StringWrapper $stringWrapper)
 149     {
 150         $stringWrapper->setEncoding($this->getEncoding());
 151         $this->stringWrapper = $stringWrapper;
 152     }
 153
 154     /**
 155      * Returns the actual encoding
 156      *
 157      * @return string
 158      */
 159     public function getEncoding()
 160     {
 161         return $this->options['encoding'];
 162     }
 163
 164     /**
 165      * Sets a new encoding to use
 166      *
 167      * @param string $encoding
 168      * @return StringLength
 169      * @throws Exception\InvalidArgumentException
 170      */
 171     public function setEncoding($encoding)
 172     {
 173         $this->stringWrapper = StringUtils::getWrapper($encoding);
 174         $this->options['encoding'] = $encoding;
 175         return $this;
 176     }
 177
 178     /**
 179      * Returns true if and only if the string length of $value is at least the min option and
 180      * no greater than the max option (when the max option is not null).
 181      *
 182      * @param  string $value
 183      * @return bool
 184      */
 185     public function isValid($value)
 186     {
 187         if (!is_string($value)) {
 188             $this->error(self::INVALID);
 189             return false;
 190         }
 191
 192         $this->setValue($value);
 193
 194         $length = $this->getStringWrapper()->strlen($value);
 195         if ($length < $this->getMin()) {
 196             $this->error(self::TOO_SHORT);
 197         }
 198
 199         if (null !== $this->getMax() && $this->getMax() < $length) {
 200             $this->error(self::TOO_LONG);
 201         }
 202
 203         if (count($this->getMessages())) {
 204             return false;
 205         }
 206
 207         return true;
 208     }
 209 }