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 | |
7b66c3b5 | 9 | * (GenCodeChecksum:767fb54121e25d39d9b82cfbb4a5355b) |
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. | |
7b66c3b5 AH |
64 | * |
65 | * @param bool $plural | |
66 | * Whether to return the plural version of the title. | |
449c4e6b | 67 | */ |
7b66c3b5 AH |
68 | public static function getEntityTitle($plural = FALSE) { |
69 | return $plural ? ts('Participant Payments') : ts('Participant Payment'); | |
449c4e6b CW |
70 | } |
71 | ||
e501603b | 72 | /** |
f41f0342 | 73 | * Returns foreign keys and entity references. |
e501603b TO |
74 | * |
75 | * @return array | |
76 | * [CRM_Core_Reference_Interface] | |
77 | */ | |
c3fc2621 | 78 | public static function getReferenceColumns() { |
346aaaba | 79 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
fa45b5b9 | 80 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 CW |
81 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'participant_id', 'civicrm_participant', 'id'); |
82 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contribution_id', 'civicrm_contribution', 'id'); | |
346aaaba | 83 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 84 | } |
346aaaba | 85 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 86 | } |
c3fc2621 | 87 | |
e501603b TO |
88 | /** |
89 | * Returns all the column names of this table | |
90 | * | |
91 | * @return array | |
92 | */ | |
c3fc2621 | 93 | public static function &fields() { |
346aaaba | 94 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
95 | Civi::$statics[__CLASS__]['fields'] = [ |
96 | 'id' => [ | |
e501603b TO |
97 | 'name' => 'id', |
98 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 99 | 'title' => ts('Payment ID'), |
215b423e | 100 | 'description' => ts('Participant Payment Id'), |
c3fc2621 | 101 | 'required' => TRUE, |
a36434b9 | 102 | 'where' => 'civicrm_participant_payment.id', |
522a26c9 | 103 | 'table_name' => 'civicrm_participant_payment', |
104 | 'entity' => 'ParticipantPayment', | |
105 | 'bao' => 'CRM_Event_BAO_ParticipantPayment', | |
6a7e5e5d | 106 | 'localizable' => 0, |
a9d0587b | 107 | 'add' => '1.7', |
c3fc2621 CW |
108 | ], |
109 | 'participant_id' => [ | |
e501603b TO |
110 | 'name' => 'participant_id', |
111 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 112 | 'title' => ts('Participant ID'), |
215b423e | 113 | 'description' => ts('Participant Id (FK)'), |
c3fc2621 | 114 | 'required' => TRUE, |
a36434b9 | 115 | 'where' => 'civicrm_participant_payment.participant_id', |
522a26c9 | 116 | 'table_name' => 'civicrm_participant_payment', |
117 | 'entity' => 'ParticipantPayment', | |
118 | 'bao' => 'CRM_Event_BAO_ParticipantPayment', | |
6a7e5e5d | 119 | 'localizable' => 0, |
e501603b | 120 | 'FKClassName' => 'CRM_Event_DAO_Participant', |
a9d0587b | 121 | 'add' => '1.7', |
c3fc2621 CW |
122 | ], |
123 | 'contribution_id' => [ | |
e501603b TO |
124 | 'name' => 'contribution_id', |
125 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 126 | 'title' => ts('Contribution'), |
215b423e | 127 | 'description' => ts('FK to contribution table.'), |
c3fc2621 | 128 | 'required' => TRUE, |
a36434b9 | 129 | 'where' => 'civicrm_participant_payment.contribution_id', |
522a26c9 | 130 | 'table_name' => 'civicrm_participant_payment', |
131 | 'entity' => 'ParticipantPayment', | |
132 | 'bao' => 'CRM_Event_BAO_ParticipantPayment', | |
6a7e5e5d | 133 | 'localizable' => 0, |
e501603b | 134 | 'FKClassName' => 'CRM_Contribute_DAO_Contribution', |
a9d0587b | 135 | 'add' => '2.0', |
c3fc2621 CW |
136 | ], |
137 | ]; | |
346aaaba | 138 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 139 | } |
346aaaba | 140 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 141 | } |
c3fc2621 | 142 | |
e501603b | 143 | /** |
bd8e0b14 | 144 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
145 | * |
146 | * @return array | |
bd8e0b14 | 147 | * Array(string $name => string $uniqueName). |
e501603b | 148 | */ |
c3fc2621 | 149 | public static function &fieldKeys() { |
bd8e0b14 TO |
150 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
151 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 152 | } |
bd8e0b14 | 153 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 154 | } |
c3fc2621 | 155 | |
e501603b TO |
156 | /** |
157 | * Returns the names of this table | |
158 | * | |
159 | * @return string | |
160 | */ | |
c3fc2621 | 161 | public static function getTableName() { |
e501603b TO |
162 | return self::$_tableName; |
163 | } | |
c3fc2621 | 164 | |
e501603b TO |
165 | /** |
166 | * Returns if this table needs to be logged | |
167 | * | |
c3fc2621 | 168 | * @return bool |
e501603b | 169 | */ |
c3fc2621 | 170 | public function getLog() { |
e501603b TO |
171 | return self::$_log; |
172 | } | |
c3fc2621 | 173 | |
e501603b TO |
174 | /** |
175 | * Returns the list of fields that can be imported | |
176 | * | |
177 | * @param bool $prefix | |
178 | * | |
179 | * @return array | |
180 | */ | |
c3fc2621 CW |
181 | public static function &import($prefix = FALSE) { |
182 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'participant_payment', $prefix, []); | |
60808919 | 183 | return $r; |
e501603b | 184 | } |
c3fc2621 | 185 | |
e501603b TO |
186 | /** |
187 | * Returns the list of fields that can be exported | |
188 | * | |
189 | * @param bool $prefix | |
190 | * | |
191 | * @return array | |
192 | */ | |
c3fc2621 CW |
193 | public static function &export($prefix = FALSE) { |
194 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'participant_payment', $prefix, []); | |
60808919 | 195 | return $r; |
e501603b | 196 | } |
c3fc2621 | 197 | |
e7a6b91a AS |
198 | /** |
199 | * Returns the list of indices | |
c3fc2621 CW |
200 | * |
201 | * @param bool $localize | |
202 | * | |
203 | * @return array | |
e7a6b91a AS |
204 | */ |
205 | public static function indices($localize = TRUE) { | |
c3fc2621 CW |
206 | $indices = [ |
207 | 'UI_contribution_participant' => [ | |
e7a6b91a | 208 | 'name' => 'UI_contribution_participant', |
c3fc2621 | 209 | 'field' => [ |
e7a6b91a AS |
210 | 0 => 'contribution_id', |
211 | 1 => 'participant_id', | |
c3fc2621 CW |
212 | ], |
213 | 'localizable' => FALSE, | |
214 | 'unique' => TRUE, | |
e7a6b91a | 215 | 'sig' => 'civicrm_participant_payment::1::contribution_id::participant_id', |
c3fc2621 CW |
216 | ], |
217 | ]; | |
e7a6b91a AS |
218 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
219 | } | |
c3fc2621 | 220 | |
e501603b | 221 | } |