Класс yii\console\Request
| Наследование | yii\console\Request » yii\base\Request » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/console/Request.php |
Запрос консоли Request представляет информацию об окружении консольного приложения.
Это обертка для переменной PHP $_SERVER , которая содержит информацию о текущей выполняемой скрипте PHP и аргументах командной строки, переданных ей.
Открытые свойства
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список прикрепленных к этому компоненту поведений | yii\base\Component |
| $isConsoleRequest | boolean | Значение, указывающее, сделан ли текущий запрос через консоль | yii\base\Request |
| $params | массив | Аргументы командной строки. | yii\console\Request |
| $scriptFile | строка | Путь к файлу скрипта входа (обработан с помощью realpath()) | yii\base\Request |
Открытые методы
| Метод | Описание | Определено |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путем клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| attachBehavior() | Прикрепляет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | yii\base\Component |
| behaviors() | Возвращает список поведений, по которым должен вести себя этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, может ли свойство быть прочитано. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, может ли свойство быть установлено. | yii\base\Object |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), прикреплены к этому компоненту. | yii\base\Component |
| getBehavior() | Возвращает объект поведения с указанным именем. | yii\base\Component |
| getBehaviors() | Возвращает все прикрепленные к этому компоненту поведения. | yii\base\Component |
| getIsConsoleRequest() | Возвращает значение, указывающее, сделан ли текущий запрос через командную строку | yii\base\Request |
| getParams() | Возвращает аргументы командной строки. | yii\console\Request |
| getScriptFile() | Возвращает путь к файлу скрипта входа. | yii\base\Request |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, прикрепленный к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Прикрепляет обработчик событий к событию. | yii\base\Component |
| resolve() | Разрешает текущий запрос в маршрут и связанные параметры. | yii\console\Request |
| setIsConsoleRequest() | Устанавливает значение, указывающее, сделан ли текущий запрос через командную строку | yii\base\Request |
| setParams() | Устанавливает аргументы командной строки. | yii\console\Request |
| setScriptFile() | Устанавливает путь к файлу скрипта входа. | yii\base\Request |
| trigger() | Срабатывает событие. | yii\base\Component |
Подробное описание свойств
$params открытое свойство
Аргументы командной строки. Не включает имя скрипта входа.
public array getParams ( )
public void setParams ( $params )
Подробное описание методов
getParams() открытый метод
Возвращает аргументы командной строки.
| public массив getParams ( ) | ||
|---|---|---|
| возврат | массив |
Аргументы командной строки. Не включает имя скрипта входа. |
resolve() открытый метод
Разрешает текущий запрос в маршрут и связанные параметры.
| public массив resolve ( ) | ||
|---|---|---|
| возврат | массив |
Первый элемент — маршрут, второй — связанные параметры. |
| выбрасывает | yii\console\Exception |
когда параметр неверен и не может быть разрешен |
setParams() открытый метод
Устанавливает аргументы командной строки.
| public void setParams ( $params ) | ||
|---|---|---|
| $params | массив |
Аргументы командной строки |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-console-request.html
