Heratio Framework API Reference

AlertService
in package

Alert Service.

Manages actionable alerts and insights.

Table of Contents

Constants

TYPES  = ['zero_result_spike' => 'Zero Result Spike', 'content_trending' => 'Content Trending', 'low_engagement' => 'Low Engagement', 'embargo_expiring' => 'Embargo Expiring', 'access_request_pending' => 'Access Request Pending', 'popia_critical' => 'POPIA Critical', 'quality_issue' => 'Quality Issue', 'batch_completed' => 'Batch Completed', 'batch_failed' => 'Batch Failed']
Alert types.

Methods

cleanupOldAlerts()  : int
Clean up old alerts.
create()  : int
Create an alert.
dismiss()  : bool
Dismiss alert.
dismissByType()  : int
Dismiss all alerts of a type.
generateSystemAlerts()  : int
Generate system alerts based on current state.
getActiveAlerts()  : array<string|int, mixed>
Get active alerts.
getAlertCounts()  : array<string|int, mixed>
Get alert counts by severity.
markRead()  : bool
Mark alert as read.

Constants

TYPES

Alert types.

public mixed TYPES = ['zero_result_spike' => 'Zero Result Spike', 'content_trending' => 'Content Trending', 'low_engagement' => 'Low Engagement', 'embargo_expiring' => 'Embargo Expiring', 'access_request_pending' => 'Access Request Pending', 'popia_critical' => 'POPIA Critical', 'quality_issue' => 'Quality Issue', 'batch_completed' => 'Batch Completed', 'batch_failed' => 'Batch Failed']

Methods

cleanupOldAlerts()

Clean up old alerts.

public cleanupOldAlerts([int $days = 90 ]) : int
Parameters
$days : int = 90
Return values
int

create()

Create an alert.

public create(array<string|int, mixed> $data) : int
Parameters
$data : array<string|int, mixed>
Return values
int

dismiss()

Dismiss alert.

public dismiss(int $id[, int|null $userId = null ]) : bool
Parameters
$id : int
$userId : int|null = null
Return values
bool

dismissByType()

Dismiss all alerts of a type.

public dismissByType(string $alertType[, int|null $institutionId = null ][, int|null $userId = null ]) : int
Parameters
$alertType : string
$institutionId : int|null = null
$userId : int|null = null
Return values
int

generateSystemAlerts()

Generate system alerts based on current state.

public generateSystemAlerts([int|null $institutionId = null ]) : int
Parameters
$institutionId : int|null = null
Return values
int

getActiveAlerts()

Get active alerts.

public getActiveAlerts([int|null $institutionId = null ][, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$institutionId : int|null = null
$params : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getAlertCounts()

Get alert counts by severity.

public getAlertCounts([int|null $institutionId = null ]) : array<string|int, mixed>
Parameters
$institutionId : int|null = null
Return values
array<string|int, mixed>

markRead()

Mark alert as read.

public markRead(int $id) : bool
Parameters
$id : int
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results