CRM/Event/DAO/Participant.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2017
   6  *
   7  * Generated from xml/schema/CRM/Event/Participant.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:444d0ee69773ce242341f8544e192087)
  10  */
  11
  12 /**
  13  * Database access object for the Participant entity.
  14  */
  15 class CRM_Event_DAO_Participant extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   static $_tableName = 'civicrm_participant';
  23
  24   /**
  25    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  26    *
  27    * @var bool
  28    */
  29   static $_log = TRUE;
  30
  31   /**
  32    * Participant Id
  33    *
  34    * @var int unsigned
  35    */
  36   public $id;
  37
  38   /**
  39    * FK to Contact ID
  40    *
  41    * @var int unsigned
  42    */
  43   public $contact_id;
  44
  45   /**
  46    * FK to Event ID
  47    *
  48    * @var int unsigned
  49    */
  50   public $event_id;
  51
  52   /**
  53    * Participant status ID. FK to civicrm_participant_status_type. Default of 1 should map to status = Registered.
  54    *
  55    * @var int unsigned
  56    */
  57   public $status_id;
  58
  59   /**
  60    * Participant role ID. Implicit FK to civicrm_option_value where option_group = participant_role.
  61    *
  62    * @var string
  63    */
  64   public $role_id;
  65
  66   /**
  67    * When did contact register for event?
  68    *
  69    * @var datetime
  70    */
  71   public $register_date;
  72
  73   /**
  74    * Source of this event registration.
  75    *
  76    * @var string
  77    */
  78   public $source;
  79
  80   /**
  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
  83    *
  84    * @var text
  85    */
  86   public $fee_level;
  87
  88   /**
  89    * @var boolean
  90    */
  91   public $is_test;
  92
  93   /**
  94    * @var boolean
  95    */
  96   public $is_pay_later;
  97
  98   /**
  99    * actual processor fee if known - may be 0.
 100    *
 101    * @var float
 102    */
 103   public $fee_amount;
 104
 105   /**
 106    * FK to Participant ID
 107    *
 108    * @var int unsigned
 109    */
 110   public $registered_by_id;
 111
 112   /**
 113    * FK to Discount ID
 114    *
 115    * @var int unsigned
 116    */
 117   public $discount_id;
 118
 119   /**
 120    * 3 character string, value derived from config setting.
 121    *
 122    * @var string
 123    */
 124   public $fee_currency;
 125
 126   /**
 127    * The campaign for which this participant has been registered.
 128    *
 129    * @var int unsigned
 130    */
 131   public $campaign_id;
 132
 133   /**
 134    * Discount Amount
 135    *
 136    * @var int unsigned
 137    */
 138   public $discount_amount;
 139
 140   /**
 141    * FK to civicrm_event_carts
 142    *
 143    * @var int unsigned
 144    */
 145   public $cart_id;
 146
 147   /**
 148    * On Waiting List
 149    *
 150    * @var int
 151    */
 152   public $must_wait;
 153
 154   /**
 155    * FK to Contact ID
 156    *
 157    * @var int unsigned
 158    */
 159   public $transferred_to_contact_id;
 160
 161   /**
 162    * Class constructor.
 163    */
 164   public function __construct() {
 165     $this->__table = 'civicrm_participant';
 166     parent::__construct();
 167   }
 168
 169   /**
 170    * Returns foreign keys and entity references.
 171    *
 172    * @return array
 173    *   [CRM_Core_Reference_Interface]
 174    */
 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']);
 187     }
 188     return Civi::$statics[__CLASS__]['links'];
 189   }
 190
 191   /**
 192    * Returns all the column names of this table
 193    *
 194    * @return array
 195    */
 196   public static function &fields() {
 197     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 198       Civi::$statics[__CLASS__]['fields'] = [
 199         'participant_id' => [
 200           'name' => 'id',
 201           'type' => CRM_Utils_Type::T_INT,
 202           'title' => ts('Participant ID'),
 203           'description' => 'Participant Id',
 204           'required' => TRUE,
 205           'import' => TRUE,
 206           'where' => 'civicrm_participant.id',
 207           'headerPattern' => '/(^(participant(.)?)?id$)/i',
 208           'dataPattern' => '',
 209           'export' => TRUE,
 210           'table_name' => 'civicrm_participant',
 211           'entity' => 'Participant',
 212           'bao' => 'CRM_Event_BAO_Participant',
 213           'localizable' => 0,
 214         ],
 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',
 220           'required' => TRUE,
 221           'import' => TRUE,
 222           'where' => 'civicrm_participant.contact_id',
 223           'headerPattern' => '/contact(.?id)?/i',
 224           'dataPattern' => '',
 225           'export' => TRUE,
 226           'table_name' => 'civicrm_participant',
 227           'entity' => 'Participant',
 228           'bao' => 'CRM_Event_BAO_Participant',
 229           'localizable' => 0,
 230           'FKClassName' => 'CRM_Contact_DAO_Contact',
 231         ],
 232         'event_id' => [
 233           'name' => 'event_id',
 234           'type' => CRM_Utils_Type::T_INT,
 235           'title' => ts('Event'),
 236           'description' => 'FK to Event ID',
 237           'required' => TRUE,
 238           'import' => TRUE,
 239           'where' => 'civicrm_participant.event_id',
 240           'headerPattern' => '/event id$/i',
 241           'dataPattern' => '',
 242           'export' => TRUE,
 243           'table_name' => 'civicrm_participant',
 244           'entity' => 'Participant',
 245           'bao' => 'CRM_Event_BAO_Participant',
 246           'localizable' => 0,
 247           'FKClassName' => 'CRM_Event_DAO_Event',
 248         ],
 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.',
 254           'required' => TRUE,
 255           'import' => TRUE,
 256           'where' => 'civicrm_participant.status_id',
 257           'headerPattern' => '/(participant.)?(status)$/i',
 258           'dataPattern' => '',
 259           'export' => TRUE,
 260           'default' => '1',
 261           'table_name' => 'civicrm_participant',
 262           'entity' => 'Participant',
 263           'bao' => 'CRM_Event_BAO_Participant',
 264           'localizable' => 0,
 265           'FKClassName' => 'CRM_Event_DAO_ParticipantStatusType',
 266           'html' => [
 267             'type' => 'Select',
 268           ],
 269           'pseudoconstant' => [
 270             'table' => 'civicrm_participant_status_type',
 271             'keyColumn' => 'id',
 272             'labelColumn' => 'label',
 273           ]
 274         ],
 275         'participant_role_id' => [
 276           'name' => '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.',
 280           'maxlength' => 128,
 281           'size' => CRM_Utils_Type::HUGE,
 282           'import' => TRUE,
 283           'where' => 'civicrm_participant.role_id',
 284           'headerPattern' => '/(participant.)?(role)$/i',
 285           'dataPattern' => '',
 286           'export' => TRUE,
 287           'default' => 'NULL',
 288           'table_name' => 'civicrm_participant',
 289           'entity' => 'Participant',
 290           'bao' => 'CRM_Event_BAO_Participant',
 291           'localizable' => 0,
 292           'serialize' => self::SERIALIZE_SEPARATOR_TRIMMED,
 293           'html' => [
 294             'type' => 'Select',
 295           ],
 296           'pseudoconstant' => [
 297             'optionGroupName' => 'participant_role',
 298             'optionEditPath' => 'civicrm/admin/options/participant_role',
 299           ]
 300         ],
 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?',
 306           'import' => TRUE,
 307           'where' => 'civicrm_participant.register_date',
 308           'headerPattern' => '/^(r(egister\s)?date)$/i',
 309           'dataPattern' => '',
 310           'export' => TRUE,
 311           'table_name' => 'civicrm_participant',
 312           'entity' => 'Participant',
 313           'bao' => 'CRM_Event_BAO_Participant',
 314           'localizable' => 0,
 315           'html' => [
 316             'type' => 'Select Date',
 317             'formatType' => 'activityDateTime',
 318           ],
 319         ],
 320         'participant_source' => [
 321           'name' => 'source',
 322           'type' => CRM_Utils_Type::T_STRING,
 323           'title' => ts('Participant Source'),
 324           'description' => 'Source of this event registration.',
 325           'maxlength' => 128,
 326           'size' => CRM_Utils_Type::HUGE,
 327           'import' => TRUE,
 328           'where' => 'civicrm_participant.source',
 329           'headerPattern' => '/(participant.)?(source)$/i',
 330           'dataPattern' => '',
 331           'export' => TRUE,
 332           'table_name' => 'civicrm_participant',
 333           'entity' => 'Participant',
 334           'bao' => 'CRM_Event_BAO_Participant',
 335           'localizable' => 0,
 336         ],
 337         'participant_fee_level' => [
 338           'name' => 'fee_level',
 339           'type' => CRM_Utils_Type::T_TEXT,
 340           'title' => ts('Fee level'),
 341           'description' => 'Populate with the label (text) associated with a fee level for paid events with multiple levels. Note that
 342       we store the label value and not the key
 343     ',
 344           'import' => TRUE,
 345           'where' => 'civicrm_participant.fee_level',
 346           'headerPattern' => '/^(f(ee\s)?level)$/i',
 347           'dataPattern' => '',
 348           'export' => TRUE,
 349           'table_name' => 'civicrm_participant',
 350           'entity' => 'Participant',
 351           'bao' => 'CRM_Event_BAO_Participant',
 352           'localizable' => 0,
 353           'serialize' => self::SERIALIZE_SEPARATOR_BOOKEND,
 354         ],
 355         'participant_is_test' => [
 356           'name' => 'is_test',
 357           'type' => CRM_Utils_Type::T_BOOLEAN,
 358           'title' => ts('Test'),
 359           'import' => TRUE,
 360           'where' => 'civicrm_participant.is_test',
 361           'headerPattern' => '',
 362           'dataPattern' => '',
 363           'export' => TRUE,
 364           'table_name' => 'civicrm_participant',
 365           'entity' => 'Participant',
 366           'bao' => 'CRM_Event_BAO_Participant',
 367           'localizable' => 0,
 368         ],
 369         'participant_is_pay_later' => [
 370           'name' => 'is_pay_later',
 371           'type' => CRM_Utils_Type::T_BOOLEAN,
 372           'title' => ts('Is Pay Later'),
 373           'import' => TRUE,
 374           'where' => 'civicrm_participant.is_pay_later',
 375           'headerPattern' => '/(is.)?(pay(.)?later)$/i',
 376           'dataPattern' => '',
 377           'export' => TRUE,
 378           'table_name' => 'civicrm_participant',
 379           'entity' => 'Participant',
 380           'bao' => 'CRM_Event_BAO_Participant',
 381           'localizable' => 0,
 382         ],
 383         'participant_fee_amount' => [
 384           'name' => 'fee_amount',
 385           'type' => CRM_Utils_Type::T_MONEY,
 386           'title' => ts('Fee Amount'),
 387           'description' => 'actual processor fee if known - may be 0.',
 388           'precision' => [
 389             20,
 390             2
 391           ],
 392           'import' => TRUE,
 393           'where' => 'civicrm_participant.fee_amount',
 394           'headerPattern' => '/fee(.?am(ou)?nt)?/i',
 395           'dataPattern' => '/^\d+(\.\d{2})?$/',
 396           'export' => TRUE,
 397           'table_name' => 'civicrm_participant',
 398           'entity' => 'Participant',
 399           'bao' => 'CRM_Event_BAO_Participant',
 400           'localizable' => 0,
 401         ],
 402         'participant_registered_by_id' => [
 403           'name' => 'registered_by_id',
 404           'type' => CRM_Utils_Type::T_INT,
 405           'title' => ts('Registered By ID'),
 406           'description' => 'FK to Participant ID',
 407           'import' => TRUE,
 408           'where' => 'civicrm_participant.registered_by_id',
 409           'headerPattern' => '',
 410           'dataPattern' => '',
 411           'export' => TRUE,
 412           'default' => 'NULL',
 413           'table_name' => 'civicrm_participant',
 414           'entity' => 'Participant',
 415           'bao' => 'CRM_Event_BAO_Participant',
 416           'localizable' => 0,
 417           'FKClassName' => 'CRM_Event_DAO_Participant',
 418         ],
 419         'participant_discount_id' => [
 420           'name' => 'discount_id',
 421           'type' => CRM_Utils_Type::T_INT,
 422           'title' => ts('Discount ID'),
 423           'description' => 'FK to Discount ID',
 424           'default' => 'NULL',
 425           'table_name' => 'civicrm_participant',
 426           'entity' => 'Participant',
 427           'bao' => 'CRM_Event_BAO_Participant',
 428           'localizable' => 0,
 429           'FKClassName' => 'CRM_Core_DAO_Discount',
 430         ],
 431         'participant_fee_currency' => [
 432           'name' => 'fee_currency',
 433           'type' => CRM_Utils_Type::T_STRING,
 434           'title' => ts('Fee Currency'),
 435           'description' => '3 character string, value derived from config setting.',
 436           'maxlength' => 3,
 437           'size' => CRM_Utils_Type::FOUR,
 438           'import' => TRUE,
 439           'where' => 'civicrm_participant.fee_currency',
 440           'headerPattern' => '/(fee)?.?cur(rency)?/i',
 441           'dataPattern' => '/^[A-Z]{3}$/i',
 442           'export' => TRUE,
 443           'default' => 'NULL',
 444           'table_name' => 'civicrm_participant',
 445           'entity' => 'Participant',
 446           'bao' => 'CRM_Event_BAO_Participant',
 447           'localizable' => 0,
 448           'html' => [
 449             'type' => 'Select',
 450           ],
 451           'pseudoconstant' => [
 452             'table' => 'civicrm_currency',
 453             'keyColumn' => 'name',
 454             'labelColumn' => 'full_name',
 455             'nameColumn' => 'name',
 456           ]
 457         ],
 458         'participant_campaign_id' => [
 459           'name' => 'campaign_id',
 460           'type' => CRM_Utils_Type::T_INT,
 461           'title' => ts('Campaign'),
 462           'description' => 'The campaign for which this participant has been registered.',
 463           'import' => TRUE,
 464           'where' => 'civicrm_participant.campaign_id',
 465           'headerPattern' => '',
 466           'dataPattern' => '',
 467           'export' => TRUE,
 468           'table_name' => 'civicrm_participant',
 469           'entity' => 'Participant',
 470           'bao' => 'CRM_Event_BAO_Participant',
 471           'localizable' => 0,
 472           'FKClassName' => 'CRM_Campaign_DAO_Campaign',
 473           'pseudoconstant' => [
 474             'table' => 'civicrm_campaign',
 475             'keyColumn' => 'id',
 476             'labelColumn' => 'title',
 477           ]
 478         ],
 479         'discount_amount' => [
 480           'name' => 'discount_amount',
 481           'type' => CRM_Utils_Type::T_INT,
 482           'title' => ts('Discount Amount'),
 483           'description' => 'Discount Amount',
 484           'table_name' => 'civicrm_participant',
 485           'entity' => 'Participant',
 486           'bao' => 'CRM_Event_BAO_Participant',
 487           'localizable' => 0,
 488         ],
 489         'cart_id' => [
 490           'name' => 'cart_id',
 491           'type' => CRM_Utils_Type::T_INT,
 492           'title' => ts('Event Cart ID'),
 493           'description' => 'FK to civicrm_event_carts',
 494           'table_name' => 'civicrm_participant',
 495           'entity' => 'Participant',
 496           'bao' => 'CRM_Event_BAO_Participant',
 497           'localizable' => 0,
 498           'FKClassName' => 'CRM_Event_Cart_DAO_Cart',
 499         ],
 500         'must_wait' => [
 501           'name' => 'must_wait',
 502           'type' => CRM_Utils_Type::T_INT,
 503           'title' => ts('Must Wait on List'),
 504           'description' => 'On Waiting List',
 505           'table_name' => 'civicrm_participant',
 506           'entity' => 'Participant',
 507           'bao' => 'CRM_Event_BAO_Participant',
 508           'localizable' => 0,
 509         ],
 510         'transferred_to_contact_id' => [
 511           'name' => 'transferred_to_contact_id',
 512           'type' => CRM_Utils_Type::T_INT,
 513           'title' => ts('Transferred to Contact ID'),
 514           'description' => 'FK to Contact ID',
 515           'import' => TRUE,
 516           'where' => 'civicrm_participant.transferred_to_contact_id',
 517           'headerPattern' => '/transfer(.?id)?/i',
 518           'dataPattern' => '',
 519           'export' => TRUE,
 520           'default' => 'NULL',
 521           'table_name' => 'civicrm_participant',
 522           'entity' => 'Participant',
 523           'bao' => 'CRM_Event_BAO_Participant',
 524           'localizable' => 0,
 525           'FKClassName' => 'CRM_Contact_DAO_Contact',
 526         ],
 527       ];
 528       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 529     }
 530     return Civi::$statics[__CLASS__]['fields'];
 531   }
 532
 533   /**
 534    * Return a mapping from field-name to the corresponding key (as used in fields()).
 535    *
 536    * @return array
 537    *   Array(string $name => string $uniqueName).
 538    */
 539   public static function &fieldKeys() {
 540     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 541       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 542     }
 543     return Civi::$statics[__CLASS__]['fieldKeys'];
 544   }
 545
 546   /**
 547    * Returns the names of this table
 548    *
 549    * @return string
 550    */
 551   public static function getTableName() {
 552     return self::$_tableName;
 553   }
 554
 555   /**
 556    * Returns if this table needs to be logged
 557    *
 558    * @return bool
 559    */
 560   public function getLog() {
 561     return self::$_log;
 562   }
 563
 564   /**
 565    * Returns the list of fields that can be imported
 566    *
 567    * @param bool $prefix
 568    *
 569    * @return array
 570    */
 571   public static function &import($prefix = FALSE) {
 572     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'participant', $prefix, []);
 573     return $r;
 574   }
 575
 576   /**
 577    * Returns the list of fields that can be exported
 578    *
 579    * @param bool $prefix
 580    *
 581    * @return array
 582    */
 583   public static function &export($prefix = FALSE) {
 584     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'participant', $prefix, []);
 585     return $r;
 586   }
 587
 588   /**
 589    * Returns the list of indices
 590    *
 591    * @param bool $localize
 592    *
 593    * @return array
 594    */
 595   public static function indices($localize = TRUE) {
 596     $indices = [
 597       'index_status_id' => [
 598         'name' => 'index_status_id',
 599         'field' => [
 600           0 => 'status_id',
 601         ],
 602         'localizable' => FALSE,
 603         'sig' => 'civicrm_participant::0::status_id',
 604       ],
 605       'index_role_id' => [
 606         'name' => 'index_role_id',
 607         'field' => [
 608           0 => 'role_id',
 609         ],
 610         'localizable' => FALSE,
 611         'sig' => 'civicrm_participant::0::role_id',
 612       ],
 613     ];
 614     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 615   }
 616
 617 }