Inheritance diagram for BristolSU\Support\ActivityInstance\ApiActivityInstanceResolver:

Collaboration diagram for BristolSU\Support\ActivityInstance\ApiActivityInstanceResolver:

Public Member Functions
	__construct (Request $request, ActivityInstanceRepositoryContract $activityInstanceRepository)

	setActivityInstance (ActivityInstance $activityInstance)

	getActivityInstance ()

	clearActivityInstance ()

Private Attributes
	$request

	$activityInstanceRepository

Detailed Description

Resolve an activity instance when using the API

Definition at line 15 of file ApiActivityInstanceResolver.php.

Constructor & Destructor Documentation

◆ __construct()

BristolSU\Support\ActivityInstance\ApiActivityInstanceResolver::__construct	(	Request	$request,
		ActivityInstanceRepositoryContract	$activityInstanceRepository
	)

Initialise the Activity Instance resolver.

Parameters

Request	$request	Request object
ActivityInstanceRepositoryContract	$activityInstanceRepository	Repository to resolve the activity instance from.

Definition at line 37 of file ApiActivityInstanceResolver.php.

References BristolSU\Support\ActivityInstance\ApiActivityInstanceResolver\$activityInstanceRepository, and BristolSU\Support\ActivityInstance\ApiActivityInstanceResolver\$request.

Member Function Documentation

◆ clearActivityInstance()

BristolSU\Support\ActivityInstance\ApiActivityInstanceResolver::clearActivityInstance ( )

Clear the activity instance

For the API, the activity instance is always set in the query string in the request object, so this method throws an exception.

Exceptions

Implements BristolSU\Support\ActivityInstance\Contracts\ActivityInstanceResolver.

Definition at line 85 of file ApiActivityInstanceResolver.php.

◆ getActivityInstance()

BristolSU\Support\ActivityInstance\ApiActivityInstanceResolver::getActivityInstance ( )

Gets the activity instance

The activity instance will be retrieved from the repository using the ID found in the query string under the key 'activity_instance_id'. If not found, a NotInActivityInstanceException will be thrown