0 追蹤者

類別 yii\validators\StringValidator

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

StringValidator 驗證屬性值是否為特定長度。

請注意,此驗證器應僅用於字串類型的屬性。

公共屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$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
$encoding string|null 要驗證的字串值的編碼 (例如 'UTF-8')。 yii\validators\StringValidator
$except array|string 驗證器不應應用於的情境。 yii\validators\Validator
$isEmpty callable|null 一個 PHP 可調用函數,用於替換 isEmpty() 的預設實作。 yii\validators\Validator
$length integer|array 指定要驗證的值的長度限制。 yii\validators\StringValidator
$max integer|null 最大長度。 yii\validators\StringValidator
$message string 當值不是字串時使用的使用者定義錯誤訊息。 yii\validators\StringValidator
$min integer|null 最小長度。 yii\validators\StringValidator
$notEqual string 當值的長度不等於 $length 時使用的使用者定義錯誤訊息。 yii\validators\StringValidator
$on array|string 驗證器可以應用於的情境。 yii\validators\Validator
$skipOnEmpty boolean 如果屬性值為 null 或空字串,是否應跳過此驗證規則。 yii\validators\Validator
$skipOnError boolean 如果根據先前的規則,要驗證的屬性已經有一些驗證錯誤,是否應跳過此驗證規則。 yii\validators\Validator
$strict boolean 是否要求值為字串資料類型。 yii\validators\StringValidator
$tooLong string 當值的長度大於 $max 時使用的使用者定義錯誤訊息。 yii\validators\StringValidator
$tooShort string 當值的長度小於 $min 時使用的使用者定義錯誤訊息。 yii\validators\StringValidator
$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\StringValidator
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\StringValidator
getValidationAttributes() 傳回此驗證器應用於的屬性列表。 yii\validators\Validator
hasEventHandlers() 傳回一個值,指示是否有名稱事件附加任何處理常式。 yii\base\Component
hasMethod() 傳回一個值,指示是否已定義方法。 yii\base\Component
hasProperty() 傳回一個值,指示是否為此組件定義了屬性。 yii\base\Component
init() 初始化物件。 yii\validators\StringValidator
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\StringValidator
validateAttributes() 驗證指定的物件。 yii\validators\Validator

保護方法

隱藏繼承的方法

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

屬性詳細資訊

隱藏繼承的屬性

$encoding 公共屬性

要驗證的字串值的編碼 (例如 'UTF-8')。如果未設定此屬性,將使用 yii\base\Application::$charset

public string|null $encoding null
$length 公共屬性

指定要驗證的值的長度限制。這可以通過以下形式之一指定

  • 整數:值應為的確切長度;
  • 包含一個元素的陣列:值應為的最小長度。例如,[8]。這將覆蓋 $min
  • 包含兩個元素的陣列:值應為的最小和最大長度。例如,[8, 128]。這將覆蓋 $min$max

另請參閱

  • $tooShort,用於太短字串的自訂訊息。
  • $tooLong,用於太長字串的自訂訊息。
  • $notEqual,用於與所需長度不符的字串的自訂訊息。
public integer|array $length null
$max 公共屬性

最大長度。如果未設定,則表示沒有最大長度限制。

另請參閱 $tooLong,用於太長字串的自訂訊息。

public integer|null $max null
$message 公共屬性

當值不是字串時使用的使用者定義錯誤訊息。

public string $message null
$min 公共屬性

最小長度。如果未設定,則表示沒有最小長度限制。

另請參閱 $tooShort,用於太短字串的自訂訊息。

public integer|null $min null
$notEqual 公共屬性

當值的長度不等於 $length 時使用的使用者定義錯誤訊息。

public string $notEqual null
$strict 公共屬性 (自版本 2.0.33 起可用)

是否要求值為字串資料類型。如果為 false,則任何純量值都將被視為其字串等效值。

public boolean $strict true
$tooLong 公共屬性

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

public string $tooLong null
$tooShort 公共屬性

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

public string $tooShort null

方法詳細資訊

隱藏繼承的方法

__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

屬性名稱

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

屬性名稱

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

傳回執行客戶端驗證所需的 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.string(value, messages, ' . Json::htmlEncode($options) . ');';
}

            
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)

傳回客戶端驗證選項。

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

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

正在驗證的模型

$attribute string

正在驗證的屬性名稱

return array

用戶端驗證選項

                public function getClientOptions($model, $attribute)
{
    $label = $model->getAttributeLabel($attribute);
    $options = [
        'message' => $this->formatMessage($this->message, [
            'attribute' => $label,
        ]),
    ];
    if ($this->min !== null) {
        $options['min'] = $this->min;
        $options['tooShort'] = $this->formatMessage($this->tooShort, [
            'attribute' => $label,
            'min' => $this->min,
        ]);
    }
    if ($this->max !== null) {
        $options['max'] = $this->max;
        $options['tooLong'] = $this->formatMessage($this->tooLong, [
            'attribute' => $label,
            'max' => $this->max,
        ]);
    }
    if ($this->length !== null) {
        $options['is'] = $this->length;
        $options['notEqual'] = $this->formatMessage($this->notEqual, [
            'attribute' => $label,
            'length' => $this->length,
        ]);
    }
    if ($this->skipOnEmpty) {
        $options['skipOnEmpty'] = 1;
    }
    return $options;
}

            
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

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

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

定義於: 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 (is_array($this->length)) {
        if (isset($this->length[0])) {
            $this->min = $this->length[0];
        }
        if (isset($this->length[1])) {
            $this->max = $this->length[1];
        }
        $this->length = null;
    }
    if ($this->encoding === null) {
        $this->encoding = Yii::$app ? Yii::$app->charset : 'UTF-8';
    }
    if ($this->message === null) {
        $this->message = Yii::t('yii', '{attribute} must be a string.');
    }
    if ($this->min !== null && $this->tooShort === null) {
        $this->tooShort = Yii::t('yii', '{attribute} should contain at least {min, number} {min, plural, one{character} other{characters}}.');
    }
    if ($this->max !== null && $this->tooLong === null) {
        $this->tooLong = Yii::t('yii', '{attribute} should contain at most {max, number} {max, plural, one{character} other{characters}}.');
    }
    if ($this->length !== null && $this->notEqual === null) {
        $this->notEqual = Yii::t('yii', '{attribute} should contain {length, number} {length, plural, one{character} other{characters}}.');
    }
}

            
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 可呼叫 (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]);
    }
}

            
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;
    if (!$this->strict && is_scalar($value) && !is_string($value)) {
        $value = (string)$value;
    }
    if (!is_string($value)) {
        $this->addError($model, $attribute, $this->message);
        return;
    }
    $length = mb_strlen($value, $this->encoding);
    if ($this->min !== null && $length < $this->min) {
        $this->addError($model, $attribute, $this->tooShort, ['min' => $this->min]);
    }
    if ($this->max !== null && $length > $this->max) {
        $this->addError($model, $attribute, $this->tooLong, ['max' => $this->max]);
    }
    if ($this->length !== null && $length !== $this->length) {
        $this->addError($model, $attribute, $this->notEqual, ['length' => $this->length]);
    }
}

            
validateAttributes() public method

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

驗證指定的物件。

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

正在驗證的資料模型

$attributes array|string|null

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

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

            
validateValue() 受保護方法

驗證值。

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

protected 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->strict && is_scalar($value) && !is_string($value)) {
        $value = (string)$value;
    }
    if (!is_string($value)) {
        return [$this->message, []];
    }
    $length = mb_strlen($value, $this->encoding);
    if ($this->min !== null && $length < $this->min) {
        return [$this->tooShort, ['min' => $this->min]];
    }
    if ($this->max !== null && $length > $this->max) {
        return [$this->tooLong, ['max' => $this->max]];
    }
    if ($this->length !== null && $length !== $this->length) {
        return [$this->notEqual, ['length' => $this->length]];
    }
    return null;
}