0 關注者

類別 yii\validators\CompareValidator

繼承yii\validators\CompareValidator » yii\validators\Validator » yii\base\Component » yii\base\BaseObject
實作yii\base\Configurable
自版本起可用2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/validators/CompareValidator.php

CompareValidator 比較指定的屬性值與另一個值。

要比較的對象值可以是另一個屬性值(透過 $compareAttribute 指定)或常數(透過 $compareValue 指定)。當兩者皆指定時,以後者為優先。若兩者皆未指定,則屬性將與另一個屬性比較,該屬性的名稱是將 "_repeat" 附加到來源屬性名稱。

CompareValidator 支援不同的比較運算子,透過 $operator 屬性指定。

預設的比較函數是基於字串值,這表示值會逐位元組比較。當比較數字時,請務必將 $type 設定為 TYPE_NUMBER 以啟用數值比較。

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$attributeNames array 屬性名稱。 yii\validators\Validator
$attributes array|string 此驗證器要驗證的屬性。 yii\validators\Validator
$behaviors yii\base\Behavior[] 附加到此元件的行為列表。 yii\base\Component
$builtInValidators array 內建驗證器列表 (名稱 => 類別或配置) yii\validators\Validator
$compareAttribute string 要比較的屬性名稱。 yii\validators\CompareValidator
$compareValue mixed 要比較的常數值。 yii\validators\CompareValidator
$enableClientValidation boolean 是否为此验证器启用客户端验证。 yii\validators\Validator
$except array|string 驗證器不應套用的情境。 yii\validators\Validator
$isEmpty callable|null 一個 PHP 可呼叫物件,用於取代 isEmpty() 的預設實作。 yii\validators\Validator
$message string 使用者定義的錯誤訊息。 yii\validators\CompareValidator
$on array|string 驗證器可以套用的情境。 yii\validators\Validator
$operator string 比較的運算子。 yii\validators\CompareValidator
$skipOnEmpty boolean 如果屬性值為 null 或空字串,是否應跳過此驗證規則。 yii\validators\Validator
$skipOnError boolean 如果根據先前的規則,要驗證的屬性已經有一些驗證錯誤,是否應跳過此驗證規則。 yii\validators\Validator
$type string 要比較的值的類型。 yii\validators\CompareValidator
$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\CompareValidator
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\CompareValidator
getValidationAttributes() 傳回此驗證器套用的屬性列表。 yii\validators\Validator
hasEventHandlers() 傳回一個值,指示是否有名稱事件附加任何處理常式。 yii\base\Component
hasMethod() 傳回一個值,指示是否已定義方法。 yii\base\Component
hasProperty() 傳回一個值,指示是否為此元件定義了屬性。 yii\base\Component
init() 初始化物件。 yii\validators\CompareValidator
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\CompareValidator
validateAttributes() 驗證指定的物件。 yii\validators\Validator

保護方法

隱藏繼承的方法

方法 描述 定義於
compareValues() 使用指定的運算符比較兩個值。 yii\validators\CompareValidator
formatMessage() 如果 \Yii::$app 不可用,則使用 I18N 格式化訊息,或使用簡單的 strtr。 yii\validators\Validator
validateValue() 驗證一個值。 yii\validators\CompareValidator

常數

隱藏繼承的常數

常數 描述 定義於
TYPE_NUMBER 'number' 用於指定數值比較 $type 的常數。 yii\validators\CompareValidator
TYPE_STRING 'string' 用於指定數值比較 $type 的常數。 yii\validators\CompareValidator

屬性詳情

隱藏繼承的屬性

$compareAttribute 公開屬性

要比較的屬性名稱。當同時設定此屬性和 $compareValue 時,以後者為優先。如果兩者都未設定,則假定與另一個屬性進行比較,該屬性的名稱是通過將 '_repeat' 附加到正在驗證的屬性而形成的。例如,如果要驗證 'password',則要比較的屬性將是 'password_repeat'。

另請參閱 $compareValue

public string $compareAttribute null
$compareValue 公開屬性

要比較的常數值。當同時設定此屬性和 $compareAttribute 時,此屬性優先。

另請參閱 $compareAttribute

public mixed $compareValue null
$message 公開屬性

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

  • {attribute}:正在驗證的屬性的標籤
  • {value}:正在驗證的屬性的值
  • {compareValue}:要比較的屬性值或屬性標籤
  • {compareAttribute}:要比較的屬性的標籤
  • {compareValueOrAttribute}:要比較的屬性值或屬性標籤
public string $message null
$operator 公開屬性

比較的運算符。支援以下運算符

  • ==:檢查兩個值是否相等。比較以非嚴格模式完成。
  • ===:檢查兩個值是否相等。比較以嚴格模式完成。
  • !=:檢查兩個值是否不相等。比較以非嚴格模式完成。
  • !==:檢查兩個值是否不相等。比較以嚴格模式完成。
  • >:檢查正在驗證的值是否大於要比較的值。
  • >=:檢查正在驗證的值是否大於或等於要比較的值。
  • <:檢查正在驗證的值是否小於要比較的值。
  • <=:檢查正在驗證的值是否小於或等於要比較的值。

當您要比較數字時,請務必同時將 $type 設定為 number

public string $operator '=='
$type 公開屬性

要比較的數值的類型。支援以下類型

  • string:值將作為字串進行比較。比較前不會進行轉換。
  • number:值將作為數字進行比較。字串值將在比較前轉換為數字。
public string $type self::TYPE_STRING

方法詳情

隱藏繼承的方法

__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.dev.org.tw/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.dev.org.tw/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 string|array|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 array behaviors ( )
回傳 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

是否將行為的屬性視為此組件的屬性

回傳 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

是否將行為的屬性視為此組件的屬性

回傳 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 ( )
回傳 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

將用於呈現視圖或包含應用此驗證器的模型表單的視圖檔案的視圖物件。

回傳 string|null

客戶端驗證腳本。如果驗證器不支援客戶端驗證,則為 Null。

                public function clientValidateAttribute($model, $attribute, $view)
{
    if ($this->compareValue != null && $this->compareValue instanceof \Closure) {
        $this->compareValue = call_user_func($this->compareValue);
    }
    ValidationAsset::register($view);
    $options = $this->getClientOptions($model, $attribute);
    return 'yii.validation.compare(value, messages, ' . Json::htmlEncode($options) . ', $form);';
}

            
compareValues() 受保護方法

使用指定的運算符比較兩個值。

protected boolean compareValues ( $operator, $type, $value, $compareValue )
$operator string

比較運算符

$type string

要比較的數值的類型

$value mixed

正在比較的值

$compareValue mixed

另一個正在比較的值

回傳 boolean

使用指定的運算符進行比較是否為真。

                protected function compareValues($operator, $type, $value, $compareValue)
{
    if ($type === self::TYPE_NUMBER) {
        $value = (float) $value;
        $compareValue = (float) $compareValue;
    } else {
        $value = (string) $value;
        $compareValue = (string) $compareValue;
    }
    switch ($operator) {
        case '==':
            return $value == $compareValue;
        case '===':
            return $value === $compareValue;
        case '!=':
            return $value != $compareValue;
        case '!==':
            return $value !== $compareValue;
        case '>':
            return $value > $compareValue;
        case '>=':
            return $value >= $compareValue;
        case '<':
            return $value < $compareValue;
        case '<=':
            return $value <= $compareValue;
        default:
            return false;
    }
}

            
createValidator() 公開靜態方法

定義於: yii\validators\Validator::createValidator()

建立驗證器物件。

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

驗證器類型。這可以是下列其中一種

  • $builtInValidators 中列出的內建驗證器名稱;
  • 模型類別的方法名稱;
  • 匿名函式;
  • 驗證器類別名稱。
$model yii\base\Model

要驗證的資料模型。

$attributes array|string

要驗證的屬性列表。這可以是屬性名稱的陣列,或是逗號分隔的屬性名稱字串。

$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() public 方法

定義於: 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() public 方法

定義於: yii\base\Component::detachBehaviors()

從元件分離所有行為。

public void detachBehaviors ( )

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

            
ensureBehaviors() public 方法

定義於: 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() protected 方法 (自版本 2.0.12 起可用)

定義於: yii\validators\Validator::formatMessage()

如果 \Yii::$app 不可用,則使用 I18N 格式化訊息,或使用簡單的 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() public 方法 (自版本 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() public 方法

定義於: 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() public 方法

定義於: yii\base\Component::getBehaviors()

傳回附加到此元件的所有行為。

public yii\base\Behavior[] getBehaviors ( )
回傳 yii\base\Behavior[]

附加到此元件的行為列表

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

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

傳回客户端驗證選項。

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

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

正在驗證的模型

$attribute string

正在驗證的屬性名稱

回傳 array

客戶端驗證選項

                public function getClientOptions($model, $attribute)
{
    $options = [
        'operator' => $this->operator,
        'type' => $this->type,
    ];
    if ($this->compareValue !== null) {
        $options['compareValue'] = $this->compareValue;
        $compareLabel = $compareValue = $compareValueOrAttribute = $this->compareValue;
    } else {
        $compareAttribute = $this->compareAttribute === null ? $attribute . '_repeat' : $this->compareAttribute;
        $compareValue = $model->getAttributeLabel($compareAttribute);
        $options['compareAttribute'] = Html::getInputId($model, $compareAttribute);
        $options['compareAttributeName'] = Html::getInputName($model, $compareAttribute);
        $compareLabel = $compareValueOrAttribute = $model->getAttributeLabel($compareAttribute);
    }
    if ($this->skipOnEmpty) {
        $options['skipOnEmpty'] = 1;
    }
    $options['message'] = $this->formatMessage($this->message, [
        'attribute' => $model->getAttributeLabel($attribute),
        'compareAttribute' => $compareLabel,
        'compareValue' => $compareValue,
        'compareValueOrAttribute' => $compareValueOrAttribute,
    ]);
    return $options;
}

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

定義於: yii\validators\Validator::getValidationAttributes()

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

public array|null getValidationAttributes ( $attributes null )
$attributes 陣列|字串|null

要驗證的屬性列表。

回傳 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() public 方法

定義於: yii\base\Component::hasEventHandlers()

傳回一個值,指示是否有名稱事件附加任何處理常式。

public boolean 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() public 方法

定義於: yii\base\Component::hasMethod()

傳回一個值,指示是否已定義方法。

如果滿足以下條件,則定義了方法

  • 類別具有指定名稱的方法
  • 附加的行為具有給定名稱的方法(當 $checkBehaviors 為 true 時)。
public boolean 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() public 方法

定義於: yii\base\Component::hasProperty()

傳回一個值,指示是否為此元件定義了屬性。

如果滿足以下條件,則定義了屬性

  • 類別具有與指定名稱相關聯的 getter 或 setter 方法(在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數(當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的屬性(當 $checkBehaviors 為 true 時)。

另請參閱

public boolean 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 方法

初始化物件。

在使用給定的配置初始化物件後,此方法會在建構函式的結尾被調用。

public void init ( )

                public function init()
{
    parent::init();
    if ($this->message === null) {
        switch ($this->operator) {
            case '==':
            case '===':
                $this->message = Yii::t('yii', '{attribute} must be equal to "{compareValueOrAttribute}".');
                break;
            case '!=':
            case '!==':
                $this->message = Yii::t('yii', '{attribute} must not be equal to "{compareValueOrAttribute}".');
                break;
            case '>':
                $this->message = Yii::t('yii', '{attribute} must be greater than "{compareValueOrAttribute}".');
                break;
            case '>=':
                $this->message = Yii::t('yii', '{attribute} must be greater than or equal to "{compareValueOrAttribute}".');
                break;
            case '<':
                $this->message = Yii::t('yii', '{attribute} must be less than "{compareValueOrAttribute}".');
                break;
            case '<=':
                $this->message = Yii::t('yii', '{attribute} must be less than or equal to "{compareValueOrAttribute}".');
                break;
            default:
                throw new InvalidConfigException("Unknown operator: {$this->operator}");
        }
    }
}

            
isActive() public 方法

定義於: yii\validators\Validator::isActive()

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

如果滿足以下條件,則驗證器為活動狀態

  • 驗證器的 on 屬性為空,或
  • 驗證器的 on 屬性包含指定的場景
public boolean 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() public 方法

定義於: yii\validators\Validator::isEmpty()

檢查給定的值是否為空。

如果值為 null、空陣列或空字串,則該值被視為空。請注意,此方法與 PHP 的 empty() 不同。當值為 0 時,它將傳回 false。

public boolean isEmpty ( $value )
$value mixed

要檢查的值

回傳 boolean

值是否為空

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

            
off() public 方法

定義於: yii\base\Component::off()

從此元件分離現有的事件處理常式。

此方法與 on() 相反。

注意:如果為事件名稱傳遞了萬用字元模式,則只會移除使用此萬用字元註冊的處理器,而使用與此萬用字元匹配的純名稱註冊的處理器將保持不變。

另請參閱 on()

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

事件名稱

$handler callable|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() public 方法

定義於: 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 方法

定義於: 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 方法

定義於: yii\validators\Validator::validate()

驗證給定的值。

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

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

要驗證的資料值。

$error string|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 方法

驗證單一屬性。

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

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

要驗證的資料模型

$attribute string

要驗證的屬性的名稱。

                public function validateAttribute($model, $attribute)
{
    $value = $model->$attribute;
    if (is_array($value)) {
        $this->addError($model, $attribute, Yii::t('yii', '{attribute} is invalid.'));
        return;
    }
    if ($this->compareValue !== null) {
        if ($this->compareValue instanceof \Closure) {
            $this->compareValue = call_user_func($this->compareValue);
        }
        $compareLabel = $compareValue = $compareValueOrAttribute = $this->compareValue;
    } else {
        $compareAttribute = $this->compareAttribute === null ? $attribute . '_repeat' : $this->compareAttribute;
        $compareValue = $model->$compareAttribute;
        $compareLabel = $compareValueOrAttribute = $model->getAttributeLabel($compareAttribute);
        if (!$this->skipOnError && $model->hasErrors($compareAttribute)) {
            $this->addError(
                $model,
                $attribute,
                Yii::t('yii', '{compareAttribute} is invalid.'),
                ['compareAttribute' => $compareLabel]
            );
            return;
        }
    }
    if (!$this->compareValues($this->operator, $this->type, $value, $compareValue)) {
        $this->addError($model, $attribute, $this->message, [
            'compareAttribute' => $compareLabel,
            'compareValue' => $compareValue,
            'compareValueOrAttribute' => $compareValueOrAttribute,
        ]);
    }
}

            
validateAttributes() public 方法

定義於: 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);
            }
        }
    }
}

            
validateValue() protected 方法

驗證一個值。

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

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

要驗證的資料值。

回傳 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。

拋出 yii\base\NotSupportedException

如果驗證器不支援在沒有模型的情況下進行資料驗證

                protected function validateValue($value)
{
    if ($this->compareValue === null) {
        throw new InvalidConfigException('CompareValidator::compareValue must be set.');
    }
    if ($this->compareValue instanceof \Closure) {
        $this->compareValue = call_user_func($this->compareValue);
    }
    if (!$this->compareValues($this->operator, $this->type, $value, $this->compareValue)) {
        return [$this->message, [
            'compareAttribute' => $this->compareValue,
            'compareValue' => $this->compareValue,
            'compareValueOrAttribute' => $this->compareValue,
        ]];
    }
    return null;
}