5 * @copyright CiviCRM LLC (c) 2004-2018
7 * Generated from xml/schema/CRM/Contribute/ContributionRecur.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:a1007a4585bac4fcb04ce47535aecec0)
13 * Database access object for the ContributionRecur entity.
15 class CRM_Contribute_DAO_ContributionRecur
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 static $_tableName = 'civicrm_contribution_recur';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
32 * Contribution Recur ID
39 * Foreign key to civicrm_contact.id .
46 * Amount to be contributed or charged each recurrence.
53 * 3 character string, value from config setting or input via user.
60 * Time units for recurrence of payment.
64 public $frequency_unit;
67 * Number of time units for recurrence of payment.
71 public $frequency_interval;
74 * Total number of payments to be made. Set this to 0 if this is an open-ended commitment i.e. no set end date.
81 * The date the first scheduled recurring contribution occurs.
88 * When this recurring contribution record was created.
95 * Last updated date for this record. mostly the last time a payment was received
99 public $modified_date;
102 * Date this recurring contribution was cancelled by contributor- if we can get access to it
109 * Date this recurring contribution finished successfully
116 * Possibly needed to store a unique identifier for this recurring payment order - if this is available from the processor??
120 public $processor_id;
123 * Optionally used to store a link to a payment token used for this recurring contribution.
127 public $payment_token_id;
130 * unique transaction id. may be processor id, bank id + trans id, or account number + check number... depending on payment_method
137 * unique invoice id, system generated or passed in
146 public $contribution_status_id;
154 * Day in the period when the payment should be charged e.g. 1st of month, 15th etc.
161 * Next scheduled date
165 public $next_sched_contribution_date;
168 * Number of failed charge attempts since last success. Business rule could be set to deactivate on more than x failures.
172 public $failure_count;
175 * Date to retry failed attempt
179 public $failure_retry_date;
182 * Some systems allow contributor to set a number of installments - but then auto-renew the subscription or commitment if they do not cancel.
189 * Foreign key to civicrm_payment_processor.id
193 public $payment_processor_id;
196 * FK to Financial Type
200 public $financial_type_id;
203 * FK to Payment Instrument
207 public $payment_instrument_id;
210 * The campaign for which this contribution has been triggered.
217 * if true, receipt is automatically emailed to contact on each successful payment
221 public $is_email_receipt;
226 public function __construct() {
227 $this->__table
= 'civicrm_contribution_recur';
228 parent
::__construct();
232 * Returns foreign keys and entity references.
235 * [CRM_Core_Reference_Interface]
237 public static function getReferenceColumns() {
238 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
239 Civi
::$statics[__CLASS__
]['links'] = static ::createReferenceColumns(__CLASS__
);
240 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'contact_id', 'civicrm_contact', 'id');
241 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'payment_token_id', 'civicrm_payment_token', 'id');
242 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'payment_processor_id', 'civicrm_payment_processor', 'id');
243 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'financial_type_id', 'civicrm_financial_type', 'id');
244 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'campaign_id', 'civicrm_campaign', 'id');
245 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
247 return Civi
::$statics[__CLASS__
]['links'];
251 * Returns all the column names of this table
255 public static function &fields() {
256 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
257 Civi
::$statics[__CLASS__
]['fields'] = [
260 'type' => CRM_Utils_Type
::T_INT
,
261 'title' => ts('Recurring Contribution ID'),
262 'description' => 'Contribution Recur ID',
264 'table_name' => 'civicrm_contribution_recur',
265 'entity' => 'ContributionRecur',
266 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
270 'name' => 'contact_id',
271 'type' => CRM_Utils_Type
::T_INT
,
272 'title' => ts('Contact ID'),
273 'description' => 'Foreign key to civicrm_contact.id .',
275 'table_name' => 'civicrm_contribution_recur',
276 'entity' => 'ContributionRecur',
277 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
279 'FKClassName' => 'CRM_Contact_DAO_Contact',
283 'type' => CRM_Utils_Type
::T_MONEY
,
284 'title' => ts('Amount'),
285 'description' => 'Amount to be contributed or charged each recurrence.',
291 'table_name' => 'civicrm_contribution_recur',
292 'entity' => 'ContributionRecur',
293 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
300 'name' => 'currency',
301 'type' => CRM_Utils_Type
::T_STRING
,
302 'title' => ts('Currency'),
303 'description' => '3 character string, value from config setting or input via user.',
305 'size' => CRM_Utils_Type
::FOUR
,
307 'table_name' => 'civicrm_contribution_recur',
308 'entity' => 'ContributionRecur',
309 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
314 'pseudoconstant' => [
315 'table' => 'civicrm_currency',
316 'keyColumn' => 'name',
317 'labelColumn' => 'full_name',
318 'nameColumn' => 'name',
321 'frequency_unit' => [
322 'name' => 'frequency_unit',
323 'type' => CRM_Utils_Type
::T_STRING
,
324 'title' => ts('Frequency Unit'),
325 'description' => 'Time units for recurrence of payment.',
327 'size' => CRM_Utils_Type
::EIGHT
,
328 'default' => 'month',
329 'table_name' => 'civicrm_contribution_recur',
330 'entity' => 'ContributionRecur',
331 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
336 'pseudoconstant' => [
337 'optionGroupName' => 'recur_frequency_units',
338 'keyColumn' => 'name',
339 'optionEditPath' => 'civicrm/admin/options/recur_frequency_units',
342 'frequency_interval' => [
343 'name' => 'frequency_interval',
344 'type' => CRM_Utils_Type
::T_INT
,
345 'title' => ts('Interval (number of units)'),
346 'description' => 'Number of time units for recurrence of payment.',
348 'table_name' => 'civicrm_contribution_recur',
349 'entity' => 'ContributionRecur',
350 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
357 'name' => 'installments',
358 'type' => CRM_Utils_Type
::T_INT
,
359 'title' => ts('Number of Installments'),
360 'description' => 'Total number of payments to be made. Set this to 0 if this is an open-ended commitment i.e. no set end date.',
361 'table_name' => 'civicrm_contribution_recur',
362 'entity' => 'ContributionRecur',
363 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
370 'name' => 'start_date',
371 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
372 'title' => ts('Recurring Contribution Started Date'),
373 'description' => 'The date the first scheduled recurring contribution occurs.',
375 'table_name' => 'civicrm_contribution_recur',
376 'entity' => 'ContributionRecur',
377 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
380 'type' => 'Select Date',
384 'name' => 'create_date',
385 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
386 'title' => ts('Recurring Contribution Created Date'),
387 'description' => 'When this recurring contribution record was created.',
389 'table_name' => 'civicrm_contribution_recur',
390 'entity' => 'ContributionRecur',
391 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
394 'type' => 'Select Date',
398 'name' => 'modified_date',
399 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
400 'title' => ts('Recurring Contribution Modified Date'),
401 'description' => 'Last updated date for this record. mostly the last time a payment was received',
402 'table_name' => 'civicrm_contribution_recur',
403 'entity' => 'ContributionRecur',
404 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
407 'type' => 'Select Date',
411 'name' => 'cancel_date',
412 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
413 'title' => ts('Recurring Contribution Cancel Date'),
414 'description' => 'Date this recurring contribution was cancelled by contributor- if we can get access to it',
415 'table_name' => 'civicrm_contribution_recur',
416 'entity' => 'ContributionRecur',
417 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
420 'type' => 'Select Date',
424 'name' => 'end_date',
425 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
426 'title' => ts('Recurring Contribution End Date'),
427 'description' => 'Date this recurring contribution finished successfully',
428 'table_name' => 'civicrm_contribution_recur',
429 'entity' => 'ContributionRecur',
430 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
433 'type' => 'Select Date',
437 'name' => 'processor_id',
438 'type' => CRM_Utils_Type
::T_STRING
,
439 'title' => ts('Processor ID'),
440 'description' => 'Possibly needed to store a unique identifier for this recurring payment order - if this is available from the processor??',
442 'size' => CRM_Utils_Type
::HUGE
,
443 'table_name' => 'civicrm_contribution_recur',
444 'entity' => 'ContributionRecur',
445 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
448 'payment_token_id' => [
449 'name' => 'payment_token_id',
450 'type' => CRM_Utils_Type
::T_INT
,
451 'title' => ts('Payment Token ID'),
452 'description' => 'Optionally used to store a link to a payment token used for this recurring contribution.',
453 'table_name' => 'civicrm_contribution_recur',
454 'entity' => 'ContributionRecur',
455 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
457 'FKClassName' => 'CRM_Financial_DAO_PaymentToken',
461 'type' => CRM_Utils_Type
::T_STRING
,
462 'title' => ts('Transaction ID'),
463 'description' => 'unique transaction id. may be processor id, bank id + trans id, or account number + check number... depending on payment_method',
465 'size' => CRM_Utils_Type
::HUGE
,
466 'table_name' => 'civicrm_contribution_recur',
467 'entity' => 'ContributionRecur',
468 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
472 'name' => 'invoice_id',
473 'type' => CRM_Utils_Type
::T_STRING
,
474 'title' => ts('Invoice ID'),
475 'description' => 'unique invoice id, system generated or passed in',
477 'size' => CRM_Utils_Type
::HUGE
,
478 'table_name' => 'civicrm_contribution_recur',
479 'entity' => 'ContributionRecur',
480 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
483 'contribution_status_id' => [
484 'name' => 'contribution_status_id',
485 'type' => CRM_Utils_Type
::T_INT
,
486 'title' => ts('Recurring Contribution Status'),
488 'where' => 'civicrm_contribution_recur.contribution_status_id',
489 'headerPattern' => '',
493 'table_name' => 'civicrm_contribution_recur',
494 'entity' => 'ContributionRecur',
495 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
497 'pseudoconstant' => [
498 'optionGroupName' => 'contribution_status',
499 'optionEditPath' => 'civicrm/admin/options/contribution_status',
504 'type' => CRM_Utils_Type
::T_BOOLEAN
,
505 'title' => ts('Test'),
507 'where' => 'civicrm_contribution_recur.is_test',
508 'headerPattern' => '',
511 'table_name' => 'civicrm_contribution_recur',
512 'entity' => 'ContributionRecur',
513 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
516 'type' => 'CheckBox',
520 'name' => 'cycle_day',
521 'type' => CRM_Utils_Type
::T_INT
,
522 'title' => ts('Number of Cycle Day'),
523 'description' => 'Day in the period when the payment should be charged e.g. 1st of month, 15th etc.',
526 'table_name' => 'civicrm_contribution_recur',
527 'entity' => 'ContributionRecur',
528 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
534 'next_sched_contribution_date' => [
535 'name' => 'next_sched_contribution_date',
536 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
537 'title' => ts('Next Scheduled Contribution Date'),
538 'description' => 'Next scheduled date',
539 'table_name' => 'civicrm_contribution_recur',
540 'entity' => 'ContributionRecur',
541 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
544 'type' => 'Select Date',
548 'name' => 'failure_count',
549 'type' => CRM_Utils_Type
::T_INT
,
550 'title' => ts('Number of Failures'),
551 'description' => 'Number of failed charge attempts since last success. Business rule could be set to deactivate on more than x failures.',
552 'table_name' => 'civicrm_contribution_recur',
553 'entity' => 'ContributionRecur',
554 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
560 'failure_retry_date' => [
561 'name' => 'failure_retry_date',
562 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
563 'title' => ts('Retry Failed Attempt Date'),
564 'description' => 'Date to retry failed attempt',
565 'table_name' => 'civicrm_contribution_recur',
566 'entity' => 'ContributionRecur',
567 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
570 'type' => 'Select Date',
574 'name' => 'auto_renew',
575 'type' => CRM_Utils_Type
::T_BOOLEAN
,
576 'title' => ts('Auto Renew'),
577 'description' => 'Some systems allow contributor to set a number of installments - but then auto-renew the subscription or commitment if they do not cancel.',
579 'table_name' => 'civicrm_contribution_recur',
580 'entity' => 'ContributionRecur',
581 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
584 'type' => 'CheckBox',
587 'payment_processor_id' => [
588 'name' => 'payment_processor_id',
589 'type' => CRM_Utils_Type
::T_INT
,
590 'title' => ts('Payment Processor'),
591 'description' => 'Foreign key to civicrm_payment_processor.id',
592 'table_name' => 'civicrm_contribution_recur',
593 'entity' => 'ContributionRecur',
594 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
596 'FKClassName' => 'CRM_Financial_DAO_PaymentProcessor',
598 'financial_type_id' => [
599 'name' => 'financial_type_id',
600 'type' => CRM_Utils_Type
::T_INT
,
601 'title' => ts('Financial Type'),
602 'description' => 'FK to Financial Type',
604 'where' => 'civicrm_contribution_recur.financial_type_id',
605 'headerPattern' => '',
607 'table_name' => 'civicrm_contribution_recur',
608 'entity' => 'ContributionRecur',
609 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
611 'FKClassName' => 'CRM_Financial_DAO_FinancialType',
612 'pseudoconstant' => [
613 'table' => 'civicrm_financial_type',
615 'labelColumn' => 'name',
618 'payment_instrument_id' => [
619 'name' => 'payment_instrument_id',
620 'type' => CRM_Utils_Type
::T_INT
,
621 'title' => ts('Payment Method'),
622 'description' => 'FK to Payment Instrument',
623 'table_name' => 'civicrm_contribution_recur',
624 'entity' => 'ContributionRecur',
625 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
630 'pseudoconstant' => [
631 'optionGroupName' => 'payment_instrument',
632 'optionEditPath' => 'civicrm/admin/options/payment_instrument',
635 'contribution_campaign_id' => [
636 'name' => 'campaign_id',
637 'type' => CRM_Utils_Type
::T_INT
,
638 'title' => ts('Campaign'),
639 'description' => 'The campaign for which this contribution has been triggered.',
641 'where' => 'civicrm_contribution_recur.campaign_id',
642 'headerPattern' => '',
645 'table_name' => 'civicrm_contribution_recur',
646 'entity' => 'ContributionRecur',
647 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
649 'FKClassName' => 'CRM_Campaign_DAO_Campaign',
650 'pseudoconstant' => [
651 'table' => 'civicrm_campaign',
653 'labelColumn' => 'title',
656 'is_email_receipt' => [
657 'name' => 'is_email_receipt',
658 'type' => CRM_Utils_Type
::T_BOOLEAN
,
659 'title' => ts('Send email Receipt?'),
660 'description' => 'if true, receipt is automatically emailed to contact on each successful payment',
662 'table_name' => 'civicrm_contribution_recur',
663 'entity' => 'ContributionRecur',
664 'bao' => 'CRM_Contribute_BAO_ContributionRecur',
667 'type' => 'CheckBox',
671 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
673 return Civi
::$statics[__CLASS__
]['fields'];
677 * Return a mapping from field-name to the corresponding key (as used in fields()).
680 * Array(string $name => string $uniqueName).
682 public static function &fieldKeys() {
683 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
684 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
686 return Civi
::$statics[__CLASS__
]['fieldKeys'];
690 * Returns the names of this table
694 public static function getTableName() {
695 return self
::$_tableName;
699 * Returns if this table needs to be logged
703 public function getLog() {
708 * Returns the list of fields that can be imported
710 * @param bool $prefix
714 public static function &import($prefix = FALSE) {
715 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'contribution_recur', $prefix, []);
720 * Returns the list of fields that can be exported
722 * @param bool $prefix
726 public static function &export($prefix = FALSE) {
727 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'contribution_recur', $prefix, []);
732 * Returns the list of indices
734 * @param bool $localize
738 public static function indices($localize = TRUE) {
740 'UI_contrib_trxn_id' => [
741 'name' => 'UI_contrib_trxn_id',
745 'localizable' => FALSE,
747 'sig' => 'civicrm_contribution_recur::1::trxn_id',
749 'UI_contrib_invoice_id' => [
750 'name' => 'UI_contrib_invoice_id',
754 'localizable' => FALSE,
756 'sig' => 'civicrm_contribution_recur::1::invoice_id',
758 'index_contribution_status' => [
759 'name' => 'index_contribution_status',
761 0 => 'contribution_status_id',
763 'localizable' => FALSE,
764 'sig' => 'civicrm_contribution_recur::0::contribution_status_id',
766 'UI_contribution_recur_payment_instrument_id' => [
767 'name' => 'UI_contribution_recur_payment_instrument_id',
769 0 => 'payment_instrument_id',
771 'localizable' => FALSE,
772 'sig' => 'civicrm_contribution_recur::0::payment_instrument_id',
775 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;