/**
* @package CRM
- * @copyright CiviCRM LLC (c) 2004-2018
+ * @copyright CiviCRM LLC (c) 2004-2019
*
* Generated from xml/schema/CRM/Contribute/ContributionRecur.xml
* DO NOT EDIT. Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:86dee7eccc17a37ef08043f32396b80d)
+ * (GenCodeChecksum:1eb0ecd4aadee175dadb66464c06dd25)
*/
/**
public $id;
/**
- * Foreign key to civicrm_contact.id .
+ * Foreign key to civicrm_contact.id.
*
* @var int unsigned
*/
'name' => 'id',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('Recurring Contribution ID'),
- 'description' => 'Contribution Recur ID',
+ 'description' => ts('Contribution Recur ID'),
'required' => TRUE,
'table_name' => 'civicrm_contribution_recur',
'entity' => 'ContributionRecur',
'contact_id' => [
'name' => 'contact_id',
'type' => CRM_Utils_Type::T_INT,
- 'title' => ts('Contact ID'),
- 'description' => 'Foreign key to civicrm_contact.id .',
+ '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' => 'Amount to be contributed or charged each recurrence.',
+ 'description' => ts('Amount to be contributed or charged each recurrence.'),
'required' => TRUE,
'precision' => [
20,
'name' => 'currency',
'type' => CRM_Utils_Type::T_STRING,
'title' => ts('Currency'),
- 'description' => '3 character string, value from config setting or input via user.',
+ 'description' => ts('3 character string, value from config setting or input via user.'),
'maxlength' => 3,
'size' => CRM_Utils_Type::FOUR,
'default' => 'NULL',
'name' => 'frequency_unit',
'type' => CRM_Utils_Type::T_STRING,
'title' => ts('Frequency Unit'),
- 'description' => 'Time units for recurrence of payment.',
+ 'description' => ts('Time units for recurrence of payment.'),
'maxlength' => 8,
'size' => CRM_Utils_Type::EIGHT,
'default' => 'month',
'name' => 'frequency_interval',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('Interval (number of units)'),
- 'description' => 'Number of time units for recurrence of payment.',
+ 'description' => ts('Number of time units for recurrence of payment.'),
'required' => TRUE,
'table_name' => 'civicrm_contribution_recur',
'entity' => 'ContributionRecur',
'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.',
+ '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',
'start_date' => [
'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.',
+ 'title' => ts('Start Date'),
+ 'description' => ts('The date the first scheduled recurring contribution occurs.'),
'required' => TRUE,
'table_name' => 'civicrm_contribution_recur',
'entity' => 'ContributionRecur',
'localizable' => 0,
'html' => [
'type' => 'Select Date',
- 'formatType' => 'activityDate',
+ 'formatType' => 'activityDateTime',
],
],
'create_date' => [
'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.',
+ 'title' => ts('Created Date'),
+ 'description' => ts('When this recurring contribution record was created.'),
'required' => TRUE,
'table_name' => 'civicrm_contribution_recur',
'entity' => 'ContributionRecur',
'localizable' => 0,
'html' => [
'type' => 'Select Date',
- 'formatType' => 'activityDate',
+ 'formatType' => 'activityDateTime',
],
],
'modified_date' => [
'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',
+ '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' => 'activityDate',
+ 'formatType' => 'activityDateTime',
],
],
'cancel_date' => [
'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',
+ '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',
'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',
+ 'description' => ts('Date this recurring contribution finished successfully'),
'table_name' => 'civicrm_contribution_recur',
'entity' => 'ContributionRecur',
'bao' => 'CRM_Contribute_BAO_ContributionRecur',
'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??',
+ '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' => 'Optionally used to store a link to a payment token used for this recurring contribution.',
+ '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',
'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',
+ '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' => 'unique invoice id, system generated or passed in',
+ '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('Recurring Contribution Status'),
+ 'title' => ts('Status'),
'import' => TRUE,
'where' => 'civicrm_contribution_recur.contribution_status_id',
'headerPattern' => '',
'entity' => 'ContributionRecur',
'bao' => 'CRM_Contribute_BAO_ContributionRecur',
'localizable' => 0,
+ 'html' => [
+ 'type' => 'Select',
+ ],
'pseudoconstant' => [
'optionGroupName' => 'contribution_status',
'optionEditPath' => 'civicrm/admin/options/contribution_status',
'cycle_day' => [
'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.',
+ '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',
'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',
+ 'description' => ts('Next scheduled date'),
'table_name' => 'civicrm_contribution_recur',
'entity' => 'ContributionRecur',
'bao' => 'CRM_Contribute_BAO_ContributionRecur',
'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.',
+ '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',
'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',
+ 'description' => ts('Date to retry failed attempt'),
'table_name' => 'civicrm_contribution_recur',
'entity' => 'ContributionRecur',
'bao' => 'CRM_Contribute_BAO_ContributionRecur',
'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.',
+ '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',
'name' => 'payment_processor_id',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('Payment Processor'),
- 'description' => 'Foreign key to civicrm_payment_processor.id',
+ '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',
+ ],
],
'financial_type_id' => [
'name' => 'financial_type_id',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('Financial Type'),
- 'description' => 'FK to Financial Type',
+ 'description' => ts('FK to Financial Type'),
'export' => FALSE,
'where' => 'civicrm_contribution_recur.financial_type_id',
'headerPattern' => '',
'bao' => 'CRM_Contribute_BAO_ContributionRecur',
'localizable' => 0,
'FKClassName' => 'CRM_Financial_DAO_FinancialType',
+ 'html' => [
+ 'type' => 'Select',
+ ],
'pseudoconstant' => [
'table' => 'civicrm_financial_type',
'keyColumn' => 'id',
'name' => 'payment_instrument_id',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('Payment Method'),
- 'description' => 'FK to Payment Instrument',
+ 'description' => ts('FK to Payment Instrument'),
'table_name' => 'civicrm_contribution_recur',
'entity' => 'ContributionRecur',
'bao' => 'CRM_Contribute_BAO_ContributionRecur',
'name' => 'campaign_id',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('Campaign'),
- 'description' => 'The campaign for which this contribution has been triggered.',
+ 'description' => ts('The campaign for which this contribution has been triggered.'),
'import' => TRUE,
'where' => 'civicrm_contribution_recur.campaign_id',
'headerPattern' => '',
'bao' => 'CRM_Contribute_BAO_ContributionRecur',
'localizable' => 0,
'FKClassName' => 'CRM_Campaign_DAO_Campaign',
+ 'html' => [
+ 'type' => 'Select',
+ ],
'pseudoconstant' => [
'table' => 'civicrm_campaign',
'keyColumn' => 'id',
'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',
+ 'description' => ts('if true, receipt is automatically emailed to contact on each successful payment'),
'default' => '1',
'table_name' => 'civicrm_contribution_recur',
'entity' => 'ContributionRecur',