Класс yii\web\Request

public string getAbsoluteUrl ( )

public array getAcceptableContentTypes ( )
public void setAcceptableContentTypes ( $value )

public array getAcceptableLanguages ( )
public void setAcceptableLanguages ( $value )

public string|null getAuthPassword ( )

public string|null getAuthUser ( )

public string getBaseUrl ( )
public void setBaseUrl ( $value )

public array getBodyParams ( )
public void setBodyParams ( $values )

public string getContentType ( )

public string $cookieValidationKey = null

public yii\web\CookieCollection getCookies ( )

public array $csrfCookie = ['httpOnly' => true]

public string $csrfParam = '_csrf'

public string getCsrfToken ( $regenerate = false )

public string getCsrfTokenFromHeader ( )

public array getETags ( )

public boolean $enableCookieValidation = true

public boolean $enableCsrfCookie = true

public boolean $enableCsrfValidation = true

public yii\web\HeaderCollection getHeaders ( )

public string|null getHostInfo ( )
public void setHostInfo ( $value )

public string|null getHostName ( )

public boolean getIsAjax ( )

public boolean getIsDelete ( )

public boolean getIsFlash ( )

public boolean getIsGet ( )

public boolean getIsHead ( )

public boolean getIsOptions ( )

public boolean getIsPatch ( )

public boolean getIsPjax ( )

public boolean getIsPost ( )

public boolean getIsPut ( )

public boolean getIsSecureConnection ( )

public string getMethod ( )

public string $methodParam = '_method'

[
    'application/json' => 'yii\web\JsonParser',
]

public array $parsers = []

public string getPathInfo ( )
public void setPathInfo ( $value )

public integer getPort ( )
public void setPort ( $value )

public string getPreferredLanguage ( array $languages = [] )

public array getQueryParams ( )
public void setQueryParams ( $values )

public string getQueryString ( )

public string getRawBody ( )
public void setRawBody ( $rawBody )

public string|null getReferrer ( )

public string getScriptFile ( )
public void setScriptFile ( $value )

public string getScriptUrl ( )
public void setScriptUrl ( $value )

public integer getSecurePort ( )
public void setSecurePort ( $value )

public string getServerName ( )

public integer|null getServerPort ( )

public string getUrl ( )
public void setUrl ( $value )

public string|null getUserAgent ( )

public string|null getUserHost ( )

public string|null getUserIP ( )

createCsrfCookie() защищенный метод

Создаёт cookie с случайным генерируемым токеном CSRF.

Начальные значения, указанные в $csrfCookie, будут применены к сгенерированному cookie.

См. также $enableCsrfValidation.

защищенный yii\web\Cookie createCsrfCookie ( $token )
$token	строка	Токен CSRF
return	yii\web\Cookie	Сгенерированный cookie

generateCsrfToken() защищенный метод

Генерирует незамаскированный случайный токен, используемый для проверки CSRF.

защищенный строка generateCsrfToken ( )
return	строка	Случайный токен для проверки CSRF.

get() публичный метод

Возвращает параметр GET с заданным именем. Если имя не указано, возвращает массив всех параметров GET.

публичный массив|смешанный get ( $name = null, $defaultValue = null )
$name	строка	Имя параметра
$defaultValue	смешанный	Значение параметра по умолчанию, если параметр не существует.

getAbsoluteUrl() публичный метод

Возвращает текущий запрашиваемый абсолютный URL.

Это сокращение для конкатенации $hostInfo и $url.

публичный строка getAbsoluteUrl ( )
return	строка	Текущий запрашиваемый абсолютный URL.

getAcceptableContentTypes() публичный метод

Возвращает типы содержимого, приемлемые для конечного пользователя.

Это определяется по HTTP-заголовку Accept. Например,

$_SERVER['HTTP_ACCEPT'] = 'text/plain; q=0.5, application/json; version=1.0, application/xml; version=2.0;';
$types = $request->getAcceptableContentTypes();
print_r($types);
// displays:
// [
//     'application/json' => ['q' => 1, 'version' => '1.0'],
//      'application/xml' => ['q' => 1, 'version' => '2.0'],
//           'text/plain' => ['q' => 0.5],
// ]

публичный массив getAcceptableContentTypes ( )
return	массив	Типы содержимого, упорядоченные по качеству. Типы с наивысшими баллами будут возвращены первыми. Ключи массива — это типы содержимого, а значения массива — соответствующий балл качества и другие параметры, заданные в заголовке.

getAcceptableLanguages() публичный метод

Возвращает языки, приемлемые для конечного пользователя.

Это определяется по HTTP-заголовку Accept-Language.

публичный массив getAcceptableLanguages ( )
return	массив	Языки, упорядоченные по уровню предпочтения. Первый элемент представляет наиболее предпочтительный язык.

getAuthPassword() публичный метод

публичный строка|null getAuthPassword ( )
return	строка|null	Пароль, отправленный через аутентификацию HTTP, null, если пароль не задан

getAuthUser() публичный метод

публичный строка|null getAuthUser ( )
return	строка|null	Имя пользователя, отправленное через аутентификацию HTTP, null, если имя пользователя не задано

getBaseUrl() публичный метод

Возвращает относительный URL приложения.

Аналогично $scriptUrl, за исключением того, что он не включает имя файла скрипта, и конечные слэши удаляются.

См. также setScriptUrl().

публичный строка getBaseUrl ( )
return	строка	Относительный URL приложения

getBodyParam() публичный метод

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

Если параметр не существует, возвращается второй параметр, переданный в этот метод.

См. также:

• getBodyParams()
• setBodyParams()

публичный смешанный getBodyParam ( $name, $defaultValue = null )
$name	строка	Имя параметра
$defaultValue	смешанный	Значение параметра по умолчанию, если параметр не существует.
return	смешанный	Значение параметра

getBodyParams() публичный метод

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

Параметры запроса определяются с помощью парсеров, настроенных в свойстве $parsers. Если для текущего $contentType нет настроенных парсеров, он использует PHP-функцию mb_parse_str() для анализа тела запроса.

См. также:

• getMethod()
• getBodyParam()
• setBodyParams()

публичный массив getBodyParams ( )
return	массив	Параметры запроса, указанные в теле запроса.
throws	yii\base\InvalidConfigException	если зарегистрированный парсер не реализует yii\web\RequestParserInterface.

getContentType() публичный метод

Возвращает тип содержимого запроса. Заголовок Content-Type указывает тип MIME данных, содержащихся в getRawBody(), или, в случае метода HEAD, тип носителя, который был бы отправлен, если бы запрос был GET.

Для типов MIME, ожидаемых пользователем в ответе, см. $acceptableContentTypes.

публичный строка getContentType ( )
return	строка	Тип содержимого запроса. Возвращает null, если эта информация недоступна.

getCookies() публичный метод

Возвращает коллекцию cookie.

С помощью возвращенной коллекции cookie вы можете получить доступ к cookie с помощью следующего синтаксиса:

$cookie = $request->cookies['name']
if ($cookie !== null) {
    $value = $cookie->value;
}

// alternatively
$value = $request->cookies->getValue('name');

публичный yii\web\CookieCollection getCookies ( )
return	yii\web\CookieCollection	Коллекция cookie.

getCsrfToken() публичный метод

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

Этот токен генерируется таким образом, чтобы предотвратить атаки BREACH. Он может передаваться через скрытое поле HTML-формы или значение HTTP-заголовка для поддержки проверки CSRF.

публичный строка getCsrfToken ( $regenerate = false )
$regenerate	boolean	Передать ли токен CSRF. При значении true каждый вызов этого метода будет генерировать новый токен CSRF и сохранять его (в сессии или cookie).
return	строка	Токен, используемый для проверки CSRF.

getCsrfTokenFromHeader() публичный метод

public string getCsrfTokenFromHeader ( )
return	string	Токен CSRF, отправленный через CSRF_HEADER браузером. Возвращает Null, если такой заголовок не отправлен.

getETags() public method

Получает ETags.

public array getETags ( )
return	array	Теги сущности

getHeaders() public method

Возвращает коллекцию заголовков.

Коллекция заголовков содержит входящие HTTP заголовки.

public yii\web\HeaderCollection getHeaders ( )
return	yii\web\HeaderCollection	Коллекция заголовков

getHostInfo() public method

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

Возвращаемый URL не содержит конечной косой черты.

По умолчанию это значение основано на информации о запросе пользователя. Этот метод вернет значение $_SERVER['HTTP_HOST'] , если оно доступно, или $_SERVER['SERVER_NAME'] , если нет. Вы можете ознакомиться с документацией PHP для получения дополнительной информации об этих переменных.

Вы можете явно указать его, установив свойство hostInfo.

Предупреждение: В зависимости от конфигурации сервера эта информация может быть ненадежной и может быть подделана пользователем, отправляющим HTTP-запрос. Если веб-сервер настроен на обслуживание одного и того же сайта независимо от значения заголовка Host, это значение ненадежно. В таких ситуациях вам следует либо исправить конфигурацию своего веб-сервера, либо явно установить значение, установив свойство hostInfo. Если у вас нет доступа к конфигурации сервера, вы можете настроить фильтр yii\filters\HostControl на уровне приложения, чтобы защититься от подобных атак.

См. также setHostInfo().

public string|null getHostInfo ( )
return	string|null	Схема и имя хоста (с номером порта, если необходимо) части URL запроса (например, http://www.yiiframework.com), null, если не может быть получено из $_SERVER и не было установлено.

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

Возвращает доменную часть текущего URL запроса.

Значение вычисляется из текущего свойства hostInfo.

Предупреждение: Содержание этого значения может быть ненадежным в зависимости от конфигурации сервера. Обратитесь к getHostInfo() для получения дополнительной информации.

См. также getHostInfo().

public string|null getHostName ( )
return	string|null	Часть имени хоста URL запроса (например, www.yiiframework.com)

getIsAjax() public method

Возвращает, является ли это AJAX (XMLHttpRequest) запросом.

Обратите внимание, что jQuery не устанавливает заголовок в случае запросов между доменами: https://stackoverflow.com/questions/8163703/cross-domain-ajax-doesnt-send-x-requested-with-header

public boolean getIsAjax ( )
return	boolean	Является ли это AJAX (XMLHttpRequest) запросом.

getIsDelete() public method

Возвращает, является ли это запросом DELETE.

public boolean getIsDelete ( )
return	boolean	Является ли это запросом DELETE.

getIsFlash() public method

Возвращает, является ли это запросом от Adobe Flash или Flex.

public boolean getIsFlash ( )
return	boolean	Является ли это запросом от Adobe Flash или Adobe Flex.

getIsGet() public method

Возвращает, является ли это запросом GET.

public boolean getIsGet ( )
return	boolean	Является ли это запросом GET.

getIsHead() public method

Возвращает, является ли это запросом HEAD.

public boolean getIsHead ( )
return	boolean	Является ли это запросом HEAD.

getIsOptions() public method

Возвращает, является ли это запросом OPTIONS.

public boolean getIsOptions ( )
return	boolean	Является ли это запросом OPTIONS.

getIsPatch() public method

Возвращает, является ли это запросом PATCH.

public boolean getIsPatch ( )
return	boolean	Является ли это запросом PATCH.

getIsPjax() public method

Возвращает, является ли это запросом PJAX

public boolean getIsPjax ( )
return	boolean	Является ли это запросом PJAX

getIsPost() public method

Возвращает, является ли это запросом POST.

public boolean getIsPost ( )
return	boolean	Является ли это запросом POST.

getIsPut() public method

Возвращает, является ли это запросом PUT.

public boolean getIsPut ( )
return	boolean	Является ли это запросом PUT.

getIsSecureConnection() public method

Возвращает, отправлен ли запрос по защищенному каналу (https).

public boolean getIsSecureConnection ( )
return	boolean	Отправлен ли запрос по защищенному каналу (https)

getMethod() public method

Возвращает метод текущего запроса (например, GET, POST, HEAD, PUT, PATCH, DELETE).

public string getMethod ( )
return	string	Метод запроса, такой как GET, POST, HEAD, PUT, PATCH, DELETE. Возвращаемое значение преобразуется в верхний регистр.

getPathInfo() public method

Возвращает информацию о пути текущего запрошенного URL.

Информация о пути относится к части, которая следует за начальным скриптом и предшествует вопросительному знаку (строка запроса). Начальные и конечные косые черты удаляются.

public строка getPathInfo ( )
возврат	строка	Часть URL запроса, которая следует за начальным скриптом и предшествует вопросительному знаку. Обратите внимание, что возвращаемая информация о пути уже декодирована по URL.
выбрасывает	yii\base\InvalidConfigException	если информация о пути не может быть определена из-за непредвиденной конфигурации сервера

getPort() общедоступный метод

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

По умолчанию 80, или порт, указанный сервером, если текущий запрос небезопасен.

См. также setPort().

public целое число getPort ( )
возврат	целое число	Номер порта для небезопасных запросов.

getPreferredLanguage() общедоступный метод

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

Решение языка основано на предпочтительных языках пользователя и языках, поддерживаемых приложением. Метод попытается найти наилучшее совпадение.

public строка getPreferredLanguage ( массив $languages = [] )
$languages	массив	Список языков, поддерживаемых приложением. Если он пустой, текущий язык приложения будет возвращён без дальнейшей обработки.
возврат	строка	Язык, который приложение должно использовать.

getQueryParam() общедоступный метод

Возвращает значение параметра GET по имени.

Если параметр GET не существует, возвращается второй параметр, переданный этому методу.

См. также getBodyParam().

public смешанный getQueryParam ( $name, $defaultValue = null )
$name	строка	Имя параметра GET.
$defaultValue	смешанный	Значение параметра по умолчанию, если параметр GET не существует.
возврат	смешанный	Значение параметра GET

getQueryParams() общедоступный метод

Возвращает параметры запроса, заданные в $queryString.

Этот метод вернёт содержимое $_GET если параметры не были явно заданы.

См. также setQueryParams().

public массив getQueryParams ( )
возврат	массив	Значения параметров GET запроса.

getQueryString() общедоступный метод

Возвращает часть URL запроса, которая следует за вопросительным знаком.

public строка getQueryString ( )
возврат	строка	Часть URL запроса, которая следует за вопросительным знаком

getRawBody() общедоступный метод

Возвращает исходное тело HTTP-запроса.

public строка getRawBody ( )
возврат	строка	Тело запроса

getReferrer() общедоступный метод

Возвращает URL-ссылку referrer.

public строка|null getReferrer ( )
возврат	строка|null	URL referrer, null если не доступен

getScriptFile() общедоступный метод

Возвращает путь к файлу начального скрипта.

Реализация по умолчанию просто вернёт $_SERVER['SCRIPT_FILENAME'].

public строка getScriptFile ( )
возврат	строка	Путь к файлу начального скрипта
выбрасывает	yii\base\InvalidConfigException

getScriptUrl() общедоступный метод

Возвращает относительный URL начального скрипта.

Реализация этого метода ссылается на Zend_Controller_Request_Http в Zend Framework.

public строка getScriptUrl ( )
возврат	строка	Относительный URL начального скрипта.
выбрасывает	yii\base\InvalidConfigException	если невозможно определить URL начального скрипта

getSecurePort() общедоступный метод

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

По умолчанию 443, или порт, указанный сервером, если текущий запрос защищён.

См. также setSecurePort().

public целое число getSecurePort ( )
возврат	целое число	Номер порта для защищённых запросов.

getServerName() общедоступный метод

Возвращает имя сервера.

public строка getServerName ( )
возврат	строка	Имя сервера, null если не доступно

getServerPort() общедоступный метод

Возвращает номер порта сервера.

public целое число|null getServerPort ( )
возврат	целое число|null	Номер порта сервера, null если не доступен

getUrl() общедоступный метод

Возвращает запрашиваемый относительный URL.

Это относится к части URL, которая следует за $hostInfo. Включает $queryString, если таковой имеется.

public строка getUrl ( )
возврат	строка	Текущий запрашиваемый относительный URL. Обратите внимание, что URI, возвращаемый может быть закодирован в URL в зависимости от клиента.
выбрасывает	yii\base\InvalidConfigException	если URL не может быть определён из-за необычной конфигурации сервера

getUserAgent() общедоступный метод

Возвращает пользовательский агент.

public строка|null getUserAgent ( )
возврат	строка|null	Пользовательский агент, null если недоступен

getUserHost() общедоступный метод

Возвращает имя хоста пользователя.

public строка|null getUserHost ( )
возврат	строка|null	Имя хоста пользователя, null если недоступно

getUserIP() общедоступный метод

Возвращает IP-адрес пользователя.

public string|null getUserIP ( )
return	string|null	IP-адрес пользователя, null, если не доступен

loadCookies() protected method

Преобразует $_COOKIE в массив yii\web\Cookie.

protected array loadCookies ( )
return	array	Куки, полученные из запроса
throws	yii\base\InvalidConfigException	если $cookieValidationKey не задан, когда $enableCookieValidation равен true

loadCsrfToken() protected method

Загружает токен CSRF из куки или сессии.

protected string loadCsrfToken ( )
return	string	Загруженный токен CSRF из куки или сессии. Null возвращается, если куки или сессия не содержат токен CSRF.

parseAcceptHeader() public method

Парсит заданный заголовок Accept (или Accept-Language).

Этот метод возвращает допустимые значения с их коэффициентами качества и соответствующими параметрами, как указано в заданном заголовке Accept. Ключи массива результата — это допустимые значения, а значения массива — соответствующие коэффициенты качества и параметры. Допустимые значения с наивысшими коэффициентами качества будут возвращены первыми. Например,

$header = 'text/plain; q=0.5, application/json; version=1.0, application/xml; version=2.0;';
$accepts = $request->parseAcceptHeader($header);
print_r($accepts);
// displays:
// [
//     'application/json' => ['q' => 1, 'version' => '1.0'],
//      'application/xml' => ['q' => 1, 'version' => '2.0'],
//           'text/plain' => ['q' => 0.5],
// ]

public array parseAcceptHeader ( $header )
$header	string	Заголовок для парсинга
return	array	Допустимые значения, отсортированные по коэффициенту качества. Значения с наивысшими коэффициентами будут возвращены первыми.

post() public method

Возвращает параметр POST с заданным именем. Если имя не указано, возвращает массив всех параметров POST.

public array|mixed post ( $name = null, $defaultValue = null )
$name	string	Имя параметра
$defaultValue	mixed	Значение параметра по умолчанию, если параметр не существует.

resolve() public method

Разрешает текущий запрос до маршрута и связанных параметров.

public array resolve ( )
return	array	Первый элемент — маршрут, второй — связанные параметры.
throws	yii\web\NotFoundHttpException	если запрос не может быть разрешен.

resolvePathInfo() protected method

Разрешает часть path info текущего запрошенного URL.

Path info — это часть, которая следует за скриптом входа и предшествует вопросительному знаку (строка запроса). Начальные слеши удаляются, конечные — сохраняются.

protected string resolvePathInfo ( )
return	string	Часть URL запроса, находящаяся после скрипта входа и перед вопросительным знаком. Обратите внимание, возвращаемый path info декодирован.
throws	yii\base\InvalidConfigException	если path info не может быть определена из-за неожиданной конфигурации сервера

resolveRequestUri() protected method

Разрешает часть request URI для текущего запрошенного URL.

Это часть, которая находится после части $hostInfo. Она включает часть $queryString, если она есть. Реализация этого метода ссылается на Zend_Controller_Request_Http в Zend Framework.

protected string|boolean resolveRequestUri ( )
return	string|boolean	Часть request URI для текущего запрошенного URL. Обратите внимание, что возвращаемый URI может быть закодирован в URL в зависимости от клиента.
throws	yii\base\InvalidConfigException	если request URI не может быть определен из-за необычной конфигурации сервера

setAcceptableContentTypes() public method

Устанавливает допустимые типы содержимого.

См. getAcceptableContentTypes() для формата параметра.

См. также:

• getAcceptableContentTypes()
• parseAcceptHeader()

public void setAcceptableContentTypes ( $value )
$value	array	Типы содержимого, допустимые для конечного пользователя. Они должны быть отсортированы по уровню приоритета.

setAcceptableLanguages() public method

public void setAcceptableLanguages ( $value )
$value	array	Языки, допустимые для конечного пользователя. Они должны быть отсортированы по уровню приоритета.

setBaseUrl() public method

Устанавливает относительный URL приложения.

По умолчанию URL определяется на основе URL скрипта входа. Этот метод-сеттер предоставляется в случае необходимости изменить это поведение.

public void setBaseUrl ( $value )
$value	string	Относительный URL приложения

setBodyParams() public method

Устанавливает параметры тела запроса.

См. также:

• getBodyParam()
• getBodyParams()

public void setBodyParams ( $values )
$values	array	Параметры тела запроса (имя-значение)

setHostInfo() public method

Устанавливает схему и доменную часть URL приложения.

Этот сеттер предоставляется в случае, если схема и имя хоста не могут быть определены на определённых веб-серверах.

См. также getHostInfo() для заметок по безопасности этого свойства.

public void setHostInfo ( $value )
$value	string|null	Схема и доменная часть URL приложения. Конечные слеши будут удалены.

setPathInfo() public method

Устанавливает path info текущего запроса.

Этот метод в основном предназначен для целей тестирования.

public void setPathInfo ( $value )
$value	string	Path info текущего запроса

setPort() public method

Устанавливает порт для использования для незащищённых запросов.

Этот сеттер предоставляется в случае необходимости использования пользовательского порта для определённых конфигураций сервера.

public void setPort ( $value )
$value	integer	Номер порта.

setQueryParams() public method

Устанавливает параметры запроса $queryString.

См. также:

• getQueryParam()
• getQueryParams()

public void setQueryParams ( $values )
$values	массив	Параметры запроса (имя-значение)

setRawBody() public метод

Устанавливает тело HTTP-запроса в сыром виде. Этот метод в основном используется тестовыми сценариями для имитации HTTP-запросов в сыром формате.

public void setRawBody ( $rawBody )
$rawBody	строка	Тело запроса

setScriptFile() public метод

Устанавливает путь к файлу скрипта входа.

Путь к файлу скрипта входа обычно можно получить из $_SERVER['SCRIPT_FILENAME']. Если ваша конфигурация сервера не возвращает правильное значение, вы можете настроить это свойство, чтобы оно соответствовало действительности.

public void setScriptFile ( $value )
$value	строка	Путь к файлу скрипта входа.

setScriptUrl() public метод

Устанавливает относительный URL-адрес скрипта входа приложения.

Этот метод сеттера предоставляется на случай, если URL-адрес скрипта входа не может быть определен на определенных веб-серверах.

public void setScriptUrl ( $value )
$value	строка	Относительный URL-адрес скрипта входа приложения.

setSecurePort() public метод

Устанавливает порт для использования в защищённых запросах.

Этот метод сеттера предоставляется на случай, если для определённых конфигураций сервера необходим настраиваемый порт.

public void setSecurePort ( $value )
$value	целое число	Номер порта.

setUrl() public метод

Устанавливает текущий запрашиваемый относительный URL.

URI должен ссылаться на часть, которая находится после $hostInfo. Обратите внимание, что URI должен быть закодирован в формате URL.

public void setUrl ( $value )
$value	строка	URI запроса, который нужно установить

validateCsrfToken() public метод

Выполняет проверку CSRF.

Этот метод проверяет предоставленный пользователем токен CSRF, сравнивая его с токеном, хранящимся в cookie или сессии. Этот метод в основном вызывается в yii\web\Controller::beforeAction().

Обратите внимание, что метод НЕ выполнит проверку CSRF, если $enableCsrfValidation имеет значение false или HTTP-метод относится к GET, HEAD или OPTIONS.

public boolean validateCsrfToken ( $clientSuppliedToken = null )
$clientSuppliedToken	строка	Предоставленный пользователем токен CSRF для проверки. Если null, токен будет получен из поля POST $csrfParam или HTTP-заголовка. Этот параметр доступен с версии 2.0.4.
return	boolean	Является ли токен CSRF действительным. Если $enableCsrfValidation равен false, этот метод вернёт true.