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/Premium.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
1713a0ec | 9 | * (GenCodeChecksum:10cc32dfc45ec3853caebce2d5b78018) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the Premium entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Contribute_DAO_Premium 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_premiums'; |
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 | 31 | /** |
e6ca0a57 | 32 | * @var int |
e501603b TO |
33 | */ |
34 | public $id; | |
c3fc2621 | 35 | |
e501603b TO |
36 | /** |
37 | * Joins these premium settings to another object. Always civicrm_contribution_page for now. | |
38 | * | |
39 | * @var string | |
40 | */ | |
41 | public $entity_table; | |
c3fc2621 | 42 | |
e501603b | 43 | /** |
e6ca0a57 | 44 | * @var int |
e501603b TO |
45 | */ |
46 | public $entity_id; | |
c3fc2621 | 47 | |
e501603b TO |
48 | /** |
49 | * Is the Premiums feature enabled for this page? | |
50 | * | |
e6ca0a57 | 51 | * @var bool |
e501603b TO |
52 | */ |
53 | public $premiums_active; | |
c3fc2621 | 54 | |
e501603b TO |
55 | /** |
56 | * Title for Premiums section. | |
57 | * | |
58 | * @var string | |
59 | */ | |
60 | public $premiums_intro_title; | |
c3fc2621 | 61 | |
e501603b TO |
62 | /** |
63 | * Displayed in <div> at top of Premiums section of page. Text and HTML allowed. | |
64 | * | |
65 | * @var text | |
66 | */ | |
67 | public $premiums_intro_text; | |
c3fc2621 | 68 | |
e501603b TO |
69 | /** |
70 | * This email address is included in receipts if it is populated and a premium has been selected. | |
71 | * | |
72 | * @var string | |
73 | */ | |
74 | public $premiums_contact_email; | |
c3fc2621 | 75 | |
e501603b TO |
76 | /** |
77 | * This phone number is included in receipts if it is populated and a premium has been selected. | |
78 | * | |
79 | * @var string | |
80 | */ | |
81 | public $premiums_contact_phone; | |
c3fc2621 | 82 | |
e501603b TO |
83 | /** |
84 | * Boolean. Should we automatically display minimum contribution amount text after the premium descriptions. | |
85 | * | |
e6ca0a57 | 86 | * @var bool |
e501603b TO |
87 | */ |
88 | public $premiums_display_min_contribution; | |
c3fc2621 | 89 | |
e501603b TO |
90 | /** |
91 | * Label displayed for No Thank-you option in premiums block (e.g. No thank you) | |
92 | * | |
93 | * @var string | |
94 | */ | |
95 | public $premiums_nothankyou_label; | |
c3fc2621 | 96 | |
e501603b | 97 | /** |
e6ca0a57 | 98 | * @var int |
e501603b TO |
99 | */ |
100 | public $premiums_nothankyou_position; | |
c3fc2621 | 101 | |
e501603b | 102 | /** |
f41f0342 | 103 | * Class constructor. |
e501603b | 104 | */ |
c3fc2621 | 105 | public function __construct() { |
e501603b TO |
106 | $this->__table = 'civicrm_premiums'; |
107 | parent::__construct(); | |
108 | } | |
c3fc2621 | 109 | |
e501603b | 110 | /** |
f41f0342 | 111 | * Returns foreign keys and entity references. |
e501603b TO |
112 | * |
113 | * @return array | |
114 | * [CRM_Core_Reference_Interface] | |
115 | */ | |
c3fc2621 | 116 | public static function getReferenceColumns() { |
346aaaba | 117 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
fa45b5b9 | 118 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 | 119 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), 'entity_id', NULL, 'id', 'entity_table'); |
346aaaba | 120 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 121 | } |
346aaaba | 122 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 123 | } |
c3fc2621 | 124 | |
e501603b TO |
125 | /** |
126 | * Returns all the column names of this table | |
127 | * | |
128 | * @return array | |
129 | */ | |
c3fc2621 | 130 | public static function &fields() { |
346aaaba | 131 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
132 | Civi::$statics[__CLASS__]['fields'] = [ |
133 | 'id' => [ | |
e501603b TO |
134 | 'name' => 'id', |
135 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 CW |
136 | 'title' => ts('Premium ID'), |
137 | 'required' => TRUE, | |
a36434b9 | 138 | 'where' => 'civicrm_premiums.id', |
522a26c9 | 139 | 'table_name' => 'civicrm_premiums', |
140 | 'entity' => 'Premium', | |
141 | 'bao' => 'CRM_Contribute_BAO_Premium', | |
6a7e5e5d | 142 | 'localizable' => 0, |
c3fc2621 CW |
143 | ], |
144 | 'entity_table' => [ | |
e501603b TO |
145 | 'name' => 'entity_table', |
146 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 147 | 'title' => ts('Premium Entity'), |
215b423e | 148 | 'description' => ts('Joins these premium settings to another object. Always civicrm_contribution_page for now.'), |
c3fc2621 | 149 | 'required' => TRUE, |
e501603b TO |
150 | 'maxlength' => 64, |
151 | 'size' => CRM_Utils_Type::BIG, | |
a36434b9 | 152 | 'where' => 'civicrm_premiums.entity_table', |
522a26c9 | 153 | 'table_name' => 'civicrm_premiums', |
154 | 'entity' => 'Premium', | |
155 | 'bao' => 'CRM_Contribute_BAO_Premium', | |
6a7e5e5d | 156 | 'localizable' => 0, |
c3fc2621 CW |
157 | ], |
158 | 'entity_id' => [ | |
e501603b TO |
159 | 'name' => 'entity_id', |
160 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 CW |
161 | 'title' => ts('Premium entity ID'), |
162 | 'required' => TRUE, | |
a36434b9 | 163 | 'where' => 'civicrm_premiums.entity_id', |
522a26c9 | 164 | 'table_name' => 'civicrm_premiums', |
165 | 'entity' => 'Premium', | |
166 | 'bao' => 'CRM_Contribute_BAO_Premium', | |
6a7e5e5d | 167 | 'localizable' => 0, |
c3fc2621 CW |
168 | ], |
169 | 'premiums_active' => [ | |
e501603b TO |
170 | 'name' => 'premiums_active', |
171 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 172 | 'title' => ts('Is Premium Active?'), |
215b423e | 173 | 'description' => ts('Is the Premiums feature enabled for this page?'), |
c3fc2621 | 174 | 'required' => TRUE, |
a36434b9 | 175 | 'where' => 'civicrm_premiums.premiums_active', |
45a83e42 | 176 | 'default' => '0', |
522a26c9 | 177 | 'table_name' => 'civicrm_premiums', |
178 | 'entity' => 'Premium', | |
179 | 'bao' => 'CRM_Contribute_BAO_Premium', | |
6a7e5e5d | 180 | 'localizable' => 0, |
c3fc2621 CW |
181 | ], |
182 | 'premiums_intro_title' => [ | |
e501603b TO |
183 | 'name' => 'premiums_intro_title', |
184 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 185 | 'title' => ts('Title for Premiums section'), |
215b423e | 186 | 'description' => ts('Title for Premiums section.'), |
e501603b TO |
187 | 'maxlength' => 255, |
188 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 189 | 'where' => 'civicrm_premiums.premiums_intro_title', |
522a26c9 | 190 | 'table_name' => 'civicrm_premiums', |
191 | 'entity' => 'Premium', | |
192 | 'bao' => 'CRM_Contribute_BAO_Premium', | |
6a7e5e5d | 193 | 'localizable' => 1, |
c3fc2621 CW |
194 | ], |
195 | 'premiums_intro_text' => [ | |
e501603b TO |
196 | 'name' => 'premiums_intro_text', |
197 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 198 | 'title' => ts('Premium Introductory Text'), |
215b423e | 199 | 'description' => ts('Displayed in <div> at top of Premiums section of page. Text and HTML allowed.'), |
a36434b9 | 200 | 'where' => 'civicrm_premiums.premiums_intro_text', |
522a26c9 | 201 | 'table_name' => 'civicrm_premiums', |
202 | 'entity' => 'Premium', | |
203 | 'bao' => 'CRM_Contribute_BAO_Premium', | |
6a7e5e5d | 204 | 'localizable' => 1, |
c3fc2621 CW |
205 | ], |
206 | 'premiums_contact_email' => [ | |
e501603b TO |
207 | 'name' => 'premiums_contact_email', |
208 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 209 | 'title' => ts('Premium Contact Email'), |
215b423e | 210 | 'description' => ts('This email address is included in receipts if it is populated and a premium has been selected.'), |
e501603b TO |
211 | 'maxlength' => 100, |
212 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 213 | 'where' => 'civicrm_premiums.premiums_contact_email', |
522a26c9 | 214 | 'table_name' => 'civicrm_premiums', |
215 | 'entity' => 'Premium', | |
216 | 'bao' => 'CRM_Contribute_BAO_Premium', | |
6a7e5e5d | 217 | 'localizable' => 0, |
c3fc2621 CW |
218 | ], |
219 | 'premiums_contact_phone' => [ | |
e501603b TO |
220 | 'name' => 'premiums_contact_phone', |
221 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 222 | 'title' => ts('Premiums Contact Phone'), |
215b423e | 223 | 'description' => ts('This phone number is included in receipts if it is populated and a premium has been selected.'), |
e501603b TO |
224 | 'maxlength' => 50, |
225 | 'size' => CRM_Utils_Type::BIG, | |
a36434b9 | 226 | 'where' => 'civicrm_premiums.premiums_contact_phone', |
522a26c9 | 227 | 'table_name' => 'civicrm_premiums', |
228 | 'entity' => 'Premium', | |
229 | 'bao' => 'CRM_Contribute_BAO_Premium', | |
6a7e5e5d | 230 | 'localizable' => 0, |
c3fc2621 CW |
231 | ], |
232 | 'premiums_display_min_contribution' => [ | |
e501603b TO |
233 | 'name' => 'premiums_display_min_contribution', |
234 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 235 | 'title' => ts('Display Minimum Contribution?'), |
215b423e | 236 | 'description' => ts('Boolean. Should we automatically display minimum contribution amount text after the premium descriptions.'), |
c3fc2621 | 237 | 'required' => TRUE, |
a36434b9 | 238 | 'where' => 'civicrm_premiums.premiums_display_min_contribution', |
522a26c9 | 239 | 'table_name' => 'civicrm_premiums', |
240 | 'entity' => 'Premium', | |
241 | 'bao' => 'CRM_Contribute_BAO_Premium', | |
6a7e5e5d | 242 | 'localizable' => 0, |
c3fc2621 CW |
243 | ], |
244 | 'premiums_nothankyou_label' => [ | |
e501603b TO |
245 | 'name' => 'premiums_nothankyou_label', |
246 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 247 | 'title' => ts('No Thank-you Text'), |
215b423e | 248 | 'description' => ts('Label displayed for No Thank-you option in premiums block (e.g. No thank you)'), |
e501603b TO |
249 | 'maxlength' => 255, |
250 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 251 | 'where' => 'civicrm_premiums.premiums_nothankyou_label', |
522a26c9 | 252 | 'table_name' => 'civicrm_premiums', |
253 | 'entity' => 'Premium', | |
254 | 'bao' => 'CRM_Contribute_BAO_Premium', | |
6a7e5e5d | 255 | 'localizable' => 1, |
c3fc2621 CW |
256 | ], |
257 | 'premiums_nothankyou_position' => [ | |
e501603b TO |
258 | 'name' => 'premiums_nothankyou_position', |
259 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 260 | 'title' => ts('No Thank-you Position'), |
a36434b9 | 261 | 'where' => 'civicrm_premiums.premiums_nothankyou_position', |
e501603b | 262 | 'default' => '1', |
522a26c9 | 263 | 'table_name' => 'civicrm_premiums', |
264 | 'entity' => 'Premium', | |
265 | 'bao' => 'CRM_Contribute_BAO_Premium', | |
6a7e5e5d | 266 | 'localizable' => 0, |
c3fc2621 CW |
267 | ], |
268 | ]; | |
346aaaba | 269 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 270 | } |
346aaaba | 271 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 272 | } |
c3fc2621 | 273 | |
e501603b | 274 | /** |
bd8e0b14 | 275 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
276 | * |
277 | * @return array | |
bd8e0b14 | 278 | * Array(string $name => string $uniqueName). |
e501603b | 279 | */ |
c3fc2621 | 280 | public static function &fieldKeys() { |
bd8e0b14 TO |
281 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
282 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 283 | } |
bd8e0b14 | 284 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 285 | } |
c3fc2621 | 286 | |
e501603b TO |
287 | /** |
288 | * Returns the names of this table | |
289 | * | |
290 | * @return string | |
291 | */ | |
c3fc2621 | 292 | public static function getTableName() { |
e501603b TO |
293 | return CRM_Core_DAO::getLocaleTableName(self::$_tableName); |
294 | } | |
c3fc2621 | 295 | |
e501603b TO |
296 | /** |
297 | * Returns if this table needs to be logged | |
298 | * | |
c3fc2621 | 299 | * @return bool |
e501603b | 300 | */ |
c3fc2621 | 301 | public function getLog() { |
e501603b TO |
302 | return self::$_log; |
303 | } | |
c3fc2621 | 304 | |
e501603b TO |
305 | /** |
306 | * Returns the list of fields that can be imported | |
307 | * | |
308 | * @param bool $prefix | |
309 | * | |
310 | * @return array | |
311 | */ | |
c3fc2621 CW |
312 | public static function &import($prefix = FALSE) { |
313 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'premiums', $prefix, []); | |
60808919 | 314 | return $r; |
e501603b | 315 | } |
c3fc2621 | 316 | |
e501603b TO |
317 | /** |
318 | * Returns the list of fields that can be exported | |
319 | * | |
320 | * @param bool $prefix | |
321 | * | |
322 | * @return array | |
323 | */ | |
c3fc2621 CW |
324 | public static function &export($prefix = FALSE) { |
325 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'premiums', $prefix, []); | |
60808919 | 326 | return $r; |
e501603b | 327 | } |
c3fc2621 | 328 | |
e7a6b91a AS |
329 | /** |
330 | * Returns the list of indices | |
c3fc2621 CW |
331 | * |
332 | * @param bool $localize | |
333 | * | |
334 | * @return array | |
e7a6b91a AS |
335 | */ |
336 | public static function indices($localize = TRUE) { | |
c3fc2621 | 337 | $indices = []; |
e7a6b91a AS |
338 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
339 | } | |
c3fc2621 | 340 | |
e501603b | 341 | } |