Inheritance diagram for Elgg\Http\Request:

Public Member Functions
	__construct (array $query=[], array $request=[], array $attributes=[], array $cookies=[], array $files=[], array $server=[], $content=null)
	{} More...

	initializeTrustedProxyConfiguration (Config $config)
	Configure trusted proxy servers to allow access to more client information. More...

	initializeContext ()
	Initialize context stack. More...

	getContextStack ()
	Returns context stack. More...

	setRoute (Route $route)
	Sets the route matched for this request by the router. More...

	getRoute ()
	Returns the route matched for this request by the router. More...

	setParam (string $key, $value, bool $override_request=false)
	Sets an input value that may later be retrieved by get_input. More...

	getParam (string $key, $default=null, bool $filter_result=true)
	Get some input from variables passed submitted through GET or POST. More...

	getParams (bool $filter_result=true)
	Returns all values parsed from the request. More...

	getCurrentURL ()
	Returns current page URL. More...

	getUrlSegments (bool $raw=false)
	Get the Elgg URL segments. More...

	setUrlSegments (array $segments)
	Get a cloned request with new Elgg URL segments. More...

	getFirstUrlSegment ()
	Get first Elgg URL segment. More...

	getElggPath ()
	Get the Request URI minus querystring. More...

	getClientIp ()
	{} More...

	isXmlHttpRequest ()
	{} More...

	sniffElggUrl ()
	Sniff the Elgg site URL with trailing slash. More...

	isRewriteCheck ()
	Is the request for checking URL rewriting? More...

	isAction ()
	Is the request an action. More...

	isCliServer ()
	Is PHP running the CLI server front controller. More...

	isCliServable (string $root)
	Is the request pointing to a file that the CLI server can handle? More...

	getFiles (string $input_name)
	Returns an array of uploaded file objects regardless of upload status/errors. More...

	getFile (string $input_name, bool $check_for_validity=true)
	Returns the first file found based on the input name. More...

	validate ()
	Validate the request. More...

	correctBaseURL (\Elgg\Config $config)
	Correct the base URL of the request. More...

Public Attributes
const	REWRITE_TEST_TOKEN = '__testing_rewrite'

const	REWRITE_TEST_OUTPUT = 'success'

bool	$_integration_testing = false

Protected Member Functions
	validateRequestHostHeader ()
	Validate that the request was made on the correct host. More...

	validateRequestBodyTruncated ()
	Validate that the request body hasn't been truncated (eg. More...

Protected Attributes
	$context_stack

	$route

	$request_overrides

	$filtered_params

	$unfiltered_params

Detailed Description

Elgg HTTP request.

Definition at line 17 of file Request.php.

Constructor & Destructor Documentation

◆ __construct()

Elgg\Http\Request::__construct	(	array	$query = `[]`,
		array	$request = `[]`,
		array	$attributes = `[]`,
		array	$cookies = `[]`,
		array	$files = `[]`,
		array	$server = `[]`,
			$content = `null`
	)

{}

Definition at line 56 of file Request.php.

Member Function Documentation

◆ correctBaseURL()

Elgg\Http\Request::correctBaseURL ( \Elgg\Config $config )

Correct the base URL of the request.

Parameters

\Elgg\Config $config the Elgg config

Returns: void

See also: https://github.com/Elgg/Elgg/issues/13667

Since: 4.3

Definition at line 543 of file Request.php.

◆ getClientIp()

Elgg\Http\Request::getClientIp ( )

{}

Definition at line 303 of file Request.php.

◆ getContextStack()

Elgg\Http\Request::getContextStack ( )

Returns context stack.

Returns: Context

Definition at line 110 of file Request.php.

◆ getCurrentURL()

Elgg\Http\Request::getCurrentURL ( )

Returns current page URL.

It uses the configured site URL for the hostname rather than depending on what the server uses to populate $_SERVER.

Returns: string

Definition at line 218 of file Request.php.

◆ getElggPath()

Elgg\Http\Request::getElggPath ( )

Get the Request URI minus querystring.

Returns: string

Definition at line 290 of file Request.php.

◆ getFile()

Elgg\Http\Request::getFile	(	string	$input_name,
		bool	$check_for_validity = `true`
	)

Returns the first file found based on the input name.

Parameters

string	$input_name	Form input name
bool	$check_for_validity	If there is an uploaded file, is it required to be valid

Returns: UploadedFile|null

Definition at line 440 of file Request.php.

◆ getFiles()

Elgg\Http\Request::getFiles ( string $input_name )

Returns an array of uploaded file objects regardless of upload status/errors.

Parameters

string $input_name Form input name

Returns: UploadedFile[]

Definition at line 419 of file Request.php.

◆ getFirstUrlSegment()

Elgg\Http\Request::getFirstUrlSegment ( )

Get first Elgg URL segment.

See also: \Elgg\Http\Request::getUrlSegments()

Returns: string

Definition at line 276 of file Request.php.

◆ getParam()

Elgg\Http\Request::getParam	(	string	$key,
			$default = `null`,
		bool	$filter_result = `true`
	)

Get some input from variables passed submitted through GET or POST.

If using any data obtained from get_input() in a web page, please be aware that it is a possible vector for a reflected XSS attack. If you are expecting an integer, cast it to an int. If it is a string, escape quotes.

Parameters

string	$key	The variable name we want.
mixed	$default	A default value for the variable if it is not found.
bool	$filter_result	If true, then the result is filtered for bad tags.

Returns: mixed

Definition at line 177 of file Request.php.

◆ getParams()

Elgg\Http\Request::getParams ( bool $filter_result = true )

Returns all values parsed from the request.

Parameters

bool $filter_result Sanitize input values

Returns: array

Definition at line 190 of file Request.php.

◆ getRoute()

Elgg\Http\Request::getRoute ( )

Returns the route matched for this request by the router.

Returns: Route|null

Definition at line 135 of file Request.php.

◆ getUrlSegments()

Elgg\Http\Request::getUrlSegments ( bool $raw = false )

Get the Elgg URL segments.

Parameters

bool $raw If true, the segments will not be HTML escaped

Returns: string[]

Definition at line 241 of file Request.php.

◆ initializeContext()

Elgg\Http\Request::initializeContext ( )

Initialize context stack.

Returns: static

Definition at line 98 of file Request.php.

◆ initializeTrustedProxyConfiguration()

Elgg\Http\Request::initializeTrustedProxyConfiguration ( Config $config )

Configure trusted proxy servers to allow access to more client information.

Parameters

Config $config Elgg config to read trusted proxy configuration from

Returns: void

Definition at line 79 of file Request.php.

◆ isAction()

Elgg\Http\Request::isAction ( )

Is the request an action.

Returns: bool

Since: 4.1

Definition at line 369 of file Request.php.

◆ isCliServable()

Elgg\Http\Request::isCliServable ( string $root )

Is the request pointing to a file that the CLI server can handle?

Parameters

string $root Root directory

Returns: bool

Definition at line 389 of file Request.php.

◆ isCliServer()

Elgg\Http\Request::isCliServer ( )

Is PHP running the CLI server front controller.

Returns: bool

Definition at line 378 of file Request.php.

◆ isRewriteCheck()

Elgg\Http\Request::isRewriteCheck ( )

Is the request for checking URL rewriting?

Returns: bool

Definition at line 351 of file Request.php.

◆ isXmlHttpRequest()

Elgg\Http\Request::isXmlHttpRequest ( )

{}

Definition at line 322 of file Request.php.

◆ setParam()

Elgg\Http\Request::setParam	(	string	$key,
			$value,
		bool	$override_request = `false`
	)

Sets an input value that may later be retrieved by get_input.

Note: this function does not handle nested arrays (ex: form input of param[m][n])

Parameters

string	$key	The name of the variable
mixed	$value	The value of the variable
bool	$override_request	The variable should override request values (default: false)

Returns: static

Definition at line 150 of file Request.php.

◆ setRoute()

Elgg\Http\Request::setRoute ( Route $route )

Sets the route matched for this request by the router.

Parameters

Route $route Route

Returns: static

Definition at line 121 of file Request.php.

◆ setUrlSegments()

Elgg\Http\Request::setUrlSegments ( array $segments )

Get a cloned request with new Elgg URL segments.

Parameters

string[] $segments URL segments

Returns: Request

Definition at line 261 of file Request.php.

◆ sniffElggUrl()

Elgg\Http\Request::sniffElggUrl ( )

Sniff the Elgg site URL with trailing slash.

Returns: string

Definition at line 333 of file Request.php.

◆ validate()

Elgg\Http\Request::validate ( )

Validate the request.

Returns: void

Exceptions

BadRequestException

Definition at line 464 of file Request.php.

◆ validateRequestBodyTruncated()

Elgg\Http\Request::validateRequestBodyTruncated ( )

protected

Validate that the request body hasn't been truncated (eg.

exceeded POST max size)

Returns: void

Exceptions

BadRequestException

Since: 3.0

Definition at line 499 of file Request.php.

◆ validateRequestHostHeader()

Elgg\Http\Request::validateRequestHostHeader ( )

protected

Validate that the request was made on the correct host.

This will prevent malicious requests from being processed

Returns: void

Exceptions

BadRequestException

Since: 3.3.25

Definition at line 478 of file Request.php.

Member Data Documentation

◆ $_integration_testing

bool Elgg\Http\Request::$_integration_testing = false

Definition at line 26 of file Request.php.

◆ $context_stack

Elgg\Http\Request::$context_stack

protected

Definition at line 31 of file Request.php.

◆ $filtered_params

Elgg\Http\Request::$filtered_params

protected

Definition at line 46 of file Request.php.

◆ $request_overrides

Elgg\Http\Request::$request_overrides

protected

Definition at line 41 of file Request.php.

◆ $route

Elgg\Http\Request::$route

protected

Definition at line 36 of file Request.php.

◆ $unfiltered_params

Elgg\Http\Request::$unfiltered_params

protected

Definition at line 51 of file Request.php.

◆ REWRITE_TEST_OUTPUT

const Elgg\Http\Request::REWRITE_TEST_OUTPUT = 'success'

Definition at line 20 of file Request.php.

◆ REWRITE_TEST_TOKEN

const Elgg\Http\Request::REWRITE_TEST_TOKEN = '__testing_rewrite'

Definition at line 19 of file Request.php.

The documentation for this class was generated from the following file:

engine/classes/Elgg/Http/Request.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ correctBaseURL()

◆ getClientIp()

◆ getContextStack()

◆ getCurrentURL()

◆ getElggPath()

◆ getFile()

◆ getFiles()

◆ getFirstUrlSegment()

◆ getParam()

◆ getParams()

◆ getRoute()

◆ getUrlSegments()

◆ initializeContext()

◆ initializeTrustedProxyConfiguration()

◆ isAction()

◆ isCliServable()

◆ isCliServer()

◆ isRewriteCheck()

◆ isXmlHttpRequest()

◆ setParam()

◆ setRoute()

◆ setUrlSegments()

◆ sniffElggUrl()

◆ validate()

◆ validateRequestBodyTruncated()

◆ validateRequestHostHeader()

Member Data Documentation

◆ $_integration_testing

◆ $context_stack

◆ $filtered_params

◆ $request_overrides

◆ $route

◆ $unfiltered_params

◆ REWRITE_TEST_OUTPUT

◆ REWRITE_TEST_TOKEN