1 位追蹤者

類別 yii\validators\Validator

繼承yii\validators\Validator » yii\base\Component » yii\base\BaseObject
實作yii\base\Configurable
子類別yii\captcha\CaptchaValidator, yii\validators\BooleanValidator, yii\validators\CompareValidator, yii\validators\DateValidator, yii\validators\DefaultValueValidator, yii\validators\EachValidator, yii\validators\EmailValidator, yii\validators\ExistValidator, yii\validators\FileValidator, yii\validators\FilterValidator, yii\validators\ImageValidator, yii\validators\InlineValidator, yii\validators\IpValidator, yii\validators\NumberValidator, yii\validators\RangeValidator, yii\validators\RegularExpressionValidator, yii\validators\RequiredValidator, yii\validators\SafeValidator, yii\validators\StringValidator, yii\validators\TrimValidator, yii\validators\UniqueValidator, yii\validators\UrlValidator
自版本起可用2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/validators/Validator.php

Validator 是所有驗證器的基礎類別。

子類別應覆寫 validateValue() 和/或 validateAttribute() 方法,以提供執行資料驗證的實際邏輯。子類別也可以覆寫 clientValidateAttribute(),以提供用戶端驗證支援。

Validator 宣告了一組內建驗證器,可以使用簡短名稱來參照。它們的列表如下

關於 Validator 的更多詳細資訊和使用方法,請參閱驗證器的指南文章

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$attributeNames array 屬性名稱。 yii\validators\Validator
$attributes array|string 由此驗證器驗證的屬性。 yii\validators\Validator
$behaviors yii\base\Behavior[] 附加到此元件的行為列表。 yii\base\Component
$builtInValidators array 內建驗證器列表 (名稱 => 類別或配置) yii\validators\Validator
$enableClientValidation boolean 是否為此驗證器啟用用戶端驗證。 yii\validators\Validator
$except array|string 驗證器不應套用的情境。 yii\validators\Validator
$isEmpty callable|null 一個 PHP 可呼叫物件,用於取代 isEmpty() 的預設實作。 yii\validators\Validator
$message string|null 使用者定義的錯誤訊息。 yii\validators\Validator
$on array|string 驗證器可以套用的情境。 yii\validators\Validator
$skipOnEmpty boolean 如果屬性值為 null 或空字串,是否應跳過此驗證規則。 yii\validators\Validator
$skipOnError boolean 如果正在驗證的屬性根據先前的規則已經有一些驗證錯誤,是否應跳過此驗證規則。 yii\validators\Validator
$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\Validator
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\Validator
validateAttributes() 驗證指定的物件。 yii\validators\Validator

受保護方法

隱藏繼承的方法

方法 描述 定義於
formatMessage() 使用 I18N 格式化訊息,如果 \Yii::$app 不可用,則使用簡單的 strtr。 yii\validators\Validator
validateValue() 驗證值。 yii\validators\Validator

屬性詳細資訊

隱藏繼承的屬性

$attributeNames 公開屬性

屬性名稱。

public array $attributeNames null
$attributes 公開屬性

由此驗證器驗證的屬性。對於多個屬性,請將它們指定為陣列;對於單個屬性,您可以使用字串或陣列。

public array|string $attributes = []
$builtInValidators 公開靜態屬性

內建驗證器列表 (名稱 => 類別或配置)

public static array $builtInValidators = [
    
'boolean' => 'yii\validators\BooleanValidator',
    
'captcha' => 'yii\captcha\CaptchaValidator',
    
'compare' => 'yii\validators\CompareValidator',
    
'date' => 'yii\validators\DateValidator',
    
'datetime' => [
        
'class' => 'yii\validators\DateValidator',
        
'type' => \yii\validators\DateValidator::TYPE_DATETIME,
    ],
    
'time' => [
        
'class' => 'yii\validators\DateValidator',
        
'type' => \yii\validators\DateValidator::TYPE_TIME,
    ],
    
'default' => 'yii\validators\DefaultValueValidator',
    
'double' => 'yii\validators\NumberValidator',
    
'each' => 'yii\validators\EachValidator',
    
'email' => 'yii\validators\EmailValidator',
    
'exist' => 'yii\validators\ExistValidator',
    
'file' => 'yii\validators\FileValidator',
    
'filter' => 'yii\validators\FilterValidator',
    
'image' => 'yii\validators\ImageValidator',
    
'in' => 'yii\validators\RangeValidator',
    
'integer' => [
        
'class' => 'yii\validators\NumberValidator',
        
'integerOnly' => true,
    ],
    
'match' => 'yii\validators\RegularExpressionValidator',
    
'number' => 'yii\validators\NumberValidator',
    
'required' => 'yii\validators\RequiredValidator',
    
'safe' => 'yii\validators\SafeValidator',
    
'string' => 'yii\validators\StringValidator',
    
'trim' => [
        
'class' => 'yii\validators\TrimValidator',
        
'skipOnArray' => true,
    ],
    
'unique' => 'yii\validators\UniqueValidator',
    
'url' => 'yii\validators\UrlValidator',
    
'ip' => 'yii\validators\IpValidator',
]
$enableClientValidation 公開屬性

是否為此驗證器啟用用戶端驗證。實際的用戶端驗證是透過 clientValidateAttribute() 傳回的 JavaScript 程式碼完成的。如果該方法傳回 null,即使此屬性為 true,此驗證器也不會執行用戶端驗證。

$except 公開屬性

驗證器不應套用的情境。對於多個情境,請將它們指定為陣列;對於單個情境,您可以使用字串或陣列。

public array|string $except = []
$isEmpty 公開屬性

一個 PHP 可呼叫物件,用於取代 isEmpty() 的預設實作。如果未設定,將使用 isEmpty() 來檢查值是否為空。可呼叫物件的簽名應為 function ($value),其傳回一個布林值,指示該值是否為空。

public callable|null $isEmpty null
$message 公開屬性

使用者定義的錯誤訊息。它可能包含以下佔位符,這些佔位符將由驗證器相應地替換

  • {attribute}: 正在驗證的屬性的標籤
  • {value}: 正在驗證的屬性的值

請注意,某些驗證器可能會引入其他屬性,用於在不滿足特定驗證條件時使用的錯誤訊息。有關這些屬性的詳細資訊,請參閱個別類別 API 文件。依照慣例,此屬性表示在不滿足最重要的驗證條件時使用的主要錯誤訊息。

public string|null $message null
$on 公開屬性

驗證器可以套用的情境。對於多個情境,請將它們指定為陣列;對於單個情境,您可以使用字串或陣列。

public array|string $on = []
$skipOnEmpty 公開屬性

如果屬性值為 null 或空字串,是否應跳過此驗證規則。此屬性僅在驗證 yii\base\Model 時使用。

public boolean $skipOnEmpty true
$skipOnError 公開屬性

如果正在驗證的屬性根據先前的規則已經有一些驗證錯誤,是否應跳過此驗證規則。預設為 true。

public boolean $skipOnError true
$validationAttributes 公開屬性

屬性名稱列表。

$when 公開屬性

一個 PHP 可呼叫物件,其傳回值決定是否應套用此驗證器。可呼叫物件的簽名應為 function ($model, $attribute),其中 $model$attribute 指的是目前正在驗證的模型和屬性。可呼叫物件應傳回一個布林值。

此屬性主要用於支援伺服器端的條件驗證。如果未設定此屬性,則始終在伺服器端套用此驗證器。

以下範例僅在目前選取的國家/地區為美國時啟用驗證器

function ($model) {
    return $model->country == Country::USA;
}

另請參閱 $whenClient

public callable|null $when null
$whenClient 公開屬性

一個 JavaScript 函數名稱,其傳回值決定是否應在用戶端套用此驗證器。函數的簽名應為 function (attribute, value),其中 attribute 是一個描述正在驗證的屬性的物件 (請參閱 clientValidateAttribute()),而 value 是屬性的目前值。

此屬性主要用於支援用戶端條件驗證。如果未設定此屬性,則始終在用戶端套用此驗證器。

以下範例僅在目前選取的國家/地區為美國時啟用驗證器

function (attribute, value) {
    return $('#country').val() === 'USA';
}

另請參閱 $when

public string|null $whenClient null

方法詳細資訊

隱藏繼承的方法

__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.dev.org.tw/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.dev.org.tw/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() 公有方法

將關於指定屬性的錯誤新增到模型物件。

這是一個輔助方法,用於執行訊息選擇和國際化。

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() 公有方法

傳回執行用戶端驗證所需的 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)
{
    return null;
}

            
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 版本起可用)

使用 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 版本起可用)

傳回已清除的屬性名稱,不包含開頭的 ! 字元。

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 版本起可用)

傳回用戶端驗證選項。

此方法通常從 clientValidateAttribute() 呼叫。 您可以覆寫此方法以修改將傳遞給客戶端驗證的選項。

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

正在被驗證的模型

$attribute string

正在被驗證的屬性名稱

return array

客戶端驗證選項

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

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

傳回此驗證器套用的屬性列表。

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() public method

Defined in: 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() public method

Defined in: 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 method

初始化物件。

此方法在建構函式結束時調用,在物件使用給定組態初始化之後。

public void init ( )

                public function init()
{
    parent::init();
    $this->attributes = (array) $this->attributes;
    $this->on = (array) $this->on;
    $this->except = (array) $this->except;
}

            
isActive() public method

傳回一個值,指示驗證器是否對給定的情境和屬性處於活動狀態。

驗證器在以下情況下為啟用狀態:

  • 驗證器的 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() public method

檢查給定的值是否為空。

如果值為 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() public method

Defined in: 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() public method

Defined in: 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() public method

Defined in: 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() public method

驗證給定的值。

您可以使用此方法在資料模型的上下文之外驗證值。

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 method

驗證單個屬性。

子類別必須實作此方法以提供實際的驗證邏輯。

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

要驗證的資料模型

$attribute string

要驗證的屬性名稱。

                public function validateAttribute($model, $attribute)
{
    $result = $this->validateValue($model->$attribute);
    if (!empty($result)) {
        $this->addError($model, $attribute, $result[0], $result[1]);
    }
}

            
validateAttributes() public method

驗證指定的物件。

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 method

驗證值。

驗證器類別可以實作此方法,以支援在資料模型上下文之外進行資料驗證。

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)
{
    throw new NotSupportedException(get_class($this) . ' does not support validateValue().');
}