0 关注者

类 yii\validators\FileValidator

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

FileValidator 验证属性是否接收了有效的上传文件。

请注意,您应该启用 fileinfo PHP 扩展。

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$attributeNames array 属性名称。 yii\validators\Validator
$attributes 数组|字符串 要由此验证器验证的属性。 yii\validators\Validator
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$builtInValidators array 内置验证器列表(名称 => 类或配置) yii\validators\Validator
$checkExtensionByMimeType boolean 是否使用 MIME 类型检查文件类型(扩展名)。 yii\validators\FileValidator
$enableClientValidation boolean 是否启用此验证器的客户端验证。 yii\validators\Validator
$except 数组|字符串 验证器不应应用于的场景。 yii\validators\Validator
$extensions 数组|字符串|null 允许上传的文件名扩展名列表。 yii\validators\FileValidator
$isEmpty 可调用|null 一个 PHP 可调用函数,替换 isEmpty() 的默认实现。 yii\validators\Validator
$maxFiles integer 给定属性可以容纳的最大文件数。 yii\validators\FileValidator
$maxSize 整数|null 上传文件所需的字节数最大值。 yii\validators\FileValidator
$message string 文件未正确上传时使用的错误消息。 yii\validators\FileValidator
$mimeTypes 数组|字符串|null 允许上传的文件 MIME 类型列表。 yii\validators\FileValidator
$minFiles integer 给定属性可以容纳的最小文件数。 yii\validators\FileValidator
$minSize 整数|null 上传文件所需的字节数最小值。 yii\validators\FileValidator
$on 数组|字符串 验证器可以应用于的场景。 yii\validators\Validator
$sizeLimit integer 上传文件的尺寸限制。 yii\validators\FileValidator
$skipOnEmpty boolean 如果属性值为 null 或空字符串,是否跳过此验证规则。 yii\validators\Validator
$skipOnError boolean 如果根据某些先前规则,正在验证的属性已存在某些验证错误,是否跳过此验证规则。 yii\validators\Validator
$tooBig string 上传文件太大时使用的错误消息。 yii\validators\FileValidator
$tooFew string 如果多个上传的文件数量小于 minFiles 时使用的错误消息。 yii\validators\FileValidator
$tooMany string 如果多个上传的文件数量超过限制时使用的错误消息。 yii\validators\FileValidator
$tooSmall string 上传文件太小时使用的错误消息。 yii\validators\FileValidator
$uploadRequired string 没有上传文件时使用的错误消息。 yii\validators\FileValidator
$validationAttributes 数组|null 属性名称列表。 yii\validators\Validator
$when 可调用|null 一个 PHP 可调用函数,其返回值决定是否应用此验证器。 yii\validators\Validator
$whenClient 字符串|null 一个 JavaScript 函数名称,其返回值决定是否在客户端应用此验证器。 yii\validators\Validator
$wrongExtension string 上传文件的扩展名不在 $extensions 中列出时使用的错误消息。 yii\validators\FileValidator
$wrongMimeType string 文件具有 $mimeTypes 属性不允许的 MIME 类型时使用的错误消息。 yii\validators\FileValidator

公共方法

隐藏继承的方法

方法 描述 定义于
__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\FileValidator
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\FileValidator
getSizeLimit() 返回上传文件允许的最大大小。 yii\validators\FileValidator
getValidationAttributes() 返回此验证器应用于的属性列表。 yii\validators\Validator
hasEventHandlers() 返回一个值,指示是否有任何处理程序附加到命名事件。 yii\base\Component
hasMethod() 返回一个值,指示方法是否已定义。 yii\base\Component
hasProperty() 返回一个值,指示此组件是否定义了属性。 yii\base\Component
init() 初始化对象。 yii\validators\FileValidator
isActive() 返回一个值,指示验证器对于给定的场景和属性是否处于活动状态。 yii\validators\Validator
isEmpty() 检查给定值是否为空。 yii\validators\FileValidator
off() 从此组件中分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
trigger() 触发事件。 yii\base\Component
validate() 验证给定值。 yii\validators\Validator
validateAttribute() 验证单个属性。 yii\validators\FileValidator
validateAttributes() 验证指定的对象。 yii\validators\Validator

受保护方法

隐藏继承的方法

方法 描述 定义于
formatMessage() 使用 I18N 格式化消息,或者如果 \Yii::$app 不可用则使用简单的 strtr。 yii\validators\Validator
getMimeTypeByFile() 通过文件路径获取 MIME 类型 yii\validators\FileValidator
validateExtension() 检查给定的上传文件是否具有根据当前验证器设置的正确类型(扩展名)。 yii\validators\FileValidator
validateMimeType() 根据 $mimeTypes 属性中的列表检查 $file 的 mimeType。 yii\validators\FileValidator
validateValue() 验证一个值。 yii\validators\FileValidator

属性详情

隐藏继承的属性

$checkExtensionByMimeType 公共属性

是否根据 MIME 类型检查文件类型(扩展名)。如果根据文件 MIME 类型检查生成的扩展名与上传的文件扩展名不同,则该文件将被视为无效。

$extensions 公共属性

允许上传的文件名扩展名的列表。这可以是一个数组,也可以是一个由空格或逗号分隔的文件扩展名名称组成的字符串(例如“gif, jpg”)。扩展名名称不区分大小写。默认为 null,表示允许所有文件名扩展名。

另请参阅 $wrongExtension 以获取错误文件类型的自定义消息。

public array|string|null $extensions null
$maxFiles 公共属性

给定属性可以容纳的最大文件数。默认为 1,表示单文件上传。通过定义更高的数字,可以实现多个上传。将其设置为 0 表示对可以同时上传的文件数量没有限制。

注意:同时允许上传的最大文件数也受 PHP 指令 max_file_uploads 的限制,默认为 20。

另请参阅

public integer $maxFiles 1
$maxSize 公共属性

上传文件所需的字节数最大值。默认为 null,表示没有限制。请注意,大小限制还受 upload_max_filesizepost_max_size INI 设置以及“MAX_FILE_SIZE”隐藏字段值的影响。有关详细信息,请参阅 getSizeLimit()

另请参阅

public integer|null $maxSize null
$message 公共属性

文件未正确上传时使用的错误消息。

public string $message null
$mimeTypes 公共属性

允许上传的文件 MIME 类型的列表。这可以是一个数组,也可以是一个由空格或逗号分隔的文件 MIME 类型组成的字符串(例如“text/plain, image/png”)。可以使用带有特殊字符 * 的掩码来匹配 MIME 类型组。例如 image/* 将传递所有以 image/ 开头的 MIME 类型(例如 image/jpegimage/png)。MIME 类型名称不区分大小写。默认为 null,表示允许所有 MIME 类型。

另请参阅 $wrongMimeType 以获取错误 MIME 类型的自定义消息。

public array|string|null $mimeTypes null
$minFiles 公共属性 (自版本 2.0.14 起可用)

给定属性可以容纳的最小文件数。默认为 0。较高的值表示至少应上传该数量的文件。

另请参阅 $tooFew 以获取上传文件过少的自定义消息。

public integer $minFiles 0
$minSize 公共属性

上传文件所需的字节数最小值。默认为 null,表示没有限制。

另请参阅 $tooSmall 以获取文件过小的自定义消息。

public integer|null $minSize null
$sizeLimit 公共属性

上传文件的尺寸限制。

public integer $sizeLimit null
$tooBig 公共属性

当上传的文件过大时使用的错误消息。您可以在消息中使用以下标记

  • {attribute}: 属性名称
  • {file}: 上传的文件名
  • {limit}: 允许的最大大小(请参阅 getSizeLimit()
  • {formattedLimit}: 使用 Formatter::asShortSize() 格式化的最大大小
public string $tooBig null
$tooFew 公共属性 (自版本 2.0.14 起可用)

如果多个上传的文件数量小于 minFiles,则使用的错误消息。您可以在消息中使用以下标记

  • {attribute}: 属性名称
  • {limit}: $minFiles 的值
public string $tooFew null
$tooMany 公共属性

如果多个上传文件的数量超过限制,则使用此错误消息。您可以在消息中使用以下标记

  • {attribute}: 属性名称
  • {limit}: $maxFiles 的值
public string $tooMany null
$tooSmall 公共属性

当上传的文件太小时使用的错误消息。您可以在消息中使用以下标记

  • {attribute}: 属性名称
  • {file}: 上传的文件名
  • {limit}: $minSize 的值
  • {formattedLimit}: 使用 [[\yii\i18n\Formatter::asShortSize()|Formatter::asShortSize()]] 格式化的 $minSize 的值
public string $tooSmall null
$uploadRequired 公共属性

当没有上传文件时使用的错误消息。请注意,这是验证错误消息的文本。要使文件上传成为必填项,您必须将 $skipOnEmpty 设置为 false

public string $uploadRequired null
$wrongExtension 公共属性

当上传的文件的扩展名未列在 $extensions 中时使用的错误消息。您可以在消息中使用以下标记

  • {attribute}: 属性名称
  • {file}: 上传的文件名
  • {extensions}: 允许的扩展名列表。
public string $wrongExtension null
$wrongMimeType 公共属性

当文件具有 $mimeTypes 属性不允许的 MIME 类型时使用的错误消息。您可以在消息中使用以下标记

  • {attribute}: 属性名称
  • {file}: 上传的文件名
  • {mimeTypes}: $mimeTypes 的值
public string $wrongMimeType null

方法详情

隐藏继承的方法

__call() 公共方法

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

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

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

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

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

方法名称

$params array

方法参数

返回值 mixed

方法返回值

抛出 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

属性名称

返回值 mixed

属性值或行为属性的值

抛出 yii\base\UnknownPropertyException

如果未定义属性

抛出 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

属性名称或事件名称

返回值 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

属性值

抛出 yii\base\UnknownPropertyException

如果未定义属性

抛出 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

属性名称

抛出 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 字符串|数组|yii\base\Behavior

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

返回值 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 数组 behaviors ( )
返回值 array

行为配置。

                public function behaviors()
{
    return [];
}

            
canGetProperty() 公共方法

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

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

如果满足以下条件,则可以读取属性:

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

另请参阅 canSetProperty()

public 布尔值 canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

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

返回值 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 布尔值 canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

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

返回值 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 字符串 className ( )
返回值 string

此类的完全限定名称。

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

            
clientValidateAttribute() 公共方法

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

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

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

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

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

attribute 对象包含以下属性:

  • id: 表单中用于唯一标识属性的 ID(例如“loginform-username”)
  • 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

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

返回值 字符串|null

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

                public function clientValidateAttribute($model, $attribute, $view)
{
    ValidationAsset::register($view);
    $options = $this->getClientOptions($model, $attribute);
    return 'yii.validation.file(attribute, messages, ' . Json::htmlEncode($options) . ');';
}

            
createValidator() 公共静态方法

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

创建一个验证器对象。

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

验证器类型。可以是:

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

要验证的数据模型。

$attributes 数组|字符串

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

$params array

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

返回值 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

行为的名称。

返回值 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 ( )
返回值 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

行为名称

返回值 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 ( )
返回值 yii\base\Behavior[]

附加到此组件的行为列表

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

            
getClientOptions() 公共方法(自版本 2.0.11 起可用)

返回客户端验证选项。

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

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

正在验证的模型

$attribute string

正在验证的属性名称

返回值 array

客户端验证选项

                public function getClientOptions($model, $attribute)
{
    $label = $model->getAttributeLabel($attribute);
    $options = [];
    if ($this->message !== null) {
        $options['message'] = $this->formatMessage($this->message, [
            'attribute' => $label,
        ]);
    }
    $options['skipOnEmpty'] = $this->skipOnEmpty;
    if (!$this->skipOnEmpty) {
        $options['uploadRequired'] = $this->formatMessage($this->uploadRequired, [
            'attribute' => $label,
        ]);
    }
    if ($this->mimeTypes !== null) {
        $mimeTypes = [];
        foreach ($this->mimeTypes as $mimeType) {
            $mimeTypes[] = new JsExpression(Html::escapeJsRegularExpression($this->buildMimeTypeRegexp($mimeType)));
        }
        $options['mimeTypes'] = $mimeTypes;
        $options['wrongMimeType'] = $this->formatMessage($this->wrongMimeType, [
            'attribute' => $label,
            'mimeTypes' => implode(', ', $this->mimeTypes),
        ]);
    }
    if ($this->extensions !== null) {
        $options['extensions'] = $this->extensions;
        $options['wrongExtension'] = $this->formatMessage($this->wrongExtension, [
            'attribute' => $label,
            'extensions' => implode(', ', $this->extensions),
        ]);
    }
    if ($this->minSize !== null) {
        $options['minSize'] = $this->minSize;
        $options['tooSmall'] = $this->formatMessage($this->tooSmall, [
            'attribute' => $label,
            'limit' => $this->minSize,
            'formattedLimit' => Yii::$app->formatter->asShortSize($this->minSize),
        ]);
    }
    if ($this->maxSize !== null) {
        $options['maxSize'] = $this->maxSize;
        $options['tooBig'] = $this->formatMessage($this->tooBig, [
            'attribute' => $label,
            'limit' => $this->getSizeLimit(),
            'formattedLimit' => Yii::$app->formatter->asShortSize($this->getSizeLimit()),
        ]);
    }
    if ($this->maxFiles !== null) {
        $options['maxFiles'] = $this->maxFiles;
        $options['tooMany'] = $this->formatMessage($this->tooMany, [
            'attribute' => $label,
            'limit' => $this->maxFiles,
        ]);
    }
    return $options;
}

            
getMimeTypeByFile() 受保护的方法(自版本 2.0.26 起可用)

通过文件路径获取 MIME 类型

protected string|null getMimeTypeByFile ( $filePath )
$filePath string
抛出 yii\base\InvalidConfigException

                protected function getMimeTypeByFile($filePath)
{
    return FileHelper::getMimeType($filePath);
}

            
getSizeLimit() 公共方法

返回上传文件允许的最大大小。

这根据以下四个因素确定:

  • php.ini 中的 'upload_max_filesize'
  • php.ini 中的 'post_max_size'
  • 'MAX_FILE_SIZE' 隐藏字段
  • $maxSize
public integer getSizeLimit ( )
返回值 integer

上传文件的尺寸限制。

                public function getSizeLimit()
{
    // Get the lowest between post_max_size and upload_max_filesize, log a warning if the first is < than the latter
    $limit = $this->sizeToBytes(ini_get('upload_max_filesize'));
    $postLimit = $this->sizeToBytes(ini_get('post_max_size'));
    if ($postLimit > 0 && $postLimit < $limit) {
        Yii::warning('PHP.ini\'s \'post_max_size\' is less than \'upload_max_filesize\'.', __METHOD__);
        $limit = $postLimit;
    }
    if ($this->maxSize !== null && $limit > 0 && $this->maxSize < $limit) {
        $limit = $this->maxSize;
    }
    if (isset($_POST['MAX_FILE_SIZE']) && $_POST['MAX_FILE_SIZE'] > 0 && $_POST['MAX_FILE_SIZE'] < $limit) {
        $limit = (int) $_POST['MAX_FILE_SIZE'];
    }
    return $limit;
}

            
getValidationAttributes() 公共方法(自版本 2.0.16 起可用)

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

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

public 数组|null getValidationAttributes ( $attributes null )
$attributes 数组|字符串|null

要验证的属性列表。

返回值 数组|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 布尔值 hasEventHandlers ( $name )
$name string

事件名称

返回值 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 布尔值 hasMethod ( $name, $checkBehaviors true )
$name string

属性名称

$checkBehaviors boolean

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

返回值 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 布尔值 hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

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

返回值 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', 'File upload failed.');
    }
    if ($this->uploadRequired === null) {
        $this->uploadRequired = Yii::t('yii', 'Please upload a file.');
    }
    if ($this->tooMany === null) {
        $this->tooMany = Yii::t('yii', 'You can upload at most {limit, number} {limit, plural, one{file} other{files}}.');
    }
    if ($this->tooFew === null) {
        $this->tooFew = Yii::t('yii', 'You should upload at least {limit, number} {limit, plural, one{file} other{files}}.');
    }
    if ($this->wrongExtension === null) {
        $this->wrongExtension = Yii::t('yii', 'Only files with these extensions are allowed: {extensions}.');
    }
    if ($this->tooBig === null) {
        $this->tooBig = Yii::t('yii', 'The file "{file}" is too big. Its size cannot exceed {formattedLimit}.');
    }
    if ($this->tooSmall === null) {
        $this->tooSmall = Yii::t('yii', 'The file "{file}" is too small. Its size cannot be smaller than {formattedLimit}.');
    }
    if (!is_array($this->extensions)) {
        $this->extensions = preg_split('/[\s,]+/', strtolower((string)$this->extensions), -1, PREG_SPLIT_NO_EMPTY);
    } else {
        $this->extensions = array_map('strtolower', $this->extensions);
    }
    if ($this->wrongMimeType === null) {
        $this->wrongMimeType = Yii::t('yii', 'Only files with these MIME types are allowed: {mimeTypes}.');
    }
    if (!is_array($this->mimeTypes)) {
        $this->mimeTypes = preg_split('/[\s,]+/', strtolower((string)$this->mimeTypes), -1, PREG_SPLIT_NO_EMPTY);
    } else {
        $this->mimeTypes = array_map('strtolower', $this->mimeTypes);
    }
}

            
isActive() 公共方法

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

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

如果验证器处于活动状态

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

场景名称

返回值 boolean

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

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

            
isEmpty() 公共方法

检查给定值是否为空。

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

public 布尔值 isEmpty ( $value, $trim false )
$value mixed

要检查的值

$trim boolean
返回值 boolean

值是否为空

                public function isEmpty($value, $trim = false)
{
    $value = is_array($value) ? reset($value) : $value;
    return !($value instanceof UploadedFile) || $value->error == UPLOAD_ERR_NO_FILE;
}

            
off() 公共方法

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

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

此方法与 on() 相反。

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

另请参阅 on()

public 布尔值 off ( $name, $handler null )
$name string

事件名称

$handler 可调用|null

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

返回值 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]);
    }
}

            
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 布尔型 validate ( $value, &$error null )
$value mixed

要验证的数据值。

$error 字符串|null

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

返回值 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)
{
    if ($this->maxFiles != 1 || $this->minFiles > 1) {
        $rawFiles = $model->$attribute;
        if (!is_array($rawFiles)) {
            $this->addError($model, $attribute, $this->uploadRequired);
            return;
        }
        $files = $this->filterFiles($rawFiles);
        $model->$attribute = $files;
        if (empty($files)) {
            $this->addError($model, $attribute, $this->uploadRequired);
            return;
        }
        $filesCount = count($files);
        if ($this->maxFiles && $filesCount > $this->maxFiles) {
            $this->addError($model, $attribute, $this->tooMany, ['limit' => $this->maxFiles]);
        }
        if ($this->minFiles && $this->minFiles > $filesCount) {
            $this->addError($model, $attribute, $this->tooFew, ['limit' => $this->minFiles]);
        }
        foreach ($files as $file) {
            $result = $this->validateValue($file);
            if (!empty($result)) {
                $this->addError($model, $attribute, $result[0], $result[1]);
            }
        }
    } else {
        $result = $this->validateValue($model->$attribute);
        if (!empty($result)) {
            $this->addError($model, $attribute, $result[0], $result[1]);
        }
    }
}

            
validateAttributes() 公共方法

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

验证指定的对象。

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

正在验证的数据模型

$attributes 数组|字符串|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);
            }
        }
    }
}

            
validateExtension() 受保护方法

检查给定的上传文件是否具有根据当前验证器设置的正确类型(扩展名)。

protected 布尔型 validateExtension ( $file )
$file yii\web\UploadedFile

                protected function validateExtension($file)
{
    $extension = mb_strtolower($file->extension, 'UTF-8');
    if ($this->checkExtensionByMimeType) {
        $mimeType = FileHelper::getMimeType($file->tempName, null, false);
        if ($mimeType === null) {
            return false;
        }
        $extensionsByMimeType = FileHelper::getExtensionsByMimeType($mimeType);
        if (!in_array($extension, $extensionsByMimeType, true)) {
            return false;
        }
    }
    if (!empty($this->extensions)) {
        foreach ((array) $this->extensions as $ext) {
            if ($extension === $ext || StringHelper::endsWith($file->name, ".$ext", false)) {
                return true;
            }
        }
        return false;
    }
    return true;
}

            
validateMimeType() 受保护方法 (自版本 2.0.8 起可用)

根据 $mimeTypes 属性中的列表检查 $file 的 mimeType。

另请参阅 $mimeTypes

protected 布尔型 validateMimeType ( $file )
$file yii\web\UploadedFile
返回值 boolean

$file 的 mimeType 是否允许

抛出 yii\base\InvalidConfigException

                protected function validateMimeType($file)
{
    $fileMimeType = $this->getMimeTypeByFile($file->tempName);
    if ($fileMimeType === null) {
        return false;
    }
    foreach ($this->mimeTypes as $mimeType) {
        if (strcasecmp($mimeType, $fileMimeType) === 0) {
            return true;
        }
        if (strpos($mimeType, '*') !== false && preg_match($this->buildMimeTypeRegexp($mimeType), $fileMimeType)) {
            return true;
        }
    }
    return false;
}

            
validateValue() 受保护方法

验证一个值。

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

protected 数组|null validateValue ( $value )
$value mixed

要验证的数据值。

返回值 数组|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。

抛出 yii\base\NotSupportedException

如果验证器不支持没有模型的数据验证

                protected function validateValue($value)
{
    if (!$value instanceof UploadedFile || $value->error == UPLOAD_ERR_NO_FILE) {
        return [$this->uploadRequired, []];
    }
    switch ($value->error) {
        case UPLOAD_ERR_OK:
            if ($this->maxSize !== null && $value->size > $this->getSizeLimit()) {
                return [
                    $this->tooBig,
                    [
                        'file' => $value->name,
                        'limit' => $this->getSizeLimit(),
                        'formattedLimit' => Yii::$app->formatter->asShortSize($this->getSizeLimit()),
                    ],
                ];
            } elseif ($this->minSize !== null && $value->size < $this->minSize) {
                return [
                    $this->tooSmall,
                    [
                        'file' => $value->name,
                        'limit' => $this->minSize,
                        'formattedLimit' => Yii::$app->formatter->asShortSize($this->minSize),
                    ],
                ];
            } elseif (!empty($this->extensions) && !$this->validateExtension($value)) {
                return [$this->wrongExtension, ['file' => $value->name, 'extensions' => implode(', ', $this->extensions)]];
            } elseif (!empty($this->mimeTypes) && !$this->validateMimeType($value)) {
                return [$this->wrongMimeType, ['file' => $value->name, 'mimeTypes' => implode(', ', $this->mimeTypes)]];
            }
            return null;
        case UPLOAD_ERR_INI_SIZE:
        case UPLOAD_ERR_FORM_SIZE:
            return [$this->tooBig, [
                'file' => $value->name,
                'limit' => $this->getSizeLimit(),
                'formattedLimit' => Yii::$app->formatter->asShortSize($this->getSizeLimit()),
            ]];
        case UPLOAD_ERR_PARTIAL:
            Yii::warning('File was only partially uploaded: ' . $value->name, __METHOD__);
            break;
        case UPLOAD_ERR_NO_TMP_DIR:
            Yii::warning('Missing the temporary folder to store the uploaded file: ' . $value->name, __METHOD__);
            break;
        case UPLOAD_ERR_CANT_WRITE:
            Yii::warning('Failed to write the uploaded file to disk: ' . $value->name, __METHOD__);
            break;
        case UPLOAD_ERR_EXTENSION:
            Yii::warning('File upload was stopped by some PHP extension: ' . $value->name, __METHOD__);
            break;
        default:
            break;
    }
    return [$this->message, []];
}