WARNING: API IN FLUX. More...

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

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

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

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

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

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

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

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

	respondWithError ($error, $status_code=ELGG_HTTP_BAD_REQUEST, array $headers=[])
	Send error HTTP response. More...

	respondFromContent ($content='', $status_code=ELGG_HTTP_OK, array $headers=[])
	Send OK response. More...

	wrapLegacyAjaxResponse ($content='', $forward_url=REFERRER)
	Wraps content for compability with legacy Elgg ajax calls. 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...

Detailed Description

WARNING: API IN FLUX.

DO NOT USE DIRECTLY.

Since: 2.3 @access private

Definition at line 20 of file ResponseFactory.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

Request	$request	HTTP request
PluginHooksService	$hooks	Plugin hooks service
AjaxService	$ajax	AJAX service
ResponseTransport	$transport	Response transport

Definition at line 60 of file ResponseFactory.php.

Member Function Documentation

◆ getHeaders()

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 86 of file ResponseFactory.php.

◆ getSentResponse()

Elgg\Http\ResponseFactory::getSentResponse ( )

Returns a response that was sent to the client.

Returns: Response|false

Definition at line 173 of file ResponseFactory.php.

◆ isAction()

Elgg\Http\ResponseFactory::isAction ( )

Check if the requested path is an action.

Returns: bool

Definition at line 531 of file ResponseFactory.php.

◆ isXhr()

Elgg\Http\ResponseFactory::isXhr ( )

Check if the request is an XmlHttpRequest.

Returns: bool

Definition at line 523 of file ResponseFactory.php.

◆ normalize()

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 545 of file ResponseFactory.php.

◆ parseContext()

Elgg\Http\ResponseFactory::parseContext ( )

Parses response type to be used as plugin hook type.

Returns: string

Definition at line 491 of file ResponseFactory.php.

◆ prepareRedirectResponse()

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

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

Exceptions

InvalidArgumentException

Definition at line 130 of file ResponseFactory.php.

◆ prepareResponse()

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

Creates an HTTP response.

Parameters

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

Returns: Response

Definition at line 113 of file ResponseFactory.php.

◆ redirect()

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: SymfonyRedirectResponse

Exceptions

InvalidParameterException

Definition at line 378 of file ResponseFactory.php.

◆ respond()

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

Send HTTP response.

Parameters

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

Returns: Response

Definition at line 184 of file ResponseFactory.php.

◆ respondFromContent()

Elgg\Http\ResponseFactory::respondFromContent	(		$content = `''`,
			$status_code = `ELGG_HTTP_OK`,
		array	$headers = `[]`
	)

Send OK response.

Parameters

string	$content	Response body
int	$status_code	HTTP status code
array	$headers	HTTP headers (will be discarded for AJAX requets)

Returns: type

Definition at line 308 of file ResponseFactory.php.

◆ respondWithError()

Elgg\Http\ResponseFactory::respondWithError	(		$error,
			$status_code = `ELGG_HTTP_BAD_REQUEST`,
		array	$headers = `[]`
	)

Send error HTTP response.

Parameters

string	$error	Error message
int	$status_code	HTTP status code
array	$headers	HTTP headers (will be discarded on AJAX requests)

Returns: Response

Exceptions

InvalidParameterException

Definition at line 263 of file ResponseFactory.php.

◆ send()

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

Send a response.

Parameters

Response $response Response object

Returns: Response

Definition at line 144 of file ResponseFactory.php.

◆ setHeader()

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 76 of file ResponseFactory.php.

◆ stringify()

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 566 of file ResponseFactory.php.

◆ wrapLegacyAjaxResponse()

Elgg\Http\ResponseFactory::wrapLegacyAjaxResponse	(	$content = `''`,
		$forward_url = `REFERRER`
	)

Wraps content for compability with legacy Elgg ajax calls.

Parameters

string	$content	Response content
string	$forward_url	Forward URL

Returns: string

Definition at line 326 of file ResponseFactory.php.

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

engine/classes/Elgg/Http/ResponseFactory.php

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getHeaders()

◆ getSentResponse()

◆ isAction()

◆ isXhr()

◆ normalize()

◆ parseContext()

◆ prepareRedirectResponse()

◆ prepareResponse()

◆ redirect()

◆ respond()

◆ respondFromContent()

◆ respondWithError()

◆ send()

◆ setHeader()

◆ stringify()

◆ wrapLegacyAjaxResponse()