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

Public Member Functions

 __construct (ActivityInstanceRepositoryContract $repository)
 
 generate (Activity $activity, string $resourceType, string $resourceId)
 

Private Attributes

 $repository
 

Detailed Description

Generate an activity instance using the repository

Definition at line 13 of file DefaultActivityInstanceGenerator.php.

Constructor & Destructor Documentation

◆ __construct()

BristolSU\Support\ActivityInstance\DefaultActivityInstanceGenerator::__construct ( ActivityInstanceRepositoryContract  $repository)

Initialise the generator

Parameters
ActivityInstanceRepositoryContract$repositoryRepository to resolve the activity instance from.

Definition at line 28 of file DefaultActivityInstanceGenerator.php.

References BristolSU\Support\ActivityInstance\DefaultActivityInstanceGenerator\$repository.

Member Function Documentation

◆ generate()

BristolSU\Support\ActivityInstance\DefaultActivityInstanceGenerator::generate ( Activity  $activity,
string  $resourceType,
string  $resourceId 
)

Find or create the default activity instance.

This method first tries to find the first activity instance and return it. If no activity instances are found, one is created.

Parameters
Activity$activityActivity with which the activity instance should be associated with.
string$resourceTypeUser, group or role. The resource type for the activity instance
string$resourceIdThe ID of the user, group or role.
Returns
ActivityInstance

Implements BristolSU\Support\ActivityInstance\Contracts\DefaultActivityInstanceGenerator.

Definition at line 45 of file DefaultActivityInstanceGenerator.php.

Member Data Documentation

◆ $repository

BristolSU\Support\ActivityInstance\DefaultActivityInstanceGenerator::$repository
private

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