5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/Member/Membership.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:835c63ea0a55b78d6d115a7a6db5dde2)
13 * Database access object for the Membership entity.
15 class CRM_Member_DAO_Membership
extends CRM_Core_DAO
{
16 const EXT
= 'civicrm';
17 const TABLE_ADDED
= '1.5';
20 * Static instance to hold the table name.
24 public static $_tableName = 'civicrm_membership';
27 * Icon associated with this entity.
31 public static $_icon = 'fa-id-badge';
34 * Should CiviCRM log any modifications to this table in the civicrm_log table.
38 public static $_log = TRUE;
55 * FK to Membership Type
59 public $membership_type_id;
62 * Beginning of initial membership period (member since...).
69 * Beginning of current uninterrupted membership period.
76 * Current membership period expire date.
88 * FK to Membership Status
95 * 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.
102 * Then end date of membership status override if 'Override until selected date' override type is selected.
106 public $status_override_end_date;
109 * Optional FK to Parent Membership.
113 public $owner_membership_id;
116 * Maximum number of related memberships (membership_type override).
130 public $is_pay_later;
133 * 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.
137 public $contribution_recur_id;
140 * The campaign for which this membership is attached.
149 public function __construct() {
150 $this->__table
= 'civicrm_membership';
151 parent
::__construct();
155 * Returns localized title of this entity.
157 public static function getEntityTitle() {
158 return ts('Memberships');
162 * Returns foreign keys and entity references.
165 * [CRM_Core_Reference_Interface]
167 public static function getReferenceColumns() {
168 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
169 Civi
::$statics[__CLASS__
]['links'] = static::createReferenceColumns(__CLASS__
);
170 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'contact_id', 'civicrm_contact', 'id');
171 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'membership_type_id', 'civicrm_membership_type', 'id');
172 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'status_id', 'civicrm_membership_status', 'id');
173 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'owner_membership_id', 'civicrm_membership', 'id');
174 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'contribution_recur_id', 'civicrm_contribution_recur', 'id');
175 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'campaign_id', 'civicrm_campaign', 'id');
176 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
178 return Civi
::$statics[__CLASS__
]['links'];
182 * Returns all the column names of this table
186 public static function &fields() {
187 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
188 Civi
::$statics[__CLASS__
]['fields'] = [
191 'type' => CRM_Utils_Type
::T_INT
,
192 'title' => ts('Membership ID'),
193 'description' => ts('Membership Id'),
196 'where' => 'civicrm_membership.id',
197 'headerPattern' => '/^(m(embership\s)?id)$/i',
199 'table_name' => 'civicrm_membership',
200 'entity' => 'Membership',
201 'bao' => 'CRM_Member_BAO_Membership',
205 'membership_contact_id' => [
206 'name' => 'contact_id',
207 'type' => CRM_Utils_Type
::T_INT
,
208 'title' => ts('Contact ID'),
209 'description' => ts('FK to Contact ID'),
212 'where' => 'civicrm_membership.contact_id',
213 'headerPattern' => '/contact(.?id)?/i',
214 'dataPattern' => '/^\d+$/',
216 'table_name' => 'civicrm_membership',
217 'entity' => 'Membership',
218 'bao' => 'CRM_Member_BAO_Membership',
220 'FKClassName' => 'CRM_Contact_DAO_Contact',
222 'type' => 'EntityRef',
226 'membership_type_id' => [
227 'name' => 'membership_type_id',
228 'type' => CRM_Utils_Type
::T_INT
,
229 'title' => ts('Membership Type Id'),
230 'description' => ts('FK to Membership Type'),
233 'where' => 'civicrm_membership.membership_type_id',
234 'headerPattern' => '/^(m(embership\s)?type)$/i',
236 'table_name' => 'civicrm_membership',
237 'entity' => 'Membership',
238 'bao' => 'CRM_Member_BAO_Membership',
240 'FKClassName' => 'CRM_Member_DAO_MembershipType',
243 'label' => ts("Membership Type"),
245 'pseudoconstant' => [
246 'table' => 'civicrm_membership_type',
248 'labelColumn' => 'name',
252 'membership_join_date' => [
253 'name' => 'join_date',
254 'type' => CRM_Utils_Type
::T_DATE
,
255 'title' => ts('Member Since'),
256 'description' => ts('Beginning of initial membership period (member since...).'),
258 'where' => 'civicrm_membership.join_date',
259 'headerPattern' => '/^join|(j(oin\s)?date)$/i',
260 'dataPattern' => '/\d{4}-?\d{2}-?\d{2}/',
262 'table_name' => 'civicrm_membership',
263 'entity' => 'Membership',
264 'bao' => 'CRM_Member_BAO_Membership',
267 'type' => 'Select Date',
268 'formatType' => 'activityDate',
272 'membership_start_date' => [
273 'name' => 'start_date',
274 'type' => CRM_Utils_Type
::T_DATE
,
275 'title' => ts('Membership Start Date'),
276 'description' => ts('Beginning of current uninterrupted membership period.'),
278 'where' => 'civicrm_membership.start_date',
279 'headerPattern' => '/(member(ship)?.)?start(s)?(.date$)?/i',
280 'dataPattern' => '/\d{4}-?\d{2}-?\d{2}/',
282 'table_name' => 'civicrm_membership',
283 'entity' => 'Membership',
284 'bao' => 'CRM_Member_BAO_Membership',
287 'type' => 'Select Date',
288 'formatType' => 'activityDate',
292 'membership_end_date' => [
293 'name' => 'end_date',
294 'type' => CRM_Utils_Type
::T_DATE
,
295 'title' => ts('Membership Expiration Date'),
296 'description' => ts('Current membership period expire date.'),
298 'where' => 'civicrm_membership.end_date',
299 'headerPattern' => '/(member(ship)?.)?end(s)?(.date$)?/i',
300 'dataPattern' => '/\d{4}-?\d{2}-?\d{2}/',
302 'table_name' => 'civicrm_membership',
303 'entity' => 'Membership',
304 'bao' => 'CRM_Member_BAO_Membership',
307 'type' => 'Select Date',
308 'formatType' => 'activityDate',
312 'membership_source' => [
314 'type' => CRM_Utils_Type
::T_STRING
,
315 'title' => ts('Source'),
317 'size' => CRM_Utils_Type
::HUGE
,
319 'where' => 'civicrm_membership.source',
320 'headerPattern' => '/^(member(ship?))?source$/i',
322 'table_name' => 'civicrm_membership',
323 'entity' => 'Membership',
324 'bao' => 'CRM_Member_BAO_Membership',
332 'name' => 'status_id',
333 'type' => CRM_Utils_Type
::T_INT
,
334 'title' => ts('Membership Status Id'),
335 'description' => ts('FK to Membership Status'),
338 'where' => 'civicrm_membership.status_id',
339 'headerPattern' => '/(member(ship|).)?(status)$/i',
341 'table_name' => 'civicrm_membership',
342 'entity' => 'Membership',
343 'bao' => 'CRM_Member_BAO_Membership',
345 'FKClassName' => 'CRM_Member_DAO_MembershipStatus',
349 'pseudoconstant' => [
350 'table' => 'civicrm_membership_status',
352 'labelColumn' => 'label',
356 'member_is_override' => [
357 'name' => 'is_override',
358 'type' => CRM_Utils_Type
::T_BOOLEAN
,
359 'title' => ts('Status Override'),
360 '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.'),
362 'where' => 'civicrm_membership.is_override',
363 'headerPattern' => '/override$/i',
365 'table_name' => 'civicrm_membership',
366 'entity' => 'Membership',
367 'bao' => 'CRM_Member_BAO_Membership',
370 'type' => 'CheckBox',
374 'status_override_end_date' => [
375 'name' => 'status_override_end_date',
376 'type' => CRM_Utils_Type
::T_DATE
,
377 'title' => ts('Status Override End Date'),
378 'description' => ts('Then end date of membership status override if \'Override until selected date\' override type is selected.'),
380 'where' => 'civicrm_membership.status_override_end_date',
383 'table_name' => 'civicrm_membership',
384 'entity' => 'Membership',
385 'bao' => 'CRM_Member_BAO_Membership',
388 'type' => 'Select Date',
389 'formatType' => 'activityDate',
393 'owner_membership_id' => [
394 'name' => 'owner_membership_id',
395 'type' => CRM_Utils_Type
::T_INT
,
396 'title' => ts('Primary Member ID'),
397 'description' => ts('Optional FK to Parent Membership.'),
398 'where' => 'civicrm_membership.owner_membership_id',
400 'table_name' => 'civicrm_membership',
401 'entity' => 'Membership',
402 'bao' => 'CRM_Member_BAO_Membership',
404 'FKClassName' => 'CRM_Member_DAO_Membership',
408 'name' => 'max_related',
409 'type' => CRM_Utils_Type
::T_INT
,
410 'title' => ts('Max Related'),
411 'description' => ts('Maximum number of related memberships (membership_type override).'),
412 'where' => 'civicrm_membership.max_related',
414 'table_name' => 'civicrm_membership',
415 'entity' => 'Membership',
416 'bao' => 'CRM_Member_BAO_Membership',
423 'member_is_test' => [
425 'type' => CRM_Utils_Type
::T_BOOLEAN
,
426 'title' => ts('Test'),
428 'where' => 'civicrm_membership.is_test',
429 'headerPattern' => '/(is.)?test(.member(ship)?)?/i',
432 'table_name' => 'civicrm_membership',
433 'entity' => 'Membership',
434 'bao' => 'CRM_Member_BAO_Membership',
437 'type' => 'CheckBox',
441 'member_is_pay_later' => [
442 'name' => 'is_pay_later',
443 'type' => CRM_Utils_Type
::T_BOOLEAN
,
444 'title' => ts('Is Pay Later'),
446 'where' => 'civicrm_membership.is_pay_later',
447 'headerPattern' => '/(is.)?(pay(.)?later)$/i',
450 'table_name' => 'civicrm_membership',
451 'entity' => 'Membership',
452 'bao' => 'CRM_Member_BAO_Membership',
455 'type' => 'CheckBox',
459 'membership_recur_id' => [
460 'name' => 'contribution_recur_id',
461 'type' => CRM_Utils_Type
::T_INT
,
462 'title' => ts('Membership Recurring Contribution'),
463 '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.'),
464 'where' => 'civicrm_membership.contribution_recur_id',
466 'table_name' => 'civicrm_membership',
467 'entity' => 'Membership',
468 'bao' => 'CRM_Member_BAO_Membership',
470 'FKClassName' => 'CRM_Contribute_DAO_ContributionRecur',
473 'member_campaign_id' => [
474 'name' => 'campaign_id',
475 'type' => CRM_Utils_Type
::T_INT
,
476 'title' => ts('Campaign'),
477 'description' => ts('The campaign for which this membership is attached.'),
479 'where' => 'civicrm_membership.campaign_id',
481 'table_name' => 'civicrm_membership',
482 'entity' => 'Membership',
483 'bao' => 'CRM_Member_BAO_Membership',
485 'FKClassName' => 'CRM_Campaign_DAO_Campaign',
489 'pseudoconstant' => [
490 'table' => 'civicrm_campaign',
492 'labelColumn' => 'title',
497 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
499 return Civi
::$statics[__CLASS__
]['fields'];
503 * Return a mapping from field-name to the corresponding key (as used in fields()).
506 * Array(string $name => string $uniqueName).
508 public static function &fieldKeys() {
509 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
510 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
512 return Civi
::$statics[__CLASS__
]['fieldKeys'];
516 * Returns the names of this table
520 public static function getTableName() {
521 return self
::$_tableName;
525 * Returns if this table needs to be logged
529 public function getLog() {
534 * Returns the list of fields that can be imported
536 * @param bool $prefix
540 public static function &import($prefix = FALSE) {
541 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'membership', $prefix, []);
546 * Returns the list of fields that can be exported
548 * @param bool $prefix
552 public static function &export($prefix = FALSE) {
553 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'membership', $prefix, []);
558 * Returns the list of indices
560 * @param bool $localize
564 public static function indices($localize = TRUE) {
566 'index_owner_membership_id' => [
567 'name' => 'index_owner_membership_id',
569 0 => 'owner_membership_id',
571 'localizable' => FALSE,
572 'sig' => 'civicrm_membership::0::owner_membership_id',
575 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;