Класс yii\console\controllers\ServeController
| Наследование | yii\console\controllers\ServeController » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\base\ViewContextInterface |
| Доступна с версии | 2.0.7 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/console/controllers/ServeController.php |
Запускает встроенный веб-сервер PHP
Для доступа к серверу с удаленных машин используйте 0.0.0.0:8000. Это особенно полезно при запуске сервера в виртуальной машине.
Публичные свойства
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| $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 |
| $docroot | string | Путь или псевдоним пути к каталогу для обработки | yii\console\controllers\ServeController |
| $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 |
| $port | integer | Порт для обработки. | yii\console\controllers\ServeController |
| $route | string | Маршрут (ID модуля, ID контроллера и ID действия) текущего запроса. | yii\base\Controller |
| $router | string | Путь к скрипту маршрутизатора. | yii\console\controllers\ServeController |
| $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() | Запускает встроенный веб-сервер PHP | yii\console\controllers\ServeController |
| 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\controllers\ServeController |
| options() | Возвращает имена допустимых параметров для действия (id). Параметр требует наличия открытого члена-переменной, имя которого соответствует имени параметра. | yii\console\controllers\ServeController |
| 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 | |
| isAddressTaken() | yii\console\controllers\ServeController | |
| parseDocCommentDetail() | Возвращает полное описание из блока документации. | yii\console\Controller |
| parseDocCommentSummary() | Возвращает первую строку блока документации. | 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_ADDRESS_TAKEN_BY_ANOTHER_PROCESS | 5 | yii\console\controllers\ServeController | |
| EXIT_CODE_ADDRESS_TAKEN_BY_ANOTHER_SERVER | 4 | yii\console\controllers\ServeController | |
| EXIT_CODE_ERROR | 1 | yii\console\Controller | |
| EXIT_CODE_NORMAL | 0 | yii\console\Controller | |
| EXIT_CODE_NO_DOCUMENT_ROOT | 2 | yii\console\controllers\ServeController | |
| EXIT_CODE_NO_ROUTING_FILE | 3 | yii\console\controllers\ServeController |
Подробности свойств
$docroot открытое свойство
Путь или псевдоним пути к каталогу для обработки
public string $docroot = '@app/web'
$port открытое свойство
Порт для обработки.
public integer $port = 8080
$router открытое свойство
Путь к скрипту маршрутизатора. См. https://secure.php.net/manual/en/features.commandline.webserver.php
public string $router = null
Подробности методов
actionIndex() открытый метод
Выполняет встроенный веб-сервер PHP
| public integer actionIndex ( $address = 'localhost' ) | ||
|---|---|---|
| $address | string |
Адрес для обработки. Может быть "хост" или "хост:порт". |
isAddressTaken() защищенный метод
| protected boolean isAddressTaken ( $address ) | ||
|---|---|---|
| $address | string |
Адрес сервера |
| return | boolean |
Если адрес уже используется |
optionAliases() открытый метод (доступен начиная с версии 2.0.8)
Возвращает псевдонимы параметров.
Подклассы могут переопределить этот метод для указания псевдонимов параметров.
| public array optionAliases ( ) | ||
|---|---|---|
| return | array |
Псевдонимы параметров, допустимые для действия, где ключ — псевдоним параметра, а значение — имя параметра. |
options() открытый метод
Возвращает имена допустимых параметров для действия (id). Параметр требует наличия открытого члена-переменной, имя которого соответствует имени параметра.
Подклассы могут переопределить этот метод для указания возможных параметров.
Обратите внимание, что значения, установленные через параметры, недоступны до вызова beforeAction().
| public string[] options ( $actionID ) | ||
|---|---|---|
| $actionID | string |
Идентификатор действия текущего запроса |
| return | string[] |
Имена параметров, допустимых для действия |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-console-controllers-servecontroller.html
