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/Pledge/PledgePayment.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
f29bf4f3 | 9 | * (GenCodeChecksum:cfecdde34ba28e4860662441f0f234f5) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the PledgePayment entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Pledge_DAO_PledgePayment 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_pledge_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 | 31 | /** |
e6ca0a57 | 32 | * @var int |
e501603b TO |
33 | */ |
34 | public $id; | |
c3fc2621 | 35 | |
e501603b TO |
36 | /** |
37 | * FK to Pledge table | |
38 | * | |
e6ca0a57 | 39 | * @var int |
e501603b TO |
40 | */ |
41 | public $pledge_id; | |
c3fc2621 | 42 | |
e501603b TO |
43 | /** |
44 | * FK to contribution table. | |
45 | * | |
e6ca0a57 | 46 | * @var int |
e501603b TO |
47 | */ |
48 | public $contribution_id; | |
c3fc2621 | 49 | |
e501603b TO |
50 | /** |
51 | * Pledged amount for this payment (the actual contribution amount might be different). | |
52 | * | |
53 | * @var float | |
54 | */ | |
55 | public $scheduled_amount; | |
c3fc2621 | 56 | |
e501603b TO |
57 | /** |
58 | * Actual amount that is paid as the Pledged installment amount. | |
59 | * | |
60 | * @var float | |
61 | */ | |
62 | public $actual_amount; | |
c3fc2621 | 63 | |
e501603b TO |
64 | /** |
65 | * 3 character string, value from config setting or input via user. | |
66 | * | |
67 | * @var string | |
68 | */ | |
69 | public $currency; | |
c3fc2621 | 70 | |
e501603b TO |
71 | /** |
72 | * The date the pledge payment is supposed to happen. | |
73 | * | |
74 | * @var datetime | |
75 | */ | |
76 | public $scheduled_date; | |
c3fc2621 | 77 | |
e501603b TO |
78 | /** |
79 | * The date that the most recent payment reminder was sent. | |
80 | * | |
81 | * @var datetime | |
82 | */ | |
83 | public $reminder_date; | |
c3fc2621 | 84 | |
e501603b TO |
85 | /** |
86 | * The number of payment reminders sent. | |
87 | * | |
e6ca0a57 | 88 | * @var int |
e501603b TO |
89 | */ |
90 | public $reminder_count; | |
c3fc2621 | 91 | |
e501603b | 92 | /** |
e6ca0a57 | 93 | * @var int |
e501603b TO |
94 | */ |
95 | public $status_id; | |
c3fc2621 | 96 | |
e501603b | 97 | /** |
f41f0342 | 98 | * Class constructor. |
e501603b | 99 | */ |
c3fc2621 | 100 | public function __construct() { |
e501603b TO |
101 | $this->__table = 'civicrm_pledge_payment'; |
102 | parent::__construct(); | |
103 | } | |
c3fc2621 | 104 | |
e501603b | 105 | /** |
f41f0342 | 106 | * Returns foreign keys and entity references. |
e501603b TO |
107 | * |
108 | * @return array | |
109 | * [CRM_Core_Reference_Interface] | |
110 | */ | |
c3fc2621 | 111 | public static function getReferenceColumns() { |
346aaaba | 112 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
fa45b5b9 | 113 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 CW |
114 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'pledge_id', 'civicrm_pledge', 'id'); |
115 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contribution_id', 'civicrm_contribution', 'id'); | |
346aaaba | 116 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 117 | } |
346aaaba | 118 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 119 | } |
c3fc2621 | 120 | |
e501603b TO |
121 | /** |
122 | * Returns all the column names of this table | |
123 | * | |
124 | * @return array | |
125 | */ | |
c3fc2621 | 126 | public static function &fields() { |
346aaaba | 127 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
128 | Civi::$statics[__CLASS__]['fields'] = [ |
129 | 'pledge_payment_id' => [ | |
e501603b TO |
130 | 'name' => 'id', |
131 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 CW |
132 | 'title' => ts('Payment ID'), |
133 | 'required' => TRUE, | |
134 | 'import' => TRUE, | |
e501603b | 135 | 'where' => 'civicrm_pledge_payment.id', |
c3fc2621 | 136 | 'export' => TRUE, |
522a26c9 | 137 | 'table_name' => 'civicrm_pledge_payment', |
138 | 'entity' => 'PledgePayment', | |
139 | 'bao' => 'CRM_Pledge_BAO_PledgePayment', | |
6a7e5e5d | 140 | 'localizable' => 0, |
c3fc2621 CW |
141 | ], |
142 | 'pledge_id' => [ | |
e501603b TO |
143 | 'name' => 'pledge_id', |
144 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 145 | 'title' => ts('Pledge'), |
215b423e | 146 | 'description' => ts('FK to Pledge table'), |
c3fc2621 | 147 | 'required' => TRUE, |
a36434b9 | 148 | 'where' => 'civicrm_pledge_payment.pledge_id', |
522a26c9 | 149 | 'table_name' => 'civicrm_pledge_payment', |
150 | 'entity' => 'PledgePayment', | |
151 | 'bao' => 'CRM_Pledge_BAO_PledgePayment', | |
6a7e5e5d | 152 | 'localizable' => 0, |
e501603b | 153 | 'FKClassName' => 'CRM_Pledge_DAO_Pledge', |
c3fc2621 CW |
154 | ], |
155 | 'contribution_id' => [ | |
e501603b TO |
156 | 'name' => 'contribution_id', |
157 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 158 | 'title' => ts('Contribution'), |
215b423e | 159 | 'description' => ts('FK to contribution table.'), |
a36434b9 | 160 | 'where' => 'civicrm_pledge_payment.contribution_id', |
522a26c9 | 161 | 'table_name' => 'civicrm_pledge_payment', |
162 | 'entity' => 'PledgePayment', | |
163 | 'bao' => 'CRM_Pledge_BAO_PledgePayment', | |
6a7e5e5d | 164 | 'localizable' => 0, |
e501603b | 165 | 'FKClassName' => 'CRM_Contribute_DAO_Contribution', |
c3fc2621 CW |
166 | ], |
167 | 'pledge_payment_scheduled_amount' => [ | |
e501603b TO |
168 | 'name' => 'scheduled_amount', |
169 | 'type' => CRM_Utils_Type::T_MONEY, | |
c3fc2621 | 170 | 'title' => ts('Scheduled Amount'), |
215b423e | 171 | 'description' => ts('Pledged amount for this payment (the actual contribution amount might be different).'), |
c3fc2621 CW |
172 | 'required' => TRUE, |
173 | 'precision' => [ | |
e501603b | 174 | 20, |
fb607354 | 175 | 2, |
c3fc2621 CW |
176 | ], |
177 | 'import' => TRUE, | |
e501603b | 178 | 'where' => 'civicrm_pledge_payment.scheduled_amount', |
c3fc2621 | 179 | 'export' => TRUE, |
522a26c9 | 180 | 'table_name' => 'civicrm_pledge_payment', |
181 | 'entity' => 'PledgePayment', | |
182 | 'bao' => 'CRM_Pledge_BAO_PledgePayment', | |
6a7e5e5d | 183 | 'localizable' => 0, |
c3fc2621 CW |
184 | ], |
185 | 'pledge_payment_actual_amount' => [ | |
e501603b TO |
186 | 'name' => 'actual_amount', |
187 | 'type' => CRM_Utils_Type::T_MONEY, | |
c3fc2621 | 188 | 'title' => ts('Actual Amount'), |
215b423e | 189 | 'description' => ts('Actual amount that is paid as the Pledged installment amount.'), |
c3fc2621 | 190 | 'precision' => [ |
e501603b | 191 | 20, |
fb607354 | 192 | 2, |
c3fc2621 CW |
193 | ], |
194 | 'import' => TRUE, | |
e501603b | 195 | 'where' => 'civicrm_pledge_payment.actual_amount', |
c3fc2621 | 196 | 'export' => TRUE, |
522a26c9 | 197 | 'table_name' => 'civicrm_pledge_payment', |
198 | 'entity' => 'PledgePayment', | |
199 | 'bao' => 'CRM_Pledge_BAO_PledgePayment', | |
6a7e5e5d | 200 | 'localizable' => 0, |
c3fc2621 CW |
201 | ], |
202 | 'currency' => [ | |
e501603b TO |
203 | 'name' => 'currency', |
204 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 205 | 'title' => ts('Currency'), |
215b423e | 206 | 'description' => ts('3 character string, value from config setting or input via user.'), |
e501603b TO |
207 | 'maxlength' => 3, |
208 | 'size' => CRM_Utils_Type::FOUR, | |
a36434b9 | 209 | 'where' => 'civicrm_pledge_payment.currency', |
e501603b | 210 | 'default' => 'NULL', |
522a26c9 | 211 | 'table_name' => 'civicrm_pledge_payment', |
212 | 'entity' => 'PledgePayment', | |
213 | 'bao' => 'CRM_Pledge_BAO_PledgePayment', | |
6a7e5e5d | 214 | 'localizable' => 0, |
c3fc2621 | 215 | 'html' => [ |
e501603b | 216 | 'type' => 'Select', |
c3fc2621 CW |
217 | ], |
218 | 'pseudoconstant' => [ | |
e501603b TO |
219 | 'table' => 'civicrm_currency', |
220 | 'keyColumn' => 'name', | |
221 | 'labelColumn' => 'full_name', | |
222 | 'nameColumn' => 'name', | |
a8fdb24e | 223 | 'abbrColumn' => 'symbol', |
e6ca0a57 | 224 | ], |
c3fc2621 CW |
225 | ], |
226 | 'pledge_payment_scheduled_date' => [ | |
e501603b TO |
227 | 'name' => 'scheduled_date', |
228 | 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, | |
c3fc2621 | 229 | 'title' => ts('Scheduled Date'), |
215b423e | 230 | 'description' => ts('The date the pledge payment is supposed to happen.'), |
c3fc2621 CW |
231 | 'required' => TRUE, |
232 | 'import' => TRUE, | |
e501603b | 233 | 'where' => 'civicrm_pledge_payment.scheduled_date', |
c3fc2621 | 234 | 'export' => TRUE, |
522a26c9 | 235 | 'table_name' => 'civicrm_pledge_payment', |
236 | 'entity' => 'PledgePayment', | |
237 | 'bao' => 'CRM_Pledge_BAO_PledgePayment', | |
6a7e5e5d | 238 | 'localizable' => 0, |
1519c828 | 239 | 'unique_title' => ts('Payment Scheduled'), |
267fb11a SL |
240 | 'html' => [ |
241 | 'type' => 'Select Date', | |
242 | 'formatType' => 'activityDate', | |
243 | ], | |
c3fc2621 CW |
244 | ], |
245 | 'pledge_payment_reminder_date' => [ | |
e501603b TO |
246 | 'name' => 'reminder_date', |
247 | 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, | |
c3fc2621 | 248 | 'title' => ts('Last Reminder'), |
215b423e | 249 | 'description' => ts('The date that the most recent payment reminder was sent.'), |
c3fc2621 | 250 | 'import' => TRUE, |
e501603b | 251 | 'where' => 'civicrm_pledge_payment.reminder_date', |
c3fc2621 | 252 | 'export' => TRUE, |
522a26c9 | 253 | 'table_name' => 'civicrm_pledge_payment', |
254 | 'entity' => 'PledgePayment', | |
255 | 'bao' => 'CRM_Pledge_BAO_PledgePayment', | |
6a7e5e5d | 256 | 'localizable' => 0, |
c3fc2621 CW |
257 | ], |
258 | 'pledge_payment_reminder_count' => [ | |
e501603b TO |
259 | 'name' => 'reminder_count', |
260 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 261 | 'title' => ts('Reminders Sent'), |
215b423e | 262 | 'description' => ts('The number of payment reminders sent.'), |
c3fc2621 | 263 | 'import' => TRUE, |
e501603b | 264 | 'where' => 'civicrm_pledge_payment.reminder_count', |
c3fc2621 | 265 | 'export' => TRUE, |
45a83e42 | 266 | 'default' => '0', |
522a26c9 | 267 | 'table_name' => 'civicrm_pledge_payment', |
268 | 'entity' => 'PledgePayment', | |
269 | 'bao' => 'CRM_Pledge_BAO_PledgePayment', | |
6a7e5e5d | 270 | 'localizable' => 0, |
c3fc2621 CW |
271 | ], |
272 | 'pledge_payment_status_id' => [ | |
e501603b TO |
273 | 'name' => 'status_id', |
274 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 CW |
275 | 'title' => ts('Payment Status'), |
276 | 'import' => TRUE, | |
e501603b | 277 | 'where' => 'civicrm_pledge_payment.status_id', |
c3fc2621 | 278 | 'export' => FALSE, |
522a26c9 | 279 | 'table_name' => 'civicrm_pledge_payment', |
280 | 'entity' => 'PledgePayment', | |
281 | 'bao' => 'CRM_Pledge_BAO_PledgePayment', | |
6a7e5e5d | 282 | 'localizable' => 0, |
c3fc2621 | 283 | 'pseudoconstant' => [ |
e501603b TO |
284 | 'optionGroupName' => 'contribution_status', |
285 | 'optionEditPath' => 'civicrm/admin/options/contribution_status', | |
e6ca0a57 | 286 | ], |
c3fc2621 CW |
287 | ], |
288 | ]; | |
346aaaba | 289 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 290 | } |
346aaaba | 291 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 292 | } |
c3fc2621 | 293 | |
e501603b | 294 | /** |
bd8e0b14 | 295 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
296 | * |
297 | * @return array | |
bd8e0b14 | 298 | * Array(string $name => string $uniqueName). |
e501603b | 299 | */ |
c3fc2621 | 300 | public static function &fieldKeys() { |
bd8e0b14 TO |
301 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
302 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 303 | } |
bd8e0b14 | 304 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 305 | } |
c3fc2621 | 306 | |
e501603b TO |
307 | /** |
308 | * Returns the names of this table | |
309 | * | |
310 | * @return string | |
311 | */ | |
c3fc2621 | 312 | public static function getTableName() { |
e501603b TO |
313 | return self::$_tableName; |
314 | } | |
c3fc2621 | 315 | |
e501603b TO |
316 | /** |
317 | * Returns if this table needs to be logged | |
318 | * | |
c3fc2621 | 319 | * @return bool |
e501603b | 320 | */ |
c3fc2621 | 321 | public function getLog() { |
e501603b TO |
322 | return self::$_log; |
323 | } | |
c3fc2621 | 324 | |
e501603b TO |
325 | /** |
326 | * Returns the list of fields that can be imported | |
327 | * | |
328 | * @param bool $prefix | |
329 | * | |
330 | * @return array | |
331 | */ | |
c3fc2621 CW |
332 | public static function &import($prefix = FALSE) { |
333 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'pledge_payment', $prefix, []); | |
60808919 | 334 | return $r; |
e501603b | 335 | } |
c3fc2621 | 336 | |
e501603b TO |
337 | /** |
338 | * Returns the list of fields that can be exported | |
339 | * | |
340 | * @param bool $prefix | |
341 | * | |
342 | * @return array | |
343 | */ | |
c3fc2621 CW |
344 | public static function &export($prefix = FALSE) { |
345 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'pledge_payment', $prefix, []); | |
60808919 | 346 | return $r; |
e501603b | 347 | } |
c3fc2621 | 348 | |
e7a6b91a AS |
349 | /** |
350 | * Returns the list of indices | |
c3fc2621 CW |
351 | * |
352 | * @param bool $localize | |
353 | * | |
354 | * @return array | |
e7a6b91a AS |
355 | */ |
356 | public static function indices($localize = TRUE) { | |
c3fc2621 CW |
357 | $indices = [ |
358 | 'index_contribution_pledge' => [ | |
e7a6b91a | 359 | 'name' => 'index_contribution_pledge', |
c3fc2621 | 360 | 'field' => [ |
e7a6b91a AS |
361 | 0 => 'contribution_id', |
362 | 1 => 'pledge_id', | |
c3fc2621 CW |
363 | ], |
364 | 'localizable' => FALSE, | |
e7a6b91a | 365 | 'sig' => 'civicrm_pledge_payment::0::contribution_id::pledge_id', |
c3fc2621 CW |
366 | ], |
367 | 'index_status' => [ | |
e7a6b91a | 368 | 'name' => 'index_status', |
c3fc2621 | 369 | 'field' => [ |
e7a6b91a | 370 | 0 => 'status_id', |
c3fc2621 CW |
371 | ], |
372 | 'localizable' => FALSE, | |
e7a6b91a | 373 | 'sig' => 'civicrm_pledge_payment::0::status_id', |
c3fc2621 CW |
374 | ], |
375 | ]; | |
e7a6b91a AS |
376 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
377 | } | |
c3fc2621 | 378 | |
e501603b | 379 | } |