Summary
- File
- Package hierarchy PHPBoost
- Class hierarchy \AdministratorAlertService
Class AdministratorAlertService
Methods
__static()
__static()
static
- Inherited from \AdministratorAlertService
Tags
| None found |
find_by_id()
find_by_id(integer $alert_id) : \AdministratorAlertBuilds an alert knowing its id.
Parameters
| integer | $alert_id | Id of the alert. |
Returns
\AdministratorAlert
—
The wanted alert. If it's not found, it returns null.
static
- Inherited from \AdministratorAlertService
Tags
| None found |
find_by_criteria()
find_by_criteria(integer $id_in_module = null, string $type = null, string $identifier = null) : array<mixed,\AdministratorAlert>Builds a list of alerts matching the required criteria(s). You can specify many criterias. When you use several of them, it's a AND condition.
It will only return the alert which match all the criterias.
Parameters
| integer | $id_in_module | Id in the module. |
| string | $type | Alert type. |
| string | $identifier | Alert identifier. |
Returns
array<mixed,\AdministratorAlert>
—
The list of the matching alerts.
static
- Inherited from \AdministratorAlertService
Tags
| None found |
get_unread_alerts()
get_unread_alerts() : array<mixed,\AdministratorAlert>Builds a list of unread alerts.
Returns
array<mixed,\AdministratorAlert>
—
The list of the matching alerts.
static
- Inherited from \AdministratorAlertService
Tags
| None found |
find_by_identifier()
find_by_identifier(string $identifier, string $type = '') : array<mixed,\AdministratorAlert>Finds an alert knowing its identifier and maybe its type.
Parameters
| string | $identifier | The identifier of the alerts you look for. |
| string | $type | The type of the alert you look for. |
Returns
array<mixed,\AdministratorAlert>
—
The list of the matching alerts.
static
- Inherited from \AdministratorAlertService
Tags
| None found |
get_all_alerts()
get_all_alerts(string $criteria = 'creation_date', string $order = 'desc', integer $begin, integer $number = 20) : array<mixed,\AdministratorAlerts>Lists all the alerts of the site. You can order them. You can also choose how much alerts you want.
Parameters
| string | $criteria | The criteria according to which you want to order. It can be id, entitled, fixing_url, current_status, creation_date, identifier, id_in_module, type, priority, description. |
| string | $order | asc or desc. |
| integer | $begin | You want all the alert from the ($begin+1)(th). |
| integer | $number | The number of alerts you want. |
Returns
array<mixed,\AdministratorAlerts>
—
The list of the alerts.
static
- Inherited from \AdministratorAlertService
Tags
| None found |
save_alert()
save_alert(\AdministratorAlert $alert) Create or updates an alert in the database. It creates it whether it doesn't exist or updates it if it already exists.
Parameters
| \AdministratorAlert | $alert | The alert to create or update. |
static
- Inherited from \AdministratorAlertService
Tags
| None found |
delete_alert()
delete_alert(\AdministratorAlert $alert) Deletes an alert from the database.
Parameters
| \AdministratorAlert | $alert | The alert to delete. |
static
- Inherited from \AdministratorAlertService
Tags
| None found |
get_number_unread_alerts()
get_number_unread_alerts() : integerReturns the number of unread alerts.
Returns
integer
—
The number of unread alerts.
static
- Inherited from \AdministratorAlertService
Tags
| None found |
get_number_alerts()
get_number_alerts() : integerReturns the number of alerts.
Returns
integer
—
The number of alerts.
static
- Inherited from \AdministratorAlertService
Tags
| None found |