Event.php
This api exposes CiviCRM Event.
Table of Contents
Functions
- civicrm_api3_event_create() : array<string|int, mixed>
- Create a Event.
- _civicrm_api3_event_create_spec() : mixed
- Adjust Metadata for Create action.
- _civicrm_api3_event_create_legacy_support_42() : mixed
- Support for schema changes made in 4.2.
- civicrm_api3_event_get() : array<string|int, mixed>
- Get Event record.
- _civicrm_api3_event_get_spec() : mixed
- Adjust Metadata for Get action.
- _civicrm_api3_event_get_legacy_support_42() : mixed
- Support for schema changes made in 4.2.
- civicrm_api3_event_delete() : array<string|int, mixed>
- Delete an existing Event.
- _civicrm_api3_event_getisfull() : mixed
- Add 'is_full' & 'available_seats' to the return array.
- _civicrm_api3_event_getlist_params() : mixed
- Get event list parameters.
- _civicrm_api3_event_getlist_output() : array<string|int, mixed>
- Get event list output.
Functions
civicrm_api3_event_create()
Create a Event.
civicrm_api3_event_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Input parameters.
Tags
Return values
array<string|int, mixed> —API result Array.
_civicrm_api3_event_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_event_create_spec(array<string|int, mixed> &$params) : mixed
The metadata is used for setting defaults, documentation & validation.
Parameters
- $params : array<string|int, mixed>
-
Array of parameters determined by getfields.
_civicrm_api3_event_create_legacy_support_42()
Support for schema changes made in 4.2.
_civicrm_api3_event_create_legacy_support_42(array<string|int, mixed> &$params) : mixed
The main purpose of the API is to provide integrators a level of stability not provided by the core code or schema - this means we have to provide support for api calls (where possible) across schema changes.
Parameters
- $params : array<string|int, mixed>
civicrm_api3_event_get()
Get Event record.
civicrm_api3_event_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —Array of all found event property values.
_civicrm_api3_event_get_spec()
Adjust Metadata for Get action.
_civicrm_api3_event_get_spec(array<string|int, mixed> &$params) : mixed
The metadata is used for setting defaults, documentation & validation.
Parameters
- $params : array<string|int, mixed>
-
Array of parameters determined by getfields.
_civicrm_api3_event_get_legacy_support_42()
Support for schema changes made in 4.2.
_civicrm_api3_event_get_legacy_support_42(array<string|int, mixed> &$event, int $event_id) : mixed
The main purpose of the API is to provide integrators a level of stability not provided by the core code or schema - this means we have to provide support for api calls (where possible) across schema changes.
Parameters
- $event : array<string|int, mixed>
- $event_id : int
civicrm_api3_event_delete()
Delete an existing Event.
civicrm_api3_event_delete(array<string|int, mixed> $params) : array<string|int, mixed>
This API is used for deleting a event given its id.
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>_civicrm_api3_event_getisfull()
Add 'is_full' & 'available_seats' to the return array.
_civicrm_api3_event_getisfull(array<string|int, mixed> &$event, int $event_id) : mixed
(this might be better in the BAO) Default BAO function returns a string if full rather than a Bool - which is more appropriate to a form
Parameters
- $event : array<string|int, mixed>
-
Return array of the event.
- $event_id : int
-
Id of the event to be updated.
_civicrm_api3_event_getlist_params()
Get event list parameters.
_civicrm_api3_event_getlist_params(array<string|int, mixed> &$request) : mixed
Parameters
- $request : array<string|int, mixed>
Tags
_civicrm_api3_event_getlist_output()
Get event list output.
_civicrm_api3_event_getlist_output(array<string|int, mixed> $result, array<string|int, mixed> $request) : array<string|int, mixed>
Parameters
- $result : array<string|int, mixed>
- $request : array<string|int, mixed>