ActionItemCompletionFormProviderInterface
in
Plugin extension point for specialized ActionItem completion forms.
Table of Contents
Methods
- applySubmission() : ServiceResult
- Apply submitted special-form values before the item is completed.
- buildForm() : ActionItemCompletionForm|null
- Build structured form metadata for My To-Dos.
- canHandle() : bool
- Whether this provider owns completion UI/validation for the item.
- validateCompletion() : ServiceResult
- Validate completion requirements after any submitted values are applied.
Methods
applySubmission()
Apply submitted special-form values before the item is completed.
public
applySubmission(ActionItem $item, array<string, mixed> $data, int $actorId, KmpIdentityInterface $user) : ServiceResult
Parameters
- $item : ActionItem
-
Action item.
- $data : array<string, mixed>
-
Submitted request data.
- $actorId : int
-
Acting member id.
- $user : KmpIdentityInterface
-
Current user.
Return values
ServiceResultbuildForm()
Build structured form metadata for My To-Dos.
public
buildForm(ActionItem $item, KmpIdentityInterface $user) : ActionItemCompletionForm|null
Parameters
- $item : ActionItem
-
Action item.
- $user : KmpIdentityInterface
-
Current user.
Return values
ActionItemCompletionForm|nullcanHandle()
Whether this provider owns completion UI/validation for the item.
public
canHandle(ActionItem $item) : bool
Parameters
- $item : ActionItem
-
Action item.
Return values
boolvalidateCompletion()
Validate completion requirements after any submitted values are applied.
public
validateCompletion(ActionItem $item) : ServiceResult
Parameters
- $item : ActionItem
-
Action item.