CRM/Event/DAO/ParticipantPayment.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2018
   6  *
   7  * Generated from xml/schema/CRM/Event/ParticipantPayment.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:293a5e4f208de9a01639960975850cd4)
  10  */
  11
  12 /**
  13  * Database access object for the ParticipantPayment entity.
  14  */
  15 class CRM_Event_DAO_ParticipantPayment extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   static $_tableName = 'civicrm_participant_payment';
  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 Payment Id
  33    *
  34    * @var int unsigned
  35    */
  36   public $id;
  37
  38   /**
  39    * Participant Id (FK)
  40    *
  41    * @var int unsigned
  42    */
  43   public $participant_id;
  44
  45   /**
  46    * FK to contribution table.
  47    *
  48    * @var int unsigned
  49    */
  50   public $contribution_id;
  51
  52   /**
  53    * Class constructor.
  54    */
  55   public function __construct() {
  56     $this->__table = 'civicrm_participant_payment';
  57     parent::__construct();
  58   }
  59
  60   /**
  61    * Returns foreign keys and entity references.
  62    *
  63    * @return array
  64    *   [CRM_Core_Reference_Interface]
  65    */
  66   public static function getReferenceColumns() {
  67     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  68       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
  69       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'participant_id', 'civicrm_participant', 'id');
  70       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contribution_id', 'civicrm_contribution', 'id');
  71       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  72     }
  73     return Civi::$statics[__CLASS__]['links'];
  74   }
  75
  76   /**
  77    * Returns all the column names of this table
  78    *
  79    * @return array
  80    */
  81   public static function &fields() {
  82     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
  83       Civi::$statics[__CLASS__]['fields'] = [
  84         'id' => [
  85           'name' => 'id',
  86           'type' => CRM_Utils_Type::T_INT,
  87           'title' => ts('Payment ID'),
  88           'description' => 'Participant Payment Id',
  89           'required' => TRUE,
  90           'table_name' => 'civicrm_participant_payment',
  91           'entity' => 'ParticipantPayment',
  92           'bao' => 'CRM_Event_BAO_ParticipantPayment',
  93           'localizable' => 0,
  94         ],
  95         'participant_id' => [
  96           'name' => 'participant_id',
  97           'type' => CRM_Utils_Type::T_INT,
  98           'title' => ts('Participant ID'),
  99           'description' => 'Participant Id (FK)',
 100           'required' => TRUE,
 101           'table_name' => 'civicrm_participant_payment',
 102           'entity' => 'ParticipantPayment',
 103           'bao' => 'CRM_Event_BAO_ParticipantPayment',
 104           'localizable' => 0,
 105           'FKClassName' => 'CRM_Event_DAO_Participant',
 106         ],
 107         'contribution_id' => [
 108           'name' => 'contribution_id',
 109           'type' => CRM_Utils_Type::T_INT,
 110           'title' => ts('Contribution'),
 111           'description' => 'FK to contribution table.',
 112           'required' => TRUE,
 113           'table_name' => 'civicrm_participant_payment',
 114           'entity' => 'ParticipantPayment',
 115           'bao' => 'CRM_Event_BAO_ParticipantPayment',
 116           'localizable' => 0,
 117           'FKClassName' => 'CRM_Contribute_DAO_Contribution',
 118         ],
 119       ];
 120       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 121     }
 122     return Civi::$statics[__CLASS__]['fields'];
 123   }
 124
 125   /**
 126    * Return a mapping from field-name to the corresponding key (as used in fields()).
 127    *
 128    * @return array
 129    *   Array(string $name => string $uniqueName).
 130    */
 131   public static function &fieldKeys() {
 132     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 133       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 134     }
 135     return Civi::$statics[__CLASS__]['fieldKeys'];
 136   }
 137
 138   /**
 139    * Returns the names of this table
 140    *
 141    * @return string
 142    */
 143   public static function getTableName() {
 144     return self::$_tableName;
 145   }
 146
 147   /**
 148    * Returns if this table needs to be logged
 149    *
 150    * @return bool
 151    */
 152   public function getLog() {
 153     return self::$_log;
 154   }
 155
 156   /**
 157    * Returns the list of fields that can be imported
 158    *
 159    * @param bool $prefix
 160    *
 161    * @return array
 162    */
 163   public static function &import($prefix = FALSE) {
 164     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'participant_payment', $prefix, []);
 165     return $r;
 166   }
 167
 168   /**
 169    * Returns the list of fields that can be exported
 170    *
 171    * @param bool $prefix
 172    *
 173    * @return array
 174    */
 175   public static function &export($prefix = FALSE) {
 176     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'participant_payment', $prefix, []);
 177     return $r;
 178   }
 179
 180   /**
 181    * Returns the list of indices
 182    *
 183    * @param bool $localize
 184    *
 185    * @return array
 186    */
 187   public static function indices($localize = TRUE) {
 188     $indices = [
 189       'UI_contribution_participant' => [
 190         'name' => 'UI_contribution_participant',
 191         'field' => [
 192           0 => 'contribution_id',
 193           1 => 'participant_id',
 194         ],
 195         'localizable' => FALSE,
 196         'unique' => TRUE,
 197         'sig' => 'civicrm_participant_payment::1::contribution_id::participant_id',
 198       ],
 199     ];
 200     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 201   }
 202
 203 }