Docs For Class EventDataHandler

Description

Event handling class, provides common structure to handle event data.

Located in /inc/datahandlers/event.php (line 22)

DataHandler
   |
   --EventDataHandler

Variable Summary

mixed $eid

array $event_insert_data

array $event_update_data

string $language_file

string $language_prefix

Method Summary

array insert_event (array 0)

void update_event (array 0)

void validate_event (array 0)

boolean verify_date ()

boolean verify_description ()

boolean verify_scope (string 0)

boolean verify_subject ()

Variables

mixed $eid = 0 (line 55)

Event ID currently being manipulated by the datahandlers.

array $event_insert_data = array() (line 43)

Array of data inserted in to an event.

array $event_update_data = array() (line 50)

Array of data used to update an event.

string $language_file = 'datahandler_event' (line 29)

The language file used in the data handler.

string $language_prefix = 'eventdata' (line 36)

The prefix for the language variables used in the data handler.

Redefinition of:

DataHandler::$language_prefix: The prefix for the language variables used in the data handler.

Inherited Variables

Inherited from DataHandler

DataHandler::$admin_override
DataHandler::$data
DataHandler::$errors
DataHandler::$is_validated
DataHandler::$method

Methods

insert_event (line 213)

Insert an event into the database.

return: Array of new event details, eid and private.

array insert_event (array 0)

array 0: The array of event data.

update_event (line 255)

Updates an event that is already in the database.

void update_event (array 0)

array 0: The event data array.

validate_event (line 168)

Validate an event.

void validate_event (array 0)

array 0: The event data array.

verify_date (line 96)

Verifies if an event date is valid or not and attempts to fix it

return: True if valid, false if invalid.

boolean verify_date ()

verify_description (line 79)

Verifies if an event description is valid or not and attempts to fix it

return: True if valid, false if invalid.

boolean verify_description ()

verify_scope (line 130)

Verifies if the user is allowed to add public or private events.

return: True or false depending on their permission.

boolean verify_scope (string 0)

string 0: If the event is private (yes) or not (no).

verify_subject (line 62)

Verifies if an event name is valid or not and attempts to fix it

return: True if valid, false if invalid.

boolean verify_subject ()

Inherited Methods

Inherited From DataHandler

DataHandler::Datahandler()
DataHandler::get_errors()
DataHandler::get_friendly_errors()
DataHandler::get_validated()
DataHandler::set_data()
DataHandler::set_error()
DataHandler::set_validated()
DataHandler::verify_yesno_option()