<?php
/**
* @see https://github.com/laminas/laminas-validator for the canonical source repository
* @copyright https://github.com/laminas/laminas-validator/blob/master/COPYRIGHT.md
* @license https://github.com/laminas/laminas-validator/blob/master/LICENSE.md New BSD License
*/
namespace Laminas\Validator;
use Laminas\Stdlib\StringUtils;
use Laminas\Stdlib\StringWrapper\StringWrapperInterface as StringWrapper;
class StringLength extends AbstractValidator
{
const INVALID = 'stringLengthInvalid';
const TOO_SHORT = 'stringLengthTooShort';
const TOO_LONG = 'stringLengthTooLong';
/**
* @var array
*/
protected $messageTemplates = [
self::INVALID => "Invalid type given. String expected",
self::TOO_SHORT => "The input is less than %min% characters long",
self::TOO_LONG => "The input is more than %max% characters long",
];
/**
* @var array
*/
protected $messageVariables = [
'min' => ['options' => 'min'],
'max' => ['options' => 'max'],
'length' => ['options' => 'length']
];
protected $options = [
'min' => 0, // Minimum length
'max' => null, // Maximum length, null if there is no length limitation
'encoding' => 'UTF-8', // Encoding to use
'length' => 0 // Actual length
];
protected $stringWrapper;
/**
* Sets validator options
*
* @param int|array|\Traversable $options
*/
public function __construct($options = [])
{
if (! is_array($options)) {
$options = func_get_args();
$temp['min'] = array_shift($options);
if (! empty($options)) {
$temp['max'] = array_shift($options);
}
if (! empty($options)) {
$temp['encoding'] = array_shift($options);
}
$options = $temp;
}
parent::__construct($options);
}
/**
* Returns the min option
*
* @return int
*/
public function getMin()
{
return $this->options['min'];
}
/**
* Sets the min option
*
* @param int $min
* @throws Exception\InvalidArgumentException
* @return StringLength Provides a fluent interface
*/
public function setMin($min)
{
if (null !== $this->getMax() && $min > $this->getMax()) {
throw new Exception\InvalidArgumentException(
"The minimum must be less than or equal to the maximum length, but {$min} > {$this->getMax()}"
);
}
$this->options['min'] = max(0, (int) $min);
return $this;
}
/**
* Returns the max option
*
* @return int|null
*/
public function getMax()
{
return $this->options['max'];
}
/**
* Sets the max option
*
* @param int|null $max
* @throws Exception\InvalidArgumentException
* @return StringLength Provides a fluent interface
*/
public function setMax($max)
{
if (null === $max) {
$this->options['max'] = null;
} elseif ($max < $this->getMin()) {
throw new Exception\InvalidArgumentException(
"The maximum must be greater than or equal to the minimum length, but {$max} < {$this->getMin()}"
);
} else {
$this->options['max'] = (int) $max;
}
return $this;
}
/**
* Get the string wrapper to detect the string length
*
* @return StringWrapper
*/
public function getStringWrapper()
{
if (! $this->stringWrapper) {
$this->stringWrapper = StringUtils::getWrapper($this->getEncoding());
}
return $this->stringWrapper;
}
/**
* Set the string wrapper to detect the string length
*
* @param StringWrapper $stringWrapper
* @return StringLength
*/
public function setStringWrapper(StringWrapper $stringWrapper)
{
$stringWrapper->setEncoding($this->getEncoding());
$this->stringWrapper = $stringWrapper;
}
/**
* Returns the actual encoding
*
* @return string
*/
public function getEncoding()
{
return $this->options['encoding'];
}
/**
* Sets a new encoding to use
*
* @param string $encoding
* @return StringLength
* @throws Exception\InvalidArgumentException
*/
public function setEncoding($encoding)
{
$this->stringWrapper = StringUtils::getWrapper($encoding);
$this->options['encoding'] = $encoding;
return $this;
}
/**
* Returns the length option
*
* @return int
*/
private function getLength()
{
return $this->options['length'];
}
/**
* Sets the length option
*
* @param int $length
* @return StringLength Provides a fluent interface
*/
private function setLength($length)
{
$this->options['length'] = (int) $length;
return $this;
}
/**
* Returns true if and only if the string length of $value is at least the min option and
* no greater than the max option (when the max option is not null).
*
* @param string $value
* @return bool
*/
public function isValid($value)
{
if (! is_string($value)) {
$this->error(self::INVALID);
return false;
}
$this->setValue($value);
$this->setLength($this->getStringWrapper()->strlen($value));
if ($this->getLength() < $this->getMin()) {
$this->error(self::TOO_SHORT);
}
if (null !== $this->getMax() && $this->getMax() < $this->getLength()) {
$this->error(self::TOO_LONG);
}
if ($this->getMessages()) {
return false;
}
return true;
}
}