5 * @copyright CiviCRM LLC (c) 2004-2018
7 * Generated from xml/schema/CRM/Event/Participant.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:2fe76154a50c0317faace43c47c3456a)
13 * Database access object for the Participant entity.
15 class CRM_Event_DAO_Participant
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 static $_tableName = 'civicrm_participant';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
53 * Participant status ID. FK to civicrm_participant_status_type. Default of 1 should map to status = Registered.
60 * Participant role ID. Implicit FK to civicrm_option_value where option_group = participant_role.
67 * When did contact register for event?
71 public $register_date;
74 * Source of this event registration.
81 * Populate with the label (text) associated with a fee level for paid events with multiple levels. Note that
82 we store the label value and not the key
99 * actual processor fee if known - may be 0.
106 * FK to Participant ID
110 public $registered_by_id;
120 * 3 character string, value derived from config setting.
124 public $fee_currency;
127 * The campaign for which this participant has been registered.
138 public $discount_amount;
141 * FK to civicrm_event_carts
159 public $transferred_to_contact_id;
164 public function __construct() {
165 $this->__table
= 'civicrm_participant';
166 parent
::__construct();
170 * Returns foreign keys and entity references.
173 * [CRM_Core_Reference_Interface]
175 public static function getReferenceColumns() {
176 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
177 Civi
::$statics[__CLASS__
]['links'] = static ::createReferenceColumns(__CLASS__
);
178 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'contact_id', 'civicrm_contact', 'id');
179 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'event_id', 'civicrm_event', 'id');
180 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'status_id', 'civicrm_participant_status_type', 'id');
181 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'registered_by_id', 'civicrm_participant', 'id');
182 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'discount_id', 'civicrm_discount', 'id');
183 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'campaign_id', 'civicrm_campaign', 'id');
184 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'cart_id', 'civicrm_event_carts', 'id');
185 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'transferred_to_contact_id', 'civicrm_contact', 'id');
186 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
188 return Civi
::$statics[__CLASS__
]['links'];
192 * Returns all the column names of this table
196 public static function &fields() {
197 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
198 Civi
::$statics[__CLASS__
]['fields'] = [
199 'participant_id' => [
201 'type' => CRM_Utils_Type
::T_INT
,
202 'title' => ts('Participant ID'),
203 'description' => 'Participant Id',
206 'where' => 'civicrm_participant.id',
207 'headerPattern' => '/(^(participant(.)?)?id$)/i',
210 'table_name' => 'civicrm_participant',
211 'entity' => 'Participant',
212 'bao' => 'CRM_Event_BAO_Participant',
215 'participant_contact_id' => [
216 'name' => 'contact_id',
217 'type' => CRM_Utils_Type
::T_INT
,
218 'title' => ts('Contact ID'),
219 'description' => 'FK to Contact ID',
222 'where' => 'civicrm_participant.contact_id',
223 'headerPattern' => '/contact(.?id)?/i',
226 'table_name' => 'civicrm_participant',
227 'entity' => 'Participant',
228 'bao' => 'CRM_Event_BAO_Participant',
230 'FKClassName' => 'CRM_Contact_DAO_Contact',
233 'name' => 'event_id',
234 'type' => CRM_Utils_Type
::T_INT
,
235 'title' => ts('Event'),
236 'description' => 'FK to Event ID',
239 'where' => 'civicrm_participant.event_id',
240 'headerPattern' => '/event id$/i',
243 'table_name' => 'civicrm_participant',
244 'entity' => 'Participant',
245 'bao' => 'CRM_Event_BAO_Participant',
247 'FKClassName' => 'CRM_Event_DAO_Event',
249 'participant_status_id' => [
250 'name' => 'status_id',
251 'type' => CRM_Utils_Type
::T_INT
,
252 'title' => ts('Participant Status'),
253 'description' => 'Participant status ID. FK to civicrm_participant_status_type. Default of 1 should map to status = Registered.',
256 'where' => 'civicrm_participant.status_id',
257 'headerPattern' => '/(participant.)?(status)$/i',
261 'table_name' => 'civicrm_participant',
262 'entity' => 'Participant',
263 'bao' => 'CRM_Event_BAO_Participant',
265 'FKClassName' => 'CRM_Event_DAO_ParticipantStatusType',
269 'pseudoconstant' => [
270 'table' => 'civicrm_participant_status_type',
272 'labelColumn' => 'label',
275 'participant_role_id' => [
277 'type' => CRM_Utils_Type
::T_STRING
,
278 'title' => ts('Participant Role'),
279 'description' => 'Participant role ID. Implicit FK to civicrm_option_value where option_group = participant_role.',
281 'size' => CRM_Utils_Type
::HUGE
,
283 'where' => 'civicrm_participant.role_id',
284 'headerPattern' => '/(participant.)?(role)$/i',
288 'table_name' => 'civicrm_participant',
289 'entity' => 'Participant',
290 'bao' => 'CRM_Event_BAO_Participant',
292 'serialize' => self
::SERIALIZE_SEPARATOR_TRIMMED
,
296 'pseudoconstant' => [
297 'optionGroupName' => 'participant_role',
298 'optionEditPath' => 'civicrm/admin/options/participant_role',
301 'participant_register_date' => [
302 'name' => 'register_date',
303 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
304 'title' => ts('Register date'),
305 'description' => 'When did contact register for event?',
307 'where' => 'civicrm_participant.register_date',
308 'headerPattern' => '/^(r(egister\s)?date)$/i',
311 'table_name' => 'civicrm_participant',
312 'entity' => 'Participant',
313 'bao' => 'CRM_Event_BAO_Participant',
316 'type' => 'Select Date',
317 'formatType' => 'activityDateTime',
320 'participant_source' => [
322 'type' => CRM_Utils_Type
::T_STRING
,
323 'title' => ts('Participant Source'),
324 'description' => 'Source of this event registration.',
326 'size' => CRM_Utils_Type
::HUGE
,
328 'where' => 'civicrm_participant.source',
329 'headerPattern' => '/(participant.)?(source)$/i',
332 'table_name' => 'civicrm_participant',
333 'entity' => 'Participant',
334 'bao' => 'CRM_Event_BAO_Participant',
340 'participant_fee_level' => [
341 'name' => 'fee_level',
342 'type' => CRM_Utils_Type
::T_TEXT
,
343 'title' => ts('Fee level'),
344 'description' => 'Populate with the label (text) associated with a fee level for paid events with multiple levels. Note that
345 we store the label value and not the key
348 'where' => 'civicrm_participant.fee_level',
349 'headerPattern' => '/^(f(ee\s)?level)$/i',
352 'table_name' => 'civicrm_participant',
353 'entity' => 'Participant',
354 'bao' => 'CRM_Event_BAO_Participant',
356 'serialize' => self
::SERIALIZE_SEPARATOR_BOOKEND
,
358 'participant_is_test' => [
360 'type' => CRM_Utils_Type
::T_BOOLEAN
,
361 'title' => ts('Test'),
363 'where' => 'civicrm_participant.is_test',
364 'headerPattern' => '',
367 'table_name' => 'civicrm_participant',
368 'entity' => 'Participant',
369 'bao' => 'CRM_Event_BAO_Participant',
372 'participant_is_pay_later' => [
373 'name' => 'is_pay_later',
374 'type' => CRM_Utils_Type
::T_BOOLEAN
,
375 'title' => ts('Is Pay Later'),
377 'where' => 'civicrm_participant.is_pay_later',
378 'headerPattern' => '/(is.)?(pay(.)?later)$/i',
381 'table_name' => 'civicrm_participant',
382 'entity' => 'Participant',
383 'bao' => 'CRM_Event_BAO_Participant',
386 'participant_fee_amount' => [
387 'name' => 'fee_amount',
388 'type' => CRM_Utils_Type
::T_MONEY
,
389 'title' => ts('Fee Amount'),
390 'description' => 'actual processor fee if known - may be 0.',
396 'where' => 'civicrm_participant.fee_amount',
397 'headerPattern' => '/fee(.?am(ou)?nt)?/i',
398 'dataPattern' => '/^\d+(\.\d{2})?$/',
400 'table_name' => 'civicrm_participant',
401 'entity' => 'Participant',
402 'bao' => 'CRM_Event_BAO_Participant',
405 'participant_registered_by_id' => [
406 'name' => 'registered_by_id',
407 'type' => CRM_Utils_Type
::T_INT
,
408 'title' => ts('Registered By ID'),
409 'description' => 'FK to Participant ID',
411 'where' => 'civicrm_participant.registered_by_id',
412 'headerPattern' => '',
416 'table_name' => 'civicrm_participant',
417 'entity' => 'Participant',
418 'bao' => 'CRM_Event_BAO_Participant',
420 'FKClassName' => 'CRM_Event_DAO_Participant',
422 'participant_discount_id' => [
423 'name' => 'discount_id',
424 'type' => CRM_Utils_Type
::T_INT
,
425 'title' => ts('Discount ID'),
426 'description' => 'FK to Discount ID',
428 'table_name' => 'civicrm_participant',
429 'entity' => 'Participant',
430 'bao' => 'CRM_Event_BAO_Participant',
432 'FKClassName' => 'CRM_Core_DAO_Discount',
434 'participant_fee_currency' => [
435 'name' => 'fee_currency',
436 'type' => CRM_Utils_Type
::T_STRING
,
437 'title' => ts('Fee Currency'),
438 'description' => '3 character string, value derived from config setting.',
440 'size' => CRM_Utils_Type
::FOUR
,
442 'where' => 'civicrm_participant.fee_currency',
443 'headerPattern' => '/(fee)?.?cur(rency)?/i',
444 'dataPattern' => '/^[A-Z]{3}$/i',
447 'table_name' => 'civicrm_participant',
448 'entity' => 'Participant',
449 'bao' => 'CRM_Event_BAO_Participant',
454 'pseudoconstant' => [
455 'table' => 'civicrm_currency',
456 'keyColumn' => 'name',
457 'labelColumn' => 'full_name',
458 'nameColumn' => 'name',
461 'participant_campaign_id' => [
462 'name' => 'campaign_id',
463 'type' => CRM_Utils_Type
::T_INT
,
464 'title' => ts('Campaign'),
465 'description' => 'The campaign for which this participant has been registered.',
467 'where' => 'civicrm_participant.campaign_id',
468 'headerPattern' => '',
471 'table_name' => 'civicrm_participant',
472 'entity' => 'Participant',
473 'bao' => 'CRM_Event_BAO_Participant',
475 'FKClassName' => 'CRM_Campaign_DAO_Campaign',
476 'pseudoconstant' => [
477 'table' => 'civicrm_campaign',
479 'labelColumn' => 'title',
482 'discount_amount' => [
483 'name' => 'discount_amount',
484 'type' => CRM_Utils_Type
::T_INT
,
485 'title' => ts('Discount Amount'),
486 'description' => 'Discount Amount',
487 'table_name' => 'civicrm_participant',
488 'entity' => 'Participant',
489 'bao' => 'CRM_Event_BAO_Participant',
494 'type' => CRM_Utils_Type
::T_INT
,
495 'title' => ts('Event Cart ID'),
496 'description' => 'FK to civicrm_event_carts',
497 'table_name' => 'civicrm_participant',
498 'entity' => 'Participant',
499 'bao' => 'CRM_Event_BAO_Participant',
501 'FKClassName' => 'CRM_Event_Cart_DAO_Cart',
504 'name' => 'must_wait',
505 'type' => CRM_Utils_Type
::T_INT
,
506 'title' => ts('Must Wait on List'),
507 'description' => 'On Waiting List',
508 'table_name' => 'civicrm_participant',
509 'entity' => 'Participant',
510 'bao' => 'CRM_Event_BAO_Participant',
513 'transferred_to_contact_id' => [
514 'name' => 'transferred_to_contact_id',
515 'type' => CRM_Utils_Type
::T_INT
,
516 'title' => ts('Transferred to Contact ID'),
517 'description' => 'FK to Contact ID',
519 'where' => 'civicrm_participant.transferred_to_contact_id',
520 'headerPattern' => '/transfer(.?id)?/i',
524 'table_name' => 'civicrm_participant',
525 'entity' => 'Participant',
526 'bao' => 'CRM_Event_BAO_Participant',
528 'FKClassName' => 'CRM_Contact_DAO_Contact',
531 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
533 return Civi
::$statics[__CLASS__
]['fields'];
537 * Return a mapping from field-name to the corresponding key (as used in fields()).
540 * Array(string $name => string $uniqueName).
542 public static function &fieldKeys() {
543 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
544 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
546 return Civi
::$statics[__CLASS__
]['fieldKeys'];
550 * Returns the names of this table
554 public static function getTableName() {
555 return self
::$_tableName;
559 * Returns if this table needs to be logged
563 public function getLog() {
568 * Returns the list of fields that can be imported
570 * @param bool $prefix
574 public static function &import($prefix = FALSE) {
575 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'participant', $prefix, []);
580 * Returns the list of fields that can be exported
582 * @param bool $prefix
586 public static function &export($prefix = FALSE) {
587 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'participant', $prefix, []);
592 * Returns the list of indices
594 * @param bool $localize
598 public static function indices($localize = TRUE) {
600 'index_status_id' => [
601 'name' => 'index_status_id',
605 'localizable' => FALSE,
606 'sig' => 'civicrm_participant::0::status_id',
609 'name' => 'index_role_id',
613 'localizable' => FALSE,
614 'sig' => 'civicrm_participant::0::role_id',
617 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;