Public Member Functions | |
| create ($attributes=[]) | |
| all () | |
| getById (int $id) | |
| update (int $id, array $attributes) | |
Detailed Description
Class to retrieve and change completion condition instances
Definition at line 11 of file CompletionConditionInstanceRepository.php.
Member Function Documentation
◆ all()
| BristolSU\Support\Completion\CompletionConditionInstanceRepository::all | ( | ) |
Get all completion condition instances
- Returns
- CompletionConditionInstance[]
Implements BristolSU\Support\Completion\Contracts\CompletionConditionInstanceRepository.
Definition at line 37 of file CompletionConditionInstanceRepository.php.
◆ create()
| BristolSU\Support\Completion\CompletionConditionInstanceRepository::create | ( | $attributes = [] | ) |
Create a completion condition instance.
The attributes given should be of the form [ 'alias' => 'alias of the completion condition', 'name' => 'Name of the completion condition instance', 'description' => 'Description of the completion condition instance', 'settings' => 'Settings for the completion condition instance' ]
- Parameters
-
array $attributes Attributes that make up the completion condition instance
- Returns
- CompletionConditionInstance
Implements BristolSU\Support\Completion\Contracts\CompletionConditionInstanceRepository.
Definition at line 27 of file CompletionConditionInstanceRepository.php.
◆ getById()
| BristolSU\Support\Completion\CompletionConditionInstanceRepository::getById | ( | int | $id | ) |
Get a completion condition instance by ID
- Parameters
-
int $id
- Returns
- Contracts
- Exceptions
-
ModelNotFoundException If the completion condition instance was not found
Implements BristolSU\Support\Completion\Contracts\CompletionConditionInstanceRepository.
Definition at line 50 of file CompletionConditionInstanceRepository.php.
Referenced by BristolSU\Support\Completion\CompletionConditionInstanceRepository\update().
◆ update()
| BristolSU\Support\Completion\CompletionConditionInstanceRepository::update | ( | int | $id, |
| array | $attributes | ||
| ) |
Update a completion condition instance
Any number of parameters may be passed to be updated. The possible attributes are alias, name, description and settings
- Parameters
-
int $id array $attributes
- Returns
- Contracts
- Exceptions
-
ModelNotFoundException If the completion condition instance was not found
Implements BristolSU\Support\Completion\Contracts\CompletionConditionInstanceRepository.
Definition at line 66 of file CompletionConditionInstanceRepository.php.
References BristolSU\Support\Completion\CompletionConditionInstanceRepository\getById().
The documentation for this class was generated from the following file:
- src/Completion/CompletionConditionInstanceRepository.php
