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

Public Member Functions

 __construct (ModuleInstanceEvaluatorContract $moduleInstanceEvaluator)
 
 evaluateParticipant (ActivityInstance $activityInstance, ?User $user=null, ?Group $group=null, ?Role $role=null)
 
 evaluateResource (ActivityInstance $activityInstance)
 

Private Attributes

 $moduleInstanceEvaluator
 

Detailed Description

Evaluates all module instances belonging to an activity

Definition at line 19 of file ActivityInstanceEvaluator.php.

Constructor & Destructor Documentation

◆ __construct()

BristolSU\Support\ModuleInstance\Evaluator\ActivityInstanceEvaluator::__construct ( ModuleInstanceEvaluatorContract  $moduleInstanceEvaluator)
Parameters
ModuleInstanceEvaluatorContract$moduleInstanceEvaluatorObject to evaluate module instances

Definition at line 32 of file ActivityInstanceEvaluator.php.

References BristolSU\Support\ModuleInstance\Evaluator\ActivityInstanceEvaluator\$moduleInstanceEvaluator.

Member Function Documentation

◆ evaluateParticipant()

BristolSU\Support\ModuleInstance\Evaluator\ActivityInstanceEvaluator::evaluateParticipant ( ActivityInstance  $activityInstance,
?User  $user = null,
?Group  $group = null,
?Role  $role = null 
)

Evaluate an activity instance for a participant

Parameters
ActivityInstance$activityInstanceActivity instance to evaluate
User | null$userUser to evaluate for
Group | null$groupGroup to evaluate for
Role | null$roleRole to evaluate for
Returns
EvaluationContract[] Array of evaluations with the module instance id as the index

Implements BristolSU\Support\ModuleInstance\Contracts\Evaluator\ActivityInstanceEvaluator.

Definition at line 47 of file ActivityInstanceEvaluator.php.

References BristolSU\Support\ActivityInstance\ActivityInstance\activity().

◆ evaluateResource()

BristolSU\Support\ModuleInstance\Evaluator\ActivityInstanceEvaluator::evaluateResource ( ActivityInstance  $activityInstance)

Evaluate the activity instance as a whole

As opposed to the evaluateParticipant and evaluateAdministrator methods, which evaluate an activity instance for a specific user/group/role, evaluateResource will consider all users/groups/roles able to access the activity instance.

Parameters
ActivityInstance$activityInstanceActivity to test
Returns
EvaluationContract[] Array of evaluations with the module instance id as the index

Implements BristolSU\Support\ModuleInstance\Contracts\Evaluator\ActivityInstanceEvaluator.

Definition at line 64 of file ActivityInstanceEvaluator.php.

References BristolSU\Support\ActivityInstance\ActivityInstance\activity().

Member Data Documentation

◆ $moduleInstanceEvaluator

BristolSU\Support\ModuleInstance\Evaluator\ActivityInstanceEvaluator::$moduleInstanceEvaluator
private

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