類別 yii\console\controllers\AssetController
讓您合併和壓縮您的 JavaScript 和 CSS 檔案。
用法
使用
template
動作建立設定檔yii asset/template /path/to/myapp/config.php
- 編輯建立的設定檔,根據您的 Web 應用程式需求進行調整。
執行 'compress' 動作,使用建立的設定
yii asset /path/to/myapp/config.php /path/to/myapp/config/assets_compressed.php
調整您的 Web 應用程式設定以使用壓縮後的資源。
注意:在命令列環境中,某些 路徑別名 (path aliases),例如 @webroot
和 @web
可能不存在,因此應直接指定設定檔內的對應路徑。
注意:預設情況下,此命令依賴外部工具來執行實際的檔案壓縮,請查看 $jsCompressor 和 $cssCompressor 以取得更多詳細資訊。
公開屬性
公開方法
受保護的方法
事件
事件 | 類型 | 描述 | 定義於 |
---|---|---|---|
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 |
屬性詳細資訊
資源管理器實例。請注意,此屬性的類型在 getter 和 setter 中有所不同。有關詳細資訊,請參閱 getAssetManager() 和 setAssetManager()。
CSS 檔案壓縮器。如果是字串,則將其視為 shell 命令範本,其中應包含佔位符 {from} - 來源檔案名稱 - 和 {to} - 輸出檔案名稱。否則,將其視為 PHP 回調,應執行壓縮。
預設值依賴於 "YUI Compressor" 的使用
是否在壓縮後刪除資源來源檔案。此選項僅影響那些設定了 yii\web\AssetBundle::$sourcePath 的資源包。
JavaScript 檔案壓縮器。如果是字串,則將其視為 shell 命令範本,其中應包含佔位符 {from} - 來源檔案名稱 - 和 {to} - 輸出檔案名稱。否則,將其視為 PHP 回調,應執行壓縮。
預設值依賴於 "Closure Compiler" 的使用
代表輸出壓縮檔案的資源包列表。您可以使用 'css' 和 'js' 鍵指定輸出壓縮檔案的名稱:例如
'app\config\AllAsset' => [
'js' => 'js/all-{hash}.js',
'css' => 'css/all-{hash}.css',
'depends' => [ ... ],
]
檔案名稱可以包含佔位符 "{hash}",該佔位符將由結果檔案的雜湊值填充。
您可以指定多個目標資源包,以便壓縮不同的資源組。在這種情況下,您應使用 'depends' 鍵來指定應由特定目標資源包涵蓋的資源包。您可以將 'depends' 留空以用於單個資源包,在這種情況下,它將壓縮所有剩餘的資源包。例如
'allShared' => [
'js' => 'js/all-shared-{hash}.js',
'css' => 'css/all-shared-{hash}.css',
'depends' => [
// Include all assets shared between 'backend' and 'frontend'
'yii\web\YiiAsset',
'app\assets\SharedAsset',
],
],
'allBackEnd' => [
'js' => 'js/all-{hash}.js',
'css' => 'css/all-{hash}.css',
'depends' => [
// Include only 'backend' assets:
'app\assets\AdminAsset'
],
],
'allFrontEnd' => [
'js' => 'js/all-{hash}.js',
'css' => 'css/all-{hash}.css',
'depends' => [], // Include all remaining assets
],
方法詳細資訊
定義於: 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()");
}
public void __clone ( ) |
public function __clone()
{
$this->_events = [];
$this->_eventWildcards = [];
$this->_behaviors = null;
}
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);
}
定義於: 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);
}
定義於: yii\base\Component::__isset()
檢查是否已設定屬性,即已定義且不為 null。
此方法將依以下順序檢查並採取相應措施
- 由 setter 定義的屬性:傳回屬性是否已設定
- 行為的屬性:傳回屬性是否已設定
- 針對不存在的屬性傳回
false
不要直接調用此方法,因為它是 PHP 魔術方法,當執行 isset($component->property)
時,它將被隱式調用。
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;
}
定義於: 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);
}
定義於: yii\base\Component::__unset()
將組件屬性設定為 null。
此方法將依以下順序檢查並採取相應措施
- 由 setter 定義的屬性:將屬性值設定為 null
- 行為的屬性:將屬性值設定為 null
不要直接調用此方法,因為它是 PHP 魔術方法,當執行 unset($component->property)
時,它將被隱式調用。
public void __unset ( $name ) | ||
$name | string |
屬性名稱 |
throws | yii\base\InvalidCallException |
如果屬性為唯讀。 |
---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
return;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name)) {
$behavior->$name = null;
return;
}
}
throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}
根據給定的設定合併和壓縮資源檔案。
在此過程中,將建立新的資源包組態檔案。您應將原始資源包組態替換為此檔案,以便使用壓縮檔案。
public void actionCompress ( $configFile, $bundleFile ) | ||
$configFile | string |
組態檔案名稱。 |
$bundleFile | string |
輸出資源包組態檔案名稱。 |
public function actionCompress($configFile, $bundleFile)
{
$this->loadConfiguration($configFile);
$bundles = $this->loadBundles($this->bundles);
$targets = $this->loadTargets($this->targets, $bundles);
foreach ($targets as $name => $target) {
$this->stdout("Creating output bundle '{$name}':\n");
if (!empty($target->js)) {
$this->buildTarget($target, 'js', $bundles);
}
if (!empty($target->css)) {
$this->buildTarget($target, 'css', $bundles);
}
$this->stdout("\n");
}
$targets = $this->adjustDependency($targets, $bundles);
$this->saveTargets($targets, $bundleFile);
if ($this->deleteSource) {
$this->deletePublishedAssets($bundles);
}
}
為 actionCompress() 建立設定檔範本。
public integer actionTemplate ( $configFile ) | ||
$configFile | string |
輸出檔案名稱。 |
return | integer |
CLI 退出代碼 |
---|---|---|
throws | yii\console\Exception |
失敗時。 |
public function actionTemplate($configFile)
{
$jsCompressor = VarDumper::export($this->jsCompressor);
$cssCompressor = VarDumper::export($this->cssCompressor);
$template = <<<EOD
p
onfiguration file for the "yii asset" console command.
n the console environment, some path aliases may not exist. Please define these:
ii::setAlias('@webroot', __DIR__ . '/../web');
ii::setAlias('@web', '/');
rn [
// Adjust command/callback for JavaScript files compressing:
'jsCompressor' => {$jsCompressor},
// Adjust command/callback for CSS files compressing:
'cssCompressor' => {$cssCompressor},
// Whether to delete asset source after compression:
'deleteSource' => false,
// The list of asset bundles to compress:
'bundles' => [
// 'app\assets\AppAsset',
// 'yii\web\YiiAsset',
// 'yii\web\JqueryAsset',
],
// Asset bundle for compression output:
'targets' => [
'all' => [
'class' => 'yii\web\AssetBundle',
'basePath' => '@webroot/assets',
'baseUrl' => '@web/assets',
'js' => 'js/all-{hash}.js',
'css' => 'css/all-{hash}.css',
],
],
// Asset manager configuration:
'assetManager' => [
//'basePath' => '@webroot/assets',
//'baseUrl' => '@web/assets',
],
if (file_exists($configFile)) {
if (!$this->confirm("File '{$configFile}' already exists. Do you wish to overwrite it?")) {
return ExitCode::OK;
}
}
if (!file_put_contents($configFile, $template, LOCK_EX)) {
throw new Exception("Unable to write template file '{$configFile}'.");
}
$this->stdout("Configuration file template created at '{$configFile}'.\n\n", Console::FG_GREEN);
return ExitCode::OK;
}
定義於: 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 [];
}
調整 CSS 內容,允許 URL 參考指向原始資源。
protected string adjustCssUrl ( $cssContent, $inputFilePath, $outputFilePath ) | ||
$cssContent | string |
來源 CSS 內容。 |
$inputFilePath | string |
輸入 CSS 檔案名稱。 |
$outputFilePath | string |
輸出 CSS 檔案名稱。 |
return | string |
已調整的 CSS 內容。 |
---|
protected function adjustCssUrl($cssContent, $inputFilePath, $outputFilePath)
{
$inputFilePath = str_replace('\\', '/', $inputFilePath);
$outputFilePath = str_replace('\\', '/', $outputFilePath);
$sharedPathParts = [];
$inputFilePathParts = explode('/', $inputFilePath);
$inputFilePathPartsCount = count($inputFilePathParts);
$outputFilePathParts = explode('/', $outputFilePath);
$outputFilePathPartsCount = count($outputFilePathParts);
for ($i = 0; $i < $inputFilePathPartsCount && $i < $outputFilePathPartsCount; $i++) {
if ($inputFilePathParts[$i] == $outputFilePathParts[$i]) {
$sharedPathParts[] = $inputFilePathParts[$i];
} else {
break;
}
}
$sharedPath = implode('/', $sharedPathParts);
$inputFileRelativePath = trim(str_replace($sharedPath, '', $inputFilePath), '/');
$outputFileRelativePath = trim(str_replace($sharedPath, '', $outputFilePath), '/');
if (empty($inputFileRelativePath)) {
$inputFileRelativePathParts = [];
} else {
$inputFileRelativePathParts = explode('/', $inputFileRelativePath);
}
if (empty($outputFileRelativePath)) {
$outputFileRelativePathParts = [];
} else {
$outputFileRelativePathParts = explode('/', $outputFileRelativePath);
}
$callback = function ($matches) use ($inputFileRelativePathParts, $outputFileRelativePathParts) {
$fullMatch = $matches[0];
$inputUrl = $matches[1];
if (strncmp($inputUrl, '/', 1) === 0 || strncmp($inputUrl, '#', 1) === 0 || preg_match('/^https?:\/\//i', $inputUrl) || preg_match('/^data:/i', $inputUrl)) {
return $fullMatch;
}
if ($inputFileRelativePathParts === $outputFileRelativePathParts) {
return $fullMatch;
}
if (empty($outputFileRelativePathParts)) {
$outputUrlParts = [];
} else {
$outputUrlParts = array_fill(0, count($outputFileRelativePathParts), '..');
}
$outputUrlParts = array_merge($outputUrlParts, $inputFileRelativePathParts);
if (strpos($inputUrl, '/') !== false) {
$inputUrlParts = explode('/', $inputUrl);
foreach ($inputUrlParts as $key => $inputUrlPart) {
if ($inputUrlPart === '..') {
array_pop($outputUrlParts);
unset($inputUrlParts[$key]);
}
}
$outputUrlParts[] = implode('/', $inputUrlParts);
} else {
$outputUrlParts[] = $inputUrl;
}
$outputUrl = implode('/', $outputUrlParts);
return str_replace($inputUrl, $outputUrl, $fullMatch);
};
$cssContent = preg_replace_callback('/url\(["\']?([^)^"\']*)["\']?\)/i', $callback, $cssContent);
return $cssContent;
}
調整資源包之間的依賴關係,使來源包開始依賴輸出包。
protected yii\web\AssetBundle[] adjustDependency ( $targets, $bundles ) | ||
$targets | yii\web\AssetBundle[] |
輸出資源包。 |
$bundles | yii\web\AssetBundle[] |
來源資源包。 |
return | yii\web\AssetBundle[] |
輸出資源包。 |
---|
protected function adjustDependency($targets, $bundles)
{
$this->stdout("Creating new bundle configuration...\n");
$map = [];
foreach ($targets as $name => $target) {
foreach ($target->depends as $bundle) {
$map[$bundle] = $name;
}
}
foreach ($targets as $name => $target) {
$depends = [];
foreach ($target->depends as $bn) {
foreach ($bundles[$bn]->depends as $bundle) {
$depends[$map[$bundle]] = true;
}
}
unset($depends[$name]);
$target->depends = array_keys($depends);
}
// detect possible circular dependencies
foreach ($targets as $name => $target) {
$registered = [];
$this->registerBundle($targets, $name, $registered);
}
foreach ($map as $bundle => $target) {
$sourceBundle = $bundles[$bundle];
$depends = $sourceBundle->depends;
if (!$this->isBundleExternal($sourceBundle)) {
$depends[] = $target;
}
$targetBundle = clone $sourceBundle;
$targetBundle->depends = $depends;
$targets[$bundle] = $targetBundle;
}
return $targets;
}
定義於: 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;
}
定義於: 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;
}
Defined in: 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);
}
Defined in: 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);
}
}
Defined in: yii\console\Controller::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);
}
Defined in: 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 [];
}
Defined in: yii\console\Controller::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);
}
Defined in: 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);
}
}
建構輸出資源包。
protected void buildTarget ( $target, $type, $bundles ) | ||
$target | yii\web\AssetBundle |
輸出資源包 |
$type | string |
可以是 'js' 或 'css'。 |
$bundles | yii\web\AssetBundle[] |
來源資源包。 |
throws | yii\console\Exception |
失敗時。 |
---|
protected function buildTarget($target, $type, $bundles)
{
$inputFiles = [];
foreach ($target->depends as $name) {
if (isset($bundles[$name])) {
if (!$this->isBundleExternal($bundles[$name])) {
foreach ($bundles[$name]->$type as $file) {
if (is_array($file)) {
$inputFiles[] = $bundles[$name]->basePath . '/' . $file[0];
} else {
$inputFiles[] = $bundles[$name]->basePath . '/' . $file;
}
}
}
} else {
throw new Exception("Unknown bundle: '{$name}'");
}
}
if (empty($inputFiles)) {
$target->$type = [];
} else {
FileHelper::createDirectory($target->basePath, $this->getAssetManager()->dirMode);
$tempFile = $target->basePath . '/' . strtr($target->$type, ['{hash}' => 'temp']);
if ($type === 'js') {
$this->compressJsFiles($inputFiles, $tempFile);
} else {
$this->compressCssFiles($inputFiles, $tempFile);
}
$targetFile = strtr($target->$type, ['{hash}' => md5_file($tempFile)]);
$outputFile = $target->basePath . '/' . $targetFile;
rename($tempFile, $outputFile);
$target->$type = [$targetFile];
}
}
Defined in: 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;
}
Defined in: 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;
}
::class
。
Defined in: yii\base\BaseObject::className()
傳回此類別的完整限定名稱。
public static string className ( ) | ||
return | string |
此類別的完整限定名稱。 |
---|
public static function className()
{
return get_called_class();
}
將 CSS 檔案合併為單一檔案。
public void combineCssFiles ( $inputFiles, $outputFile ) | ||
$inputFiles | array |
來源檔案名稱。 |
$outputFile | string |
輸出檔案名稱。 |
throws | yii\console\Exception |
失敗時。 |
---|
public function combineCssFiles($inputFiles, $outputFile)
{
$content = '';
$outputFilePath = dirname($this->findRealPath($outputFile));
foreach ($inputFiles as $file) {
$content .= "/*** BEGIN FILE: $file ***/\n"
. $this->adjustCssUrl(file_get_contents($file), dirname($this->findRealPath($file)), $outputFilePath)
. "/*** END FILE: $file ***/\n";
}
if (!file_put_contents($outputFile, $content)) {
throw new Exception("Unable to write output CSS file '{$outputFile}'.");
}
}
將 JavaScript 檔案合併為單一檔案。
public void combineJsFiles ( $inputFiles, $outputFile ) | ||
$inputFiles | array |
來源檔案名稱。 |
$outputFile | string |
輸出檔案名稱。 |
throws | yii\console\Exception |
失敗時。 |
---|
public function combineJsFiles($inputFiles, $outputFile)
{
$content = '';
foreach ($inputFiles as $file) {
// Add a semicolon to source code if trailing semicolon missing.
// Notice: It needs a new line before `;` to avoid affection of line comment. (// ...;)
$fileContent = rtrim(file_get_contents($file));
if (substr($fileContent, -1) !== ';') {
$fileContent .= "\n;";
}
$content .= "/*** BEGIN FILE: $file ***/\n"
. $fileContent . "\n"
. "/*** END FILE: $file ***/\n";
}
if (!file_put_contents($outputFile, $content)) {
throw new Exception("Unable to write output JavaScript file '{$outputFile}'.");
}
}
壓縮給定的 CSS 檔案,並將它們合併為單一檔案。
protected void compressCssFiles ( $inputFiles, $outputFile ) | ||
$inputFiles | array |
來源檔案名稱列表。 |
$outputFile | string |
輸出檔案名稱。 |
throws | yii\console\Exception |
失敗時 |
---|
protected function compressCssFiles($inputFiles, $outputFile)
{
if (empty($inputFiles)) {
return;
}
$this->stdout(" Compressing CSS files...\n");
if (is_string($this->cssCompressor)) {
$tmpFile = $outputFile . '.tmp';
$this->combineCssFiles($inputFiles, $tmpFile);
$this->stdout((string)shell_exec(strtr($this->cssCompressor, [
'{from}' => escapeshellarg($tmpFile),
'{to}' => escapeshellarg($outputFile),
])));
@unlink($tmpFile);
} else {
call_user_func($this->cssCompressor, $this, $inputFiles, $outputFile);
}
if (!file_exists($outputFile)) {
throw new Exception("Unable to compress CSS files into '{$outputFile}'.");
}
$this->stdout(" CSS files compressed into '{$outputFile}'.\n");
}
壓縮給定的 JavaScript 檔案,並將它們合併為單一檔案。
protected void compressJsFiles ( $inputFiles, $outputFile ) | ||
$inputFiles | array |
來源檔案名稱列表。 |
$outputFile | string |
輸出檔案名稱。 |
throws | yii\console\Exception |
失敗時 |
---|
protected function compressJsFiles($inputFiles, $outputFile)
{
if (empty($inputFiles)) {
return;
}
$this->stdout(" Compressing JavaScript files...\n");
if (is_string($this->jsCompressor)) {
$tmpFile = $outputFile . '.tmp';
$this->combineJsFiles($inputFiles, $tmpFile);
$this->stdout((string)shell_exec(strtr($this->jsCompressor, [
'{from}' => escapeshellarg($tmpFile),
'{to}' => escapeshellarg($outputFile),
])));
@unlink($tmpFile);
} else {
call_user_func($this->jsCompressor, $this, $inputFiles, $outputFile);
}
if (!file_exists($outputFile)) {
throw new Exception("Unable to compress JavaScript files into '{$outputFile}'.");
}
$this->stdout(" JavaScript files compressed into '{$outputFile}'.\n");
}
Defined in: 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;
}
Defined in: yii\base\Controller::createAction()
根據給定的動作 ID 建立一個動作。
此方法首先檢查動作 ID 是否已在 actions() 中宣告。如果是,它將使用那裡宣告的配置來建立動作物件。如果沒有,它將尋找控制器方法,其名稱格式為 actionXyz
,其中 xyz
是動作 ID。如果找到,將建立並傳回代表該方法的 yii\base\InlineAction。
public yii\base\Action|null createAction ( $id ) | ||
$id | string |
動作 ID。 |
return | yii\base\Action|null |
新建立的動作實例。如果 ID 無法解析為任何動作,則為 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;
}
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;
}
Defined in: yii\base\Component::detachBehaviors()
從組件中分離所有行為。
public void detachBehaviors ( ) |
public function detachBehaviors()
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $name => $behavior) {
$this->detachBehavior($name);
}
}
Defined in: 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);
}
}
}
Defined in: 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;
}
Defined in: yii\console\Controller::getActionArgsHelp()
傳回動作的匿名引數的說明資訊。
傳回值應為陣列。鍵是引數名稱,值是對應的說明資訊。每個值都必須是以下結構的陣列
- required: bool,此引數是否為必要項
- type: string|null,此引數的 PHP 型別
- default: mixed,此引數的預設值
- comment: string,此引數的描述
預設實作將傳回從與動作方法對應的參數的反思或 DocBlock 中擷取的說明資訊。
public array getActionArgsHelp ( $action ) | ||
$action | yii\base\Action |
動作實例 |
return | array |
動作引數的說明資訊 |
---|
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;
}
Defined in: yii\console\Controller::getActionHelp()
傳回指定動作的詳細說明資訊。
public string getActionHelp ( $action ) | ||
$action | yii\base\Action |
要取得說明的動作 |
return | string |
指定動作的詳細說明資訊。 |
---|
public function getActionHelp($action)
{
return $this->parseDocCommentDetail($this->getActionMethodReflection($action));
}
Defined in: yii\console\Controller::getActionHelpSummary()
傳回描述指定動作的單行簡短摘要。
public string getActionHelpSummary ( $action ) | ||
$action | yii\base\Action |
要取得摘要的動作 |
return | string |
描述指定動作的單行簡短摘要。 |
---|
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));
}
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];
}
Defined in: yii\console\Controller::getActionOptionsHelp()
傳回動作選項的說明資訊。
傳回值應為陣列。鍵是選項名稱,值是對應的說明資訊。每個值都必須是以下結構的陣列
- type: string,此引數的 PHP 型別。
- default: string,此引數的預設值
- comment: string,此引數的註解
預設實作將傳回從與動作選項對應的屬性的 doc-comment 中擷取的說明資訊。
public array getActionOptionsHelp ( $action ) | ||
$action | yii\base\Action | |
return | array |
動作選項的說明資訊 |
---|
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;
}
傳回資源管理器實例。
public yii\web\AssetManager getAssetManager ( ) | ||
return | yii\web\AssetManager |
資源管理器實例。 |
---|---|---|
throws | yii\console\Exception |
關於無效的配置。 |
public function getAssetManager()
{
if (!is_object($this->_assetManager)) {
$options = $this->_assetManager;
if (!isset($options['class'])) {
$options['class'] = 'yii\\web\\AssetManager';
}
if (!isset($options['basePath'])) {
throw new Exception("Please specify 'basePath' for the 'assetManager' option.");
}
if (!isset($options['baseUrl'])) {
throw new Exception("Please specify 'baseUrl' for the 'assetManager' option.");
}
if (!isset($options['forceCopy'])) {
$options['forceCopy'] = true;
}
$this->_assetManager = Yii::createObject($options);
}
return $this->_assetManager;
}
定義於: yii\base\Component::getBehavior()
傳回指定名稱的行為物件。
public yii\base\Behavior|null getBehavior ( $name ) | ||
$name | string |
行為名稱 |
return | yii\base\Behavior|null |
行為物件,如果行為不存在則為 null |
---|
public function getBehavior($name)
{
$this->ensureBehaviors();
return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}
定義於: yii\base\Component::getBehaviors()
傳回附加到此組件的所有行為。
public yii\base\Behavior[] getBehaviors ( ) | ||
return | yii\base\Behavior[] |
附加到此組件的行為列表 |
---|
public function getBehaviors()
{
$this->ensureBehaviors();
return $this->_behaviors;
}
public string getHelp ( ) |
public function getHelp()
{
return $this->parseDocCommentDetail(new \ReflectionClass($this));
}
定義於: yii\console\Controller::getHelpSummary()
傳回描述此控制器的單行簡短摘要。
您可以覆寫此方法以返回自訂的摘要。預設實作會返回 PHPDoc 註解的第一行。
public string getHelpSummary ( ) |
public function getHelpSummary()
{
return $this->parseDocCommentSummary(new \ReflectionClass($this));
}
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;
}
定義於: 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;
}
定義於: yii\console\Controller::getPassedOptionValues()
傳回對應於已傳遞選項的屬性。
public array getPassedOptionValues ( ) | ||
return | array |
對應於已傳遞選項的屬性 |
---|
public function getPassedOptionValues()
{
$properties = [];
foreach ($this->_passedOptions as $property) {
$properties[$property] = $this->$property;
}
return $properties;
}
定義於: yii\console\Controller::getPassedOptions()
傳回執行期間傳遞的有效選項名稱。
public array getPassedOptions ( ) | ||
return | array |
執行期間傳遞的選項名稱 |
---|
public function getPassedOptions()
{
return $this->_passedOptions;
}
定義於: yii\base\Controller::getRoute()
傳回當前請求的路由。
public string getRoute ( ) | ||
return | string |
目前請求的路由(模組 ID、控制器 ID 和動作 ID)。 |
---|
public function getRoute()
{
return $this->action !== null ? $this->action->getUniqueId() : $this->getUniqueId();
}
定義於: 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;
}
定義於: 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;
}
定義於: yii\base\Controller::getViewPath()
傳回包含此控制器視圖檔案的目錄。
public string getViewPath ( ) | ||
return | string |
包含此控制器視圖檔案的目錄。 |
---|
public function getViewPath()
{
if ($this->_viewPath === null) {
$this->_viewPath = $this->module->getViewPath() . DIRECTORY_SEPARATOR . $this->id;
}
return $this->_viewPath;
}
定義於: 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);
}
定義於: 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;
}
定義於: 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);
}
public void init ( ) |
public function init()
{
parent::init();
$this->request = Instance::ensure($this->request, Request::className());
$this->response = Instance::ensure($this->response, Response::className());
}
定義於: 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;
}
建立來源資源包的完整列表。
protected yii\web\AssetBundle[] loadBundles ( $bundles ) | ||
$bundles | string[] |
資源包名稱列表 |
return | yii\web\AssetBundle[] |
來源資源包列表。 |
---|
protected function loadBundles($bundles)
{
$this->stdout("Collecting source bundles information...\n");
$am = $this->getAssetManager();
$result = [];
foreach ($bundles as $name) {
$result[$name] = $am->getBundle($name);
}
foreach ($result as $bundle) {
$this->loadDependency($bundle, $result);
}
return $result;
}
將給定檔案中的組態套用到自身實例。
protected void loadConfiguration ( $configFile ) | ||
$configFile | string |
組態檔案名稱。 |
throws | yii\console\Exception |
失敗時。 |
---|
protected function loadConfiguration($configFile)
{
$this->stdout("Loading configuration from '{$configFile}'...\n");
$config = require $configFile;
foreach ($config as $name => $value) {
if (property_exists($this, $name) || $this->canSetProperty($name)) {
$this->$name = $value;
} else {
throw new Exception("Unknown configuration option: $name");
}
}
$this->getAssetManager(); // check if asset manager configuration is correct
}
遞迴載入資源包依賴項。
protected void loadDependency ( $bundle, &$result ) | ||
$bundle | yii\web\AssetBundle |
Bundle instance |
$result | array |
Already loaded bundles list. |
throws | yii\console\Exception |
失敗時。 |
---|
protected function loadDependency($bundle, &$result)
{
$am = $this->getAssetManager();
foreach ($bundle->depends as $name) {
if (!isset($result[$name])) {
$dependencyBundle = $am->getBundle($name);
$result[$name] = false;
$this->loadDependency($dependencyBundle, $result);
$result[$name] = $dependencyBundle;
} elseif ($result[$name] === false) {
throw new Exception("A circular dependency is detected for bundle '{$name}': " . $this->composeCircularDependencyTrace($name, $result) . '.');
}
}
}
建立輸出資源包的完整列表。
protected yii\web\AssetBundle[] loadTargets ( $targets, $bundles ) | ||
$targets | array |
輸出資源包配置。 |
$bundles | yii\web\AssetBundle[] |
來源資源包列表。 |
return | yii\web\AssetBundle[] |
輸出資源包列表。 |
---|---|---|
throws | yii\console\Exception |
失敗時。 |
protected function loadTargets($targets, $bundles)
{
// build the dependency order of bundles
$registered = [];
foreach ($bundles as $name => $bundle) {
$this->registerBundle($bundles, $name, $registered);
}
$bundleOrders = array_combine(array_keys($registered), range(0, count($bundles) - 1));
// fill up the target which has empty 'depends'.
$referenced = [];
foreach ($targets as $name => $target) {
if (empty($target['depends'])) {
if (!isset($all)) {
$all = $name;
} else {
throw new Exception("Only one target can have empty 'depends' option. Found two now: $all, $name");
}
} else {
foreach ($target['depends'] as $bundle) {
if (!isset($referenced[$bundle])) {
$referenced[$bundle] = $name;
} else {
throw new Exception("Target '{$referenced[$bundle]}' and '$name' cannot contain the bundle '$bundle' at the same time.");
}
}
}
}
if (isset($all)) {
$targets[$all]['depends'] = array_diff(array_keys($registered), array_keys($referenced));
}
// adjust the 'depends' order for each target according to the dependency order of bundles
// create an AssetBundle object for each target
foreach ($targets as $name => $target) {
if (!isset($target['basePath'])) {
throw new Exception("Please specify 'basePath' for the '$name' target.");
}
if (!isset($target['baseUrl'])) {
throw new Exception("Please specify 'baseUrl' for the '$name' target.");
}
usort($target['depends'], function ($a, $b) use ($bundleOrders) {
if ($bundleOrders[$a] == $bundleOrders[$b]) {
return 0;
}
return $bundleOrders[$a] > $bundleOrders[$b] ? 1 : -1;
});
if (!isset($target['class'])) {
$target['class'] = $name;
}
$targets[$name] = Yii::createObject($target);
}
return $targets;
}
定義於: 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;
}
將事件處理常式附加到事件。
事件處理常式必須是有效的 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]);
}
}
public array optionAliases ( ) | ||
return | array |
適用於動作的選項別名名稱,其中鍵是選項的別名名稱,值是選項名稱。 |
---|
public function optionAliases()
{
return [
'h' => 'help',
];
}
定義於: 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'];
}
定義於: 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 '';
}
定義於: 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 '';
}
定義於: 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;
}
定義於: yii\console\Controller::prompt()
提示使用者輸入並驗證輸入。
public string prompt ( $text, $options = [] ) | ||
$text | string |
提示字串 |
$options | array |
驗證輸入的選項
如何使用帶有驗證器函數的 prompt 方法的範例。
|
return | string |
使用者輸入 |
---|
public function prompt($text, $options = [])
{
if ($this->interactive) {
return Console::prompt($text, $options);
}
return isset($options['default']) ? $options['default'] : '';
}
註冊資源包,包括其依賴項。
protected void registerBundle ( $bundles, $name, &$registered ) | ||
$bundles | yii\web\AssetBundle[] |
資源包列表。 |
$name | string |
資源包名稱。 |
$registered | array |
儲存已註冊的名稱。 |
throws | yii\console\Exception |
如果偵測到循環依賴。 |
---|
protected function registerBundle($bundles, $name, &$registered)
{
if (!isset($registered[$name])) {
$registered[$name] = false;
$bundle = $bundles[$name];
foreach ($bundle->depends as $depend) {
$this->registerBundle($bundles, $depend, $registered);
}
unset($registered[$name]);
$registered[$name] = $bundle;
} elseif ($registered[$name] === false) {
throw new Exception("A circular dependency is detected for target '{$name}': " . $this->composeCircularDependencyTrace($name, $registered) . '.');
}
}
定義於: yii\base\Controller::render()
呈現視圖並在可用時套用版面配置。
要渲染的視圖可以使用以下格式之一指定
- `路徑別名` (例如 "@app/views/site/index");
- 應用程式內的絕對路徑 (例如 "//site/index"):視圖名稱以雙斜線開頭。實際的視圖檔案將在應用程式的 `視圖路徑` 下查找。
- 模組內的絕對路徑 (例如 "/site/index"):視圖名稱以單斜線開頭。實際的視圖檔案將在 `$module` 的 `視圖路徑` 下查找。
- 相對路徑 (例如 "index"):實際的視圖檔案將在 `$viewPath` 下查找。
為了確定應套用哪個佈局,將執行以下兩個步驟
- 在第一步中,它確定佈局名稱和上下文模組
- 如果 `$layout` 指定為字串,則將其用作佈局名稱,並將 `$module` 用作上下文模組;
- 如果 `$layout` 為 null,則搜尋此控制器的所有祖先模組,並找到第一個 `layout` 不為 null 的模組。佈局和對應的模組分別用作佈局名稱和上下文模組。如果找不到這樣的模組,或者對應的佈局不是字串,它將返回 false,表示沒有適用的佈局。
- 在第二步中,它根據先前找到的佈局名稱和上下文模組確定實際的佈局檔案。佈局名稱可以是
- `路徑別名` (例如 "@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);
}
定義於: yii\base\Controller::renderContent()
透過套用版面配置來呈現靜態字串。
public string renderContent ( $content ) | ||
$content | string |
正在呈現的靜態字串 |
return | string |
使用給定的靜態字串作為 |
---|
public function renderContent($content)
{
$layoutFile = $this->findLayoutFile($this->getView());
if ($layoutFile !== false) {
return $this->getView()->renderFile($layoutFile, ['content' => $content], $this);
}
return $content;
}
定義於: 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);
}
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);
}
定義於: 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);
}
定義於: 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);
}
儲存新的資源包組態。
protected void saveTargets ( $targets, $bundleFile ) | ||
$targets | yii\web\AssetBundle[] |
要儲存的資源包列表。 |
$bundleFile | string |
輸出檔案名稱。 |
throws | yii\console\Exception |
失敗時。 |
---|
protected function saveTargets($targets, $bundleFile)
{
$array = [];
foreach ($targets as $name => $target) {
if (isset($this->targets[$name])) {
$array[$name] = array_merge($this->targets[$name], [
'class' => get_class($target),
'sourcePath' => null,
'basePath' => $this->targets[$name]['basePath'],
'baseUrl' => $this->targets[$name]['baseUrl'],
'js' => $target->js,
'css' => $target->css,
'depends' => [],
]);
} else {
if ($this->isBundleExternal($target)) {
$array[$name] = $this->composeBundleConfig($target);
} else {
$array[$name] = [
'sourcePath' => null,
'js' => [],
'css' => [],
'depends' => $target->depends,
];
}
}
}
$array = VarDumper::export($array);
$version = date('Y-m-d H:i:s');
$bundleFileContent = <<<EOD
p
his file is generated by the "yii {$this->id}" command.
O NOT MODIFY THIS FILE DIRECTLY.
version {$version}
rn {$array};
if (!file_put_contents($bundleFile, $bundleFileContent, LOCK_EX)) {
throw new Exception("Unable to write output bundle configuration at '{$bundleFile}'.");
}
$this->stdout("Output bundle configuration created at '{$bundleFile}'.\n", Console::FG_GREEN);
}
定義於: yii\console\Controller::select()
讓使用者選擇一個選項。輸入 '?' 將顯示可供選擇的選項列表及其說明。
public string select ( $prompt, $options = [], $default = null ) | ||
$prompt | string |
提示訊息 |
$options | array |
要從中選擇的選項的鍵值陣列 |
$default | string|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;
}
設定資源管理器實例或組態。
public void setAssetManager ( $assetManager ) | ||
$assetManager | yii\web\AssetManager|array |
資源管理器實例或其陣列配置。 |
throws | yii\console\Exception |
在無效的參數類型時。 |
---|
public function setAssetManager($assetManager)
{
if (is_scalar($assetManager)) {
throw new Exception('"' . get_class($this) . '::assetManager" should be either object or array - "' . gettype($assetManager) . '" given.');
}
$this->_assetManager = $assetManager;
}
定義於: yii\base\Controller::setView()
設定要由此控制器使用的視圖物件。
public void setView ( $view ) | ||
$view | yii\base\View|yii\web\View |
可用於呈現視圖或視圖檔案的視圖物件。 |
public function setView($view)
{
$this->_view = $view;
}
定義於: yii\base\Controller::setViewPath()
設定包含視圖檔案的目錄。
public void setViewPath ( $path ) | ||
$path | string |
視圖檔案的根目錄。 |
throws | yii\base\InvalidArgumentException |
如果目錄無效 |
---|
public function setViewPath($path)
{
$this->_viewPath = Yii::getAlias($path);
}
定義於: 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);
}
定義於: 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);
}
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);
}
註冊 或 登入 以發表評論。