0 追蹤者 (follower)

類別 yii\console\Controller (Class yii\console\Controller)

繼承 (Inheritance)yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject
實作 (Implements)yii\base\Configurable, yii\base\ViewContextInterface
子類別 (Subclasses)yii\console\controllers\AssetController, yii\console\controllers\BaseMigrateController, yii\console\controllers\CacheController, yii\console\controllers\FixtureController, yii\console\controllers\HelpController, yii\console\controllers\MessageController, yii\console\controllers\MigrateController, yii\console\controllers\ServeController
自版本起可用 (Available since version)2.0
原始碼 (Source Code) https://github.com/yiisoft/yii2/blob/master/framework/console/Controller.php

Controller 是控制台命令類別的基底類別。(Controller is the base class of console command classes.)

一個控制台控制器 (console controller) 由一個或多個被稱為子命令 (sub-commands) 的動作 (actions) 組成。使用者透過指定對應於控制器動作的路由 (route) 來調用控制台命令。當調用控制台命令時,會使用 yii 程式,如下所示 (Users call a console command by specifying the corresponding route which identifies a controller action. The yii program is used when calling a console command, like the following)

yii <route> [--param1=value1 --param2 ...]

其中 <route> 是控制器動作的路由,參數將會填充為命令的屬性。請參閱 options() 以了解詳細資訊。(where <route> is a route to a controller action and the params will be populated as properties of a command. See options() for details.)

公開屬性 (Public Properties)

隱藏繼承的屬性 (Hide inherited properties)

屬性 (Property) 類型 (Type) 描述 (Description) 定義於 (Defined By)
$action yii\base\Action|null 目前正在執行的動作。(The action that is currently being executed.) yii\base\Controller
$behaviors yii\base\Behavior[] 附加到此組件的行為列表。(List of behaviors attached to this component.) yii\base\Component
$color boolean|null 是否在輸出中啟用 ANSI 彩色。(Whether to enable ANSI color in the output.) yii\console\Controller
$defaultAction string 當請求中未指定動作 ID 時,所使用的動作 ID。(The ID of the action that is used when the action ID is not specified in the request.) yii\base\Controller
$help boolean 是否顯示關於目前命令的幫助資訊。(Whether to display help information about current command.) yii\console\Controller
$helpSummary string yii\console\Controller
$id string 此控制器的 ID。(The ID of this controller.) yii\base\Controller
$interactive boolean 是否以互動方式執行命令。(Whether to run the command interactively.) yii\console\Controller
$layout string|null|false 要應用於此控制器視圖的佈局名稱。(The name of the layout to be applied to this controller's views.) yii\base\Controller
$module yii\base\Module 此控制器所屬的模組。(The module that this controller belongs to.) yii\base\Controller
$modules yii\base\Module[] 此控制器所在的所有的祖先模組。(All ancestor modules that this controller is located within.) yii\base\Controller
$passedOptionValues array 對應於傳遞選項的屬性。(The properties corresponding to the passed options.) yii\console\Controller
$passedOptions array 執行期間傳遞的選項名稱。(The names of the options passed during execution.) yii\console\Controller
$request yii\base\Request|array|string 請求。(The request.) yii\base\Controller
$response yii\base\Response|array|string 回應。(The response.) yii\base\Controller
$route string 當前請求的路由 (模組 ID、控制器 ID 和動作 ID)。(The route (module ID, controller ID and action ID) of the current request.) yii\base\Controller
$silentExitOnException boolean|null 如果為 true - 腳本在發生異常時以 ExitCode::OK 結束。(If true - script finish with ExitCode::OK in case of exception.) yii\console\Controller
$uniqueId string 以模組 ID (如果有的話) 為前綴的控制器 ID。(The controller ID that is prefixed with the module ID (if any).) yii\base\Controller
$view yii\base\View|yii\web\View 可用於呈現視圖或視圖檔案的視圖物件。(The view object that can be used to render views or view files.) yii\base\Controller
$viewPath string 此控制器視圖檔案所在的目錄。 yii\base\Controller

公共方法

隱藏繼承方法

方法 描述 (Description) 定義於 (Defined By)
__call() 呼叫未定義為類別方法的具名方法。 yii\base\Component
__clone() 在透過複製現有物件建立新物件後,會呼叫此方法。 yii\base\Component
__construct() yii\base\Controller
__get() 傳回組件屬性的值。 yii\base\Component
__isset() 檢查屬性是否已設定,即已定義且非 null。 yii\base\Component
__set() 設定組件屬性的值。 yii\base\Component
__unset() 將組件屬性設定為 null。 yii\base\Component
actions() 宣告控制器的外部動作。 yii\base\Controller
afterAction() 此方法會在動作執行完成後立即調用。 yii\base\Controller
ansiFormat() 使用 ANSI 代碼格式化字串。 yii\console\Controller
attachBehavior() 將行為附加到此組件。 yii\base\Component
attachBehaviors() 將行為清單附加到此組件。 yii\base\Component
beforeAction() 此方法會在動作執行前立即調用。 yii\console\Controller
behaviors() 傳回此組件應表現為的行為清單。 yii\base\Component
bindActionParams() 將參數繫結到動作。 yii\console\Controller
canGetProperty() 傳回一個值,指示屬性是否可讀取。 yii\base\Component
canSetProperty() 傳回一個值,指示屬性是否可設定。 yii\base\Component
className() 傳回此類別的完整限定名稱。 yii\base\BaseObject
confirm() 要求使用者輸入 y 或 n 以進行確認。 yii\console\Controller
createAction() 根據給定的動作 ID 建立動作。 yii\base\Controller
detachBehavior() 從組件分離行為。 yii\base\Component
detachBehaviors() 從組件分離所有行為。 yii\base\Component
ensureBehaviors() 確保在 behaviors() 中宣告的行為已附加到此組件。 yii\base\Component
findLayoutFile() 尋找適用的版面配置檔案。 yii\base\Controller
getActionArgsHelp() 傳回動作匿名引數的說明資訊。 yii\console\Controller
getActionHelp() 傳回指定動作的詳細說明資訊。 yii\console\Controller
getActionHelpSummary() 傳回描述指定動作的單行簡短摘要。 yii\console\Controller
getActionOptionsHelp() 傳回動作選項的說明資訊。 yii\console\Controller
getBehavior() 傳回具名行為物件。 yii\base\Component
getBehaviors() 傳回附加到此組件的所有行為。 yii\base\Component
getHelp() 傳回此控制器的說明資訊。 yii\console\Controller
getHelpSummary() 傳回描述此控制器的單行簡短摘要。 yii\console\Controller
getModules() 傳回此控制器的所有祖先模組。 yii\base\Controller
getOptionValues() 傳回對應於動作 ID 選項的屬性。子類別可以覆寫此方法以指定可能的屬性。 yii\console\Controller
getPassedOptionValues() 傳回對應於已傳遞選項的屬性。 yii\console\Controller
getPassedOptions() 傳回執行期間傳遞的有效選項名稱。 yii\console\Controller
getRoute() 傳回當前請求的路徑。 yii\base\Controller
getUniqueId() 傳回控制器的唯一 ID。 yii\base\Controller
getView() 傳回可用於呈現視圖或視圖檔案的視圖物件。 yii\base\Controller
getViewPath() 傳回此控制器視圖檔案所在的目錄。 yii\base\Controller
hasEventHandlers() 傳回一個值,指示是否有名稱事件附加任何處理常式。 yii\base\Component
hasMethod() 傳回一個值,指示是否已定義方法。 yii\base\Component
hasProperty() 傳回一個值,指示是否已為此組件定義屬性。 yii\base\Component
init() 初始化物件。 yii\base\Controller
isColorEnabled() 傳回一個值,指示是否啟用 ANSI 顏色。 yii\console\Controller
off() 從此組件分離現有的事件處理常式。 yii\base\Component
on() 將事件處理常式附加到事件。 yii\base\Component
optionAliases() 傳回選項別名。 yii\console\Controller
options() 傳回動作 (id) 有效選項的名稱。選項需要存在一個公共成員變數,其名稱為選項名稱。 yii\console\Controller
prompt() 提示使用者輸入並驗證輸入。 yii\console\Controller
render() 呈現視圖並在可用時套用版面配置。 yii\base\Controller
renderContent() 透過套用版面配置來呈現靜態字串。 yii\base\Controller
renderFile() 呈現視圖檔案。 yii\base\Controller
renderPartial() 呈現視圖,但不套用版面配置。 yii\base\Controller
run() 執行依路徑指定的請求。 yii\base\Controller
runAction() 使用指定的動作 ID 和參數執行動作。 yii\console\Controller
select() 讓使用者選擇一個選項。輸入 '?' 將顯示選項清單及其說明。 yii\console\Controller
setView() 設定此控制器要使用的視圖物件。 yii\base\Controller
setViewPath() 設定包含視圖檔案的目錄。 yii\base\Controller
stderr() 將字串列印到 STDERR。 yii\console\Controller
stdout() 將字串列印到 STDOUT。 yii\console\Controller
trigger() 觸發事件。 yii\base\Component

受保護的方法

隱藏繼承方法

方法 描述 (Description) 定義於 (Defined By)
bindInjectedParams() 根據動作方法簽章中的類型和名稱填寫參數。 yii\base\Controller
getActionMethodReflection() yii\console\Controller
parseDocCommentDetail() 從 docblock 傳回完整描述。 yii\console\Controller
parseDocCommentSummary() 傳回 docblock 的第一行。 yii\console\Controller
parseDocCommentTags() 將註解區塊剖析為標籤。 yii\console\Controller

事件

隱藏繼承事件

事件 類型 (Type) 描述 (Description) 定義於 (Defined By)
EVENT_AFTER_ACTION yii\base\ActionEvent 在執行控制器動作後立即引發的事件。 yii\base\Controller
EVENT_BEFORE_ACTION yii\base\ActionEvent 在執行控制器動作前立即引發的事件。 yii\base\Controller

常數

隱藏繼承常數

常數 描述 (Description) 定義於 (Defined By)
EXIT_CODE_ERROR 1 自 2.0.13 版本起已棄用。請改用 yii\console\ExitCode::UNSPECIFIED_ERROR yii\console\Controller
EXIT_CODE_NORMAL 0 自 2.0.13 版本起已棄用。請改用 yii\console\ExitCode::OK yii\console\Controller

屬性詳細資訊

隱藏繼承的屬性 (Hide inherited properties)

$color 公共屬性

是否在輸出中啟用 ANSI 顏色。如果未設定,ANSI 顏色僅會針對支援它的終端機啟用。

public boolean|null $color null
$help 公共屬性 (自 2.0.10 版本起可用)

是否顯示關於目前命令的幫助資訊。(Whether to display help information about current command.)

public boolean $help false
$helpSummary 公共屬性
public string $helpSummary null
$interactive 公共屬性

是否以互動方式執行命令。(Whether to run the command interactively.)

public boolean $interactive true
$passedOptionValues 公共屬性

對應於傳遞選項的屬性。(The properties corresponding to the passed options.)

public array $passedOptionValues null
$passedOptions 公共屬性

執行期間傳遞的選項名稱。(The names of the options passed during execution.)

public array $passedOptions null
$silentExitOnException 公共屬性 (自 2.0.36 版本起可用)

如果為 true - 腳本在發生例外情況時以 ExitCode::OK 結束。 false - ExitCode::UNSPECIFIED_ERROR。預設值:YII_ENV_TEST

方法詳細資訊

隱藏繼承方法

__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() 公共方法
public void __construct ( $id, $module, $config = [] )
$id string

此控制器的 ID。(The ID of this controller.)

$module yii\base\Module

此控制器所屬的模組。(The module that this controller belongs to.)

$config array

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

                public function __construct($id, $module, $config = [])
{
    $this->id = $id;
    $this->module = $module;
    parent::__construct($config);
}

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

            
actions() 公共方法

定義於: yii\base\Controller::actions()

宣告控制器的外部動作。

此方法旨在被覆寫以宣告控制器的外部動作。它應傳回一個陣列,其中陣列鍵為動作 ID,而陣列值為對應的動作類別名稱或動作組態陣列。例如:

return [
    'action1' => 'app\components\Action1',
    'action2' => [
        'class' => 'app\components\Action2',
        'property1' => 'value1',
        'property2' => 'value2',
    ],
];

Yii::createObject() 將在稍後用於使用此處提供的組態建立請求的動作。

public array actions ( )

                public function actions()
{
    return [];
}

            
afterAction() 公共方法

定義於: yii\base\Controller::afterAction()

此方法會在動作執行完成後立即調用。

此方法將觸發 EVENT_AFTER_ACTION 事件。方法的傳回值將用作動作傳回值。

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

public function afterAction($action, $result)
{
    $result = parent::afterAction($action, $result);
    // your custom code here
    return $result;
}
public mixed afterAction ( $action, $result )
$action yii\base\Action

剛執行的動作。

$result mixed

動作傳回結果。

return mixed

已處理的動作結果。

                public function afterAction($action, $result)
{
    $event = new ActionEvent($action);
    $event->result = $result;
    $this->trigger(self::EVENT_AFTER_ACTION, $event);
    return $event->result;
}

            
ansiFormat() 公共方法

使用 ANSI 代碼格式化字串。

您可以使用 yii\helpers\Console 中定義的常數傳遞其他參數。

範例

echo $this->ansiFormat('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);
public string ansiFormat ( $string )
$string string

要格式化的字串

                public function ansiFormat($string)
{
    if ($this->isColorEnabled()) {
        $args = func_get_args();
        array_shift($args);
        $string = Console::ansiFormat($string, $args);
    }
    return $string;
}

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

            
beforeAction() 公共方法

此方法會在動作執行前立即調用。

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

如果動作不應執行,則應在 beforeAction 程式碼中處理請求,方法是提供必要的輸出或重新導向請求。否則,回應將為空。

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

public function beforeAction($action)
{
    // your custom code here, if you want the code to run before action filters,
    // which are triggered on the [[EVENT_BEFORE_ACTION]] event, e.g. PageCache or AccessControl

    if (!parent::beforeAction($action)) {
        return false;
    }

    // other custom code here

    return true; // or false to not run the action
}
public boolean beforeAction ( $action )
$action yii\base\Action

要執行的動作。

return boolean

動作是否應繼續執行。

                public function beforeAction($action)
{
    $silentExit = $this->silentExitOnException !== null ? $this->silentExitOnException : YII_ENV_TEST;
    Yii::$app->errorHandler->silentExitOnException = $silentExit;
    return parent::beforeAction($action);
}

            
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 [];
}

            
bindActionParams() 公共方法

將參數繫結到動作。

yii\base\Action 開始使用給定的參數執行時,會調用此方法。此方法將首先將參數與動作可用的 options 繫結。然後,它會驗證給定的引數。

public array bindActionParams ( $action, $params )
$action yii\base\Action

要與參數繫結的動作

$params array

要繫結到動作的參數

return array

動作可以執行的有效參數。

throws yii\console\Exception

如果存在未知選項或遺失引數

                public function bindActionParams($action, $params)
{
    if ($action instanceof InlineAction) {
        $method = new \ReflectionMethod($this, $action->actionMethod);
    } else {
        $method = new \ReflectionMethod($action, 'run');
    }
    $args = [];
    $missing = [];
    $actionParams = [];
    $requestedParams = [];
    foreach ($method->getParameters() as $i => $param) {
        $name = $param->getName();
        $key = null;
        if (array_key_exists($i, $params)) {
            $key = $i;
        } elseif (array_key_exists($name, $params)) {
            $key = $name;
        }
        if ($key !== null) {
            if (PHP_VERSION_ID >= 80000) {
                $isArray = ($type = $param->getType()) instanceof \ReflectionNamedType && $type->getName() === 'array';
            } else {
                $isArray = $param->isArray();
            }
            if ($isArray) {
                $params[$key] = $params[$key] === '' ? [] : preg_split('/\s*,\s*/', $params[$key]);
            }
            $args[] = $actionParams[$key] = $params[$key];
            unset($params[$key]);
        } elseif (
            PHP_VERSION_ID >= 70100
            && ($type = $param->getType()) !== null
            && $type instanceof \ReflectionNamedType
            && !$type->isBuiltin()
        ) {
            try {
                $this->bindInjectedParams($type, $name, $args, $requestedParams);
            } catch (\yii\base\Exception $e) {
                throw new Exception($e->getMessage());
            }
        } elseif ($param->isDefaultValueAvailable()) {
            $args[] = $actionParams[$i] = $param->getDefaultValue();
        } else {
            $missing[] = $name;
        }
    }
    if (!empty($missing)) {
        throw new Exception(Yii::t('yii', 'Missing required arguments: {params}', ['params' => implode(', ', $missing)]));
    }
    // We use a different array here, specifically one that doesn't contain service instances but descriptions instead.
    if (\Yii::$app->requestedParams === null) {
        \Yii::$app->requestedParams = array_merge($actionParams, $requestedParams);
    }
    return array_merge($args, $params);
}

            
bindInjectedParams() 受保護的方法 (自 2.0.36 版本起可用)

定義於: yii\base\Controller::bindInjectedParams()

根據動作方法簽章中的類型和名稱填寫參數。

protected void bindInjectedParams ( ReflectionType $type, $name, &$args, &$requestedParams )
$type ReflectionType

動作參數的反射類型。

$name string

參數的名稱。

$args array

動作的引數陣列,此函數可能會將項目附加到其中。

$requestedParams array

具有請求參數的陣列,此函數可能會將特定索引鍵寫入其中。

throws yii\base\ErrorException

當我們無法載入必要的服務時。

throws yii\base\InvalidConfigException

當 DI 組態中存在錯誤時拋出。

throws yii\di\NotInstantiableException

當定義無法解析為具體類別(例如介面類型提示)而容器中沒有正確的定義時拋出。

                final protected function bindInjectedParams(\ReflectionType $type, $name, &$args, &$requestedParams)
{
    // Since it is not a builtin type it must be DI injection.
    $typeName = $type->getName();
    if (($component = $this->module->get($name, false)) instanceof $typeName) {
        $args[] = $component;
        $requestedParams[$name] = 'Component: ' . get_class($component) . " \$$name";
    } elseif ($this->module->has($typeName) && ($service = $this->module->get($typeName)) instanceof $typeName) {
        $args[] = $service;
        $requestedParams[$name] = 'Module ' . get_class($this->module) . " DI: $typeName \$$name";
    } elseif (\Yii::$container->has($typeName) && ($service = \Yii::$container->get($typeName)) instanceof $typeName) {
        $args[] = $service;
        $requestedParams[$name] = "Container DI: $typeName \$$name";
    } elseif ($type->allowsNull()) {
        $args[] = null;
        $requestedParams[$name] = "Unavailable service: $name";
    } else {
        throw new Exception('Could not load required service: ' . $name);
    }
}

            
canGetProperty() public 方法

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

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

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

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

另請參閱 canSetProperty()

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

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

return boolean

屬性是否可以被讀取

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

            
canSetProperty() public 方法

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

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

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

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

另請參閱 canGetProperty()

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

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

return boolean

屬性是否可以被寫入

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

            
className() public static 方法
自 2.0.14 版本起已過時。在 PHP >=5.5 版本,請改用 ::class

定義於: yii\base\BaseObject::className()

傳回此類別的完整限定名稱。

public static string className ( )
return string

此類別的完整限定名稱。

                public static function className()
{
    return get_called_class();
}

            
confirm() public 方法

要求使用者輸入 y 或 n 以進行確認。

典型的用法如下所示

if ($this->confirm("Are you sure?")) {
    echo "user typed yes\n";
} else {
    echo "user typed no\n";
}
public boolean confirm ( $message, $default false )
$message string

等待使用者輸入前要輸出的訊息

$default boolean

如果未進行選擇,則返回此值。

return boolean

使用者是否已確認。如果 $interactive 為 false,將返回 true。

                public function confirm($message, $default = false)
{
    if ($this->interactive) {
        return Console::confirm($message, $default);
    }
    return true;
}

            
createAction() public 方法

定義於: yii\base\Controller::createAction()

根據給定的動作 ID 建立動作。

此方法首先檢查 action ID 是否已在 actions() 中宣告。如果是,它將使用那裡宣告的配置來建立 action 物件。如果否,它將尋找控制器方法,其名稱格式為 actionXyz,其中 xyz 是 action ID。如果找到,將建立並返回代表該方法的 yii\base\InlineAction

public yii\base\Action|null createAction ( $id )
$id string

Action ID。

return yii\base\Action|null

新建立的 action 實例。如果 ID 無法解析為任何 action,則為 Null。

                public function createAction($id)
{
    if ($id === '') {
        $id = $this->defaultAction;
    }
    $actionMap = $this->actions();
    if (isset($actionMap[$id])) {
        return Yii::createObject($actionMap[$id], [$id, $this]);
    }
    if (preg_match('/^(?:[a-z0-9_]+-)*[a-z0-9_]+$/', $id)) {
        $methodName = 'action' . str_replace(' ', '', ucwords(str_replace('-', ' ', $id)));
        if (method_exists($this, $methodName)) {
            $method = new \ReflectionMethod($this, $methodName);
            if ($method->isPublic() && $method->getName() === $methodName) {
                return new InlineAction($id, $this, $methodName);
            }
        }
    }
    return null;
}

            
detachBehavior() public 方法

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

從組件分離行為。

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

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

行為的名稱。

return yii\base\Behavior|null

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

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

            
detachBehaviors() public 方法

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

從組件分離所有行為。

public void detachBehaviors ( )

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

            
ensureBehaviors() public 方法

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

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

public void ensureBehaviors ( )

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

            
findLayoutFile() public 方法

定義於: yii\base\Controller::findLayoutFile()

尋找適用的版面配置檔案。

public string|boolean findLayoutFile ( $view )
$view yii\base\View

用於渲染版面配置檔案的視圖物件。

return string|boolean

版面配置檔案路徑,如果不需要版面配置,則為 false。請參閱 render() 以了解如何指定此參數。

throws yii\base\InvalidArgumentException

如果使用了無效的路徑別名來指定版面配置。

                public function findLayoutFile($view)
{
    $module = $this->module;
    $layout = null;
    if (is_string($this->layout)) {
        $layout = $this->layout;
    } elseif ($this->layout === null) {
        while ($module !== null && $module->layout === null) {
            $module = $module->module;
        }
        if ($module !== null && is_string($module->layout)) {
            $layout = $module->layout;
        }
    }
    if ($layout === null) {
        return false;
    }
    if (strncmp($layout, '@', 1) === 0) {
        $file = Yii::getAlias($layout);
    } elseif (strncmp($layout, '/', 1) === 0) {
        $file = Yii::$app->getLayoutPath() . DIRECTORY_SEPARATOR . substr($layout, 1);
    } else {
        $file = $module->getLayoutPath() . DIRECTORY_SEPARATOR . $layout;
    }
    if (pathinfo($file, PATHINFO_EXTENSION) !== '') {
        return $file;
    }
    $path = $file . '.' . $view->defaultExtension;
    if ($view->defaultExtension !== 'php' && !is_file($path)) {
        $path = $file . '.php';
    }
    return $path;
}

            
getActionArgsHelp() public 方法

傳回動作匿名引數的說明資訊。

返回值應為陣列。鍵是參數名稱,值是相應的幫助資訊。每個值都必須是以下結構的陣列

  • required: bool,此參數是否為必填項
  • type: string|null,此參數的 PHP 類型
  • default: mixed,此參數的預設值
  • comment: string,此參數的描述

預設實作將返回從與 action 方法相對應的參數的 Reflection 或 DocBlock 中提取的幫助資訊。

public array getActionArgsHelp ( $action )
$action yii\base\Action

Action 實例

return array

Action 參數的幫助資訊

                public function getActionArgsHelp($action)
{
    $method = $this->getActionMethodReflection($action);
    $tags = $this->parseDocCommentTags($method);
    $tags['param'] = isset($tags['param']) ? (array) $tags['param'] : [];
    $phpDocParams = [];
    foreach ($tags['param'] as $i => $tag) {
        if (preg_match('/^(?<type>\S+)(\s+\$(?<name>\w+))?(?<comment>.*)/us', $tag, $matches) === 1) {
            $key = empty($matches['name']) ? $i : $matches['name'];
            $phpDocParams[$key] = ['type' => $matches['type'], 'comment' => $matches['comment']];
        }
    }
    unset($tags);
    $args = [];
    /** @var \ReflectionParameter $parameter */
    foreach ($method->getParameters() as $i => $parameter) {
        $type = null;
        $comment = '';
        if (PHP_MAJOR_VERSION > 5 && $parameter->hasType()) {
            $reflectionType = $parameter->getType();
            if (PHP_VERSION_ID >= 70100) {
                $types = method_exists($reflectionType, 'getTypes') ? $reflectionType->getTypes() : [$reflectionType];
                foreach ($types as $key => $reflectionType) {
                    $types[$key] = $reflectionType->getName();
                }
                $type = implode('|', $types);
            } else {
                $type = (string) $reflectionType;
            }
        }
        // find PhpDoc tag by property name or position
        $key = isset($phpDocParams[$parameter->name]) ? $parameter->name : (isset($phpDocParams[$i]) ? $i : null);
        if ($key !== null) {
            $comment = $phpDocParams[$key]['comment'];
            if ($type === null && !empty($phpDocParams[$key]['type'])) {
                $type = $phpDocParams[$key]['type'];
            }
        }
        // if type still not detected, then using type of default value
        if ($type === null && $parameter->isDefaultValueAvailable() && $parameter->getDefaultValue() !== null) {
            $type = gettype($parameter->getDefaultValue());
        }
        $args[$parameter->name] = [
            'required' => !$parameter->isOptional(),
            'type' => $type,
            'default' => $parameter->isDefaultValueAvailable() ? $parameter->getDefaultValue() : null,
            'comment' => $comment,
        ];
    }
    return $args;
}

            
getActionHelp() public 方法

傳回指定動作的詳細說明資訊。

public string getActionHelp ( $action )
$action yii\base\Action

要取得幫助的 Action

return string

指定 action 的詳細幫助資訊。

                public function getActionHelp($action)
{
    return $this->parseDocCommentDetail($this->getActionMethodReflection($action));
}

            
getActionHelpSummary() public 方法

傳回描述指定動作的單行簡短摘要。

public string getActionHelpSummary ( $action )
$action yii\base\Action

要取得摘要的 Action

return string

描述指定 action 的單行簡短摘要。

                public function getActionHelpSummary($action)
{
    if ($action === null) {
        return $this->ansiFormat(Yii::t('yii', 'Action not found.'), Console::FG_RED);
    }
    return $this->parseDocCommentSummary($this->getActionMethodReflection($action));
}

            
getActionMethodReflection() protected 方法

protected ReflectionFunctionAbstract getActionMethodReflection ( $action )
$action yii\base\Action

                protected function getActionMethodReflection($action)
{
    if (!isset($this->_reflections[$action->id])) {
        if ($action instanceof InlineAction) {
            $this->_reflections[$action->id] = new \ReflectionMethod($this, $action->actionMethod);
        } else {
            $this->_reflections[$action->id] = new \ReflectionMethod($action, 'run');
        }
    }
    return $this->_reflections[$action->id];
}

            
getActionOptionsHelp() public 方法

傳回動作選項的說明資訊。

返回值應為陣列。鍵是選項名稱,值是相應的幫助資訊。每個值都必須是以下結構的陣列

  • type: string,此參數的 PHP 類型。
  • default: string,此參數的預設值
  • comment: string,此參數的註解

預設實作將返回從與 action 選項相對應的屬性的 doc-comment 中提取的幫助資訊。

public array getActionOptionsHelp ( $action )
$action yii\base\Action
return array

Action 選項的幫助資訊

                public function getActionOptionsHelp($action)
{
    $optionNames = $this->options($action->id);
    if (empty($optionNames)) {
        return [];
    }
    $class = new \ReflectionClass($this);
    $options = [];
    foreach ($class->getProperties() as $property) {
        $name = $property->getName();
        if (!in_array($name, $optionNames, true)) {
            continue;
        }
        $defaultValue = $property->getValue($this);
        $tags = $this->parseDocCommentTags($property);
        // Display camelCase options in kebab-case
        $name = Inflector::camel2id($name, '-', true);
        if (isset($tags['var']) || isset($tags['property'])) {
            $doc = isset($tags['var']) ? $tags['var'] : $tags['property'];
            if (is_array($doc)) {
                $doc = reset($doc);
            }
            if (preg_match('/^(\S+)(.*)/s', $doc, $matches)) {
                $type = $matches[1];
                $comment = $matches[2];
            } else {
                $type = null;
                $comment = $doc;
            }
            $options[$name] = [
                'type' => $type,
                'default' => $defaultValue,
                'comment' => $comment,
            ];
        } else {
            $options[$name] = [
                'type' => null,
                'default' => $defaultValue,
                'comment' => '',
            ];
        }
    }
    return $options;
}

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

            
getHelp() public 方法

傳回此控制器的說明資訊。

您可以覆寫此方法以返回自訂的幫助資訊。預設實作返回從 PHPDoc 註解中檢索的幫助資訊。

public string getHelp ( )

                public function getHelp()
{
    return $this->parseDocCommentDetail(new \ReflectionClass($this));
}

            
getHelpSummary() public 方法

傳回描述此控制器的單行簡短摘要。

您可以覆寫此方法以返回自訂的摘要。預設實作返回 PHPDoc 註解的第一行。

public string getHelpSummary ( )

                public function getHelpSummary()
{
    return $this->parseDocCommentSummary(new \ReflectionClass($this));
}

            
getModules() public 方法

定義於: yii\base\Controller::getModules()

傳回此控制器的所有祖先模組。

陣列中的第一個模組是最外層的模組(即應用程式實例),而最後一個是最內層的模組。

public yii\base\Module[] getModules ( )
return yii\base\Module[]

此控制器所在的所有的祖先模組。(All ancestor modules that this controller is located within.)

                public function getModules()
{
    $modules = [$this->module];
    $module = $this->module;
    while ($module->module !== null) {
        array_unshift($modules, $module->module);
        $module = $module->module;
    }
    return $modules;
}

            
getOptionValues() public 方法

傳回對應於動作 ID 選項的屬性。子類別可以覆寫此方法以指定可能的屬性。

public array getOptionValues ( $actionID )
$actionID string

當前請求的 action id

return array

與 action 選項相對應的屬性

                public function getOptionValues($actionID)
{
    // $actionId might be used in subclasses to provide properties specific to action id
    $properties = [];
    foreach ($this->options($this->action->id) as $property) {
        $properties[$property] = $this->$property;
    }
    return $properties;
}

            
getPassedOptionValues() public 方法

傳回對應於已傳遞選項的屬性。

public array getPassedOptionValues ( )
return array

與傳遞的選項相對應的屬性

                public function getPassedOptionValues()
{
    $properties = [];
    foreach ($this->_passedOptions as $property) {
        $properties[$property] = $this->$property;
    }
    return $properties;
}

            
getPassedOptions() public 方法

傳回執行期間傳遞的有效選項名稱。

public array getPassedOptions ( )
return array

執行期間傳遞的選項名稱

                public function getPassedOptions()
{
    return $this->_passedOptions;
}

            
getRoute() public 方法

定義於: yii\base\Controller::getRoute()

傳回當前請求的路徑。

public string getRoute ( )
return string

當前請求的路由 (模組 ID、控制器 ID 和動作 ID)。(The route (module ID, controller ID and action ID) of the current request.)

                public function getRoute()
{
    return $this->action !== null ? $this->action->getUniqueId() : $this->getUniqueId();
}

            
getUniqueId() public 方法

定義於: yii\base\Controller::getUniqueId()

傳回控制器的唯一 ID。

public string getUniqueId ( )
return string

以模組 ID (如果有的話) 為前綴的控制器 ID。(The controller ID that is prefixed with the module ID (if any).)

                public function getUniqueId()
{
    return $this->module instanceof Application ? $this->id : $this->module->getUniqueId() . '/' . $this->id;
}

            
getView() public 方法

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

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

render()renderPartial()renderFile() 方法將使用此視圖物件來實作實際的視圖渲染。如果未設定,它將預設為 “view” 應用程式組件。

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

可用於呈現視圖或視圖檔案的視圖物件。(The view object that can be used to render views or view files.)

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

            
getViewPath() public 方法

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

傳回此控制器視圖檔案所在的目錄。

預設實作返回以控制器 $id 命名的目錄,該目錄位於 $module$viewPath 目錄下。

public string getViewPath ( )
return string

此控制器視圖檔案所在的目錄。

                public function getViewPath()
{
    if ($this->_viewPath === null) {
        $this->_viewPath = $this->module->getViewPath() . DIRECTORY_SEPARATOR . $this->id;
    }
    return $this->_viewPath;
}

            
hasEventHandlers() public 方法

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

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

public boolean hasEventHandlers ( $name )
$name string

事件名稱

return boolean

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

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

            
hasMethod() public 方法

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

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

如果符合以下條件,則定義了方法:

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

屬性名稱

$checkBehaviors boolean

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

return boolean

方法是否已定義

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

            
hasProperty() public 方法

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

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

如果符合以下條件,則定義了屬性:

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

另請參閱

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

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

return boolean

屬性是否已定義

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

            
init() public 方法 (自版本 2.0.36 起可用)

定義於: yii\base\Controller::init()

初始化物件。

在物件使用給定的配置初始化後,此方法會在建構子的末尾被調用。

public void init ( )

                public function init()
{
    parent::init();
    $this->request = Instance::ensure($this->request, Request::className());
    $this->response = Instance::ensure($this->response, Response::className());
}

            
isColorEnabled() public method

傳回一個值,指示是否啟用 ANSI 顏色。

ANSI 色彩僅在 $color 設定為 true,或未設定且終端機支援 ANSI 色彩時啟用。

public boolean isColorEnabled ( $stream = \STDOUT )
$stream resource

要檢查的串流。

return boolean

是否在輸出中啟用 ANSI 樣式。

                public function isColorEnabled($stream = \STDOUT)
{
    return $this->color === null ? Console::streamSupportsAnsiColors($stream) : $this->color;
}

            
off() public method

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

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

此方法與 on() 相反。

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

另請參閱 on()

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

事件名稱

$handler callable|null

要移除的事件處理常式。如果為 null,則會移除附加到指定名稱事件的所有處理常式。

return boolean

如果找到並分離處理常式

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

            
on() public method

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

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

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

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

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

function ($event)

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

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

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

另請參閱 off()

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

事件名稱

$handler callable

事件處理常式

$data mixed

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

$append boolean

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

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

            
optionAliases() public method (available since version 2.0.8)

傳回選項別名。

子類別可以覆寫此方法以指定別名選項。

另請參閱 options()

public array optionAliases ( )
return array

適用於動作的選項別名,其中鍵為選項的別名,值為選項名稱。

                public function optionAliases()
{
    return [
        'h' => 'help',
    ];
}

            
options() public method

傳回動作 (id) 有效選項的名稱。選項需要存在一個公共成員變數,其名稱為選項名稱。

子類別可以覆寫此方法以指定可能的選項。

請注意,透過選項設定的值在調用 beforeAction() 之前不可用。

public string[] options ( $actionID )
$actionID string

當前請求的 action id

return string[]

適用於動作的選項名稱

                public function options($actionID)
{
    // $actionId might be used in subclasses to provide options specific to action id
    return ['color', 'interactive', 'help', 'silentExitOnException'];
}

            
parseDocCommentDetail() protected method

從 docblock 傳回完整描述。

protected string parseDocCommentDetail ( $reflection )
$reflection ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract

                protected function parseDocCommentDetail($reflection)
{
    $comment = strtr(trim(preg_replace('/^\s*\**([ \t])?/m', '', trim($reflection->getDocComment(), '/'))), "\r", '');
    if (preg_match('/^\s*@\w+/m', $comment, $matches, PREG_OFFSET_CAPTURE)) {
        $comment = trim(substr($comment, 0, $matches[0][1]));
    }
    if ($comment !== '') {
        return rtrim(Console::renderColoredString(Console::markdownToAnsi($comment)));
    }
    return '';
}

            
parseDocCommentSummary() protected method

傳回 docblock 的第一行。

protected string parseDocCommentSummary ( $reflection )
$reflection ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract

                protected function parseDocCommentSummary($reflection)
{
    $docLines = preg_split('~\R~u', $reflection->getDocComment());
    if (isset($docLines[1])) {
        return trim($docLines[1], "\t *");
    }
    return '';
}

            
parseDocCommentTags() protected method

將註解區塊剖析為標籤。

protected array parseDocCommentTags ( $reflection )
$reflection ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract

註解區塊

return array

已解析的標籤

                protected function parseDocCommentTags($reflection)
{
    $comment = $reflection->getDocComment();
    $comment = "@description \n" . strtr(trim(preg_replace('/^\s*\**([ \t])?/m', '', trim($comment, '/'))), "\r", '');
    $parts = preg_split('/^\s*@/m', $comment, -1, PREG_SPLIT_NO_EMPTY);
    $tags = [];
    foreach ($parts as $part) {
        if (preg_match('/^(\w+)(.*)/ms', trim($part), $matches)) {
            $name = $matches[1];
            if (!isset($tags[$name])) {
                $tags[$name] = trim($matches[2]);
            } elseif (is_array($tags[$name])) {
                $tags[$name][] = trim($matches[2]);
            } else {
                $tags[$name] = [$tags[$name], trim($matches[2])];
            }
        }
    }
    return $tags;
}

            
prompt() public method

提示使用者輸入並驗證輸入。

public string prompt ( $text, $options = [] )
$text string

提示字串

$options array

驗證輸入的選項

  • required:是否為必填
  • default:使用者未輸入時的預設值
  • pattern:驗證使用者輸入的正規表示式模式
  • validator:用於驗證輸入的可調用函式。該函式必須接受兩個參數
    • $input:要驗證的使用者輸入
    • $error:驗證失敗時,透過引用傳遞的錯誤值。

如何使用帶有驗證器函式的 prompt 方法的範例。

$code = $this->prompt('Enter 4-Chars-Pin', ['required' => true, 'validator' => function($input, &$error) {
    if (strlen($input) !== 4) {
        $error = 'The Pin must be exactly 4 chars!';
        return false;
    }
    return true;
}]);
return string

使用者輸入

                public function prompt($text, $options = [])
{
    if ($this->interactive) {
        return Console::prompt($text, $options);
    }
    return isset($options['default']) ? $options['default'] : '';
}

            
render() public method

定義於: yii\base\Controller::render()

呈現視圖並在可用時套用版面配置。

要呈現的視圖可以使用以下格式之一指定:

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

為了確定應套用哪個佈局,將執行以下兩個步驟:

  1. 在第一步中,它確定佈局名稱和上下文模組:
  • 如果 $layout 指定為字串,則將其用作佈局名稱,並將 $module 作為上下文模組;
  • 如果 $layout 為 null,則搜尋此控制器的所有祖先模組,並找到第一個 layout 不為 null 的模組。佈局和相應的模組分別用作佈局名稱和上下文模組。如果找不到這樣的模組,或相應的佈局不是字串,它將傳回 false,表示沒有適用的佈局。
  1. 在第二步中,它根據先前找到的佈局名稱和上下文模組確定實際的佈局檔案。佈局名稱可以是:
  • 路徑別名 (例如 "@app/views/layouts/main");
  • 絕對路徑 (例如 "/main"):佈局名稱以斜線開頭。實際的佈局檔案將在應用程式的 佈局路徑 下尋找;
  • 相對路徑 (例如 "main"):實際的佈局檔案將在上下文模組的 佈局路徑 下尋找。

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

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

視圖名稱。

$params array

應在視圖中提供的參數(名稱-值對)。這些參數在佈局中不可用。

return string

呈現結果。

throws yii\base\InvalidArgumentException

如果視圖檔案或佈局檔案不存在。

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

            
renderContent() public method (available since version 2.0.1)

定義於: yii\base\Controller::renderContent()

透過套用版面配置來呈現靜態字串。

public string renderContent ( $content )
$content string

要呈現的靜態字串

return string

具有給定靜態字串作為 $content 變數的佈局的呈現結果。如果佈局已停用,則會將字串傳回。

                public function renderContent($content)
{
    $layoutFile = $this->findLayoutFile($this->getView());
    if ($layoutFile !== false) {
        return $this->getView()->renderFile($layoutFile, ['content' => $content], $this);
    }
    return $content;
}

            
renderFile() public method

定義於: yii\base\Controller::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);
}

            
renderPartial() public method

定義於: yii\base\Controller::renderPartial()

呈現視圖,但不套用版面配置。

此方法與 render() 的不同之處在於它不套用任何佈局。

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

視圖名稱。請參閱 render() 了解如何指定視圖名稱。

$params array

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

return string

呈現結果。

throws yii\base\InvalidArgumentException

如果視圖檔案不存在。

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

            
run() public method

定義於: yii\base\Controller::run()

執行依路徑指定的請求。

路由可以是此控制器內動作的 ID,也可以是由模組 ID、控制器 ID 和動作 ID 組成的完整路由。如果路由以斜線 '/' 開頭,則路由的解析將從應用程式開始;否則,它將從此控制器的父模組開始。

另請參閱 runAction()

public mixed run ( $route, $params = [] )
$route string

要處理的路由,例如 'view'、'comment/view'、'/admin/comment/view'。

$params array

要傳遞給動作的參數。

return mixed

動作的結果。

                public function run($route, $params = [])
{
    $pos = strpos($route, '/');
    if ($pos === false) {
        return $this->runAction($route, $params);
    } elseif ($pos > 0) {
        return $this->module->runAction($route, $params);
    }
    return Yii::$app->runAction(ltrim($route, '/'), $params);
}

            
runAction() public method

使用指定的動作 ID 和參數執行動作。

如果動作 ID 為空,則此方法將使用 $defaultAction

另請參閱 createAction()

public integer runAction ( $id, $params = [] )
$id string

要執行的動作的 ID。

$params array

要傳遞給動作的參數(名稱-值對)。

return integer

動作執行的狀態。0 表示正常,其他值表示異常。

throws yii\base\InvalidRouteException

如果請求的動作 ID 無法成功解析為動作。

throws yii\console\Exception

如果存在未知選項或遺失引數

                public function runAction($id, $params = [])
{
    if (!empty($params)) {
        // populate options here so that they are available in beforeAction().
        $options = $this->options($id === '' ? $this->defaultAction : $id);
        if (isset($params['_aliases'])) {
            $optionAliases = $this->optionAliases();
            foreach ($params['_aliases'] as $name => $value) {
                if (array_key_exists($name, $optionAliases)) {
                    $params[$optionAliases[$name]] = $value;
                } else {
                    $message = Yii::t('yii', 'Unknown alias: -{name}', ['name' => $name]);
                    if (!empty($optionAliases)) {
                        $aliasesAvailable = [];
                        foreach ($optionAliases as $alias => $option) {
                            $aliasesAvailable[] = '-' . $alias . ' (--' . $option . ')';
                        }
                        $message .= '. ' . Yii::t('yii', 'Aliases available: {aliases}', [
                            'aliases' => implode(', ', $aliasesAvailable)
                        ]);
                    }
                    throw new Exception($message);
                }
            }
            unset($params['_aliases']);
        }
        foreach ($params as $name => $value) {
            // Allow camelCase options to be entered in kebab-case
            if (!in_array($name, $options, true) && strpos($name, '-') !== false) {
                $kebabName = $name;
                $altName = lcfirst(Inflector::id2camel($kebabName));
                if (in_array($altName, $options, true)) {
                    $name = $altName;
                }
            }
            if (in_array($name, $options, true)) {
                $default = $this->$name;
                if (is_array($default) && is_string($value)) {
                    $this->$name = preg_split('/\s*,\s*(?![^()]*\))/', $value);
                } elseif ($default !== null) {
                    settype($value, gettype($default));
                    $this->$name = $value;
                } else {
                    $this->$name = $value;
                }
                $this->_passedOptions[] = $name;
                unset($params[$name]);
                if (isset($kebabName)) {
                    unset($params[$kebabName]);
                }
            } elseif (!is_int($name)) {
                $message = Yii::t('yii', 'Unknown option: --{name}', ['name' => $name]);
                if (!empty($options)) {
                    $message .= '. ' . Yii::t('yii', 'Options available: {options}', ['options' => '--' . implode(', --', $options)]);
                }
                throw new Exception($message);
            }
        }
    }
    if ($this->help) {
        $route = $this->getUniqueId() . '/' . $id;
        return Yii::$app->runAction('help', [$route]);
    }
    return parent::runAction($id, $params);
}

            
select() public method

讓使用者選擇一個選項。輸入 '?' 將顯示選項清單及其說明。

public string select ( $prompt, $options = [], $default null )
$prompt string

提示訊息

$options array

要從中選擇的選項的鍵值陣列

$default string|null

當使用者未提供選項時要使用的值。如果預設值為 null,則使用者必須選擇一個選項。

return string

使用者選擇的選項字元

版本 描述 (Description)
2.0.49 新增了 $default 參數

                public function select($prompt, $options = [], $default = null)
{
    if ($this->interactive) {
        return Console::select($prompt, $options, $default);
    }
    return $default;
}

            
setView() public method

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

設定此控制器要使用的視圖物件。

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

可用於呈現視圖或視圖檔案的視圖物件。(The view object that can be used to render views or view files.)

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

            
setViewPath() public method (available since version 2.0.7)

定義於: yii\base\Controller::setViewPath()

設定包含視圖檔案的目錄。

public void setViewPath ( $path )
$path string

視圖檔案的根目錄。

throws yii\base\InvalidArgumentException

如果目錄無效

                public function setViewPath($path)
{
    $this->_viewPath = Yii::getAlias($path);
}

            
stderr() public method

將字串列印到 STDERR。

您可以選擇性地使用 ANSI 代碼格式化字串,方法是使用 yii\helpers\Console 中定義的常數傳遞其他參數。

範例

$this->stderr('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);
public integer|boolean stderr ( $string )
$string string

要列印的字串

return integer|boolean

列印的位元組數,如果發生錯誤則為 false

                public function stderr($string)
{
    if ($this->isColorEnabled(\STDERR)) {
        $args = func_get_args();
        array_shift($args);
        $string = Console::ansiFormat($string, $args);
    }
    return fwrite(\STDERR, $string);
}

            
stdout() public method

將字串列印到 STDOUT。

您可以選擇性地使用 ANSI 代碼格式化字串,方法是使用 yii\helpers\Console 中定義的常數傳遞其他參數。

範例

$this->stdout('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);
public integer|boolean stdout ( $string )
$string string

要列印的字串

return integer|boolean

列印的位元組數,如果發生錯誤則為 false

                public function stdout($string)
{
    if ($this->isColorEnabled()) {
        $args = func_get_args();
        array_shift($args);
        $string = Console::ansiFormat($string, $args);
    }
    return Console::stdout($string);
}

            
trigger() public method

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

觸發事件。

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

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

事件名稱

$event yii\base\Event|null

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

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