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