Merge pull request #14059 from Stoob/patch-2
[civicrm-core.git] / CRM / Contribute / DAO / ContributionRecur.php
index e4642341d8cf7e08b6b1f7386b600e3db9d86213..9eedb5c3079750467909577d6861f2e20d0b5d38 100644 (file)
@@ -19,14 +19,14 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
    *
    * @var string
    */
-  static $_tableName = 'civicrm_contribution_recur';
+  public static $_tableName = 'civicrm_contribution_recur';
 
   /**
    * Should CiviCRM log any modifications to this table in the civicrm_log table.
    *
    * @var bool
    */
-  static $_log = TRUE;
+  public static $_log = TRUE;
 
   /**
    * Contribution Recur ID
@@ -243,7 +243,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
    */
   public static function getReferenceColumns() {
     if (!isset(Civi::$statics[__CLASS__]['links'])) {
-      Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
+      Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id', 'civicrm_contact', 'id');
       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'payment_token_id', 'civicrm_payment_token', 'id');
       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'payment_processor_id', 'civicrm_payment_processor', 'id');
@@ -268,6 +268,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'title' => ts('Recurring Contribution ID'),
           'description' => ts('Contribution Recur ID'),
           'required' => TRUE,
+          'where' => 'civicrm_contribution_recur.id',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
           'bao' => 'CRM_Contribute_BAO_ContributionRecur',
@@ -279,6 +280,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'title' => ts('Contact'),
           'description' => ts('Foreign key to civicrm_contact.id.'),
           'required' => TRUE,
+          'where' => 'civicrm_contribution_recur.contact_id',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
           'bao' => 'CRM_Contribute_BAO_ContributionRecur',
@@ -298,6 +300,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
             20,
             2
           ],
+          'where' => 'civicrm_contribution_recur.amount',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
           'bao' => 'CRM_Contribute_BAO_ContributionRecur',
@@ -313,6 +316,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'description' => ts('3 character string, value from config setting or input via user.'),
           'maxlength' => 3,
           'size' => CRM_Utils_Type::FOUR,
+          'where' => 'civicrm_contribution_recur.currency',
           'default' => 'NULL',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
@@ -335,6 +339,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'description' => ts('Time units for recurrence of payment.'),
           'maxlength' => 8,
           'size' => CRM_Utils_Type::EIGHT,
+          'where' => 'civicrm_contribution_recur.frequency_unit',
           'default' => 'month',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
@@ -355,6 +360,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'title' => ts('Interval (number of units)'),
           'description' => ts('Number of time units for recurrence of payment.'),
           'required' => TRUE,
+          'where' => 'civicrm_contribution_recur.frequency_interval',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
           'bao' => 'CRM_Contribute_BAO_ContributionRecur',
@@ -368,6 +374,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Number of Installments'),
           'description' => ts('Total number of payments to be made. Set this to 0 if this is an open-ended commitment i.e. no set end date.'),
+          'where' => 'civicrm_contribution_recur.installments',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
           'bao' => 'CRM_Contribute_BAO_ContributionRecur',
@@ -382,6 +389,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'title' => ts('Start Date'),
           'description' => ts('The date the first scheduled recurring contribution occurs.'),
           'required' => TRUE,
+          'where' => 'civicrm_contribution_recur.start_date',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
           'bao' => 'CRM_Contribute_BAO_ContributionRecur',
@@ -397,6 +405,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'title' => ts('Created Date'),
           'description' => ts('When this recurring contribution record was created.'),
           'required' => TRUE,
+          'where' => 'civicrm_contribution_recur.create_date',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
           'bao' => 'CRM_Contribute_BAO_ContributionRecur',
@@ -411,6 +420,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
           'title' => ts('Modified Date'),
           'description' => ts('Last updated date for this record. mostly the last time a payment was received'),
+          'where' => 'civicrm_contribution_recur.modified_date',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
           'bao' => 'CRM_Contribute_BAO_ContributionRecur',
@@ -425,6 +435,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
           'title' => ts('Cancel Date'),
           'description' => ts('Date this recurring contribution was cancelled by contributor- if we can get access to it'),
+          'where' => 'civicrm_contribution_recur.cancel_date',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
           'bao' => 'CRM_Contribute_BAO_ContributionRecur',
@@ -439,6 +450,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_TEXT,
           'title' => ts('Cancellation Reason'),
           'description' => ts('Free text field for a reason for cancelling'),
+          'where' => 'civicrm_contribution_recur.cancel_reason',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
           'bao' => 'CRM_Contribute_BAO_ContributionRecur',
@@ -452,6 +464,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
           'title' => ts('Recurring Contribution End Date'),
           'description' => ts('Date this recurring contribution finished successfully'),
+          'where' => 'civicrm_contribution_recur.end_date',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
           'bao' => 'CRM_Contribute_BAO_ContributionRecur',
@@ -468,6 +481,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'description' => ts('Possibly needed to store a unique identifier for this recurring payment order - if this is available from the processor??'),
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
+          'where' => 'civicrm_contribution_recur.processor_id',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
           'bao' => 'CRM_Contribute_BAO_ContributionRecur',
@@ -481,6 +495,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Payment Token ID'),
           'description' => ts('Optionally used to store a link to a payment token used for this recurring contribution.'),
+          'where' => 'civicrm_contribution_recur.payment_token_id',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
           'bao' => 'CRM_Contribute_BAO_ContributionRecur',
@@ -494,6 +509,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'description' => ts('unique transaction id. may be processor id, bank id + trans id, or account number + check number... depending on payment_method'),
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
+          'where' => 'civicrm_contribution_recur.trxn_id',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
           'bao' => 'CRM_Contribute_BAO_ContributionRecur',
@@ -509,6 +525,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'description' => ts('unique invoice id, system generated or passed in'),
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
+          'where' => 'civicrm_contribution_recur.invoice_id',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
           'bao' => 'CRM_Contribute_BAO_ContributionRecur',
@@ -523,8 +540,6 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'title' => ts('Status'),
           'import' => TRUE,
           'where' => 'civicrm_contribution_recur.contribution_status_id',
-          'headerPattern' => '',
-          'dataPattern' => '',
           'export' => TRUE,
           'default' => '1',
           'table_name' => 'civicrm_contribution_recur',
@@ -545,8 +560,6 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'title' => ts('Test'),
           'import' => TRUE,
           'where' => 'civicrm_contribution_recur.is_test',
-          'headerPattern' => '',
-          'dataPattern' => '',
           'export' => TRUE,
           'default' => '0',
           'table_name' => 'civicrm_contribution_recur',
@@ -563,6 +576,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'title' => ts('Cycle Day'),
           'description' => ts('Day in the period when the payment should be charged e.g. 1st of month, 15th etc.'),
           'required' => TRUE,
+          'where' => 'civicrm_contribution_recur.cycle_day',
           'default' => '1',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
@@ -577,6 +591,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
           'title' => ts('Next Scheduled Contribution Date'),
           'description' => ts('Next scheduled date'),
+          'where' => 'civicrm_contribution_recur.next_sched_contribution_date',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
           'bao' => 'CRM_Contribute_BAO_ContributionRecur',
@@ -591,6 +606,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Number of Failures'),
           'description' => ts('Number of failed charge attempts since last success. Business rule could be set to deactivate on more than x failures.'),
+          'where' => 'civicrm_contribution_recur.failure_count',
           'default' => '0',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
@@ -605,6 +621,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
           'title' => ts('Retry Failed Attempt Date'),
           'description' => ts('Date to retry failed attempt'),
+          'where' => 'civicrm_contribution_recur.failure_retry_date',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
           'bao' => 'CRM_Contribute_BAO_ContributionRecur',
@@ -620,6 +637,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'title' => ts('Auto Renew'),
           'description' => ts('Some systems allow contributor to set a number of installments - but then auto-renew the subscription or commitment if they do not cancel.'),
           'required' => TRUE,
+          'where' => 'civicrm_contribution_recur.auto_renew',
           'default' => '0',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
@@ -634,6 +652,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Payment Processor'),
           'description' => ts('Foreign key to civicrm_payment_processor.id'),
+          'where' => 'civicrm_contribution_recur.payment_processor_id',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
           'bao' => 'CRM_Contribute_BAO_ContributionRecur',
@@ -653,10 +672,8 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Financial Type'),
           'description' => ts('FK to Financial Type'),
-          'export' => FALSE,
           'where' => 'civicrm_contribution_recur.financial_type_id',
-          'headerPattern' => '',
-          'dataPattern' => '',
+          'export' => FALSE,
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
           'bao' => 'CRM_Contribute_BAO_ContributionRecur',
@@ -676,6 +693,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_INT,
           'title' => ts('Payment Method'),
           'description' => ts('FK to Payment Instrument'),
+          'where' => 'civicrm_contribution_recur.payment_instrument_id',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
           'bao' => 'CRM_Contribute_BAO_ContributionRecur',
@@ -695,8 +713,6 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'description' => ts('The campaign for which this contribution has been triggered.'),
           'import' => TRUE,
           'where' => 'civicrm_contribution_recur.campaign_id',
-          'headerPattern' => '',
-          'dataPattern' => '',
           'export' => TRUE,
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',
@@ -717,6 +733,7 @@ class CRM_Contribute_DAO_ContributionRecur extends CRM_Core_DAO {
           'type' => CRM_Utils_Type::T_BOOLEAN,
           'title' => ts('Send email Receipt?'),
           'description' => ts('if true, receipt is automatically emailed to contact on each successful payment'),
+          'where' => 'civicrm_contribution_recur.is_email_receipt',
           'default' => '1',
           'table_name' => 'civicrm_contribution_recur',
           'entity' => 'ContributionRecur',