1 位追蹤者

類別 yii\widgets\MaskedInput

繼承yii\widgets\MaskedInput » yii\widgets\InputWidget » 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/MaskedInput.php

MaskedInput 產生一個遮罩文字輸入框。

MaskedInput 類似於 yii\helpers\Html::textInput(),不同之處在於它會使用輸入遮罩來強制使用者輸入格式正確的資料,例如電話號碼、社會安全號碼。

若要使用 MaskedInput,您必須設定 $mask 屬性。以下範例展示如何使用 MaskedInput 來收集電話號碼

echo MaskedInput::widget([
    'name' => 'phone',
    'mask' => '999-999-9999',
]);

您也可以在 yii\widgets\ActiveForm 中使用此小部件,使用 widget() 方法,例如像這樣

<?= $form->field($model, 'from_date')->widget(\yii\widgets\MaskedInput::class, [
    'mask' => '999-999-9999',
]) ?>

遮罩文字欄位是基於 jQuery input masked plugin 插件實作的。

公共屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$_hashVar string 用於儲存 pluginOptions 的雜湊變數 yii\widgets\MaskedInput
$_jsCallbacks string[] inputmask 屬性可以包含回呼函數 yii\widgets\MaskedInput
$aliases array 要使用的自訂別名。 yii\widgets\MaskedInput
$attribute string|null 此小部件關聯的模型屬性。 yii\widgets\InputWidget
$autoIdPrefix string 自動產生的小部件 ID 的前綴。 yii\base\Widget
$behaviors yii\base\Behavior[] 附加到此元件的行為列表。 yii\base\Component
$clientOptions array 輸入遮罩插件的 JQuery 插件選項。 yii\widgets\MaskedInput
$definitions array 要使用的自訂遮罩定義。 yii\widgets\MaskedInput
$field yii\widgets\ActiveField 觸發此小部件渲染的活動輸入欄位。 yii\widgets\InputWidget
$id string|null 小部件的 ID。 yii\base\Widget
$mask string|array|yii\web\JsExpression 輸入遮罩(例如日期輸入的 '99/99/9999')。 yii\widgets\MaskedInput
$model yii\base\Model|null 此小部件關聯的資料模型。 yii\widgets\InputWidget
$name string|null 輸入名稱。 yii\widgets\InputWidget
$options array 輸入標籤的 HTML 屬性。 yii\widgets\MaskedInput
$type string 輸入標籤的類型。 yii\widgets\MaskedInput
$value string 輸入值。 yii\widgets\InputWidget
$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
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
ensureBehaviors() 確保在 behaviors() 中宣告的行為已附加到此元件。 yii\base\Component
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\MaskedInput
off() 從此元件分離現有的事件處理常式。 yii\base\Component
on() 將事件處理常式附加到事件。 yii\base\Component
registerClientScript() 註冊所需的客戶端腳本和選項。 yii\widgets\MaskedInput
render() 渲染一個視圖。 yii\base\Widget
renderFile() 渲染一個視圖檔案。 yii\base\Widget
run() 執行小部件。 yii\widgets\MaskedInput
setId() 設定小部件的 ID。 yii\base\Widget
setView() 設定此小部件要使用的視圖物件。 yii\base\Widget
trigger() 觸發一個事件。 yii\base\Component
widget() 建立小部件實例並執行它。 yii\base\Widget

受保護的方法

隱藏繼承的方法

方法 描述 定義於
hasModel() yii\widgets\InputWidget
hashPluginOptions() 產生一個雜湊變數,以儲存插件 clientOptions yii\widgets\MaskedInput
initClientOptions() 初始化客戶端選項。 yii\widgets\MaskedInput
renderInputHtml() 渲染一個 HTML 輸入標籤。 yii\widgets\InputWidget

事件

隱藏繼承的事件

事件 類型 描述 定義於
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

常數

隱藏繼承的常數

常數 描述 定義於
PLUGIN_NAME 'inputmask' 此小部件要使用的 jQuery 插件名稱。 yii\widgets\MaskedInput

屬性詳細資訊

隱藏繼承的屬性

$_hashVar 受保護的屬性

用於儲存 pluginOptions 的雜湊變數

protected string $_hashVar null
$_jsCallbacks 受保護的屬性

inputmask 屬性可以包含回呼函數

protected string[] $_jsCallbacks = [
    
'oncomplete',
    
'onincomplete',
    
'oncleared',
    
'onKeyDown',
    
'onBeforeMask',
    
'onBeforePaste',
    
'onBeforeWrite',
    
'onUnMask',
    
'onKeyValidation',
    
'isComplete',
    
'preValidation',
    
'postValidation',
    
'canClearPosition',
]
$aliases 公共屬性

要使用的自訂別名。 應配置為 maskAlias => settings,其中

  • maskAlias 是一個字串,包含用於識別您的遮罩別名定義的文字 (例如 'phone'),以及
  • settings 是一個陣列,包含遮罩符號的設定,與在 $clientOptions 中傳遞的參數完全相似。
public array $aliases null
$clientOptions 公共屬性

輸入遮罩插件的 JQuery 插件選項。

另請參閱 https://github.com/RobinHerbots/Inputmask

public array $clientOptions = []
$definitions 公共屬性

要使用的自訂遮罩定義。 應配置為 maskSymbol => settings,其中

  • maskSymbol 是一個字串,包含用於識別您的遮罩定義的字元,以及
  • settings 是一個陣列,由以下條目組成
    • validator:字串,JS 正規表示式或 JS 函數。
    • cardinality:整數,指定為定義表示和驗證多少個字元。
    • prevalidator:陣列,在達到定義基數之前驗證字元。
    • definitionSymbol:字串,允許使用此 definitionSymbol 從其他定義中移動值。
public array $definitions null
$mask 公共屬性

輸入遮罩(例如日期輸入的 '99/99/9999')。 以下字元可用於遮罩中,並且是預先定義的

  • a:代表字母字元 (A-Z, a-z)
  • 9:代表數字字元 (0-9)
  • *:代表字母數字字元 (A-Z, a-z, 0-9)
  • []:方括號之間輸入的任何內容都被視為選用的使用者輸入。 這是基於 $clientOptions 中的 optionalmarker 設定。

其他定義可以透過 $definitions 屬性設定。

$options 公共屬性

輸入標籤的 HTML 屬性。

另請參閱 yii\helpers\Html::renderTagAttributes(),以取得關於屬性如何渲染的詳細資訊。

public array $options = [
    
'class' => 'form-control',
]
$type 公共屬性 (自版本 2.0.6 起可用)

輸入標籤的類型。 目前僅支援 'text' 和 'tel'。

另請參閱 https://github.com/RobinHerbots/Inputmask

public string $type 'text'

方法詳細資訊

隱藏繼承的方法

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

            
afterRun() 公共方法 (自版本 2.0.11 起可用)

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

此方法在小部件執行後立即調用。

此方法將觸發 EVENT_AFTER_RUN 事件。 此方法的傳回值將用作小部件傳回值。

如果您覆寫此方法,您的程式碼應如下所示

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

小部件傳回結果。

return mixed

已處理的小部件結果。

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

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

            
beforeRun() 公共方法 (自版本 2.0.11 起可用)

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

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

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

覆寫此方法時,請確保您像下面這樣呼叫父類別實作

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

是否應繼續執行小部件。

                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() 呼叫。 由於某些小部件可能會使用輸出緩衝,因此應在同一個視圖中進行 end() 呼叫,以避免中斷輸出緩衝的巢狀結構。

另請參閱 end()

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

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

return yii\base\Widget

新建立的小部件實例

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

            
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 方法

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

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

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

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

另請參閱 canSetProperty()

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

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

return boolean

屬性是否可讀取

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

            
canSetProperty() public 方法

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

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

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

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

另請參閱 canGetProperty()

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

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

return boolean

屬性是否可寫入

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

            
className() public 靜態方法
自 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 方法

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

從元件分離行為。

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

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

行為的名稱。

return yii\base\Behavior|null

已分離的行為。如果行為不存在,則為 Null。

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() public 方法

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

從元件分離所有行為。

public void detachBehaviors ( )

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

            
end() public 靜態方法

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

結束一個小部件。

請注意,小工具的呈現結果會直接輸出。

另請參閱 begin()

public static static end ( )
return yii\base\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.');
}

            
ensureBehaviors() public 方法

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

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

public void ensureBehaviors ( )

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

            
getBehavior() public 方法

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

傳回指定的行為物件。

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

行為名稱

return yii\base\Behavior|null

行為物件,如果行為不存在,則為 null

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() public 方法

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

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

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

附加到此元件的行為列表

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

            
getId() public 方法

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

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

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

傳回包含此小部件視圖檔案的目錄。

預設實作會傳回包含小工具類別檔案之目錄下的 'views' 子目錄。

public string getViewPath ( )
return string

包含此小部件視圖檔案的目錄。

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

            
hasEventHandlers() public 方法

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

傳回一個值,指示是否有名稱為指定事件的任何處理常式。

public boolean hasEventHandlers ( $name )
$name string

事件名稱

return boolean

是否有任何處理常式附加到事件。

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

            
hasMethod() public 方法

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

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

如果滿足以下條件,則定義方法

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

屬性名稱

$checkBehaviors boolean

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

return boolean

方法是否已定義

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

            
hasModel() protected 方法
protected boolean hasModel ( )
return boolean

此小工具是否與資料模型關聯。

                protected function hasModel()
{
    return $this->model instanceof Model && $this->attribute !== null;
}

            
hasProperty() public 方法

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

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

如果滿足以下條件,則定義屬性

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

另請參閱

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

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

return boolean

屬性是否已定義

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

            
hashPluginOptions() protected 方法

產生一個雜湊變數,以儲存插件 clientOptions

協助在同一頁面上為其他小工具傳遞的相似選項重複使用變數。以下特殊的資料屬性也將新增至輸入欄位,以允許透過 javascript 存取用戶端選項

  • 'data-plugin-inputmask' 將儲存儲存外掛程式選項的雜湊變數。
protected void hashPluginOptions ( $view )
$view yii\web\View

視圖實例

                protected function hashPluginOptions($view)
{
    $encOptions = empty($this->clientOptions) ? '{}' : Json::htmlEncode($this->clientOptions);
    $this->_hashVar = self::PLUGIN_NAME . '_' . hash('crc32', $encOptions);
    $this->options['data-plugin-' . self::PLUGIN_NAME] = $this->_hashVar;
    $view->registerJs("var {$this->_hashVar} = {$encOptions};", View::POS_HEAD);
}

            
init() public 方法

初始化小部件。

public void init ( )
throws yii\base\InvalidConfigException

如果未設定 "mask" 屬性。

                public function init()
{
    parent::init();
    if (empty($this->mask) && empty($this->clientOptions['alias'])) {
        throw new InvalidConfigException("Either the 'mask' property or the 'clientOptions[\"alias\"]' property must be set.");
    }
}

            
initClientOptions() protected 方法

初始化客戶端選項。

protected void initClientOptions ( )

                protected function initClientOptions()
{
    $options = $this->clientOptions;
    foreach ($options as $key => $value) {
        if (
            !empty($value)
            && !$value instanceof JsExpression
            && in_array($key, $this->_jsCallbacks, true)
        ) {
            $options[$key] = new JsExpression($value);
        }
    }
    $this->clientOptions = $options;
}

            
off() public 方法

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

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

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

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

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

事件處理常式必須使用以下簽名定義,

function ($event)

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

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

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

另請參閱 off()

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

事件名稱

$handler 可呼叫

事件處理常式

$data mixed

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

$append boolean

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

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

            
registerClientScript() public 方法

註冊所需的客戶端腳本和選項。

public void registerClientScript ( )

                public function registerClientScript()
{
    $js = '';
    $view = $this->getView();
    $this->initClientOptions();
    if (!empty($this->mask)) {
        $this->clientOptions['mask'] = $this->mask;
    }
    $this->hashPluginOptions($view);
    if (!empty($this->definitions) && is_array($this->definitions)) {
        $js .= ucfirst(self::PLUGIN_NAME) . '.extendDefinitions(' . Json::htmlEncode($this->definitions) . ');';
    }
    if (!empty($this->aliases) && is_array($this->aliases)) {
        $js .= ucfirst(self::PLUGIN_NAME) . '.extendAliases(' . Json::htmlEncode($this->aliases) . ');';
    }
    $id = $this->options['id'];
    $js .= 'jQuery("#' . $id . '").' . self::PLUGIN_NAME . '(' . $this->_hashVar . ');';
    MaskedInputAsset::register($view);
    $view->registerJs($js);
}

            
render() public 方法

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

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

            
renderInputHtml() protected 方法 (自 2.0.13 版本起提供)

定義於: yii\widgets\InputWidget::renderInputHtml()

渲染一個 HTML 輸入標籤。

如果輸入小工具 繫結到模型,則會呼叫 yii\helpers\Html::activeInput(),否則會呼叫 yii\helpers\Html::input()

另請參閱

protected string renderInputHtml ( $type )
$type string

要建立的輸入類型。

return string

輸入欄位的 HTML。

                protected function renderInputHtml($type)
{
    if ($this->hasModel()) {
        return Html::activeInput($type, $this->model, $this->attribute, $this->options);
    }
    return Html::input($type, $this->name, $this->value, $this->options);
}

            
run() public 方法

執行小部件。

public string|void run ( )
return string|void

呈現結果可以直接 'echo' 輸出或作為字串傳回

                public function run()
{
    $this->registerClientScript();
    echo $this->renderInputHtml($this->type);
}

            
setId() public 方法

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

設定小部件的 ID。

public void setId ( $value )
$value string

Widget 的 ID。

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

            
setView() public 方法

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

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

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

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

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

            
trigger() public 方法

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

            
widget() public 靜態方法

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