Elgg\Ajax\Service Class Reference

Models the Ajax API service. More...

Public Member Functions
	__construct (protected EventsService $events, protected SystemMessagesService $msgs, protected Request $request, protected ESMService $esm, protected ExternalFiles $externalFiles)
	Constructor. More...
	isAjax2Request ()
	Did the request come from the elgg/Ajax module? More...
	isReady ()
	Is the service ready to respond to the request? More...
	decodeJson ($string)
	Attempt to JSON decode the given string. More...
	respondFromOutput ($output, string $event_type='', bool $try_decode=true)
	Send a JSON HTTP response with the given output. More...
	respondFromApiResponse (AjaxResponse $api_response, string $event_type='')
	Send a JSON HTTP response based on the given API response. More...
	respondWithError (string $msg='', int $status=400)
	Send a JSON HTTP 400 response. More...
	prepareResponse (\Elgg\Event $event)
	Prepare the response with additional metadata, like system messages and required ES modules. More...
	registerView (string $view)
	Register a view to be available for ajax calls. More...
	unregisterView (string $view)
	Unregister a view for ajax calls. More...
	getViews ()
	Returns an array of views allowed for ajax calls. More...

Protected Attributes
bool	$response_sent = false
array	$allowed_views = []

Detailed Description

Models the Ajax API service.

Since

1.12.0

Definition at line 20 of file Service.php.

Constructor & Destructor Documentation

__construct()

Elgg\Ajax\Service::__construct	(	protected EventsService	$events,
		protected SystemMessagesService	$msgs,
		protected Request	$request,
		protected ESMService	$esm,
		protected ExternalFiles	$externalFiles
	)

Constructor.

Parameters

EventsService	$events	Events service
SystemMessagesService	$msgs	System messages service
Request	$request	Http Request
ESMService	$esm	ESM service
ExternalFiles	$externalFiles	External files service

Definition at line 35 of file Service.php.

Member Function Documentation

decodeJson()

Elgg\Ajax\Service::decodeJson

(

$string

)

Attempt to JSON decode the given string.

Parameters

mixed

$string

Output string

Returns

mixed

Definition at line 76 of file Service.php.

getViews()

Elgg\Ajax\Service::getViews

(

)

Returns an array of views allowed for ajax calls.

Returns

string[]

Definition at line 278 of file Service.php.

isAjax2Request()

Elgg\Ajax\Service::isAjax2Request

(

)

Did the request come from the elgg/Ajax module?

Returns

bool

Definition at line 51 of file Service.php.

isReady()

Elgg\Ajax\Service::isReady

(

)

Is the service ready to respond to the request?

Some code paths involve multiple layers of handling (e.g. router calls actions/ajax views) so we must check whether the response has already been sent to avoid sending it twice. We can't use headers_sent() because Router needs to use output buffering.

Returns

bool

Definition at line 65 of file Service.php.

prepareResponse()

Elgg\Ajax\Service::prepareResponse

(

\Elgg\Event

$event

)

Prepare the response with additional metadata, like system messages and required ES modules.

Parameters

\Elgg\Event

$event

"ajax_response", "all"

Returns

AjaxResponse

Definition at line 209 of file Service.php.

registerView()

Elgg\Ajax\Service::registerView

(

string

$view

)

Register a view to be available for ajax calls.

Parameters

string

$view

The view name

Returns

void

Definition at line 258 of file Service.php.

respondFromApiResponse()

Elgg\Ajax\Service::respondFromApiResponse	(	AjaxResponse	$api_response,
		string	$event_type = ''
	)

Send a JSON HTTP response based on the given API response.

Parameters

AjaxResponse	$api_response	API response
string	$event_type	The event type. If given, the response will be filtered by event

Returns

JsonResponse|false

Definition at line 123 of file Service.php.

respondFromOutput()

Elgg\Ajax\Service::respondFromOutput	(		$output,
		string	$event_type = '',
		bool	$try_decode = true
	)

Send a JSON HTTP response with the given output.

Parameters

mixed	$output	Output from a page/action handler
string	$event_type	The event type. If given, the response will be filtered by event
bool	$try_decode	Try to convert a JSON string back to an abject

Returns

JsonResponse|false

Definition at line 94 of file Service.php.

respondWithError()

Elgg\Ajax\Service::respondWithError	(	string	$msg = '',
		int	$status = 400
	)

Send a JSON HTTP 400 response.

Parameters

string	$msg	The error message (not displayed to the user)
int	$status	The HTTP status code

Returns

JsonResponse|false

Definition at line 139 of file Service.php.

unregisterView()

Elgg\Ajax\Service::unregisterView

(

string

$view

)

Unregister a view for ajax calls.

Parameters

string

$view

The view name

Returns

void

Definition at line 269 of file Service.php.

Member Data Documentation

$allowed_views

array Elgg\Ajax\Service::$allowed_views = []

protected

Definition at line 24 of file Service.php.

$response_sent

bool Elgg\Ajax\Service::$response_sent = false

protected

Definition at line 22 of file Service.php.

---

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

• engine/classes/Elgg/Ajax/Service.php