Public Member Functions | |
| setActivityInstance (ActivityInstance $activityInstance) | |
| getActivityInstance () | |
| clearActivityInstance () | |
Detailed Description
Resolve and persist the current Activity Instance
Definition at line 13 of file ActivityInstanceResolver.php.
Member Function Documentation
◆ clearActivityInstance()
| BristolSU\Support\ActivityInstance\Contracts\ActivityInstanceResolver::clearActivityInstance | ( | ) |
Clear the current activity instance.
Remove the activity instance from persistence.
- Returns
- void
Implemented in BristolSU\Support\ActivityInstance\ApiActivityInstanceResolver, BristolSU\Support\ActivityInstance\WebRequestActivityInstanceResolver, and BristolSU\Support\Testing\ActivityInstance\LaravelAuthActivityInstanceResolver.
◆ getActivityInstance()
| BristolSU\Support\ActivityInstance\Contracts\ActivityInstanceResolver::getActivityInstance | ( | ) |
Get the current activity instance.
Get the activity instance set with setActivityInstance. Should thrown an exception if not found.
- Returns
- ActivityInstance
- Exceptions
-
NotInActivityInstanceException
Implemented in BristolSU\Support\ActivityInstance\ApiActivityInstanceResolver, BristolSU\Support\ActivityInstance\WebRequestActivityInstanceResolver, and BristolSU\Support\Testing\ActivityInstance\LaravelAuthActivityInstanceResolver.
◆ setActivityInstance()
| BristolSU\Support\ActivityInstance\Contracts\ActivityInstanceResolver::setActivityInstance | ( | ActivityInstance | $activityInstance | ) |
Persist an Activity Instance.
Save the Activity Instance for the current session. The activity instance should be able to be retrieved over many requests when set.
- Parameters
-
ActivityInstance $activityInstance
- Returns
- void
Implemented in BristolSU\Support\ActivityInstance\ApiActivityInstanceResolver, BristolSU\Support\ActivityInstance\WebRequestActivityInstanceResolver, and BristolSU\Support\Testing\ActivityInstance\LaravelAuthActivityInstanceResolver.
The documentation for this interface was generated from the following file:
- src/ActivityInstance/Contracts/ActivityInstanceResolver.php
