5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/Member/MembershipType.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:9cb69957096aad15ee7d55a4efceb53e)
13 * Database access object for the MembershipType entity.
15 class CRM_Member_DAO_MembershipType
extends CRM_Core_DAO
{
16 const EXT
= 'civicrm';
17 const TABLE_ADDED
= '1.5';
18 const COMPONENT
= 'CiviMember';
21 * Static instance to hold the table name.
25 public static $_tableName = 'civicrm_membership_type';
28 * Field to show when displaying a record.
32 public static $_labelField = 'name';
35 * Should CiviCRM log any modifications to this table in the civicrm_log table.
39 public static $_log = TRUE;
49 * Which Domain is this match entry for
56 * Name of Membership Type
63 * Description of Membership Type
70 * Owner organization for this membership type. FK to Contact ID
74 public $member_of_contact_id;
77 * If membership is paid by a contribution - what financial type should be used. FK to civicrm_financial_type.id
81 public $financial_type_id;
84 * Minimum fee for this membership (0 for free/complimentary memberships).
91 * Unit in which membership period is expressed.
95 public $duration_unit;
98 * Number of duration units in membership period (e.g. 1 year, 12 months).
102 public $duration_interval;
105 * Rolling membership period starts on signup date. Fixed membership periods start on fixed_period_start_day.
112 * For fixed period memberships, month and day (mmdd) on which subscription/membership will start. Period start is back-dated unless after rollover day.
116 public $fixed_period_start_day;
119 * For fixed period memberships, signups after this day (mmdd) rollover to next period.
123 public $fixed_period_rollover_day;
126 * FK to Relationship Type ID
130 public $relationship_type_id;
135 public $relationship_direction;
138 * Maximum number of related memberships.
155 * Receipt Text for membership signup
159 public $receipt_text_signup;
162 * Receipt Text for membership renewal
166 public $receipt_text_renewal;
169 * 0 = No auto-renew option; 1 = Give option, but not required; 2 = Auto-renew required;
176 * Is this membership_type enabled
185 public function __construct() {
186 $this->__table
= 'civicrm_membership_type';
187 parent
::__construct();
191 * Returns localized title of this entity.
193 * @param bool $plural
194 * Whether to return the plural version of the title.
196 public static function getEntityTitle($plural = FALSE) {
197 return $plural ?
ts('Membership Types') : ts('Membership Type');
201 * Returns foreign keys and entity references.
204 * [CRM_Core_Reference_Interface]
206 public static function getReferenceColumns() {
207 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
208 Civi
::$statics[__CLASS__
]['links'] = static::createReferenceColumns(__CLASS__
);
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');
212 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
214 return Civi
::$statics[__CLASS__
]['links'];
218 * Returns all the column names of this table
222 public static function &fields() {
223 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
224 Civi
::$statics[__CLASS__
]['fields'] = [
227 'type' => CRM_Utils_Type
::T_INT
,
228 'title' => ts('Membership Type ID'),
229 'description' => ts('Membership ID'),
231 'where' => 'civicrm_membership_type.id',
232 'table_name' => 'civicrm_membership_type',
233 'entity' => 'MembershipType',
234 'bao' => 'CRM_Member_BAO_MembershipType',
243 'name' => 'domain_id',
244 'type' => CRM_Utils_Type
::T_INT
,
245 'title' => ts('Domain ID'),
246 'description' => ts('Which Domain is this match entry for'),
248 'where' => 'civicrm_membership_type.domain_id',
249 'table_name' => 'civicrm_membership_type',
250 'entity' => 'MembershipType',
251 'bao' => 'CRM_Member_BAO_MembershipType',
253 'FKClassName' => 'CRM_Core_DAO_Domain',
255 'label' => ts("Domain"),
257 'pseudoconstant' => [
258 'table' => 'civicrm_domain',
260 'labelColumn' => 'name',
264 'membership_type' => [
266 'type' => CRM_Utils_Type
::T_STRING
,
267 'title' => ts('Membership Type'),
268 'description' => ts('Name of Membership Type'),
271 'size' => CRM_Utils_Type
::HUGE
,
273 'where' => 'civicrm_membership_type.name',
275 'table_name' => 'civicrm_membership_type',
276 'entity' => 'MembershipType',
277 'bao' => 'CRM_Member_BAO_MembershipType',
281 'label' => ts("Name"),
286 'name' => 'description',
287 'type' => CRM_Utils_Type
::T_STRING
,
288 'title' => ts('Description'),
289 'description' => ts('Description of Membership Type'),
291 'size' => CRM_Utils_Type
::HUGE
,
292 'where' => 'civicrm_membership_type.description',
293 'table_name' => 'civicrm_membership_type',
294 'entity' => 'MembershipType',
295 'bao' => 'CRM_Member_BAO_MembershipType',
298 'type' => 'TextArea',
299 'label' => ts("Description"),
303 'member_of_contact_id' => [
304 'name' => 'member_of_contact_id',
305 'type' => CRM_Utils_Type
::T_INT
,
306 'title' => ts('Organization ID'),
307 'description' => ts('Owner organization for this membership type. FK to Contact ID'),
309 'where' => 'civicrm_membership_type.member_of_contact_id',
310 'table_name' => 'civicrm_membership_type',
311 'entity' => 'MembershipType',
312 'bao' => 'CRM_Member_BAO_MembershipType',
314 'FKClassName' => 'CRM_Contact_DAO_Contact',
316 'label' => ts("Organization"),
320 'financial_type_id' => [
321 'name' => 'financial_type_id',
322 'type' => CRM_Utils_Type
::T_INT
,
323 'title' => ts('Financial Type ID'),
324 'description' => ts('If membership is paid by a contribution - what financial type should be used. FK to civicrm_financial_type.id'),
326 'where' => 'civicrm_membership_type.financial_type_id',
327 'table_name' => 'civicrm_membership_type',
328 'entity' => 'MembershipType',
329 'bao' => 'CRM_Member_BAO_MembershipType',
331 'FKClassName' => 'CRM_Financial_DAO_FinancialType',
333 'label' => ts("Financial Type"),
335 'pseudoconstant' => [
336 'table' => 'civicrm_financial_type',
338 'labelColumn' => 'name',
343 'name' => 'minimum_fee',
344 'type' => CRM_Utils_Type
::T_MONEY
,
345 'title' => ts('Minimum Fee'),
346 'description' => ts('Minimum fee for this membership (0 for free/complimentary memberships).'),
351 'where' => 'civicrm_membership_type.minimum_fee',
353 'table_name' => 'civicrm_membership_type',
354 'entity' => 'MembershipType',
355 'bao' => 'CRM_Member_BAO_MembershipType',
359 'label' => ts("Minimum Fee"),
364 'name' => 'duration_unit',
365 'type' => CRM_Utils_Type
::T_STRING
,
366 'title' => ts('Membership Type Duration Unit'),
367 'description' => ts('Unit in which membership period is expressed.'),
370 'size' => CRM_Utils_Type
::EIGHT
,
371 'where' => 'civicrm_membership_type.duration_unit',
372 'table_name' => 'civicrm_membership_type',
373 'entity' => 'MembershipType',
374 'bao' => 'CRM_Member_BAO_MembershipType',
379 'pseudoconstant' => [
380 'callback' => 'CRM_Core_SelectValues::membershipTypeUnitList',
384 'duration_interval' => [
385 'name' => 'duration_interval',
386 'type' => CRM_Utils_Type
::T_INT
,
387 'title' => ts('Membership Type Duration Interval'),
388 'description' => ts('Number of duration units in membership period (e.g. 1 year, 12 months).'),
389 'where' => 'civicrm_membership_type.duration_interval',
390 'table_name' => 'civicrm_membership_type',
391 'entity' => 'MembershipType',
392 'bao' => 'CRM_Member_BAO_MembershipType',
400 'name' => 'period_type',
401 'type' => CRM_Utils_Type
::T_STRING
,
402 'title' => ts('Membership Type Plan'),
403 'description' => ts('Rolling membership period starts on signup date. Fixed membership periods start on fixed_period_start_day.'),
406 'size' => CRM_Utils_Type
::EIGHT
,
407 'where' => 'civicrm_membership_type.period_type',
408 'table_name' => 'civicrm_membership_type',
409 'entity' => 'MembershipType',
410 'bao' => 'CRM_Member_BAO_MembershipType',
415 'pseudoconstant' => [
416 'callback' => 'CRM_Core_SelectValues::periodType',
420 'fixed_period_start_day' => [
421 'name' => 'fixed_period_start_day',
422 'type' => CRM_Utils_Type
::T_INT
,
423 'title' => ts('Fixed Period Start Day'),
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.'),
425 'where' => 'civicrm_membership_type.fixed_period_start_day',
426 'table_name' => 'civicrm_membership_type',
427 'entity' => 'MembershipType',
428 'bao' => 'CRM_Member_BAO_MembershipType',
432 'fixed_period_rollover_day' => [
433 'name' => 'fixed_period_rollover_day',
434 'type' => CRM_Utils_Type
::T_INT
,
435 'title' => ts('Fixed Period Rollover Day'),
436 'description' => ts('For fixed period memberships, signups after this day (mmdd) rollover to next period.'),
437 'where' => 'civicrm_membership_type.fixed_period_rollover_day',
438 'table_name' => 'civicrm_membership_type',
439 'entity' => 'MembershipType',
440 'bao' => 'CRM_Member_BAO_MembershipType',
444 'relationship_type_id' => [
445 'name' => 'relationship_type_id',
446 'type' => CRM_Utils_Type
::T_STRING
,
447 'title' => ts('Membership Type Relationship'),
448 'description' => ts('FK to Relationship Type ID'),
450 'size' => CRM_Utils_Type
::BIG
,
451 'where' => 'civicrm_membership_type.relationship_type_id',
452 'table_name' => 'civicrm_membership_type',
453 'entity' => 'MembershipType',
454 'bao' => 'CRM_Member_BAO_MembershipType',
456 'serialize' => self
::SERIALIZE_SEPARATOR_TRIMMED
,
459 'relationship_direction' => [
460 'name' => 'relationship_direction',
461 'type' => CRM_Utils_Type
::T_STRING
,
462 'title' => ts('Relationship Direction'),
464 'size' => CRM_Utils_Type
::HUGE
,
465 'where' => 'civicrm_membership_type.relationship_direction',
466 'table_name' => 'civicrm_membership_type',
467 'entity' => 'MembershipType',
468 'bao' => 'CRM_Member_BAO_MembershipType',
470 'serialize' => self
::SERIALIZE_SEPARATOR_TRIMMED
,
472 'label' => ts("Relationship Direction"),
477 'name' => 'max_related',
478 'type' => CRM_Utils_Type
::T_INT
,
479 'title' => ts('Max Related Members for Type'),
480 'description' => ts('Maximum number of related memberships.'),
481 'where' => 'civicrm_membership_type.max_related',
482 'table_name' => 'civicrm_membership_type',
483 'entity' => 'MembershipType',
484 'bao' => 'CRM_Member_BAO_MembershipType',
488 'label' => ts("Max Related"),
493 'name' => 'visibility',
494 'type' => CRM_Utils_Type
::T_STRING
,
495 'title' => ts('Visible'),
497 'size' => CRM_Utils_Type
::BIG
,
498 'where' => 'civicrm_membership_type.visibility',
499 'table_name' => 'civicrm_membership_type',
500 'entity' => 'MembershipType',
501 'bao' => 'CRM_Member_BAO_MembershipType',
506 'pseudoconstant' => [
507 'callback' => 'CRM_Core_SelectValues::memberVisibility',
513 'type' => CRM_Utils_Type
::T_INT
,
514 'title' => ts('Order'),
515 'where' => 'civicrm_membership_type.weight',
516 'table_name' => 'civicrm_membership_type',
517 'entity' => 'MembershipType',
518 'bao' => 'CRM_Member_BAO_MembershipType',
525 'receipt_text_signup' => [
526 'name' => 'receipt_text_signup',
527 'type' => CRM_Utils_Type
::T_STRING
,
528 'title' => ts('Membership Type Receipt Text'),
529 'description' => ts('Receipt Text for membership signup'),
531 'size' => CRM_Utils_Type
::HUGE
,
532 'where' => 'civicrm_membership_type.receipt_text_signup',
533 'table_name' => 'civicrm_membership_type',
534 'entity' => 'MembershipType',
535 'bao' => 'CRM_Member_BAO_MembershipType',
538 'type' => 'TextArea',
542 'receipt_text_renewal' => [
543 'name' => 'receipt_text_renewal',
544 'type' => CRM_Utils_Type
::T_STRING
,
545 'title' => ts('Membership Type Renewal Text'),
546 'description' => ts('Receipt Text for membership renewal'),
548 'size' => CRM_Utils_Type
::HUGE
,
549 'where' => 'civicrm_membership_type.receipt_text_renewal',
550 'table_name' => 'civicrm_membership_type',
551 'entity' => 'MembershipType',
552 'bao' => 'CRM_Member_BAO_MembershipType',
555 'type' => 'TextArea',
560 'name' => 'auto_renew',
561 'type' => CRM_Utils_Type
::T_INT
,
562 'title' => ts('Auto Renew'),
563 'description' => ts('0 = No auto-renew option; 1 = Give option, but not required; 2 = Auto-renew required;'),
564 'where' => 'civicrm_membership_type.auto_renew',
566 'table_name' => 'civicrm_membership_type',
567 'entity' => 'MembershipType',
568 'bao' => 'CRM_Member_BAO_MembershipType',
572 'label' => ts("Auto-Renew"),
574 'pseudoconstant' => [
575 'callback' => 'CRM_Core_SelectValues::memberAutoRenew',
580 'name' => 'is_active',
581 'type' => CRM_Utils_Type
::T_BOOLEAN
,
582 'title' => ts('Is Active'),
583 'description' => ts('Is this membership_type enabled'),
584 'where' => 'civicrm_membership_type.is_active',
586 'table_name' => 'civicrm_membership_type',
587 'entity' => 'MembershipType',
588 'bao' => 'CRM_Member_BAO_MembershipType',
591 'type' => 'CheckBox',
592 'label' => ts("Enabled?"),
597 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
599 return Civi
::$statics[__CLASS__
]['fields'];
603 * Return a mapping from field-name to the corresponding key (as used in fields()).
606 * Array(string $name => string $uniqueName).
608 public static function &fieldKeys() {
609 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
610 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
612 return Civi
::$statics[__CLASS__
]['fieldKeys'];
616 * Returns the names of this table
620 public static function getTableName() {
621 return CRM_Core_DAO
::getLocaleTableName(self
::$_tableName);
625 * Returns if this table needs to be logged
629 public function getLog() {
634 * Returns the list of fields that can be imported
636 * @param bool $prefix
640 public static function &import($prefix = FALSE) {
641 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'membership_type', $prefix, []);
646 * Returns the list of fields that can be exported
648 * @param bool $prefix
652 public static function &export($prefix = FALSE) {
653 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'membership_type', $prefix, []);
658 * Returns the list of indices
660 * @param bool $localize
664 public static function indices($localize = TRUE) {
666 'index_relationship_type_id' => [
667 'name' => 'index_relationship_type_id',
669 0 => 'relationship_type_id',
671 'localizable' => FALSE,
672 'sig' => 'civicrm_membership_type::0::relationship_type_id',
675 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;