Commit | Line | Data |
---|---|---|
e501603b | 1 | <?php |
c3fc2621 | 2 | |
e501603b TO |
3 | /** |
4 | * @package CRM | |
ca5cec67 | 5 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
e501603b TO |
6 | * |
7 | * Generated from xml/schema/CRM/Member/MembershipType.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
495f49d4 | 9 | * (GenCodeChecksum:9cb69957096aad15ee7d55a4efceb53e) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the MembershipType entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Member_DAO_MembershipType extends CRM_Core_DAO { |
929a1c14 CW |
16 | const EXT = 'civicrm'; |
17 | const TABLE_ADDED = '1.5'; | |
d31fb4e3 | 18 | const COMPONENT = 'CiviMember'; |
c3fc2621 | 19 | |
e501603b | 20 | /** |
f41f0342 | 21 | * Static instance to hold the table name. |
e501603b TO |
22 | * |
23 | * @var string | |
24 | */ | |
fa45b5b9 | 25 | public static $_tableName = 'civicrm_membership_type'; |
c3fc2621 | 26 | |
8ab43c93 CW |
27 | /** |
28 | * Field to show when displaying a record. | |
29 | * | |
30 | * @var string | |
31 | */ | |
32 | public static $_labelField = 'name'; | |
33 | ||
e501603b | 34 | /** |
f41f0342 | 35 | * Should CiviCRM log any modifications to this table in the civicrm_log table. |
e501603b | 36 | * |
c3fc2621 | 37 | * @var bool |
e501603b | 38 | */ |
fa45b5b9 | 39 | public static $_log = TRUE; |
c3fc2621 | 40 | |
e501603b | 41 | /** |
2cbbebe8 | 42 | * Membership ID |
e501603b | 43 | * |
e6ca0a57 | 44 | * @var int |
e501603b TO |
45 | */ |
46 | public $id; | |
c3fc2621 | 47 | |
e501603b TO |
48 | /** |
49 | * Which Domain is this match entry for | |
50 | * | |
e6ca0a57 | 51 | * @var int |
e501603b TO |
52 | */ |
53 | public $domain_id; | |
c3fc2621 | 54 | |
e501603b TO |
55 | /** |
56 | * Name of Membership Type | |
57 | * | |
58 | * @var string | |
59 | */ | |
60 | public $name; | |
c3fc2621 | 61 | |
e501603b TO |
62 | /** |
63 | * Description of Membership Type | |
64 | * | |
65 | * @var string | |
66 | */ | |
67 | public $description; | |
c3fc2621 | 68 | |
e501603b TO |
69 | /** |
70 | * Owner organization for this membership type. FK to Contact ID | |
71 | * | |
e6ca0a57 | 72 | * @var int |
e501603b TO |
73 | */ |
74 | public $member_of_contact_id; | |
c3fc2621 | 75 | |
e501603b TO |
76 | /** |
77 | * If membership is paid by a contribution - what financial type should be used. FK to civicrm_financial_type.id | |
78 | * | |
e6ca0a57 | 79 | * @var int |
e501603b TO |
80 | */ |
81 | public $financial_type_id; | |
c3fc2621 | 82 | |
e501603b TO |
83 | /** |
84 | * Minimum fee for this membership (0 for free/complimentary memberships). | |
85 | * | |
86 | * @var float | |
87 | */ | |
88 | public $minimum_fee; | |
c3fc2621 | 89 | |
e501603b TO |
90 | /** |
91 | * Unit in which membership period is expressed. | |
92 | * | |
93 | * @var string | |
94 | */ | |
95 | public $duration_unit; | |
c3fc2621 | 96 | |
e501603b TO |
97 | /** |
98 | * Number of duration units in membership period (e.g. 1 year, 12 months). | |
99 | * | |
100 | * @var int | |
101 | */ | |
102 | public $duration_interval; | |
c3fc2621 | 103 | |
e501603b TO |
104 | /** |
105 | * Rolling membership period starts on signup date. Fixed membership periods start on fixed_period_start_day. | |
106 | * | |
107 | * @var string | |
108 | */ | |
109 | public $period_type; | |
c3fc2621 | 110 | |
e501603b TO |
111 | /** |
112 | * For fixed period memberships, month and day (mmdd) on which subscription/membership will start. Period start is back-dated unless after rollover day. | |
113 | * | |
114 | * @var int | |
115 | */ | |
116 | public $fixed_period_start_day; | |
c3fc2621 | 117 | |
e501603b TO |
118 | /** |
119 | * For fixed period memberships, signups after this day (mmdd) rollover to next period. | |
120 | * | |
121 | * @var int | |
122 | */ | |
123 | public $fixed_period_rollover_day; | |
c3fc2621 | 124 | |
e501603b TO |
125 | /** |
126 | * FK to Relationship Type ID | |
127 | * | |
128 | * @var string | |
129 | */ | |
130 | public $relationship_type_id; | |
c3fc2621 | 131 | |
e501603b | 132 | /** |
e501603b TO |
133 | * @var string |
134 | */ | |
135 | public $relationship_direction; | |
c3fc2621 | 136 | |
e501603b TO |
137 | /** |
138 | * Maximum number of related memberships. | |
139 | * | |
140 | * @var int | |
141 | */ | |
142 | public $max_related; | |
c3fc2621 | 143 | |
e501603b | 144 | /** |
e501603b TO |
145 | * @var string |
146 | */ | |
147 | public $visibility; | |
c3fc2621 | 148 | |
e501603b | 149 | /** |
e501603b TO |
150 | * @var int |
151 | */ | |
152 | public $weight; | |
c3fc2621 | 153 | |
e501603b TO |
154 | /** |
155 | * Receipt Text for membership signup | |
156 | * | |
157 | * @var string | |
158 | */ | |
159 | public $receipt_text_signup; | |
c3fc2621 | 160 | |
e501603b TO |
161 | /** |
162 | * Receipt Text for membership renewal | |
163 | * | |
164 | * @var string | |
165 | */ | |
166 | public $receipt_text_renewal; | |
c3fc2621 | 167 | |
e501603b TO |
168 | /** |
169 | * 0 = No auto-renew option; 1 = Give option, but not required; 2 = Auto-renew required; | |
170 | * | |
05250199 | 171 | * @var int |
e501603b TO |
172 | */ |
173 | public $auto_renew; | |
c3fc2621 | 174 | |
e501603b TO |
175 | /** |
176 | * Is this membership_type enabled | |
177 | * | |
e6ca0a57 | 178 | * @var bool |
e501603b TO |
179 | */ |
180 | public $is_active; | |
c3fc2621 | 181 | |
e501603b | 182 | /** |
f41f0342 | 183 | * Class constructor. |
e501603b | 184 | */ |
c3fc2621 | 185 | public function __construct() { |
e501603b TO |
186 | $this->__table = 'civicrm_membership_type'; |
187 | parent::__construct(); | |
188 | } | |
c3fc2621 | 189 | |
449c4e6b CW |
190 | /** |
191 | * Returns localized title of this entity. | |
7b66c3b5 AH |
192 | * |
193 | * @param bool $plural | |
194 | * Whether to return the plural version of the title. | |
449c4e6b | 195 | */ |
7b66c3b5 AH |
196 | public static function getEntityTitle($plural = FALSE) { |
197 | return $plural ? ts('Membership Types') : ts('Membership Type'); | |
449c4e6b CW |
198 | } |
199 | ||
e501603b | 200 | /** |
f41f0342 | 201 | * Returns foreign keys and entity references. |
e501603b TO |
202 | * |
203 | * @return array | |
204 | * [CRM_Core_Reference_Interface] | |
205 | */ | |
c3fc2621 | 206 | public static function getReferenceColumns() { |
346aaaba | 207 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
fa45b5b9 | 208 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 CW |
209 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'domain_id', 'civicrm_domain', 'id'); |
210 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'member_of_contact_id', 'civicrm_contact', 'id'); | |
211 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'financial_type_id', 'civicrm_financial_type', 'id'); | |
346aaaba | 212 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 213 | } |
346aaaba | 214 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 215 | } |
c3fc2621 | 216 | |
e501603b TO |
217 | /** |
218 | * Returns all the column names of this table | |
219 | * | |
220 | * @return array | |
221 | */ | |
c3fc2621 | 222 | public static function &fields() { |
346aaaba | 223 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
224 | Civi::$statics[__CLASS__]['fields'] = [ |
225 | 'id' => [ | |
e501603b TO |
226 | 'name' => 'id', |
227 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 228 | 'title' => ts('Membership Type ID'), |
2cbbebe8 | 229 | 'description' => ts('Membership ID'), |
c3fc2621 | 230 | 'required' => TRUE, |
a36434b9 | 231 | 'where' => 'civicrm_membership_type.id', |
522a26c9 | 232 | 'table_name' => 'civicrm_membership_type', |
233 | 'entity' => 'MembershipType', | |
234 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 235 | 'localizable' => 0, |
2cbbebe8 A |
236 | 'html' => [ |
237 | 'type' => 'Number', | |
238 | ], | |
1fe423d6 | 239 | 'readonly' => TRUE, |
a9d0587b | 240 | 'add' => '1.5', |
c3fc2621 CW |
241 | ], |
242 | 'domain_id' => [ | |
e501603b TO |
243 | 'name' => 'domain_id', |
244 | 'type' => CRM_Utils_Type::T_INT, | |
2cbbebe8 | 245 | 'title' => ts('Domain ID'), |
215b423e | 246 | 'description' => ts('Which Domain is this match entry for'), |
c3fc2621 | 247 | 'required' => TRUE, |
a36434b9 | 248 | 'where' => 'civicrm_membership_type.domain_id', |
522a26c9 | 249 | 'table_name' => 'civicrm_membership_type', |
250 | 'entity' => 'MembershipType', | |
251 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 252 | 'localizable' => 0, |
e501603b | 253 | 'FKClassName' => 'CRM_Core_DAO_Domain', |
2cbbebe8 A |
254 | 'html' => [ |
255 | 'label' => ts("Domain"), | |
256 | ], | |
c3fc2621 | 257 | 'pseudoconstant' => [ |
e501603b TO |
258 | 'table' => 'civicrm_domain', |
259 | 'keyColumn' => 'id', | |
260 | 'labelColumn' => 'name', | |
e6ca0a57 | 261 | ], |
a9d0587b | 262 | 'add' => '3.0', |
c3fc2621 CW |
263 | ], |
264 | 'membership_type' => [ | |
e501603b TO |
265 | 'name' => 'name', |
266 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 267 | 'title' => ts('Membership Type'), |
215b423e | 268 | 'description' => ts('Name of Membership Type'), |
dec137c7 | 269 | 'required' => TRUE, |
e501603b TO |
270 | 'maxlength' => 128, |
271 | 'size' => CRM_Utils_Type::HUGE, | |
c3fc2621 | 272 | 'import' => TRUE, |
e501603b | 273 | 'where' => 'civicrm_membership_type.name', |
c3fc2621 | 274 | 'export' => TRUE, |
522a26c9 | 275 | 'table_name' => 'civicrm_membership_type', |
276 | 'entity' => 'MembershipType', | |
277 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 278 | 'localizable' => 1, |
6f85d058 | 279 | 'html' => [ |
280 | 'type' => 'Text', | |
4361de53 | 281 | 'label' => ts("Name"), |
6f85d058 | 282 | ], |
a9d0587b | 283 | 'add' => '1.5', |
c3fc2621 CW |
284 | ], |
285 | 'description' => [ | |
e501603b TO |
286 | 'name' => 'description', |
287 | 'type' => CRM_Utils_Type::T_STRING, | |
c23563e3 | 288 | 'title' => ts('Description'), |
215b423e | 289 | 'description' => ts('Description of Membership Type'), |
e501603b TO |
290 | 'maxlength' => 255, |
291 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 292 | 'where' => 'civicrm_membership_type.description', |
522a26c9 | 293 | 'table_name' => 'civicrm_membership_type', |
294 | 'entity' => 'MembershipType', | |
295 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 296 | 'localizable' => 1, |
c3fc2621 | 297 | 'html' => [ |
e501603b | 298 | 'type' => 'TextArea', |
4361de53 | 299 | 'label' => ts("Description"), |
c3fc2621 | 300 | ], |
a9d0587b | 301 | 'add' => '1.5', |
c3fc2621 CW |
302 | ], |
303 | 'member_of_contact_id' => [ | |
e501603b TO |
304 | 'name' => 'member_of_contact_id', |
305 | 'type' => CRM_Utils_Type::T_INT, | |
2cbbebe8 | 306 | 'title' => ts('Organization ID'), |
215b423e | 307 | 'description' => ts('Owner organization for this membership type. FK to Contact ID'), |
c3fc2621 | 308 | 'required' => TRUE, |
a36434b9 | 309 | 'where' => 'civicrm_membership_type.member_of_contact_id', |
522a26c9 | 310 | 'table_name' => 'civicrm_membership_type', |
311 | 'entity' => 'MembershipType', | |
312 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 313 | 'localizable' => 0, |
e501603b | 314 | 'FKClassName' => 'CRM_Contact_DAO_Contact', |
2cbbebe8 A |
315 | 'html' => [ |
316 | 'label' => ts("Organization"), | |
317 | ], | |
a9d0587b | 318 | 'add' => '1.5', |
c3fc2621 CW |
319 | ], |
320 | 'financial_type_id' => [ | |
e501603b TO |
321 | 'name' => 'financial_type_id', |
322 | 'type' => CRM_Utils_Type::T_INT, | |
2cbbebe8 | 323 | 'title' => ts('Financial Type ID'), |
215b423e | 324 | 'description' => ts('If membership is paid by a contribution - what financial type should be used. FK to civicrm_financial_type.id'), |
c3fc2621 | 325 | 'required' => TRUE, |
a36434b9 | 326 | 'where' => 'civicrm_membership_type.financial_type_id', |
522a26c9 | 327 | 'table_name' => 'civicrm_membership_type', |
328 | 'entity' => 'MembershipType', | |
329 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 330 | 'localizable' => 0, |
e501603b | 331 | 'FKClassName' => 'CRM_Financial_DAO_FinancialType', |
2cbbebe8 A |
332 | 'html' => [ |
333 | 'label' => ts("Financial Type"), | |
334 | ], | |
c3fc2621 | 335 | 'pseudoconstant' => [ |
e501603b TO |
336 | 'table' => 'civicrm_financial_type', |
337 | 'keyColumn' => 'id', | |
338 | 'labelColumn' => 'name', | |
e6ca0a57 | 339 | ], |
a9d0587b | 340 | 'add' => '4.3', |
c3fc2621 CW |
341 | ], |
342 | 'minimum_fee' => [ | |
e501603b TO |
343 | 'name' => 'minimum_fee', |
344 | 'type' => CRM_Utils_Type::T_MONEY, | |
c23563e3 | 345 | 'title' => ts('Minimum Fee'), |
215b423e | 346 | 'description' => ts('Minimum fee for this membership (0 for free/complimentary memberships).'), |
c3fc2621 | 347 | 'precision' => [ |
25e0f950 | 348 | 18, |
fb607354 | 349 | 9, |
c3fc2621 | 350 | ], |
a36434b9 | 351 | 'where' => 'civicrm_membership_type.minimum_fee', |
45a83e42 | 352 | 'default' => '0', |
522a26c9 | 353 | 'table_name' => 'civicrm_membership_type', |
354 | 'entity' => 'MembershipType', | |
355 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 356 | 'localizable' => 0, |
6f85d058 | 357 | 'html' => [ |
358 | 'type' => 'Text', | |
4361de53 | 359 | 'label' => ts("Minimum Fee"), |
6f85d058 | 360 | ], |
a9d0587b | 361 | 'add' => '1.5', |
c3fc2621 CW |
362 | ], |
363 | 'duration_unit' => [ | |
e501603b TO |
364 | 'name' => 'duration_unit', |
365 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 366 | 'title' => ts('Membership Type Duration Unit'), |
215b423e | 367 | 'description' => ts('Unit in which membership period is expressed.'), |
495f49d4 | 368 | 'required' => TRUE, |
e501603b TO |
369 | 'maxlength' => 8, |
370 | 'size' => CRM_Utils_Type::EIGHT, | |
a36434b9 | 371 | 'where' => 'civicrm_membership_type.duration_unit', |
522a26c9 | 372 | 'table_name' => 'civicrm_membership_type', |
373 | 'entity' => 'MembershipType', | |
374 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 375 | 'localizable' => 0, |
c3fc2621 | 376 | 'html' => [ |
e501603b | 377 | 'type' => 'Select', |
c3fc2621 CW |
378 | ], |
379 | 'pseudoconstant' => [ | |
e501603b | 380 | 'callback' => 'CRM_Core_SelectValues::membershipTypeUnitList', |
e6ca0a57 | 381 | ], |
a9d0587b | 382 | 'add' => '1.5', |
c3fc2621 CW |
383 | ], |
384 | 'duration_interval' => [ | |
e501603b TO |
385 | 'name' => 'duration_interval', |
386 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 387 | 'title' => ts('Membership Type Duration Interval'), |
215b423e | 388 | 'description' => ts('Number of duration units in membership period (e.g. 1 year, 12 months).'), |
a36434b9 | 389 | 'where' => 'civicrm_membership_type.duration_interval', |
522a26c9 | 390 | 'table_name' => 'civicrm_membership_type', |
391 | 'entity' => 'MembershipType', | |
392 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 393 | 'localizable' => 0, |
6f85d058 | 394 | 'html' => [ |
395 | 'type' => 'Text', | |
396 | ], | |
a9d0587b | 397 | 'add' => '1.5', |
c3fc2621 CW |
398 | ], |
399 | 'period_type' => [ | |
e501603b TO |
400 | 'name' => 'period_type', |
401 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 402 | 'title' => ts('Membership Type Plan'), |
215b423e | 403 | 'description' => ts('Rolling membership period starts on signup date. Fixed membership periods start on fixed_period_start_day.'), |
0524826d | 404 | 'required' => TRUE, |
e501603b TO |
405 | 'maxlength' => 8, |
406 | 'size' => CRM_Utils_Type::EIGHT, | |
a36434b9 | 407 | 'where' => 'civicrm_membership_type.period_type', |
522a26c9 | 408 | 'table_name' => 'civicrm_membership_type', |
409 | 'entity' => 'MembershipType', | |
410 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 411 | 'localizable' => 0, |
6f85d058 | 412 | 'html' => [ |
413 | 'type' => 'Select', | |
414 | ], | |
c3fc2621 | 415 | 'pseudoconstant' => [ |
e501603b | 416 | 'callback' => 'CRM_Core_SelectValues::periodType', |
e6ca0a57 | 417 | ], |
a9d0587b | 418 | 'add' => '1.5', |
c3fc2621 CW |
419 | ], |
420 | 'fixed_period_start_day' => [ | |
e501603b TO |
421 | 'name' => 'fixed_period_start_day', |
422 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 423 | 'title' => ts('Fixed Period Start Day'), |
215b423e | 424 | 'description' => ts('For fixed period memberships, month and day (mmdd) on which subscription/membership will start. Period start is back-dated unless after rollover day.'), |
a36434b9 | 425 | 'where' => 'civicrm_membership_type.fixed_period_start_day', |
522a26c9 | 426 | 'table_name' => 'civicrm_membership_type', |
427 | 'entity' => 'MembershipType', | |
428 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 429 | 'localizable' => 0, |
a9d0587b | 430 | 'add' => '1.5', |
c3fc2621 CW |
431 | ], |
432 | 'fixed_period_rollover_day' => [ | |
e501603b TO |
433 | 'name' => 'fixed_period_rollover_day', |
434 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 435 | 'title' => ts('Fixed Period Rollover Day'), |
215b423e | 436 | 'description' => ts('For fixed period memberships, signups after this day (mmdd) rollover to next period.'), |
a36434b9 | 437 | 'where' => 'civicrm_membership_type.fixed_period_rollover_day', |
522a26c9 | 438 | 'table_name' => 'civicrm_membership_type', |
439 | 'entity' => 'MembershipType', | |
440 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 441 | 'localizable' => 0, |
a9d0587b | 442 | 'add' => '1.5', |
c3fc2621 CW |
443 | ], |
444 | 'relationship_type_id' => [ | |
e501603b TO |
445 | 'name' => 'relationship_type_id', |
446 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 447 | 'title' => ts('Membership Type Relationship'), |
215b423e | 448 | 'description' => ts('FK to Relationship Type ID'), |
e501603b TO |
449 | 'maxlength' => 64, |
450 | 'size' => CRM_Utils_Type::BIG, | |
a36434b9 | 451 | 'where' => 'civicrm_membership_type.relationship_type_id', |
522a26c9 | 452 | 'table_name' => 'civicrm_membership_type', |
453 | 'entity' => 'MembershipType', | |
454 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 455 | 'localizable' => 0, |
96c40ac7 | 456 | 'serialize' => self::SERIALIZE_SEPARATOR_TRIMMED, |
a9d0587b | 457 | 'add' => '1.5', |
c3fc2621 CW |
458 | ], |
459 | 'relationship_direction' => [ | |
e501603b TO |
460 | 'name' => 'relationship_direction', |
461 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 462 | 'title' => ts('Relationship Direction'), |
e501603b TO |
463 | 'maxlength' => 128, |
464 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 465 | 'where' => 'civicrm_membership_type.relationship_direction', |
522a26c9 | 466 | 'table_name' => 'civicrm_membership_type', |
467 | 'entity' => 'MembershipType', | |
468 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 469 | 'localizable' => 0, |
96c40ac7 | 470 | 'serialize' => self::SERIALIZE_SEPARATOR_TRIMMED, |
c23563e3 SL |
471 | 'html' => [ |
472 | 'label' => ts("Relationship Direction"), | |
473 | ], | |
a9d0587b | 474 | 'add' => '1.7', |
c3fc2621 CW |
475 | ], |
476 | 'max_related' => [ | |
e501603b TO |
477 | 'name' => 'max_related', |
478 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 479 | 'title' => ts('Max Related Members for Type'), |
215b423e | 480 | 'description' => ts('Maximum number of related memberships.'), |
a36434b9 | 481 | 'where' => 'civicrm_membership_type.max_related', |
522a26c9 | 482 | 'table_name' => 'civicrm_membership_type', |
483 | 'entity' => 'MembershipType', | |
484 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 485 | 'localizable' => 0, |
6f85d058 | 486 | 'html' => [ |
487 | 'type' => 'Text', | |
4361de53 | 488 | 'label' => ts("Max Related"), |
6f85d058 | 489 | ], |
a9d0587b | 490 | 'add' => '4.3', |
c3fc2621 CW |
491 | ], |
492 | 'visibility' => [ | |
e501603b TO |
493 | 'name' => 'visibility', |
494 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 495 | 'title' => ts('Visible'), |
e501603b TO |
496 | 'maxlength' => 64, |
497 | 'size' => CRM_Utils_Type::BIG, | |
a36434b9 | 498 | 'where' => 'civicrm_membership_type.visibility', |
522a26c9 | 499 | 'table_name' => 'civicrm_membership_type', |
500 | 'entity' => 'MembershipType', | |
501 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 502 | 'localizable' => 0, |
c3fc2621 | 503 | 'html' => [ |
e501603b | 504 | 'type' => 'Select', |
c3fc2621 CW |
505 | ], |
506 | 'pseudoconstant' => [ | |
e501603b | 507 | 'callback' => 'CRM_Core_SelectValues::memberVisibility', |
e6ca0a57 | 508 | ], |
a9d0587b | 509 | 'add' => '1.5', |
c3fc2621 CW |
510 | ], |
511 | 'weight' => [ | |
e501603b TO |
512 | 'name' => 'weight', |
513 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 514 | 'title' => ts('Order'), |
a36434b9 | 515 | 'where' => 'civicrm_membership_type.weight', |
522a26c9 | 516 | 'table_name' => 'civicrm_membership_type', |
517 | 'entity' => 'MembershipType', | |
518 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 519 | 'localizable' => 0, |
6f85d058 | 520 | 'html' => [ |
521 | 'type' => 'Text', | |
522 | ], | |
a9d0587b | 523 | 'add' => '1.5', |
c3fc2621 CW |
524 | ], |
525 | 'receipt_text_signup' => [ | |
e501603b TO |
526 | 'name' => 'receipt_text_signup', |
527 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 528 | 'title' => ts('Membership Type Receipt Text'), |
215b423e | 529 | 'description' => ts('Receipt Text for membership signup'), |
e501603b TO |
530 | 'maxlength' => 255, |
531 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 532 | 'where' => 'civicrm_membership_type.receipt_text_signup', |
522a26c9 | 533 | 'table_name' => 'civicrm_membership_type', |
534 | 'entity' => 'MembershipType', | |
535 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 536 | 'localizable' => 0, |
c3fc2621 | 537 | 'html' => [ |
e501603b | 538 | 'type' => 'TextArea', |
c3fc2621 | 539 | ], |
a9d0587b | 540 | 'add' => '2.0', |
c3fc2621 CW |
541 | ], |
542 | 'receipt_text_renewal' => [ | |
e501603b TO |
543 | 'name' => 'receipt_text_renewal', |
544 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 545 | 'title' => ts('Membership Type Renewal Text'), |
215b423e | 546 | 'description' => ts('Receipt Text for membership renewal'), |
e501603b TO |
547 | 'maxlength' => 255, |
548 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 549 | 'where' => 'civicrm_membership_type.receipt_text_renewal', |
522a26c9 | 550 | 'table_name' => 'civicrm_membership_type', |
551 | 'entity' => 'MembershipType', | |
552 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 553 | 'localizable' => 0, |
c3fc2621 | 554 | 'html' => [ |
e501603b | 555 | 'type' => 'TextArea', |
c3fc2621 | 556 | ], |
a9d0587b | 557 | 'add' => '2.0', |
c3fc2621 CW |
558 | ], |
559 | 'auto_renew' => [ | |
e501603b | 560 | 'name' => 'auto_renew', |
05250199 | 561 | 'type' => CRM_Utils_Type::T_INT, |
c3fc2621 | 562 | 'title' => ts('Auto Renew'), |
215b423e | 563 | 'description' => ts('0 = No auto-renew option; 1 = Give option, but not required; 2 = Auto-renew required;'), |
a36434b9 | 564 | 'where' => 'civicrm_membership_type.auto_renew', |
45a83e42 | 565 | 'default' => '0', |
522a26c9 | 566 | 'table_name' => 'civicrm_membership_type', |
567 | 'entity' => 'MembershipType', | |
568 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 569 | 'localizable' => 0, |
fc093e40 | 570 | 'html' => [ |
571 | 'type' => 'Radio', | |
c23563e3 | 572 | 'label' => ts("Auto-Renew"), |
fc093e40 | 573 | ], |
c3fc2621 | 574 | 'pseudoconstant' => [ |
e501603b | 575 | 'callback' => 'CRM_Core_SelectValues::memberAutoRenew', |
e6ca0a57 | 576 | ], |
a9d0587b | 577 | 'add' => '3.3', |
c3fc2621 CW |
578 | ], |
579 | 'is_active' => [ | |
e501603b TO |
580 | 'name' => 'is_active', |
581 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 582 | 'title' => ts('Is Active'), |
215b423e | 583 | 'description' => ts('Is this membership_type enabled'), |
a36434b9 | 584 | 'where' => 'civicrm_membership_type.is_active', |
e501603b | 585 | 'default' => '1', |
522a26c9 | 586 | 'table_name' => 'civicrm_membership_type', |
587 | 'entity' => 'MembershipType', | |
588 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 589 | 'localizable' => 0, |
6f85d058 | 590 | 'html' => [ |
591 | 'type' => 'CheckBox', | |
4361de53 | 592 | 'label' => ts("Enabled?"), |
6f85d058 | 593 | ], |
a9d0587b | 594 | 'add' => '1.5', |
c3fc2621 CW |
595 | ], |
596 | ]; | |
346aaaba | 597 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 598 | } |
346aaaba | 599 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 600 | } |
c3fc2621 | 601 | |
e501603b | 602 | /** |
bd8e0b14 | 603 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
604 | * |
605 | * @return array | |
bd8e0b14 | 606 | * Array(string $name => string $uniqueName). |
e501603b | 607 | */ |
c3fc2621 | 608 | public static function &fieldKeys() { |
bd8e0b14 TO |
609 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
610 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 611 | } |
bd8e0b14 | 612 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 613 | } |
c3fc2621 | 614 | |
e501603b TO |
615 | /** |
616 | * Returns the names of this table | |
617 | * | |
618 | * @return string | |
619 | */ | |
c3fc2621 | 620 | public static function getTableName() { |
e501603b TO |
621 | return CRM_Core_DAO::getLocaleTableName(self::$_tableName); |
622 | } | |
c3fc2621 | 623 | |
e501603b TO |
624 | /** |
625 | * Returns if this table needs to be logged | |
626 | * | |
c3fc2621 | 627 | * @return bool |
e501603b | 628 | */ |
c3fc2621 | 629 | public function getLog() { |
e501603b TO |
630 | return self::$_log; |
631 | } | |
c3fc2621 | 632 | |
e501603b TO |
633 | /** |
634 | * Returns the list of fields that can be imported | |
635 | * | |
636 | * @param bool $prefix | |
637 | * | |
638 | * @return array | |
639 | */ | |
c3fc2621 CW |
640 | public static function &import($prefix = FALSE) { |
641 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'membership_type', $prefix, []); | |
60808919 | 642 | return $r; |
e501603b | 643 | } |
c3fc2621 | 644 | |
e501603b TO |
645 | /** |
646 | * Returns the list of fields that can be exported | |
647 | * | |
648 | * @param bool $prefix | |
649 | * | |
650 | * @return array | |
651 | */ | |
c3fc2621 CW |
652 | public static function &export($prefix = FALSE) { |
653 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'membership_type', $prefix, []); | |
60808919 | 654 | return $r; |
e501603b | 655 | } |
c3fc2621 | 656 | |
e7a6b91a AS |
657 | /** |
658 | * Returns the list of indices | |
c3fc2621 CW |
659 | * |
660 | * @param bool $localize | |
661 | * | |
662 | * @return array | |
e7a6b91a AS |
663 | */ |
664 | public static function indices($localize = TRUE) { | |
c3fc2621 CW |
665 | $indices = [ |
666 | 'index_relationship_type_id' => [ | |
e7a6b91a | 667 | 'name' => 'index_relationship_type_id', |
c3fc2621 | 668 | 'field' => [ |
e7a6b91a | 669 | 0 => 'relationship_type_id', |
c3fc2621 CW |
670 | ], |
671 | 'localizable' => FALSE, | |
e7a6b91a | 672 | 'sig' => 'civicrm_membership_type::0::relationship_type_id', |
c3fc2621 CW |
673 | ], |
674 | ]; | |
e7a6b91a AS |
675 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
676 | } | |
c3fc2621 | 677 | |
e501603b | 678 | } |