php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-08-20 10:27:18 +08:00
Code Issues Packages Projects Releases Wiki Activity

console HelpController use correct script name

Browse Source
This commit is contained in:
Carsten Brandt
2014-01-05 22:13:24 +01:00
parent f8938a2b12
commit 60db9518f0
1 changed files with 15 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
framework/yii/console/controllers/HelpController.php
View File

@ -42,11 +42,6 @@ class HelpController extends Controller
* Displays available commands or the detailed information * Displays available commands or the detailed information
* about a particular command. For example, * about a particular command. For example,
* *
* ~~~
* yii help # list available commands
* yii help message # display help info about "message"
* ~~~
*
* @param string $command The name of the command to show help about. * @param string $command The name of the command to show help about.
* If not provided, all available commands will be displayed. * If not provided, all available commands will be displayed.
* @return integer the exit status * @return integer the exit status
@ -149,8 +144,9 @@ class HelpController extends Controller
foreach ($commands as $command) { foreach ($commands as $command) {
echo "- " . $this->ansiFormat($command, Console::FG_YELLOW) . "\n"; echo "- " . $this->ansiFormat($command, Console::FG_YELLOW) . "\n";
} }
$scriptName = $this->getScriptName();
$this->stdout("\nTo see the help of each command, enter:\n", Console::BOLD); $this->stdout("\nTo see the help of each command, enter:\n", Console::BOLD);
echo "\n yii " . $this->ansiFormat('help', Console::FG_YELLOW) . ' ' echo "\n $scriptName " . $this->ansiFormat('help', Console::FG_YELLOW) . ' '
. $this->ansiFormat('<command-name>', Console::FG_CYAN) . "\n\n"; . $this->ansiFormat('<command-name>', Console::FG_CYAN) . "\n\n";
} else { } else {
$this->stdout("\nNo commands are found.\n\n", Console::BOLD); $this->stdout("\nNo commands are found.\n\n", Console::BOLD);
@ -189,8 +185,9 @@ class HelpController extends Controller
} }
echo "\n"; echo "\n";
} }
$scriptName = $this->getScriptName();
echo "\nTo see the detailed information about individual sub-commands, enter:\n"; echo "\nTo see the detailed information about individual sub-commands, enter:\n";
echo "\n yii " . $this->ansiFormat('help', Console::FG_YELLOW) . ' ' echo "\n $scriptName " . $this->ansiFormat('help', Console::FG_YELLOW) . ' '
. $this->ansiFormat('<sub-command>', Console::FG_CYAN) . "\n\n"; . $this->ansiFormat('<sub-command>', Console::FG_CYAN) . "\n\n";
} }
} }
@ -261,10 +258,11 @@ class HelpController extends Controller
} }
$this->stdout("\nUSAGE\n\n", Console::BOLD); $this->stdout("\nUSAGE\n\n", Console::BOLD);
$scriptName = $this->getScriptName();
if ($action->id === $controller->defaultAction) { if ($action->id === $controller->defaultAction) {
echo 'yii ' . $this->ansiFormat($controller->getUniqueId(), Console::FG_YELLOW); echo $scriptName . ' ' . $this->ansiFormat($controller->getUniqueId(), Console::FG_YELLOW);
} else { } else {
echo 'yii ' . $this->ansiFormat($action->getUniqueId(), Console::FG_YELLOW); echo $scriptName . ' ' . $this->ansiFormat($action->getUniqueId(), Console::FG_YELLOW);
} }
list ($required, $optional) = $this->getArgHelps($method, isset($tags['param']) ? $tags['param'] : []); list ($required, $optional) = $this->getArgHelps($method, isset($tags['param']) ? $tags['param'] : []);
foreach ($required as $arg => $description) { foreach ($required as $arg => $description) {
@ -425,4 +423,12 @@ class HelpController extends Controller
$name = $required ? "$name (required)" : $name; $name = $required ? "$name (required)" : $name;
return $doc === '' ? $name : "$name: $doc"; return $doc === '' ? $name : "$name: $doc";
} }
/**
* @return string the name of the cli script currently running.
*/
protected function getScriptName()
{
return basename(Yii::$app->request->scriptFile);
}
} }