__table = 'civicrm_contribution_recur'; parent::__construct(); } /** * Returns foreign keys and entity references. * * @return array * [CRM_Core_Reference_Interface] */ public static function getReferenceColumns() { if (!isset(Civi::$statics[__CLASS__]['links'])) { 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'); Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'financial_type_id', 'civicrm_financial_type', 'id'); Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'campaign_id', 'civicrm_campaign', 'id'); CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); } return Civi::$statics[__CLASS__]['links']; } /** * Returns all the column names of this table * * @return array */ public static function &fields() { if (!isset(Civi::$statics[__CLASS__]['fields'])) { Civi::$statics[__CLASS__]['fields'] = [ 'id' => [ 'name' => 'id', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Recurring Contribution ID'), 'description' => ts('Contribution Recur ID'), 'required' => TRUE, 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, ], 'contact_id' => [ 'name' => 'contact_id', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Contact'), 'description' => ts('Foreign key to civicrm_contact.id.'), 'required' => TRUE, 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'FKClassName' => 'CRM_Contact_DAO_Contact', 'html' => [ 'type' => 'EntityRef', ], ], 'amount' => [ 'name' => 'amount', 'type' => CRM_Utils_Type::T_MONEY, 'title' => ts('Amount'), 'description' => ts('Amount to be contributed or charged each recurrence.'), 'required' => TRUE, 'precision' => [ 20, 2 ], 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => [ 'type' => 'Text', ], ], 'currency' => [ 'name' => 'currency', 'type' => CRM_Utils_Type::T_STRING, 'title' => ts('Currency'), 'description' => ts('3 character string, value from config setting or input via user.'), 'maxlength' => 3, 'size' => CRM_Utils_Type::FOUR, 'default' => 'NULL', 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => [ 'type' => 'Select', ], 'pseudoconstant' => [ 'table' => 'civicrm_currency', 'keyColumn' => 'name', 'labelColumn' => 'full_name', 'nameColumn' => 'name', ] ], 'frequency_unit' => [ 'name' => 'frequency_unit', 'type' => CRM_Utils_Type::T_STRING, 'title' => ts('Frequency Unit'), 'description' => ts('Time units for recurrence of payment.'), 'maxlength' => 8, 'size' => CRM_Utils_Type::EIGHT, 'default' => 'month', 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => [ 'type' => 'Select', ], 'pseudoconstant' => [ 'optionGroupName' => 'recur_frequency_units', 'keyColumn' => 'name', 'optionEditPath' => 'civicrm/admin/options/recur_frequency_units', ] ], 'frequency_interval' => [ 'name' => 'frequency_interval', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Interval (number of units)'), 'description' => ts('Number of time units for recurrence of payment.'), 'required' => TRUE, 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => [ 'type' => 'Text', ], ], 'installments' => [ 'name' => 'installments', '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.'), 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => [ 'type' => 'Text', ], ], 'start_date' => [ 'name' => 'start_date', 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, 'title' => ts('Start Date'), 'description' => ts('The date the first scheduled recurring contribution occurs.'), 'required' => TRUE, 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => [ 'type' => 'Select Date', 'formatType' => 'activityDateTime', ], ], 'create_date' => [ 'name' => 'create_date', 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, 'title' => ts('Created Date'), 'description' => ts('When this recurring contribution record was created.'), 'required' => TRUE, 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => [ 'type' => 'Select Date', 'formatType' => 'activityDateTime', ], ], 'modified_date' => [ 'name' => 'modified_date', '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'), 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => [ 'type' => 'Select Date', 'formatType' => 'activityDateTime', ], ], 'cancel_date' => [ 'name' => 'cancel_date', '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'), 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => [ 'type' => 'Select Date', 'formatType' => 'activityDate', ], ], 'end_date' => [ 'name' => 'end_date', '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'), 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => [ 'type' => 'Select Date', 'formatType' => 'activityDate', ], ], 'processor_id' => [ 'name' => 'processor_id', 'type' => CRM_Utils_Type::T_STRING, 'title' => ts('Processor ID'), '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, 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => [ 'type' => 'Text', ], ], 'payment_token_id' => [ 'name' => 'payment_token_id', '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.'), 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'FKClassName' => 'CRM_Financial_DAO_PaymentToken', ], 'trxn_id' => [ 'name' => 'trxn_id', 'type' => CRM_Utils_Type::T_STRING, 'title' => ts('Transaction ID'), '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, 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => [ 'type' => 'Text', ], ], 'invoice_id' => [ 'name' => 'invoice_id', 'type' => CRM_Utils_Type::T_STRING, 'title' => ts('Invoice ID'), 'description' => ts('unique invoice id, system generated or passed in'), 'maxlength' => 255, 'size' => CRM_Utils_Type::HUGE, 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => [ 'type' => 'Text', ], ], 'contribution_status_id' => [ 'name' => 'contribution_status_id', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Status'), 'import' => TRUE, 'where' => 'civicrm_contribution_recur.contribution_status_id', 'headerPattern' => '', 'dataPattern' => '', 'export' => TRUE, 'default' => '1', 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => [ 'type' => 'Select', ], 'pseudoconstant' => [ 'optionGroupName' => 'contribution_status', 'optionEditPath' => 'civicrm/admin/options/contribution_status', ] ], 'is_test' => [ 'name' => 'is_test', 'type' => CRM_Utils_Type::T_BOOLEAN, 'title' => ts('Test'), 'import' => TRUE, 'where' => 'civicrm_contribution_recur.is_test', 'headerPattern' => '', 'dataPattern' => '', 'export' => TRUE, 'default' => '0', 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => [ 'type' => 'CheckBox', ], ], 'cycle_day' => [ 'name' => 'cycle_day', 'type' => CRM_Utils_Type::T_INT, '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, 'default' => '1', 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => [ 'type' => 'Text', ], ], 'next_sched_contribution_date' => [ 'name' => 'next_sched_contribution_date', 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, 'title' => ts('Next Scheduled Contribution Date'), 'description' => ts('Next scheduled date'), 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => [ 'type' => 'Select Date', 'formatType' => 'activityDate', ], ], 'failure_count' => [ 'name' => 'failure_count', '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.'), 'default' => '0', 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => [ 'type' => 'Text', ], ], 'failure_retry_date' => [ 'name' => 'failure_retry_date', 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, 'title' => ts('Retry Failed Attempt Date'), 'description' => ts('Date to retry failed attempt'), 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => [ 'type' => 'Select Date', 'formatType' => 'activityDate', ], ], 'auto_renew' => [ 'name' => 'auto_renew', 'type' => CRM_Utils_Type::T_BOOLEAN, '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, 'default' => '0', 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => [ 'type' => 'CheckBox', ], ], 'payment_processor_id' => [ 'name' => 'payment_processor_id', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Payment Processor'), 'description' => ts('Foreign key to civicrm_payment_processor.id'), 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'FKClassName' => 'CRM_Financial_DAO_PaymentProcessor', 'html' => [ 'type' => 'Select', ], 'pseudoconstant' => [ 'table' => 'civicrm_payment_processor', 'keyColumn' => 'id', 'labelColumn' => 'name', ] ], 'financial_type_id' => [ 'name' => 'financial_type_id', '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' => '', 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'FKClassName' => 'CRM_Financial_DAO_FinancialType', 'html' => [ 'type' => 'Select', ], 'pseudoconstant' => [ 'table' => 'civicrm_financial_type', 'keyColumn' => 'id', 'labelColumn' => 'name', ] ], 'payment_instrument_id' => [ 'name' => 'payment_instrument_id', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Payment Method'), 'description' => ts('FK to Payment Instrument'), 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => [ 'type' => 'Select', ], 'pseudoconstant' => [ 'optionGroupName' => 'payment_instrument', 'optionEditPath' => 'civicrm/admin/options/payment_instrument', ] ], 'contribution_campaign_id' => [ 'name' => 'campaign_id', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Campaign'), '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', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'FKClassName' => 'CRM_Campaign_DAO_Campaign', 'html' => [ 'type' => 'Select', ], 'pseudoconstant' => [ 'table' => 'civicrm_campaign', 'keyColumn' => 'id', 'labelColumn' => 'title', ] ], 'is_email_receipt' => [ 'name' => 'is_email_receipt', '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'), 'default' => '1', 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => [ 'type' => 'CheckBox', ], ], ]; CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); } return Civi::$statics[__CLASS__]['fields']; } /** * Return a mapping from field-name to the corresponding key (as used in fields()). * * @return array * Array(string $name => string $uniqueName). */ public static function &fieldKeys() { if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); } return Civi::$statics[__CLASS__]['fieldKeys']; } /** * Returns the names of this table * * @return string */ public static function getTableName() { return self::$_tableName; } /** * Returns if this table needs to be logged * * @return bool */ public function getLog() { return self::$_log; } /** * Returns the list of fields that can be imported * * @param bool $prefix * * @return array */ public static function &import($prefix = FALSE) { $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'contribution_recur', $prefix, []); return $r; } /** * Returns the list of fields that can be exported * * @param bool $prefix * * @return array */ public static function &export($prefix = FALSE) { $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'contribution_recur', $prefix, []); return $r; } /** * Returns the list of indices * * @param bool $localize * * @return array */ public static function indices($localize = TRUE) { $indices = [ 'UI_contrib_trxn_id' => [ 'name' => 'UI_contrib_trxn_id', 'field' => [ 0 => 'trxn_id', ], 'localizable' => FALSE, 'unique' => TRUE, 'sig' => 'civicrm_contribution_recur::1::trxn_id', ], 'UI_contrib_invoice_id' => [ 'name' => 'UI_contrib_invoice_id', 'field' => [ 0 => 'invoice_id', ], 'localizable' => FALSE, 'unique' => TRUE, 'sig' => 'civicrm_contribution_recur::1::invoice_id', ], 'index_contribution_status' => [ 'name' => 'index_contribution_status', 'field' => [ 0 => 'contribution_status_id', ], 'localizable' => FALSE, 'sig' => 'civicrm_contribution_recur::0::contribution_status_id', ], 'UI_contribution_recur_payment_instrument_id' => [ 'name' => 'UI_contribution_recur_payment_instrument_id', 'field' => [ 0 => 'payment_instrument_id', ], 'localizable' => FALSE, 'sig' => 'civicrm_contribution_recur::0::payment_instrument_id', ], ]; return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; } }