Bristol SU Support Package
Public Member Functions | List of all members
BristolSU\Support\Completion\Contracts\CompletionConditionTester Interface Reference
Inheritance diagram for BristolSU\Support\Completion\Contracts\CompletionConditionTester:
Inheritance graph
[legend]

Public Member Functions

 evaluate (ActivityInstance $activityInstance, CompletionConditionInstance $completionConditionInstance)
 
 evaluatePercentage (ActivityInstance $activityInstance, CompletionConditionInstance $completionConditionInstance)
 

Detailed Description

Test if a module instance is complete

Definition at line 10 of file CompletionConditionTester.php.

Member Function Documentation

◆ evaluate()

BristolSU\Support\Completion\Contracts\CompletionConditionTester::evaluate ( ActivityInstance  $activityInstance,
CompletionConditionInstance  $completionConditionInstance 
)

Tests if the completion condition instance is complete for the given activity instance

Parameters
ActivityInstance$activityInstanceActivity instance to test
CompletionConditionInstance$completionConditionInstanceCompletion condition instance to test
Returns
bool If the condition is complete or not

◆ evaluatePercentage()

BristolSU\Support\Completion\Contracts\CompletionConditionTester::evaluatePercentage ( ActivityInstance  $activityInstance,
CompletionConditionInstance  $completionConditionInstance 
)

Check the completion condition completion percentage.

Parameters
ActivityInstance$activityInstanceActivity instance to test
CompletionConditionInstance$completionConditionInstanceCompletion condition instance to test
Returns
int Percentage completion

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