Public Member Functions | |
| __construct (CompletionConditionRepository $repository) | |
| evaluate (ActivityInstance $activityInstance, CompletionConditionInstance $completionConditionInstance) | |
| evaluatePercentage (ActivityInstance $activityInstance, CompletionConditionInstance $completionConditionInstance) | |
 Public Member Functions inherited from BristolSU\Support\Completion\Contracts\CompletionConditionTester | |
| evaluate (ActivityInstance $activityInstance, CompletionConditionInstance $completionConditionInstance) | |
| evaluatePercentage (ActivityInstance $activityInstance, CompletionConditionInstance $completionConditionInstance) | |
Private Attributes | |
| $repository | |
Detailed Description
Test if a module instance is complete
Definition at line 15 of file CompletionConditionTester.php.
Constructor & Destructor Documentation
◆ __construct()
| BristolSU\Support\Completion\CompletionConditionTester::__construct | ( | CompletionConditionRepository | $repository | ) |
- Parameters
-
CompletionConditionRepository $repository
Definition at line 27 of file CompletionConditionTester.php.
References BristolSU\Support\Completion\CompletionConditionTester\$repository.
Member Function Documentation
◆ evaluate()
| BristolSU\Support\Completion\CompletionConditionTester::evaluate | ( | ActivityInstance | $activityInstance, |
| CompletionConditionInstance | $completionConditionInstance | ||
| ) |
Check if the completion condition is complete for the given activity instance
- Parameters
-
ActivityInstance $activityInstance Activity instance to test CompletionConditionInstance $completionConditionInstance Completion condition instance to test
- Returns
- bool If the completion condition is complete
Definition at line 40 of file CompletionConditionTester.php.
References BristolSU\Support\Completion\CompletionConditionInstance\alias(), BristolSU\Support\Completion\CompletionConditionInstance\moduleInstance(), and BristolSU\Support\Completion\CompletionConditionInstance\settings().
◆ evaluatePercentage()
| BristolSU\Support\Completion\CompletionConditionTester::evaluatePercentage | ( | ActivityInstance | $activityInstance, |
| CompletionConditionInstance | $completionConditionInstance | ||
| ) |
Check the completion condition completion percentage.
- Parameters
-
ActivityInstance $activityInstance Activity instance to test CompletionConditionInstance $completionConditionInstance Completion condition instance to test
- Returns
- int Percentage completion
Definition at line 58 of file CompletionConditionTester.php.
References BristolSU\Support\Completion\CompletionConditionInstance\alias(), BristolSU\Support\Completion\CompletionConditionInstance\moduleInstance(), and BristolSU\Support\Completion\CompletionConditionInstance\settings().
Member Data Documentation
◆ $repository
|
private |
Definition at line 22 of file CompletionConditionTester.php.
Referenced by BristolSU\Support\Completion\CompletionConditionTester\__construct().
The documentation for this class was generated from the following file:
- src/Completion/CompletionConditionTester.php
