Class Event

__construct() 

Builds an Event object.

set_id(integer $id) 

Sets the id of the event. The id is the corresponding data base entry one.

set_entitled(string $entitled) 

Sets the entitled of the event. The entitled can be considered as the name, it must be explicit.

set_fixing_url(string $fixing_url) 

Sets the URL corresponding to the event. For the contributions and the administrator alerts it's the number URL at which the problem can be solved.

set_status(integer $new_current_status) 

Set the status of the event.

set_creation_date(\Date $date) 

Sets the creation date of the event.

set_id_in_module(integer $id) 

Sets the id in module parameter. It corresponds to the id of the element corresponding to the event in your data base tables.

For example, il you use the events to allow user to purpose some news in your web site, it will be the id of the news added.

set_identifier(string $identifier) 

Sets the event identifier. To retrieve your event, you might need to have a field in which you put some informations, for example a hash or an identifier.

It's that identifier which can be used to filter the events. You don't have to use it, you can let it blank.

set_type(string $type) 

Sets the type of the event. To retrieve your event, you might need to have a type of event, for example if your module has differents kinds of events. With this field, you can specify it.

set_must_regenerate_cache(boolean $must) 

Sets a private property indicating if the changes made on this event imply the regeneration of the events cache.

get_id() : integer

Gets the id of the event (in the event data base).

The id.

get_entitled() : string

Returns the entitled of the event.

The entitled.

get_fixing_url() : string

Returns the URL corresponding to the alert.

Relative URL whose first character is / for the website root.

get_status() : integer

Gets the status of the event. The status is one of those elements: ul> <li>Event::EVENT_STATUS_UNREAD if it's not read.</li> <li>Event::EVENT_STATUS_BEING_PROCESSED if the event is beeing processed</li> <li>Event::EVENT_STATUS_PROCESSED if the event is processed.

Status

get_creation_date() : \Date

Returns the creation date of the event.

Creation date

get_id_in_module() : integer

Gets the id in the module. This value corresponds to the id of the daba base entry associated to the event.

The id in the module.

get_identifier() : string

Gets the identifier of the event. To retrieve your event, you might need to have a field in which you put some informations, for example a hash or an identifier.

It's that identifier which can be used to filter the events.

The identifier of the event.

get_type() : string

Gets the type of the event. To retrieve your event, you might need to have a type of event, for example if your module has differents kinds of events. With this field, you can specify it.

The type.

get_must_regenerate_cache() : boolean

Gets the value indicating if the cache must be generated.

true if the cache has to be generated, false else.

get_status_name() : \The

Gets the event status name. It's automatically translated in the user language.

name of the event status, ready to be displayed.

build_event(integer $id, string $entitled, string $fixing_url, integer $current_status, \Date $creation_date, integer $id_in_module, string $identifier, string $type) 

Builds an event object from its whole parameters.