Class

AdministratorAlert

Package: PHPBoost\Event Copyright: © 2005-2019 PHPBoost License: GNU/GPL-3.0 Author: Benoit SAUTEL ben.popeye@phpboost.com Version: PHPBoost 5.2 - last update: 2018 11 07 Since: PHPBoost 2.0 - 2008 08 27 Contributor: Julien BRISWALTER j1.seth@phpboost.com Contributor: Arnaud GENET elenwii@phpboost.com Located at: phpboost/event/AdministratorAlert.class.php

This class represents an alert which must be sent to the administrator. It allows to the module developers to handle the administrator alerts. The administrator alerts can be in the administration panel and can be used when you want to signal an important event to the administrator(s).

Event
Extended by AdministratorAlert
Methods summary
public
# __construct( )

Builds an AdministratorAlert object.
public
# build( integer $id, string $entitled, string $properties, string $fixing_url, integer $current_status, Date $creation_date, integer $id_in_module, string $identifier, string $type, integer $priority )

Builds an alert from its whole parameters.
public integer
# get_priority( )

Gets the priority of the alert.
public string
# get_properties( )

Gets the alert properties.
public
# set_priority( integer $priority )

Sets the priority of the alert.
public
# set_properties( string $properties )

Sets the properties of the alert.
public string
# get_priority_name( )

Gets the priority name. It's automatically translater to the user language, ready to be displayed.
Methods inherited from Event
build_event(), get_creation_date(), get_entitled(), get_fixing_url(), get_id(), get_id_in_module(), get_identifier(), get_must_regenerate_cache(), get_status(), get_status_name(), get_type(), set_creation_date(), set_entitled(), set_fixing_url(), set_id(), set_id_in_module(), set_identifier(), set_must_regenerate_cache(), set_status(), set_type()
Constants summary
integer ADMIN_ALERT_VERY_LOW_PRIORITY
# 1
integer ADMIN_ALERT_LOW_PRIORITY
# 2
integer ADMIN_ALERT_MEDIUM_PRIORITY
# 3
integer ADMIN_ALERT_HIGH_PRIORITY
# 4
integer ADMIN_ALERT_VERY_HIGH_PRIORITY
# 5
integer ADMIN_ALERT_STATUS_UNREAD
# Event::EVENT_STATUS_UNREAD
integer ADMIN_ALERT_STATUS_PROCESSED
# Event::EVENT_STATUS_PROCESSED
Constants inherited from Event
EVENT_STATUS_BEING_PROCESSED, EVENT_STATUS_PROCESSED, EVENT_STATUS_UNREAD
Properties inherited from Event
$creation_date, $current_status, $entitled, $fixing_url, $id, $id_in_module, $identifier, $must_regenerate_cache, $type