Bristol SU Support Package
|
Public Member Functions | |
__construct (Request $request, ActivityInstanceRepositoryContract $activityInstanceRepository) | |
setActivityInstance (ActivityInstance $activityInstance) | |
getActivityInstance () | |
clearActivityInstance () | |
Private Attributes | |
$request | |
$activityInstanceRepository | |
Resolve an activity instance when using the API
Definition at line 13 of file WebRequestActivityInstanceResolver.php.
BristolSU\Support\ActivityInstance\WebRequestActivityInstanceResolver::__construct | ( | Request | $request, |
ActivityInstanceRepositoryContract | $activityInstanceRepository | ||
) |
Initialise the Activity Instance resolver.
Request | $request | Request object |
ActivityInstanceRepositoryContract | $activityInstanceRepository | Repository to resolve the activity instance from. |
Definition at line 35 of file WebRequestActivityInstanceResolver.php.
References BristolSU\Support\ActivityInstance\WebRequestActivityInstanceResolver\$activityInstanceRepository, and BristolSU\Support\ActivityInstance\WebRequestActivityInstanceResolver\$request.
BristolSU\Support\ActivityInstance\WebRequestActivityInstanceResolver::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.
Implements BristolSU\Support\ActivityInstance\Contracts\ActivityInstanceResolver.
Definition at line 84 of file WebRequestActivityInstanceResolver.php.
BristolSU\Support\ActivityInstance\WebRequestActivityInstanceResolver::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 'a'. If not found, a NotInActivityInstanceException will be thrown
NotInActivityInstanceException |
Implements BristolSU\Support\ActivityInstance\Contracts\ActivityInstanceResolver.
Definition at line 65 of file WebRequestActivityInstanceResolver.php.
BristolSU\Support\ActivityInstance\WebRequestActivityInstanceResolver::setActivityInstance | ( | ActivityInstance | $activityInstance | ) |
Set the activity instance.
For this resolver, the activity instance id must always be passed through the request object, so this method will throw an exception.
ActivityInstance | $activityInstance |
Implements BristolSU\Support\ActivityInstance\Contracts\ActivityInstanceResolver.
Definition at line 50 of file WebRequestActivityInstanceResolver.php.
|
private |
Definition at line 27 of file WebRequestActivityInstanceResolver.php.
Referenced by BristolSU\Support\ActivityInstance\WebRequestActivityInstanceResolver\__construct().
|
private |
Definition at line 20 of file WebRequestActivityInstanceResolver.php.
Referenced by BristolSU\Support\ActivityInstance\WebRequestActivityInstanceResolver\__construct().