Класс yii\console\controllers\HelpController

Все классы | Свойства | Методы | События | Константы

Наследование	yii\console\controllers\HelpController » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\Object
Реализует	yii\base\Configurable, yii\base\ViewContextInterface
Доступна с версии	2.0
Исходный код	https://github.com/yiisoft/yii2/blob/master/framework/console/controllers/HelpController.php

Предоставляет справочную информацию о консольных командах.

Эта команда отображает список доступных команд в приложении или подробные инструкции по использованию конкретной команды.

Эту команду можно использовать следующим образом в командной строке:

yii help [command name]

Если имя команды не указано, будут отображены все доступные команды.

Публичные свойства

Свойство	Тип	Описание	Определено
$action	yii\base\Action	Действие, которое выполняется в данный момент.	yii\base\Controller
$behaviors	yii\base\Behavior[]	Список присоединенных к этому компоненту поведений.	yii\base\Component
$color	boolean	Включить ANSI-цвет в выводе.	yii\console\Controller
$commands	array	Все доступные имена команд.	yii\console\controllers\HelpController
$defaultAction	string	Идентификатор действия, используемого, когда идентификатор действия не указан в запросе.	yii\base\Controller
$help	boolean	Отображать ли справочную информацию о текущей команде.	yii\console\Controller
$helpSummary	string		yii\console\Controller
$id	string	Идентификатор этого контроллера.	yii\base\Controller
$interactive	boolean	Выполнять ли команду в интерактивном режиме.	yii\console\Controller
$layout	null\|string\|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
$route	string	Путь (ID модуля, ID контроллера и ID действия) текущего запроса.	yii\base\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\Object
__clone()	Этот метод вызывается после создания объекта путём клонирования существующего.	yii\base\Component
__construct()		yii\base\Controller
__get()	Возвращает значение свойства объекта.	yii\base\Object
__isset()	Проверяет, установлено ли свойство, т.е. определено и не равно null.	yii\base\Object
__set()	Устанавливает значение свойства объекта.	yii\base\Object
__unset()	Устанавливает свойство объекта в значение null.	yii\base\Object
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\base\Controller
behaviors()	Возвращает список поведений, по которым этот компонент должен вести себя.	yii\base\Component
bindActionParams()	Привязывает параметры к действию.	yii\console\Controller
canGetProperty()	Возвращает значение, указывающее, можно ли читать свойство.	yii\base\Object
canSetProperty()	Возвращает значение, указывающее, можно ли установить свойство.	yii\base\Object
className()	Возвращает полное квалифицированное имя этого класса.	yii\base\Object
confirm()	Просит пользователя подтвердить, введя y или n.	yii\console\Controller
createAction()	Создаёт действие на основе заданного идентификатора действия.	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()	Возвращает свойства, соответствующие опциям для идентификатора действия. Дочерние классы могут переопределить этот метод для указания возможных свойств.	yii\console\Controller
getPassedOptionValues()	Возвращает свойства, соответствующие переданным опциям.	yii\console\Controller
getPassedOptions()	Возвращает имена допустимых опций, переданных во время выполнения.	yii\console\Controller
getRoute()	Возвращает маршрут текущего запроса.	yii\base\Controller
getUniqueId()	Возвращает уникальный идентификатор контроллера.	yii\base\Controller
getView()	Возвращает объект представления, который можно использовать для рендеринга представлений или файлов представлений.	yii\base\Controller
getViewPath()	Возвращает каталог, содержащий файлы представлений для этого контроллера.	yii\base\Controller
hasEventHandlers()	Возвращает значение, указывающее, присоединён ли какой-либо обработчик к названному событию.	yii\base\Component
hasMethod()	Возвращает значение, указывающее, определён ли метод.	yii\base\Object

hasProperty()	Возвращает значение, указывающее, определён ли свойство.	yii\base\Object
init()	Инициализирует объект.	yii\base\Object
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()	Выполняет действие с указанным идентификатором действия и параметрами.	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

Защищенные методы

Метод	Описание	Определено в
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		yii\console\Controller
EXIT_CODE_NORMAL	0		yii\console\Controller

Подробное описание свойств

$commands публичное только для чтения свойство

Все доступные имена команд

public array getCommands ( )

Подробное описание методов

actionIndex() public method

Отображает доступные команды или подробную информацию о конкретной команде.

public integer actionIndex ( $command = null )
$command	string	Имя команды, о которой нужно показать справку. Если не указано, будут отображены все доступные команды.
return	integer	Код завершения
throws	yii\console\Exception	если команда для справки неизвестна

actionList() public method (доступно начиная с версии 2.0.11)

Выводит список всех доступных контроллеров и действий в формате, читаемом машиной.

Используется для автодополнения командной строки.

public void actionList ( )

actionListActionOptions() public method (доступно начиная с версии 2.0.11)

Выводит список всех доступных опций для действия $action в формате, читаемом машиной.

Используется для автодополнения командной строки.

public void actionListActionOptions ( $action )
$action	string	Путь к действию

actionUsage() public method (доступно начиная с версии 2.0.11)

Отображает информацию об использовании действия $action

public void actionUsage ( $action )
$action	string	Путь к действию

formatOptionAliases() protected method (доступно начиная с версии 2.0.8)

protected string formatOptionAliases ( $controller, $option )
$controller	yii\console\Controller	Экземпляр контроллера
$option	string	Название опции
return	string	Отформатированная строка для аргумента или опции

formatOptionHelp() protected method

Генерирует отформатированную строку для аргумента или опции.

protected string formatOptionHelp ( $name, $required, $type, $defaultValue, $comment )
$name	string	Название аргумента или опции
$required	boolean	Требуется ли аргумент
$type	string	Тип опции или аргумента
$defaultValue	mixed	Значение по умолчанию опции или аргумента
$comment	string	Комментарий к опции или аргументу
return	string	Отформатированная строка для аргумента или опции

getActions() public method

Возвращает все доступные действия указанного контроллера.

public array getActions ( $controller )
$controller	yii\console\Controller	Экземпляр контроллера
return	array	Все доступные идентификаторы действий.

getCommandDescriptions() protected method

Возвращает массив команд и их описаний.

protected array getCommandDescriptions ( )
return	array	Все доступные команды в качестве ключей и их описания в качестве значений.

getCommandHelp() protected method

Отображает общую информацию о команде.

protected void getCommandHelp ( $controller )
$controller	yii\console\Controller	Экземпляр контроллера

getCommands() public method

Возвращает все доступные имена команд.

public array getCommands ( )
return	array	Все доступные имена команд

getDefaultHelp() protected method

Отображает все доступные команды.

protected void getDefaultHelp ( )

getDefaultHelpHeader() protected method (доступно начиная с версии 2.0.11)

Возвращает заголовок справки по умолчанию.

protected string getDefaultHelpHeader ( )
return	string	Заголовок справки по умолчанию.

getModuleCommands() protected method

Возвращает доступные команды указанного модуля.

protected array getModuleCommands ( $module )
$module	yii\base\Module	Экземпляр модуля
return	array	Доступные имена команд

getScriptName() protected method

protected string getScriptName ( )
return	string	Имя скрипта командной строки, который выполняется в данный момент.

getSubCommandHelp() protected method

Отображает подробную информацию о действии команды.

protected void getSubCommandHelp ( $controller, $actionID )
$controller	yii\console\Controller	Экземпляр контроллера
$actionID	string	Идентификатор действия
throws	yii\console\Exception	если действие не существует

validateControllerClass() protected method

Проверяет, является ли данный класс допустимым классом контроллера консоли.

protected boolean validateControllerClass ( $controllerClass )
$controllerClass	string

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-console-controllers-helpcontroller.html