Commit | Line | Data |
---|---|---|
e501603b TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.7 | | |
5 | +--------------------------------------------------------------------+ | |
6 | | Copyright CiviCRM LLC (c) 2004-2016 | | |
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 | * @package CRM | |
29 | * @copyright CiviCRM LLC (c) 2004-2016 | |
30 | * | |
31 | * Generated from xml/schema/CRM/Financial/FinancialType.xml | |
32 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
437fafcf | 33 | * (GenCodeChecksum:70310c419681152b59c27bc1b3e013d9) |
e501603b TO |
34 | */ |
35 | require_once 'CRM/Core/DAO.php'; | |
36 | require_once 'CRM/Utils/Type.php'; | |
37 | class CRM_Financial_DAO_FinancialType extends CRM_Core_DAO { | |
38 | /** | |
39 | * static instance to hold the table name | |
40 | * | |
41 | * @var string | |
42 | */ | |
43 | static $_tableName = 'civicrm_financial_type'; | |
44 | /** | |
45 | * static instance to hold the field values | |
46 | * | |
47 | * @var array | |
48 | */ | |
49 | static $_fields = null; | |
50 | /** | |
51 | * static instance to hold the keys used in $_fields for each field. | |
52 | * | |
53 | * @var array | |
54 | */ | |
55 | static $_fieldKeys = null; | |
56 | /** | |
57 | * static instance to hold the FK relationships | |
58 | * | |
59 | * @var string | |
60 | */ | |
61 | static $_links = null; | |
e501603b TO |
62 | /** |
63 | * static value to see if we should log any modifications to | |
64 | * this table in the civicrm_log table | |
65 | * | |
66 | * @var boolean | |
67 | */ | |
68 | static $_log = true; | |
69 | /** | |
70 | * 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 | |
71 | * | |
72 | * @var int unsigned | |
73 | */ | |
74 | public $id; | |
75 | /** | |
76 | * Financial Type Name. | |
77 | * | |
78 | * @var string | |
79 | */ | |
80 | public $name; | |
81 | /** | |
82 | * Financial Type Description. | |
83 | * | |
84 | * @var string | |
85 | */ | |
86 | public $description; | |
87 | /** | |
88 | * 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. | |
89 | * | |
90 | * @var boolean | |
91 | */ | |
92 | public $is_deductible; | |
93 | /** | |
94 | * Is this a predefined system object? | |
95 | * | |
96 | * @var boolean | |
97 | */ | |
98 | public $is_reserved; | |
99 | /** | |
100 | * Is this property active? | |
101 | * | |
102 | * @var boolean | |
103 | */ | |
104 | public $is_active; | |
105 | /** | |
106 | * class constructor | |
107 | * | |
108 | * @return civicrm_financial_type | |
109 | */ | |
110 | function __construct() { | |
111 | $this->__table = 'civicrm_financial_type'; | |
112 | parent::__construct(); | |
113 | } | |
114 | /** | |
115 | * Returns all the column names of this table | |
116 | * | |
117 | * @return array | |
118 | */ | |
119 | static function &fields() { | |
120 | if (!(self::$_fields)) { | |
121 | self::$_fields = array( | |
122 | 'id' => array( | |
123 | 'name' => 'id', | |
124 | 'type' => CRM_Utils_Type::T_INT, | |
125 | 'title' => ts('Financial Type ID') , | |
126 | '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', | |
127 | 'required' => true, | |
128 | ) , | |
129 | 'financial_type' => array( | |
130 | 'name' => 'name', | |
131 | 'type' => CRM_Utils_Type::T_STRING, | |
132 | 'title' => ts('Financial Type') , | |
133 | 'description' => 'Financial Type Name.', | |
134 | 'required' => true, | |
135 | 'maxlength' => 64, | |
136 | 'size' => CRM_Utils_Type::BIG, | |
137 | 'import' => true, | |
138 | 'where' => 'civicrm_financial_type.name', | |
139 | 'headerPattern' => '/(finan(cial)?)?type/i', | |
140 | 'dataPattern' => '/donation|member|campaign/i', | |
141 | 'export' => true, | |
142 | ) , | |
143 | 'description' => array( | |
144 | 'name' => 'description', | |
145 | 'type' => CRM_Utils_Type::T_STRING, | |
146 | 'title' => ts('Description') , | |
147 | 'description' => 'Financial Type Description.', | |
148 | 'maxlength' => 255, | |
149 | 'size' => CRM_Utils_Type::HUGE, | |
150 | ) , | |
151 | 'is_deductible' => array( | |
152 | 'name' => 'is_deductible', | |
153 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
154 | 'title' => ts('Is Tax Deductible?') , | |
155 | '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.', | |
156 | 'default' => '1', | |
157 | ) , | |
158 | 'is_reserved' => array( | |
159 | 'name' => 'is_reserved', | |
160 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
161 | 'title' => ts('Financial Type is Reserved?') , | |
162 | 'description' => 'Is this a predefined system object?', | |
163 | ) , | |
164 | 'is_active' => array( | |
165 | 'name' => 'is_active', | |
166 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
167 | 'title' => ts('Financial Type Is Active?') , | |
168 | 'description' => 'Is this property active?', | |
169 | ) , | |
170 | ); | |
171 | } | |
172 | return self::$_fields; | |
173 | } | |
174 | /** | |
175 | * Returns an array containing, for each field, the arary key used for that | |
176 | * field in self::$_fields. | |
177 | * | |
178 | * @return array | |
179 | */ | |
180 | static function &fieldKeys() { | |
181 | if (!(self::$_fieldKeys)) { | |
182 | self::$_fieldKeys = array( | |
183 | 'id' => 'id', | |
184 | 'name' => 'financial_type', | |
185 | 'description' => 'description', | |
186 | 'is_deductible' => 'is_deductible', | |
187 | 'is_reserved' => 'is_reserved', | |
188 | 'is_active' => 'is_active', | |
189 | ); | |
190 | } | |
191 | return self::$_fieldKeys; | |
192 | } | |
193 | /** | |
194 | * Returns the names of this table | |
195 | * | |
196 | * @return string | |
197 | */ | |
198 | static function getTableName() { | |
199 | return self::$_tableName; | |
200 | } | |
201 | /** | |
202 | * Returns if this table needs to be logged | |
203 | * | |
204 | * @return boolean | |
205 | */ | |
206 | function getLog() { | |
207 | return self::$_log; | |
208 | } | |
209 | /** | |
210 | * Returns the list of fields that can be imported | |
211 | * | |
212 | * @param bool $prefix | |
213 | * | |
214 | * @return array | |
215 | */ | |
216 | static function &import($prefix = false) { | |
60808919 TO |
217 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'financial_type', $prefix, array()); |
218 | return $r; | |
e501603b TO |
219 | } |
220 | /** | |
221 | * Returns the list of fields that can be exported | |
222 | * | |
223 | * @param bool $prefix | |
224 | * | |
225 | * @return array | |
226 | */ | |
227 | static function &export($prefix = false) { | |
60808919 TO |
228 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'financial_type', $prefix, array()); |
229 | return $r; | |
e501603b TO |
230 | } |
231 | } |