0 追蹤者

類別 yii\console\controllers\HelpController

繼承關係yii\console\controllers\HelpController » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject
實作yii\base\Configurableyii\base\ViewContextInterface
自版本起可用2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/console/controllers/HelpController.php

提供關於主控台命令的說明資訊。

此命令顯示應用程式中可用的命令列表,或關於使用特定命令的詳細指示。

此命令可以在命令列上如下使用

yii help [command name]

在上面,如果未提供命令名稱,將顯示所有可用的命令。

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$action yii\base\Action|null 目前正在執行的動作。 yii\base\Controller
$behaviors yii\base\Behavior[] 附加到此組件的行為列表。 yii\base\Component
$color boolean|null 是否在輸出中啟用 ANSI 彩色。 yii\console\Controller
$commands array 所有可用的命令名稱。 yii\console\controllers\HelpController
$defaultAction string 當請求中未指定動作 ID 時,使用的動作 ID。 yii\base\Controller
$help boolean 是否顯示關於目前命令的說明資訊。 yii\console\Controller
$helpSummary string yii\console\Controller
$id string 此控制器 ID。 yii\base\Controller
$interactive boolean 是否以互動方式執行命令。 yii\console\Controller
$layout 字串|null|false 要套用至此控制器視圖的版面配置名稱。 yii\base\Controller
$module yii\base\Module 此控制器所屬的模組。 yii\base\Controller
$modules yii\base\Module[] 此控制器所位於的所有上層模組。 yii\base\Controller
$passedOptionValues array 與已傳遞選項對應的屬性。 yii\console\Controller
$passedOptions array 執行期間傳遞的選項名稱。 yii\console\Controller
$request yii\base\Request|陣列|字串 請求。 yii\base\Controller
$response yii\base\Response|陣列|字串 回應。 yii\base\Controller
$route string 目前請求的路由(模組 ID、控制器 ID 和動作 ID)。 yii\base\Controller
$silentExitOnException boolean|null 如果為 true - 發生例外狀況時,腳本以 ExitCode::OK 結束。 yii\console\Controller
$uniqueId string 以模組 ID(如果有的話)為前綴的控制器 ID。 yii\base\Controller
$view yii\base\View|yii\web\View 可用於呈現視圖或視圖檔案的視圖物件。 yii\base\Controller
$viewPath string 包含此控制器視圖檔案的目錄。 yii\base\Controller

公共方法

隱藏繼承的方法

方法 描述 定義於
__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
actionIndex() 顯示可用命令或特定命令的詳細資訊。 yii\console\controllers\HelpController
actionList() 以機器可讀格式列出所有可用的控制器和動作。 yii\console\controllers\HelpController
actionListActionOptions() 以機器可讀格式列出 $action 的所有可用選項。 yii\console\controllers\HelpController
actionUsage() 顯示 $action 的使用資訊。 yii\console\controllers\HelpController
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
getActions() 傳回指定控制器的所有可用動作。 yii\console\controllers\HelpController
getBehavior() 傳回具名的行為物件。 yii\base\Component
getBehaviors() 傳回附加到此組件的所有行為。 yii\base\Component
getCommands() 傳回所有可用的命令名稱。 yii\console\controllers\HelpController
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

受保護的方法

隱藏繼承的方法

方法 描述 定義於
bindInjectedParams() 根據動作方法簽名中的類型和名稱填寫參數。 yii\base\Controller
formatOptionAliases() yii\console\controllers\HelpController
formatOptionHelp() 為引數或選項產生格式良好的字串。 yii\console\controllers\HelpController
getActionMethodReflection() yii\console\Controller
getCommandDescriptions() 傳回命令及其描述的陣列。 yii\console\controllers\HelpController
getCommandHelp() 顯示命令的整體資訊。 yii\console\controllers\HelpController
getDefaultHelp() 顯示所有可用的命令。 yii\console\controllers\HelpController
getDefaultHelpHeader() 傳回預設的說明標頭。 yii\console\controllers\HelpController
getModuleCommands() 傳回指定模組的可用命令。 yii\console\controllers\HelpController
getScriptName() yii\console\controllers\HelpController
getSubCommandHelp() 顯示命令動作的詳細資訊。 yii\console\controllers\HelpController
parseDocCommentDetail() 從 docblock 傳回完整描述。 yii\console\Controller
parseDocCommentSummary() 傳回 docblock 的第一行。 yii\console\Controller
parseDocCommentTags() 將註解區塊剖析為標籤。 yii\console\Controller
validateControllerClass() 驗證給定的類別是否為有效的控制台控制器類別。 yii\console\controllers\HelpController

事件

隱藏繼承的事件

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

常數

隱藏繼承的常數

常數 描述 定義於
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

屬性詳細資訊

隱藏繼承的屬性

$commands 公共屬性

所有可用的命令名稱。

public array $commands null

方法詳細資訊

隱藏繼承的方法

__call() 公共方法

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

呼叫非類別方法的具名方法。

此方法將檢查是否有任何附加的行為具有具名方法,並在可用時執行它。

請勿直接呼叫此方法,因為它是 PHP 魔術方法,當調用未知方法時,將會隱含地呼叫它。

public mixed __call ( $name, $params )
$name string

方法名稱

$params array

方法參數

return mixed

方法傳回值

throws yii\base\UnknownMethodException

當呼叫未知方法時

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() 公共方法

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

在透過複製現有物件建立物件後,會呼叫此方法。

它會移除所有行為,因為這些行為已附加到舊物件。

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() 公共方法
public void __construct ( $id, $module, $config = [] )
$id string

此控制器 ID。

$module yii\base\Module

此控制器所屬的模組。

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

            
actionIndex() 公共方法

顯示可用命令或特定命令的詳細資訊。

public integer actionIndex ( $command null )
$command 字串|null

要顯示說明之命令的名稱。如果未提供,將顯示所有可用的命令。

return integer

結束狀態

throws yii\console\Exception

如果要求說明的命令未知

                public function actionIndex($command = null)
{
    if ($command !== null) {
        $result = Yii::$app->createController($command);
        if ($result === false) {
            $name = $this->ansiFormat($command, Console::FG_YELLOW);
            throw new Exception("No help for unknown command \"$name\".");
        }
        list($controller, $actionID) = $result;
        $actions = $this->getActions($controller);
        if ($actionID !== '' || count($actions) === 1 && $actions[0] === $controller->defaultAction) {
            $this->getSubCommandHelp($controller, $actionID);
        } else {
            $this->getCommandHelp($controller);
        }
    } else {
        $this->getDefaultHelp();
    }
}

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

以機器可讀格式列出所有可用的控制器和動作。

這用於 shell 自動完成。

public void actionList ( )

                public function actionList()
{
    foreach ($this->getCommandDescriptions() as $command => $description) {
        $result = Yii::$app->createController($command);
        /** @var $controller Controller */
        list($controller, $actionID) = $result;
        $actions = $this->getActions($controller);
        $prefix = $controller->getUniqueId();
        if ($controller->createAction($controller->defaultAction) !== null) {
            $this->stdout("$prefix\n");
        }
        foreach ($actions as $action) {
            $this->stdout("$prefix/$action\n");
        }
    }
}

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

以機器可讀格式列出 $action 的所有可用選項。

這用於 shell 自動完成。

public void actionListActionOptions ( $action )
$action string

動作路由

                public function actionListActionOptions($action)
{
    $result = Yii::$app->createController($action);
    if ($result === false || !($result[0] instanceof Controller)) {
        return;
    }
    /** @var Controller $controller */
    list($controller, $actionID) = $result;
    $action = $controller->createAction($actionID);
    if ($action === null) {
        return;
    }
    foreach ($controller->getActionArgsHelp($action) as $argument => $help) {
        $description = preg_replace('~\R~', '', addcslashes($help['comment'], ':')) ?: $argument;
        $this->stdout($argument . ':' . $description . "\n");
    }
    $this->stdout("\n");
    foreach ($controller->getActionOptionsHelp($action) as $argument => $help) {
        $description = preg_replace('~\R~', '', addcslashes($help['comment'], ':'));
        $this->stdout('--' . $argument . ($description ? ':' . $description : '') . "\n");
    }
}

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

顯示 $action 的使用資訊。

public void actionUsage ( $action )
$action string

動作路由

                public function actionUsage($action)
{
    $result = Yii::$app->createController($action);
    if ($result === false || !($result[0] instanceof Controller)) {
        return;
    }
    /** @var Controller $controller */
    list($controller, $actionID) = $result;
    $action = $controller->createAction($actionID);
    if ($action === null) {
        return;
    }
    $scriptName = $this->getScriptName();
    if ($action->id === $controller->defaultAction) {
        $this->stdout($scriptName . ' ' . $this->ansiFormat($controller->getUniqueId(), Console::FG_YELLOW));
    } else {
        $this->stdout($scriptName . ' ' . $this->ansiFormat($action->getUniqueId(), Console::FG_YELLOW));
    }
    foreach ($controller->getActionArgsHelp($action) as $name => $arg) {
        if ($arg['required']) {
            $this->stdout(' <' . $name . '>', Console::FG_CYAN);
        } else {
            $this->stdout(' [' . $name . ']', Console::FG_CYAN);
        }
    }
    $this->stdout("\n");
}

            
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() 公共方法

定義於: yii\console\Controller::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 字串|陣列|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() public 函式

定義於: yii\console\Controller::beforeAction()

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

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

如果 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

要執行的 action。

return boolean

是否應繼續執行 action。

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

            
behaviors() public 函式

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

傳回此組件應表現為的行為清單。

子類別可以覆寫此方法,以指定它們想要作為的 behaviors。

此方法的傳回值應為 behavior 物件或組態的陣列,並以 behavior 名稱作為索引。behavior 組態可以是指定 behavior 類別的字串,或具有以下結構的陣列

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

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

在此方法中宣告的 Behaviors 將會自動 (依需求) 附加到元件。

public array behaviors ( )
return array

Behavior 組態。

                public function behaviors()
{
    return [];
}

            
bindActionParams() public 函式

定義於: yii\console\Controller::bindActionParams()

將參數繫結至動作。

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

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

要與參數繫結的 action

$params array

要繫結到 action 的參數

return array

action 可以執行的有效參數。

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() protected 函式 (自版本 2.0.36 起可用)

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

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

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

action 參數的反射類型。

$name string

參數的名稱。

$args array

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

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

另請參閱 canSetProperty()

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

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

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

另請參閱 canGetProperty()

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

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

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 函式

定義於: yii\console\Controller::confirm()

要求使用者輸入 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()

從組件中分離行為。

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

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

behavior 的名稱。

return yii\base\Behavior|null

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

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

            
detachBehaviors() public 函式

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

用於呈現 layout 檔案的 view 物件。

return string|boolean

layout 檔案路徑,或如果不需要 layout 則為 false。請參閱 render(),了解如何指定此參數。

throws yii\base\InvalidArgumentException

如果使用無效的路徑別名來指定 layout。

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

            
formatOptionAliases() protected 函式 (自版本 2.0.8 起可用)

protected string formatOptionAliases ( $controller, $option )
$controller yii\console\Controller

控制器實例

$option string

選項名稱

return string

別名引數或選項的格式化字串

                protected function formatOptionAliases($controller, $option)
{
    foreach ($controller->optionAliases() as $name => $value) {
        if (Inflector::camel2id($value, '-', true) === $option) {
            return ', -' . $name;
        }
    }
    return '';
}

            
formatOptionHelp() protected 函式

為引數或選項產生格式良好的字串。

protected string formatOptionHelp ( $name, $required, $type, $defaultValue, $comment )
$name string

引數或選項的名稱

$required boolean

引數是否為必要

$type string

選項或引數的類型

$defaultValue mixed

選項或引數的預設值

$comment string

關於選項或引數的註解

return string

引數或選項的格式化字串

                protected function formatOptionHelp($name, $required, $type, $defaultValue, $comment)
{
    $comment = trim((string)$comment);
    $type = trim((string)$type);
    if (strncmp($type, 'bool', 4) === 0) {
        $type = 'boolean, 0 or 1';
    }
    if ($defaultValue !== null && !is_array($defaultValue)) {
        if ($type === null) {
            $type = gettype($defaultValue);
        }
        if (is_bool($defaultValue)) {
            // show as integer to avoid confusion
            $defaultValue = (int) $defaultValue;
        }
        if (is_string($defaultValue)) {
            $defaultValue = "'" . $defaultValue . "'";
        } else {
            $defaultValue = var_export($defaultValue, true);
        }
        $doc = "$type (defaults to $defaultValue)";
    } else {
        $doc = $type;
    }
    if ($doc === '') {
        $doc = $comment;
    } elseif ($comment !== '') {
        $doc .= "\n" . preg_replace('/^/m', '  ', $comment);
    }
    $name = $required ? "$name (required)" : $name;
    return $doc === '' ? $name : "$name: $doc";
}

            
getActionArgsHelp() public 函式

定義於: yii\console\Controller::getActionArgsHelp()

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

傳回值應為陣列。鍵是引數名稱,值是對應的說明資訊。每個值都必須是以下結構的陣列

  • 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 函式

定義於: yii\console\Controller::getActionHelp()

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

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

要取得說明的 Action

return string

指定 action 的詳細說明資訊。

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

            
getActionHelpSummary() public 函式

定義於: yii\console\Controller::getActionHelpSummary()

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

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 函式

定義於: yii\console\Controller::getActionOptionsHelp()

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

傳回值應為陣列。鍵是選項名稱,值是對應的說明資訊。每個值都必須是以下結構的陣列

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

            
getActions() public 函式

傳回指定控制器的所有可用動作。

public array getActions ( $controller )
$controller yii\console\Controller

控制器實例

return array

所有可用的 action ID。

                public function getActions($controller)
{
    $actions = array_keys($controller->actions());
    $class = new \ReflectionClass($controller);
    foreach ($class->getMethods() as $method) {
        $name = $method->getName();
        if ($name !== 'actions' && $method->isPublic() && !$method->isStatic() && strncmp($name, 'action', 6) === 0) {
            $actions[] = $this->camel2id(substr($name, 6));
        }
    }
    sort($actions);
    return array_unique($actions);
}

            
getBehavior() public 函式

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

傳回具名的行為物件。

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

behavior 名稱

return yii\base\Behavior|null

behavior 物件,或如果 behavior 不存在則為 null

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

            
getBehaviors() public 函式

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

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

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

附加到此元件的 behaviors 清單

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

            
getCommandDescriptions() protected 函式

傳回命令及其描述的陣列。

protected array getCommandDescriptions ( )
return array

所有可用的命令作為鍵,其描述作為值。

                protected function getCommandDescriptions()
{
    $descriptions = [];
    foreach ($this->getCommands() as $command) {
        $result = Yii::$app->createController($command);
        /** @var Controller $controller */
        list($controller, $actionID) = $result;
        $descriptions[$command] = $controller->getHelpSummary();
    }
    return $descriptions;
}

            
getCommandHelp() protected method

顯示命令的整體資訊。

protected void getCommandHelp ( $controller )
$controller yii\console\Controller

控制器實例

                protected function getCommandHelp($controller)
{
    $controller->color = $this->color;
    $this->stdout("\nDESCRIPTION\n", Console::BOLD);
    $comment = $controller->getHelp();
    if ($comment !== '') {
        $this->stdout("\n$comment\n\n");
    }
    $actions = $this->getActions($controller);
    if (!empty($actions)) {
        $this->stdout("\nSUB-COMMANDS\n\n", Console::BOLD);
        $prefix = $controller->getUniqueId();
        $maxlen = 5;
        foreach ($actions as $action) {
            $len = strlen($prefix . '/' . $action) + 2 + ($action === $controller->defaultAction ? 10 : 0);
            $maxlen = max($maxlen, $len);
        }
        foreach ($actions as $action) {
            $this->stdout('- ' . $this->ansiFormat($prefix . '/' . $action, Console::FG_YELLOW));
            $len = strlen($prefix . '/' . $action) + 2;
            if ($action === $controller->defaultAction) {
                $this->stdout(' (default)', Console::FG_GREEN);
                $len += 10;
            }
            $summary = $controller->getActionHelpSummary($controller->createAction($action));
            if ($summary !== '') {
                $this->stdout(str_repeat(' ', $maxlen - $len + 2) . Console::wrapText($summary, $maxlen + 2));
            }
            $this->stdout("\n");
        }
        $scriptName = $this->getScriptName();
        $this->stdout("\nTo see the detailed information about individual sub-commands, enter:\n");
        $this->stdout("\n  $scriptName " . $this->ansiFormat('help', Console::FG_YELLOW) . ' '
            . $this->ansiFormat('<sub-command>', Console::FG_CYAN) . "\n\n");
    }
}

            
getCommands() public method

傳回所有可用的命令名稱。

public array getCommands ( )
return array

所有可用的命令名稱

                public function getCommands()
{
    $commands = $this->getModuleCommands(Yii::$app);
    sort($commands);
    return array_filter(array_unique($commands), function ($command) {
        $result = Yii::$app->createController($command);
        if ($result === false || !$result[0] instanceof Controller) {
            return false;
        }
        list($controller, $actionID) = $result;
        $actions = $this->getActions($controller);
        return $actions !== [];
    });
}

            
getDefaultHelp() protected method

顯示所有可用的命令。

protected void getDefaultHelp ( )

                protected function getDefaultHelp()
{
    $commands = $this->getCommandDescriptions();
    $this->stdout($this->getDefaultHelpHeader());
    if (empty($commands)) {
        $this->stdout("\nNo commands are found.\n\n", Console::BOLD);
        return;
    }
    $this->stdout("\nThe following commands are available:\n\n", Console::BOLD);
    $maxLength = 0;
    foreach ($commands as $command => $description) {
        $result = Yii::$app->createController($command);
        /** @var $controller Controller */
        list($controller, $actionID) = $result;
        $actions = $this->getActions($controller);
        $prefix = $controller->getUniqueId();
        foreach ($actions as $action) {
            $string = $prefix . '/' . $action;
            if ($action === $controller->defaultAction) {
                $string .= ' (default)';
            }
            $maxLength = max($maxLength, strlen($string));
        }
    }
    foreach ($commands as $command => $description) {
        $result = Yii::$app->createController($command);
        list($controller, $actionID) = $result;
        $actions = $this->getActions($controller);
        $this->stdout('- ' . $this->ansiFormat($command, Console::FG_YELLOW));
        $this->stdout(str_repeat(' ', $maxLength + 4 - strlen($command)));
        $this->stdout(Console::wrapText($description, $maxLength + 4 + 2), Console::BOLD);
        $this->stdout("\n");
        $prefix = $controller->getUniqueId();
        foreach ($actions as $action) {
            $string = '  ' . $prefix . '/' . $action;
            $this->stdout('  ' . $this->ansiFormat($string, Console::FG_GREEN));
            if ($action === $controller->defaultAction) {
                $string .= ' (default)';
                $this->stdout(' (default)', Console::FG_YELLOW);
            }
            $summary = $controller->getActionHelpSummary($controller->createAction($action));
            if ($summary !== '') {
                $this->stdout(str_repeat(' ', $maxLength + 4 - strlen($string)));
                $this->stdout(Console::wrapText($summary, $maxLength + 4 + 2));
            }
            $this->stdout("\n");
        }
        $this->stdout("\n");
    }
    $scriptName = $this->getScriptName();
    $this->stdout("\nTo see the help of each command, enter:\n", Console::BOLD);
    $this->stdout("\n  $scriptName " . $this->ansiFormat('help', Console::FG_YELLOW) . ' '
        . $this->ansiFormat('<command-name>', Console::FG_CYAN) . "\n\n");
}

            
getDefaultHelpHeader() protected method (available since version 2.0.11)

傳回預設的說明標頭。

protected string getDefaultHelpHeader ( )
return string

預設說明標頭。

                protected function getDefaultHelpHeader()
{
    return "\nThis is Yii version " . \Yii::getVersion() . ".\n";
}

            
getHelp() public method

定義於: yii\console\Controller::getHelp()

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

您可以覆寫此方法以傳回自訂的說明。預設實作會傳回從 PHPDoc 註解中檢索的說明資訊。

public string getHelp ( )

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

            
getHelpSummary() public method

定義於: yii\console\Controller::getHelpSummary()

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

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

public string getHelpSummary ( )

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

            
getModuleCommands() protected method

傳回指定模組的可用命令。

protected array getModuleCommands ( $module )
$module yii\base\Module

模組實例

return array

可用的命令名稱

                protected function getModuleCommands($module)
{
    $prefix = $module instanceof Application ? '' : $module->getUniqueId() . '/';
    $commands = [];
    foreach (array_keys($module->controllerMap) as $id) {
        $commands[] = $prefix . $id;
    }
    foreach ($module->getModules() as $id => $child) {
        if (($child = $module->getModule($id)) === null) {
            continue;
        }
        foreach ($this->getModuleCommands($child) as $command) {
            $commands[] = $command;
        }
    }
    $controllerPath = $module->getControllerPath();
    if (is_dir($controllerPath)) {
        $iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($controllerPath, \RecursiveDirectoryIterator::KEY_AS_PATHNAME));
        $iterator = new \RegexIterator($iterator, '/.*Controller\.php$/', \RecursiveRegexIterator::GET_MATCH);
        foreach ($iterator as $matches) {
            $file = $matches[0];
            $relativePath = str_replace($controllerPath, '', $file);
            $class = strtr($relativePath, [
                '/' => '\\',
                '.php' => '',
            ]);
            $controllerClass = $module->controllerNamespace . $class;
            if ($this->validateControllerClass($controllerClass)) {
                $dir = ltrim(pathinfo($relativePath, PATHINFO_DIRNAME), '\\/');
                $command = Inflector::camel2id(substr(basename($file), 0, -14), '-', true);
                if (!empty($dir)) {
                    $command = $dir . '/' . $command;
                }
                $commands[] = $prefix . $command;
            }
        }
    }
    return $commands;
}

            
getModules() public method

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

傳回此控制器的所有上層模組。

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

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

此控制器所位於的所有上層模組。

                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 method

定義於: yii\console\Controller::getOptionValues()

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

public array getOptionValues ( $actionID )
$actionID string

當前請求的動作 ID

return array

對應於動作選項的屬性

                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 method

定義於: yii\console\Controller::getPassedOptionValues()

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

public array getPassedOptionValues ( )
return array

對應於已傳遞選項的屬性

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

            
getPassedOptions() public method

定義於: yii\console\Controller::getPassedOptions()

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

public array getPassedOptions ( )
return array

執行期間傳遞的選項名稱

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

            
getRoute() public method

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

傳回目前請求的路由。

public string getRoute ( )
return string

目前請求的路由(模組 ID、控制器 ID 和動作 ID)。

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

            
getScriptName() protected method

protected string getScriptName ( )
return string

當前正在執行的 cli 腳本名稱。

                protected function getScriptName()
{
    return basename(Yii::$app->request->scriptFile);
}

            
getSubCommandHelp() protected method

顯示命令動作的詳細資訊。

protected void getSubCommandHelp ( $controller, $actionID )
$controller yii\console\Controller

控制器實例

$actionID string

動作 ID

throws yii\console\Exception

如果動作不存在

                protected function getSubCommandHelp($controller, $actionID)
{
    $action = $controller->createAction($actionID);
    if ($action === null) {
        $name = $this->ansiFormat(rtrim($controller->getUniqueId() . '/' . $actionID, '/'), Console::FG_YELLOW);
        throw new Exception("No help for unknown sub-command \"$name\".");
    }
    $description = $controller->getActionHelp($action);
    if ($description !== '') {
        $this->stdout("\nDESCRIPTION\n", Console::BOLD);
        $this->stdout("\n$description\n\n");
    }
    $this->stdout("\nUSAGE\n\n", Console::BOLD);
    $scriptName = $this->getScriptName();
    if ($action->id === $controller->defaultAction) {
        $this->stdout($scriptName . ' ' . $this->ansiFormat($controller->getUniqueId(), Console::FG_YELLOW));
    } else {
        $this->stdout($scriptName . ' ' . $this->ansiFormat($action->getUniqueId(), Console::FG_YELLOW));
    }
    $args = $controller->getActionArgsHelp($action);
    foreach ($args as $name => $arg) {
        if ($arg['required']) {
            $this->stdout(' <' . $name . '>', Console::FG_CYAN);
        } else {
            $this->stdout(' [' . $name . ']', Console::FG_CYAN);
        }
    }
    $options = $controller->getActionOptionsHelp($action);
    $options[\yii\console\Application::OPTION_APPCONFIG] = [
        'type' => 'string',
        'default' => null,
        'comment' => "custom application configuration file path.\nIf not set, default application configuration is used.",
    ];
    ksort($options);
    if (!empty($options)) {
        $this->stdout(' [...options...]', Console::FG_RED);
    }
    $this->stdout("\n\n");
    if (!empty($args)) {
        foreach ($args as $name => $arg) {
            $this->stdout($this->formatOptionHelp(
                '- ' . $this->ansiFormat($name, Console::FG_CYAN),
                $arg['required'],
                $arg['type'],
                $arg['default'],
                $arg['comment']
            ) . "\n\n");
        }
    }
    if (!empty($options)) {
        $this->stdout("\nOPTIONS\n\n", Console::BOLD);
        foreach ($options as $name => $option) {
            $this->stdout($this->formatOptionHelp(
                $this->ansiFormat(
                    '--' . $name . $this->formatOptionAliases($controller, $name),
                    Console::FG_RED,
                    empty($option['required']) ? Console::FG_RED : Console::BOLD
                ),
                !empty($option['required']),
                $option['type'],
                $option['default'],
                $option['comment']
            ) . "\n\n");
        }
    }
}

            
getUniqueId() public method

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

傳回控制器的唯一 ID。

public string getUniqueId ( )
return string

以模組 ID(如果有的話)為前綴的控制器 ID。

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

            
getView() public method

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

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

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

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

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

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

            
getViewPath() public method

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

傳回包含此控制器視圖檔案的目錄。

預設實作會傳回在 $module$viewPath 目錄下,以控制器 $id 命名的目錄。

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 method

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

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

public boolean hasEventHandlers ( $name )
$name string

事件名稱

return boolean

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

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

            
hasMethod() public method

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

傳回指示是否已定義方法的數值。

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

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

屬性名稱

$checkBehaviors boolean

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

return boolean

是否已定義方法

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

            
hasProperty() public method

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

傳回指示是否已為此組件定義屬性的數值。

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

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

參見

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

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

return boolean

是否已定義屬性

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

            
init() public method (available since version 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

定義於: yii\console\Controller::isColorEnabled()

傳回指示是否啟用 ANSI 彩色的數值。

只有在 $color 設定為 true 或未設定且終端機支援 ANSI 彩色時,才會啟用 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)

定義於: yii\console\Controller::optionAliases()

傳回選項別名。

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

另請參見 options()

public array optionAliases ( )
return array

對於動作有效的選項別名,其中鍵是選項的別名,值是選項名稱。

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

            
options() public method

定義於: yii\console\Controller::options()

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

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

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

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

當前請求的動作 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

定義於: yii\console\Controller::parseDocCommentDetail()

從 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

定義於: yii\console\Controller::parseDocCommentSummary()

傳回 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

定義於: yii\console\Controller::parseDocCommentTags()

將註解區塊剖析為標籤。

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

定義於: yii\console\Controller::prompt()

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

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

定義於: yii\console\Controller::runAction()

使用指定的動作 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

定義於: yii\console\Controller::select()

讓使用者可以從選項中選擇。輸入 '?' 作為輸入將顯示選項清單及其說明。

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

提示訊息

$options array

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

$default 字串|null

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

return string

使用者選擇的選項字元

版本 描述
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

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

                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

定義於: yii\console\Controller::stderr()

將字串列印到 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

定義於: yii\console\Controller::stdout()

將字串列印到 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);
}

            
validateControllerClass() protected method

驗證給定的類別是否為有效的控制台控制器類別。

protected boolean validateControllerClass ( $controllerClass )
$controllerClass string

                protected function validateControllerClass($controllerClass)
{
    if (class_exists($controllerClass)) {
        $class = new \ReflectionClass($controllerClass);
        return !$class->isAbstract() && $class->isSubclassOf('yii\console\Controller');
    }
    return false;
}