Bristol SU Support Package
Public Member Functions | Private Attributes | List of all members
BristolSU\Support\ActivityInstance\WebRequestActivityInstanceResolver Class Reference
Inheritance diagram for BristolSU\Support\ActivityInstance\WebRequestActivityInstanceResolver:
Inheritance graph
[legend]
Collaboration diagram for BristolSU\Support\ActivityInstance\WebRequestActivityInstanceResolver:
Collaboration graph
[legend]

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 13 of file WebRequestActivityInstanceResolver.php.

Constructor & Destructor Documentation

◆ __construct()

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

Initialise the Activity Instance resolver.

Parameters
Request$requestRequest object
ActivityInstanceRepositoryContract$activityInstanceRepositoryRepository 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.

Member Function Documentation

◆ clearActivityInstance()

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.

Exceptions

Implements BristolSU\Support\ActivityInstance\Contracts\ActivityInstanceResolver.

Definition at line 84 of file WebRequestActivityInstanceResolver.php.

◆ getActivityInstance()

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

Returns
ActivityInstance
Exceptions
NotInActivityInstanceException

Implements BristolSU\Support\ActivityInstance\Contracts\ActivityInstanceResolver.

Definition at line 65 of file WebRequestActivityInstanceResolver.php.

◆ setActivityInstance()

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.

Parameters
ActivityInstance$activityInstance
Exceptions

Implements BristolSU\Support\ActivityInstance\Contracts\ActivityInstanceResolver.

Definition at line 50 of file WebRequestActivityInstanceResolver.php.

Member Data Documentation

◆ $activityInstanceRepository

BristolSU\Support\ActivityInstance\WebRequestActivityInstanceResolver::$activityInstanceRepository
private

◆ $request

BristolSU\Support\ActivityInstance\WebRequestActivityInstanceResolver::$request
private

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