You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

189 lines
5.0 KiB

14 years ago
<?php
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
14 years ago
* @license http://www.yiiframework.com/license/
*/
14 years ago
namespace yii\validators;
use Yii;
14 years ago
/**
14 years ago
* StringValidator validates that the attribute value is of certain length.
14 years ago
*
* Note, this validator should only be used with string-typed attributes.
*
* @author Qiang Xue <qiang.xue@gmail.com>
14 years ago
* @since 2.0
14 years ago
*/
14 years ago
class StringValidator extends Validator
14 years ago
{
/**
* @var integer maximum length. Defaults to null, meaning no maximum limit.
*/
public $max;
/**
* @var integer minimum length. Defaults to null, meaning no minimum limit.
*/
public $min;
/**
* @var integer exact length. Defaults to null, meaning no exact length limit.
*/
public $is;
/**
14 years ago
* @var string user-defined error message used when the value is not a string
*/
public $message;
/**
* @var string user-defined error message used when the length of the value is smaller than [[min]].
14 years ago
*/
public $tooShort;
/**
14 years ago
* @var string user-defined error message used when the length of the value is greater than [[max]].
14 years ago
*/
public $tooLong;
/**
14 years ago
* @var string user-defined error message used when the length of the value is not equal to [[is]].
*/
public $notEqual;
/**
* @var string the encoding of the string value to be validated (e.g. 'UTF-8').
* If this property is not set, [[\yii\base\Application::charset]] will be used.
14 years ago
*/
public $encoding;
14 years ago
/**
* Initializes the validator.
14 years ago
*/
public function init()
{
parent::init();
if ($this->encoding === null) {
$this->encoding = Yii::$app->charset;
}
}
14 years ago
/**
* Validates the attribute of the object.
* If there is any error, the error message is added to the object.
14 years ago
* @param \yii\base\Model $object the object being validated
14 years ago
* @param string $attribute the attribute being validated
*/
14 years ago
public function validateAttribute($object, $attribute)
14 years ago
{
$value = $object->$attribute;
14 years ago
if (!is_string($value)) {
$message = ($this->message !== null) ? $this->message : Yii::t('yii|{attribute} must be a string.');
14 years ago
$this->addError($object, $attribute, $message);
14 years ago
return;
14 years ago
}
14 years ago
$length = mb_strlen($value, $this->encoding);
14 years ago
14 years ago
if ($this->min !== null && $length < $this->min) {
$message = ($this->tooShort !== null) ? $this->tooShort : Yii::t('yii|{attribute} should contain at least {min} characters.');
14 years ago
$this->addError($object, $attribute, $message, array('{min}' => $this->min));
}
14 years ago
if ($this->max !== null && $length > $this->max) {
$message = ($this->tooLong !== null) ? $this->tooLong : Yii::t('yii|{attribute} should contain at most {max} characters.');
14 years ago
$this->addError($object, $attribute, $message, array('{max}' => $this->max));
}
14 years ago
if ($this->is !== null && $length !== $this->is) {
$message = ($this->notEqual !== null) ? $this->notEqual : Yii::t('yii|{attribute} should contain {length} characters.');
14 years ago
$this->addError($object, $attribute, $message, array('{length}' => $this->is));
}
}
/**
* Validates the given value.
* @param mixed $value the value to be validated.
* @return boolean whether the value is valid.
*/
public function validateValue($value)
{
if (!is_string($value)) {
return false;
}
$length = mb_strlen($value, $this->encoding);
return ($this->min === null || $length >= $this->min)
&& ($this->max === null || $length <= $this->max)
&& ($this->is === null || $length === $this->is);
}
/**
14 years ago
* Returns the JavaScript needed for performing client-side validation.
14 years ago
* @param \yii\base\Model $object the data object being validated
14 years ago
* @param string $attribute the name of the attribute to be validated.
* @return string the client-side validation script.
*/
public function clientValidateAttribute($object, $attribute)
{
$label = $object->getAttributeLabel($attribute);
14 years ago
$value = $object->$attribute;
14 years ago
14 years ago
if (($notEqual = $this->notEqual) === null) {
$notEqual = Yii::t('yii|{attribute} should contain {length} characters.');
14 years ago
}
$notEqual = strtr($notEqual, array(
14 years ago
'{attribute}' => $label,
14 years ago
'{value}' => $value,
14 years ago
'{length}' => $this->is,
));
14 years ago
if (($tooShort = $this->tooShort) === null) {
$tooShort = Yii::t('yii|{attribute} should contain at least {min} characters.');
14 years ago
}
14 years ago
$tooShort = strtr($tooShort, array(
'{attribute}' => $label,
14 years ago
'{value}' => $value,
14 years ago
'{min}' => $this->min,
));
14 years ago
if (($tooLong = $this->tooLong) === null) {
$tooLong = Yii::t('yii|{attribute} should contain at most {max} characters.');
14 years ago
}
14 years ago
$tooLong = strtr($tooLong, array(
'{attribute}' => $label,
14 years ago
'{value}' => $value,
14 years ago
'{max}' => $this->max,
));
$js = '';
14 years ago
if ($this->min !== null) {
14 years ago
$js .= "
if(value.length< {$this->min}) {
14 years ago
messages.push(" . json_encode($tooShort) . ");
14 years ago
}
";
}
14 years ago
if ($this->max !== null) {
14 years ago
$js .= "
if(value.length> {$this->max}) {
14 years ago
messages.push(" . json_encode($tooLong) . ");
14 years ago
}
";
}
14 years ago
if ($this->is !== null) {
14 years ago
$js .= "
if(value.length!= {$this->is}) {
14 years ago
messages.push(" . json_encode($notEqual) . ");
14 years ago
}
";
}
14 years ago
if ($this->allowEmpty) {
14 years ago
$js = "
if($.trim(value)!='') {
$js
}
";
}
return $js;
}
}