0 追蹤者

類別 yii\validators\DateValidator

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

DateValidator 驗證屬性是否以正確的 $format 格式表示日期、時間或日期時間。

它也可以解析特定 $locale 中的國際化日期,例如當 $format 配置為使用 ICU 格式的時間模式時,可以解析 12 мая 2014

此外,還可以使用 $min$max 將日期限制在特定範圍內。

除了驗證日期之外,它還可以導出已解析的時間戳記作為機器可讀格式,這可以使用 $timestampAttribute 進行配置。對於包含時間資訊的值(非僅日期值),時區也會被調整。輸入值的時區假定為 $timeZone 屬性指定的時區,而目標時區在 $timestampAttributeFormatnull(導出為 UNIX 時間戳記)或 $timestampAttributeTimeZone 時將為 UTC。如果您想避免時區轉換,請確保 $timeZone$timestampAttributeTimeZone 相同。

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$attributeNames array 屬性名稱。 yii\validators\Validator
$attributes array|string 此驗證器要驗證的屬性。 yii\validators\Validator
$behaviors yii\base\Behavior[] 附加到此組件的行為列表。 yii\base\Component
$builtInValidators array 內建驗證器列表 (名稱 => 類別或配置) yii\validators\Validator
$defaultTimeZone string 當格式中未提供時間部分時,用於解析的預設時區。 yii\validators\DateValidator
$enableClientValidation boolean 是否為此驗證器啟用客戶端驗證。 yii\validators\Validator
$except array|string 驗證器不應套用的情境。 yii\validators\Validator
$format string|null 要驗證的值應遵循的日期格式。 yii\validators\DateValidator
$isEmpty callable|null 一個 PHP 可呼叫物件,用於取代 isEmpty() 的預設實作。 yii\validators\Validator
$locale string|null 用於本地化日期解析的語系 ID。 yii\validators\DateValidator
$max integer|string|null 日期的上限。 yii\validators\DateValidator
$maxString string|null 在錯誤訊息中顯示的上限的使用者友善值。 yii\validators\DateValidator
$message string|null 使用者定義的錯誤訊息。 yii\validators\Validator
$min integer|string|null 日期的下限。 yii\validators\DateValidator
$minString string|null 在錯誤訊息中顯示的下限的使用者友善值。 yii\validators\DateValidator
$on array|string 驗證器可以套用的情境。 yii\validators\Validator
$skipOnEmpty boolean 如果屬性值為 null 或空字串,是否應跳過此驗證規則。 yii\validators\Validator
$skipOnError boolean 如果正在驗證的屬性根據先前的規則已經存在一些驗證錯誤,是否應跳過此驗證規則。 yii\validators\Validator
$strictDateFormat boolean 如果您需要嚴格的日期格式驗證,請將此參數設定為 true(例如,只有以下日期才能通過 'yyyy-MM-dd' 格式的驗證:'0011-03-25'、'2019-04-30' 等。 yii\validators\DateValidator
$timeZone string|null 用於解析日期和時間值的時區。 yii\validators\DateValidator
$timestampAttribute string|null 用於接收解析結果的屬性名稱。 yii\validators\DateValidator
$timestampAttributeFormat string|null 用於填充 $timestampAttribute 的格式。 yii\validators\DateValidator
$timestampAttributeTimeZone string 使用 $timestampAttributeFormat 填充 $timestampAttribute 時要使用的時區。 yii\validators\DateValidator
$tooBig string 當值大於 $max 時使用的使用者定義錯誤訊息。 yii\validators\DateValidator
$tooSmall string 當值小於 $min 時使用的使用者定義錯誤訊息。 yii\validators\DateValidator
$type string 驗證器的類型。 yii\validators\DateValidator
$validationAttributes array|null 屬性名稱列表。 yii\validators\Validator
$when callable|null 一個 PHP 可呼叫物件,其傳回值決定是否應套用此驗證器。 yii\validators\Validator
$whenClient string|null 一個 JavaScript 函數名稱,其傳回值決定是否應在客戶端套用此驗證器。 yii\validators\Validator

公開方法

隱藏繼承的方法

方法 描述 定義於
__call() 呼叫指定的非類別方法。 yii\base\Component
__clone() 在通過複製現有物件建立物件後,會呼叫此方法。 yii\base\Component
__construct() 建構函式。 yii\base\BaseObject
__get() 傳回組件屬性的值。 yii\base\Component
__isset() 檢查屬性是否已設定,即已定義且非 null。 yii\base\Component
__set() 設定組件屬性的值。 yii\base\Component
__unset() 將組件屬性設定為 null。 yii\base\Component
addError() 將指定屬性的錯誤新增到模型物件。 yii\validators\Validator
attachBehavior() 將行為附加到此組件。 yii\base\Component
attachBehaviors() 將行為列表附加到組件。 yii\base\Component
behaviors() 傳回此組件應表現為的行為列表。 yii\base\Component
canGetProperty() 傳回一個值,指示是否可以讀取屬性。 yii\base\Component
canSetProperty() 傳回一個值,指示是否可以設定屬性。 yii\base\Component
className() 傳回此類別的完整限定名稱。 yii\base\BaseObject
clientValidateAttribute() 傳回執行客戶端驗證所需的 JavaScript。 yii\validators\Validator
createValidator() 建立驗證器物件。 yii\validators\Validator
detachBehavior() 從組件中分離行為。 yii\base\Component
detachBehaviors() 從組件中分離所有行為。 yii\base\Component
ensureBehaviors() 確保在 behaviors() 中宣告的行為已附加到此組件。 yii\base\Component
getAttributeNames() 傳回已清除的屬性名稱,不包含開頭的 ! 字元。 yii\validators\Validator
getBehavior() 傳回指定的行為物件。 yii\base\Component
getBehaviors() 傳回附加到此組件的所有行為。 yii\base\Component
getClientOptions() 傳回客戶端驗證選項。 yii\validators\Validator
getValidationAttributes() 傳回此驗證器套用的屬性列表。 yii\validators\Validator
hasEventHandlers() 傳回一個值,指示指定事件是否有任何處理常式附加。 yii\base\Component
hasMethod() 傳回一個值,指示是否已定義方法。 yii\base\Component
hasProperty() 傳回一個值,指示是否為此組件定義了屬性。 yii\base\Component
init() 初始化物件。 yii\validators\DateValidator
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\DateValidator
validateAttributes() 驗證指定的物件。 yii\validators\Validator

受保護的方法

隱藏繼承的方法

方法 描述 定義於
formatMessage() 使用 I18N 格式化訊息,如果 \Yii::$app 不可用,則使用簡單的 strtr。 yii\validators\Validator
parseDateValue() 將日期字串解析為 UNIX 時間戳記。 yii\validators\DateValidator
validateValue() 驗證值。 yii\validators\DateValidator

常數

隱藏繼承的常數

常數 描述 定義於
TYPE_DATE 'date' 用於指定驗證 $type 為日期值的常數,用於使用 intl 短格式進行驗證。 yii\validators\DateValidator
TYPE_DATETIME 'datetime' 用於指定驗證 $type 為日期時間值的常數,用於使用 intl 短格式進行驗證。 yii\validators\DateValidator
TYPE_TIME 'time' 用於指定驗證 $type 為時間值的常數,用於使用 intl 短格式進行驗證。 yii\validators\DateValidator

屬性詳情

隱藏繼承的屬性

$defaultTimeZone 公開屬性 (自版本 2.0.39 起可用)

當格式中未提供時間部分時,用於解析的預設時區。有關更多描述,請參閱 $timestampAttributeTimeZone

public string $defaultTimeZone 'UTC'
$format 公開屬性

要驗證的值應遵循的日期格式。這可以是 ICU 手冊 中描述的日期時間模式。

或者,這可以是帶有 php: 字首的字串,表示 PHP Datetime 類別可以識別的格式。請參閱 https://php.dev.org.tw/manual/en/datetime.createfromformat.php 以瞭解支援的格式。

如果未設定此屬性,則預設值將從 Yii::$app->formatter->dateFormat 取得,請參閱 yii\i18n\Formatter::$dateFormat 以瞭解詳細資訊。自版本 2.0.8 起,預設值將根據格式化器類別的不同格式確定,具體取決於 $type 的值

以下是一些範例值

'MM/dd/yyyy' // date in ICU format
'php:m/d/Y' // the same date in PHP format
'MM/dd/yyyy HH:mm' // not only dates but also times can be validated

注意: 使用的底層日期解析器因格式而異。如果您使用 ICU 格式並且安裝了 PHP intl 擴充功能,則會使用 IntlDateFormatter 來解析輸入值。在所有其他情況下,都會使用 PHP DateTime 類別。IntlDateFormatter 的優點是它可以解析國際日期,例如 12. Mai 201512 мая 2014,而 PHP 解析器僅限於英語。但是,PHP 解析器對輸入格式的要求更嚴格,因為它不接受格式為 php:d.m.Y12.05.05,但 IntlDateFormatter 會接受格式為 dd.MM.yyyy12.05.05。如果您需要使用 IntlDateFormatter,可以通過指定 最小日期 來避免此問題。

public string|null $format null
$locale 公開屬性

用於本地化日期解析的語系 ID。這僅在安裝了 PHP intl 擴充功能 時才有效。如果未設定,將使用 formatter 的語系設定。另請參閱 yii\i18n\Formatter::$locale

public string|null $locale null
$max 公開屬性 (自版本 2.0.4 起可用)

日期的上限。預設為 null,表示沒有上限。這可以是 unix 時間戳記或表示日期時間值的字串。如果此屬性是字串,則將使用 $format 來解析它。

另請參閱 $tooBig 以瞭解在日期過大時使用的自訂訊息。

public integer|string|null $max null
$maxString 公開屬性 (自版本 2.0.4 起可用)

在錯誤訊息中顯示的上限的使用者友善值。如果此屬性為 null,則將使用 $max 的值(在解析之前)。

public string|null $maxString null
$min 公開屬性 (自版本 2.0.4 起可用)

日期的下限。預設為 null,表示沒有下限。這可以是 unix 時間戳記或表示日期時間值的字串。如果此屬性是字串,則將使用 $format 來解析它。

另請參閱 $tooSmall 以瞭解在日期過小時使用的自訂訊息。

public integer|string|null $min null
$minString 公開屬性 (自版本 2.0.4 起可用)

在錯誤訊息中顯示的下限的使用者友善值。如果此屬性為 null,則將使用 $min 的值(在解析之前)。

public string|null $minString null
$strictDateFormat 公開屬性 (自版本 2.0.22 起可用)

如果您需要嚴格的日期格式驗證,請將此參數設定為 true(例如,只有以下日期才能通過 'yyyy-MM-dd' 格式的驗證:'0011-03-25'、'2019-04-30' 等,而不是 '18-05-15'、'2017-Mar-14' 等,如果此參數設定為 false,則可以通過驗證)

public boolean $strictDateFormat false
$timeZone 公開屬性

用於解析日期和時間值的時區。這可以是任何可以傳遞給 date_default_timezone_set() 的值,例如 UTCEurope/BerlinAmerica/Chicago。有關可用的時區,請參閱 php 手冊。如果未設定此屬性,則將使用 yii\base\Application::$timeZone

public string|null $timeZone null
$timestampAttribute 公開屬性

用於接收解析結果的屬性名稱。當此屬性不為 null 且驗證成功時,指定的屬性將接收解析結果。

這可以是與正在驗證的屬性相同的屬性。如果是這種情況,則在成功驗證後,原始值將被時間戳記值覆蓋。

請注意,當使用此屬性時,輸入值將轉換為 unix 時間戳記,根據定義,unix 時間戳記位於 預設 UTC 時區,因此將執行從 輸入時區 到預設時區的轉換。如果您想更改預設時區,請設定 $defaultTimeZone 屬性。當定義 $timestampAttributeFormat 時,您可以通過將 $timestampAttributeTimeZone 設定為與 'UTC' 不同的值來進一步控制轉換。

另請參閱

$timestampAttributeFormat 公開屬性 (自版本 2.0.4 起可用)

用於填充 $timestampAttribute 的格式。格式的指定方式可以與 $format 相同。

如果未設定,$timestampAttribute 將接收 UNIX 時間戳記。如果未設定 $timestampAttribute,則將忽略此屬性。

另請參閱

$timestampAttributeTimeZone 公開屬性 (自版本 2.0.4 起可用)

使用 $timestampAttributeFormat 填充 $timestampAttribute 時要使用的時區。預設為 UTC

這可以是任何可以傳遞給 date_default_timezone_set() 的值,例如 UTCEurope/BerlinAmerica/Chicago。有關可用的時區,請參閱 php 手冊

如果未設定 $timestampAttributeFormat,則將忽略此屬性。

另請參閱 $timestampAttributeFormat

$tooBig 公開屬性 (自版本 2.0.4 起可用)

當值大於 $max 時使用的使用者定義錯誤訊息。

public string $tooBig null
$tooSmall 公開屬性 (自版本 2.0.4 起可用)

當值小於 $min 時使用的使用者定義錯誤訊息。

public string $tooSmall null
$type 公開屬性 (自版本 2.0.8 起可用)

驗證器的類型。指示是否應驗證日期、時間或日期時間值。此屬性會影響 $format 的預設值,並在 $format 是 intl 短格式之一時設定正確的行為,shortmediumlongfull

這僅在安裝了 PHP intl 擴充功能 時才有效。

此屬性可以設定為以下值

  • TYPE_DATE - (預設) 僅用於驗證日期值,這表示只有不包含時間範圍的值才有效。
  • TYPE_DATETIME - 用於驗證日期時間值,其中包含日期部分以及時間部分。
  • TYPE_TIME - 用於驗證時間值,其中不包含日期資訊。
public string $type self::TYPE_DATE

方法詳情

隱藏繼承的方法

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

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

在通過複製現有物件建立物件後,會呼叫此方法。

它會移除所有行為,因為它們會附加到舊的物件。

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() public method

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

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

傳回組件屬性的值。

此方法將依以下順序檢查並採取相應的動作

  • 由 getter 定義的屬性:傳回 getter 結果
  • 行為的屬性:傳回行為屬性值

請勿直接呼叫此方法,因為它是 PHP 魔術方法,將在執行 $value = $component->property; 時隱式呼叫。

另請參閱 __set()

public mixed __get ( $name )
$name string

屬性名稱

return mixed

屬性值或行為屬性的值

throws yii\base\UnknownPropertyException

如果屬性未定義

throws yii\base\InvalidCallException

如果屬性為唯寫。

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() public method

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

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

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

將組件屬性設定為 null。

此方法將依以下順序檢查並採取相應的動作

  • 由 setter 定義的屬性:將屬性值設定為 null
  • 行為的屬性:將屬性值設定為 null

請勿直接呼叫此方法,因為它是 PHP 魔術方法,將在執行 unset($component->property) 時隱式呼叫。

另請參閱 https://php.dev.org.tw/manual/en/function.unset.php

public void __unset ( $name )
$name string

屬性名稱

throws yii\base\InvalidCallException

如果屬性為唯讀。

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

            
addError() public method

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

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

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

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

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

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

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

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

另請參閱 canSetProperty()

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

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

return boolean

屬性是否可以讀取

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

            
canSetProperty() public method

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

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

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

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

另請參閱 canGetProperty()

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

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

return boolean

屬性是否可以寫入

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

            
className() public static method
自 2.0.14 版本起已棄用。在 PHP >=5.5 上,請改用 ::class

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

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

public static string className ( )
return string

此類別的完整名稱。

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

            
clientValidateAttribute() public method

定義於: 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 string|null clientValidateAttribute ( $model, $attribute, $view )
$model yii\base\Model

正在驗證的資料模型

$attribute string

要驗證的屬性名稱。

$view yii\web\View

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

return string|null

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

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

            
createValidator() public static method

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

建立驗證器物件。

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

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

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

要驗證的資料模型。

$attributes array|string

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

$params array

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

return yii\validators\Validator

驗證器

                public static function createValidator($type, $model, $attributes, $params = [])
{
    $params['attributes'] = $attributes;
    if ($type instanceof \Closure) {
        $params['class'] = __NAMESPACE__ . '\InlineValidator';
        $params['method'] = $type;
    } elseif (!isset(static::$builtInValidators[$type]) && $model->hasMethod($type)) {
        // method-based validator
        $params['class'] = __NAMESPACE__ . '\InlineValidator';
        $params['method'] = [$model, $type];
    } else {
        unset($params['current']);
        if (isset(static::$builtInValidators[$type])) {
            $type = static::$builtInValidators[$type];
        }
        if (is_array($type)) {
            $params = array_merge($type, $params);
        } else {
            $params['class'] = $type;
        }
    }
    return Yii::createObject($params);
}

            
detachBehavior() public method

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

定義於: 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() 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 string

正在驗證的屬性名稱

return array

用戶端驗證選項

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

Defined in: yii\base\Component::hasEventHandlers()

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

public boolean hasEventHandlers ( $name )
$name string

事件名稱

return boolean

判斷是否有任何處理器附加到此事件。

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() public method

Defined in: yii\base\Component::hasMethod()

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

方法被定義如果

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

屬性名稱

$checkBehaviors boolean

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

return boolean

判斷方法是否被定義

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() public method

Defined in: yii\base\Component::hasProperty()

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

屬性被定義如果

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

另請參閱

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

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

return boolean

判斷屬性是否被定義

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
init() public method

初始化物件。

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

public void init ( )

                public function init()
{
    parent::init();
    if ($this->message === null) {
        $this->message = Yii::t('yii', 'The format of {attribute} is invalid.');
    }
    if ($this->format === null) {
        if ($this->type === self::TYPE_DATE) {
            $this->format = Yii::$app->formatter->dateFormat;
        } elseif ($this->type === self::TYPE_DATETIME) {
            $this->format = Yii::$app->formatter->datetimeFormat;
        } elseif ($this->type === self::TYPE_TIME) {
            $this->format = Yii::$app->formatter->timeFormat;
        } else {
            throw new InvalidConfigException('Unknown validation type set for DateValidator::$type: ' . $this->type);
        }
    }
    if ($this->locale === null) {
        $this->locale = Yii::$app->language;
    }
    if ($this->timeZone === null) {
        $this->timeZone = Yii::$app->timeZone;
    }
    if ($this->min !== null && $this->tooSmall === null) {
        $this->tooSmall = Yii::t('yii', '{attribute} must be no less than {min}.');
    }
    if ($this->max !== null && $this->tooBig === null) {
        $this->tooBig = Yii::t('yii', '{attribute} must be no greater than {max}.');
    }
    if ($this->maxString === null) {
        $this->maxString = (string)$this->max;
    }
    if ($this->minString === null) {
        $this->minString = (string)$this->min;
    }
    if ($this->max !== null && is_string($this->max)) {
        $timestamp = $this->parseDateValue($this->max);
        if ($timestamp === false) {
            throw new InvalidConfigException("Invalid max date value: {$this->max}");
        }
        $this->max = $timestamp;
    }
    if ($this->min !== null && is_string($this->min)) {
        $timestamp = $this->parseDateValue($this->min);
        if ($timestamp === false) {
            throw new InvalidConfigException("Invalid min date value: {$this->min}");
        }
        $this->min = $timestamp;
    }
}

            
isActive() public method

Defined in: yii\validators\Validator::isActive()

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

驗證器在下列情況下為啟用:

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

場景名稱

return boolean

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

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

            
isEmpty() public method

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

Defined in: yii\base\Component::off()

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

此方法與 on() 相反。

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

另請參閱 on()

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

事件名稱

$handler callable|null

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

return boolean

如果找到並分離處理器

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() public method

Defined in: yii\base\Component::on()

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

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

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

事件處理器必須使用以下簽名定義:

function ($event)

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

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

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

另請參閱 off()

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

事件名稱

$handler 可呼叫 (callable)

事件處理器

$data mixed

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

$append boolean

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

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

            
parseDateValue() protected method

將日期字串解析為 UNIX 時間戳記。

protected integer|false parseDateValue ( $value )
$value mixed

代表日期的字串

return integer|false

UNIX 時間戳記或失敗時為 false

                protected function parseDateValue($value)
{
    // TODO consider merging these methods into single one at 2.1
    return $this->parseDateValueFormat($value, $this->format);
}

            
trigger() public method

Defined in: yii\base\Component::trigger()

觸發事件。

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

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

事件名稱

$event yii\base\Event|null

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

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

            
validate() public method

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

驗證單個屬性。

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

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

要驗證的資料模型

$attribute string

要驗證的屬性名稱。

                public function validateAttribute($model, $attribute)
{
    $value = $model->$attribute;
    if ($this->isEmpty($value)) {
        if ($this->timestampAttribute !== null) {
            $model->{$this->timestampAttribute} = null;
        }
        return;
    }
    $timestamp = $this->parseDateValue($value);
    if ($timestamp === false) {
        if ($this->timestampAttribute === $attribute) {
            if ($this->timestampAttributeFormat === null) {
                if (is_int($value)) {
                    return;
                }
            } elseif ($this->parseDateValueFormat($value, $this->timestampAttributeFormat) !== false) {
                return;
            }
        }
        $this->addError($model, $attribute, $this->message, []);
    } elseif ($this->min !== null && $timestamp < $this->min) {
        $this->addError($model, $attribute, $this->tooSmall, ['min' => $this->minString]);
    } elseif ($this->max !== null && $timestamp > $this->max) {
        $this->addError($model, $attribute, $this->tooBig, ['max' => $this->maxString]);
    } elseif ($this->timestampAttribute !== null) {
        if ($this->timestampAttributeFormat === null) {
            $model->{$this->timestampAttribute} = $timestamp;
        } else {
            $model->{$this->timestampAttribute} = $this->formatTimestamp($timestamp, $this->timestampAttributeFormat);
        }
    }
}

            
validateAttributes() public method

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

驗證值。

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

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)
{
    $timestamp = $this->parseDateValue($value);
    if ($timestamp === false) {
        return [$this->message, []];
    } elseif ($this->min !== null && $timestamp < $this->min) {
        return [$this->tooSmall, ['min' => $this->minString]];
    } elseif ($this->max !== null && $timestamp > $this->max) {
        return [$this->tooBig, ['max' => $this->maxString]];
    }
    return null;
}