類別 yii\validators\InlineValidator
InlineValidator 代表一個驗證器,其定義為正在驗證物件中的一個方法。
公開屬性
公開方法
受保護的方法
方法 | 描述 | 定義於 |
---|---|---|
formatMessage() | 使用 I18N 格式化訊息,如果 \Yii::$app 不可用,則使用簡單的 strtr。 |
yii\validators\Validator |
validateValue() | 驗證值。 | yii\validators\Validator |
屬性詳細資訊
一個匿名函數或模型類別方法的名稱,該方法會傳回客戶端驗證程式碼。方法的簽章應如下所示
function (string $attribute, mixed $params, InlineValidator $validator, mixed $current, View $view): string
{
// $view->registerJs('JS validation function');
// or \app\assets\ValidationAsset::register($view);
return "calling JS validation function";
}
請參考 clientValidateAttribute() 和 guide 以取得關於如何傳回客戶端驗證程式碼的詳細資訊。
一個匿名函數或模型類別方法的名稱,該方法將被調用以執行實際驗證。方法的簽章應如下所示
function (string $attribute, mixed $params, InlineValidator $validator, mixed $current): bool {
}
$attribute
是要驗證的屬性名稱$params
包含 $params 的值,您在宣告 inline 驗證規則時指定$validator
是對相關 yii\validators\InlineValidator 物件的參考。此參數自版本 2.0.11 起可用$current
是屬性值。此參數自版本 2.0.36 起可用
方法詳細資訊
定義於: yii\base\Component::__call()
呼叫指定的非類別方法。
此方法將檢查是否有任何附加的行為具有指定的名稱方法,如果有的話則執行它。
請勿直接調用此方法,因為它是一個 PHP 魔術方法,當調用未知方法時將會被隱式調用。
public mixed __call ( $name, $params ) | ||
$name | string |
方法名稱 |
$params | 陣列 |
方法參數 |
return | 混合 |
方法返回值 |
---|---|---|
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()");
}
public void __clone ( ) |
public function __clone()
{
$this->_events = [];
$this->_eventWildcards = [];
$this->_behaviors = null;
}
定義於: yii\base\BaseObject::__construct()
建構子。
預設實作執行兩件事
- 使用給定的配置
$config
初始化物件。 - 調用 init()。
如果在子類別中覆寫此方法,建議
- 建構函式的最後一個參數是一個配置陣列,例如此處的
$config
。 - 在建構函式結尾調用父類別實作。
public void __construct ( $config = [] ) | ||
$config | 陣列 |
將用於初始化物件屬性的名稱-值對 |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
定義於: yii\base\Component::__get()
傳回組件屬性的值。
此方法將按以下順序檢查並相應地執行操作
- 由 getter 定義的屬性:傳回 getter 結果
- 行為的屬性:傳回行為屬性值
請勿直接調用此方法,因為它是一個 PHP 魔術方法,當執行 $value = $component->property;
時將會被隱式調用。
另請參閱 __set()。
public mixed __get ( $name ) | ||
$name | string |
屬性名稱 |
return | 混合 |
屬性值或行為屬性的值 |
---|---|---|
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);
}
定義於: yii\base\Component::__isset()
檢查屬性是否已設定,即已定義且非 null。
此方法將按以下順序檢查並相應地執行操作
- 由 setter 定義的屬性:傳回屬性是否已設定
- 行為的屬性:傳回屬性是否已設定
- 對於不存在的屬性傳回
false
請勿直接調用此方法,因為它是一個 PHP 魔術方法,當執行 isset($component->property)
時將會被隱式調用。
public boolean __isset ( $name ) | ||
$name | string |
屬性名稱或事件名稱 |
return | 布林值 |
名稱屬性是否已設定 |
---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name)) {
return $behavior->$name !== null;
}
}
return false;
}
定義於: yii\base\Component::__set()
設定組件屬性的值。
此方法將按以下順序檢查並相應地執行操作
- 由 setter 定義的屬性:設定屬性值
- 格式為 "on xyz" 的事件:將處理器附加到事件 "xyz"
- 格式為 "as xyz" 的行為:附加名為 "xyz" 的行為
- 行為的屬性:設定行為屬性值
請勿直接調用此方法,因為它是一個 PHP 魔術方法,當執行 $component->property = $value;
時將會被隱式調用。
另請參閱 __get()。
public void __set ( $name, $value ) | ||
$name | string |
屬性名稱或事件名稱 |
$value | 混合 |
屬性值 |
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);
}
定義於: yii\base\Component::__unset()
將組件屬性設定為 null。
此方法將按以下順序檢查並相應地執行操作
- 由 setter 定義的屬性:將屬性值設定為 null
- 行為的屬性:將屬性值設定為 null
請勿直接調用此方法,因為它是一個 PHP 魔術方法,當執行 unset($component->property)
時將會被隱式調用。
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);
}
public void addError ( $model, $attribute, $message, $params = [] ) | ||
$model | yii\base\Model |
正在驗證的資料模型 |
$attribute | string |
正在驗證的屬性 |
$message | string |
錯誤訊息 |
$params | 陣列 |
錯誤訊息中佔位符的值 |
public function addError($model, $attribute, $message, $params = [])
{
$params['attribute'] = $model->getAttributeLabel($attribute);
if (!isset($params['value'])) {
$value = $model->$attribute;
if (is_array($value)) {
$params['value'] = 'array()';
} elseif (is_object($value) && !method_exists($value, '__toString')) {
$params['value'] = '(object)';
} else {
$params['value'] = $value;
}
}
$model->addError($attribute, $this->formatMessage($message, $params));
}
定義於: 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);
}
定義於: yii\base\Component::attachBehaviors()
將行為列表附加到組件。
每個行為都以其名稱索引,並且應該是一個 yii\base\Behavior 物件、一個指定行為類別的字串或一個用於建立行為的配置陣列。
另請參閱 attachBehavior()。
public void attachBehaviors ( $behaviors ) | ||
$behaviors | 陣列 |
要附加到組件的行為列表 |
public function attachBehaviors($behaviors)
{
$this->ensureBehaviors();
foreach ($behaviors as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
定義於: yii\base\Component::behaviors()
傳回此組件應表現為的行為列表。
子類別可以覆寫此方法來指定它們想要表現為的行為。
此方法的傳回值應該是一個行為物件或配置的陣列,並以行為名稱索引。行為配置可以是指定行為類別的字串,也可以是以下結構的陣列
'behaviorName' => [
'class' => 'BehaviorClass',
'property1' => 'value1',
'property2' => 'value2',
]
請注意,行為類別必須繼承自 yii\base\Behavior。行為可以使用名稱或匿名方式附加。當名稱用作陣列鍵時,使用此名稱,稍後可以使用 getBehavior() 檢索行為,或使用 detachBehavior() 分離行為。匿名行為無法檢索或分離。
在此方法中宣告的行為將自動(按需)附加到組件。
public array behaviors ( ) | ||
return | 陣列 |
行為配置。 |
---|
public function behaviors()
{
return [];
}
定義於: yii\base\Component::canGetProperty()
傳回一個值,指示是否可以讀取屬性。
如果滿足以下條件,則可以讀取屬性
- 類別具有與指定名稱相關聯的 getter 方法(在這種情況下,屬性名稱不區分大小寫);
- 類別具有具有指定名稱的成員變數(當
$checkVars
為 true 時); - 附加的行為具有給定名稱的可讀屬性(當
$checkBehaviors
為 true 時)。
另請參閱 canSetProperty()。
public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
屬性名稱 |
$checkVars | 布林值 |
是否將成員變數視為屬性 |
$checkBehaviors | 布林值 |
是否將行為的屬性視為此組件的屬性 |
return | 布林值 |
屬性是否可以讀取 |
---|
public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name, $checkVars)) {
return true;
}
}
}
return false;
}
定義於: yii\base\Component::canSetProperty()
傳回一個值,指示是否可以設定屬性。
如果滿足以下條件,則可以寫入屬性
- 類別具有與指定名稱相關聯的 setter 方法(在這種情況下,屬性名稱不區分大小寫);
- 類別具有具有指定名稱的成員變數(當
$checkVars
為 true 時); - 附加的行為具有給定名稱的可寫屬性(當
$checkBehaviors
為 true 時)。
另請參閱 canGetProperty()。
public boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
屬性名稱 |
$checkVars | 布林值 |
是否將成員變數視為屬性 |
$checkBehaviors | 布林值 |
是否將行為的屬性視為此組件的屬性 |
return | 布林值 |
屬性是否可以寫入 |
---|
public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name, $checkVars)) {
return true;
}
}
}
return false;
}
::class
。
定義於: yii\base\BaseObject::className()
傳回此類別的完整限定名稱。
public static string className ( ) | ||
return | string |
此類別的完整限定名稱。 |
---|
public static function className()
{
return get_called_class();
}
傳回執行客戶端驗證所需的 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 | 字串|null |
客戶端驗證腳本。如果驗證器不支援客戶端驗證,則為 Null。 |
---|
public function clientValidateAttribute($model, $attribute, $view)
{
if ($this->clientValidate !== null) {
$method = $this->clientValidate;
if (is_string($method)) {
$method = [$model, $method];
} elseif ($method instanceof \Closure) {
$method = $method->bindTo($model);
}
$current = $this->current;
if ($current === null) {
$current = $model->$attribute;
}
return $method($attribute, $this->params, $this, $current, $view);
}
return null;
}
定義於: yii\validators\Validator::createValidator()
建立驗證器物件。
public static yii\validators\Validator createValidator ( $type, $model, $attributes, $params = [] ) | ||
$type | 字串|Closure |
驗證器類型。這可以是以下之一
|
$model | yii\base\Model |
要驗證的資料模型。 |
$attributes | 陣列|字串 |
要驗證的屬性列表。這可以是屬性名稱的陣列或逗號分隔的屬性名稱字串。 |
$params | 陣列 |
要應用於驗證器屬性的初始值。 |
return | yii\validators\Validator |
驗證器 |
---|
public static function createValidator($type, $model, $attributes, $params = [])
{
$params['attributes'] = $attributes;
if ($type instanceof \Closure) {
$params['class'] = __NAMESPACE__ . '\InlineValidator';
$params['method'] = $type;
} elseif (!isset(static::$builtInValidators[$type]) && $model->hasMethod($type)) {
// method-based validator
$params['class'] = __NAMESPACE__ . '\InlineValidator';
$params['method'] = [$model, $type];
} else {
unset($params['current']);
if (isset(static::$builtInValidators[$type])) {
$type = static::$builtInValidators[$type];
}
if (is_array($type)) {
$params = array_merge($type, $params);
} else {
$params['class'] = $type;
}
}
return Yii::createObject($params);
}
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;
}
定義於: yii\base\Component::detachBehaviors()
從組件分離所有行為。
public void detachBehaviors ( ) |
public function detachBehaviors()
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $name => $behavior) {
$this->detachBehavior($name);
}
}
定義於: 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);
}
}
}
定義於: yii\validators\Validator::formatMessage()
使用 I18N 格式化訊息,如果 \Yii::$app
不可用,則使用簡單的 strtr。
protected string formatMessage ( $message, $params ) | ||
$message | string | |
$params | 陣列 |
protected function formatMessage($message, $params)
{
if (Yii::$app !== null) {
return \Yii::$app->getI18n()->format($message, $params, Yii::$app->language);
}
$placeholders = [];
foreach ((array) $params as $name => $value) {
$placeholders['{' . $name . '}'] = $value;
}
return ($placeholders === []) ? $message : strtr($message, $placeholders);
}
定義於: yii\validators\Validator::getAttributeNames()
傳回已清除的屬性名稱,不包含開頭的 !
字元。
public array getAttributeNames ( ) | ||
return | 陣列 |
屬性名稱。 |
---|
public function getAttributeNames()
{
return array_map(function ($attribute) {
return ltrim($attribute, '!');
}, $this->attributes);
}
定義於: 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;
}
定義於: yii\base\Component::getBehaviors()
傳回附加到此組件的所有行為。
public yii\base\Behavior[] getBehaviors ( ) | ||
return | yii\base\Behavior[] |
附加到此組件的行為列表 |
---|
public function getBehaviors()
{
$this->ensureBehaviors();
return $this->_behaviors;
}
定義於: yii\validators\Validator::getClientOptions()
傳回客戶端驗證選項。
此方法通常從 clientValidateAttribute() 呼叫。您可以覆寫此方法以修改將傳遞到客戶端驗證的選項。
public array getClientOptions ( $model, $attribute ) | ||
$model | yii\base\Model |
正在驗證的模型 |
$attribute | string |
正在驗證的屬性名稱 |
return | 陣列 |
客戶端驗證選項 |
---|
public function getClientOptions($model, $attribute)
{
return [];
}
定義於: yii\validators\Validator::getValidationAttributes()
傳回此驗證器適用的屬性列表。
public array|null getValidationAttributes ( $attributes = null ) | ||
$attributes | array|string|null |
要驗證的屬性列表。
|
return | 陣列|null |
屬性名稱列表。 |
---|
public function getValidationAttributes($attributes = null)
{
if ($attributes === null) {
return $this->getAttributeNames();
}
if (is_scalar($attributes)) {
$attributes = [$attributes];
}
$newAttributes = [];
$attributeNames = $this->getAttributeNames();
foreach ($attributes as $attribute) {
// do not strict compare, otherwise int attributes would fail due to to string conversion in getAttributeNames() using ltrim().
if (in_array($attribute, $attributeNames, false)) {
$newAttributes[] = $attribute;
}
}
return $newAttributes;
}
定義於: yii\base\Component::hasEventHandlers()
傳回一個值,指示是否有名稱事件附加任何處理常式。
public boolean hasEventHandlers ( $name ) | ||
$name | string |
事件名稱 |
return | 布林值 |
是否有任何處理常式附加到事件。 |
---|
public function hasEventHandlers($name)
{
$this->ensureBehaviors();
if (!empty($this->_events[$name])) {
return true;
}
foreach ($this->_eventWildcards as $wildcard => $handlers) {
if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
return true;
}
}
return Event::hasHandlers($this, $name);
}
定義於: yii\base\Component::hasMethod()
傳回一個值,指示是否已定義方法。
如果滿足以下任一條件,則定義方法:
- 類別具有指定名稱的方法
- 附加的行為具有給定名稱的方法(當
$checkBehaviors
為 true 時)。
public boolean hasMethod ( $name, $checkBehaviors = true ) | ||
$name | string |
屬性名稱 |
$checkBehaviors | 布林值 |
是否將行為的方法視為此組件的方法 |
return | 布林值 |
是否已定義方法 |
---|
public function hasMethod($name, $checkBehaviors = true)
{
if (method_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->hasMethod($name)) {
return true;
}
}
}
return false;
}
定義於: yii\base\Component::hasProperty()
傳回一個值,指示是否為此組件定義了屬性。
如果滿足以下任一條件,則定義屬性:
- 類別具有與指定名稱關聯的 getter 或 setter 方法(在這種情況下,屬性名稱不區分大小寫);
- 類別具有具有指定名稱的成員變數(當
$checkVars
為 true 時); - 附加的行為具有給定名稱的屬性(當
$checkBehaviors
為 true 時)。
另請參閱
public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
屬性名稱 |
$checkVars | 布林值 |
是否將成員變數視為屬性 |
$checkBehaviors | 布林值 |
是否將行為的屬性視為此組件的屬性 |
return | 布林值 |
是否已定義屬性 |
---|
public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}
public void init ( ) |
public function init()
{
parent::init();
$this->attributes = (array) $this->attributes;
$this->on = (array) $this->on;
$this->except = (array) $this->except;
}
定義於: yii\validators\Validator::isActive()
傳回一個值,指示驗證器是否對給定的情境和屬性處於活動狀態。
如果滿足以下任一條件,驗證器為活動狀態:
- 驗證器的
on
屬性為空,或者 - 驗證器的
on
屬性包含指定的場景
public boolean isActive ( $scenario ) | ||
$scenario | string |
場景名稱 |
return | 布林值 |
驗證器是否適用於指定的場景。 |
---|
public function isActive($scenario)
{
return !in_array($scenario, $this->except, true) && (empty($this->on) || in_array($scenario, $this->on, true));
}
定義於: yii\validators\Validator::isEmpty()
檢查給定的值是否為空。
如果值為 null、空陣列或空字串,則視為空值。請注意,此方法與 PHP empty() 不同。當值為 0 時,它將傳回 false。
public boolean isEmpty ( $value ) | ||
$value | 混合 |
要檢查的值 |
return | 布林值 |
值是否為空 |
---|
public function isEmpty($value)
{
if ($this->isEmpty !== null) {
return call_user_func($this->isEmpty, $value);
}
return $value === null || $value === [] || $value === '';
}
定義於: yii\base\Component::off()
從此組件中移除現有的事件處理器。
此方法與 on() 相反。
注意:如果為事件名稱傳遞了萬用字元模式,則只會移除使用此萬用字元註冊的處理常式,而使用符合此萬用字元的純名稱註冊的處理常式將會保留。
另請參閱 on()。
public boolean off ( $name, $handler = null ) | ||
$name | string |
事件名稱 |
$handler | 可呼叫|null |
要移除的事件處理常式。如果為 null,則會移除附加到具名事件的所有處理常式。 |
return | 布林值 |
如果找到並分離處理常式 |
---|
public function off($name, $handler = null)
{
$this->ensureBehaviors();
if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
return false;
}
if ($handler === null) {
unset($this->_events[$name], $this->_eventWildcards[$name]);
return true;
}
$removed = false;
// plain event names
if (isset($this->_events[$name])) {
foreach ($this->_events[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_events[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_events[$name] = array_values($this->_events[$name]);
return true;
}
}
// wildcard event names
if (isset($this->_eventWildcards[$name])) {
foreach ($this->_eventWildcards[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_eventWildcards[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
// remove empty wildcards to save future redundant regex checks:
if (empty($this->_eventWildcards[$name])) {
unset($this->_eventWildcards[$name]);
}
}
}
return $removed;
}
將事件處理器附加到事件。
事件處理常式必須是有效的 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 | 混合 |
事件觸發時要傳遞到事件處理常式的資料。調用事件處理常式時,可以透過 yii\base\Event::$data 存取此資料。 |
$append | 布林值 |
是否將新的事件處理常式附加到現有處理常式列表的末尾。如果為 false,則新的處理常式將插入到現有處理常式列表的開頭。 |
public function on($name, $handler, $data = null, $append = true)
{
$this->ensureBehaviors();
if (strpos($name, '*') !== false) {
if ($append || empty($this->_eventWildcards[$name])) {
$this->_eventWildcards[$name][] = [$handler, $data];
} else {
array_unshift($this->_eventWildcards[$name], [$handler, $data]);
}
return;
}
if ($append || empty($this->_events[$name])) {
$this->_events[$name][] = [$handler, $data];
} else {
array_unshift($this->_events[$name], [$handler, $data]);
}
}
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);
}
public boolean validate ( $value, &$error = null ) | ||
$value | 混合 |
要驗證的資料值。 |
$error | 字串|null |
如果驗證失敗,要傳回的錯誤訊息。 |
return | 布林值 |
資料是否有效。 |
---|
public function validate($value, &$error = null)
{
$result = $this->validateValue($value);
if (empty($result)) {
return true;
}
list($message, $params) = $result;
$params['attribute'] = Yii::t('yii', 'the input value');
if (is_array($value)) {
$params['value'] = 'array()';
} elseif (is_object($value)) {
$params['value'] = 'object';
} else {
$params['value'] = $value;
}
$error = $this->formatMessage($message, $params);
return false;
}
驗證單一屬性。
子類別必須實作此方法以提供實際的驗證邏輯。
public void validateAttribute ( $model, $attribute ) | ||
$model | yii\base\Model |
要驗證的資料模型 |
$attribute | string |
要驗證的屬性名稱。 |
public function validateAttribute($model, $attribute)
{
$method = $this->method;
if (is_string($method)) {
$method = [$model, $method];
} elseif ($method instanceof \Closure) {
$method = $this->method->bindTo($model);
}
$current = $this->current;
if ($current === null) {
$current = $model->$attribute;
}
$method($attribute, $this->params, $this, $current);
}
定義於: 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);
}
}
}
}
protected array|null validateValue ( $value ) | ||
$value | 混合 |
要驗證的資料值。 |
return | 陣列|null |
錯誤訊息和要插入錯誤訊息的參數陣列。
} return null; 如果資料有效,則應傳回 Null。 |
---|---|---|
throws | yii\base\NotSupportedException |
如果驗證器不支援在沒有模型的情況下進行資料驗證 |
protected function validateValue($value)
{
throw new NotSupportedException(get_class($this) . ' does not support validateValue().');
}
註冊 或 登入 以進行評論。