Commit | Line | Data |
---|---|---|
e501603b | 1 | <?php |
c3fc2621 | 2 | |
e501603b TO |
3 | /** |
4 | * @package CRM | |
6b83d5bd | 5 | * @copyright CiviCRM LLC (c) 2004-2019 |
e501603b TO |
6 | * |
7 | * Generated from xml/schema/CRM/Contribute/ContributionSoft.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
042043f1 | 9 | * (GenCodeChecksum:80b29a1f7da297139c5265799fb4ffc3) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the ContributionSoft entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Contribute_DAO_ContributionSoft extends CRM_Core_DAO { |
c3fc2621 | 16 | |
e501603b | 17 | /** |
f41f0342 | 18 | * Static instance to hold the table name. |
e501603b TO |
19 | * |
20 | * @var string | |
21 | */ | |
fa45b5b9 | 22 | public static $_tableName = 'civicrm_contribution_soft'; |
c3fc2621 | 23 | |
e501603b | 24 | /** |
f41f0342 | 25 | * Should CiviCRM log any modifications to this table in the civicrm_log table. |
e501603b | 26 | * |
c3fc2621 | 27 | * @var bool |
e501603b | 28 | */ |
fa45b5b9 | 29 | public static $_log = TRUE; |
c3fc2621 | 30 | |
e501603b TO |
31 | /** |
32 | * Soft Contribution ID | |
33 | * | |
34 | * @var int unsigned | |
35 | */ | |
36 | public $id; | |
c3fc2621 | 37 | |
e501603b TO |
38 | /** |
39 | * FK to contribution table. | |
40 | * | |
41 | * @var int unsigned | |
42 | */ | |
43 | public $contribution_id; | |
c3fc2621 | 44 | |
e501603b TO |
45 | /** |
46 | * FK to Contact ID | |
47 | * | |
48 | * @var int unsigned | |
49 | */ | |
50 | public $contact_id; | |
c3fc2621 | 51 | |
e501603b TO |
52 | /** |
53 | * Amount of this soft contribution. | |
54 | * | |
55 | * @var float | |
56 | */ | |
57 | public $amount; | |
c3fc2621 | 58 | |
e501603b TO |
59 | /** |
60 | * 3 character string, value from config setting or input via user. | |
61 | * | |
62 | * @var string | |
63 | */ | |
64 | public $currency; | |
c3fc2621 | 65 | |
e501603b TO |
66 | /** |
67 | * FK to civicrm_pcp.id | |
68 | * | |
69 | * @var int unsigned | |
70 | */ | |
71 | public $pcp_id; | |
c3fc2621 | 72 | |
e501603b | 73 | /** |
e501603b TO |
74 | * @var boolean |
75 | */ | |
76 | public $pcp_display_in_roll; | |
c3fc2621 | 77 | |
e501603b | 78 | /** |
e501603b TO |
79 | * @var string |
80 | */ | |
81 | public $pcp_roll_nickname; | |
c3fc2621 | 82 | |
e501603b | 83 | /** |
e501603b TO |
84 | * @var string |
85 | */ | |
86 | public $pcp_personal_note; | |
c3fc2621 | 87 | |
e501603b TO |
88 | /** |
89 | * Soft Credit Type ID.Implicit FK to civicrm_option_value where option_group = soft_credit_type. | |
90 | * | |
91 | * @var int unsigned | |
92 | */ | |
93 | public $soft_credit_type_id; | |
c3fc2621 | 94 | |
e501603b | 95 | /** |
f41f0342 | 96 | * Class constructor. |
e501603b | 97 | */ |
c3fc2621 | 98 | public function __construct() { |
e501603b TO |
99 | $this->__table = 'civicrm_contribution_soft'; |
100 | parent::__construct(); | |
101 | } | |
c3fc2621 | 102 | |
e501603b | 103 | /** |
f41f0342 | 104 | * Returns foreign keys and entity references. |
e501603b TO |
105 | * |
106 | * @return array | |
107 | * [CRM_Core_Reference_Interface] | |
108 | */ | |
c3fc2621 | 109 | public static function getReferenceColumns() { |
346aaaba | 110 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
fa45b5b9 | 111 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 CW |
112 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contribution_id', 'civicrm_contribution', 'id'); |
113 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id', 'civicrm_contact', 'id'); | |
114 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'pcp_id', 'civicrm_pcp', 'id'); | |
346aaaba | 115 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 116 | } |
346aaaba | 117 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 118 | } |
c3fc2621 | 119 | |
e501603b TO |
120 | /** |
121 | * Returns all the column names of this table | |
122 | * | |
123 | * @return array | |
124 | */ | |
c3fc2621 | 125 | public static function &fields() { |
346aaaba | 126 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
127 | Civi::$statics[__CLASS__]['fields'] = [ |
128 | 'contribution_soft_id' => [ | |
e501603b TO |
129 | 'name' => 'id', |
130 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 131 | 'title' => ts('Soft Contribution ID'), |
215b423e | 132 | 'description' => ts('Soft Contribution ID'), |
c3fc2621 CW |
133 | 'required' => TRUE, |
134 | 'import' => TRUE, | |
e501603b | 135 | 'where' => 'civicrm_contribution_soft.id', |
c3fc2621 | 136 | 'export' => TRUE, |
522a26c9 | 137 | 'table_name' => 'civicrm_contribution_soft', |
138 | 'entity' => 'ContributionSoft', | |
139 | 'bao' => 'CRM_Contribute_BAO_ContributionSoft', | |
6a7e5e5d | 140 | 'localizable' => 0, |
c3fc2621 CW |
141 | ], |
142 | 'contribution_id' => [ | |
e501603b TO |
143 | 'name' => 'contribution_id', |
144 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 145 | 'title' => ts('Soft Contribution - Contribution'), |
215b423e | 146 | 'description' => ts('FK to contribution table.'), |
c3fc2621 | 147 | 'required' => TRUE, |
a36434b9 | 148 | 'where' => 'civicrm_contribution_soft.contribution_id', |
522a26c9 | 149 | 'table_name' => 'civicrm_contribution_soft', |
150 | 'entity' => 'ContributionSoft', | |
151 | 'bao' => 'CRM_Contribute_BAO_ContributionSoft', | |
6a7e5e5d | 152 | 'localizable' => 0, |
e501603b | 153 | 'FKClassName' => 'CRM_Contribute_DAO_Contribution', |
c3fc2621 CW |
154 | ], |
155 | 'contribution_soft_contact_id' => [ | |
e501603b TO |
156 | 'name' => 'contact_id', |
157 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 158 | 'title' => ts('Contact ID'), |
215b423e | 159 | 'description' => ts('FK to Contact ID'), |
c3fc2621 CW |
160 | 'required' => TRUE, |
161 | 'import' => TRUE, | |
e501603b TO |
162 | 'where' => 'civicrm_contribution_soft.contact_id', |
163 | 'headerPattern' => '/contact(.?id)?/i', | |
164 | 'dataPattern' => '/^\d+$/', | |
c3fc2621 | 165 | 'export' => TRUE, |
522a26c9 | 166 | 'table_name' => 'civicrm_contribution_soft', |
167 | 'entity' => 'ContributionSoft', | |
168 | 'bao' => 'CRM_Contribute_BAO_ContributionSoft', | |
6a7e5e5d | 169 | 'localizable' => 0, |
e501603b | 170 | 'FKClassName' => 'CRM_Contact_DAO_Contact', |
c3fc2621 CW |
171 | ], |
172 | 'amount' => [ | |
e501603b TO |
173 | 'name' => 'amount', |
174 | 'type' => CRM_Utils_Type::T_MONEY, | |
c3fc2621 | 175 | 'title' => ts('Soft Contribution Amount'), |
215b423e | 176 | 'description' => ts('Amount of this soft contribution.'), |
c3fc2621 CW |
177 | 'required' => TRUE, |
178 | 'precision' => [ | |
e501603b TO |
179 | 20, |
180 | 2 | |
c3fc2621 CW |
181 | ], |
182 | 'import' => TRUE, | |
e501603b TO |
183 | 'where' => 'civicrm_contribution_soft.amount', |
184 | 'headerPattern' => '/total(.?am(ou)?nt)?/i', | |
185 | 'dataPattern' => '/^\d+(\.\d{2})?$/', | |
c3fc2621 | 186 | 'export' => TRUE, |
522a26c9 | 187 | 'table_name' => 'civicrm_contribution_soft', |
188 | 'entity' => 'ContributionSoft', | |
189 | 'bao' => 'CRM_Contribute_BAO_ContributionSoft', | |
6a7e5e5d | 190 | 'localizable' => 0, |
c3fc2621 CW |
191 | ], |
192 | 'currency' => [ | |
e501603b TO |
193 | 'name' => 'currency', |
194 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 195 | 'title' => ts('Soft Contribution Currency'), |
215b423e | 196 | 'description' => ts('3 character string, value from config setting or input via user.'), |
e501603b TO |
197 | 'maxlength' => 3, |
198 | 'size' => CRM_Utils_Type::FOUR, | |
a36434b9 | 199 | 'where' => 'civicrm_contribution_soft.currency', |
e501603b | 200 | 'default' => 'NULL', |
522a26c9 | 201 | 'table_name' => 'civicrm_contribution_soft', |
202 | 'entity' => 'ContributionSoft', | |
203 | 'bao' => 'CRM_Contribute_BAO_ContributionSoft', | |
6a7e5e5d | 204 | 'localizable' => 0, |
c3fc2621 | 205 | 'html' => [ |
e501603b | 206 | 'type' => 'Select', |
c3fc2621 CW |
207 | ], |
208 | 'pseudoconstant' => [ | |
e501603b TO |
209 | 'table' => 'civicrm_currency', |
210 | 'keyColumn' => 'name', | |
211 | 'labelColumn' => 'full_name', | |
212 | 'nameColumn' => 'name', | |
c3fc2621 CW |
213 | ] |
214 | ], | |
215 | 'pcp_id' => [ | |
e501603b TO |
216 | 'name' => 'pcp_id', |
217 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 218 | 'title' => ts('Soft Contribution PCP'), |
215b423e | 219 | 'description' => ts('FK to civicrm_pcp.id'), |
a36434b9 | 220 | 'where' => 'civicrm_contribution_soft.pcp_id', |
e501603b | 221 | 'default' => 'NULL', |
522a26c9 | 222 | 'table_name' => 'civicrm_contribution_soft', |
223 | 'entity' => 'ContributionSoft', | |
224 | 'bao' => 'CRM_Contribute_BAO_ContributionSoft', | |
6a7e5e5d | 225 | 'localizable' => 0, |
e501603b | 226 | 'FKClassName' => 'CRM_PCP_DAO_PCP', |
c3fc2621 | 227 | 'pseudoconstant' => [ |
e501603b TO |
228 | 'table' => 'civicrm_pcp', |
229 | 'keyColumn' => 'id', | |
230 | 'labelColumn' => 'title', | |
c3fc2621 CW |
231 | ] |
232 | ], | |
233 | 'pcp_display_in_roll' => [ | |
e501603b TO |
234 | 'name' => 'pcp_display_in_roll', |
235 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 236 | 'title' => ts('Soft Contribution Display on PCP'), |
a36434b9 | 237 | 'where' => 'civicrm_contribution_soft.pcp_display_in_roll', |
45a83e42 | 238 | 'default' => '0', |
522a26c9 | 239 | 'table_name' => 'civicrm_contribution_soft', |
240 | 'entity' => 'ContributionSoft', | |
241 | 'bao' => 'CRM_Contribute_BAO_ContributionSoft', | |
6a7e5e5d | 242 | 'localizable' => 0, |
c3fc2621 CW |
243 | ], |
244 | 'pcp_roll_nickname' => [ | |
e501603b TO |
245 | 'name' => 'pcp_roll_nickname', |
246 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 247 | 'title' => ts('Soft Contribution PCP Nickname'), |
e501603b TO |
248 | 'maxlength' => 255, |
249 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 250 | 'where' => 'civicrm_contribution_soft.pcp_roll_nickname', |
e501603b | 251 | 'default' => 'NULL', |
522a26c9 | 252 | 'table_name' => 'civicrm_contribution_soft', |
253 | 'entity' => 'ContributionSoft', | |
254 | 'bao' => 'CRM_Contribute_BAO_ContributionSoft', | |
6a7e5e5d | 255 | 'localizable' => 0, |
c3fc2621 CW |
256 | ], |
257 | 'pcp_personal_note' => [ | |
e501603b TO |
258 | 'name' => 'pcp_personal_note', |
259 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 260 | 'title' => ts('Soft Contribution PCP Note'), |
e501603b TO |
261 | 'maxlength' => 255, |
262 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 263 | 'where' => 'civicrm_contribution_soft.pcp_personal_note', |
e501603b | 264 | 'default' => 'NULL', |
522a26c9 | 265 | 'table_name' => 'civicrm_contribution_soft', |
266 | 'entity' => 'ContributionSoft', | |
267 | 'bao' => 'CRM_Contribute_BAO_ContributionSoft', | |
6a7e5e5d | 268 | 'localizable' => 0, |
bddddc63 | 269 | 'html' => [ |
270 | 'type' => 'TextArea', | |
271 | ], | |
c3fc2621 CW |
272 | ], |
273 | 'soft_credit_type_id' => [ | |
e501603b TO |
274 | 'name' => 'soft_credit_type_id', |
275 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 276 | 'title' => ts('Soft Credit Type'), |
215b423e | 277 | 'description' => ts('Soft Credit Type ID.Implicit FK to civicrm_option_value where option_group = soft_credit_type.'), |
a36434b9 | 278 | 'where' => 'civicrm_contribution_soft.soft_credit_type_id', |
e501603b | 279 | 'default' => 'NULL', |
522a26c9 | 280 | 'table_name' => 'civicrm_contribution_soft', |
281 | 'entity' => 'ContributionSoft', | |
282 | 'bao' => 'CRM_Contribute_BAO_ContributionSoft', | |
6a7e5e5d | 283 | 'localizable' => 0, |
c3fc2621 | 284 | 'pseudoconstant' => [ |
e501603b TO |
285 | 'optionGroupName' => 'soft_credit_type', |
286 | 'optionEditPath' => 'civicrm/admin/options/soft_credit_type', | |
c3fc2621 CW |
287 | ] |
288 | ], | |
289 | ]; | |
346aaaba | 290 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 291 | } |
346aaaba | 292 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 293 | } |
c3fc2621 | 294 | |
e501603b | 295 | /** |
bd8e0b14 | 296 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
297 | * |
298 | * @return array | |
bd8e0b14 | 299 | * Array(string $name => string $uniqueName). |
e501603b | 300 | */ |
c3fc2621 | 301 | public static function &fieldKeys() { |
bd8e0b14 TO |
302 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
303 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 304 | } |
bd8e0b14 | 305 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 306 | } |
c3fc2621 | 307 | |
e501603b TO |
308 | /** |
309 | * Returns the names of this table | |
310 | * | |
311 | * @return string | |
312 | */ | |
c3fc2621 | 313 | public static function getTableName() { |
e501603b TO |
314 | return self::$_tableName; |
315 | } | |
c3fc2621 | 316 | |
e501603b TO |
317 | /** |
318 | * Returns if this table needs to be logged | |
319 | * | |
c3fc2621 | 320 | * @return bool |
e501603b | 321 | */ |
c3fc2621 | 322 | public function getLog() { |
e501603b TO |
323 | return self::$_log; |
324 | } | |
c3fc2621 | 325 | |
e501603b TO |
326 | /** |
327 | * Returns the list of fields that can be imported | |
328 | * | |
329 | * @param bool $prefix | |
330 | * | |
331 | * @return array | |
332 | */ | |
c3fc2621 CW |
333 | public static function &import($prefix = FALSE) { |
334 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'contribution_soft', $prefix, []); | |
60808919 | 335 | return $r; |
e501603b | 336 | } |
c3fc2621 | 337 | |
e501603b TO |
338 | /** |
339 | * Returns the list of fields that can be exported | |
340 | * | |
341 | * @param bool $prefix | |
342 | * | |
343 | * @return array | |
344 | */ | |
c3fc2621 CW |
345 | public static function &export($prefix = FALSE) { |
346 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'contribution_soft', $prefix, []); | |
60808919 | 347 | return $r; |
e501603b | 348 | } |
c3fc2621 | 349 | |
e7a6b91a AS |
350 | /** |
351 | * Returns the list of indices | |
c3fc2621 CW |
352 | * |
353 | * @param bool $localize | |
354 | * | |
355 | * @return array | |
e7a6b91a AS |
356 | */ |
357 | public static function indices($localize = TRUE) { | |
c3fc2621 CW |
358 | $indices = [ |
359 | 'index_id' => [ | |
e7a6b91a | 360 | 'name' => 'index_id', |
c3fc2621 | 361 | 'field' => [ |
e7a6b91a | 362 | 0 => 'pcp_id', |
c3fc2621 CW |
363 | ], |
364 | 'localizable' => FALSE, | |
e7a6b91a | 365 | 'sig' => 'civicrm_contribution_soft::0::pcp_id', |
c3fc2621 CW |
366 | ], |
367 | ]; | |
e7a6b91a AS |
368 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
369 | } | |
c3fc2621 | 370 | |
e501603b | 371 | } |