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/Membership.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
c23563e3 | 9 | * (GenCodeChecksum:595cdfb5731f1391fee016c91e425124) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the Membership entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Member_DAO_Membership 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'; |
c3fc2621 | 26 | |
449c4e6b CW |
27 | /** |
28 | * Icon associated with this entity. | |
29 | * | |
30 | * @var string | |
31 | */ | |
32 | public static $_icon = 'fa-id-badge'; | |
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 | |
a7bd99ff CW |
41 | /** |
42 | * Paths for accessing this entity in the UI. | |
43 | * | |
44 | * @var string[] | |
45 | */ | |
46 | protected static $_paths = [ | |
5c385299 | 47 | 'add' => 'civicrm/member/add?reset=1&action=add&context=standalone', |
a7bd99ff | 48 | 'view' => 'civicrm/contact/view/membership?reset=1&action=view&id=[id]&cid=[contact_id]', |
5c385299 | 49 | 'update' => 'civicrm/contact/view/membership?reset=1&action=update&id=[id]&cid=[contact_id]', |
a7bd99ff CW |
50 | 'delete' => 'civicrm/contact/view/membership?reset=1&action=delete&id=[id]&cid=[contact_id]', |
51 | ]; | |
52 | ||
e501603b | 53 | /** |
2cbbebe8 | 54 | * Membership ID |
e501603b | 55 | * |
e6ca0a57 | 56 | * @var int |
e501603b TO |
57 | */ |
58 | public $id; | |
c3fc2621 | 59 | |
e501603b TO |
60 | /** |
61 | * FK to Contact ID | |
62 | * | |
e6ca0a57 | 63 | * @var int |
e501603b TO |
64 | */ |
65 | public $contact_id; | |
c3fc2621 | 66 | |
e501603b TO |
67 | /** |
68 | * FK to Membership Type | |
69 | * | |
e6ca0a57 | 70 | * @var int |
e501603b TO |
71 | */ |
72 | public $membership_type_id; | |
c3fc2621 | 73 | |
e501603b TO |
74 | /** |
75 | * Beginning of initial membership period (member since...). | |
76 | * | |
77 | * @var date | |
78 | */ | |
79 | public $join_date; | |
c3fc2621 | 80 | |
e501603b TO |
81 | /** |
82 | * Beginning of current uninterrupted membership period. | |
83 | * | |
84 | * @var date | |
85 | */ | |
86 | public $start_date; | |
c3fc2621 | 87 | |
e501603b TO |
88 | /** |
89 | * Current membership period expire date. | |
90 | * | |
91 | * @var date | |
92 | */ | |
93 | public $end_date; | |
c3fc2621 | 94 | |
e501603b | 95 | /** |
e501603b TO |
96 | * @var string |
97 | */ | |
98 | public $source; | |
c3fc2621 | 99 | |
e501603b TO |
100 | /** |
101 | * FK to Membership Status | |
102 | * | |
e6ca0a57 | 103 | * @var int |
e501603b TO |
104 | */ |
105 | public $status_id; | |
c3fc2621 | 106 | |
e501603b TO |
107 | /** |
108 | * Admin users may set a manual status which overrides the calculated status. When this flag is true, automated status update scripts should NOT modify status for the record. | |
109 | * | |
e6ca0a57 | 110 | * @var bool |
e501603b TO |
111 | */ |
112 | public $is_override; | |
c3fc2621 | 113 | |
e136f704 O |
114 | /** |
115 | * Then end date of membership status override if 'Override until selected date' override type is selected. | |
116 | * | |
117 | * @var date | |
118 | */ | |
119 | public $status_override_end_date; | |
120 | ||
e501603b TO |
121 | /** |
122 | * Optional FK to Parent Membership. | |
123 | * | |
e6ca0a57 | 124 | * @var int |
e501603b TO |
125 | */ |
126 | public $owner_membership_id; | |
c3fc2621 | 127 | |
e501603b TO |
128 | /** |
129 | * Maximum number of related memberships (membership_type override). | |
130 | * | |
131 | * @var int | |
132 | */ | |
133 | public $max_related; | |
c3fc2621 | 134 | |
e501603b | 135 | /** |
e6ca0a57 | 136 | * @var bool |
e501603b TO |
137 | */ |
138 | public $is_test; | |
c3fc2621 | 139 | |
e501603b | 140 | /** |
e6ca0a57 | 141 | * @var bool |
e501603b TO |
142 | */ |
143 | public $is_pay_later; | |
c3fc2621 | 144 | |
e501603b TO |
145 | /** |
146 | * Conditional foreign key to civicrm_contribution_recur id. Each membership in connection with a recurring contribution carries a foreign key to the recurring contribution record. This assumes we can track these processor initiated events. | |
147 | * | |
e6ca0a57 | 148 | * @var int |
e501603b TO |
149 | */ |
150 | public $contribution_recur_id; | |
c3fc2621 | 151 | |
e501603b TO |
152 | /** |
153 | * The campaign for which this membership is attached. | |
154 | * | |
e6ca0a57 | 155 | * @var int |
e501603b TO |
156 | */ |
157 | public $campaign_id; | |
c3fc2621 | 158 | |
e501603b | 159 | /** |
f41f0342 | 160 | * Class constructor. |
e501603b | 161 | */ |
c3fc2621 | 162 | public function __construct() { |
e501603b TO |
163 | $this->__table = 'civicrm_membership'; |
164 | parent::__construct(); | |
165 | } | |
c3fc2621 | 166 | |
449c4e6b CW |
167 | /** |
168 | * Returns localized title of this entity. | |
7b66c3b5 AH |
169 | * |
170 | * @param bool $plural | |
171 | * Whether to return the plural version of the title. | |
449c4e6b | 172 | */ |
7b66c3b5 AH |
173 | public static function getEntityTitle($plural = FALSE) { |
174 | return $plural ? ts('Memberships') : ts('Membership'); | |
449c4e6b CW |
175 | } |
176 | ||
e501603b | 177 | /** |
f41f0342 | 178 | * Returns foreign keys and entity references. |
e501603b TO |
179 | * |
180 | * @return array | |
181 | * [CRM_Core_Reference_Interface] | |
182 | */ | |
c3fc2621 | 183 | public static function getReferenceColumns() { |
346aaaba | 184 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
fa45b5b9 | 185 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 CW |
186 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id', 'civicrm_contact', 'id'); |
187 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'membership_type_id', 'civicrm_membership_type', 'id'); | |
188 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'status_id', 'civicrm_membership_status', 'id'); | |
189 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'owner_membership_id', 'civicrm_membership', 'id'); | |
190 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contribution_recur_id', 'civicrm_contribution_recur', 'id'); | |
191 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'campaign_id', 'civicrm_campaign', 'id'); | |
346aaaba | 192 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 193 | } |
346aaaba | 194 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 195 | } |
c3fc2621 | 196 | |
e501603b TO |
197 | /** |
198 | * Returns all the column names of this table | |
199 | * | |
200 | * @return array | |
201 | */ | |
c3fc2621 | 202 | public static function &fields() { |
346aaaba | 203 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
204 | Civi::$statics[__CLASS__]['fields'] = [ |
205 | 'membership_id' => [ | |
e501603b TO |
206 | 'name' => 'id', |
207 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 208 | 'title' => ts('Membership ID'), |
2cbbebe8 | 209 | 'description' => ts('Membership ID'), |
c3fc2621 CW |
210 | 'required' => TRUE, |
211 | 'import' => TRUE, | |
e501603b TO |
212 | 'where' => 'civicrm_membership.id', |
213 | 'headerPattern' => '/^(m(embership\s)?id)$/i', | |
c3fc2621 | 214 | 'export' => TRUE, |
522a26c9 | 215 | 'table_name' => 'civicrm_membership', |
216 | 'entity' => 'Membership', | |
217 | 'bao' => 'CRM_Member_BAO_Membership', | |
6a7e5e5d | 218 | 'localizable' => 0, |
2cbbebe8 A |
219 | 'html' => [ |
220 | 'type' => 'Number', | |
221 | ], | |
a9d0587b | 222 | 'add' => '1.5', |
c3fc2621 CW |
223 | ], |
224 | 'membership_contact_id' => [ | |
e501603b TO |
225 | 'name' => 'contact_id', |
226 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 227 | 'title' => ts('Contact ID'), |
215b423e | 228 | 'description' => ts('FK to Contact ID'), |
c3fc2621 CW |
229 | 'required' => TRUE, |
230 | 'import' => TRUE, | |
e501603b TO |
231 | 'where' => 'civicrm_membership.contact_id', |
232 | 'headerPattern' => '/contact(.?id)?/i', | |
233 | 'dataPattern' => '/^\d+$/', | |
c3fc2621 | 234 | 'export' => TRUE, |
522a26c9 | 235 | 'table_name' => 'civicrm_membership', |
236 | 'entity' => 'Membership', | |
237 | 'bao' => 'CRM_Member_BAO_Membership', | |
6a7e5e5d | 238 | 'localizable' => 0, |
e501603b | 239 | 'FKClassName' => 'CRM_Contact_DAO_Contact', |
c3fc2621 | 240 | 'html' => [ |
e501603b | 241 | 'type' => 'EntityRef', |
2cbbebe8 | 242 | 'label' => ts("Contact"), |
c3fc2621 | 243 | ], |
a9d0587b | 244 | 'add' => '1.5', |
c3fc2621 CW |
245 | ], |
246 | 'membership_type_id' => [ | |
e501603b TO |
247 | 'name' => 'membership_type_id', |
248 | 'type' => CRM_Utils_Type::T_INT, | |
2cbbebe8 | 249 | 'title' => ts('Membership Type ID'), |
215b423e | 250 | 'description' => ts('FK to Membership Type'), |
c3fc2621 CW |
251 | 'required' => TRUE, |
252 | 'import' => TRUE, | |
e501603b TO |
253 | 'where' => 'civicrm_membership.membership_type_id', |
254 | 'headerPattern' => '/^(m(embership\s)?type)$/i', | |
c3fc2621 | 255 | 'export' => FALSE, |
522a26c9 | 256 | 'table_name' => 'civicrm_membership', |
257 | 'entity' => 'Membership', | |
258 | 'bao' => 'CRM_Member_BAO_Membership', | |
6a7e5e5d | 259 | 'localizable' => 0, |
e501603b | 260 | 'FKClassName' => 'CRM_Member_DAO_MembershipType', |
c3fc2621 | 261 | 'html' => [ |
e501603b | 262 | 'type' => 'Select', |
03ee227b | 263 | 'label' => ts("Membership Type"), |
c3fc2621 CW |
264 | ], |
265 | 'pseudoconstant' => [ | |
e501603b TO |
266 | 'table' => 'civicrm_membership_type', |
267 | 'keyColumn' => 'id', | |
268 | 'labelColumn' => 'name', | |
e6ca0a57 | 269 | ], |
a9d0587b | 270 | 'add' => '1.5', |
c3fc2621 | 271 | ], |
09ba1975 | 272 | 'membership_join_date' => [ |
e501603b TO |
273 | 'name' => 'join_date', |
274 | 'type' => CRM_Utils_Type::T_DATE, | |
c3fc2621 | 275 | 'title' => ts('Member Since'), |
215b423e | 276 | 'description' => ts('Beginning of initial membership period (member since...).'), |
c3fc2621 | 277 | 'import' => TRUE, |
e501603b TO |
278 | 'where' => 'civicrm_membership.join_date', |
279 | 'headerPattern' => '/^join|(j(oin\s)?date)$/i', | |
280 | 'dataPattern' => '/\d{4}-?\d{2}-?\d{2}/', | |
c3fc2621 | 281 | 'export' => TRUE, |
522a26c9 | 282 | 'table_name' => 'civicrm_membership', |
283 | 'entity' => 'Membership', | |
284 | 'bao' => 'CRM_Member_BAO_Membership', | |
6a7e5e5d | 285 | 'localizable' => 0, |
c3fc2621 | 286 | 'html' => [ |
e501603b | 287 | 'type' => 'Select Date', |
24317d89 | 288 | 'formatType' => 'activityDate', |
c3fc2621 | 289 | ], |
a9d0587b | 290 | 'add' => '1.5', |
c3fc2621 CW |
291 | ], |
292 | 'membership_start_date' => [ | |
e501603b TO |
293 | 'name' => 'start_date', |
294 | 'type' => CRM_Utils_Type::T_DATE, | |
c3fc2621 | 295 | 'title' => ts('Membership Start Date'), |
215b423e | 296 | 'description' => ts('Beginning of current uninterrupted membership period.'), |
c3fc2621 | 297 | 'import' => TRUE, |
e501603b TO |
298 | 'where' => 'civicrm_membership.start_date', |
299 | 'headerPattern' => '/(member(ship)?.)?start(s)?(.date$)?/i', | |
300 | 'dataPattern' => '/\d{4}-?\d{2}-?\d{2}/', | |
c3fc2621 | 301 | 'export' => TRUE, |
522a26c9 | 302 | 'table_name' => 'civicrm_membership', |
303 | 'entity' => 'Membership', | |
304 | 'bao' => 'CRM_Member_BAO_Membership', | |
6a7e5e5d | 305 | 'localizable' => 0, |
c3fc2621 | 306 | 'html' => [ |
e501603b | 307 | 'type' => 'Select Date', |
24317d89 | 308 | 'formatType' => 'activityDate', |
c3fc2621 | 309 | ], |
a9d0587b | 310 | 'add' => '1.5', |
c3fc2621 CW |
311 | ], |
312 | 'membership_end_date' => [ | |
e501603b TO |
313 | 'name' => 'end_date', |
314 | 'type' => CRM_Utils_Type::T_DATE, | |
c3fc2621 | 315 | 'title' => ts('Membership Expiration Date'), |
215b423e | 316 | 'description' => ts('Current membership period expire date.'), |
c3fc2621 | 317 | 'import' => TRUE, |
e501603b TO |
318 | 'where' => 'civicrm_membership.end_date', |
319 | 'headerPattern' => '/(member(ship)?.)?end(s)?(.date$)?/i', | |
320 | 'dataPattern' => '/\d{4}-?\d{2}-?\d{2}/', | |
c3fc2621 | 321 | 'export' => TRUE, |
522a26c9 | 322 | 'table_name' => 'civicrm_membership', |
323 | 'entity' => 'Membership', | |
324 | 'bao' => 'CRM_Member_BAO_Membership', | |
6a7e5e5d | 325 | 'localizable' => 0, |
c3fc2621 | 326 | 'html' => [ |
e501603b | 327 | 'type' => 'Select Date', |
24317d89 | 328 | 'formatType' => 'activityDate', |
c3fc2621 | 329 | ], |
a9d0587b | 330 | 'add' => '1.5', |
c3fc2621 CW |
331 | ], |
332 | 'membership_source' => [ | |
e501603b TO |
333 | 'name' => 'source', |
334 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 335 | 'title' => ts('Source'), |
e501603b TO |
336 | 'maxlength' => 128, |
337 | 'size' => CRM_Utils_Type::HUGE, | |
c3fc2621 | 338 | 'import' => TRUE, |
e501603b TO |
339 | 'where' => 'civicrm_membership.source', |
340 | 'headerPattern' => '/^(member(ship?))?source$/i', | |
c3fc2621 | 341 | 'export' => TRUE, |
522a26c9 | 342 | 'table_name' => 'civicrm_membership', |
343 | 'entity' => 'Membership', | |
344 | 'bao' => 'CRM_Member_BAO_Membership', | |
6a7e5e5d | 345 | 'localizable' => 0, |
c3fc2621 | 346 | 'html' => [ |
e501603b | 347 | 'type' => 'Text', |
c3fc2621 | 348 | ], |
a9d0587b | 349 | 'add' => '1.5', |
c3fc2621 CW |
350 | ], |
351 | 'status_id' => [ | |
e501603b TO |
352 | 'name' => 'status_id', |
353 | 'type' => CRM_Utils_Type::T_INT, | |
2cbbebe8 | 354 | 'title' => ts('Status ID'), |
215b423e | 355 | 'description' => ts('FK to Membership Status'), |
c3fc2621 CW |
356 | 'required' => TRUE, |
357 | 'import' => TRUE, | |
e501603b TO |
358 | 'where' => 'civicrm_membership.status_id', |
359 | 'headerPattern' => '/(member(ship|).)?(status)$/i', | |
c3fc2621 | 360 | 'export' => FALSE, |
522a26c9 | 361 | 'table_name' => 'civicrm_membership', |
362 | 'entity' => 'Membership', | |
363 | 'bao' => 'CRM_Member_BAO_Membership', | |
6a7e5e5d | 364 | 'localizable' => 0, |
e501603b | 365 | 'FKClassName' => 'CRM_Member_DAO_MembershipStatus', |
c3fc2621 | 366 | 'html' => [ |
e501603b | 367 | 'type' => 'Select', |
2cbbebe8 | 368 | 'label' => ts("Status"), |
c3fc2621 CW |
369 | ], |
370 | 'pseudoconstant' => [ | |
e501603b TO |
371 | 'table' => 'civicrm_membership_status', |
372 | 'keyColumn' => 'id', | |
373 | 'labelColumn' => 'label', | |
e6ca0a57 | 374 | ], |
a9d0587b | 375 | 'add' => '1.5', |
c3fc2621 | 376 | ], |
8f67d99a | 377 | 'member_is_override' => [ |
e501603b TO |
378 | 'name' => 'is_override', |
379 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 380 | 'title' => ts('Status Override'), |
215b423e | 381 | 'description' => ts('Admin users may set a manual status which overrides the calculated status. When this flag is true, automated status update scripts should NOT modify status for the record.'), |
c3fc2621 | 382 | 'import' => TRUE, |
e501603b TO |
383 | 'where' => 'civicrm_membership.is_override', |
384 | 'headerPattern' => '/override$/i', | |
c3fc2621 | 385 | 'export' => TRUE, |
522a26c9 | 386 | 'table_name' => 'civicrm_membership', |
387 | 'entity' => 'Membership', | |
388 | 'bao' => 'CRM_Member_BAO_Membership', | |
6a7e5e5d | 389 | 'localizable' => 0, |
c3fc2621 | 390 | 'html' => [ |
e501603b | 391 | 'type' => 'CheckBox', |
c3fc2621 | 392 | ], |
a9d0587b | 393 | 'add' => '1.5', |
c3fc2621 | 394 | ], |
e136f704 O |
395 | 'status_override_end_date' => [ |
396 | 'name' => 'status_override_end_date', | |
397 | 'type' => CRM_Utils_Type::T_DATE, | |
398 | 'title' => ts('Status Override End Date'), | |
215b423e | 399 | 'description' => ts('Then end date of membership status override if \'Override until selected date\' override type is selected.'), |
e136f704 O |
400 | 'import' => TRUE, |
401 | 'where' => 'civicrm_membership.status_override_end_date', | |
e136f704 O |
402 | 'export' => TRUE, |
403 | 'default' => 'NULL', | |
404 | 'table_name' => 'civicrm_membership', | |
405 | 'entity' => 'Membership', | |
406 | 'bao' => 'CRM_Member_BAO_Membership', | |
407 | 'localizable' => 0, | |
408 | 'html' => [ | |
409 | 'type' => 'Select Date', | |
efcda6b9 | 410 | 'formatType' => 'activityDate', |
e136f704 | 411 | ], |
a9d0587b | 412 | 'add' => '4.7', |
e136f704 | 413 | ], |
c3fc2621 | 414 | 'owner_membership_id' => [ |
e501603b TO |
415 | 'name' => 'owner_membership_id', |
416 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 417 | 'title' => ts('Primary Member ID'), |
215b423e | 418 | 'description' => ts('Optional FK to Parent Membership.'), |
e501603b | 419 | 'where' => 'civicrm_membership.owner_membership_id', |
a36434b9 | 420 | 'export' => TRUE, |
522a26c9 | 421 | 'table_name' => 'civicrm_membership', |
422 | 'entity' => 'Membership', | |
423 | 'bao' => 'CRM_Member_BAO_Membership', | |
6a7e5e5d | 424 | 'localizable' => 0, |
e501603b | 425 | 'FKClassName' => 'CRM_Member_DAO_Membership', |
2cbbebe8 A |
426 | 'html' => [ |
427 | 'label' => ts("Primary Member"), | |
428 | ], | |
a9d0587b | 429 | 'add' => '1.7', |
c3fc2621 CW |
430 | ], |
431 | 'max_related' => [ | |
e501603b TO |
432 | 'name' => 'max_related', |
433 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 434 | 'title' => ts('Max Related'), |
215b423e | 435 | 'description' => ts('Maximum number of related memberships (membership_type override).'), |
a36434b9 | 436 | 'where' => 'civicrm_membership.max_related', |
8f67d99a | 437 | 'export' => TRUE, |
522a26c9 | 438 | 'table_name' => 'civicrm_membership', |
439 | 'entity' => 'Membership', | |
440 | 'bao' => 'CRM_Member_BAO_Membership', | |
6a7e5e5d | 441 | 'localizable' => 0, |
c3fc2621 | 442 | 'html' => [ |
e501603b | 443 | 'type' => 'Text', |
c23563e3 | 444 | 'label' => ts("Maximum number of related memberships"), |
c3fc2621 | 445 | ], |
a9d0587b | 446 | 'add' => '4.3', |
c3fc2621 CW |
447 | ], |
448 | 'member_is_test' => [ | |
e501603b TO |
449 | 'name' => 'is_test', |
450 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 CW |
451 | 'title' => ts('Test'), |
452 | 'import' => TRUE, | |
e501603b TO |
453 | 'where' => 'civicrm_membership.is_test', |
454 | 'headerPattern' => '/(is.)?test(.member(ship)?)?/i', | |
c3fc2621 | 455 | 'export' => TRUE, |
45a83e42 | 456 | 'default' => '0', |
522a26c9 | 457 | 'table_name' => 'civicrm_membership', |
458 | 'entity' => 'Membership', | |
459 | 'bao' => 'CRM_Member_BAO_Membership', | |
6a7e5e5d | 460 | 'localizable' => 0, |
c3fc2621 | 461 | 'html' => [ |
e501603b | 462 | 'type' => 'CheckBox', |
c3fc2621 | 463 | ], |
a9d0587b | 464 | 'add' => NULL, |
c3fc2621 CW |
465 | ], |
466 | 'member_is_pay_later' => [ | |
e501603b TO |
467 | 'name' => 'is_pay_later', |
468 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 CW |
469 | 'title' => ts('Is Pay Later'), |
470 | 'import' => TRUE, | |
e501603b TO |
471 | 'where' => 'civicrm_membership.is_pay_later', |
472 | 'headerPattern' => '/(is.)?(pay(.)?later)$/i', | |
c3fc2621 | 473 | 'export' => TRUE, |
45a83e42 | 474 | 'default' => '0', |
522a26c9 | 475 | 'table_name' => 'civicrm_membership', |
476 | 'entity' => 'Membership', | |
477 | 'bao' => 'CRM_Member_BAO_Membership', | |
6a7e5e5d | 478 | 'localizable' => 0, |
c3fc2621 | 479 | 'html' => [ |
e501603b | 480 | 'type' => 'CheckBox', |
c3fc2621 | 481 | ], |
a9d0587b | 482 | 'add' => '2.1', |
c3fc2621 | 483 | ], |
8f67d99a | 484 | 'membership_recur_id' => [ |
e501603b TO |
485 | 'name' => 'contribution_recur_id', |
486 | 'type' => CRM_Utils_Type::T_INT, | |
2cbbebe8 | 487 | 'title' => ts('Recurring Contribution ID'), |
215b423e | 488 | 'description' => ts('Conditional foreign key to civicrm_contribution_recur id. Each membership in connection with a recurring contribution carries a foreign key to the recurring contribution record. This assumes we can track these processor initiated events.'), |
a36434b9 | 489 | 'where' => 'civicrm_membership.contribution_recur_id', |
8f67d99a | 490 | 'export' => TRUE, |
522a26c9 | 491 | 'table_name' => 'civicrm_membership', |
492 | 'entity' => 'Membership', | |
493 | 'bao' => 'CRM_Member_BAO_Membership', | |
6a7e5e5d | 494 | 'localizable' => 0, |
e501603b | 495 | 'FKClassName' => 'CRM_Contribute_DAO_ContributionRecur', |
2cbbebe8 A |
496 | 'html' => [ |
497 | 'label' => ts("Recurring Contribution"), | |
498 | ], | |
a9d0587b | 499 | 'add' => '3.3', |
c3fc2621 CW |
500 | ], |
501 | 'member_campaign_id' => [ | |
e501603b TO |
502 | 'name' => 'campaign_id', |
503 | 'type' => CRM_Utils_Type::T_INT, | |
2cbbebe8 | 504 | 'title' => ts('Campaign ID'), |
215b423e | 505 | 'description' => ts('The campaign for which this membership is attached.'), |
c3fc2621 | 506 | 'import' => TRUE, |
e501603b | 507 | 'where' => 'civicrm_membership.campaign_id', |
c3fc2621 | 508 | 'export' => TRUE, |
522a26c9 | 509 | 'table_name' => 'civicrm_membership', |
510 | 'entity' => 'Membership', | |
511 | 'bao' => 'CRM_Member_BAO_Membership', | |
6a7e5e5d | 512 | 'localizable' => 0, |
e501603b | 513 | 'FKClassName' => 'CRM_Campaign_DAO_Campaign', |
c3fc2621 | 514 | 'html' => [ |
e501603b | 515 | 'type' => 'Select', |
2cbbebe8 | 516 | 'label' => ts("Campaign"), |
c3fc2621 | 517 | ], |
a9d0587b | 518 | 'add' => '3.4', |
c3fc2621 CW |
519 | ], |
520 | ]; | |
346aaaba | 521 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 522 | } |
346aaaba | 523 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 524 | } |
c3fc2621 | 525 | |
e501603b | 526 | /** |
bd8e0b14 | 527 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
528 | * |
529 | * @return array | |
bd8e0b14 | 530 | * Array(string $name => string $uniqueName). |
e501603b | 531 | */ |
c3fc2621 | 532 | public static function &fieldKeys() { |
bd8e0b14 TO |
533 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
534 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 535 | } |
bd8e0b14 | 536 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 537 | } |
c3fc2621 | 538 | |
e501603b TO |
539 | /** |
540 | * Returns the names of this table | |
541 | * | |
542 | * @return string | |
543 | */ | |
c3fc2621 | 544 | public static function getTableName() { |
e501603b TO |
545 | return self::$_tableName; |
546 | } | |
c3fc2621 | 547 | |
e501603b TO |
548 | /** |
549 | * Returns if this table needs to be logged | |
550 | * | |
c3fc2621 | 551 | * @return bool |
e501603b | 552 | */ |
c3fc2621 | 553 | public function getLog() { |
e501603b TO |
554 | return self::$_log; |
555 | } | |
c3fc2621 | 556 | |
e501603b TO |
557 | /** |
558 | * Returns the list of fields that can be imported | |
559 | * | |
560 | * @param bool $prefix | |
561 | * | |
562 | * @return array | |
563 | */ | |
c3fc2621 CW |
564 | public static function &import($prefix = FALSE) { |
565 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'membership', $prefix, []); | |
60808919 | 566 | return $r; |
e501603b | 567 | } |
c3fc2621 | 568 | |
e501603b TO |
569 | /** |
570 | * Returns the list of fields that can be exported | |
571 | * | |
572 | * @param bool $prefix | |
573 | * | |
574 | * @return array | |
575 | */ | |
c3fc2621 CW |
576 | public static function &export($prefix = FALSE) { |
577 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'membership', $prefix, []); | |
60808919 | 578 | return $r; |
e501603b | 579 | } |
c3fc2621 | 580 | |
e7a6b91a AS |
581 | /** |
582 | * Returns the list of indices | |
c3fc2621 CW |
583 | * |
584 | * @param bool $localize | |
585 | * | |
586 | * @return array | |
e7a6b91a AS |
587 | */ |
588 | public static function indices($localize = TRUE) { | |
c3fc2621 CW |
589 | $indices = [ |
590 | 'index_owner_membership_id' => [ | |
e7a6b91a | 591 | 'name' => 'index_owner_membership_id', |
c3fc2621 | 592 | 'field' => [ |
e7a6b91a | 593 | 0 => 'owner_membership_id', |
c3fc2621 CW |
594 | ], |
595 | 'localizable' => FALSE, | |
e7a6b91a | 596 | 'sig' => 'civicrm_membership::0::owner_membership_id', |
c3fc2621 CW |
597 | ], |
598 | ]; | |
e7a6b91a AS |
599 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
600 | } | |
c3fc2621 | 601 | |
e501603b | 602 | } |