__table = 'civicrm_contribution_recur'; parent::__construct(); } /** * Returns foreign keys and entity references. * * @return array * [CRM_Core_Reference_Interface] */ 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 */ static function &fields() { if (!isset(Civi::$statics[__CLASS__]['fields'])) { Civi::$statics[__CLASS__]['fields'] = array( 'id' => array( 'name' => 'id', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Recurring Contribution ID') , 'description' => 'Contribution Recur ID', 'required' => true, 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, ) , 'contact_id' => array( 'name' => 'contact_id', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Contact ID') , 'description' => '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', ) , 'amount' => array( 'name' => 'amount', 'type' => CRM_Utils_Type::T_MONEY, 'title' => ts('Amount') , 'description' => 'Amount to be contributed or charged each recurrence.', 'required' => true, 'precision' => array( 20, 2 ) , 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => array( 'type' => 'Text', ) , ) , 'currency' => array( 'name' => 'currency', 'type' => CRM_Utils_Type::T_STRING, 'title' => ts('Currency') , 'description' => '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' => array( 'type' => 'Select', ) , 'pseudoconstant' => array( 'table' => 'civicrm_currency', 'keyColumn' => 'name', 'labelColumn' => 'full_name', 'nameColumn' => 'name', ) ) , 'frequency_unit' => array( 'name' => 'frequency_unit', 'type' => CRM_Utils_Type::T_STRING, 'title' => ts('Frequency Unit') , 'description' => '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' => array( 'type' => 'Select', ) , 'pseudoconstant' => array( 'optionGroupName' => 'recur_frequency_units', 'keyColumn' => 'name', 'optionEditPath' => 'civicrm/admin/options/recur_frequency_units', ) ) , 'frequency_interval' => array( 'name' => 'frequency_interval', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Interval (number of units)') , 'description' => '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' => array( 'type' => 'Text', ) , ) , 'installments' => array( 'name' => 'installments', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Number of Installments') , '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.', 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => array( 'type' => 'Text', ) , ) , 'start_date' => array( 'name' => 'start_date', 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, 'title' => ts('Recurring Contribution Started Date') , 'description' => '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' => array( 'type' => 'Select Date', ) , ) , 'create_date' => array( 'name' => 'create_date', 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, 'title' => ts('Recurring Contribution Created Date') , 'description' => 'When this recurring contribution record was created.', 'required' => true, 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => array( 'type' => 'Select Date', ) , ) , 'modified_date' => array( 'name' => 'modified_date', 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, 'title' => ts('Recurring Contribution Modified Date') , 'description' => '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' => array( 'type' => 'Select Date', ) , ) , 'cancel_date' => array( 'name' => 'cancel_date', 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, 'title' => ts('Recurring Contribution Cancel Date') , 'description' => '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' => array( 'type' => 'Select Date', ) , ) , 'end_date' => array( 'name' => 'end_date', 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, 'title' => ts('Recurring Contribution End Date') , 'description' => 'Date this recurring contribution finished successfully', 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => array( 'type' => 'Select Date', ) , ) , 'processor_id' => array( 'name' => 'processor_id', 'type' => CRM_Utils_Type::T_STRING, 'title' => ts('Processor ID') , 'description' => '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, ) , 'payment_token_id' => array( 'name' => 'payment_token_id', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Payment Token ID') , 'description' => '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' => array( 'name' => 'trxn_id', 'type' => CRM_Utils_Type::T_STRING, 'title' => ts('Transaction ID') , 'description' => '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, ) , 'invoice_id' => array( 'name' => 'invoice_id', 'type' => CRM_Utils_Type::T_STRING, 'title' => ts('Invoice ID') , 'description' => '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, ) , 'contribution_status_id' => array( 'name' => 'contribution_status_id', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Recurring Contribution 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, 'pseudoconstant' => array( 'optionGroupName' => 'contribution_status', 'optionEditPath' => 'civicrm/admin/options/contribution_status', ) ) , 'is_test' => array( 'name' => 'is_test', 'type' => CRM_Utils_Type::T_BOOLEAN, 'title' => ts('Test') , 'import' => true, 'where' => 'civicrm_contribution_recur.is_test', 'headerPattern' => '', 'dataPattern' => '', 'export' => true, 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => array( 'type' => 'CheckBox', ) , ) , 'cycle_day' => array( 'name' => 'cycle_day', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Number of Cycle Day') , 'description' => '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' => array( 'type' => 'Text', ) , ) , 'next_sched_contribution_date' => array( 'name' => 'next_sched_contribution_date', 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, 'title' => ts('Next Scheduled Contribution Date') , 'description' => 'Next scheduled date', 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => array( 'type' => 'Select Date', ) , ) , 'failure_count' => array( 'name' => 'failure_count', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Number of Failures') , 'description' => 'Number of failed charge attempts since last success. Business rule could be set to deactivate on more than x failures.', 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => array( 'type' => 'Text', ) , ) , 'failure_retry_date' => array( 'name' => 'failure_retry_date', 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, 'title' => ts('Retry Failed Attempt Date') , 'description' => 'Date to retry failed attempt', 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => array( 'type' => 'Select Date', ) , ) , 'auto_renew' => array( 'name' => 'auto_renew', 'type' => CRM_Utils_Type::T_BOOLEAN, 'title' => ts('Auto Renew') , 'description' => '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, 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => array( 'type' => 'CheckBox', ) , ) , 'payment_processor_id' => array( 'name' => 'payment_processor_id', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Payment Processor') , 'description' => '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', ) , 'financial_type_id' => array( 'name' => 'financial_type_id', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Financial Type') , 'description' => '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', 'pseudoconstant' => array( 'table' => 'civicrm_financial_type', 'keyColumn' => 'id', 'labelColumn' => 'name', ) ) , 'payment_instrument_id' => array( 'name' => 'payment_instrument_id', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Payment Method') , 'description' => 'FK to Payment Instrument', 'table_name' => 'civicrm_contribution_recur', 'entity' => 'ContributionRecur', 'bao' => 'CRM_Contribute_BAO_ContributionRecur', 'localizable' => 0, 'html' => array( 'type' => 'Select', ) , 'pseudoconstant' => array( 'optionGroupName' => 'payment_instrument', 'optionEditPath' => 'civicrm/admin/options/payment_instrument', ) ) , 'contribution_campaign_id' => array( 'name' => 'campaign_id', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Campaign') , 'description' => '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', 'pseudoconstant' => array( 'table' => 'civicrm_campaign', 'keyColumn' => 'id', 'labelColumn' => 'title', ) ) , 'is_email_receipt' => array( 'name' => 'is_email_receipt', 'type' => CRM_Utils_Type::T_BOOLEAN, 'title' => ts('Send email Receipt?') , 'description' => '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' => array( '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). */ 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 */ static function getTableName() { return self::$_tableName; } /** * Returns if this table needs to be logged * * @return boolean */ function getLog() { return self::$_log; } /** * Returns the list of fields that can be imported * * @param bool $prefix * * @return array */ static function &import($prefix = false) { $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'contribution_recur', $prefix, array()); return $r; } /** * Returns the list of fields that can be exported * * @param bool $prefix * * @return array */ static function &export($prefix = false) { $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'contribution_recur', $prefix, array()); return $r; } /** * Returns the list of indices */ public static function indices($localize = TRUE) { $indices = array( 'UI_contrib_trxn_id' => array( 'name' => 'UI_contrib_trxn_id', 'field' => array( 0 => 'trxn_id', ) , 'localizable' => false, 'unique' => true, 'sig' => 'civicrm_contribution_recur::1::trxn_id', ) , 'UI_contrib_invoice_id' => array( 'name' => 'UI_contrib_invoice_id', 'field' => array( 0 => 'invoice_id', ) , 'localizable' => false, 'unique' => true, 'sig' => 'civicrm_contribution_recur::1::invoice_id', ) , 'index_contribution_status' => array( 'name' => 'index_contribution_status', 'field' => array( 0 => 'contribution_status_id', ) , 'localizable' => false, 'sig' => 'civicrm_contribution_recur::0::contribution_status_id', ) , 'UI_contribution_recur_payment_instrument_id' => array( 'name' => 'UI_contribution_recur_payment_instrument_id', 'field' => array( 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; } }