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 | |
1fe423d6 | 9 | * (GenCodeChecksum:ede0d06ec0ba6cc17b197c448abdf8e4) |
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 | * | |
e6ca0a57 | 171 | * @var bool |
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.'), |
e501603b TO |
368 | 'maxlength' => 8, |
369 | 'size' => CRM_Utils_Type::EIGHT, | |
a36434b9 | 370 | 'where' => 'civicrm_membership_type.duration_unit', |
522a26c9 | 371 | 'table_name' => 'civicrm_membership_type', |
372 | 'entity' => 'MembershipType', | |
373 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 374 | 'localizable' => 0, |
c3fc2621 | 375 | 'html' => [ |
e501603b | 376 | 'type' => 'Select', |
c3fc2621 CW |
377 | ], |
378 | 'pseudoconstant' => [ | |
e501603b | 379 | 'callback' => 'CRM_Core_SelectValues::membershipTypeUnitList', |
e6ca0a57 | 380 | ], |
a9d0587b | 381 | 'add' => '1.5', |
c3fc2621 CW |
382 | ], |
383 | 'duration_interval' => [ | |
e501603b TO |
384 | 'name' => 'duration_interval', |
385 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 386 | 'title' => ts('Membership Type Duration Interval'), |
215b423e | 387 | 'description' => ts('Number of duration units in membership period (e.g. 1 year, 12 months).'), |
a36434b9 | 388 | 'where' => 'civicrm_membership_type.duration_interval', |
522a26c9 | 389 | 'table_name' => 'civicrm_membership_type', |
390 | 'entity' => 'MembershipType', | |
391 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 392 | 'localizable' => 0, |
6f85d058 | 393 | 'html' => [ |
394 | 'type' => 'Text', | |
395 | ], | |
a9d0587b | 396 | 'add' => '1.5', |
c3fc2621 CW |
397 | ], |
398 | 'period_type' => [ | |
e501603b TO |
399 | 'name' => 'period_type', |
400 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 401 | 'title' => ts('Membership Type Plan'), |
215b423e | 402 | 'description' => ts('Rolling membership period starts on signup date. Fixed membership periods start on fixed_period_start_day.'), |
0524826d | 403 | 'required' => TRUE, |
e501603b TO |
404 | 'maxlength' => 8, |
405 | 'size' => CRM_Utils_Type::EIGHT, | |
a36434b9 | 406 | 'where' => 'civicrm_membership_type.period_type', |
522a26c9 | 407 | 'table_name' => 'civicrm_membership_type', |
408 | 'entity' => 'MembershipType', | |
409 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 410 | 'localizable' => 0, |
6f85d058 | 411 | 'html' => [ |
412 | 'type' => 'Select', | |
413 | ], | |
c3fc2621 | 414 | 'pseudoconstant' => [ |
e501603b | 415 | 'callback' => 'CRM_Core_SelectValues::periodType', |
e6ca0a57 | 416 | ], |
a9d0587b | 417 | 'add' => '1.5', |
c3fc2621 CW |
418 | ], |
419 | 'fixed_period_start_day' => [ | |
e501603b TO |
420 | 'name' => 'fixed_period_start_day', |
421 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 422 | 'title' => ts('Fixed Period Start Day'), |
215b423e | 423 | '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 | 424 | 'where' => 'civicrm_membership_type.fixed_period_start_day', |
522a26c9 | 425 | 'table_name' => 'civicrm_membership_type', |
426 | 'entity' => 'MembershipType', | |
427 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 428 | 'localizable' => 0, |
a9d0587b | 429 | 'add' => '1.5', |
c3fc2621 CW |
430 | ], |
431 | 'fixed_period_rollover_day' => [ | |
e501603b TO |
432 | 'name' => 'fixed_period_rollover_day', |
433 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 434 | 'title' => ts('Fixed Period Rollover Day'), |
215b423e | 435 | 'description' => ts('For fixed period memberships, signups after this day (mmdd) rollover to next period.'), |
a36434b9 | 436 | 'where' => 'civicrm_membership_type.fixed_period_rollover_day', |
522a26c9 | 437 | 'table_name' => 'civicrm_membership_type', |
438 | 'entity' => 'MembershipType', | |
439 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 440 | 'localizable' => 0, |
a9d0587b | 441 | 'add' => '1.5', |
c3fc2621 CW |
442 | ], |
443 | 'relationship_type_id' => [ | |
e501603b TO |
444 | 'name' => 'relationship_type_id', |
445 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 446 | 'title' => ts('Membership Type Relationship'), |
215b423e | 447 | 'description' => ts('FK to Relationship Type ID'), |
e501603b TO |
448 | 'maxlength' => 64, |
449 | 'size' => CRM_Utils_Type::BIG, | |
a36434b9 | 450 | 'where' => 'civicrm_membership_type.relationship_type_id', |
522a26c9 | 451 | 'table_name' => 'civicrm_membership_type', |
452 | 'entity' => 'MembershipType', | |
453 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 454 | 'localizable' => 0, |
96c40ac7 | 455 | 'serialize' => self::SERIALIZE_SEPARATOR_TRIMMED, |
a9d0587b | 456 | 'add' => '1.5', |
c3fc2621 CW |
457 | ], |
458 | 'relationship_direction' => [ | |
e501603b TO |
459 | 'name' => 'relationship_direction', |
460 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 461 | 'title' => ts('Relationship Direction'), |
e501603b TO |
462 | 'maxlength' => 128, |
463 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 464 | 'where' => 'civicrm_membership_type.relationship_direction', |
522a26c9 | 465 | 'table_name' => 'civicrm_membership_type', |
466 | 'entity' => 'MembershipType', | |
467 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 468 | 'localizable' => 0, |
96c40ac7 | 469 | 'serialize' => self::SERIALIZE_SEPARATOR_TRIMMED, |
c23563e3 SL |
470 | 'html' => [ |
471 | 'label' => ts("Relationship Direction"), | |
472 | ], | |
a9d0587b | 473 | 'add' => '1.7', |
c3fc2621 CW |
474 | ], |
475 | 'max_related' => [ | |
e501603b TO |
476 | 'name' => 'max_related', |
477 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 478 | 'title' => ts('Max Related Members for Type'), |
215b423e | 479 | 'description' => ts('Maximum number of related memberships.'), |
a36434b9 | 480 | 'where' => 'civicrm_membership_type.max_related', |
522a26c9 | 481 | 'table_name' => 'civicrm_membership_type', |
482 | 'entity' => 'MembershipType', | |
483 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 484 | 'localizable' => 0, |
6f85d058 | 485 | 'html' => [ |
486 | 'type' => 'Text', | |
4361de53 | 487 | 'label' => ts("Max Related"), |
6f85d058 | 488 | ], |
a9d0587b | 489 | 'add' => '4.3', |
c3fc2621 CW |
490 | ], |
491 | 'visibility' => [ | |
e501603b TO |
492 | 'name' => 'visibility', |
493 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 494 | 'title' => ts('Visible'), |
e501603b TO |
495 | 'maxlength' => 64, |
496 | 'size' => CRM_Utils_Type::BIG, | |
a36434b9 | 497 | 'where' => 'civicrm_membership_type.visibility', |
522a26c9 | 498 | 'table_name' => 'civicrm_membership_type', |
499 | 'entity' => 'MembershipType', | |
500 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 501 | 'localizable' => 0, |
c3fc2621 | 502 | 'html' => [ |
e501603b | 503 | 'type' => 'Select', |
c3fc2621 CW |
504 | ], |
505 | 'pseudoconstant' => [ | |
e501603b | 506 | 'callback' => 'CRM_Core_SelectValues::memberVisibility', |
e6ca0a57 | 507 | ], |
a9d0587b | 508 | 'add' => '1.5', |
c3fc2621 CW |
509 | ], |
510 | 'weight' => [ | |
e501603b TO |
511 | 'name' => 'weight', |
512 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 513 | 'title' => ts('Order'), |
a36434b9 | 514 | 'where' => 'civicrm_membership_type.weight', |
522a26c9 | 515 | 'table_name' => 'civicrm_membership_type', |
516 | 'entity' => 'MembershipType', | |
517 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 518 | 'localizable' => 0, |
6f85d058 | 519 | 'html' => [ |
520 | 'type' => 'Text', | |
521 | ], | |
a9d0587b | 522 | 'add' => '1.5', |
c3fc2621 CW |
523 | ], |
524 | 'receipt_text_signup' => [ | |
e501603b TO |
525 | 'name' => 'receipt_text_signup', |
526 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 527 | 'title' => ts('Membership Type Receipt Text'), |
215b423e | 528 | 'description' => ts('Receipt Text for membership signup'), |
e501603b TO |
529 | 'maxlength' => 255, |
530 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 531 | 'where' => 'civicrm_membership_type.receipt_text_signup', |
522a26c9 | 532 | 'table_name' => 'civicrm_membership_type', |
533 | 'entity' => 'MembershipType', | |
534 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 535 | 'localizable' => 0, |
c3fc2621 | 536 | 'html' => [ |
e501603b | 537 | 'type' => 'TextArea', |
c3fc2621 | 538 | ], |
a9d0587b | 539 | 'add' => '2.0', |
c3fc2621 CW |
540 | ], |
541 | 'receipt_text_renewal' => [ | |
e501603b TO |
542 | 'name' => 'receipt_text_renewal', |
543 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 544 | 'title' => ts('Membership Type Renewal Text'), |
215b423e | 545 | 'description' => ts('Receipt Text for membership renewal'), |
e501603b TO |
546 | 'maxlength' => 255, |
547 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 548 | 'where' => 'civicrm_membership_type.receipt_text_renewal', |
522a26c9 | 549 | 'table_name' => 'civicrm_membership_type', |
550 | 'entity' => 'MembershipType', | |
551 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 552 | 'localizable' => 0, |
c3fc2621 | 553 | 'html' => [ |
e501603b | 554 | 'type' => 'TextArea', |
c3fc2621 | 555 | ], |
a9d0587b | 556 | 'add' => '2.0', |
c3fc2621 CW |
557 | ], |
558 | 'auto_renew' => [ | |
e501603b TO |
559 | 'name' => 'auto_renew', |
560 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 561 | 'title' => ts('Auto Renew'), |
215b423e | 562 | 'description' => ts('0 = No auto-renew option; 1 = Give option, but not required; 2 = Auto-renew required;'), |
a36434b9 | 563 | 'where' => 'civicrm_membership_type.auto_renew', |
45a83e42 | 564 | 'default' => '0', |
522a26c9 | 565 | 'table_name' => 'civicrm_membership_type', |
566 | 'entity' => 'MembershipType', | |
567 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 568 | 'localizable' => 0, |
fc093e40 | 569 | 'html' => [ |
570 | 'type' => 'Radio', | |
c23563e3 | 571 | 'label' => ts("Auto-Renew"), |
fc093e40 | 572 | ], |
c3fc2621 | 573 | 'pseudoconstant' => [ |
e501603b | 574 | 'callback' => 'CRM_Core_SelectValues::memberAutoRenew', |
e6ca0a57 | 575 | ], |
a9d0587b | 576 | 'add' => '3.3', |
c3fc2621 CW |
577 | ], |
578 | 'is_active' => [ | |
e501603b TO |
579 | 'name' => 'is_active', |
580 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 581 | 'title' => ts('Is Active'), |
215b423e | 582 | 'description' => ts('Is this membership_type enabled'), |
a36434b9 | 583 | 'where' => 'civicrm_membership_type.is_active', |
e501603b | 584 | 'default' => '1', |
522a26c9 | 585 | 'table_name' => 'civicrm_membership_type', |
586 | 'entity' => 'MembershipType', | |
587 | 'bao' => 'CRM_Member_BAO_MembershipType', | |
6a7e5e5d | 588 | 'localizable' => 0, |
6f85d058 | 589 | 'html' => [ |
590 | 'type' => 'CheckBox', | |
4361de53 | 591 | 'label' => ts("Enabled?"), |
6f85d058 | 592 | ], |
a9d0587b | 593 | 'add' => '1.5', |
c3fc2621 CW |
594 | ], |
595 | ]; | |
346aaaba | 596 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 597 | } |
346aaaba | 598 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 599 | } |
c3fc2621 | 600 | |
e501603b | 601 | /** |
bd8e0b14 | 602 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
603 | * |
604 | * @return array | |
bd8e0b14 | 605 | * Array(string $name => string $uniqueName). |
e501603b | 606 | */ |
c3fc2621 | 607 | public static function &fieldKeys() { |
bd8e0b14 TO |
608 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
609 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 610 | } |
bd8e0b14 | 611 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 612 | } |
c3fc2621 | 613 | |
e501603b TO |
614 | /** |
615 | * Returns the names of this table | |
616 | * | |
617 | * @return string | |
618 | */ | |
c3fc2621 | 619 | public static function getTableName() { |
e501603b TO |
620 | return CRM_Core_DAO::getLocaleTableName(self::$_tableName); |
621 | } | |
c3fc2621 | 622 | |
e501603b TO |
623 | /** |
624 | * Returns if this table needs to be logged | |
625 | * | |
c3fc2621 | 626 | * @return bool |
e501603b | 627 | */ |
c3fc2621 | 628 | public function getLog() { |
e501603b TO |
629 | return self::$_log; |
630 | } | |
c3fc2621 | 631 | |
e501603b TO |
632 | /** |
633 | * Returns the list of fields that can be imported | |
634 | * | |
635 | * @param bool $prefix | |
636 | * | |
637 | * @return array | |
638 | */ | |
c3fc2621 CW |
639 | public static function &import($prefix = FALSE) { |
640 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'membership_type', $prefix, []); | |
60808919 | 641 | return $r; |
e501603b | 642 | } |
c3fc2621 | 643 | |
e501603b TO |
644 | /** |
645 | * Returns the list of fields that can be exported | |
646 | * | |
647 | * @param bool $prefix | |
648 | * | |
649 | * @return array | |
650 | */ | |
c3fc2621 CW |
651 | public static function &export($prefix = FALSE) { |
652 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'membership_type', $prefix, []); | |
60808919 | 653 | return $r; |
e501603b | 654 | } |
c3fc2621 | 655 | |
e7a6b91a AS |
656 | /** |
657 | * Returns the list of indices | |
c3fc2621 CW |
658 | * |
659 | * @param bool $localize | |
660 | * | |
661 | * @return array | |
e7a6b91a AS |
662 | */ |
663 | public static function indices($localize = TRUE) { | |
c3fc2621 CW |
664 | $indices = [ |
665 | 'index_relationship_type_id' => [ | |
e7a6b91a | 666 | 'name' => 'index_relationship_type_id', |
c3fc2621 | 667 | 'field' => [ |
e7a6b91a | 668 | 0 => 'relationship_type_id', |
c3fc2621 CW |
669 | ], |
670 | 'localizable' => FALSE, | |
e7a6b91a | 671 | 'sig' => 'civicrm_membership_type::0::relationship_type_id', |
c3fc2621 CW |
672 | ], |
673 | ]; | |
e7a6b91a AS |
674 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
675 | } | |
c3fc2621 | 676 | |
e501603b | 677 | } |