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/Financial/FinancialTrxn.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
f29bf4f3 | 9 | * (GenCodeChecksum:b4a9dceaf91c13ea192a11b7cb8805ca) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the FinancialTrxn entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Financial_DAO_FinancialTrxn 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_financial_trxn'; |
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 | 31 | /** |
e6ca0a57 | 32 | * @var int |
e501603b TO |
33 | */ |
34 | public $id; | |
c3fc2621 | 35 | |
e501603b TO |
36 | /** |
37 | * FK to financial_account table. | |
38 | * | |
e6ca0a57 | 39 | * @var int |
e501603b TO |
40 | */ |
41 | public $from_financial_account_id; | |
c3fc2621 | 42 | |
e501603b TO |
43 | /** |
44 | * FK to financial_financial_account table. | |
45 | * | |
e6ca0a57 | 46 | * @var int |
e501603b TO |
47 | */ |
48 | public $to_financial_account_id; | |
c3fc2621 | 49 | |
e501603b TO |
50 | /** |
51 | * date transaction occurred | |
52 | * | |
53 | * @var datetime | |
54 | */ | |
55 | public $trxn_date; | |
c3fc2621 | 56 | |
e501603b TO |
57 | /** |
58 | * amount of transaction | |
59 | * | |
60 | * @var float | |
61 | */ | |
62 | public $total_amount; | |
c3fc2621 | 63 | |
e501603b TO |
64 | /** |
65 | * actual processor fee if known - may be 0. | |
66 | * | |
67 | * @var float | |
68 | */ | |
69 | public $fee_amount; | |
c3fc2621 | 70 | |
e501603b TO |
71 | /** |
72 | * actual funds transfer amount. total less fees. if processor does not report actual fee during transaction, this is set to total_amount. | |
73 | * | |
74 | * @var float | |
75 | */ | |
76 | public $net_amount; | |
c3fc2621 | 77 | |
e501603b TO |
78 | /** |
79 | * 3 character string, value from config setting or input via user. | |
80 | * | |
81 | * @var string | |
82 | */ | |
83 | public $currency; | |
c3fc2621 | 84 | |
e501603b TO |
85 | /** |
86 | * Is this entry either a payment or a reversal of a payment? | |
87 | * | |
e6ca0a57 | 88 | * @var bool |
e501603b TO |
89 | */ |
90 | public $is_payment; | |
c3fc2621 | 91 | |
e501603b TO |
92 | /** |
93 | * Transaction id supplied by external processor. This may not be unique. | |
94 | * | |
95 | * @var string | |
96 | */ | |
97 | public $trxn_id; | |
c3fc2621 | 98 | |
e501603b TO |
99 | /** |
100 | * processor result code | |
101 | * | |
102 | * @var string | |
103 | */ | |
104 | public $trxn_result_code; | |
c3fc2621 | 105 | |
e501603b TO |
106 | /** |
107 | * pseudo FK to civicrm_option_value of contribution_status_id option_group | |
108 | * | |
e6ca0a57 | 109 | * @var int |
e501603b TO |
110 | */ |
111 | public $status_id; | |
c3fc2621 | 112 | |
e501603b TO |
113 | /** |
114 | * Payment Processor for this financial transaction | |
115 | * | |
e6ca0a57 | 116 | * @var int |
e501603b TO |
117 | */ |
118 | public $payment_processor_id; | |
c3fc2621 | 119 | |
e501603b TO |
120 | /** |
121 | * FK to payment_instrument option group values | |
122 | * | |
e6ca0a57 | 123 | * @var int |
e501603b TO |
124 | */ |
125 | public $payment_instrument_id; | |
c3fc2621 | 126 | |
ea927522 PN |
127 | /** |
128 | * FK to accept_creditcard option group values | |
129 | * | |
e6ca0a57 | 130 | * @var int |
ea927522 | 131 | */ |
5e0343e8 | 132 | public $card_type_id; |
c3fc2621 | 133 | |
e501603b TO |
134 | /** |
135 | * Check number | |
136 | * | |
137 | * @var string | |
138 | */ | |
139 | public $check_number; | |
c3fc2621 | 140 | |
ea927522 PN |
141 | /** |
142 | * Last 4 digits of credit card | |
143 | * | |
4e0ede5a | 144 | * @var string |
ea927522 PN |
145 | */ |
146 | public $pan_truncation; | |
c3fc2621 | 147 | |
1f34d30a AS |
148 | /** |
149 | * Payment Processor external order reference | |
150 | * | |
151 | * @var string | |
152 | */ | |
153 | public $order_reference; | |
154 | ||
e501603b | 155 | /** |
f41f0342 | 156 | * Class constructor. |
e501603b | 157 | */ |
c3fc2621 | 158 | public function __construct() { |
e501603b TO |
159 | $this->__table = 'civicrm_financial_trxn'; |
160 | parent::__construct(); | |
161 | } | |
c3fc2621 | 162 | |
e501603b | 163 | /** |
f41f0342 | 164 | * Returns foreign keys and entity references. |
e501603b TO |
165 | * |
166 | * @return array | |
167 | * [CRM_Core_Reference_Interface] | |
168 | */ | |
c3fc2621 | 169 | public static function getReferenceColumns() { |
346aaaba | 170 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
fa45b5b9 | 171 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 CW |
172 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'from_financial_account_id', 'civicrm_financial_account', 'id'); |
173 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'to_financial_account_id', 'civicrm_financial_account', 'id'); | |
174 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'payment_processor_id', 'civicrm_payment_processor', 'id'); | |
346aaaba | 175 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 176 | } |
346aaaba | 177 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 178 | } |
c3fc2621 | 179 | |
e501603b TO |
180 | /** |
181 | * Returns all the column names of this table | |
182 | * | |
183 | * @return array | |
184 | */ | |
c3fc2621 | 185 | public static function &fields() { |
346aaaba | 186 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
187 | Civi::$statics[__CLASS__]['fields'] = [ |
188 | 'id' => [ | |
e501603b TO |
189 | 'name' => 'id', |
190 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 CW |
191 | 'title' => ts('Financial Transaction ID'), |
192 | 'required' => TRUE, | |
a36434b9 | 193 | 'where' => 'civicrm_financial_trxn.id', |
522a26c9 | 194 | 'table_name' => 'civicrm_financial_trxn', |
195 | 'entity' => 'FinancialTrxn', | |
196 | 'bao' => 'CRM_Financial_DAO_FinancialTrxn', | |
6a7e5e5d | 197 | 'localizable' => 0, |
c3fc2621 CW |
198 | ], |
199 | 'from_financial_account_id' => [ | |
e501603b TO |
200 | 'name' => 'from_financial_account_id', |
201 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 202 | 'title' => ts('Financial Transaction From Account'), |
215b423e | 203 | 'description' => ts('FK to financial_account table.'), |
a36434b9 | 204 | 'where' => 'civicrm_financial_trxn.from_financial_account_id', |
522a26c9 | 205 | 'table_name' => 'civicrm_financial_trxn', |
206 | 'entity' => 'FinancialTrxn', | |
207 | 'bao' => 'CRM_Financial_DAO_FinancialTrxn', | |
6a7e5e5d | 208 | 'localizable' => 0, |
e501603b | 209 | 'FKClassName' => 'CRM_Financial_DAO_FinancialAccount', |
c3fc2621 | 210 | 'html' => [ |
e501603b | 211 | 'type' => 'Select', |
c3fc2621 CW |
212 | ], |
213 | 'pseudoconstant' => [ | |
e501603b TO |
214 | 'table' => 'civicrm_financial_account', |
215 | 'keyColumn' => 'id', | |
216 | 'labelColumn' => 'name', | |
e6ca0a57 | 217 | ], |
c3fc2621 CW |
218 | ], |
219 | 'to_financial_account_id' => [ | |
e501603b TO |
220 | 'name' => 'to_financial_account_id', |
221 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 222 | 'title' => ts('Financial Transaction To Account'), |
215b423e | 223 | 'description' => ts('FK to financial_financial_account table.'), |
a36434b9 | 224 | 'where' => 'civicrm_financial_trxn.to_financial_account_id', |
522a26c9 | 225 | 'table_name' => 'civicrm_financial_trxn', |
226 | 'entity' => 'FinancialTrxn', | |
227 | 'bao' => 'CRM_Financial_DAO_FinancialTrxn', | |
6a7e5e5d | 228 | 'localizable' => 0, |
e501603b | 229 | 'FKClassName' => 'CRM_Financial_DAO_FinancialAccount', |
c3fc2621 | 230 | 'html' => [ |
e501603b | 231 | 'type' => 'Select', |
c3fc2621 CW |
232 | ], |
233 | 'pseudoconstant' => [ | |
e501603b TO |
234 | 'table' => 'civicrm_financial_account', |
235 | 'keyColumn' => 'id', | |
236 | 'labelColumn' => 'name', | |
e6ca0a57 | 237 | ], |
c3fc2621 CW |
238 | ], |
239 | 'trxn_date' => [ | |
e501603b TO |
240 | 'name' => 'trxn_date', |
241 | 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, | |
c3fc2621 | 242 | 'title' => ts('Financial Transaction Date'), |
215b423e | 243 | 'description' => ts('date transaction occurred'), |
a36434b9 | 244 | 'where' => 'civicrm_financial_trxn.trxn_date', |
e501603b | 245 | 'default' => 'NULL', |
522a26c9 | 246 | 'table_name' => 'civicrm_financial_trxn', |
247 | 'entity' => 'FinancialTrxn', | |
248 | 'bao' => 'CRM_Financial_DAO_FinancialTrxn', | |
6a7e5e5d | 249 | 'localizable' => 0, |
c3fc2621 | 250 | 'html' => [ |
f7fb5615 | 251 | 'type' => 'Select Date', |
252 | 'formatType' => 'activityDateTime', | |
c3fc2621 CW |
253 | ], |
254 | ], | |
255 | 'total_amount' => [ | |
e501603b TO |
256 | 'name' => 'total_amount', |
257 | 'type' => CRM_Utils_Type::T_MONEY, | |
c3fc2621 | 258 | 'title' => ts('Financial Total Amount'), |
215b423e | 259 | 'description' => ts('amount of transaction'), |
c3fc2621 CW |
260 | 'required' => TRUE, |
261 | 'precision' => [ | |
e501603b | 262 | 20, |
fb607354 | 263 | 2, |
c3fc2621 | 264 | ], |
a36434b9 | 265 | 'where' => 'civicrm_financial_trxn.total_amount', |
522a26c9 | 266 | 'table_name' => 'civicrm_financial_trxn', |
267 | 'entity' => 'FinancialTrxn', | |
268 | 'bao' => 'CRM_Financial_DAO_FinancialTrxn', | |
6a7e5e5d | 269 | 'localizable' => 0, |
c3fc2621 CW |
270 | ], |
271 | 'fee_amount' => [ | |
e501603b TO |
272 | 'name' => 'fee_amount', |
273 | 'type' => CRM_Utils_Type::T_MONEY, | |
c3fc2621 | 274 | 'title' => ts('Financial Fee Amount'), |
215b423e | 275 | 'description' => ts('actual processor fee if known - may be 0.'), |
c3fc2621 | 276 | 'precision' => [ |
e501603b | 277 | 20, |
fb607354 | 278 | 2, |
c3fc2621 | 279 | ], |
a36434b9 | 280 | 'where' => 'civicrm_financial_trxn.fee_amount', |
522a26c9 | 281 | 'table_name' => 'civicrm_financial_trxn', |
282 | 'entity' => 'FinancialTrxn', | |
283 | 'bao' => 'CRM_Financial_DAO_FinancialTrxn', | |
6a7e5e5d | 284 | 'localizable' => 0, |
c3fc2621 CW |
285 | ], |
286 | 'net_amount' => [ | |
e501603b TO |
287 | 'name' => 'net_amount', |
288 | 'type' => CRM_Utils_Type::T_MONEY, | |
c3fc2621 | 289 | 'title' => ts('Financial Net Amount'), |
215b423e | 290 | 'description' => ts('actual funds transfer amount. total less fees. if processor does not report actual fee during transaction, this is set to total_amount.'), |
c3fc2621 | 291 | 'precision' => [ |
e501603b | 292 | 20, |
fb607354 | 293 | 2, |
c3fc2621 | 294 | ], |
a36434b9 | 295 | 'where' => 'civicrm_financial_trxn.net_amount', |
522a26c9 | 296 | 'table_name' => 'civicrm_financial_trxn', |
297 | 'entity' => 'FinancialTrxn', | |
298 | 'bao' => 'CRM_Financial_DAO_FinancialTrxn', | |
6a7e5e5d | 299 | 'localizable' => 0, |
c3fc2621 CW |
300 | ], |
301 | 'currency' => [ | |
e501603b TO |
302 | 'name' => 'currency', |
303 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 304 | 'title' => ts('Financial Currency'), |
215b423e | 305 | 'description' => ts('3 character string, value from config setting or input via user.'), |
e501603b TO |
306 | 'maxlength' => 3, |
307 | 'size' => CRM_Utils_Type::FOUR, | |
c3fc2621 | 308 | 'import' => TRUE, |
e501603b TO |
309 | 'where' => 'civicrm_financial_trxn.currency', |
310 | 'headerPattern' => '/cur(rency)?/i', | |
311 | 'dataPattern' => '/^[A-Z]{3}$/', | |
c3fc2621 | 312 | 'export' => TRUE, |
e501603b | 313 | 'default' => 'NULL', |
522a26c9 | 314 | 'table_name' => 'civicrm_financial_trxn', |
315 | 'entity' => 'FinancialTrxn', | |
316 | 'bao' => 'CRM_Financial_DAO_FinancialTrxn', | |
6a7e5e5d | 317 | 'localizable' => 0, |
c3fc2621 | 318 | 'html' => [ |
e501603b | 319 | 'type' => 'Select', |
c3fc2621 CW |
320 | ], |
321 | 'pseudoconstant' => [ | |
e501603b TO |
322 | 'table' => 'civicrm_currency', |
323 | 'keyColumn' => 'name', | |
324 | 'labelColumn' => 'full_name', | |
325 | 'nameColumn' => 'name', | |
a8fdb24e | 326 | 'abbrColumn' => 'symbol', |
e6ca0a57 | 327 | ], |
c3fc2621 CW |
328 | ], |
329 | 'is_payment' => [ | |
e501603b TO |
330 | 'name' => 'is_payment', |
331 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 332 | 'title' => ts('Is Payment?'), |
215b423e | 333 | 'description' => ts('Is this entry either a payment or a reversal of a payment?'), |
c3fc2621 | 334 | 'import' => TRUE, |
e501603b | 335 | 'where' => 'civicrm_financial_trxn.is_payment', |
c3fc2621 | 336 | 'export' => TRUE, |
45a83e42 | 337 | 'default' => '0', |
522a26c9 | 338 | 'table_name' => 'civicrm_financial_trxn', |
339 | 'entity' => 'FinancialTrxn', | |
340 | 'bao' => 'CRM_Financial_DAO_FinancialTrxn', | |
6a7e5e5d | 341 | 'localizable' => 0, |
c3fc2621 CW |
342 | ], |
343 | 'trxn_id' => [ | |
e501603b TO |
344 | 'name' => 'trxn_id', |
345 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 346 | 'title' => ts('Transaction ID'), |
215b423e | 347 | 'description' => ts('Transaction id supplied by external processor. This may not be unique.'), |
e501603b | 348 | 'maxlength' => 255, |
a7a8f17d | 349 | 'size' => 10, |
a36434b9 | 350 | 'where' => 'civicrm_financial_trxn.trxn_id', |
522a26c9 | 351 | 'table_name' => 'civicrm_financial_trxn', |
352 | 'entity' => 'FinancialTrxn', | |
353 | 'bao' => 'CRM_Financial_DAO_FinancialTrxn', | |
6a7e5e5d | 354 | 'localizable' => 0, |
c3fc2621 | 355 | 'html' => [ |
a7a8f17d | 356 | 'type' => 'Text', |
c3fc2621 CW |
357 | ], |
358 | ], | |
359 | 'trxn_result_code' => [ | |
e501603b TO |
360 | 'name' => 'trxn_result_code', |
361 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 362 | 'title' => ts('Transaction Result Code'), |
215b423e | 363 | 'description' => ts('processor result code'), |
e501603b TO |
364 | 'maxlength' => 255, |
365 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 366 | 'where' => 'civicrm_financial_trxn.trxn_result_code', |
522a26c9 | 367 | 'table_name' => 'civicrm_financial_trxn', |
368 | 'entity' => 'FinancialTrxn', | |
369 | 'bao' => 'CRM_Financial_DAO_FinancialTrxn', | |
6a7e5e5d | 370 | 'localizable' => 0, |
c3fc2621 CW |
371 | ], |
372 | 'status_id' => [ | |
e501603b TO |
373 | 'name' => 'status_id', |
374 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 375 | 'title' => ts('Financial Transaction Status Id'), |
215b423e | 376 | 'description' => ts('pseudo FK to civicrm_option_value of contribution_status_id option_group'), |
c3fc2621 | 377 | 'import' => TRUE, |
e501603b TO |
378 | 'where' => 'civicrm_financial_trxn.status_id', |
379 | 'headerPattern' => '/status/i', | |
c3fc2621 | 380 | 'export' => TRUE, |
522a26c9 | 381 | 'table_name' => 'civicrm_financial_trxn', |
382 | 'entity' => 'FinancialTrxn', | |
383 | 'bao' => 'CRM_Financial_DAO_FinancialTrxn', | |
6a7e5e5d | 384 | 'localizable' => 0, |
c3fc2621 | 385 | 'pseudoconstant' => [ |
e501603b TO |
386 | 'optionGroupName' => 'contribution_status', |
387 | 'optionEditPath' => 'civicrm/admin/options/contribution_status', | |
e6ca0a57 | 388 | ], |
c3fc2621 CW |
389 | ], |
390 | 'payment_processor_id' => [ | |
e501603b TO |
391 | 'name' => 'payment_processor_id', |
392 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 393 | 'title' => ts('Payment Processor'), |
215b423e | 394 | 'description' => ts('Payment Processor for this financial transaction'), |
a36434b9 | 395 | 'where' => 'civicrm_financial_trxn.payment_processor_id', |
522a26c9 | 396 | 'table_name' => 'civicrm_financial_trxn', |
397 | 'entity' => 'FinancialTrxn', | |
398 | 'bao' => 'CRM_Financial_DAO_FinancialTrxn', | |
6a7e5e5d | 399 | 'localizable' => 0, |
e501603b | 400 | 'FKClassName' => 'CRM_Financial_DAO_PaymentProcessor', |
c3fc2621 CW |
401 | ], |
402 | 'financial_trxn_payment_instrument_id' => [ | |
e501603b TO |
403 | 'name' => 'payment_instrument_id', |
404 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 405 | 'title' => ts('Payment Method'), |
215b423e | 406 | 'description' => ts('FK to payment_instrument option group values'), |
a36434b9 | 407 | 'where' => 'civicrm_financial_trxn.payment_instrument_id', |
522a26c9 | 408 | 'table_name' => 'civicrm_financial_trxn', |
409 | 'entity' => 'FinancialTrxn', | |
410 | 'bao' => 'CRM_Financial_DAO_FinancialTrxn', | |
6a7e5e5d | 411 | 'localizable' => 0, |
c3fc2621 | 412 | 'html' => [ |
e501603b | 413 | 'type' => 'Select', |
c3fc2621 CW |
414 | ], |
415 | 'pseudoconstant' => [ | |
e501603b TO |
416 | 'optionGroupName' => 'payment_instrument', |
417 | 'optionEditPath' => 'civicrm/admin/options/payment_instrument', | |
e6ca0a57 | 418 | ], |
c3fc2621 CW |
419 | ], |
420 | 'financial_trxn_card_type_id' => [ | |
5e0343e8 | 421 | 'name' => 'card_type_id', |
ea927522 | 422 | 'type' => CRM_Utils_Type::T_INT, |
c3fc2621 | 423 | 'title' => ts('Card Type ID'), |
215b423e | 424 | 'description' => ts('FK to accept_creditcard option group values'), |
a36434b9 | 425 | 'where' => 'civicrm_financial_trxn.card_type_id', |
ea927522 PN |
426 | 'table_name' => 'civicrm_financial_trxn', |
427 | 'entity' => 'FinancialTrxn', | |
428 | 'bao' => 'CRM_Financial_DAO_FinancialTrxn', | |
6a7e5e5d | 429 | 'localizable' => 0, |
c3fc2621 | 430 | 'html' => [ |
ea927522 | 431 | 'type' => 'Select', |
c3fc2621 CW |
432 | ], |
433 | 'pseudoconstant' => [ | |
ea927522 PN |
434 | 'optionGroupName' => 'accept_creditcard', |
435 | 'optionEditPath' => 'civicrm/admin/options/accept_creditcard', | |
e6ca0a57 | 436 | ], |
c3fc2621 CW |
437 | ], |
438 | 'financial_trxn_check_number' => [ | |
e501603b TO |
439 | 'name' => 'check_number', |
440 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 441 | 'title' => ts('Check Number'), |
215b423e | 442 | 'description' => ts('Check number'), |
e501603b TO |
443 | 'maxlength' => 255, |
444 | 'size' => 6, | |
a36434b9 | 445 | 'where' => 'civicrm_financial_trxn.check_number', |
522a26c9 | 446 | 'table_name' => 'civicrm_financial_trxn', |
447 | 'entity' => 'FinancialTrxn', | |
448 | 'bao' => 'CRM_Financial_DAO_FinancialTrxn', | |
6a7e5e5d | 449 | 'localizable' => 0, |
c3fc2621 | 450 | 'html' => [ |
e501603b | 451 | 'type' => 'Text', |
c3fc2621 CW |
452 | ], |
453 | ], | |
454 | 'financial_trxn_pan_truncation' => [ | |
ea927522 | 455 | 'name' => 'pan_truncation', |
4e0ede5a | 456 | 'type' => CRM_Utils_Type::T_STRING, |
c3fc2621 | 457 | 'title' => ts('Pan Truncation'), |
215b423e | 458 | 'description' => ts('Last 4 digits of credit card'), |
4e0ede5a PN |
459 | 'maxlength' => 4, |
460 | 'size' => 4, | |
a36434b9 | 461 | 'where' => 'civicrm_financial_trxn.pan_truncation', |
ea927522 PN |
462 | 'table_name' => 'civicrm_financial_trxn', |
463 | 'entity' => 'FinancialTrxn', | |
464 | 'bao' => 'CRM_Financial_DAO_FinancialTrxn', | |
6a7e5e5d | 465 | 'localizable' => 0, |
c3fc2621 | 466 | 'html' => [ |
ea927522 | 467 | 'type' => 'Text', |
c3fc2621 CW |
468 | ], |
469 | ], | |
1f34d30a AS |
470 | 'financial_trxn_order_reference' => [ |
471 | 'name' => 'order_reference', | |
472 | 'type' => CRM_Utils_Type::T_STRING, | |
473 | 'title' => ts('Order Reference'), | |
474 | 'description' => ts('Payment Processor external order reference'), | |
475 | 'maxlength' => 255, | |
476 | 'size' => 25, | |
477 | 'where' => 'civicrm_financial_trxn.order_reference', | |
478 | 'table_name' => 'civicrm_financial_trxn', | |
479 | 'entity' => 'FinancialTrxn', | |
480 | 'bao' => 'CRM_Financial_DAO_FinancialTrxn', | |
481 | 'localizable' => 0, | |
482 | 'html' => [ | |
483 | 'type' => 'Text', | |
484 | ], | |
485 | ], | |
c3fc2621 | 486 | ]; |
346aaaba | 487 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 488 | } |
346aaaba | 489 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 490 | } |
c3fc2621 | 491 | |
e501603b | 492 | /** |
bd8e0b14 | 493 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
494 | * |
495 | * @return array | |
bd8e0b14 | 496 | * Array(string $name => string $uniqueName). |
e501603b | 497 | */ |
c3fc2621 | 498 | public static function &fieldKeys() { |
bd8e0b14 TO |
499 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
500 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 501 | } |
bd8e0b14 | 502 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 503 | } |
c3fc2621 | 504 | |
e501603b TO |
505 | /** |
506 | * Returns the names of this table | |
507 | * | |
508 | * @return string | |
509 | */ | |
c3fc2621 | 510 | public static function getTableName() { |
e501603b TO |
511 | return self::$_tableName; |
512 | } | |
c3fc2621 | 513 | |
e501603b TO |
514 | /** |
515 | * Returns if this table needs to be logged | |
516 | * | |
c3fc2621 | 517 | * @return bool |
e501603b | 518 | */ |
c3fc2621 | 519 | public function getLog() { |
e501603b TO |
520 | return self::$_log; |
521 | } | |
c3fc2621 | 522 | |
e501603b TO |
523 | /** |
524 | * Returns the list of fields that can be imported | |
525 | * | |
526 | * @param bool $prefix | |
527 | * | |
528 | * @return array | |
529 | */ | |
c3fc2621 CW |
530 | public static function &import($prefix = FALSE) { |
531 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'financial_trxn', $prefix, []); | |
60808919 | 532 | return $r; |
e501603b | 533 | } |
c3fc2621 | 534 | |
e501603b TO |
535 | /** |
536 | * Returns the list of fields that can be exported | |
537 | * | |
538 | * @param bool $prefix | |
539 | * | |
540 | * @return array | |
541 | */ | |
c3fc2621 CW |
542 | public static function &export($prefix = FALSE) { |
543 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'financial_trxn', $prefix, []); | |
60808919 | 544 | return $r; |
e501603b | 545 | } |
c3fc2621 | 546 | |
e7a6b91a AS |
547 | /** |
548 | * Returns the list of indices | |
c3fc2621 CW |
549 | * |
550 | * @param bool $localize | |
551 | * | |
552 | * @return array | |
e7a6b91a AS |
553 | */ |
554 | public static function indices($localize = TRUE) { | |
c3fc2621 CW |
555 | $indices = [ |
556 | 'UI_ftrxn_trxn_id' => [ | |
e7a6b91a | 557 | 'name' => 'UI_ftrxn_trxn_id', |
c3fc2621 | 558 | 'field' => [ |
e7a6b91a | 559 | 0 => 'trxn_id', |
c3fc2621 CW |
560 | ], |
561 | 'localizable' => FALSE, | |
e7a6b91a | 562 | 'sig' => 'civicrm_financial_trxn::0::trxn_id', |
c3fc2621 CW |
563 | ], |
564 | 'UI_ftrxn_payment_instrument_id' => [ | |
e7a6b91a | 565 | 'name' => 'UI_ftrxn_payment_instrument_id', |
c3fc2621 | 566 | 'field' => [ |
e7a6b91a | 567 | 0 => 'payment_instrument_id', |
c3fc2621 CW |
568 | ], |
569 | 'localizable' => FALSE, | |
e7a6b91a | 570 | 'sig' => 'civicrm_financial_trxn::0::payment_instrument_id', |
c3fc2621 CW |
571 | ], |
572 | 'UI_ftrxn_check_number' => [ | |
e7a6b91a | 573 | 'name' => 'UI_ftrxn_check_number', |
c3fc2621 | 574 | 'field' => [ |
e7a6b91a | 575 | 0 => 'check_number', |
c3fc2621 CW |
576 | ], |
577 | 'localizable' => FALSE, | |
e7a6b91a | 578 | 'sig' => 'civicrm_financial_trxn::0::check_number', |
c3fc2621 CW |
579 | ], |
580 | ]; | |
e7a6b91a AS |
581 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
582 | } | |
c3fc2621 | 583 | |
e501603b | 584 | } |