HTTP response service. More...

Public Member Functions
	__construct (Request $request, PluginHooksService $hooks, AjaxService $ajax, EventsService $events)
	Constructor. More...

	setHeader ($name, $value, $replace=true)
	Sets headers to apply to all responses being sent. More...

	setCookie (\ElggCookie $cookie)
	Set a cookie, but allow plugins to customize it first. More...

	getHeaders ($remove_existing=true)
	Get headers set to apply to all responses. More...

	prepareResponse ($content= '', $status=200, array $headers=[])
	Creates an HTTP response. More...

	prepareRedirectResponse ($url, $status=302, array $headers=[])
	Creates a redirect response. More...

	prepareJsonResponse ($content= '', $status=200, array $headers=[])
	Creates an JSON response. More...

	send (SymfonyResponse $response)
	Send a response. More...

	getSentResponse ()
	Returns a response that was sent to the client. More...

	respond (ResponseBuilder $response)
	Send HTTP response. More...

	respondWithError (ResponseBuilder $response)
	Send error HTTP response. More...

	respondFromContent (ResponseBuilder $response)
	Send OK response. More...

	wrapAjaxResponse ($content= '', $forward_url=null)
	Wraps response content in an Ajax2 compatible format. More...

	redirect ($forward_url=REFERRER, $status_code=ELGG_HTTP_FOUND)
	Prepares a redirect response. More...

	parseContext ()
	Parses response type to be used as plugin hook type. More...

	isXhr ()
	Check if the request is an XmlHttpRequest. More...

	isAction ()
	Check if the requested path is an action. More...

	normalize ($content= '')
	Normalizes content into serializable data by walking through arrays and objectifying Elgg entities. More...

	stringify ($content= '')
	Stringify/serialize response data. More...

	setTransport (ResponseTransport $transport)
	Replaces response transport. More...

Protected Member Functions
	getSiteRefererUrl ()
	Ensures the referer header is a site url. More...

	makeSecureForwardUrl ($url)
	Ensure the url has a valid protocol for browser use. More...

	closeSession ()
	Closes the session. More...

Detailed Description

HTTP response service.

Since: 2.3

Definition at line 22 of file ResponseFactory.php.

Constructor & Destructor Documentation

Elgg\Http\ResponseFactory::__construct	(	Request	$request,
		PluginHooksService	$hooks,
		AjaxService	$ajax,
		EventsService	$events
	)

Constructor.

Parameters

Request	$request	HTTP request
PluginHooksService	$hooks	Plugin hooks service
AjaxService	$ajax	AJAX service
EventsService	$events	Events service

Definition at line 69 of file ResponseFactory.php.

Member Function Documentation

Elgg\Http\ResponseFactory::closeSession ( )

protected

Closes the session.

Force closing the session so session is saved to the database before headers are sent preventing race conditions with session data

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

Returns: void

Definition at line 678 of file ResponseFactory.php.

Elgg\Http\ResponseFactory::getHeaders ( $remove_existing = true )

Get headers set to apply to all responses.

Parameters

bool $remove_existing Remove existing headers found in headers_list()

Returns: ResponseHeaderBag

Definition at line 124 of file ResponseFactory.php.

Elgg\Http\ResponseFactory::getSentResponse ( )

Returns a response that was sent to the client.

Returns: SymfonyResponse|false

Definition at line 255 of file ResponseFactory.php.

Elgg\Http\ResponseFactory::getSiteRefererUrl ( )

protected

Ensures the referer header is a site url.

Returns: string

Definition at line 642 of file ResponseFactory.php.

Elgg\Http\ResponseFactory::isAction ( )

Check if the requested path is an action.

Returns: bool

Definition at line 574 of file ResponseFactory.php.

Elgg\Http\ResponseFactory::isXhr ( )

Check if the request is an XmlHttpRequest.

Returns: bool

Definition at line 566 of file ResponseFactory.php.

Elgg\Http\ResponseFactory::makeSecureForwardUrl ( $url )

protected

Ensure the url has a valid protocol for browser use.

Parameters

string $url url the secure

Returns: string

Definition at line 659 of file ResponseFactory.php.

Elgg\Http\ResponseFactory::normalize ( $content = '' )

Normalizes content into serializable data by walking through arrays and objectifying Elgg entities.

Parameters

mixed $content Data to normalize

Returns: mixed

Definition at line 588 of file ResponseFactory.php.

Elgg\Http\ResponseFactory::parseContext ( )

Parses response type to be used as plugin hook type.

Returns: string

Definition at line 534 of file ResponseFactory.php.

Elgg\Http\ResponseFactory::prepareJsonResponse	(		$content = `''`,
			$status = `200`,
		array	$headers = `[]`
	)

Creates an JSON response.

Parameters

mixed	$content	The response content
integer	$status	The response status code
array	$headers	An array of response headers

Returns: JsonResponse

Removing Content-Type header because in some cases content-type headers were already set This is a problem when serving a cachable view (for example a .css) in ajax/view

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

Definition at line 192 of file ResponseFactory.php.

Elgg\Http\ResponseFactory::prepareRedirectResponse	(		$url,
			$status = `302`,
		array	$headers = `[]`
	)

Creates a redirect response.

Parameters

string	$url	URL to redirect to
integer	$status	The status code (302 by default)
array	$headers	An array of response headers (Location is always set to the given URL)

Returns: SymfonyRedirectResponse

Definition at line 172 of file ResponseFactory.php.

Elgg\Http\ResponseFactory::prepareResponse	(		$content = `''`,
			$status = `200`,
		array	$headers = `[]`
	)

Creates an HTTP response.

Parameters

mixed	$content	The response content
integer	$status	The response status code
array	$headers	An array of response headers

Returns: SymfonyResponse

Definition at line 152 of file ResponseFactory.php.

Elgg\Http\ResponseFactory::redirect	(	$forward_url = `REFERRER`,
		$status_code = `ELGG_HTTP_FOUND`
	)

Prepares a redirect response.

Parameters

string	$forward_url	Redirection URL
mixed	$status_code	HTTP status code or forward reason

Returns: false|SymfonyResponse

Exceptions

InvalidParameterException

Definition at line 446 of file ResponseFactory.php.

Elgg\Http\ResponseFactory::respond ( ResponseBuilder $response )

Send HTTP response.

Parameters

ResponseBuilder $response ResponseBuilder instance An instance of an ErrorResponse, OkResponse or RedirectResponse

Returns: false|SymfonyResponse

Exceptions

InvalidParameterException

Definition at line 267 of file ResponseFactory.php.

Elgg\Http\ResponseFactory::respondFromContent ( ResponseBuilder $response )

Send OK response.

Parameters

ResponseBuilder $response ResponseBuilder instance An instance of an ErrorResponse, OkResponse or RedirectResponse

Returns: SymfonyResponse|false

Definition at line 401 of file ResponseFactory.php.

Elgg\Http\ResponseFactory::respondWithError ( ResponseBuilder $response )

Send error HTTP response.

Parameters

ResponseBuilder $response ResponseBuilder instance An instance of an ErrorResponse, OkResponse or RedirectResponse

Returns: false|SymfonyResponse

Definition at line 344 of file ResponseFactory.php.

Elgg\Http\ResponseFactory::send ( SymfonyResponse $response )

Send a response.

Parameters

SymfonyResponse $response Response object

Returns: SymfonyResponse|false

Definition at line 218 of file ResponseFactory.php.

Elgg\Http\ResponseFactory::setCookie ( \ElggCookie $cookie )

Set a cookie, but allow plugins to customize it first.

To customize all cookies, register for the 'init:cookie', 'all' event.

Parameters

\ElggCookie $cookie The cookie that is being set

Returns: bool

Definition at line 99 of file ResponseFactory.php.

Elgg\Http\ResponseFactory::setHeader	(	$name,
		$value,
		$replace = `true`
	)

Sets headers to apply to all responses being sent.

Parameters

string	$name	Header name
string	$value	Header value
bool	$replace	Replace existing headers

Returns: void

Definition at line 87 of file ResponseFactory.php.

Elgg\Http\ResponseFactory::setTransport ( ResponseTransport $transport )

Replaces response transport.

Parameters

ResponseTransport $transport Transport interface

Returns: void

Definition at line 633 of file ResponseFactory.php.

Elgg\Http\ResponseFactory::stringify ( $content = '' )

Stringify/serialize response data.

Casts objects implementing __toString method to strings Serializes non-scalar values to JSON

Parameters

mixed $content Content to serialize

Returns: string

Definition at line 609 of file ResponseFactory.php.

Elgg\Http\ResponseFactory::wrapAjaxResponse	(	$content = `''`,
		$forward_url = `null`
	)

Wraps response content in an Ajax2 compatible format.

Parameters

string	$content	Response content
string	$forward_url	Forward URL

Returns: string

Definition at line 419 of file ResponseFactory.php.

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

engine/classes/Elgg/Http/ResponseFactory.php

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation