Events
Table of Contents
Packages
Classes
- CB_Events_Component
- A component that allows certain users to create and manage company events.
- CB_Events_Contest
- CB_Events_Contest class.
- CB_Events_Event
- Handles the creation and management of events.
Functions
- cb_ajax_new_contests() : mixed
- Accepts either a singular contest object or an array of contest objects and adds them to the database.
- cb_ajax_delete_contests() : mixed
- Deletes existing contest objects from the database.
- cb_ajax_new_events() : mixed
- Creates a new event object and saves it to the database.
- cb_ajax_update_events() : mixed
- Updates an existing event object and saves it to the database.
- cb_ajax_delete_events() : mixed
- Deletes an existing event object from the database.
- cb_ajax_get_events() : mixed
- Retrieves event objects from the database.
- cb_ajax_get_event_participants() : mixed
- Retrieves a list of participants for a given event.
- cb_ajax_new_contest() : mixed
- Saves contest placements for a given event.
- cb_ajax_get_bda() : mixed
- cb_ajax_new_bda() : mixed
- cb_ajax_update_bda() : mixed
- cb_ajax_delete_bda() : mixed
- cb_events_new_event() : mixed
- Saves a new event to the database.
- cb_events_new_notifications() : mixed
- Sends out notifications when a new event is created.
- cb_events_update_notifications() : mixed
- CB Events Update Notifications
- cb_setup_events() : mixed
- CB Setup Events
- cb_events_get_calendar_header() : string
- Gets markup for the calendar header.
- cb_events_get_calendar_view() : string
- Outputs a calendar view of events.
- cb_events_rewrite_rules() : mixed
- Adds rewrite rules to the events component so we don't get a false 404 when we update plugins.
Functions
cb_ajax_new_contests()
Accepts either a singular contest object or an array of contest objects and adds them to the database.
cb_ajax_new_contests() : mixed
Tags
cb_ajax_delete_contests()
Deletes existing contest objects from the database.
cb_ajax_delete_contests() : mixed
Tags
cb_ajax_new_events()
Creates a new event object and saves it to the database.
cb_ajax_new_events() : mixed
Tags
cb_ajax_update_events()
Updates an existing event object and saves it to the database.
cb_ajax_update_events() : mixed
Tags
cb_ajax_delete_events()
Deletes an existing event object from the database.
cb_ajax_delete_events() : mixed
Tags
cb_ajax_get_events()
Retrieves event objects from the database.
cb_ajax_get_events() : mixed
Tags
cb_ajax_get_event_participants()
Retrieves a list of participants for a given event.
cb_ajax_get_event_participants() : mixed
Tags
cb_ajax_new_contest()
Saves contest placements for a given event.
cb_ajax_new_contest() : mixed
Tags
cb_ajax_get_bda()
cb_ajax_get_bda() : mixed
cb_ajax_new_bda()
cb_ajax_new_bda() : mixed
cb_ajax_update_bda()
cb_ajax_update_bda() : mixed
cb_ajax_delete_bda()
cb_ajax_delete_bda() : mixed
cb_events_new_event()
Saves a new event to the database.
cb_events_new_event([array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $args : array<string|int, mixed> = []
-
{ An associative array of arguments. Accepts any parameters of a CB_Events_Event object. }
cb_events_new_notifications()
Sends out notifications when a new event is created.
cb_events_new_notifications([array<string|int, mixed> $data = [] ]) : mixed
Parameters
- $data : array<string|int, mixed> = []
-
{ An associative array of key => value pairs from a CB_Events_Event object.
@see CB_Events_Event::save()}
Tags
cb_events_update_notifications()
CB Events Update Notifications
cb_events_update_notifications([mixed $data = [] ]) : mixed
Sends out an update notification when an event is updated.
Parameters
- $data : mixed = []
Tags
cb_setup_events()
CB Setup Events
cb_setup_events() : mixed
Loads our Events component to give us easy access to global values.
Tags
cb_events_get_calendar_header()
Gets markup for the calendar header.
cb_events_get_calendar_header([string $class_prefix = '' ]) : string
Parameters
- $class_prefix : string = ''
-
The prefix to add to the calendar header.
Tags
Return values
string —The formatted header markup.
cb_events_get_calendar_view()
Outputs a calendar view of events.
cb_events_get_calendar_view() : string
Tags
Return values
string —The formatted markup.
cb_events_rewrite_rules()
Adds rewrite rules to the events component so we don't get a false 404 when we update plugins.
cb_events_rewrite_rules() : mixed