0 追蹤者

類別 yii\validators\RequiredValidator

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

RequiredValidator 驗證指定的屬性是否沒有 null 或空值。

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$attributeNames array 屬性名稱。 yii\validators\Validator
$attributes array|string 此驗證器要驗證的屬性。 yii\validators\Validator
$behaviors yii\base\Behavior[] 附加到此元件的行為列表。 yii\base\Component
$builtInValidators array 內建驗證器列表 (name => class 或組態) yii\validators\Validator
$enableClientValidation boolean 是否為此驗證器啟用用戶端驗證。 yii\validators\Validator
$except array|string 驗證器不應套用的情境。 yii\validators\Validator
$isEmpty callable|null 一個 PHP 可呼叫物件,用於取代 isEmpty() 的預設實作。 yii\validators\Validator
$message string 使用者定義的錯誤訊息。 yii\validators\RequiredValidator
$on array|string 驗證器可套用的情境。 yii\validators\Validator
$requiredValue mixed 屬性必須擁有的期望值。 yii\validators\RequiredValidator
$skipOnEmpty boolean 如果要驗證的值為空值,是否跳過此驗證器。 yii\validators\RequiredValidator
$skipOnError boolean 如果根據先前的規則,要驗證的屬性已經有一些驗證錯誤,是否應跳過此驗證規則。 yii\validators\Validator
$strict boolean 屬性值與 $requiredValue 之間的比較是否為嚴格模式。 yii\validators\RequiredValidator
$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\RequiredValidator
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\RequiredValidator
getValidationAttributes() 傳回此驗證器套用的屬性列表。 yii\validators\Validator
hasEventHandlers() 傳回一個值,指示是否有名稱事件的任何處理常式附加。 yii\base\Component
hasMethod() 傳回一個值,指示是否已定義方法。 yii\base\Component
hasProperty() 傳回一個值,指示是否為此元件定義了屬性。 yii\base\Component
init() 初始化物件。 yii\validators\RequiredValidator
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\RequiredValidator

屬性詳細資訊

隱藏繼承的屬性

$message 公開屬性

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

  • {attribute}:正在驗證的屬性的標籤
  • {value}:正在驗證的屬性的值
  • {requiredValue}$requiredValue 的值
public string $message null
$requiredValue 公開屬性

屬性必須擁有的期望值。 如果為 null,則驗證器將驗證指定的屬性是否為非空值。 如果設定為非 null 值,則驗證器將驗證屬性的值是否與此屬性值相同。 預設值為 null。

另請參閱 $strict

public mixed $requiredValue null
$skipOnEmpty 公開屬性

如果要驗證的值為空值,是否跳過此驗證器。

public boolean $skipOnEmpty false
$strict 公開屬性

屬性值與 $requiredValue 之間的比較是否為嚴格模式。 如果為 true,則值和類型都必須相符。 預設值為 false,表示只需要值相符。

請注意,當 $requiredValue 為 null 時的行為如下

  • 在嚴格模式下,驗證器將檢查屬性值是否為 null
  • 在非嚴格模式下,驗證將會失敗
public boolean $strict false

方法詳細資訊

隱藏繼承的方法

__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

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

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

$name

是否將成員變數視為屬性 boolean

$checkBehaviors

是否將行為的屬性視為此元件的屬性 boolean

屬性是否可讀取

return boolean

canSetProperty() 公開方法

                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;
}

            

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

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

類別具有與指定名稱關聯的 setter 方法 (在這種情況下,屬性名稱不區分大小寫);

  • 附加的行為具有給定名稱的可寫屬性 (當 $checkBehaviors 為 true 時)。
  • 類別具有具有指定名稱的成員變數 (當 $checkVars 為 true 時);
  • 另請參閱 canGetProperty()

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )

屬性是否可寫入
$name string

$name

是否將成員變數視為屬性 boolean

$checkBehaviors

是否將行為的屬性視為此元件的屬性 boolean

屬性是否可讀取

return boolean

className() 公開靜態方法

                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;
}

            
自 2.0.14 版起已棄用。 在 PHP >=5.5 上,請改用 ::class

public static string className ( )

傳回此類別的完整限定名稱。

此類別的完整限定名稱。
return string

clientValidateAttribute() 公開方法

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

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

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

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

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

attribute:描述正在驗證的屬性的物件。

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

id:在表單中識別屬性的唯一 ID (例如 "loginform-username")

  • name:屬性名稱或表達式 (例如表格輸入的 "[0]content")
  • container:輸入欄位容器的 jQuery 選擇器
  • input:表單上下文中輸入欄位的 jQuery 選擇器
  • error:容器上下文中錯誤標籤的 jQuery 選擇器
  • status:輸入欄位的狀態,0:空,之前未輸入,1:已驗證,2:待驗證,3:正在驗證
  • public string|null clientValidateAttribute ( $model, $attribute, $view )
要驗證的屬性名稱。
$model yii\base\Model

正在驗證的資料模型

$attribute string

$view

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

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

return string|null

createValidator() 公開靜態方法

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

            

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

建立驗證器物件。

$type
string|Closure 驗證器類型。 這可以是下列其中一項

$builtInValidators 中列出的內建驗證器名稱;

  • 模型類別的方法名稱;
  • 匿名函式;
  • 驗證器類別名稱。
  • 要驗證的資料模型。
$model yii\base\Model

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

$attributes array|string

$params

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

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

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

protected string formatMessage ( $message, $params )
$message string
$params array

                protected function formatMessage($message, $params)
{
    if (Yii::$app !== null) {
        return \Yii::$app->getI18n()->format($message, $params, Yii::$app->language);
    }
    $placeholders = [];
    foreach ((array) $params as $name => $value) {
        $placeholders['{' . $name . '}'] = $value;
    }
    return ($placeholders === []) ? $message : strtr($message, $placeholders);
}

            
getAttributeNames() 公開方法 (自版本 2.0.12 起可用)

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

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

public array getAttributeNames ( )
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)
{
    $options = [];
    if ($this->requiredValue !== null) {
        $options['message'] = $this->formatMessage($this->message, [
            'requiredValue' => $this->requiredValue,
        ]);
        $options['requiredValue'] = $this->requiredValue;
    } else {
        $options['message'] = $this->message;
    }
    if ($this->strict) {
        $options['strict'] = 1;
    }
    $options['message'] = $this->formatMessage($options['message'], [
        'attribute' => $model->getAttributeLabel($attribute),
    ]);
    return $options;
}

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

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

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

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

要驗證的屬性列表。

return array|null

屬性名稱列表。

                public function getValidationAttributes($attributes = null)
{
    if ($attributes === null) {
        return $this->getAttributeNames();
    }
    if (is_scalar($attributes)) {
        $attributes = [$attributes];
    }
    $newAttributes = [];
    $attributeNames = $this->getAttributeNames();
    foreach ($attributes as $attribute) {
        // do not strict compare, otherwise int attributes would fail due to to string conversion in getAttributeNames() using ltrim().
        if (in_array($attribute, $attributeNames, false)) {
            $newAttributes[] = $attribute;
        }
    }
    return $newAttributes;
}

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

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

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

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

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

$name

是否將行為的屬性視為此元件的屬性 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() 公開方法

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

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

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

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

另請參閱

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

$name

是否將成員變數視為屬性 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 void init ( )

                public function init()
{
    parent::init();
    if ($this->message === null) {
        $this->message = $this->requiredValue === null ? Yii::t('yii', '{attribute} cannot be blank.')
            : Yii::t('yii', '{attribute} must be "{requiredValue}".');
    }
}

            
isActive() 公開方法

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

傳回一個值,指示驗證器是否對給定的情境和屬性處於作用中。

如果符合以下條件,驗證器為 active

  • 驗證器的 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() 公開方法

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

檢查給定的值是否為空值。

如果值為 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() 公開方法

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

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

將事件處理常式附加到事件。

事件處理常式必須是有效的 PHP 回呼。以下是一些範例

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

事件處理常式必須使用以下簽章定義,

function ($event)

其中 $event 是一個 yii\base\Event 物件,其中包含與事件相關聯的參數。

自 2.0.14 版本起,您可以將事件名稱指定為萬用字元模式

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

另請參閱 off()

public void on ( $name, $handler, $data null, $append true )
$name string

事件名稱

$handler 可呼叫

事件處理常式

$data mixed

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

$append boolean

是否將新的事件處理常式附加到現有處理常式列表的末尾。如果為 false,則新的處理常式將插入到現有處理常式列表的開頭。

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
trigger() 公開方法

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

觸發事件。

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

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

事件名稱

$event yii\base\Event|null

事件實例。如果未設定,將會建立預設的 yii\base\Event 物件。

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}

            
validate() 公開方法

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

驗證給定的值。

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

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

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

驗證單一屬性。

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

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

要驗證的資料模型

$attribute string

$view

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

            
validateAttributes() 公開方法

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

驗證指定的物件。

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

正在驗證的資料模型

$attributes 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 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)
{
    if ($this->requiredValue === null) {
        if ($this->strict && $value !== null || !$this->strict && !$this->isEmpty(is_string($value) ? trim($value) : $value)) {
            return null;
        }
    } elseif (!$this->strict && $value == $this->requiredValue || $this->strict && $value === $this->requiredValue) {
        return null;
    }
    if ($this->requiredValue === null) {
        return [$this->message, []];
    }
    return [$this->message, [
        'requiredValue' => $this->requiredValue,
    ]];
}