RecommendationApprovalContextRenderer
in package
implements
ApprovalContextRendererInterface
Table of Contents
Interfaces
- ApprovalContextRendererInterface
- Renders entity-aware context for the unified approvals UI.
Methods
- canRender() : bool
- Check whether this renderer supports award recommendation approval workflows.
- render() : ApprovalContext
- Render award recommendation details for the unified approvals UI.
- awardLabel() : string
- Build a readable award label from the award, domain, level, and specialty.
- findRecommendation() : Recommendation|null
- Locate the recommendation referenced by a workflow instance.
- findRecommendationApprovalRun() : RecommendationApprovalRun|null
- Find the recommendation approval run for workflow instances owned by the run.
- findRecommendationById() : Recommendation|null
- Load the recommendation detail graph used by approval detail panels.
- gatheringLabels() : array<int, string>
- recommendationUrl() : string|null
- Build the source recommendation URL.
Methods
canRender()
Check whether this renderer supports award recommendation approval workflows.
public
canRender(WorkflowInstance $instance) : bool
Parameters
- $instance : WorkflowInstance
-
Workflow instance to check
Return values
boolrender()
Render award recommendation details for the unified approvals UI.
public
render(WorkflowInstance $instance) : ApprovalContext
Parameters
- $instance : WorkflowInstance
-
Workflow instance to render
Return values
ApprovalContextawardLabel()
Build a readable award label from the award, domain, level, and specialty.
private
awardLabel(Recommendation $recommendation) : string
Parameters
- $recommendation : Recommendation
-
Recommendation.
Return values
stringfindRecommendation()
Locate the recommendation referenced by a workflow instance.
private
findRecommendation(WorkflowInstance $instance) : Recommendation|null
Parameters
- $instance : WorkflowInstance
-
Workflow instance.
Return values
Recommendation|nullfindRecommendationApprovalRun()
Find the recommendation approval run for workflow instances owned by the run.
private
findRecommendationApprovalRun(WorkflowInstance $instance) : RecommendationApprovalRun|null
Parameters
- $instance : WorkflowInstance
-
Workflow instance.
Return values
RecommendationApprovalRun|nullfindRecommendationById()
Load the recommendation detail graph used by approval detail panels.
private
findRecommendationById(int $recommendationId) : Recommendation|null
Parameters
- $recommendationId : int
-
Recommendation ID.
Return values
Recommendation|nullgatheringLabels()
private
gatheringLabels(Recommendation $recommendation) : array<int, string>
Parameters
- $recommendation : Recommendation
Return values
array<int, string>recommendationUrl()
Build the source recommendation URL.
private
recommendationUrl(int $recommendationId) : string|null
Parameters
- $recommendationId : int
-
Recommendation ID.