0 追隨者

類別 yii\validators\IpValidator

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

此驗證器檢查屬性值是否為有效的 IPv4/IPv6 地址或子網路。

如果啟用 IPv6 擴展的正規化,它也可能會更改屬性的值。

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

['ip_address', 'ip'], // IPv4 or IPv6 address
['ip_address', 'ip', 'ipv6' => false], // IPv4 address (IPv6 is disabled)
['ip_address', 'ip', 'subnet' => true], // requires a CIDR prefix (like 10.0.0.1/24) for the IP address
['ip_address', 'ip', 'subnet' => null], // CIDR prefix is optional
['ip_address', 'ip', 'subnet' => null, 'normalize' => true], // CIDR prefix is optional and will be added when missing
['ip_address', 'ip', 'ranges' => ['192.168.0.0/24']], // only IP addresses from the specified subnet are allowed
['ip_address', 'ip', 'ranges' => ['!192.168.0.0/24', 'any']], // any IP is allowed except IP in the specified subnet
['ip_address', 'ip', 'expandIPv6' => true], // expands IPv6 address to a full notation format

公共屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$attributeNames array 屬性名稱。 yii\validators\Validator
$attributes array|string 由此驗證器驗證的屬性。 yii\validators\Validator
$behaviors yii\base\Behavior[] 附加到此組件的行為列表。 yii\base\Component
$builtInValidators array 內建驗證器列表 (名稱 => 類別或配置) yii\validators\Validator
$enableClientValidation boolean 是否為此驗證器啟用客戶端驗證。 yii\validators\Validator
$except array|string 驗證器不應套用的情境。 yii\validators\Validator
$expandIPv6 boolean 是否將 IPv6 位址擴展為完整表示法格式。 yii\validators\IpValidator
$hasSubnet string 當由於 $subnet 為 false 而驗證失敗,但存在 CIDR 前綴時,會使用使用者定義的錯誤訊息。 yii\validators\IpValidator
$ipv4 boolean 驗證值是否可以為 IPv4 位址。 yii\validators\IpValidator
$ipv4NotAllowed string 當由於停用 IPv4 驗證而驗證失敗時,會使用使用者定義的錯誤訊息。 yii\validators\IpValidator
$ipv4Pattern string 用於驗證 IPv4 位址的 Regexp 模式 yii\validators\IpValidator
$ipv6 boolean 驗證值是否可以為 IPv6 位址。 yii\validators\IpValidator
$ipv6NotAllowed string 當由於停用 IPv6 驗證而驗證失敗時,會使用使用者定義的錯誤訊息。 yii\validators\IpValidator
$ipv6Pattern string 用於驗證 IPv6 位址的 Regexp 模式 yii\validators\IpValidator
$isEmpty callable|null 一個 PHP 可呼叫物件,用於取代 isEmpty() 的預設實作。 yii\validators\Validator
$message string 當由於 IP 位址格式錯誤而驗證失敗時,會使用使用者定義的錯誤訊息。 yii\validators\IpValidator
$negation boolean 位址的開頭是否可以有 NEGATION_CHAR 字元。 yii\validators\IpValidator
$networks array 可在 $ranges 中使用的網路別名。 yii\validators\IpValidator
$noSubnet string|null 當由於子網路 $subnet 設定為 'only',但未設定 CIDR 前綴時,會使用使用者定義的錯誤訊息。 yii\validators\IpValidator
$normalize boolean 是否將 CIDR 前綴與最小長度(IPv4 為 32,IPv6 為 128)新增至沒有前綴的位址。 yii\validators\IpValidator
$notInRange string 當由於 $ranges 檢查不允許 IP 位址而驗證失敗時,會使用使用者定義的錯誤訊息。 yii\validators\IpValidator
$on array|string 驗證器可以套用的情境。 yii\validators\Validator
$ranges array 允許或禁止的 IPv4 或 IPv6 範圍。 yii\validators\IpValidator
$skipOnEmpty boolean 如果屬性值為 null 或空字串,是否應跳過此驗證規則。 yii\validators\Validator
$skipOnError boolean 如果根據先前的規則,要驗證的屬性已存在某些驗證錯誤,是否應跳過此驗證規則。 yii\validators\Validator
$subnet boolean|null 位址是否可以為具有 CIDR 子網路的 IP,例如 192.168.10.0/24 yii\validators\IpValidator
$validationAttributes array|null 屬性名稱列表。 yii\validators\Validator
$when callable|null 一個 PHP 可呼叫物件,其傳回值決定是否應套用此驗證器。 yii\validators\Validator
$whenClient string|null 一個 JavaScript 函式名稱,其傳回值決定是否應在用戶端套用此驗證器。 yii\validators\Validator
$wrongCidr string 當由於 CIDR 錯誤而驗證失敗時,會使用使用者定義的錯誤訊息。 yii\validators\IpValidator

Public Methods

隱藏繼承的方法

Method 描述 定義於
__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\IpValidator
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\IpValidator
getRanges() yii\validators\IpValidator
getValidationAttributes() 傳回此驗證器套用的屬性列表。 yii\validators\Validator
hasEventHandlers() 傳回指示是否有名稱事件附加任何處理常式的值。 yii\base\Component
hasMethod() 傳回指示是否已定義方法的值。 yii\base\Component
hasProperty() 傳回指示是否已為此元件定義屬性的值。 yii\base\Component
init() 初始化物件。 yii\validators\IpValidator
isActive() 傳回指示驗證器是否對給定的情境和屬性處於活動狀態的值。 yii\validators\Validator
isEmpty() 檢查給定值是否為空。 yii\validators\Validator
off() 從此元件分離現有的事件處理常式。 yii\base\Component
on() 將事件處理常式附加至事件。 yii\base\Component
setRanges() 設定允許或禁止的 IPv4 或 IPv6 範圍。 yii\validators\IpValidator
trigger() 觸發事件。 yii\base\Component
validate() 驗證給定值。 yii\validators\Validator
validateAttribute() 驗證單一屬性。 yii\validators\IpValidator
validateAttributes() 驗證指定的物件。 yii\validators\Validator

Protected Methods

隱藏繼承的方法

Method 描述 定義於
formatMessage() 使用 I18N 格式化訊息,如果 \Yii::$app 不可用,則使用簡單的 strtr。 yii\validators\Validator
validateIPv4() 驗證 IPv4 位址。 yii\validators\IpValidator
validateIPv6() 驗證 IPv6 位址。 yii\validators\IpValidator
validateValue() 驗證值。 yii\validators\IpValidator

Constants

隱藏繼承的常數

Constant Value 描述 定義於
NEGATION_CHAR '!' 否定字元。用於否定 $ranges$networks,或在 $negation 設定為 true 時否定驗證值。 yii\validators\IpValidator

Property Details

隱藏繼承的屬性

$expandIPv6 public property

是否將 IPv6 位址擴展為完整表示法格式。預設值為 false

public boolean $expandIPv6 false
$hasSubnet public property

當由於 $subnet 為 false 而驗證失敗,但存在 CIDR 前綴時,會使用使用者定義的錯誤訊息。

您可以在訊息中使用以下預留位置

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

另請參閱 $subnet

public string $hasSubnet null
$ipv4 public property

驗證值是否可以為 IPv4 位址。預設值為 true

public boolean $ipv4 true
$ipv4NotAllowed public property

當由於停用 IPv4 驗證而驗證失敗時,會使用使用者定義的錯誤訊息。

您可以在訊息中使用以下預留位置

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

另請參閱 $ipv4

public string $ipv4NotAllowed null
$ipv4Pattern public property

用於驗證 IPv4 位址的 Regexp 模式

public string $ipv4Pattern '/^(?:(?:2(?:[0-4]\d|5[0-5])|[0-1]?\d?\d)\.){3}(?:(?:2([0-4]\d|5[0-5])|[0-1]?\d?\d))$/'
$ipv6 public property

驗證值是否可以為 IPv6 位址。預設值為 true

public boolean $ipv6 true
$ipv6NotAllowed public property

當由於停用 IPv6 驗證而驗證失敗時,會使用使用者定義的錯誤訊息。

您可以在訊息中使用以下預留位置

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

另請參閱 $ipv6

public string $ipv6NotAllowed null
$ipv6Pattern public property

用於驗證 IPv6 位址的 Regexp 模式

public string $ipv6Pattern '/^(([\da-fA-F]{1,4}:){7}[\da-fA-F]{1,4}|([\da-fA-F]{1,4}:){1,7}:|([\da-fA-F]{1,4}:){1,6}:[\da-fA-F]{1,4}|([\da-fA-F]{1,4}:){1,5}(:[\da-fA-F]{1,4}){1,2}|([\da-fA-F]{1,4}:){1,4}(:[\da-fA-F]{1,4}){1,3}|([\da-fA-F]{1,4}:){1,3}(:[\da-fA-F]{1,4}){1,4}|([\da-fA-F]{1,4}:){1,2}(:[\da-fA-F]{1,4}){1,5}|[\da-fA-F]{1,4}:((:[\da-fA-F]{1,4}){1,6})|:((:[\da-fA-F]{1,4}){1,7}|:)|fe80:(:[\da-fA-F]{0,4}){0,4}%[\da-zA-Z]+|::(ffff(:0{1,4})?:)?((25[0-5]|(2[0-4]|1?\d)?\d)\.){3}(25[0-5]|(2[0-4]|1?\d)?\d)|([\da-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1?[\d])?\d)\.){3}(25[0-5]|(2[0-4]|1?\d)?\d))$/'
$message public property

當由於 IP 位址格式錯誤而驗證失敗時,會使用使用者定義的錯誤訊息。

您可以在訊息中使用以下預留位置

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

位址的開頭是否可以有 NEGATION_CHAR 字元。預設值為 false

public boolean $negation false
$networks public property

可在 $ranges 中使用的網路別名。

  • key - 別名
  • value - 字串陣列。字串可以是 IP 範圍、IP 位址或另一個別名。字串可以使用 NEGATION_CHAR 否定(獨立於 negation 選項)。

預設會定義以下別名

  • *: any
  • any: 0.0.0.0/0, ::/0
  • private: 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, fd00::/8
  • multicast: 224.0.0.0/4, ff00::/8
  • linklocal: 169.254.0.0/16, fe80::/10
  • localhost: 127.0.0.0/8', ::1
  • documentation: 192.0.2.0/24, 198.51.100.0/24, 203.0.113.0/24, 2001:db8::/32
  • system: multicast, linklocal, localhost, documentation
public array $networks = [
    
'*' => [
        
'any',
    ],
    
'any' => [
        
'0.0.0.0/0',
        
'::/0',
    ],
    
'private' => [
        
'10.0.0.0/8',
        
'172.16.0.0/12',
        
'192.168.0.0/16',
        
'fd00::/8',
    ],
    
'multicast' => [
        
'224.0.0.0/4',
        
'ff00::/8',
    ],
    
'linklocal' => [
        
'169.254.0.0/16',
        
'fe80::/10',
    ],
    
'localhost' => [
        
'127.0.0.0/8',
        
'::1',
    ],
    
'documentation' => [
        
'192.0.2.0/24',
        
'198.51.100.0/24',
        
'203.0.113.0/24',
        
'2001:db8::/32',
    ],
    
'system' => [
        
'multicast',
        
'linklocal',
        
'localhost',
        
'documentation',
    ],
]
$noSubnet public property

當由於子網路 $subnet 設定為 'only',但未設定 CIDR 前綴時,會使用使用者定義的錯誤訊息。

您可以在訊息中使用以下預留位置

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

另請參閱 $subnet

public string|null $noSubnet null
$normalize public property

是否將 CIDR 前綴與最小長度(IPv4 為 32,IPv6 為 128)新增至沒有前綴的位址。僅在 subnet 不是 false 時有效。例如

  • 10.0.1.5 將正規化為 10.0.1.5/32
  • 2008:db0::1 將正規化為 2008:db0::1/128 預設值為 false

另請參閱 $subnet

public boolean $normalize false
$notInRange public property

當由於 $ranges 檢查不允許 IP 位址而驗證失敗時,會使用使用者定義的錯誤訊息。

您可以在訊息中使用以下預留位置

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

另請參閱 $ranges

public string $notInRange null
$ranges public property

允許或禁止的 IPv4 或 IPv6 範圍。請注意,此屬性的型別在 getter 和 setter 中有所不同。請參閱 getRanges()setRanges() 以取得詳細資訊。

public array $ranges null
$subnet public property

位址是否可以為具有 CIDR 子網路的 IP,例如 192.168.10.0/24。可能的值如下

  • false - 位址不得具有子網路(預設)。
  • true - 需要指定子網路。
  • null - 指定子網路為選用。
public boolean|null $subnet false
$wrongCidr public property

當由於 CIDR 錯誤而驗證失敗時,會使用使用者定義的錯誤訊息。

您可以在訊息中使用以下預留位置

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

另請參閱 $subnet

public string $wrongCidr null

Method Details

隱藏繼承的方法

__call() public method

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

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

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

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

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

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

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

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

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

傳回執行用戶端驗證所需的 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)
{
    ValidationAsset::register($view);
    $options = $this->getClientOptions($model, $attribute);
    return 'yii.validation.ip(value, messages, ' . Json::htmlEncode($options) . ');';
}

            
createValidator() public static 方法

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

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

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

從元件分離所有行為。

public void detachBehaviors ( )

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

            
ensureBehaviors() public 方法

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

確保在 behaviors() 中宣告的行為已附加至此元件。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
formatMessage() protected 方法 (自 2.0.12 版本起可用)

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

使用 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 方法 (自 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 方法

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

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

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

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

附加到此元件的行為列表

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

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

傳回用戶端驗證選項。

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

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

受驗證的模型

$attribute string

受驗證的屬性名稱

return array

客戶端驗證選項

                public function getClientOptions($model, $attribute)
{
    $messages = [
        'ipv6NotAllowed' => $this->ipv6NotAllowed,
        'ipv4NotAllowed' => $this->ipv4NotAllowed,
        'message' => $this->message,
        'noSubnet' => $this->noSubnet,
        'hasSubnet' => $this->hasSubnet,
    ];
    foreach ($messages as &$message) {
        $message = $this->formatMessage($message, [
            'attribute' => $model->getAttributeLabel($attribute),
        ]);
    }
    $options = [
        'ipv4Pattern' => new JsExpression(Html::escapeJsRegularExpression($this->ipv4Pattern)),
        'ipv6Pattern' => new JsExpression(Html::escapeJsRegularExpression($this->ipv6Pattern)),
        'messages' => $messages,
        'ipv4' => (bool) $this->ipv4,
        'ipv6' => (bool) $this->ipv6,
        'ipParsePattern' => new JsExpression(Html::escapeJsRegularExpression($this->getIpParsePattern())),
        'negation' => $this->negation,
        'subnet' => $this->subnet,
    ];
    if ($this->skipOnEmpty) {
        $options['skipOnEmpty'] = 1;
    }
    return $options;
}

            
getRanges() public 方法

public array getRanges ( )
return array

允許或禁止的 IPv4 或 IPv6 範圍。

                public function getRanges()
{
    return $this->_ranges;
}

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

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

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

定義於: 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->ipv4 && !$this->ipv6) {
        throw new InvalidConfigException('Both IPv4 and IPv6 checks can not be disabled at the same time');
    }
    if ($this->message === null) {
        $this->message = Yii::t('yii', '{attribute} must be a valid IP address.');
    }
    if ($this->ipv6NotAllowed === null) {
        $this->ipv6NotAllowed = Yii::t('yii', '{attribute} must not be an IPv6 address.');
    }
    if ($this->ipv4NotAllowed === null) {
        $this->ipv4NotAllowed = Yii::t('yii', '{attribute} must not be an IPv4 address.');
    }
    if ($this->wrongCidr === null) {
        $this->wrongCidr = Yii::t('yii', '{attribute} contains wrong subnet mask.');
    }
    if ($this->noSubnet === null) {
        $this->noSubnet = Yii::t('yii', '{attribute} must be an IP address with specified subnet.');
    }
    if ($this->hasSubnet === null) {
        $this->hasSubnet = Yii::t('yii', '{attribute} must not be a subnet.');
    }
    if ($this->notInRange === null) {
        $this->notInRange = Yii::t('yii', '{attribute} is not in the allowed range.');
    }
}

            
isActive() public method

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

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

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

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

            
setRanges() public method

設定允許或禁止的 IPv4 或 IPv6 範圍。

執行以下準備工作:

  • 遞迴地將別名(在 $networks 中描述)替換為它們的值。
  • 移除重複項
public void setRanges ( $ranges )
$ranges array|string|null

允許或禁止的 IPv4 或 IPv6 範圍。

當陣列為空或未設定選項時,允許所有 IP 位址。

否則,依序檢查規則,直到找到第一個符合項。當 IP 位址未符合任何規則時,則禁止該 IP 位址。

範例

[
     'ranges' => [
         '192.168.10.128'
         '!192.168.10.0/24',
         'any' // allows any other IP addresses
     ]
]

在此範例中,允許存取所有 IPv4 和 IPv6 位址,但不包括 192.168.10.0/24 子網路。也允許 IPv4 位址 192.168.10.128,因為它在限制之前列出。

                public function setRanges($ranges)
{
    $this->_ranges = $this->prepareRanges((array) $ranges);
}

            
trigger() public method

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

定義於: 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;
    $result = $this->validateSubnet($value);
    if (is_array($result)) {
        $result[1] = array_merge(['ip' => is_array($value) ? 'array()' : $value], $result[1]);
        $this->addError($model, $attribute, $result[0], $result[1]);
    } else {
        $model->$attribute = $result;
    }
}

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

            
validateIPv4() protected method

驗證 IPv4 位址。

protected boolean validateIPv4 ( $value )
$value string

                protected function validateIPv4($value)
{
    return preg_match($this->ipv4Pattern, $value) !== 0;
}

            
validateIPv6() protected method

驗證 IPv6 位址。

protected boolean validateIPv6 ( $value )
$value string

                protected function validateIPv6($value)
{
    return preg_match($this->ipv6Pattern, $value) !== 0;
}

            
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)
{
    $result = $this->validateSubnet($value);
    if (is_array($result)) {
        $result[1] = array_merge(['ip' => is_array($value) ? 'array()' : $value], $result[1]);
        return $result;
    }
    return null;
}