Абстрактный класс yii\base\Request
| Наследование | yii\base\Request » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Подклассы | yii\console\Request, yii\web\Request |
| Доступна с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/base/Request.php |
Request представляет запрос, обрабатываемый yii\base\Application.
Для более подробной информации и руководства по использованию Request, см. статью руководства по запросам.
Открытые свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список поведений, прикреплённых к этому компоненту | yii\base\Component |
| $isConsoleRequest | boolean | Значение, указывающее, сделан ли текущий запрос через консоль | yii\base\Request |
| $scriptFile | string | Путь к файлу скрипта входа (обработанный с помощью 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 |
| 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\base\Request |
| setIsConsoleRequest() | Устанавливает значение, указывающее, сделан ли текущий запрос через командную строку | yii\base\Request |
| setScriptFile() | Устанавливает путь к файлу скрипта входа. | yii\base\Request |
| trigger() | Вызывает событие. | yii\base\Component |
Подробности свойств
$isConsoleRequest открытое свойство
Значение, указывающее, сделан ли текущий запрос через консоль
public boolean getIsConsoleRequest ( )
public void setIsConsoleRequest ( $value )
$scriptFile открытое свойство
Путь к файлу скрипта входа (обработанный с помощью realpath())
public string getScriptFile ( )
public void setScriptFile ( $value )
Подробности методов
getIsConsoleRequest() public method
Возвращает значение, указывающее, выполняется ли текущий запрос через командную строку
| public boolean getIsConsoleRequest ( ) | ||
|---|---|---|
| return | boolean |
Значение, указывающее, выполняется ли текущий запрос через консоль |
getScriptFile() public method
Возвращает путь к файлу сценария входа.
| public string getScriptFile ( ) | ||
|---|---|---|
| return | string |
Путь к файлу сценария входа (обработанный с помощью realpath()) |
| throws | yii\base\InvalidConfigException |
если путь к файлу сценария входа не может быть определен автоматически. |
resolve() public abstract method
Разрешает текущий запрос в маршрут и связанные параметры.
| public abstract array resolve ( ) | ||
|---|---|---|
| return | array |
Первый элемент — маршрут, второй — связанные параметры. |
setIsConsoleRequest() public method
Устанавливает значение, указывающее, выполняется ли текущий запрос через командную строку
| public void setIsConsoleRequest ( $value ) | ||
|---|---|---|
| $value | boolean |
Значение, указывающее, выполняется ли текущий запрос через командную строку |
setScriptFile() public method
Устанавливает путь к файлу сценария входа.
Путь к файлу сценария входа обычно можно определить на основе переменной SCRIPT_FILENAME SERVER. Однако для некоторых конфигураций сервера это может быть неверно или невозможно. Этот метод setter предоставляет возможность вручную указать путь к файлу сценария входа.
| public void setScriptFile ( $value ) | ||
|---|---|---|
| $value | string |
Путь к файлу сценария входа. Это может быть путь к файлу или псевдоним пути. |
| throws | yii\base\InvalidConfigException |
если предоставленный путь к файлу сценария входа недействителен. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-base-request.html
