3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * @copyright CiviCRM LLC (c) 2004-2017
31 * Generated from xml/schema/CRM/Financial/FinancialType.xml
32 * DO NOT EDIT. Generated by CRM_Core_CodeGen
33 * (GenCodeChecksum:9d787931917508983d68631821eea721)
35 require_once 'CRM/Core/DAO.php';
36 require_once 'CRM/Utils/Type.php';
38 * CRM_Financial_DAO_FinancialType constructor.
40 class CRM_Financial_DAO_FinancialType
extends CRM_Core_DAO
{
42 * Static instance to hold the table name.
46 static $_tableName = 'civicrm_financial_type';
48 * Should CiviCRM log any modifications to this table in the civicrm_log table.
54 * ID of original financial_type so you can search this table by the financial_type.id and then select the relevant version based on the timestamp
60 * Financial Type Name.
66 * Financial Type Description.
72 * Is this financial type tax-deductible? If true, contributions of this type may be fully OR partially deductible - non-deductible amount is stored in the Contribution record.
76 public $is_deductible;
78 * Is this a predefined system object?
84 * Is this property active?
92 function __construct() {
93 $this->__table
= 'civicrm_financial_type';
94 parent
::__construct();
97 * Returns all the column names of this table
101 static function &fields() {
102 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
103 Civi
::$statics[__CLASS__
]['fields'] = array(
106 'type' => CRM_Utils_Type
::T_INT
,
107 'title' => ts('Financial Type ID') ,
108 'description' => 'ID of original financial_type so you can search this table by the financial_type.id and then select the relevant version based on the timestamp',
110 'table_name' => 'civicrm_financial_type',
111 'entity' => 'FinancialType',
112 'bao' => 'CRM_Financial_BAO_FinancialType',
115 'financial_type' => array(
117 'type' => CRM_Utils_Type
::T_STRING
,
118 'title' => ts('Financial Type') ,
119 'description' => 'Financial Type Name.',
122 'size' => CRM_Utils_Type
::BIG
,
124 'where' => 'civicrm_financial_type.name',
125 'headerPattern' => '/(finan(cial)?)?type/i',
126 'dataPattern' => '/donation|member|campaign/i',
128 'table_name' => 'civicrm_financial_type',
129 'entity' => 'FinancialType',
130 'bao' => 'CRM_Financial_BAO_FinancialType',
133 'description' => array(
134 'name' => 'description',
135 'type' => CRM_Utils_Type
::T_STRING
,
136 'title' => ts('Description') ,
137 'description' => 'Financial Type Description.',
139 'size' => CRM_Utils_Type
::HUGE
,
140 'table_name' => 'civicrm_financial_type',
141 'entity' => 'FinancialType',
142 'bao' => 'CRM_Financial_BAO_FinancialType',
145 'is_deductible' => array(
146 'name' => 'is_deductible',
147 'type' => CRM_Utils_Type
::T_BOOLEAN
,
148 'title' => ts('Is Tax Deductible?') ,
149 'description' => 'Is this financial type tax-deductible? If true, contributions of this type may be fully OR partially deductible - non-deductible amount is stored in the Contribution record.',
151 'table_name' => 'civicrm_financial_type',
152 'entity' => 'FinancialType',
153 'bao' => 'CRM_Financial_BAO_FinancialType',
156 'is_reserved' => array(
157 'name' => 'is_reserved',
158 'type' => CRM_Utils_Type
::T_BOOLEAN
,
159 'title' => ts('Financial Type is Reserved?') ,
160 'description' => 'Is this a predefined system object?',
161 'table_name' => 'civicrm_financial_type',
162 'entity' => 'FinancialType',
163 'bao' => 'CRM_Financial_BAO_FinancialType',
166 'is_active' => array(
167 'name' => 'is_active',
168 'type' => CRM_Utils_Type
::T_BOOLEAN
,
169 'title' => ts('Financial Type Is Active?') ,
170 'description' => 'Is this property active?',
171 'table_name' => 'civicrm_financial_type',
172 'entity' => 'FinancialType',
173 'bao' => 'CRM_Financial_BAO_FinancialType',
177 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
179 return Civi
::$statics[__CLASS__
]['fields'];
182 * Return a mapping from field-name to the corresponding key (as used in fields()).
185 * Array(string $name => string $uniqueName).
187 static function &fieldKeys() {
188 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
189 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
191 return Civi
::$statics[__CLASS__
]['fieldKeys'];
194 * Returns the names of this table
198 static function getTableName() {
199 return self
::$_tableName;
202 * Returns if this table needs to be logged
210 * Returns the list of fields that can be imported
212 * @param bool $prefix
216 static function &import($prefix = false) {
217 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'financial_type', $prefix, array());
221 * Returns the list of fields that can be exported
223 * @param bool $prefix
227 static function &export($prefix = false) {
228 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'financial_type', $prefix, array());
232 * Returns the list of indices
234 public static function indices($localize = TRUE) {
241 'localizable' => false,
243 'sig' => 'civicrm_financial_type::1::id',
246 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;