HelpCommand.php 1.97 KB
Newer Older
Alexander Makarov committed
1 2
<?php
/**
Alexander Makarov committed
3
 * HelpCommand class file.
Alexander Makarov committed
4 5 6
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @link http://www.yiiframework.com/
Alexander Makarov committed
7
 * @copyright Copyright &copy; 2008-2012 Yii Software LLC
Alexander Makarov committed
8 9 10 11 12 13
 * @license http://www.yiiframework.com/license/
 */

namespace yii\console;

/**
Alexander Makarov committed
14
 * HelpCommand represents a console help command.
Alexander Makarov committed
15
 *
Alexander Makarov committed
16
 * HelpCommand displays the available command list or the help instructions
Alexander Makarov committed
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
 * about a specific command.
 *
 * To use this command, enter the following on the command line:
 * <pre>
 * php path/to/entry_script.php help [command name]
 * </pre>
 * In the above, if the command name is not provided, it will display all
 * available commands.
 *
 * @property string $help The command description.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class HelpCommand extends Command
{
	/**
	 * Execute the action.
	 * @param array $args command line parameters specific for this command
	 */
	public function run($args)
	{
		$runner=$this->getCommandRunner();
		$commands=$runner->commands;
		if(isset($args[0]))
		{
			$name=strtolower($args[0]);
		}
		if(!isset($args[0]) || !isset($commands[$name]))
		{
			if(!empty($commands))
			{
				echo "Yii command runner (based on Yii v".\Yii::getVersion().")\n";
				echo "Usage: ".$runner->getScriptName()." <command-name> [parameters...]\n";
				echo "\nThe following commands are available:\n";
				$commandNames=array_keys($commands);
				sort($commandNames);
				echo ' - '.implode("\n - ",$commandNames);
				echo "\n\nTo see individual command help, use the following:\n";
				echo "   ".$runner->getScriptName()." help <command-name>\n";
Qiang Xue committed
57
			} else
Alexander Makarov committed
58 59 60 61 62
			{
				echo "No available commands.\n";
				echo "Please define them under the following directory:\n";
				echo "\t".\Yii::$app->getCommandPath()."\n";
			}
Qiang Xue committed
63
		} else
Alexander Makarov committed
64 65 66 67 68 69 70 71 72 73 74 75
			echo $runner->createCommand($name)->getHelp();
	}

	/**
	 * Provides the command description.
	 * @return string the command description.
	 */
	public function getHelp()
	{
		return parent::getHelp().' [command-name]';
	}
}