4 追蹤者

類別 yii\widgets\ActiveForm

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

ActiveForm 是一個小工具,用於為一個或多個資料模型建立互動式 HTML 表單。

有關 ActiveForm 的更多詳細資訊和使用說明,請參閱表單指南文章

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$action array|string 表單 action URL。 yii\widgets\ActiveForm
$ajaxDataType string 您期望從伺服器接收回傳的資料類型。 yii\widgets\ActiveForm
$ajaxParam string 指示驗證請求為 AJAX 請求的 GET 參數名稱。 yii\widgets\ActiveForm
$autoIdPrefix string 自動產生的小工具 ID 的前綴。 yii\base\Widget
$behaviors yii\base\Behavior[] 附加到此元件的行為列表。 yii\base\Component
$enableAjaxValidation boolean 是否啟用基於 AJAX 的資料驗證。 yii\widgets\ActiveForm
$enableClientScript boolean 是否掛鉤 yii.activeForm JavaScript 外掛程式。 yii\widgets\ActiveForm
$enableClientValidation boolean 是否啟用客戶端資料驗證。 yii\widgets\ActiveForm
$encodeErrorSummary boolean 是否對錯誤摘要執行編碼。 yii\widgets\ActiveForm
$errorCssClass string 當關聯屬性有驗證錯誤時,添加到欄位容器的 CSS 類別。 yii\widgets\ActiveForm
$errorSummaryCssClass string 錯誤摘要容器的預設 CSS 類別。 yii\widgets\ActiveForm
$fieldClass string 呼叫 field() 以建立新欄位時的預設欄位類別名稱。 yii\widgets\ActiveForm
$fieldConfig array|Closure field() 在建立新欄位物件時使用的預設配置。 yii\widgets\ActiveForm
$id string|null 小工具的 ID。 yii\base\Widget
$method string 表單提交方法。 yii\widgets\ActiveForm
$options array 表單標籤的 HTML 屬性 (名稱-值 對)。 yii\widgets\ActiveForm
$requiredCssClass string 當關聯屬性為必填時,添加到欄位容器的 CSS 類別。 yii\widgets\ActiveForm
$scrollToError boolean 是否在驗證後捲動到第一個錯誤。 yii\widgets\ActiveForm
$scrollToErrorOffset integer 捲動到第一個錯誤時應加入的像素偏移量。 yii\widgets\ActiveForm
$successCssClass string 當關聯屬性成功驗證時,添加到欄位容器的 CSS 類別。 yii\widgets\ActiveForm
$validateOnBlur boolean 是否在輸入欄位失去焦點時執行驗證。 yii\widgets\ActiveForm
$validateOnChange boolean 是否在輸入欄位的值變更時執行驗證。 yii\widgets\ActiveForm
$validateOnSubmit boolean 是否在提交表單時執行驗證。 yii\widgets\ActiveForm
$validateOnType boolean 是否在使用者於輸入欄位中輸入時執行驗證。 yii\widgets\ActiveForm
$validatingCssClass string 當關聯屬性正在驗證時,添加到欄位容器的 CSS 類別。 yii\widgets\ActiveForm
$validationDelay integer 當使用者在欄位中輸入且 $validateOnType 設定為 true 時,驗證應延遲的毫秒數。 yii\widgets\ActiveForm
$validationStateOn string 在哪裡呈現驗證狀態類別。可以是 "container" 或 "input"。 yii\widgets\ActiveForm
$validationUrl array|string|null 用於執行基於 AJAX 的驗證的 URL。 yii\widgets\ActiveForm
$view yii\web\View 可用於呈現視圖或視圖檔案的視圖物件。 yii\base\Widget
$viewPath string 包含此小工具的視圖檔案的目錄。 yii\base\Widget

公開方法

隱藏繼承的方法

方法 描述 定義於
__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
afterRun() 此方法在小工具執行後立即調用。 yii\base\Widget
attachBehavior() 將行為附加到此元件。 yii\base\Component
attachBehaviors() 將行為列表附加到組件。 yii\base\Component
beforeRun() 此方法在小組件執行前立即調用。 yii\base\Widget
begin() 開始一個小組件。 yii\base\Widget
beginField() 開始一個表單欄位。 yii\widgets\ActiveForm
behaviors() 返回此組件應表現為的行為列表。 yii\base\Component
canGetProperty() 返回一個值,指示是否可以讀取屬性。 yii\base\Component
canSetProperty() 返回一個值,指示是否可以設定屬性。 yii\base\Component
className() 返回此類別的完整限定名稱。 yii\base\BaseObject
detachBehavior() 從組件分離一個行為。 yii\base\Component
detachBehaviors() 從組件分離所有行為。 yii\base\Component
end() 結束一個小組件。 yii\base\Widget
endField() 結束一個表單欄位。 yii\widgets\ActiveForm
ensureBehaviors() 確保在 behaviors() 中宣告的行為已附加到此組件。 yii\base\Component
errorSummary() 產生驗證錯誤的摘要。 yii\widgets\ActiveForm
field() 產生一個表單欄位。 yii\widgets\ActiveForm
getBehavior() 返回指定名稱的行為物件。 yii\base\Component
getBehaviors() 返回附加到此組件的所有行為。 yii\base\Component
getId() 返回小組件的 ID。 yii\base\Widget
getView() 返回可用於渲染視圖或視圖檔案的視圖物件。 yii\base\Widget
getViewPath() 返回包含此小組件視圖檔案的目錄。 yii\base\Widget
hasEventHandlers() 返回一個值,指示是否有名稱事件附加任何處理器。 yii\base\Component
hasMethod() 返回一個值,指示是否已定義方法。 yii\base\Component
hasProperty() 返回一個值,指示是否為此組件定義了屬性。 yii\base\Component
init() 初始化小組件。 yii\widgets\ActiveForm
off() 從此組件分離現有的事件處理器。 yii\base\Component
on() 將事件處理器附加到事件。 yii\base\Component
registerClientScript() 此方法註冊必要的 JavaScript 程式碼。 yii\widgets\ActiveForm
render() 渲染一個視圖。 yii\base\Widget
renderFile() 渲染一個視圖檔案。 yii\base\Widget
run() 執行小組件。 yii\widgets\ActiveForm
setId() 設定小組件的 ID。 yii\base\Widget
setView() 設定此小組件要使用的視圖物件。 yii\base\Widget
trigger() 觸發一個事件。 yii\base\Component
validate() 驗證一個或多個模型,並返回一個以屬性 ID 索引的錯誤訊息陣列。 yii\widgets\ActiveForm
validateMultiple() 驗證模型實例陣列,並返回一個以屬性 ID 索引的錯誤訊息陣列。 yii\widgets\ActiveForm
widget() 建立一個小組件實例並執行它。 yii\base\Widget

受保護的方法

隱藏繼承的方法

方法 描述 定義於
getClientOptions() 返回表單 JS 小組件的選項。 yii\widgets\ActiveForm

事件

隱藏繼承的事件

事件 類型 描述 定義於
EVENT_AFTER_RUN yii\base\WidgetEvent 在執行小組件後立即引發的事件。(自版本 2.0.11 起可用) yii\base\Widget
EVENT_BEFORE_RUN yii\base\WidgetEvent 在執行小組件前立即引發的事件。(自版本 2.0.11 起可用) yii\base\Widget
EVENT_INIT yii\base\Event 通過 init() 初始化小組件時觸發的事件。(自版本 2.0.11 起可用) yii\base\Widget

常數

隱藏繼承的常數

常數 描述 定義於
VALIDATION_STATE_ON_CONTAINER 'container' 將驗證狀態類別新增到容器標籤 yii\widgets\ActiveForm
VALIDATION_STATE_ON_INPUT 'input' 將驗證狀態類別新增到輸入標籤 yii\widgets\ActiveForm

屬性詳情

隱藏繼承的屬性

$action 公開屬性

表單 action URL。此參數將由 yii\helpers\Url::to() 處理。

另請參閱 $method 以指定此表單的 HTTP 方法。

public array|string $action ''
$ajaxDataType 公開屬性

您期望從伺服器接收回傳的資料類型。

public string $ajaxDataType 'json'
$ajaxParam 公開屬性

指示驗證請求為 AJAX 請求的 GET 參數名稱。

public string $ajaxParam 'ajax'
$enableAjaxValidation 公開屬性

是否啟用基於 AJAX 的資料驗證。如果設定了 yii\widgets\ActiveField::$enableAjaxValidation,則其值將優先用於該輸入欄位。

$enableClientScript 公開屬性

是否掛鉤 yii.activeForm JavaScript 外掛程式。如果您要支援用戶端驗證和/或 AJAX 驗證,或者您想要利用 yii.activeForm 外掛程式,則必須將此屬性設定為 true。當此屬性為 false 時,表單將不會產生任何 JavaScript。

另請參閱 registerClientScript()

$enableClientValidation 公開屬性

是否啟用用戶端資料驗證。如果設定了 yii\widgets\ActiveField::$enableClientValidation,則其值將優先用於該輸入欄位。

$encodeErrorSummary 公開屬性

是否對錯誤摘要執行編碼。

$errorCssClass 公開屬性

當關聯屬性有驗證錯誤時,添加到欄位容器的 CSS 類別。

public string $errorCssClass 'has-error'
$errorSummaryCssClass 公開屬性

錯誤摘要容器的預設 CSS 類別。

另請參閱 errorSummary()

public string $errorSummaryCssClass 'error-summary'
$fieldClass 公開屬性

呼叫 field() 以建立新欄位時的預設欄位類別名稱。

另請參閱 $fieldConfig

public string $fieldClass 'yii\widgets\ActiveField'
$fieldConfig 公開屬性

field() 在建立新欄位物件時使用的預設配置。這可以是配置陣列或返回配置陣列的匿名函式。如果是後者,則簽名應如下:

function ($model, $attribute)

此屬性的值將與傳遞給 field()$options 參數遞迴合併。

另請參閱 $fieldClass

$method 公開屬性

表單提交方法。這應為 postget。預設為 post

當您將其設定為 get 時,您可能會看到每個請求都重複 URL 參數。這是因為 $action 的預設值設定為當前請求 URL,並且每次提交都會新增新的參數,而不是替換現有的參數。您可以明確設定 $action 以避免這種情況。

$form = ActiveForm::begin([
    'method' => 'get',
    'action' => ['controller/action'],
]);
public string $method 'post'
$options 公開屬性

表單標籤的 HTML 屬性 (名稱-值 對)。

另請參閱 yii\helpers\Html::renderTagAttributes(),以詳細了解如何渲染屬性。

public array $options = []
$requiredCssClass 公開屬性

當關聯屬性為必填時,添加到欄位容器的 CSS 類別。

public string $requiredCssClass 'required'
$scrollToError 公開屬性 (自版本 2.0.6 起可用)

是否在驗證後捲動到第一個錯誤。

public boolean $scrollToError true
$scrollToErrorOffset 公開屬性 (自版本 2.0.11 起可用)

捲動到第一個錯誤時應加入的像素偏移量。

$successCssClass 公開屬性

當關聯屬性成功驗證時,添加到欄位容器的 CSS 類別。

public string $successCssClass 'has-success'
$validateOnBlur 公開屬性

是否在輸入欄位失去焦點時執行驗證。如果設定了 yii\widgets\ActiveField::$validateOnBlur,則其值將優先用於該輸入欄位。

public boolean $validateOnBlur true
$validateOnChange 公開屬性

是否在輸入欄位的值變更時執行驗證。如果設定了 yii\widgets\ActiveField::$validateOnChange,則其值將優先用於該輸入欄位。

public boolean $validateOnChange true
$validateOnSubmit 公開屬性

是否在提交表單時執行驗證。

public boolean $validateOnSubmit true
$validateOnType 公開屬性

是否在使用者於輸入欄位中輸入時執行驗證。如果設定了 yii\widgets\ActiveField::$validateOnType,則其值將優先用於該輸入欄位。

另請參閱 $validationDelay

public boolean $validateOnType false
$validatingCssClass 公開屬性

當關聯屬性正在驗證時,添加到欄位容器的 CSS 類別。

public string $validatingCssClass 'validating'
$validationDelay 公開屬性

當使用者在欄位中輸入且 $validateOnType 設定為 true 時,驗證應延遲的毫秒數。如果設定了 yii\widgets\ActiveField::$validationDelay,則其值將優先用於該輸入欄位。

$validationStateOn 公開屬性 (自版本 2.0.14 起可用)

在哪裡渲染驗證狀態類別。可以是 "container" 或 "input"。預設為 "container"。

public string $validationStateOn self::VALIDATION_STATE_ON_CONTAINER
$validationUrl 公開屬性

用於執行基於 AJAX 驗證的 URL。此屬性將由 yii\helpers\Url::to() 處理。有關如何配置此屬性的更多詳細資訊,請參閱 yii\helpers\Url::to()。如果未設定此屬性,它將採用表單 action 屬性的值。

方法詳情

隱藏繼承的方法

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

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

將元件屬性設定為 null。

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

  • 由 setter 定義的屬性:將屬性值設定為 null
  • 行為 (behavior) 的屬性:將屬性值設定為 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);
}

            
afterRun() public method (自版本 2.0.11 起可用)

定義於: yii\base\Widget::afterRun()

此方法在小工具執行後立即調用。

此方法將觸發 EVENT_AFTER_RUN 事件。此方法的傳回值將作為 widget 的傳回值。

如果您覆寫此方法,您的程式碼應該看起來像這樣

public function afterRun($result)
{
    $result = parent::afterRun($result);
    // your custom code here
    return $result;
}
public mixed afterRun ( $result )
$result mixed

Widget 的傳回結果。

return mixed

已處理的 widget 結果。

                public function afterRun($result)
{
    $event = new WidgetEvent();
    $event->result = $result;
    $this->trigger(self::EVENT_AFTER_RUN, $event);
    return $event->result;
}

            
attachBehavior() public method

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

將行為附加到此元件。

此方法將根據給定的組態建立行為 (behavior) 物件。 之後,將透過呼叫 yii\base\Behavior::attach() 方法將行為 (behavior) 物件附加到此元件。

另請參閱 detachBehavior()

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

行為 (behavior) 的名稱。

$behavior string|array|yii\base\Behavior

行為 (behavior) 組態。 這可以是以下其中之一

return yii\base\Behavior

行為 (behavior) 物件

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() public method

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

將行為列表附加到組件。

每個行為 (behavior) 都以其名稱索引,並且應該是一個 yii\base\Behavior 物件、一個指定行為 (behavior) 類別的字串,或一個用於建立行為 (behavior) 的組態陣列。

另請參閱 attachBehavior()

public void attachBehaviors ( $behaviors )
$behaviors array

要附加到元件的行為 (behavior) 列表

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
beforeRun() public method (自版本 2.0.11 起可用)

定義於: yii\base\Widget::beforeRun()

此方法在小組件執行前立即調用。

此方法將觸發 EVENT_BEFORE_RUN 事件。此方法的傳回值將決定 widget 是否應繼續執行。

當覆寫此方法時,請確保您像以下方式呼叫父類別實作

public function beforeRun()
{
    if (!parent::beforeRun()) {
        return false;
    }

    // your custom code here

    return true; // or false to not run the widget
}
public boolean beforeRun ( )
return boolean

widget 是否應繼續執行。

                public function beforeRun()
{
    $event = new WidgetEvent();
    $this->trigger(self::EVENT_BEFORE_RUN, $event);
    return $event->isValid;
}

            
begin() public static method

定義於: yii\base\Widget::begin()

開始一個小組件。

此方法建立呼叫類別的實例。 它會將組態應用於建立的實例。 稍後應呼叫相符的 end() 呼叫。 由於某些 widget 可能會使用輸出緩衝,因此應在同一個視圖中進行 end() 呼叫,以避免破壞輸出緩衝的巢狀結構。

另請參閱 end()

public static static begin ( $config = [] )
$config array

將用於初始化物件屬性的名稱-值對

return yii\base\Widget

新建立的 widget 實例

                public static function begin($config = [])
{
    $config['class'] = get_called_class();
    /* @var $widget Widget */
    $widget = Yii::createObject($config);
    self::$stack[] = $widget;
    return $widget;
}

            
beginField() public method

開始一個表單欄位。

此方法將建立一個新的表單欄位並傳回其開始標籤。 您應該在之後呼叫 endField()

另請參閱

public string beginField ( $model, $attribute, $options = [] )
$model yii\base\Model

資料模型。

$attribute string

屬性名稱或運算式。 有關屬性運算式的格式,請參閱 yii\helpers\Html::getAttributeName()

$options array

欄位物件的其他組態。

return string

開始標籤。

                public function beginField($model, $attribute, $options = [])
{
    $field = $this->field($model, $attribute, $options);
    $this->_fields[] = $field;
    return $field->begin();
}

            
behaviors() public method

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

返回此組件應表現為的行為列表。

子類別可以覆寫此方法以指定它們想要表現為的行為 (behavior)。

此方法的傳回值應該是一個行為 (behavior) 物件或組態的陣列,以行為 (behavior) 名稱索引。 行為 (behavior) 組態可以是指定行為 (behavior) 類別的字串或以下結構的陣列

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

請注意,行為 (behavior) 類別必須從 yii\base\Behavior 擴展。 行為 (behavior) 可以使用名稱或匿名方式附加。 當名稱用作陣列鍵時,使用此名稱,稍後可以使用 getBehavior() 檢索行為 (behavior),或使用 detachBehavior() 分離行為 (behavior)。 匿名行為 (behavior) 無法檢索或分離。

在此方法中宣告的行為 (behavior) 將自動(根據需求)附加到元件。

public array behaviors ( )
return array

行為 (behavior) 組態。

                public function behaviors()
{
    return [];
}

            
canGetProperty() public method

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

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

如果滿足以下條件,則可以讀取屬性:

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

另請參閱 canSetProperty()

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

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

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 時);
  • 附加的行為 (behavior) 具有給定名稱的可寫屬性(當 $checkBehaviors 為 true 時)。

另請參閱 canGetProperty()

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

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

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

            
detachBehavior() public method

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

從組件分離一個行為。

將調用行為 (behavior) 的 yii\base\Behavior::detach() 方法。

public yii\base\Behavior|null detachBehavior ( $name )
$name string

行為 (behavior) 的名稱。

return yii\base\Behavior|null

已分離的行為 (behavior)。 如果行為 (behavior) 不存在,則為 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);
    }
}

            
end() public static method

定義於: yii\base\Widget::end()

結束一個小組件。

請注意,widget 的呈現結果會直接輸出。

另請參閱 begin()

public static static end ( )
return yii\base\Widget

已結束的 widget 實例。

throws yii\base\InvalidCallException

如果 begin()end() 呼叫未正確巢狀

                public static function end()
{
    if (!empty(self::$stack)) {
        $widget = array_pop(self::$stack);
        $calledClass = get_called_class();
        if (Yii::$container->has($calledClass) && isset(Yii::$container->getDefinitions()[$calledClass]['class'])) {
            $calledClass = Yii::$container->getDefinitions()[$calledClass]['class'];
        }
        if (get_class($widget) === $calledClass) {
            /* @var $widget Widget */
            if ($widget->beforeRun()) {
                $result = $widget->run();
                $result = $widget->afterRun($result);
                echo $result;
            }
            return $widget;
        }
        throw new InvalidCallException('Expecting end() of ' . get_class($widget) . ', found ' . get_called_class());
    }
    throw new InvalidCallException('Unexpected ' . get_called_class() . '::end() call. A matching begin() is not found.');
}

            
endField() public method

結束一個表單欄位。

此方法將傳回由 beginField() 啟動的 active form 欄位的結束標籤。

public string endField ( )
return string

表單欄位的結束標籤。

throws yii\base\InvalidCallException

如果在沒有先呼叫 beginField() 的情況下呼叫此方法。

                public function endField()
{
    $field = array_pop($this->_fields);
    if ($field instanceof ActiveField) {
        return $field->end();
    }
    throw new InvalidCallException('Mismatching endField() call.');
}

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

            
errorSummary() public method

產生驗證錯誤的摘要。

如果沒有驗證錯誤,仍然會產生一個空的錯誤摘要標記,但它將會被隱藏。

另請參閱 $errorSummaryCssClass

public string errorSummary ( $models, $options = [] )
$models yii\base\Model|yii\base\Model[]

與此表單關聯的模型。

$options array

以名稱-值對表示的標籤選項。 以下選項經過特殊處理

  • header:字串,錯誤摘要的標頭 HTML。 如果未設定,將使用預設提示字串。
  • footer:字串,錯誤摘要的頁尾 HTML。

其餘選項將呈現為容器標籤的屬性。 這些值將使用 yii\helpers\Html::encode() 進行 HTML 編碼。 如果值為 null,則不會呈現對應的屬性。

return string

產生的錯誤摘要。

                public function errorSummary($models, $options = [])
{
    Html::addCssClass($options, $this->errorSummaryCssClass);
    $options['encode'] = $this->encodeErrorSummary;
    return Html::errorSummary($models, $options);
}

            
field() public method

產生一個表單欄位。

表單欄位與模型和屬性關聯。 它包含標籤、輸入和錯誤訊息,並使用它們與終端使用者互動,以收集他們對屬性的輸入。

另請參閱 $fieldConfig

public yii\widgets\ActiveField field ( $model, $attribute, $options = [] )
$model yii\base\Model

資料模型。

$attribute string

屬性名稱或運算式。 有關屬性運算式的格式,請參閱 yii\helpers\Html::getAttributeName()

$options array

欄位物件的其他組態。 這些是 yii\widgets\ActiveField 或子類別的屬性,取決於 $fieldClass 的值。

return yii\widgets\ActiveField

建立的 ActiveField 物件。

                public function field($model, $attribute, $options = [])
{
    $config = $this->fieldConfig;
    if ($config instanceof \Closure) {
        $config = call_user_func($config, $model, $attribute);
    }
    if (!isset($config['class'])) {
        $config['class'] = $this->fieldClass;
    }
    return Yii::createObject(ArrayHelper::merge($config, $options, [
        'model' => $model,
        'attribute' => $attribute,
        'form' => $this,
    ]));
}

            
getBehavior() public method

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

返回指定名稱的行為物件。

public yii\base\Behavior|null getBehavior ( $name )
$name string

行為 (behavior) 名稱

return yii\base\Behavior|null

行為 (behavior) 物件,如果行為 (behavior) 不存在則為 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[]

附加到此元件的行為 (behavior) 列表

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

            
getClientOptions() protected method

返回表單 JS 小組件的選項。

protected array getClientOptions ( )
return array

選項。

                protected function getClientOptions()
{
    $options = [
        'encodeErrorSummary' => $this->encodeErrorSummary,
        'errorSummary' => '.' . implode('.', preg_split('/\s+/', $this->errorSummaryCssClass, -1, PREG_SPLIT_NO_EMPTY)),
        'validateOnSubmit' => $this->validateOnSubmit,
        'errorCssClass' => $this->errorCssClass,
        'successCssClass' => $this->successCssClass,
        'validatingCssClass' => $this->validatingCssClass,
        'ajaxParam' => $this->ajaxParam,
        'ajaxDataType' => $this->ajaxDataType,
        'scrollToError' => $this->scrollToError,
        'scrollToErrorOffset' => $this->scrollToErrorOffset,
        'validationStateOn' => $this->validationStateOn,
    ];
    if ($this->validationUrl !== null) {
        $options['validationUrl'] = Url::to($this->validationUrl);
    }
    // only get the options that are different from the default ones (set in yii.activeForm.js)
    return array_diff_assoc($options, [
        'encodeErrorSummary' => true,
        'errorSummary' => '.error-summary',
        'validateOnSubmit' => true,
        'errorCssClass' => 'has-error',
        'successCssClass' => 'has-success',
        'validatingCssClass' => 'validating',
        'ajaxParam' => 'ajax',
        'ajaxDataType' => 'json',
        'scrollToError' => true,
        'scrollToErrorOffset' => 0,
        'validationStateOn' => self::VALIDATION_STATE_ON_CONTAINER,
    ]);
}

            
getId() public method

定義於: yii\base\Widget::getId()

返回小組件的 ID。

public string|null getId ( $autoGenerate true )
$autoGenerate boolean

如果先前未設定 ID,是否要產生 ID

return string|null

小工具的 ID。

                public function getId($autoGenerate = true)
{
    if ($autoGenerate && $this->_id === null) {
        $this->_id = static::$autoIdPrefix . static::$counter++;
    }
    return $this->_id;
}

            
getView() public method

定義於: yii\base\Widget::getView()

返回可用於渲染視圖或視圖檔案的視圖物件。

render()renderFile() 方法將使用此視圖物件來實作實際的視圖呈現。 如果未設定,它將預設為「view」應用程式元件。

public yii\web\View getView ( )
return yii\web\View

可用於呈現視圖或視圖檔案的視圖物件。

                public function getView()
{
    if ($this->_view === null) {
        $this->_view = Yii::$app->getView();
    }
    return $this->_view;
}

            
getViewPath() public method

定義於: yii\base\Widget::getViewPath()

返回包含此小組件視圖檔案的目錄。

預設實作傳回 widget 類別檔案所在目錄下的 'views' 子目錄。

public string getViewPath ( )
return string

包含此小工具的視圖檔案的目錄。

                public function getViewPath()
{
    $class = new ReflectionClass($this);
    return dirname($class->getFileName()) . DIRECTORY_SEPARATOR . 'views';
}

            
hasEventHandlers() public method

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

返回一個值,指示是否有名稱事件附加任何處理器。

public boolean hasEventHandlers ( $name )
$name string

事件名稱

return boolean

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

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

            
hasMethod() public method

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

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

方法在以下情況下被定義:

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

屬性名稱

$checkBehaviors boolean

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

return boolean

方法是否被定義

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

            
hasProperty() public method

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

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

屬性在以下情況下被定義:

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

另請參閱

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

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

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 (!isset($this->options['id'])) {
        $this->options['id'] = $this->getId();
    }
    ob_start();
    ob_implicit_flush(false);
}

            
off() public method

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

從此組件分離現有的事件處理器。

此方法與 on() 相反。

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

另請參閱 on()

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

事件名稱

$handler callable|null

要移除的事件處理器。如果為 null,則將移除附加到指定事件的所有處理器。

return boolean

如果找到並分離處理器

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

            
on() public method

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

將事件處理器附加到事件。

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

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

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

function ($event)

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

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

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

另請參閱 off()

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

事件名稱

$handler callable

事件處理器

$data mixed

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

$append boolean

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

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

            
registerClientScript() public method (available since version 2.0.12)

此方法註冊必要的 JavaScript 程式碼。

public void registerClientScript ( )

                public function registerClientScript()
{
    $id = $this->options['id'];
    $options = Json::htmlEncode($this->getClientOptions());
    $attributes = Json::htmlEncode($this->attributes);
    $view = $this->getView();
    ActiveFormAsset::register($view);
    $view->registerJs("jQuery('#$id').yiiActiveForm($attributes, $options);");
}

            
render() public method

Defined in: yii\base\Widget::render()

渲染一個視圖。

要渲染的視圖可以使用以下格式之一指定

  • 路徑別名(例如 "@app/views/site/index");
  • 應用程式內的絕對路徑(例如 "//site/index"):視圖名稱以雙斜線開頭。實際的視圖檔案將在應用程式的視圖路徑下查找。
  • 模組內的絕對路徑(例如 "/site/index"):視圖名稱以單斜線開頭。實際的視圖檔案將在當前活動模組的視圖路徑下查找。
  • 相對路徑(例如 "index"):實際的視圖檔案將在 $viewPath 下查找。

如果視圖名稱不包含檔案副檔名,它將使用預設的 .php

public string render ( $view, $params = [] )
$view string

視圖名稱。

$params array

應在視圖中提供的參數(名稱-值對)。

return string

渲染結果。

throws yii\base\InvalidArgumentException

如果視圖檔案不存在。

                public function render($view, $params = [])
{
    return $this->getView()->render($view, $params, $this);
}

            
renderFile() public method

Defined in: yii\base\Widget::renderFile()

渲染一個視圖檔案。

public string renderFile ( $file, $params = [] )
$file string

要渲染的視圖檔案。這可以是檔案路徑或 路徑別名

$params array

應在視圖中提供的參數(名稱-值對)。

return string

渲染結果。

throws yii\base\InvalidArgumentException

如果視圖檔案不存在。

                public function renderFile($file, $params = [])
{
    return $this->getView()->renderFile($file, $params, $this);
}

            
run() public method

執行小組件。

這會註冊必要的 JavaScript 程式碼並渲染表單的開始和結束標籤。

public void run ( )
throws yii\base\InvalidCallException

如果 beginField()endField() 呼叫不匹配。

                public function run()
{
    if (!empty($this->_fields)) {
        throw new InvalidCallException('Each beginField() should have a matching endField() call.');
    }
    $content = ob_get_clean();
    $html = Html::beginForm($this->action, $this->method, $this->options);
    $html .= $content;
    if ($this->enableClientScript) {
        $this->registerClientScript();
    }
    $html .= Html::endForm();
    return $html;
}

            
setId() public method

Defined in: yii\base\Widget::setId()

設定小組件的 ID。

public void setId ( $value )
$value string

Widget 的 ID。

                public function setId($value)
{
    $this->_id = $value;
}

            
setView() public method

Defined in: yii\base\Widget::setView()

設定此小組件要使用的視圖物件。

public void setView ( $view )
$view yii\base\View

可用於呈現視圖或視圖檔案的視圖物件。

                public function setView($view)
{
    $this->_view = $view;
}

            
trigger() public method

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

觸發一個事件。

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

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

事件名稱

$event yii\base\Event|null

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

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

            
validate() public static method

驗證一個或多個模型,並返回一個以屬性 ID 索引的錯誤訊息陣列。

這是一個輔助方法,簡化了編寫 AJAX 驗證程式碼的方式。

例如,您可以在控制器動作中使用以下程式碼來回應 AJAX 驗證請求

$model = new Post;
$model->load(Yii::$app->request->post());
if (Yii::$app->request->isAjax) {
    Yii::$app->response->format = Response::FORMAT_JSON;
    return ActiveForm::validate($model);
}
// ... respond to non-AJAX request ...

要驗證多個模型,只需將每個模型作為參數傳遞給此方法,如下所示

ActiveForm::validate($model1, $model2, ...);
public static array validate ( $model, $attributes null )
$model yii\base\Model

要驗證的模型。

$attributes mixed

應該驗證的屬性列表。如果此參數為空,則表示應驗證適用驗證規則中列出的任何屬性。

當此方法用於驗證多個模型時,此參數將被解釋為模型。

return array

以屬性 ID 索引的錯誤訊息陣列。

                public static function validate($model, $attributes = null)
{
    $result = [];
    if ($attributes instanceof Model) {
        // validating multiple models
        $models = func_get_args();
        $attributes = null;
    } else {
        $models = [$model];
    }
    /* @var $model Model */
    foreach ($models as $model) {
        $model->validate($attributes);
        foreach ($model->getErrors() as $attribute => $errors) {
            $result[Html::getInputId($model, $attribute)] = $errors;
        }
    }
    return $result;
}

            
validateMultiple() public static method

驗證模型實例陣列,並返回一個以屬性 ID 索引的錯誤訊息陣列。

這是一個輔助方法,簡化了為表格輸入編寫 AJAX 驗證程式碼的方式。

例如,您可以在控制器動作中使用以下程式碼來回應 AJAX 驗證請求

// ... load $models ...
if (Yii::$app->request->isAjax) {
    Yii::$app->response->format = Response::FORMAT_JSON;
    return ActiveForm::validateMultiple($models);
}
// ... respond to non-AJAX request ...
public static array validateMultiple ( $models, $attributes null )
$models array

要驗證的模型陣列。

$attributes mixed

應該驗證的屬性列表。如果此參數為空,則表示應驗證適用驗證規則中列出的任何屬性。

return array

以屬性 ID 索引的錯誤訊息陣列。

                public static function validateMultiple($models, $attributes = null)
{
    $result = [];
    /* @var $model Model */
    foreach ($models as $i => $model) {
        $model->validate($attributes);
        foreach ($model->getErrors() as $attribute => $errors) {
            $result[Html::getInputId($model, "[$i]" . $attribute)] = $errors;
        }
    }
    return $result;
}

            
widget() public static method

Defined in: yii\base\Widget::widget()

建立一個小組件實例並執行它。

Widget 渲染結果由此方法返回。

public static string widget ( $config = [] )
$config array

將用於初始化物件屬性的名稱-值對

return string

Widget 的渲染結果。

throws Throwable

                public static function widget($config = [])
{
    ob_start();
    ob_implicit_flush(false);
    try {
        /* @var $widget Widget */
        $config['class'] = get_called_class();
        $widget = Yii::createObject($config);
        $out = '';
        if ($widget->beforeRun()) {
            $result = $widget->run();
            $out = $widget->afterRun($result);
        }
    } catch (\Exception $e) {
        // close the output buffer opened above if it has not been closed already
        if (ob_get_level() > 0) {
            ob_end_clean();
        }
        throw $e;
    } catch (\Throwable $e) {
        // close the output buffer opened above if it has not been closed already
        if (ob_get_level() > 0) {
            ob_end_clean();
        }
        throw $e;
    }
    return ob_get_clean() . $out;
}