0 關注者

類別 yii\validators\UniqueValidator

繼承關係yii\validators\UniqueValidator » yii\validators\Validator » yii\base\Component » yii\base\BaseObject
實作介面yii\base\Configurable
自版本2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/validators/UniqueValidator.php

UniqueValidator 驗證屬性值在指定的資料庫表格中是否為唯一值。

UniqueValidator 檢查被驗證的值,在 ActiveRecord 類別 $targetClass 和屬性 $targetAttribute 所指定的表格欄位中是否為唯一值。

以下是使用此驗證器的驗證規則範例

// a1 needs to be unique
['a1', 'unique']
// a1 needs to be unique, but column a2 will be used to check the uniqueness of the a1 value
['a1', 'unique', 'targetAttribute' => 'a2']
// a1 and a2 need to be unique together, and they both will receive error message
[['a1', 'a2'], 'unique', 'targetAttribute' => ['a1', 'a2']]
// a1 and a2 need to be unique together, only a1 will receive error message
['a1', 'unique', 'targetAttribute' => ['a1', 'a2']]
// a1 needs to be unique by checking the uniqueness of both a2 and a3 (using a1 value)
['a1', 'unique', 'targetAttribute' => ['a2', 'a1' => 'a3']]

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$attributeNames 陣列 屬性名稱。 yii\validators\Validator
$attributes 陣列|字串 由此驗證器驗證的屬性。 yii\validators\Validator
$behaviors yii\base\Behavior[] 附加到此元件的行為列表。 yii\base\Component
$builtInValidators 陣列 內建驗證器列表 (名稱 => 類別或配置) yii\validators\Validator
$comboNotUnique 字串 yii\validators\UniqueValidator
$enableClientValidation 布林值 是否為此驗證器啟用客戶端驗證。 yii\validators\Validator
$except 陣列|字串 驗證器不應套用的情境。 yii\validators\Validator
$filter 字串|陣列|Closure 要應用於資料庫查詢的額外篩選器,用於檢查屬性值的唯一性。 yii\validators\UniqueValidator
$forceMasterDb 布林值 此驗證器是否強制始終使用主資料庫 yii\validators\UniqueValidator
$isEmpty 可呼叫|null 一個 PHP 可呼叫物件,用於替換 isEmpty() 的預設實作。 yii\validators\Validator
$message 字串 使用者定義的錯誤訊息。 yii\validators\UniqueValidator
$on 陣列|字串 驗證器可以套用的情境。 yii\validators\Validator
$skipOnEmpty 布林值 如果屬性值為 null 或空字串,是否應跳過此驗證規則。 yii\validators\Validator
$skipOnError 布林值 如果根據先前的某些規則,要驗證的屬性已經存在某些驗證錯誤,是否應跳過此驗證規則。 yii\validators\Validator
$targetAttribute 字串|陣列|null 應該用於驗證目前屬性值唯一性的 ActiveRecord 屬性名稱。 yii\validators\UniqueValidator
$targetAttributeJunction 字串 定義目標屬性之間如何關聯 (And|or)。 yii\validators\UniqueValidator
$targetClass 字串|null 應該用於驗證目前屬性值唯一性的 ActiveRecord 類別名稱。 yii\validators\UniqueValidator
$validationAttributes 陣列|null 屬性名稱列表。 yii\validators\Validator
$when 可呼叫|null 一個 PHP 可呼叫函式,其回傳值決定是否應套用此驗證器。 yii\validators\Validator
$whenClient 字串|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\UniqueValidator
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\UniqueValidator
validateAttributes() 驗證指定的物件。 yii\validators\Validator

保護方法

隱藏繼承的方法

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

屬性詳情

隱藏繼承的屬性

$comboNotUnique 公共屬性 (自版本 2.0.9 起可用)
自版本 2.0.10 起已棄用,將在 2.1 中移除。針對多個目標屬性設定自訂訊息,請使用 $message 屬性。
public 字串 $comboNotUnique null
$filter 公共屬性

要套用於資料庫查詢的其他篩選條件,用於檢查屬性值的唯一性。這可以是字串或陣列,代表額外的查詢條件 (請參閱 yii\db\Query::where() 關於查詢條件的格式),或帶有簽章 function ($query) 的匿名函式,其中 $query 是您可以函式中修改的 Query 物件。

public 字串|陣列|Closure $filter null
$forceMasterDb 公共屬性 (自版本 2.0.14 起可用)

此驗證器是否強制始終使用主資料庫

public 布林值 $forceMasterDb true
$message 公共屬性

使用者定義的錯誤訊息。

驗證單一屬性時,它可能包含以下佔位符,驗證器將相應地替換這些佔位符

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

驗證多個屬性時,它可能包含以下佔位符

  • {attributes}:正在驗證的屬性的標籤。
  • {values}:正在驗證的屬性的值。
public 字串 $message null
$targetAttribute 公共屬性

應該用於驗證目前屬性值唯一性的 ActiveRecord 屬性名稱。如果未設定,則會使用目前正在驗證的屬性名稱。您可以使用陣列來同時驗證多個欄位的唯一性。陣列值是要用於驗證唯一性的屬性,而陣列鍵是要驗證其值的屬性。

$targetAttributeJunction 公共屬性 (自版本 2.0.11 起可用)

定義目標屬性之間如何關聯 (And|or)。

$targetClass 公共屬性

應該用於驗證目前屬性值唯一性的 ActiveRecord 類別名稱。如果未設定,則會使用正在驗證的屬性的 ActiveRecord 類別。

另請參閱 $targetAttribute

public 字串|null $targetClass null

方法詳情

隱藏繼承的方法

__call() 公共方法

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

呼叫未定義為類別方法的具名方法。

此方法將檢查是否有任何附加的行為具有具名方法,並在可用時執行它。

請勿直接呼叫此方法,因為它是 PHP 魔術方法,將在叫用未知方法時隱式呼叫。

public mixed __call ( $name, $params )
$name 字串

方法名稱

$params 陣列

方法參數

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 陣列

將用於初始化物件屬性的名稱-值對

                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 字串

屬性名稱

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 布林值 __isset ( $name )
$name 字串

屬性名稱或事件名稱

return 布林值

具名屬性是否已設定

                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 字串

屬性名稱或事件名稱

$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 字串

屬性名稱

throws yii\base\InvalidCallException

如果屬性為唯讀。

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

            
addError() 公共方法

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

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

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

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

正在驗證的資料模型

$attribute 字串

正在驗證的屬性

$message 字串

錯誤訊息

$params 陣列

錯誤訊息中佔位符的值

                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 字串

行為的名稱。

$behavior 字串|陣列|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 陣列

要附加到組件的行為列表

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

            
behaviors() 公共方法

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

傳回此組件應表現為的行為列表。

子類別可以覆寫此方法,以指定它們想要表現為的行為。

此方法的回傳值應該是以行為名稱編制索引的行為物件或組態陣列。行為組態可以是指定行為類別的字串,或是以下結構的陣列

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

請注意,行為類別必須從 yii\base\Behavior 擴展而來。行為可以使用名稱或匿名方式附加。當名稱用作陣列鍵時,使用此名稱,稍後可以使用 getBehavior() 擷取行為,或使用 detachBehavior() 分離行為。匿名行為無法擷取或分離。

在此方法中宣告的行為將自動(按需)附加到組件。

public 陣列 behaviors ( )
return 陣列

行為組態。

                public function behaviors()
{
    return [];
}

            
canGetProperty() 公共方法

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

傳回一個值,指示是否可以讀取屬性。

如果符合以下條件,則可以讀取屬性

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

另請參閱 canSetProperty()

public 布林值 canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name 字串

屬性名稱

$checkVars 布林值

是否將成員變數視為屬性

$checkBehaviors 布林值

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

return 布林值

屬性是否可以讀取

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

            
canSetProperty() 公共方法

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

傳回一個值,指示是否可以設定屬性。

如果符合以下條件,則可以寫入屬性

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

另請參閱 canGetProperty()

public 布林值 canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name 字串

屬性名稱

$checkVars 布林值

是否將成員變數視為屬性

$checkBehaviors 布林值

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

return 布林值

屬性是否可以寫入

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

            
className() 公共靜態方法
自 2.0.14 版起已棄用。在 PHP >=5.5 上,請改用 ::class

定義於: yii\base\BaseObject::className()

傳回此類別的完整命名空間名稱。

public static 字串 className ( )
return 字串

此類別的完整命名空間名稱。

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

            
clientValidateAttribute() 公共方法

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

傳回執行用戶端驗證所需的 JavaScript。

呼叫 getClientOptions() 以產生用於用戶端驗證的選項陣列。

如果驗證器可以支援用戶端驗證,您可以覆寫此方法以傳回 JavaScript 驗證程式碼。

以下 JavaScript 變數是預先定義的,可以在驗證程式碼中使用

  • attribute:描述正在驗證的屬性的物件。
  • value:正在驗證的值。
  • messages:用於保存屬性的驗證錯誤訊息的陣列。
  • deferred:用於保存非同步驗證的延遲物件的陣列
  • $form:包含表單元素的 jQuery 物件

attribute 物件包含以下屬性

  • id:在表單中識別屬性的唯一 ID(例如 "loginform-username")
  • name:屬性名稱或運算式(例如,用於表格輸入的 "[0]content")
  • container:輸入欄位容器的 jQuery 選擇器
  • input:表單上下文中輸入欄位的 jQuery 選擇器
  • error:容器上下文中錯誤標籤的 jQuery 選擇器
  • status:輸入欄位的狀態,0:空,之前未輸入,1:已驗證,2:待驗證,3:正在驗證

另請參閱

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

正在驗證的資料模型

$attribute 字串

要驗證的屬性名稱。

$view yii\web\View

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

return 字串|null

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

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

            
createValidator() 公共靜態方法

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

建立驗證器物件。

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

驗證器類型。這可以是

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

要驗證的資料模型。

$attributes 陣列|字串

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

$params 陣列

要應用於驗證器屬性的初始值。

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

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

從組件分離行為。

將會調用行為的 yii\base\Behavior::detach() 方法。

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

行為的名稱。

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

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

從組件分離所有行為。

public void detachBehaviors ( )

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

            
ensureBehaviors() public method

定義於: 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 method (available since version 2.0.12)

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

使用 I18N 格式化訊息,如果 \Yii::$app 不可用,則使用簡單的 strtr。

protected string formatMessage ( $message, $params )
$message 字串
$params 陣列

                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 method (available since version 2.0.12)

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

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

public array getAttributeNames ( )
return 陣列

屬性名稱。

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

            
getBehavior() public method

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

傳回具名的行為物件。

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

行為名稱

return yii\base\Behavior|null

行為物件,如果行為不存在則為 null

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

            
getBehaviors() public method

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

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

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

附加到此元件的行為列表

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

            
getClientOptions() public method (available since version 2.0.11)

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

傳回用戶端驗證選項。

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

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

正在驗證的模型

$attribute 字串

正在驗證的屬性名稱

return 陣列

用戶端驗證選項

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

            
getValidationAttributes() public method (available since version 2.0.16)

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

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

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

要驗證的屬性列表。

return 陣列|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 method

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

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

public boolean hasEventHandlers ( $name )
$name 字串

事件名稱

return 布林值

是否有任何處理常式附加到事件。

                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

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

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

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

  • 類別具有指定名稱的方法
  • 附加的行為具有給定名稱的方法(當 $checkBehaviors 為 true 時)。
public boolean hasMethod ( $name, $checkBehaviors true )
$name 字串

屬性名稱

$checkBehaviors 布林值

是否將行為的方法視為此元件的方法

return 布林值

方法是否已定義

                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

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

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

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

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

另請參閱

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name 字串

屬性名稱

$checkVars 布林值

是否將成員變數視為屬性

$checkBehaviors 布林值

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

return 布林值

屬性是否已定義

                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();
    if ($this->message !== null) {
        return;
    }
    if (is_array($this->targetAttribute) && count($this->targetAttribute) > 1) {
        // fallback for deprecated `comboNotUnique` property - use it as message if is set
        if ($this->comboNotUnique === null) {
            $this->message = Yii::t('yii', 'The combination {values} of {attributes} has already been taken.');
        } else {
            $this->message = $this->comboNotUnique;
        }
    } else {
        $this->message = Yii::t('yii', '{attribute} "{value}" has already been taken.');
    }
}

            
isActive() public method

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

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

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

  • 驗證器的 on 屬性為空,或
  • 驗證器的 on 屬性包含指定的場景
public boolean isActive ( $scenario )
$scenario 字串

場景名稱

return 布林值

驗證器是否適用於指定的場景。

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

            
isEmpty() public method

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

檢查給定的值是否為空。

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

public boolean isEmpty ( $value )
$value mixed

要檢查的值

return 布林值

值是否為空

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

            
off() public method

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

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

此方法與 on() 相反。

注意:如果為事件名稱傳遞了萬用字元模式,則只會移除使用此萬用字元註冊的處理常式,而使用符合此萬用字元的純名稱註冊的處理常式將會保留。

另請參閱 on()

public boolean off ( $name, $handler null )
$name 字串

事件名稱

$handler 可呼叫|null

要移除的事件處理常式。如果為 null,則會移除附加到命名事件的所有處理常式。

return 布林值

如果找到並分離處理常式

                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

定義於: 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 字串

事件名稱

$handler 可呼叫

事件處理常式

$data mixed

事件觸發時要傳遞給事件處理常式的資料。當調用事件處理常式時,可以透過 yii\base\Event::$data 存取此資料。

$append 布林值

是否將新的事件處理常式附加到現有處理常式列表的末尾。如果為 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

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

觸發事件。

此方法表示事件的發生。它會調用事件的所有附加處理常式,包括類別層級的處理常式。

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

事件名稱

$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

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

驗證給定的值。

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

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

要驗證的資料值。

$error 字串|null

如果驗證失敗,要傳回的錯誤訊息。

return 布林值

資料是否有效。

                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 字串

要驗證的屬性名稱。

                public function validateAttribute($model, $attribute)
{
    $targetAttribute = $this->targetAttribute === null ? $attribute : $this->targetAttribute;
    if ($this->skipOnError) {
        foreach ((array)$targetAttribute as $k => $v) {
            if ($model->hasErrors(is_int($k) ? $v : $k)) {
                return;
            }
        }
    }
    $rawConditions = $this->prepareConditions($targetAttribute, $model, $attribute);
    $conditions = [$this->targetAttributeJunction === 'or' ? 'or' : 'and'];
    foreach ($rawConditions as $key => $value) {
        if (is_array($value)) {
            $this->addError($model, $attribute, Yii::t('yii', '{attribute} is invalid.'));
            return;
        }
        $conditions[] = [$key => $value];
    }
    /* @var $targetClass ActiveRecordInterface */
    $targetClass = $this->getTargetClass($model);
    $db = $targetClass::getDb();
    $modelExists = false;
    if ($this->forceMasterDb && method_exists($db, 'useMaster')) {
        $db->useMaster(function () use ($targetClass, $conditions, $model, &$modelExists) {
            $modelExists = $this->modelExists($targetClass, $conditions, $model);
        });
    } else {
        $modelExists = $this->modelExists($targetClass, $conditions, $model);
    }
    if ($modelExists) {
        if (is_array($targetAttribute) && count($targetAttribute) > 1) {
            $this->addComboNotUniqueError($model, $attribute);
        } else {
            $this->addError($model, $attribute, $this->message);
        }
    }
}

            
validateAttributes() public method

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

驗證指定的物件。

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

正在驗證的資料模型

$attributes array|string|null

要驗證的屬性列表。請注意,如果屬性未與驗證器關聯,則將會忽略它。如果此參數為 null,則將驗證 $attributes 中列出的每個屬性。

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

            
validateValue() protected method

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

驗證值。

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

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

要驗證的資料值。

return 陣列|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().');
}