0 关注者

类 yii\validators\DateValidator

继承关系yii\validators\DateValidator » yii\validators\Validator » yii\base\Component » yii\base\BaseObject
实现接口yii\base\Configurable
版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/validators/DateValidator.php

DateValidator 验证属性是否代表一个日期,时间或日期时间,并使用正确的 $format 格式。

它还可以解析特定 $locale 的国际化日期,例如 12 мая 2014,当 $format 被配置为使用 ICU 格式的时间模式时。

还可以使用 $min$max 将日期限制在特定范围内。

除了验证日期之外,它还可以将解析后的时间戳导出为机器可读的格式,该格式可以使用 $timestampAttribute 配置。对于包含时间信息的 value(而不是仅日期 value),还会调整时区。输入 value 的时区被假定为由 $timeZone 属性指定,目标时区将为 UTC,当 $timestampAttributeFormatnull(导出为 UNIX 时间戳)或 $timestampAttributeTimeZone 为其他值时。如果你想避免时区转换,请确保 $timeZone$timestampAttributeTimeZone 相同。

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$attributeNames array 属性名称。 yii\validators\Validator
$attributes array|string 要由此验证器验证的属性。 yii\validators\Validator
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$builtInValidators array 内置验证器列表(名称 => 类或配置) yii\validators\Validator
$defaultTimeZone string 当格式中没有提供时间部分时,用于解析的默认时区。 yii\validators\DateValidator
$enableClientValidation boolean 是否为该验证器启用客户端验证。 yii\validators\Validator
$except array|string 验证器不应应用于的场景。 yii\validators\Validator
$format string|null 正在验证的值应遵循的日期格式。 yii\validators\DateValidator
$isEmpty callable|null 一个 PHP 可调用函数,它替换 isEmpty() 的默认实现。 yii\validators\Validator
$locale string|null 用于本地化日期解析的区域设置 ID。 yii\validators\DateValidator
$max integer|string|null 日期的上限。 yii\validators\DateValidator
$maxString string|null 上限的用户友好值,用于在错误消息中显示。 yii\validators\DateValidator
$message string|null 用户定义的错误消息。 yii\validators\Validator
$min integer|string|null 日期的下限。 yii\validators\DateValidator
$minString string|null 下限的用户友好值,用于在错误消息中显示。 yii\validators\DateValidator
$on array|string 验证器可以应用于的场景。 yii\validators\Validator
$skipOnEmpty boolean 如果属性值为 null 或空字符串,是否应该跳过此验证规则。 yii\validators\Validator
$skipOnError boolean 如果正在验证的属性根据某些先前规则已经存在一些验证错误,是否应该跳过此验证规则。 yii\validators\Validator
$strictDateFormat boolean 如果需要严格的日期格式验证,请将此参数设置为 true(例如,仅以下日期通过以下格式的验证 'yyyy-MM-dd':'0011-03-25'、'2019-04-30' 等)。 yii\validators\DateValidator
$timeZone string|null 用于解析日期和时间值的时区。 yii\validators\DateValidator
$timestampAttribute string|null 接收解析结果的属性名称。 yii\validators\DateValidator
$timestampAttributeFormat string|null 填充 $timestampAttribute 时要使用的格式。 yii\validators\DateValidator
$timestampAttributeTimeZone string 填充 $timestampAttribute 时要使用的时区,该时区具有 $timestampAttributeFormat 格式。 yii\validators\DateValidator
$tooBig string 当 value 大于 $max 时使用的用户定义的错误消息。 yii\validators\DateValidator
$tooSmall string 当 value 小于 $min 时使用的用户定义的错误消息。 yii\validators\DateValidator
$type string 验证器的类型。 yii\validators\DateValidator
$validationAttributes array|null 属性名称列表。 yii\validators\Validator
$when callable|null 一个 PHP 可调用函数,它的返回值决定是否应该应用此验证器。 yii\validators\Validator
$whenClient string|null 一个 JavaScript 函数名,它的返回值决定是否应该在客户端应用此验证器。 yii\validators\Validator

公共方法

隐藏继承的方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\Component
__clone() 此方法是在通过克隆现有对象创建对象后调用的。 yii\base\Component
__construct() 构造函数。 yii\base\BaseObject
__get() 返回组件属性的值。 yii\base\Component
__isset() 检查属性是否已设置,即已定义且不为 null。 yii\base\Component
__set() 设置组件属性的值。 yii\base\Component
__unset() 将组件属性设置为 null。 yii\base\Component
addError() 向模型对象添加有关指定属性的错误。 yii\validators\Validator
attachBehavior() 将行为附加到此组件。 yii\base\Component
attachBehaviors() 将行为列表附加到组件。 yii\base\Component
behaviors() 返回此组件应该表现为的行为列表。 yii\base\Component
canGetProperty() 返回一个值,指示是否可以读取属性。 yii\base\Component
canSetProperty() 返回一个值,指示是否可以设置属性。 yii\base\Component
className() 返回此类的完全限定名称。 yii\base\BaseObject
clientValidateAttribute() 返回执行客户端验证所需的 JavaScript 代码。 yii\validators\Validator
createValidator() 创建一个验证器对象。 yii\validators\Validator
detachBehavior() 从组件中分离行为。 yii\base\Component
detachBehaviors() 从组件中分离所有行为。 yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件。 yii\base\Component
getAttributeNames() 返回清理后的属性名称,没有开头的 ! 字符。 yii\validators\Validator
getBehavior() 返回命名行为对象。 yii\base\Component
getBehaviors() 返回附加到此组件的所有行为。 yii\base\Component
getClientOptions() 返回客户端验证选项。 yii\validators\Validator
getValidationAttributes() 返回此验证器应用于的属性列表。 yii\validators\Validator
hasEventHandlers() 返回一个值,指示是否在命名事件中附加了任何处理程序。 yii\base\Component
hasMethod() 返回一个值,指示是否定义了方法。 yii\base\Component
hasProperty() 返回一个值,指示是否为此组件定义了属性。 yii\base\Component
init() 初始化对象。 yii\validators\DateValidator
isActive() 返回一个值,指示验证器对于给定的场景和属性是否处于活动状态。 yii\validators\Validator
isEmpty() 检查给定值是否为空。 yii\validators\Validator
off() 从该组件中分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
trigger() 触发事件。 yii\base\Component
validate() 验证给定值。 yii\validators\Validator
validateAttribute() 验证单个属性。 yii\validators\DateValidator
validateAttributes() 验证指定的对象。 yii\validators\Validator

受保护的方法

隐藏继承的方法

方法 描述 定义于
formatMessage() 使用 I18N 格式化消息,如果 \Yii::$app 不可用,则使用简单的 strtr。 yii\validators\Validator
parseDateValue() 将日期字符串解析为 UNIX 时间戳。 yii\validators\DateValidator
validateValue() 验证值。 yii\validators\DateValidator

常量

隐藏继承的常量

常量 描述 定义于
TYPE_DATE 'date' 指定验证 $type 为日期值的常量,用于使用 intl 短格式验证。 yii\validators\DateValidator
TYPE_DATETIME 'datetime' 指定验证 $type 为日期时间值的常量,用于使用 intl 短格式验证。 yii\validators\DateValidator
TYPE_TIME 'time' 指定验证 $type 为时间值的常量,用于使用 intl 短格式验证。 yii\validators\DateValidator

属性详情

隐藏继承的属性

$defaultTimeZone 公共属性 (自版本 2.0.39 起可用)

当格式中未提供时间部分时,用于解析的默认时区。有关更多说明,请参见 $timestampAttributeTimeZone

public string $defaultTimeZone 'UTC'
$format 公共属性

要验证的值应遵循的日期格式。这可以是 ICU 手册 中描述的日期时间模式。

或者,这可以是一个以 php: 为前缀的字符串,代表 PHP Datetime 类可以识别的格式。有关支持的格式,请参阅 https://php.ac.cn/manual/en/datetime.createfromformat.php

如果未设置此属性,则默认值将从 Yii::$app->formatter->dateFormat 获取,有关详细信息,请参见 yii\i18n\Formatter::$dateFormat。自版本 2.0.8 起,默认值将根据格式化程序类的不同格式确定,具体取决于 $type 的值

以下是一些示例值

'MM/dd/yyyy' // date in ICU format
'php:m/d/Y' // the same date in PHP format
'MM/dd/yyyy HH:mm' // not only dates but also times can be validated

注意:正在使用的底层日期解析器因格式而异。如果您使用 ICU 格式并且安装了 PHP intl 扩展,则 IntlDateFormatter 用于解析输入值。在所有其他情况下,将使用 PHP DateTime 类。IntlDateFormatter 的优点是可以解析国际日期,例如 12. Mai 201512 мая 2014,而 PHP 解析器仅限于英语。但是,PHP 解析器对输入格式更加严格,因为它不会接受格式 php:d.m.Y12.05.05,但 IntlDateFormatter 会接受格式 dd.MM.yyyy 的该值。如果您需要使用 IntlDateFormatter,则可以通过指定 最小日期 来避免此问题。

public string|null $format null
$locale 公共属性

用于本地化日期解析的区域设置 ID。这仅在安装了 PHP intl 扩展 时有效。如果未设置,将使用 格式化程序 的区域设置。另请参见 yii\i18n\Formatter::$locale

public string|null $locale null
$max 公共属性 (自版本 2.0.4 起可用)

日期的上限。默认为 null,表示没有上限。这可以是 UNIX 时间戳或表示日期时间值的字符串。如果此属性为字符串,则将使用 $format 解析它。

另请参见 $tooBig,了解日期过大时使用的自定义消息。

public integer|string|null $max null
$maxString 公共属性 (自版本 2.0.4 起可用)

要显示在错误消息中的上限的用户友好值。如果此属性为 null,则将使用 $max 的值(在解析之前)。

public string|null $maxString null
$min 公共属性 (自版本 2.0.4 起可用)

日期的下限。默认为 null,表示没有下限。这可以是 UNIX 时间戳或表示日期时间值的字符串。如果此属性为字符串,则将使用 $format 解析它。

另请参见 $tooSmall,了解日期过小时使用的自定义消息。

public integer|string|null $min null
$minString 公共属性 (自版本 2.0.4 起可用)

要显示在错误消息中的下限的用户友好值。如果此属性为 null,则将使用 $min 的值(在解析之前)。

public string|null $minString null
$strictDateFormat 公共属性 (自版本 2.0.22 起可用)

如果您需要严格的日期格式验证,请将此参数设置为 true(例如,只有以下格式的日期通过验证 'yyyy-MM-dd':'0011-03-25'、'2019-04-30' 等,而不是 '18-05-15'、'2017-Mar-14' 等,如果将此参数设置为 false,这些日期将通过验证)。

public boolean $strictDateFormat false
$timeZone 公共属性

用于解析日期和时间值的时区。可以是传递给 date_default_timezone_set() 的任何值,例如 UTCEurope/BerlinAmerica/Chicago。有关可用时区的详细信息,请参阅 php 手册。如果未设置此属性,将使用 yii\base\Application::$timeZone

public string|null $timeZone null
$timestampAttribute 公共属性

接收解析结果的属性名称。当此属性不为 null 且验证成功时,命名属性将接收解析结果。

这可以与正在验证的属性相同。如果是这种情况,原始值将在验证成功后被时间戳值覆盖。

注意,使用此属性时,输入值将被转换为 unix 时间戳,该时间戳根据定义是在 默认 UTC 时区 中的,因此将执行从 输入时区 到默认时区的转换。如果要更改默认时区,请设置 $defaultTimeZone 属性。在定义 $timestampAttributeFormat 时,可以通过将 $timestampAttributeTimeZone 设置为与 'UTC' 不同的值来进一步控制转换。

另请参阅

$timestampAttributeFormat 公共属性 (available since version 2.0.4)

用于填充 $timestampAttribute 的格式。格式的指定方式与 $format 相同。

如果未设置,$timestampAttribute 将接收一个 UNIX 时间戳。如果 $timestampAttribute 未设置,则将忽略此属性。

另请参阅

$timestampAttributeTimeZone 公共属性 (available since version 2.0.4)

使用 $timestampAttributeFormat 填充 $timestampAttribute 时要使用的时区。默认值为 UTC

可以是传递给 date_default_timezone_set() 的任何值,例如 UTCEurope/BerlinAmerica/Chicago。有关可用时区的详细信息,请参阅 php 手册

如果 $timestampAttributeFormat 未设置,则将忽略此属性。

另请参阅 $timestampAttributeFormat

$tooBig 公共属性 (available since version 2.0.4)

当 value 大于 $max 时使用的用户定义的错误消息。

public string $tooBig null
$tooSmall 公共属性 (available since version 2.0.4)

当 value 小于 $min 时使用的用户定义的错误消息。

public string $tooSmall null
$type 公共属性 (available since version 2.0.8)

验证器的类型。指示要验证的是日期、时间还是日期时间值。此属性影响 $format 的默认值,并在 $format 为 intl 简短格式 shortmediumlongfull 时设置正确的行为。

这仅在安装了 PHP intl 扩展 时有效。

此属性可以设置为以下值

  • TYPE_DATE - (默认) 用于仅验证日期值,这意味着只有不包含时间范围的值有效。
  • TYPE_DATETIME - 用于验证日期时间值,其中包含日期部分和时间部分。
  • TYPE_TIME - 用于验证时间值,不包含日期信息。
public string $type self::TYPE_DATE

方法详情

隐藏继承的方法

__call() 公共方法

定义于: yii\base\Component::__call()

调用不是类方法的命名方法。

此方法将检查是否任何附加的行为具有命名方法,如果可用,将执行该方法。

不要直接调用此方法,因为它是一个 PHP 魔术方法,当调用未知方法时会隐式调用。

public mixed __call ( $name, $params )
$name string

方法名称

$params array

方法参数

return mixed

方法返回值

throws yii\base\UnknownMethodException

当调用未知方法时

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() 公共方法

定义于: yii\base\Component::__clone()

此方法是在通过克隆现有对象创建对象后调用的。

它将删除所有行为,因为它们附加到旧对象。

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() 公共方法

定义于: yii\base\BaseObject::__construct()

构造函数。

默认实现执行两件事

  • 使用给定的配置 $config 初始化对象。
  • 调用 init()

如果在子类中重写此方法,建议

  • 构造函数的最后一个参数是一个配置数组,就像这里的 $config 一样。
  • 在构造函数的末尾调用父实现。
public void __construct ( $config = [] )
$config array

用于初始化对象属性的键值对

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}

            
__get() 公共方法

定义于: yii\base\Component::__get()

返回组件属性的值。

此方法将按以下顺序检查并相应地操作

  • 通过 getter 定义的属性:返回 getter 结果
  • 行为的属性:返回行为属性值

不要直接调用此方法,因为它是一个 PHP 魔术方法,将在执行 $value = $component->property; 时隐式调用。

另请参阅 __set().

public mixed __get ( $name )
$name string

属性名称

return mixed

属性值或行为属性的值

throws yii\base\UnknownPropertyException

如果未定义属性

throws yii\base\InvalidCallException

如果属性是只写。

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() 公共方法

定义于: yii\base\Component::__isset()

检查属性是否已设置,即已定义且不为 null。

此方法将按以下顺序检查并相应地操作

  • 通过 setter 定义的属性:返回属性是否已设置
  • 行为的属性:返回属性是否已设置
  • 对于不存在的属性,返回 false

不要直接调用此方法,因为它是一个 PHP 魔术方法,将在执行 isset($component->property) 时隐式调用。

另请参阅 https://php.ac.cn/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

属性名称或事件名称

return boolean

命名的属性是否已设置

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() 公共方法

定义于: yii\base\Component::__set()

设置组件属性的值。

此方法将按以下顺序检查并相应地操作

  • 通过 setter 定义的属性:设置属性值
  • 以“on xyz”格式的事件:将处理程序附加到事件“xyz”
  • 以“as xyz”格式的行为:附加名为“xyz”的行为
  • 行为的属性:设置行为属性值

不要直接调用此方法,因为它是一个 PHP 魔术方法,将在执行 $component->property = $value; 时隐式调用。

另请参阅 __get().

public void __set ( $name, $value )
$name string

属性名称或事件名称

$value mixed

属性值

throws yii\base\UnknownPropertyException

如果未定义属性

throws yii\base\InvalidCallException

如果属性是只读。

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() 公共方法

定义于: yii\base\Component::__unset()

将组件属性设置为 null。

此方法将按以下顺序检查并相应地操作

  • 通过 setter 定义的属性:将属性值设置为 null
  • 行为的属性:将属性值设置为 null

不要直接调用此方法,因为它是一个 PHP 魔术方法,将在执行 unset($component->property) 时隐式调用。

另请参阅 https://php.ac.cn/manual/en/function.unset.php.

public void __unset ( $name )
$name string

属性名称

throws yii\base\InvalidCallException

如果属性是只读。

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
addError() 公共方法

定义于: yii\validators\Validator::addError()

向模型对象添加有关指定属性的错误。

这是一个执行消息选择和国际化的辅助方法。

public void addError ( $model, $attribute, $message, $params = [] )
$model yii\base\Model

正在验证的数据模型

$attribute string

正在验证的属性

$message string

错误消息

$params array

错误消息中占位符的值

                public function addError($model, $attribute, $message, $params = [])
{
    $params['attribute'] = $model->getAttributeLabel($attribute);
    if (!isset($params['value'])) {
        $value = $model->$attribute;
        if (is_array($value)) {
            $params['value'] = 'array()';
        } elseif (is_object($value) && !method_exists($value, '__toString')) {
            $params['value'] = '(object)';
        } else {
            $params['value'] = $value;
        }
    }
    $model->addError($attribute, $this->formatMessage($message, $params));
}

            
attachBehavior() 公共方法

定义于: yii\base\Component::attachBehavior()

将行为附加到此组件。

此方法将根据给定的配置创建行为对象。之后,将通过调用 yii\base\Behavior::attach() 方法将行为对象附加到此组件。

另请参阅 detachBehavior().

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

行为的名称。

$behavior string|array|yii\base\Behavior

行为配置。可以是以下之一

return yii\base\Behavior

行为对象

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() 公共方法

定义于: yii\base\Component::attachBehaviors()

将行为列表附加到组件。

每个行为都按其名称索引,应该是 yii\base\Behavior 对象,指定行为类的字符串,或创建行为的配置数组。

另请参阅 attachBehavior().

public void attachBehaviors ( $behaviors )
$behaviors array

要附加到组件的行为列表

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
behaviors() 公共方法

定义于: yii\base\Component::behaviors()

返回此组件应该表现为的行为列表。

子类可以重写此方法以指定它们要表现的行为。

此方法的返回值应为行为对象或配置的数组,按行为名称索引。行为配置可以是指定行为类的字符串,也可以是以下结构的数组

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

请注意,行为类必须扩展自 yii\base\Behavior。行为可以使用名称或匿名方式附加。当使用名称作为数组键时,可以使用此名称稍后使用 getBehavior() 检索行为,或使用 detachBehavior() 分离行为。匿名行为无法检索或分离。

在此方法中声明的行为将自动附加到组件(按需)。

public array behaviors ( )
return array

行为配置。

                public function behaviors()
{
    return [];
}

            
canGetProperty() 公共方法

定义于: yii\base\Component::canGetProperty()

返回一个值,指示是否可以读取属性。

如果属性可以读取,则

  • 该类具有与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
  • 该类具有具有指定名称的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的可读属性(当 $checkBehaviors 为 true 时)。

另请参阅 canSetProperty().

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

return boolean

属性是否可读

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() 公共方法

定义在: yii\base\Component::canSetProperty()

返回一个值,指示是否可以设置属性。

属性可以写入,如果

  • 该类具有与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
  • 该类具有具有指定名称的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的可写属性(当 $checkBehaviors 为 true 时)。

另请参阅 canGetProperty().

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

return boolean

属性是否可写

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
className() 公共静态方法
自 2.0.14 起已弃用。在 PHP >= 5.5 上,使用 ::class 代替。

定义在: yii\base\BaseObject::className()

返回此类的完全限定名称。

public static string className ( )
return string

此类的完全限定名称。

                public static function className()
{
    return get_called_class();
}

            
clientValidateAttribute() 公共方法

定义在: yii\validators\Validator::clientValidateAttribute()

返回执行客户端验证所需的 JavaScript 代码。

调用 getClientOptions() 为客户端验证生成选项数组。

您可以覆盖此方法以返回 JavaScript 验证代码,如果验证器支持客户端验证。

以下 JavaScript 变量已预定义,可以在验证代码中使用

  • attribute: 一个描述正在验证的属性的对象。
  • value: 正被验证的值。
  • messages: 用于保存属性验证错误消息的数组。
  • deferred: 用于保存异步验证的延迟对象的数组
  • $form: 包含表单元素的 jQuery 对象

attribute 对象包含以下属性

  • id: 用于标识表单中属性(例如“loginform-username”)的唯一 ID
  • name: 属性名称或表达式(例如表格输入的“[0]content”)
  • container: 输入字段容器的 jQuery 选择器
  • input: 表单上下文下输入字段的 jQuery 选择器
  • error: 容器上下文下错误标签的 jQuery 选择器
  • status: 输入字段的状态,0: 空,之前未输入,1: 已验证,2: 待验证,3: 正在验证

另请参阅

public string|null clientValidateAttribute ( $model, $attribute, $view )
$model yii\base\Model

正在验证的数据模型

$attribute string

要验证的属性的名称。

$view yii\web\View

将用于呈现视图或包含应用此验证器的模型表单的视图文件的视图对象。

return string|null

客户端验证脚本。如果验证器不支持客户端验证,则为 null。

                public function clientValidateAttribute($model, $attribute, $view)
{
    return null;
}

            
createValidator() 公共静态方法

定义在: yii\validators\Validator::createValidator()

创建一个验证器对象。

public static yii\validators\Validator createValidator ( $type, $model, $attributes, $params = [] )
$type string|Closure

验证器类型。这可以是

  • $builtInValidators 中列出的内置验证器名称;
  • 模型类的函数名;
  • 匿名函数;
  • 验证器类名。
$model yii\base\Model

要验证的数据模型。

$attributes array|string

要验证的属性列表。这可以是属性名称数组或逗号分隔的属性名称字符串。

$params array

要应用于验证器属性的初始值。

return yii\validators\Validator

验证器

                public static function createValidator($type, $model, $attributes, $params = [])
{
    $params['attributes'] = $attributes;
    if ($type instanceof \Closure) {
        $params['class'] = __NAMESPACE__ . '\InlineValidator';
        $params['method'] = $type;
    } elseif (!isset(static::$builtInValidators[$type]) && $model->hasMethod($type)) {
        // method-based validator
        $params['class'] = __NAMESPACE__ . '\InlineValidator';
        $params['method'] = [$model, $type];
    } else {
        unset($params['current']);
        if (isset(static::$builtInValidators[$type])) {
            $type = static::$builtInValidators[$type];
        }
        if (is_array($type)) {
            $params = array_merge($type, $params);
        } else {
            $params['class'] = $type;
        }
    }
    return Yii::createObject($params);
}

            
detachBehavior() 公共方法

定义在: yii\base\Component::detachBehavior()

从组件中分离行为。

将调用行为的 yii\base\Behavior::detach() 方法。

public yii\base\Behavior|null detachBehavior ( $name )
$name string

行为的名称。

return yii\base\Behavior|null

分离的行为。如果行为不存在,则为 null。

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() 公共方法

定义在: yii\base\Component::detachBehaviors()

从组件中分离所有行为。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
ensureBehaviors() 公共方法

定义在: yii\base\Component::ensureBehaviors()

确保在 behaviors() 中声明的行为已附加到此组件。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
formatMessage() 受保护的方法 (自版本 2.0.12 起可用)

定义在: yii\validators\Validator::formatMessage()

使用 I18N 格式化消息,如果 \Yii::$app 不可用,则使用简单的 strtr。

protected string formatMessage ( $message, $params )
$message string
$params array

                protected function formatMessage($message, $params)
{
    if (Yii::$app !== null) {
        return \Yii::$app->getI18n()->format($message, $params, Yii::$app->language);
    }
    $placeholders = [];
    foreach ((array) $params as $name => $value) {
        $placeholders['{' . $name . '}'] = $value;
    }
    return ($placeholders === []) ? $message : strtr($message, $placeholders);
}

            
getAttributeNames() 公共方法 (自版本 2.0.12 起可用)

定义在: yii\validators\Validator::getAttributeNames()

返回清理后的属性名称,没有开头的 ! 字符。

public array getAttributeNames ( )
return array

属性名称。

                public function getAttributeNames()
{
    return array_map(function ($attribute) {
        return ltrim($attribute, '!');
    }, $this->attributes);
}

            
getBehavior() 公共方法

定义于: yii\base\Component::getBehavior()

返回命名行为对象。

public yii\base\Behavior|null getBehavior ( $name )
$name string

行为名称

return yii\base\Behavior|null

行为对象,如果行为不存在则为 null

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() 公共方法

定义于: yii\base\Component::getBehaviors()

返回附加到此组件的所有行为。

public yii\base\Behavior[] getBehaviors ( )
return yii\base\Behavior[]

附加到此组件的行为列表

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getClientOptions() 公共方法 (从版本 2.0.11 开始可用)

定义于: yii\validators\Validator::getClientOptions()

返回客户端验证选项。

此方法通常从 clientValidateAttribute() 中调用。您可以覆盖此方法来修改将传递给客户端验证的选项。

public array getClientOptions ( $model, $attribute )
$model yii\base\Model

正在验证的模型

$attribute string

正在验证的属性名称

return array

客户端验证选项

                public function getClientOptions($model, $attribute)
{
    return [];
}

            
getValidationAttributes() 公共方法 (从版本 2.0.16 开始可用)

定义于: yii\validators\Validator::getValidationAttributes()

返回此验证器应用于的属性列表。

public array|null getValidationAttributes ( $attributes null )
$attributes array|string|null

要验证的属性列表。

return array|null

属性名称列表。

                public function getValidationAttributes($attributes = null)
{
    if ($attributes === null) {
        return $this->getAttributeNames();
    }
    if (is_scalar($attributes)) {
        $attributes = [$attributes];
    }
    $newAttributes = [];
    $attributeNames = $this->getAttributeNames();
    foreach ($attributes as $attribute) {
        // do not strict compare, otherwise int attributes would fail due to to string conversion in getAttributeNames() using ltrim().
        if (in_array($attribute, $attributeNames, false)) {
            $newAttributes[] = $attribute;
        }
    }
    return $newAttributes;
}

            
hasEventHandlers() 公共方法

定义于: yii\base\Component::hasEventHandlers()

返回一个值,指示是否在命名事件中附加了任何处理程序。

public boolean hasEventHandlers ( $name )
$name string

事件名称

return boolean

是否有任何处理程序附加到该事件。

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() 公共方法

定义于: yii\base\Component::hasMethod()

返回一个值,指示是否定义了方法。

如果定义了方法

  • 该类具有指定名称的方法
  • 附加的行为具有给定名称的方法(当 $checkBehaviors 为 true 时)。
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

属性名称

$checkBehaviors boolean

是否将行为的方法视为此组件的方法

return boolean

该方法是否已定义

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() 公共方法

定义于: yii\base\Component::hasProperty()

返回一个值,指示是否为此组件定义了属性。

如果定义了属性

  • 该类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
  • 该类具有具有指定名称的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的属性(当 $checkBehaviors 为 true 时)。

另请参阅

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

return boolean

该属性是否已定义

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
init() 公共方法

初始化对象。

此方法在构造函数结束时调用,在对象使用给定配置初始化之后调用。

public void init ( )

                public function init()
{
    parent::init();
    if ($this->message === null) {
        $this->message = Yii::t('yii', 'The format of {attribute} is invalid.');
    }
    if ($this->format === null) {
        if ($this->type === self::TYPE_DATE) {
            $this->format = Yii::$app->formatter->dateFormat;
        } elseif ($this->type === self::TYPE_DATETIME) {
            $this->format = Yii::$app->formatter->datetimeFormat;
        } elseif ($this->type === self::TYPE_TIME) {
            $this->format = Yii::$app->formatter->timeFormat;
        } else {
            throw new InvalidConfigException('Unknown validation type set for DateValidator::$type: ' . $this->type);
        }
    }
    if ($this->locale === null) {
        $this->locale = Yii::$app->language;
    }
    if ($this->timeZone === null) {
        $this->timeZone = Yii::$app->timeZone;
    }
    if ($this->min !== null && $this->tooSmall === null) {
        $this->tooSmall = Yii::t('yii', '{attribute} must be no less than {min}.');
    }
    if ($this->max !== null && $this->tooBig === null) {
        $this->tooBig = Yii::t('yii', '{attribute} must be no greater than {max}.');
    }
    if ($this->maxString === null) {
        $this->maxString = (string)$this->max;
    }
    if ($this->minString === null) {
        $this->minString = (string)$this->min;
    }
    if ($this->max !== null && is_string($this->max)) {
        $timestamp = $this->parseDateValue($this->max);
        if ($timestamp === false) {
            throw new InvalidConfigException("Invalid max date value: {$this->max}");
        }
        $this->max = $timestamp;
    }
    if ($this->min !== null && is_string($this->min)) {
        $timestamp = $this->parseDateValue($this->min);
        if ($timestamp === false) {
            throw new InvalidConfigException("Invalid min date value: {$this->min}");
        }
        $this->min = $timestamp;
    }
}

            
isActive() 公共方法

定义于: yii\validators\Validator::isActive()

返回一个值,指示验证器对于给定的场景和属性是否处于活动状态。

如果验证器处于活动状态

  • 验证器的 on 属性为空,或
  • 验证器的 on 属性包含指定的场景
public boolean isActive ( $scenario )
$scenario string

场景名称

return boolean

验证器是否适用于指定的场景。

                public function isActive($scenario)
{
    return !in_array($scenario, $this->except, true) && (empty($this->on) || in_array($scenario, $this->on, true));
}

            
isEmpty() 公共方法

定义于: yii\validators\Validator::isEmpty()

检查给定值是否为空。

如果值为 null、空数组或空字符串,则该值被认为为空。请注意,此方法与 PHP empty() 不同。当值为 0 时,它将返回 false。

public boolean isEmpty ( $value )
$value mixed

要检查的值

return boolean

该值是否为空

                public function isEmpty($value)
{
    if ($this->isEmpty !== null) {
        return call_user_func($this->isEmpty, $value);
    }
    return $value === null || $value === [] || $value === '';
}

            
off() 公共方法

定义于: yii\base\Component::off()

从该组件中分离现有的事件处理程序。

此方法与 on() 相反。

注意:如果事件名称传递了通配符模式,则只删除使用此通配符注册的处理程序,而使用与该通配符匹配的普通名称注册的处理程序将保留。

另请参阅 on()

public boolean off ( $name, $handler null )
$name string

事件名称

$handler callable|null

要删除的事件处理程序。如果为 null,则将删除附加到命名事件的所有处理程序。

return boolean

如果找到并分离处理程序

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() 公共方法

定义于: yii\base\Component::on()

将事件处理程序附加到事件。

事件处理程序必须是有效的 PHP 回调。以下是一些示例

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

事件处理程序必须使用以下签名定义,

function ($event)

其中 $event 是一个 yii\base\Event 对象,其中包含与事件相关的参数。

从 2.0.14 开始,您可以将事件名称指定为通配符模式

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

另请参阅 off()

public void on ( $name, $handler, $data null, $append true )
$name string

事件名称

$handler 可调用

事件处理程序

$data mixed

当事件触发时传递给事件处理程序的数据。 当调用事件处理程序时,可以通过 yii\base\Event::$data 访问此数据。

$append boolean

是否将新的事件处理程序附加到现有处理程序列表的末尾。 如果为 false,则新的处理程序将插入到现有处理程序列表的开头。

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
parseDateValue() 受保护方法

将日期字符串解析为 UNIX 时间戳。

protected integer|false parseDateValue ( $value )
$value mixed

表示日期的字符串

return integer|false

UNIX 时间戳或 false 表示失败。

                protected function parseDateValue($value)
{
    // TODO consider merging these methods into single one at 2.1
    return $this->parseDateValueFormat($value, $this->format);
}

            
trigger() 公共方法

定义于: yii\base\Component::trigger()

触发事件。

此方法表示事件的发生。 它调用事件的所有附加处理程序,包括类级别处理程序。

public void trigger ( $name, yii\base\Event $event null )
$name string

事件名称

$event yii\base\Event|null

事件实例。 如果未设置,将创建一个默认的 yii\base\Event 对象。

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}

            
validate() 公共方法

定义于: yii\validators\Validator::validate()

验证给定值。

您可以使用此方法验证数据模型上下文之外的值。

public boolean validate ( $value, &$error null )
$value mixed

要验证的数据值。

$error string|null

如果验证失败,要返回的错误消息。

return boolean

数据是否有效。

                public function validate($value, &$error = null)
{
    $result = $this->validateValue($value);
    if (empty($result)) {
        return true;
    }
    list($message, $params) = $result;
    $params['attribute'] = Yii::t('yii', 'the input value');
    if (is_array($value)) {
        $params['value'] = 'array()';
    } elseif (is_object($value)) {
        $params['value'] = 'object';
    } else {
        $params['value'] = $value;
    }
    $error = $this->formatMessage($message, $params);
    return false;
}

            
validateAttribute() 公共方法

验证单个属性。

子类必须实现此方法以提供实际的验证逻辑。

public void validateAttribute ( $model, $attribute )
$model yii\base\Model

要验证的数据模型

$attribute string

要验证的属性的名称。

                public function validateAttribute($model, $attribute)
{
    $value = $model->$attribute;
    if ($this->isEmpty($value)) {
        if ($this->timestampAttribute !== null) {
            $model->{$this->timestampAttribute} = null;
        }
        return;
    }
    $timestamp = $this->parseDateValue($value);
    if ($timestamp === false) {
        if ($this->timestampAttribute === $attribute) {
            if ($this->timestampAttributeFormat === null) {
                if (is_int($value)) {
                    return;
                }
            } elseif ($this->parseDateValueFormat($value, $this->timestampAttributeFormat) !== false) {
                return;
            }
        }
        $this->addError($model, $attribute, $this->message, []);
    } elseif ($this->min !== null && $timestamp < $this->min) {
        $this->addError($model, $attribute, $this->tooSmall, ['min' => $this->minString]);
    } elseif ($this->max !== null && $timestamp > $this->max) {
        $this->addError($model, $attribute, $this->tooBig, ['max' => $this->maxString]);
    } elseif ($this->timestampAttribute !== null) {
        if ($this->timestampAttributeFormat === null) {
            $model->{$this->timestampAttribute} = $timestamp;
        } else {
            $model->{$this->timestampAttribute} = $this->formatTimestamp($timestamp, $this->timestampAttributeFormat);
        }
    }
}

            
validateAttributes() 公共方法

定义于: yii\validators\Validator::validateAttributes()

验证指定的对象。

public void validateAttributes ( $model, $attributes null )
$model yii\base\Model

正在验证的数据模型

$attributes array|string|null

要验证的属性列表。 请注意,如果属性未与验证器关联,则将被忽略。 如果此参数为 null,则将验证 $attributes 中列出的每个属性。

                public function validateAttributes($model, $attributes = null)
{
    $attributes = $this->getValidationAttributes($attributes);
    foreach ($attributes as $attribute) {
        $skip = $this->skipOnError && $model->hasErrors($attribute)
            || $this->skipOnEmpty && $this->isEmpty($model->$attribute);
        if (!$skip) {
            if ($this->when === null || call_user_func($this->when, $model, $attribute)) {
                $this->validateAttribute($model, $attribute);
            }
        }
    }
}

            
validateValue() 受保护方法

验证值。

验证器类可以实现此方法以支持数据模型上下文之外的数据验证。

protected array|null validateValue ( $value )
$value mixed

要验证的数据值。

return array|null

错误消息和要插入错误消息的参数数组。 `php if (!$valid) {

return [$this->message, [
    'param1' => $this->param1,
    'formattedLimit' => Yii::$app->formatter->asShortSize($this->getSizeLimit()),
    'mimeTypes' => implode(', ', $this->mimeTypes),
    'param4' => 'etc...',
]];

}

return null; ` 对于此示例,message 模板可以包含 {param1}{formattedLimit}{mimeTypes}{param4}

如果数据有效,则应返回 Null。

throws yii\base\NotSupportedException

如果验证器不支持在没有模型的情况下进行数据验证

                protected function validateValue($value)
{
    $timestamp = $this->parseDateValue($value);
    if ($timestamp === false) {
        return [$this->message, []];
    } elseif ($this->min !== null && $timestamp < $this->min) {
        return [$this->tooSmall, ['min' => $this->minString]];
    } elseif ($this->max !== null && $timestamp > $this->max) {
        return [$this->tooBig, ['max' => $this->maxString]];
    }
    return null;
}