类 yii\validators\ImageValidator
ImageValidator 验证属性是否接收有效图像。
公共属性
公共方法
受保护的方法
方法 | 描述 | 定义于 |
---|---|---|
formatMessage() | 使用 I18N 格式化消息,或者如果 \Yii::$app 不可用,则使用简单的 strtr 格式化消息。 |
yii\validators\Validator |
getMimeTypeByFile() | 根据文件路径获取 MIME 类型 | yii\validators\FileValidator |
validateExtension() | 检查给定上传的文件是否具有当前验证器设置的正确类型(扩展名)。 | yii\validators\FileValidator |
validateImage() | 验证图像文件。 | yii\validators\ImageValidator |
validateMimeType() | 将 $file 的 mimeType 与 $mimeTypes 属性中的列表进行比较。 | yii\validators\FileValidator |
validateValue() | 验证值。 | yii\validators\ImageValidator |
属性详细信息
最大宽度(以像素为单位)。默认为 null,表示没有限制。
有关图像高度过大时使用的自定义消息,请参阅 $overHeight。
最大宽度(以像素为单位)。默认为 null,表示没有限制。
有关图像宽度过大时使用的自定义消息,请参阅 $overWidth。
最小高度(以像素为单位)。默认为 null,表示没有限制。
有关图像高度过小时使用的自定义消息,请参阅 $underHeight。
最小宽度(以像素为单位)。默认为 null,表示没有限制。
有关图像宽度过小时使用的自定义消息,请参阅 $underWidth。
上传文件不是图像时使用的错误消息。您可以在消息中使用以下标记
- {attribute}: 属性名称
- {file}: 上传的文件名
图像超过 $maxHeight 时使用的错误消息。您可以在消息中使用以下标记
- {attribute}: 属性名称
- {file}: 上传的文件名
- {limit}: $maxHeight 的值
图像小于 $minHeight 时使用的错误消息。您可以在消息中使用以下标记
- {attribute}: 属性名称
- {file}: 上传的文件名
- {limit}: $minHeight 的值
方法详细信息
定义于: 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()");
}
public void __clone ( ) |
public function __clone()
{
$this->_events = [];
$this->_eventWildcards = [];
$this->_behaviors = null;
}
定义于: 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();
}
定义于: 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);
}
定义于: yii\base\Component::__isset()
检查属性是否已设置,即已定义且不为空。
此方法将按以下顺序检查并相应地执行
- 通过 setter 定义的属性:返回属性是否已设置
- 行为的属性:返回属性是否已设置
- 对于不存在的属性,返回
false
不要直接调用此方法,因为它是一个 PHP 魔术方法,将在执行 isset($component->property)
时隐式调用。
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;
}
定义于: 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);
}
定义于: yii\base\Component::__unset()
将组件属性设置为 null。
此方法将按以下顺序检查并相应地执行
- 通过 setter 定义的属性:将属性值设置为 null
- 行为的属性:将属性值设置为 null
不要直接调用此方法,因为它是一个 PHP 魔术方法,将在执行 unset($component->property)
时隐式调用。
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);
}
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));
}
定义于: 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);
}
定义于: 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);
}
}
定义于: 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 [];
}
定义于: 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;
}
定义于: 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;
}
::class
代替。
定义于: yii\base\BaseObject::className()
返回此类的完全限定名。
public static string className ( ) | ||
return | string |
此类的完全限定名称。 |
---|
public static function className()
{
return get_called_class();
}
返回用于执行客户端验证所需的 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 |
将用于渲染视图或包含应用此验证器的模型表单的视图文件的视图对象。 |
return | string|null |
客户端验证脚本。如果验证器不支持客户端验证,则为 null。 |
---|
public function clientValidateAttribute($model, $attribute, $view)
{
ValidationAsset::register($view);
$options = $this->getClientOptions($model, $attribute);
return 'yii.validation.image(attribute, messages, ' . Json::htmlEncode($options) . ', deferred);';
}
定义于: yii\validators\Validator::createValidator()
创建一个验证器对象。
public static yii\validators\Validator createValidator ( $type, $model, $attributes, $params = [] ) | ||
$type | string|Closure |
验证器类型。可以是:
|
$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);
}
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;
}
定义于: yii\base\Component::detachBehaviors()
从组件中分离所有行为。
public void detachBehaviors ( ) |
public function detachBehaviors()
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $name => $behavior) {
$this->detachBehavior($name);
}
}
定义于: 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);
}
}
}
定义于: 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);
}
定义于: yii\validators\Validator::getAttributeNames()
返回清除的属性名称,没有开头的 !
字符。
public array getAttributeNames ( ) | ||
return | array |
属性名称。 |
---|
public function getAttributeNames()
{
return array_map(function ($attribute) {
return ltrim($attribute, '!');
}, $this->attributes);
}
定义于: 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;
}
定义于: yii\base\Component::getBehaviors()
返回附加到此组件的所有行为。
public yii\base\Behavior[] getBehaviors ( ) | ||
return | yii\base\Behavior[] |
附加到此组件的行为列表 |
---|
public function getBehaviors()
{
$this->ensureBehaviors();
return $this->_behaviors;
}
返回客户端验证选项。
此方法通常从 clientValidateAttribute() 调用。您可以重写此方法来修改将传递给客户端验证的选项。
public array getClientOptions ( $model, $attribute ) | ||
$model | yii\base\Model |
正在验证的模型 |
$attribute | string |
正在验证的属性名称 |
return | array |
客户端验证选项 |
---|
public function getClientOptions($model, $attribute)
{
$options = parent::getClientOptions($model, $attribute);
$label = $model->getAttributeLabel($attribute);
if ($this->notImage !== null) {
$options['notImage'] = $this->formatMessage($this->notImage, [
'attribute' => $label,
]);
}
if ($this->minWidth !== null) {
$options['minWidth'] = $this->minWidth;
$options['underWidth'] = $this->formatMessage($this->underWidth, [
'attribute' => $label,
'limit' => $this->minWidth,
]);
}
if ($this->maxWidth !== null) {
$options['maxWidth'] = $this->maxWidth;
$options['overWidth'] = $this->formatMessage($this->overWidth, [
'attribute' => $label,
'limit' => $this->maxWidth,
]);
}
if ($this->minHeight !== null) {
$options['minHeight'] = $this->minHeight;
$options['underHeight'] = $this->formatMessage($this->underHeight, [
'attribute' => $label,
'limit' => $this->minHeight,
]);
}
if ($this->maxHeight !== null) {
$options['maxHeight'] = $this->maxHeight;
$options['overHeight'] = $this->formatMessage($this->overHeight, [
'attribute' => $label,
'limit' => $this->maxHeight,
]);
}
return $options;
}
定义于: yii\validators\FileValidator::getMimeTypeByFile()
根据文件路径获取 MIME 类型
protected string|null getMimeTypeByFile ( $filePath ) | ||
$filePath | string | |
throws | yii\base\InvalidConfigException |
---|
protected function getMimeTypeByFile($filePath)
{
return FileHelper::getMimeType($filePath);
}
定义于: yii\validators\FileValidator::getSizeLimit()
返回允许上传文件的最大尺寸。
这取决于四个因素
- php.ini 中的 'upload_max_filesize'
- php.ini 中的 'post_max_size'
- 'MAX_FILE_SIZE' 隐藏字段
- $maxSize
public integer getSizeLimit ( ) | ||
return | 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;
}
定义于: 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;
}
定义于: 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);
}
定义于: 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;
}
定义于: 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);
}
初始化对象。
此方法在构造函数结束后调用,对象使用给定的配置初始化后。
public void init ( ) |
public function init()
{
parent::init();
if ($this->notImage === null) {
$this->notImage = Yii::t('yii', 'The file "{file}" is not an image.');
}
if ($this->underWidth === null) {
$this->underWidth = Yii::t('yii', 'The image "{file}" is too small. The width cannot be smaller than {limit, number} {limit, plural, one{pixel} other{pixels}}.');
}
if ($this->underHeight === null) {
$this->underHeight = Yii::t('yii', 'The image "{file}" is too small. The height cannot be smaller than {limit, number} {limit, plural, one{pixel} other{pixels}}.');
}
if ($this->overWidth === null) {
$this->overWidth = Yii::t('yii', 'The image "{file}" is too large. The width cannot be larger than {limit, number} {limit, plural, one{pixel} other{pixels}}.');
}
if ($this->overHeight === null) {
$this->overHeight = Yii::t('yii', 'The image "{file}" is too large. The height cannot be larger than {limit, number} {limit, plural, one{pixel} other{pixels}}.');
}
}
定义于: 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));
}
定义在: yii\validators\FileValidator::isEmpty()
检查给定值是否为空。
如果值为空,空数组或空字符串,则认为为空。请注意,此方法与 PHP empty() 不同。当值为 0 时,它将返回 false。
public boolean isEmpty ( $value, $trim = false ) | ||
$value | mixed |
要检查的值 |
$trim | boolean | |
return | boolean |
该值是否为空 |
---|
public function isEmpty($value, $trim = false)
{
$value = is_array($value) ? reset($value) : $value;
return !($value instanceof UploadedFile) || $value->error == UPLOAD_ERR_NO_FILE;
}
定义在: 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;
}
将事件处理程序附加到事件。
事件处理程序必须是一个有效的 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 | callable |
事件处理程序 |
$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]);
}
}
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);
}
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;
}
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]);
}
}
}
定义在: 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);
}
}
}
}
定义在: yii\validators\FileValidator::validateExtension()
检查给定上传的文件是否具有当前验证器设置的正确类型(扩展名)。
protected boolean 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;
}
验证图像文件。
protected array|null validateImage ( $image ) | ||
$image | yii\web\UploadedFile |
上传的文件,通过一组规则进行检查 |
return | array|null |
错误消息和要插入错误消息的参数。如果数据有效,应返回 Null。 |
---|
protected function validateImage($image)
{
if (false === ($imageInfo = getimagesize($image->tempName))) {
return [$this->notImage, ['file' => $image->name]];
}
list($width, $height) = $imageInfo;
if ($width == 0 || $height == 0) {
return [$this->notImage, ['file' => $image->name]];
}
if ($this->minWidth !== null && $width < $this->minWidth) {
return [$this->underWidth, ['file' => $image->name, 'limit' => $this->minWidth]];
}
if ($this->minHeight !== null && $height < $this->minHeight) {
return [$this->underHeight, ['file' => $image->name, 'limit' => $this->minHeight]];
}
if ($this->maxWidth !== null && $width > $this->maxWidth) {
return [$this->overWidth, ['file' => $image->name, 'limit' => $this->maxWidth]];
}
if ($this->maxHeight !== null && $height > $this->maxHeight) {
return [$this->overHeight, ['file' => $image->name, 'limit' => $this->maxHeight]];
}
return null;
}
定义在: yii\validators\FileValidator::validateMimeType()
将 $file 的 mimeType 与 $mimeTypes 属性中的列表进行比较。
另请参阅 $mimeTypes.
protected boolean validateMimeType ( $file ) | ||
$file | yii\web\UploadedFile | |
return | boolean |
$file 的 mimeType 是否允许 |
---|---|---|
throws | 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;
}
验证值。
验证器类可以实现此方法来支持在数据模型之外进行数据验证。
protected array|null validateValue ( $value ) | ||
$value | mixed |
要验证的数据值。 |
return | array|null |
错误消息和要插入错误消息的参数数组。
} return null; 如果数据有效,则应返回 Null。 |
---|---|---|
throws | yii\base\NotSupportedException |
如果验证器不支持在没有模型的情况下进行数据验证 |
protected function validateValue($value)
{
$result = parent::validateValue($value);
return empty($result) ? $this->validateImage($value) : $result;
}
注册 或 登录 才能发表评论。