settings/Contribute.setting.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  *
  33  * Settings metadata file
  34  */
  35
  36 return [
  37   'cvv_backoffice_required' => [
  38     'group_name' => 'Contribute Preferences',
  39     'group' => 'contribute',
  40     'name' => 'cvv_backoffice_required',
  41     'type' => 'Boolean',
  42     'html_type' => 'radio',
  43     'quick_form_type' => 'YesNo',
  44     'default' => '1',
  45     'add' => '4.1',
  46     'title' => 'CVV required for backoffice?',
  47     'is_domain' => 1,
  48     'is_contact' => 0,
  49     'description' => 'Is the CVV code required for back office credit card transactions',
  50     'help_text' => 'If set it back-office credit card transactions will required a cvv code. Leave as required unless you have a very strong reason to change',
  51   ],
  52   'contribution_invoice_settings' => [
  53     // @todo our standard is to have a setting per item not to hide settings in an array with
  54     // no useful metadata. Undo this setting.
  55     'group_name' => 'Contribute Preferences',
  56     'group' => 'contribute',
  57     'name' => 'contribution_invoice_settings',
  58     'type' => 'Array',
  59     'default' => [
  60       'invoice_prefix' => 'INV_',
  61       'credit_notes_prefix' => 'CN_',
  62       'due_date' => '10',
  63       'due_date_period' => 'days',
  64       'notes' => '',
  65       'tax_term' => 'Sales Tax',
  66       'tax_display_settings' => 'Inclusive',
  67     ],
  68     'add' => '4.7',
  69     'title' => 'Contribution Invoice Settings',
  70     'is_domain' => 1,
  71     'is_contact' => 0,
  72     'description' => NULL,
  73     'help_text' => NULL,
  74   ],
  75   'invoicing' => [
  76     'group_name' => 'Contribute Preferences',
  77     'group' => 'contribute',
  78     'name' => 'invoicing',
  79     'type' => 'Boolean',
  80     'html_type' => 'checkbox',
  81     'quick_form_type' => 'Element',
  82     'default' => 0,
  83     'add' => '4.7',
  84     'title' => 'Enable Tax and Invoicing',
  85     'is_domain' => 1,
  86     'is_contact' => 0,
  87     'on_change' => [
  88       'CRM_Invoicing_Utils::onToggle',
  89     ],
  90   ],
  91   'acl_financial_type' => [
  92     'group_name' => 'Contribute Preferences',
  93     'group' => 'contribute',
  94     'name' => 'acl_financial_type',
  95     'type' => 'Boolean',
  96     'html_type' => 'checkbox',
  97     'quick_form_type' => 'Element',
  98     'default' => 0,
  99     'add' => '4.7',
 100     'title' => 'Enable Access Control by Financial Type',
 101     'is_domain' => 1,
 102     'is_contact' => 0,
 103     'description' => NULL,
 104     'help_text' => NULL,
 105     'help' => ['id' => 'acl_financial_type'],
 106   ],
 107   'deferred_revenue_enabled' => [
 108     'group_name' => 'Contribute Preferences',
 109     'group' => 'contribute',
 110     'name' => 'deferred_revenue_enabled',
 111     'type' => 'Boolean',
 112     'html_type' => 'checkbox',
 113     'quick_form_type' => 'Element',
 114     'default' => 0,
 115     'add' => '4.7',
 116     'title' => 'Enable Deferred Revenue',
 117     'is_domain' => 1,
 118     'is_contact' => 0,
 119     'description' => NULL,
 120     'help_text' => NULL,
 121   ],
 122   'default_invoice_page' => [
 123     'group_name' => 'Contribute Preferences',
 124     'group' => 'contribute',
 125     'name' => 'default_invoice_page',
 126     'type' => 'Integer',
 127     'quick_form_type' => 'Select',
 128     'default' => NULL,
 129     'pseudoconstant' => [
 130       // @todo - handle table style pseudoconstants for settings & avoid deprecated function.
 131       'callback' => 'CRM_Contribute_PseudoConstant::contributionPage',
 132     ],
 133     'html_type' => 'select',
 134     'add' => '4.7',
 135     'title' => 'Default invoice payment page',
 136     'is_domain' => 1,
 137     'is_contact' => 0,
 138     'description' => NULL,
 139     'help_text' => NULL,
 140   ],
 141   'always_post_to_accounts_receivable' => [
 142     'group_name' => 'Contribute Preferences',
 143     'group' => 'contribute',
 144     'name' => 'always_post_to_accounts_receivable',
 145     'type' => 'Boolean',
 146     'html_type' => 'checkbox',
 147     'quick_form_type' => 'Element',
 148     'default' => 0,
 149     'add' => '4.7',
 150     'title' => 'Always post to Accounts Receivable?',
 151     'is_domain' => 1,
 152     'is_contact' => 0,
 153     'description' => NULL,
 154     'help_text' => NULL,
 155   ],
 156   'update_contribution_on_membership_type_change' => [
 157     'group_name' => 'Contribute Preferences',
 158     'group' => 'contribute',
 159     'name' => 'update_contribution_on_membership_type_change',
 160     'type' => 'Boolean',
 161     'html_type' => 'checkbox',
 162     'quick_form_type' => 'Element',
 163     'default' => 0,
 164     'add' => '4.7',
 165     'title' => 'Automatically update related contributions when Membership Type is changed',
 166     'is_domain' => 1,
 167     'is_contact' => 0,
 168     'description' => 'Enabling this setting will update related contribution of membership(s) except if the membership is paid for with a recurring contribution.',
 169     'help_text' => NULL,
 170   ],
 171 ];