5 * @copyright CiviCRM LLC (c) 2004-2018
7 * Generated from xml/schema/CRM/Member/Membership.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:643f191c50bbd0244e93745a929ba499)
13 * Database access object for the Membership entity.
15 class CRM_Member_DAO_Membership
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 static $_tableName = 'civicrm_membership';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
46 * FK to Membership Type
50 public $membership_type_id;
53 * Beginning of initial membership period (member since...).
60 * Beginning of current uninterrupted membership period.
67 * Current membership period expire date.
79 * FK to Membership Status
86 * 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.
93 * Then end date of membership status override if 'Override until selected date' override type is selected.
97 public $status_override_end_date;
100 * Optional FK to Parent Membership.
104 public $owner_membership_id;
107 * Maximum number of related memberships (membership_type override).
121 public $is_pay_later;
124 * 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.
128 public $contribution_recur_id;
131 * The campaign for which this membership is attached.
140 public function __construct() {
141 $this->__table
= 'civicrm_membership';
142 parent
::__construct();
146 * Returns foreign keys and entity references.
149 * [CRM_Core_Reference_Interface]
151 public static function getReferenceColumns() {
152 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
153 Civi
::$statics[__CLASS__
]['links'] = static ::createReferenceColumns(__CLASS__
);
154 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'contact_id', 'civicrm_contact', 'id');
155 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'membership_type_id', 'civicrm_membership_type', 'id');
156 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'status_id', 'civicrm_membership_status', 'id');
157 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'owner_membership_id', 'civicrm_membership', 'id');
158 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'contribution_recur_id', 'civicrm_contribution_recur', 'id');
159 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'campaign_id', 'civicrm_campaign', 'id');
160 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
162 return Civi
::$statics[__CLASS__
]['links'];
166 * Returns all the column names of this table
170 public static function &fields() {
171 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
172 Civi
::$statics[__CLASS__
]['fields'] = [
175 'type' => CRM_Utils_Type
::T_INT
,
176 'title' => ts('Membership ID'),
177 'description' => 'Membership Id',
180 'where' => 'civicrm_membership.id',
181 'headerPattern' => '/^(m(embership\s)?id)$/i',
184 'table_name' => 'civicrm_membership',
185 'entity' => 'Membership',
186 'bao' => 'CRM_Member_BAO_Membership',
189 'membership_contact_id' => [
190 'name' => 'contact_id',
191 'type' => CRM_Utils_Type
::T_INT
,
192 'title' => ts('Contact ID'),
193 'description' => 'FK to Contact ID',
196 'where' => 'civicrm_membership.contact_id',
197 'headerPattern' => '/contact(.?id)?/i',
198 'dataPattern' => '/^\d+$/',
200 'table_name' => 'civicrm_membership',
201 'entity' => 'Membership',
202 'bao' => 'CRM_Member_BAO_Membership',
204 'FKClassName' => 'CRM_Contact_DAO_Contact',
206 'type' => 'EntityRef',
209 'membership_type_id' => [
210 'name' => 'membership_type_id',
211 'type' => CRM_Utils_Type
::T_INT
,
212 'title' => ts('Membership Type Id'),
213 'description' => 'FK to Membership Type',
216 'where' => 'civicrm_membership.membership_type_id',
217 'headerPattern' => '/^(m(embership\s)?type)$/i',
220 'table_name' => 'civicrm_membership',
221 'entity' => 'Membership',
222 'bao' => 'CRM_Member_BAO_Membership',
224 'FKClassName' => 'CRM_Member_DAO_MembershipType',
228 'pseudoconstant' => [
229 'table' => 'civicrm_membership_type',
231 'labelColumn' => 'name',
235 'name' => 'join_date',
236 'type' => CRM_Utils_Type
::T_DATE
,
237 'title' => ts('Member Since'),
238 'description' => 'Beginning of initial membership period (member since...).',
240 'where' => 'civicrm_membership.join_date',
241 'headerPattern' => '/^join|(j(oin\s)?date)$/i',
242 'dataPattern' => '/\d{4}-?\d{2}-?\d{2}/',
244 'table_name' => 'civicrm_membership',
245 'entity' => 'Membership',
246 'bao' => 'CRM_Member_BAO_Membership',
249 'type' => 'Select Date',
250 'formatType' => 'activityDate',
253 'membership_start_date' => [
254 'name' => 'start_date',
255 'type' => CRM_Utils_Type
::T_DATE
,
256 'title' => ts('Membership Start Date'),
257 'description' => 'Beginning of current uninterrupted membership period.',
259 'where' => 'civicrm_membership.start_date',
260 'headerPattern' => '/(member(ship)?.)?start(s)?(.date$)?/i',
261 'dataPattern' => '/\d{4}-?\d{2}-?\d{2}/',
263 'table_name' => 'civicrm_membership',
264 'entity' => 'Membership',
265 'bao' => 'CRM_Member_BAO_Membership',
268 'type' => 'Select Date',
269 'formatType' => 'activityDate',
272 'membership_end_date' => [
273 'name' => 'end_date',
274 'type' => CRM_Utils_Type
::T_DATE
,
275 'title' => ts('Membership Expiration Date'),
276 'description' => 'Current membership period expire date.',
278 'where' => 'civicrm_membership.end_date',
279 'headerPattern' => '/(member(ship)?.)?end(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',
291 'membership_source' => [
293 'type' => CRM_Utils_Type
::T_STRING
,
294 'title' => ts('Source'),
296 'size' => CRM_Utils_Type
::HUGE
,
298 'where' => 'civicrm_membership.source',
299 'headerPattern' => '/^(member(ship?))?source$/i',
302 'table_name' => 'civicrm_membership',
303 'entity' => 'Membership',
304 'bao' => 'CRM_Member_BAO_Membership',
311 'name' => 'status_id',
312 'type' => CRM_Utils_Type
::T_INT
,
313 'title' => ts('Membership Status Id'),
314 'description' => 'FK to Membership Status',
317 'where' => 'civicrm_membership.status_id',
318 'headerPattern' => '/(member(ship|).)?(status)$/i',
321 'table_name' => 'civicrm_membership',
322 'entity' => 'Membership',
323 'bao' => 'CRM_Member_BAO_Membership',
325 'FKClassName' => 'CRM_Member_DAO_MembershipStatus',
329 'pseudoconstant' => [
330 'table' => 'civicrm_membership_status',
332 'labelColumn' => 'label',
336 'name' => 'is_override',
337 'type' => CRM_Utils_Type
::T_BOOLEAN
,
338 'title' => ts('Status Override'),
339 'description' => '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.',
341 'where' => 'civicrm_membership.is_override',
342 'headerPattern' => '/override$/i',
345 'table_name' => 'civicrm_membership',
346 'entity' => 'Membership',
347 'bao' => 'CRM_Member_BAO_Membership',
350 'type' => 'CheckBox',
353 'status_override_end_date' => [
354 'name' => 'status_override_end_date',
355 'type' => CRM_Utils_Type
::T_DATE
,
356 'title' => ts('Status Override End Date'),
357 'description' => 'Then end date of membership status override if \'Override until selected date\' override type is selected.',
359 'where' => 'civicrm_membership.status_override_end_date',
360 'headerPattern' => '',
364 'table_name' => 'civicrm_membership',
365 'entity' => 'Membership',
366 'bao' => 'CRM_Member_BAO_Membership',
369 'type' => 'Select Date',
372 'owner_membership_id' => [
373 'name' => 'owner_membership_id',
374 'type' => CRM_Utils_Type
::T_INT
,
375 'title' => ts('Primary Member ID'),
376 'description' => 'Optional FK to Parent Membership.',
378 'where' => 'civicrm_membership.owner_membership_id',
379 'headerPattern' => '',
381 'table_name' => 'civicrm_membership',
382 'entity' => 'Membership',
383 'bao' => 'CRM_Member_BAO_Membership',
385 'FKClassName' => 'CRM_Member_DAO_Membership',
388 'name' => 'max_related',
389 'type' => CRM_Utils_Type
::T_INT
,
390 'title' => ts('Max Related'),
391 'description' => 'Maximum number of related memberships (membership_type override).',
392 'table_name' => 'civicrm_membership',
393 'entity' => 'Membership',
394 'bao' => 'CRM_Member_BAO_Membership',
400 'member_is_test' => [
402 'type' => CRM_Utils_Type
::T_BOOLEAN
,
403 'title' => ts('Test'),
405 'where' => 'civicrm_membership.is_test',
406 'headerPattern' => '/(is.)?test(.member(ship)?)?/i',
409 'table_name' => 'civicrm_membership',
410 'entity' => 'Membership',
411 'bao' => 'CRM_Member_BAO_Membership',
414 'type' => 'CheckBox',
417 'member_is_pay_later' => [
418 'name' => 'is_pay_later',
419 'type' => CRM_Utils_Type
::T_BOOLEAN
,
420 'title' => ts('Is Pay Later'),
422 'where' => 'civicrm_membership.is_pay_later',
423 'headerPattern' => '/(is.)?(pay(.)?later)$/i',
426 'table_name' => 'civicrm_membership',
427 'entity' => 'Membership',
428 'bao' => 'CRM_Member_BAO_Membership',
431 'type' => 'CheckBox',
434 'contribution_recur_id' => [
435 'name' => 'contribution_recur_id',
436 'type' => CRM_Utils_Type
::T_INT
,
437 'title' => ts('Membership Recurring Contribution'),
438 'description' => '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.',
439 'table_name' => 'civicrm_membership',
440 'entity' => 'Membership',
441 'bao' => 'CRM_Member_BAO_Membership',
443 'FKClassName' => 'CRM_Contribute_DAO_ContributionRecur',
445 'member_campaign_id' => [
446 'name' => 'campaign_id',
447 'type' => CRM_Utils_Type
::T_INT
,
448 'title' => ts('Campaign'),
449 'description' => 'The campaign for which this membership is attached.',
451 'where' => 'civicrm_membership.campaign_id',
452 'headerPattern' => '',
455 'table_name' => 'civicrm_membership',
456 'entity' => 'Membership',
457 'bao' => 'CRM_Member_BAO_Membership',
459 'FKClassName' => 'CRM_Campaign_DAO_Campaign',
463 'pseudoconstant' => [
464 'table' => 'civicrm_campaign',
466 'labelColumn' => 'title',
470 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
472 return Civi
::$statics[__CLASS__
]['fields'];
476 * Return a mapping from field-name to the corresponding key (as used in fields()).
479 * Array(string $name => string $uniqueName).
481 public static function &fieldKeys() {
482 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
483 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
485 return Civi
::$statics[__CLASS__
]['fieldKeys'];
489 * Returns the names of this table
493 public static function getTableName() {
494 return self
::$_tableName;
498 * Returns if this table needs to be logged
502 public function getLog() {
507 * Returns the list of fields that can be imported
509 * @param bool $prefix
513 public static function &import($prefix = FALSE) {
514 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'membership', $prefix, []);
519 * Returns the list of fields that can be exported
521 * @param bool $prefix
525 public static function &export($prefix = FALSE) {
526 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'membership', $prefix, []);
531 * Returns the list of indices
533 * @param bool $localize
537 public static function indices($localize = TRUE) {
539 'index_owner_membership_id' => [
540 'name' => 'index_owner_membership_id',
542 0 => 'owner_membership_id',
544 'localizable' => FALSE,
545 'sig' => 'civicrm_membership::0::owner_membership_id',
548 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;