Menu
Home
Controls API
Components API
Tutorials
Templating
Global Functions
Website
\Components\Website\Designs
\Components\Website\Media
\Components\Website\Pages
\Components\Website\Pages\Forms
\Components\Website\Posts
\Components\Website\Posts\Categories
Customers
\Components\Customers\Contacts
\Components\Customers\Contacts\Relationships
\Components\Customers\Contacts\Relationships\Types
\Components\Customers\Groups
Marketing
\Components\Marketing\EmailMarketing
\Components\Marketing\Events
\Components\Marketing\Events\Attendees
\Components\Marketing\Events\Categories
\Components\Marketing\Events\Locations
Commerce
\Components\Commerce\Carts
\Components\Commerce\Carts\Current
\Components\Commerce\Configuration\PaymentMethods
\Components\Commerce\Configuration\ShippingMethods
\Components\Commerce\Discounts
\Components\Commerce\Products
\Components\Commerce\Products\Brands
\Components\Commerce\Products\Categories
\Components\Commerce\Products\Inventory
\Components\Commerce\Sales
\Components\Commerce\Sales\Items
\Components\Commerce\Sales\Receipts
\Components\Commerce\Sales\Receipts\Allocations
Settings
\Components\Settings\Administrators
\Components\Settings\CustomFields
\Components\Settings\Domains
Other Apps
\Components\Website\Comments
\Components\Commerce\Affiliates
\Components\Commerce\Affiliates\Administrators
\Components\Commerce\Affiliates\Commissions
\Components\Commerce\Affiliates\Payments
\Components\Commerce\RecurringSales
\Components\Commerce\RecurringSales\StoredCards
Framework
\Framework\Caching
\Framework\Data\Util
\Framework\HTML\Bleacher
\Framework\HTML\Converters
\Framework\HTTP\Cookies
\Framework\HTTP\Redirection
\Framework\HTTP\Request
\Framework\HTTP\Session
\Framework\HTTP\UserAgent
\Framework\I18N\CompanyTypes
\Framework\I18N\Countries
\Framework\I18N\Languages
\Framework\Network\GeoIP
Description
Methods
delete()
get()
getAll()
getAttendeeContactsForEvent()
getAttendeeRSVPStatus()
getColumn()
getCount()
save()
saveColumn()
search()
Fields
\Components\Marketing\Events\
Attendees::
Use this API to create, update and delete the attendees of events.
Methods
Invoke via
\Components\Marketing\Events\Attendees::method()
Click a method name to copy it.
bool
delete(
$iEventAttendeeId, $bDeleteMedia
)
Deletes a record from the database
Parameters
$iEventAttendeeId
int unsigned
A record's event_attendee_id
$bDeleteMedia
mixed
Return
Returns true if record existed and was deleted, otherwise false
array
get(
$iEventAttendeeId
)
Gets a record from the database
Parameters
$iEventAttendeeId
int unsigned
A record's event_attendee_id
Return
Attendees
array
getAll(
$arrQuery
)
Return a set of records from the database
Parameters
$arrQuery
mixed
Return
Array of
Attendees
array
getAttendeeContactsForEvent(
$iEventId, $arrQuery
)
Return all Attendees for a particular event, joined with their Contact rows.
This was implemented here because a searchbox didn't seem to want to call any page-level funcions.
can be used as a datasource.
Parameters
$iEventId
mixed
$arrQuery
mixed
Return
Array of joined Attendee and Contact rows.
string
getAttendeeRSVPStatus(
$iEventId, $iContactId
)
Returns the attendee status of a contact and an event
Parameters
$iEventId
mixed
$iContactId
mixed
Return
Attendee status null|no_rsvp|not_attending|maybe|attending
mixed
getColumn(
$iEventAttendeeId, $strColumn
)
Gets a single field from a record
Parameters
$iEventAttendeeId
int unsigned
A record's event_attendee_id
$strColumn
mixed
Return
mixed
int
getCount(
$arrFilter
)
Returns the number of records in the database (matching the filter if specified)
Parameters
$arrFilter
mixed
Return
int
string|int
save(
$arrEntity
)
Saves a record into the database
Parameters
$arrEntity
mixed
Return
string|int
void
saveColumn(
$iEventAttendeeId, $strColumn, $strValue
)
Saves a specific column of a row into a database
Parameters
$iEventAttendeeId
int unsigned
A record's event_attendee_id
$strColumn
mixed
$strValue
mixed
array
search(
$strSearch, $arrQuery
)
Performs a search
Parameters
$strSearch
mixed
$arrQuery
mixed
Return
Array of
Attendees
that match the search query.
Database Fields
The following fields are used when retrieving and saving entities.
event_attendee_id
int unsigned (10)
event_attendee_attendance_status
Default value: no_rsvp
event_attendee_checked_in
0 or 1
event_attendee_invitation_datetime
datetime
event_attendee_rsvp_datetime
datetime
contact_id
int (11)
contact_company_id
int (11)
event_id
int unsigned (10)
event_attendee_original_attendee_id
int unsigned (10)
event_attendee_parent_attendee_id
int unsigned (10)
event_attendee_guest_count
int (11)
Default value: 1
sale_item_id
int unsigned (10)