CHelpCommand
| Пакет | system.console |
|---|---|
| Наследование | class CHelpCommand » CConsoleCommand » CComponent |
| С момента | 1.0 |
| Исходный код | framework/console/CHelpCommand.php |
CHelpCommand представляет команду консоли для вывода справки.
CHelpCommand отображает список доступных команд или инструкции по конкретной команде.
Для использования этой команды введите следующее в командной строке:
CHelpCommand отображает список доступных команд или инструкции по конкретной команде.
Для использования этой команды введите следующее в командной строке:
php path/to/entry_script.php help [command name]В случае, если имя команды не указано, будут отображены все доступные команды.
Общедоступные свойства
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| commandRunner | CConsoleCommandRunner | экземпляр обработчика команд | CConsoleCommand |
| defaultAction | строка | имя по умолчанию действия. | CConsoleCommand |
| help | строка | Предоставляет описание команды. | CHelpCommand |
| name | строка | имя команды. | CConsoleCommand |
| optionHelp | массив | Предоставляет информацию о справке опций команды. | CConsoleCommand |
Общедоступные методы
| Метод | Описание | Определено |
|---|---|---|
| __call() | Вызывает метод, который не является методом класса. | CComponent |
| __construct() | Конструктор. | CConsoleCommand |
| __get() | Возвращает значение свойства, список обработчиков событий или поведение на основе его имени. | CComponent |
| __isset() | Проверяет, является ли значение свойства нулевым. | CComponent |
| __set() | Устанавливает значение свойства компонента. | CComponent |
| __unset() | Устанавливает свойство компонента в значение null. | CComponent |
| asa() | Возвращает объект поведения с заданным именем. | CComponent |
| attachBehavior() | Прикрепляет поведение к этому компоненту. | CComponent |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | CComponent |
| attachEventHandler() | Прикрепляет обработчик событий к событию. | CComponent |
| behaviors() | Возвращает список поведений, которые должна иметь эта команда. | CConsoleCommand |
| buildFileList() | Создает список файлов в каталоге. | CConsoleCommand |
| canGetProperty() | Определяет, может ли свойство быть прочитано. | CComponent |
| canSetProperty() | Определяет, может ли свойство быть установлено. | CComponent |
| confirm() | Запрашивает у пользователя подтверждение, введя y или n. | CConsoleCommand |
| copyFiles() | Копирует список файлов из одного места в другое. | CConsoleCommand |
| detachBehavior() | Отсоединяет поведение от компонента. | CComponent |
| detachBehaviors() | Отсоединяет все поведения от компонента. | CComponent |
| detachEventHandler() | Отсоединяет существующий обработчик событий. | CComponent |
| disableBehavior() | Отключает присоединенное поведение. | CComponent |
| disableBehaviors() | Отключает все поведения, прикрепленные к этому компоненту. | CComponent |
| enableBehavior() | Включает присоединенное поведение. | CComponent |
| enableBehaviors() | Включает все прикрепленные поведения к этому компоненту. | CComponent |
| ensureDirectory() | Создает все родительские каталоги, если они не существуют. | CConsoleCommand |
| evaluateExpression() | Вычисляет выражение PHP или обратный вызов в контексте этого компонента. | CComponent |
| getCommandRunner() | Возвращает экземпляр обработчика команд | CConsoleCommand |
| getEventHandlers() | Возвращает список прикрепленных обработчиков событий для события. | CComponent |
| getHelp() | Предоставляет описание команды. | CHelpCommand |
| getName() | Возвращает имя команды. | CConsoleCommand |
| getOptionHelp() | Предоставляет информацию о справке опций команды. | CConsoleCommand |
| hasEvent() | Определяет, определено ли событие. | CComponent |
| hasEventHandler() | Проверяет, есть ли прикрепленные обработчики к указанному событию. | CComponent |
| hasProperty() | Определяет, определено ли свойство. | CComponent |
| init() | Инициализирует объект команды. | CConsoleCommand |
| onAfterAction() | Это событие генерируется после завершения выполнения действия. | CConsoleCommand |
| onBeforeAction() | Это событие генерируется перед выполнением действия. | CConsoleCommand |
| pluralize() | Преобразует слово в его множественное число. | CConsoleCommand |
| prompt() | Считывает ввод через расширение readline PHP, если оно доступно, или fgets(), если readline не установлен. | CConsoleCommand |
| raiseEvent() | Генерирует событие. | CComponent |
| renderFile() | Отображает файл представления. | CConsoleCommand |
| run() | Выполнить действие. | CHelpCommand |
| usageError() | Отображает ошибку использования. | CConsoleCommand |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| afterAction() | Этот метод вызывается сразу после завершения выполнения действия. | CConsoleCommand |
| beforeAction() | Этот метод вызывается непосредственно перед выполнением действия. | CConsoleCommand |
| resolveRequest() | Парсит аргументы командной строки и определяет, какое действие выполнить. | CConsoleCommand |
События
| Событие | Описание | Определено в |
|---|---|---|
| onBeforeAction | Это событие срабатывает перед выполнением действия. | CConsoleCommand |
| onAfterAction | Это событие срабатывает после завершения выполнения действия. | CConsoleCommand |
Подробное описание свойств
help свойство только для чтения
public string getHelp()
Предоставляет описание команды.
Подробное описание методов
getHelp() метод
public string getHelp() | ||
| {return} | строка | описание команды. |
Исходный код: framework/console/CHelpCommand.php#72 (показать)
public function getHelp()
{
return parent::getHelp().' [command-name]';
}
Предоставляет описание команды.
run() метод
public integer run(array $args) | ||
| $args | массив | параметры командной строки, специфичные для этой команды |
| {return} | целое число | код завершения приложения, отличный от нуля, после вывода справки |
Исходный код: framework/console/CHelpCommand.php#37 (показать)
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";
}
else
{
echo "No available commands.\n";
echo "Please define them under the following directory:\n";
echo "\t".Yii::app()->getCommandPath()."\n";
}
}
else
echo $runner->createCommand($name)->getHelp();
return 1;
}
Выполнить действие.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CHelpCommand