Components \ commerce \ affiliates administrators commissions payments \ configuration paymentmethods \ shippingmethods \ methods delivery discounts \ products brands categories \ recurringsales storedcards \ sales items \ receipts allocations \ customers \ contacts passwords referrertypes \ relationships types \ groups contacts \ marketing \ emailmarketing \ sends contacts unsubscribers \ events attendees locations \ reminders \ automation eventremindertrigger \ settings administrators components configurationitems cpanel customfields \ developer scheduledtasks threads domains \ website \ analytics sessions comments \ designs generator media pages \ posts categories Framework \ architecture publicassets \ assets css javascript \ caching filebased \ components textualids \ data util \ database mainconnection date \ dom currentcontext renderer \ html converters highlighter javascript \ http redirection request session useragent \ i18n companytypes countries languages \ network cidr dns geoip random \ reflection api \ system filenames filesystem toasts
.
.
.
quick access
\ methods

\Components\Marketing\Events::

Class Methods

The following static methods are available on this class:
string configGetValue($strConfigId)
Description
Retrieves the value of a config item for the current component
Parameters
$strConfigId
string
Return
Config item value
array customFieldsForEvent($iEventId, $bPublicOnly)
Description
The Attendee table contains all custom fields for all events, but specific events make use of different columns. Return the relevent custom fields for a particular Event.

Defaults to false.
Parameters
$iEventId
int
The event to get custom fields for.
$bPublicOnly
{Boolean}
Whether to only return public custom fields.
Return
Rows in the configuration custom fields table.
bool delete($strKeyValue, $bDeleteMedia, $strReason)
Description
Deletes an entity and triggers the pre/post component events
Parameters
$strKeyValue
string
$bDeleteMedia
bool
$strReason
mixed
Return
bool
array get($strKey)
Description
Returns an entity
Parameters
$strKey
mixed
Value of the primary key
Return
{Array} getAll($arrProperties)
Description
Return all entities in the database.
Parameters
$arrProperties
mixed
Return
Array of Events
mixed getColumn($strKey, $strColumn)
Description
Returns a single column of an entity
Parameters
$strKey
string
$strColumn
string
Return
mixed
int getCount($arrFilter)
Description
Returns a count of all rows in the data adapter
Parameters
$arrFilter
array
Return
int
string mediaFolderGet($strKey)
Description
Returns the media folder for this data adapter
Parameters
$strKey
mixed
Return
Folder
string renderEventDate($arrEvent)
Description
Return the event date with the format: (On the same day) 1 Sep 2016 2:00pm - 4:00pm. (Different day) 1 Sep 2016 2:00pm - 3 Sep 2016 3:00pm.
Parameters
$arrEvent
mixed
Return
string
string renderTime($arrEvent, $iTime, $strDateFormat, $strTimeFormat)
Description
Return $iTime formatted into a human readable string, in the timezone specified for this event.
Parameters
$arrEvent
array
The event that has the timezone.
$iTime
int
The time offset to render.
$strDateFormat
string
Optionally specify a custom date format.
$strTimeFormat
string
Optionally specify a custom time format.
Return
string
mixed save($arrEntity, $strReason)
Description
Saves an entity and triggers the pre/post component events
Parameters
$arrEntity
array
$strReason
string
Return
mixed
mixed saveColumn($strKeyValue, $strColumn, $strValue, $strReason)
Description
Changes a column of an existing entity Supports primary keys spanning on several columns if passing $strKeyValue as an associative arry
Parameters
$strKeyValue
string
$strColumn
string
$strValue
string
$strReason
string
Return
Id
array search($strSearch, $arrProperties)
Description
Performs a search
Parameters
$strSearch
string
$arrProperties
mixed
Return
array

Database Fields

The following fields are used when retrieving and saving entities.
event_allow_alternate_rsvp
tinyint unsigned (1)
event_allow_guest_rsvp
tinyint unsigned (1)
event_allow_maybe_rsvp
tinyint (1)
Default value: 1
event_attending_count
int unsigned (10)
event_capacity
int (10)
event_capacity_restrictive
tinyint unsigned (1)
event_custom_fields
text
event_description
text
event_end_datetime
datetime
event_guests_require_registration
tinyint (1)
Default value: 1
event_id
int unsigned (10)
event_linked_guest_product
int (10)
event_linked_product
int (10)
event_location_id
int (10)
event_maybe_count
int unsigned (10)
event_norsvp_count
int unsigned (10)
event_notattending_count
int unsigned (10)
event_require_address
tinyint unsigned (1)
event_requires_invitation
tinyint (4)
Default value: 1
event_rsvp_deadline_datetime
datetime
event_start_datetime
datetime
event_timezone
varchar (255)
event_title
varchar (255)