Класс yii\shell\ShellController
| Наследование | yii\shell\ShellController » 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-shell/blob/master/ShellController.php |
Запускает интерактивную оболочку. Это особенно полезно при разработке приложения, когда вы хотите попробовать какой-либо метод вашего кода.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $action | yii\base\Action | Действие, которое в данный момент выполняется. | yii\base\Controller |
| $behaviors | yii\base\Behavior[] | Список поведений, прикреплённых к этому компоненту | yii\base\Component |
| $color | boolean | Включает ли ANSI цвет в выводе. | yii\console\Controller |
| $defaultAction | string | Идентификатор действия, используемый, когда идентификатор действия не указан в запросе. | yii\base\Controller |
| $help | boolean | Выводить ли справку о текущей команде. | yii\console\Controller |
| $helpSummary | string | yii\console\Controller | |
| $id | string | Идентификатор этого контроллера. | yii\base\Controller |
| $include | array | Включать файлы перед запуском оболочки tinker | yii\shell\ShellController |
| $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 | Идентификатор контроллера, дополненный идентификатором модуля (если имеется). | 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\shell\ShellController |
| 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 |
| getBehavior() | Возвращает объект именованного поведения. | yii\base\Component |
| getBehaviors() | Возвращает все присоединенные к этому компоненту поведения. | yii\base\Component |
| 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\shell\ShellController |
| 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 |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| getActionMethodReflection() | yii\console\Controller | |
| getCasters() | yii\shell\ShellController | |
| parseDocCommentDetail() | Возвращает полное описание из docblock. | yii\console\Controller |
| parseDocCommentSummary() | Возвращает первую строку docblock. | yii\console\Controller |
| parseDocCommentTags() | Разбирает блок комментариев на теги. | yii\console\Controller |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| 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 |
Подробности свойств
$include общедоступное свойство
Включаемый файл(ы) перед запуском интерпретатора tinker shell
public array $include = []
Подробности методов
actionIndex() общедоступный метод
Запускает интерактивную оболочку
| public void actionIndex ( ) |
|---|
getCasters() защищенный метод
| protected массив getCasters ( ) | ||
|---|---|---|
| return | массив |
Конвертеры для psysh |
options() общедоступный метод
Возвращает имена допустимых опций для действия (id) Опция требует наличия общедоступной переменной члена, имя которой совпадает с именем опции.
Подклассы могут переопределять этот метод для указания возможных опций.
Обратите внимание, что значения, установленные с помощью опций, недоступны до тех пор, пока не будет вызвано beforeAction().
| public строка[] options ( $actionID ) | ||
|---|---|---|
| $actionID | строка |
Идентификатор действия текущего запроса |
| return | строка[] |
Имена опций, допустимых для действия |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-shell-shellcontroller.html
