mirror of
https://github.com/yiisoft/yii2.git
synced 2026-03-06 15:28:58 +01:00
Moved "framework" to "iii".
This commit is contained in:
@@ -1,174 +0,0 @@
|
||||
<?php
|
||||
/**
|
||||
* @link http://www.yiiframework.com/
|
||||
* @copyright Copyright (c) 2008 Yii Software LLC
|
||||
* @license http://www.yiiframework.com/license/
|
||||
*/
|
||||
|
||||
namespace yii\validators;
|
||||
|
||||
use Yii;
|
||||
use yii\helpers\Html;
|
||||
|
||||
/**
|
||||
* StringValidator validates that the attribute value is of certain length.
|
||||
*
|
||||
* Note, this validator should only be used with string-typed attributes.
|
||||
*
|
||||
* @author Qiang Xue <qiang.xue@gmail.com>
|
||||
* @since 2.0
|
||||
*/
|
||||
class StringValidator extends Validator
|
||||
{
|
||||
/**
|
||||
* @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;
|
||||
/**
|
||||
* @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]].
|
||||
*/
|
||||
public $tooShort;
|
||||
/**
|
||||
* @var string user-defined error message used when the length of the value is greater than [[max]].
|
||||
*/
|
||||
public $tooLong;
|
||||
/**
|
||||
* @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.
|
||||
*/
|
||||
public $encoding;
|
||||
|
||||
|
||||
/**
|
||||
* Initializes the validator.
|
||||
*/
|
||||
public function init()
|
||||
{
|
||||
parent::init();
|
||||
if ($this->encoding === null) {
|
||||
$this->encoding = Yii::$app->charset;
|
||||
}
|
||||
if ($this->message === null) {
|
||||
$this->message = Yii::t('yii|{attribute} must be a string.');
|
||||
}
|
||||
if ($this->min !== null && $this->tooShort === null) {
|
||||
$this->tooShort = Yii::t('yii|{attribute} should contain at least {min} characters.');
|
||||
}
|
||||
if ($this->max !== null && $this->tooLong === null) {
|
||||
$this->tooLong = Yii::t('yii|{attribute} should contain at most {max} characters.');
|
||||
}
|
||||
if ($this->is !== null && $this->notEqual === null) {
|
||||
$this->notEqual = Yii::t('yii|{attribute} should contain {length} characters.');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Validates the attribute of the object.
|
||||
* If there is any error, the error message is added to the object.
|
||||
* @param \yii\base\Model $object the object being validated
|
||||
* @param string $attribute the attribute being validated
|
||||
*/
|
||||
public function validateAttribute($object, $attribute)
|
||||
{
|
||||
$value = $object->$attribute;
|
||||
|
||||
if (!is_string($value)) {
|
||||
$this->addError($object, $attribute, $this->message);
|
||||
return;
|
||||
}
|
||||
|
||||
$length = mb_strlen($value, $this->encoding);
|
||||
|
||||
if ($this->min !== null && $length < $this->min) {
|
||||
$this->addError($object, $attribute, $this->tooShort, array('{min}' => $this->min));
|
||||
}
|
||||
if ($this->max !== null && $length > $this->max) {
|
||||
$this->addError($object, $attribute, $this->tooLong, array('{max}' => $this->max));
|
||||
}
|
||||
if ($this->is !== null && $length !== $this->is) {
|
||||
$this->addError($object, $attribute, $this->notEqual, 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);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the JavaScript needed for performing client-side validation.
|
||||
* @param \yii\base\Model $object the data object being validated
|
||||
* @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);
|
||||
$value = $object->$attribute;
|
||||
|
||||
$options = array(
|
||||
'message' => Html::encode(strtr($this->message, array(
|
||||
'{attribute}' => $label,
|
||||
'{value}' => $value,
|
||||
))),
|
||||
);
|
||||
|
||||
if ($this->min !== null) {
|
||||
$options['min'] = $this->min;
|
||||
$options['tooShort'] = Html::encode(strtr($this->tooShort, array(
|
||||
'{attribute}' => $label,
|
||||
'{value}' => $value,
|
||||
'{min}' => $this->min,
|
||||
)));
|
||||
}
|
||||
if ($this->max !== null) {
|
||||
$options['max'] = $this->max;
|
||||
$options['tooLong'] = Html::encode(strtr($this->tooLong, array(
|
||||
'{attribute}' => $label,
|
||||
'{value}' => $value,
|
||||
'{max}' => $this->max,
|
||||
)));
|
||||
}
|
||||
if ($this->is !== null) {
|
||||
$options['is'] = $this->is;
|
||||
$options['notEqual'] = Html::encode(strtr($this->notEqual, array(
|
||||
'{attribute}' => $label,
|
||||
'{value}' => $value,
|
||||
'{length}' => $this->is,
|
||||
)));
|
||||
}
|
||||
if ($this->skipOnEmpty) {
|
||||
$options['skipOnEmpty'] = 1;
|
||||
}
|
||||
|
||||
return 'yii.validation.string(value, messages, ' . json_encode($options) . ');';
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user