Inheritance diagram for BristolSU\Support\ModuleInstance\Evaluator\ModuleInstanceEvaluator:

Collaboration diagram for BristolSU\Support\ModuleInstance\Evaluator\ModuleInstanceEvaluator:

Public Member Functions
	evaluateAdministrator (ModuleInstance $moduleInstance, ?User $user=null, ?Group $group=null, ?Role $role=null)

	evaluateParticipant (ActivityInstance $activityInstance, ModuleInstance $moduleInstance, ?User $user=null, ?Group $group=null, ?Role $role=null)

	evaluateResource (ActivityInstance $activityInstance, ModuleInstance $moduleInstance)

Private Member Functions
	isComplete (ActivityInstance $activityInstance, ModuleInstance $moduleInstance)

Detailed Description

Evaluates a given module instance and module

Definition at line 23 of file ModuleInstanceEvaluator.php.

Member Function Documentation

◆ evaluateAdministrator()

BristolSU\Support\ModuleInstance\Evaluator\ModuleInstanceEvaluator::evaluateAdministrator	(	ModuleInstance	$moduleInstance,
		?User	$user = `null`,
		?Group	$group = `null`,
		?Role	$role = `null`
	)

Evaluate a module instance for a given administrator

Parameters

ModuleInstance	$moduleInstance	Module instance to evaluate
User \| null	$user	User to evaluate for
Group \| null	$group	Group to evaluate for
Role \| null	$role	Role to evaluate for

Returns: EvaluationContract

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

Definition at line 35 of file ModuleInstanceEvaluator.php.

◆ evaluateParticipant()

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

Evaluate a module instance for a given participant

Parameters

ActivityInstance	$activityInstance	Activity instance to evaluate
ModuleInstance	$moduleInstance	Module instance to evaluate
User \| null	$user	User to evaluate for
Group \| null	$group	Group to evaluate for
Role \| null	$role	Role to evaluate for

Returns: EvaluationContract

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

Definition at line 56 of file ModuleInstanceEvaluator.php.

References BristolSU\Support\ActivityInstance\ActivityInstance\activity(), and BristolSU\Support\ModuleInstance\Evaluator\ModuleInstanceEvaluator\isComplete().

◆ evaluateResource()

BristolSU\Support\ModuleInstance\Evaluator\ModuleInstanceEvaluator::evaluateResource	(	ActivityInstance	$activityInstance,
		ModuleInstance	$moduleInstance
	)

Evaluate the module instance for all participants of the activity instance.

This method, unlike the admin or participant methods, does not accept a user/group/role. Instead, it evaluates the module instance as a whole for a general overview of how the resource (i.e. the model associated to the activity instance) is doing.

Parameters