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