5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/Event/ParticipantPayment.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:e968c8fec853683ccda7863407aef635)
13 * Database access object for the ParticipantPayment entity.
15 class CRM_Event_DAO_ParticipantPayment
extends CRM_Core_DAO
{
16 const EXT
= 'civicrm';
17 const TABLE_ADDED
= '1.7';
18 const COMPONENT
= 'CiviEvent';
21 * Static instance to hold the table name.
25 public static $_tableName = 'civicrm_participant_payment';
28 * Should CiviCRM log any modifications to this table in the civicrm_log table.
32 public static $_log = TRUE;
35 * Participant Payment ID
37 * @var int|string|null
38 * (SQL type: int unsigned)
39 * Note that values will be retrieved from the database as a string.
47 * (SQL type: int unsigned)
48 * Note that values will be retrieved from the database as a string.
50 public $participant_id;
53 * FK to contribution table.
56 * (SQL type: int unsigned)
57 * Note that values will be retrieved from the database as a string.
59 public $contribution_id;
64 public function __construct() {
65 $this->__table
= 'civicrm_participant_payment';
66 parent
::__construct();
70 * Returns localized title of this entity.
73 * Whether to return the plural version of the title.
75 public static function getEntityTitle($plural = FALSE) {
76 return $plural ?
ts('Participant Payments') : ts('Participant Payment');
80 * Returns foreign keys and entity references.
83 * [CRM_Core_Reference_Interface]
85 public static function getReferenceColumns() {
86 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
87 Civi
::$statics[__CLASS__
]['links'] = static::createReferenceColumns(__CLASS__
);
88 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'participant_id', 'civicrm_participant', 'id');
89 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'contribution_id', 'civicrm_contribution', 'id');
90 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
92 return Civi
::$statics[__CLASS__
]['links'];
96 * Returns all the column names of this table
100 public static function &fields() {
101 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
102 Civi
::$statics[__CLASS__
]['fields'] = [
105 'type' => CRM_Utils_Type
::T_INT
,
106 'title' => ts('Payment ID'),
107 'description' => ts('Participant Payment ID'),
109 'where' => 'civicrm_participant_payment.id',
110 'table_name' => 'civicrm_participant_payment',
111 'entity' => 'ParticipantPayment',
112 'bao' => 'CRM_Event_BAO_ParticipantPayment',
120 'participant_id' => [
121 'name' => 'participant_id',
122 'type' => CRM_Utils_Type
::T_INT
,
123 'title' => ts('Participant ID'),
124 'description' => ts('Participant ID (FK)'),
126 'where' => 'civicrm_participant_payment.participant_id',
127 'table_name' => 'civicrm_participant_payment',
128 'entity' => 'ParticipantPayment',
129 'bao' => 'CRM_Event_BAO_ParticipantPayment',
131 'FKClassName' => 'CRM_Event_DAO_Participant',
133 'label' => ts("Participant"),
137 'contribution_id' => [
138 'name' => 'contribution_id',
139 'type' => CRM_Utils_Type
::T_INT
,
140 'title' => ts('Contribution ID'),
141 'description' => ts('FK to contribution table.'),
143 'where' => 'civicrm_participant_payment.contribution_id',
144 'table_name' => 'civicrm_participant_payment',
145 'entity' => 'ParticipantPayment',
146 'bao' => 'CRM_Event_BAO_ParticipantPayment',
148 'FKClassName' => 'CRM_Contribute_DAO_Contribution',
150 'label' => ts("Contribution"),
155 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
157 return Civi
::$statics[__CLASS__
]['fields'];
161 * Return a mapping from field-name to the corresponding key (as used in fields()).
164 * Array(string $name => string $uniqueName).
166 public static function &fieldKeys() {
167 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
168 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
170 return Civi
::$statics[__CLASS__
]['fieldKeys'];
174 * Returns the names of this table
178 public static function getTableName() {
179 return self
::$_tableName;
183 * Returns if this table needs to be logged
187 public function getLog() {
192 * Returns the list of fields that can be imported
194 * @param bool $prefix
198 public static function &import($prefix = FALSE) {
199 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'participant_payment', $prefix, []);
204 * Returns the list of fields that can be exported
206 * @param bool $prefix
210 public static function &export($prefix = FALSE) {
211 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'participant_payment', $prefix, []);
216 * Returns the list of indices
218 * @param bool $localize
222 public static function indices($localize = TRUE) {
224 'UI_contribution_participant' => [
225 'name' => 'UI_contribution_participant',
227 0 => 'contribution_id',
228 1 => 'participant_id',
230 'localizable' => FALSE,
232 'sig' => 'civicrm_participant_payment::1::contribution_id::participant_id',
235 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;