Граф наследования:HttpRequest:

Открытые члены
	__construct (Server $server, array $queryString, array $postData, array $files, array $cookies, array $jsonData=[])
	addFilter (Type\IRequestFilter $filter)
	getQuery ($name)
	getQueryList ()
	getPost ($name)
	getPostList ()
	getFile ($name)
	getFileList ()
	getHeader ($name)
	getHeaders ()
	getCookie ($name)
	getCookieList ()
	getCookieRaw ($name)
	getCookieRawList ()
	getJsonList ()
	getRemoteAddress ()
	getUserAgent ()
	getRequestUri ()
	getRequestMethod ()
	getServerPort ()
	isPost ()
	getAcceptedLanguages ()
	getRequestedPage ()
	getDecodedUri ()
	getHttpHost ()
	isHttps ()
	modifyByQueryString ($queryString)
	getScriptFile ()
	getCookiesMode ()
	isJson ()
	decodeJson ()
	decodeJsonStrict ()
Открытые члены унаследованные от Request
	__construct (Server $server, array $request)
	getServer ()
	getPhpSelf ()
	getScriptName ()
	getRequestedPageDirectory ()
	isAdminSection ()
	isAjaxRequest ()
Открытые члены унаследованные от ParameterDictionary
	getRaw ($name)
	toArrayRaw ()
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	setValues ($values)
Открытые члены унаследованные от Dictionary
	__construct (array $values=null)
	get ($name)
	set ($name, $value=null)
	getValues ()
	clear ()
	current ()
	next ()
	key ()
	valid ()
	rewind ()
	offsetExists ($offset)
	offsetGet ($offset)
	count ()
	toArray ()
	isEmpty ()
	jsonSerialize ()
	__unserialize (array $data)

Открытые статические члены
static	getSystemParameters ()
static	getInput ()

Защищенные члены
	prepareCookie (array $cookies)
Защищенные члены унаследованные от ParameterDictionary
	setValuesNoDemand (array $values)

Защищенные статические члены
static	decode ($url)
static	normalize ($path)

Защищенные данные
	$queryString
	$postData
	$files
	$cookies
	$cookiesRaw
	$jsonData
	$headers
	$httpHost
	$acceptedLanguages
Защищенные данные унаследованные от Request
	$server
	$requestedPage = null
	$requestedPageDirectory = null
Защищенные данные унаследованные от ParameterDictionary
	$rawValues = null
Защищенные данные унаследованные от Dictionary
	$values = []

Подробное описание

Примеры: C:/bitrix/modules/ui/lib/Avatar/Mask/Helper.php.

См. определение в файле httprequest.php строка 19

Конструктор(ы)

◆ __construct()

__construct	(	Server	$server,
		array	$queryString,
		array	$postData,
		array	$files,
		array	$cookies,
		array	$jsonData = [] )

Creates new HttpRequest object

Аргументы

Server	$server
array	$queryString	_GET
array	$postData	_POST
array	$files	_FILES
array	$cookies	_COOKIE

См. определение в файле httprequest.php строка 61

Методы

◆ addFilter()

addFilter ( Type\IRequestFilter $filter )

Applies filter to the http request data. Preserve original values.

Аргументы

Type\IRequestFilter $filter Filter object

Переопределяет метод предка Request.

См. определение в файле httprequest.php строка 98

◆ decode()

decode ( $url )

staticprotected

См. определение в файле httprequest.php строка 360

◆ decodeJson()

decodeJson ( )

Decodes JSON from application/json requests.

См. определение в файле httprequest.php строка 580

◆ decodeJsonStrict()

decodeJsonStrict ( )

См. определение в файле httprequest.php строка 598

◆ getAcceptedLanguages()

getAcceptedLanguages ( )

См. определение в файле httprequest.php строка 302

◆ getCookie()

getCookie ( $name )

Returns the COOKIES parameter of the current request.

Аргументы

$name

Возвращает: null|string

См. определение в файле httprequest.php строка 233

◆ getCookieList()

getCookieList ( )

Returns the list of COOKIES parameters of the current request.

Возвращает: Type\ParameterDictionary

См. определение в файле httprequest.php строка 243

◆ getCookieRaw()

getCookieRaw ( $name )

См. определение в файле httprequest.php строка 248

◆ getCookieRawList()

getCookieRawList ( )

См. определение в файле httprequest.php строка 253

◆ getCookiesMode()

getCookiesMode ( )

Returns Y if persistant cookies are enabled, N if disabled, or empty if unknown.

Возвращает: null|string

См. определение в файле httprequest.php строка 557

◆ getDecodedUri()

getDecodedUri ( )

Returns url-decoded and converted to the current encoding URI of the request (except the query string).

Возвращает: string

См. определение в файле httprequest.php строка 346

◆ getFile()

getFile ( $name )

Returns the FILES parameter of the current request.

Аргументы

$name

Возвращает: string | array | null

См. определение в файле httprequest.php строка 190

◆ getFileList()

getFileList ( )

Returns the list of FILES parameters of the current request.

Возвращает: Type\ParameterDictionary

См. определение в файле httprequest.php строка 200

◆ getHeader()

getHeader ( $name )

Returns the header of the current request.

Аргументы

string $name Name of header.

Возвращает: null|string

См. определение в файле httprequest.php строка 212

◆ getHeaders()

getHeaders ( )

Returns the list of headers of the current request.

Возвращает: HttpHeaders

См. определение в файле httprequest.php строка 222

◆ getHttpHost()

getHttpHost ( )

Returns the host from the server variable without a port number.

Возвращает: string

См. определение в файле httprequest.php строка 369

◆ getInput()

getInput ( )

static

Returns raw request data from php://input.

Возвращает: bool|string

См. определение в файле httprequest.php строка 548

◆ getJsonList()

getJsonList ( )

См. определение в файле httprequest.php строка 258

◆ getPost()

getPost ( $name )

Returns the POST parameter of the current request.

Аргументы

$name

Возвращает: string | array | null

См. определение в файле httprequest.php строка 169

◆ getPostList()

getPostList ( )

Returns the list of POST parameters of the current request.

Возвращает: Type\ParameterDictionary

См. определение в файле httprequest.php строка 179

◆ getQuery()

getQuery ( $name )

Returns the GET parameter of the current request.

Аргументы

string $name Parameter name

Возвращает: null | string | array

См. определение в файле httprequest.php строка 148

◆ getQueryList()

getQueryList ( )

Returns the list of GET parameters of the current request.

Возвращает: Type\ParameterDictionary

См. определение в файле httprequest.php строка 158

◆ getRemoteAddress()

getRemoteAddress ( )

См. определение в файле httprequest.php строка 263

◆ getRequestedPage()

getRequestedPage ( )

Returns the current page calculated from the request URI.

Возвращает: string

Переопределяет метод предка Request.

См. определение в файле httprequest.php строка 324

◆ getRequestMethod()

getRequestMethod ( )

См. определение в файле httprequest.php строка 282

◆ getRequestUri()

getRequestUri ( )

См. определение в файле httprequest.php строка 277

◆ getScriptFile()

getScriptFile ( )

Returns script file possibly corrected by urlrewrite.php.

Возвращает: string

См. определение в файле httprequest.php строка 503

◆ getServerPort()

getServerPort ( )

Returns server port.

Возвращает: string | null

См. определение в файле httprequest.php строка 292

◆ getSystemParameters()

getSystemParameters ( )

static

Returns the array with predefined query parameters.

Возвращает: array

См. определение в файле httprequest.php строка 520

◆ getUserAgent()

getUserAgent ( )

Returns the User-Agent HTTP request header.

Возвращает: null|string

См. определение в файле httprequest.php строка 272

◆ isHttps()

isHttps ( )

См. определение в файле httprequest.php строка 384

◆ isJson()

isJson ( )

См. определение в файле httprequest.php строка 562

◆ isPost()

isPost ( )

См. определение в файле httprequest.php строка 297

◆ modifyByQueryString()

modifyByQueryString ( $queryString )

См. определение в файле httprequest.php строка 402

◆ normalize()

normalize ( $path )

staticprotected

См. определение в файле httprequest.php строка 486

◆ prepareCookie()

prepareCookie ( array $cookies )

protected

Аргументы

array $cookies

Возвращает: array

См. определение в файле httprequest.php строка 417

Поля

◆ $acceptedLanguages

$acceptedLanguages

protected

См. определение в файле httprequest.php строка 50

◆ $cookies

$cookies

protected

См. определение в файле httprequest.php строка 36

◆ $cookiesRaw

$cookiesRaw

protected

См. определение в файле httprequest.php строка 40

◆ $files

$files

protected

См. определение в файле httprequest.php строка 32

◆ $headers

$headers

protected

См. определение в файле httprequest.php строка 48

◆ $httpHost

$httpHost

protected

См. определение в файле httprequest.php строка 49

◆ $jsonData

$jsonData

protected

См. определение в файле httprequest.php строка 44

◆ $postData

$postData

protected

См. определение в файле httprequest.php строка 28

◆ $queryString

$queryString

protected

См. определение в файле httprequest.php строка 24

Объявления и описания членов класса находятся в файле:

C:/bitrix/modules/main/lib/httprequest.php

Открытые члены

Открытые статические члены

Защищенные члены

Защищенные статические члены

Защищенные данные

Подробное описание

Конструктор(ы)

◆ __construct()

Методы

◆ addFilter()

◆ decode()

◆ decodeJson()

◆ decodeJsonStrict()

◆ getAcceptedLanguages()

◆ getCookie()

◆ getCookieList()

◆ getCookieRaw()

◆ getCookieRawList()

◆ getCookiesMode()

◆ getDecodedUri()

◆ getFile()

◆ getFileList()

◆ getHeader()

◆ getHeaders()

◆ getHttpHost()

◆ getInput()

◆ getJsonList()

◆ getPost()

◆ getPostList()

◆ getQuery()

◆ getQueryList()

◆ getRemoteAddress()

◆ getRequestedPage()

◆ getRequestMethod()

◆ getRequestUri()

◆ getScriptFile()

◆ getServerPort()

◆ getSystemParameters()

◆ getUserAgent()

◆ isHttps()

◆ isJson()

◆ isPost()

◆ modifyByQueryString()

◆ normalize()

◆ prepareCookie()

Поля

◆ $acceptedLanguages

◆ $cookies

◆ $cookiesRaw

◆ $files

◆ $headers

◆ $httpHost

◆ $jsonData

◆ $postData

◆ $queryString