CRM/Member/DAO/MembershipType.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Member/MembershipType.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:9fd7f864fc6d70c8a1fad482ded120ff)
  10  */
  11
  12 /**
  13  * Database access object for the MembershipType entity.
  14  */
  15 class CRM_Member_DAO_MembershipType extends CRM_Core_DAO {
  16   const EXT = 'civicrm';
  17   const TABLE_ADDED = '1.5';
  18   const COMPONENT = 'CiviMember';
  19
  20   /**
  21    * Static instance to hold the table name.
  22    *
  23    * @var string
  24    */
  25   public static $_tableName = 'civicrm_membership_type';
  26
  27   /**
  28    * Field to show when displaying a record.
  29    *
  30    * @var string
  31    */
  32   public static $_labelField = 'name';
  33
  34   /**
  35    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  36    *
  37    * @var bool
  38    */
  39   public static $_log = TRUE;
  40
  41   /**
  42    * Membership ID
  43    *
  44    * @var int
  45    */
  46   public $id;
  47
  48   /**
  49    * Which Domain is this match entry for
  50    *
  51    * @var int
  52    */
  53   public $domain_id;
  54
  55   /**
  56    * Name of Membership Type
  57    *
  58    * @var string
  59    */
  60   public $name;
  61
  62   /**
  63    * Description of Membership Type
  64    *
  65    * @var string
  66    */
  67   public $description;
  68
  69   /**
  70    * Owner organization for this membership type. FK to Contact ID
  71    *
  72    * @var int
  73    */
  74   public $member_of_contact_id;
  75
  76   /**
  77    * If membership is paid by a contribution - what financial type should be used. FK to civicrm_financial_type.id
  78    *
  79    * @var int
  80    */
  81   public $financial_type_id;
  82
  83   /**
  84    * Minimum fee for this membership (0 for free/complimentary memberships).
  85    *
  86    * @var float
  87    */
  88   public $minimum_fee;
  89
  90   /**
  91    * Unit in which membership period is expressed.
  92    *
  93    * @var string
  94    */
  95   public $duration_unit;
  96
  97   /**
  98    * Number of duration units in membership period (e.g. 1 year, 12 months).
  99    *
 100    * @var int
 101    */
 102   public $duration_interval;
 103
 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;
 110
 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;
 117
 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;
 124
 125   /**
 126    * FK to Relationship Type ID
 127    *
 128    * @var string
 129    */
 130   public $relationship_type_id;
 131
 132   /**
 133    * @var string
 134    */
 135   public $relationship_direction;
 136
 137   /**
 138    * Maximum number of related memberships.
 139    *
 140    * @var int
 141    */
 142   public $max_related;
 143
 144   /**
 145    * @var string
 146    */
 147   public $visibility;
 148
 149   /**
 150    * @var int
 151    */
 152   public $weight;
 153
 154   /**
 155    * Receipt Text for membership signup
 156    *
 157    * @var string
 158    */
 159   public $receipt_text_signup;
 160
 161   /**
 162    * Receipt Text for membership renewal
 163    *
 164    * @var string
 165    */
 166   public $receipt_text_renewal;
 167
 168   /**
 169    * 0 = No auto-renew option; 1 = Give option, but not required; 2 = Auto-renew required;
 170    *
 171    * @var bool
 172    */
 173   public $auto_renew;
 174
 175   /**
 176    * Is this membership_type enabled
 177    *
 178    * @var bool
 179    */
 180   public $is_active;
 181
 182   /**
 183    * Class constructor.
 184    */
 185   public function __construct() {
 186     $this->__table = 'civicrm_membership_type';
 187     parent::__construct();
 188   }
 189
 190   /**
 191    * Returns localized title of this entity.
 192    *
 193    * @param bool $plural
 194    *   Whether to return the plural version of the title.
 195    */
 196   public static function getEntityTitle($plural = FALSE) {
 197     return $plural ? ts('Membership Types') : ts('Membership Type');
 198   }
 199
 200   /**
 201    * Returns foreign keys and entity references.
 202    *
 203    * @return array
 204    *   [CRM_Core_Reference_Interface]
 205    */
 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']);
 213     }
 214     return Civi::$statics[__CLASS__]['links'];
 215   }
 216
 217   /**
 218    * Returns all the column names of this table
 219    *
 220    * @return array
 221    */
 222   public static function &fields() {
 223     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 224       Civi::$statics[__CLASS__]['fields'] = [
 225         'id' => [
 226           'name' => 'id',
 227           'type' => CRM_Utils_Type::T_INT,
 228           'title' => ts('Membership Type ID'),
 229           'description' => ts('Membership ID'),
 230           'required' => TRUE,
 231           'where' => 'civicrm_membership_type.id',
 232           'table_name' => 'civicrm_membership_type',
 233           'entity' => 'MembershipType',
 234           'bao' => 'CRM_Member_BAO_MembershipType',
 235           'localizable' => 0,
 236           'html' => [
 237             'type' => 'Number',
 238           ],
 239           'add' => '1.5',
 240         ],
 241         'domain_id' => [
 242           'name' => 'domain_id',
 243           'type' => CRM_Utils_Type::T_INT,
 244           'title' => ts('Domain ID'),
 245           'description' => ts('Which Domain is this match entry for'),
 246           'required' => TRUE,
 247           'where' => 'civicrm_membership_type.domain_id',
 248           'table_name' => 'civicrm_membership_type',
 249           'entity' => 'MembershipType',
 250           'bao' => 'CRM_Member_BAO_MembershipType',
 251           'localizable' => 0,
 252           'FKClassName' => 'CRM_Core_DAO_Domain',
 253           'html' => [
 254             'label' => ts("Domain"),
 255           ],
 256           'pseudoconstant' => [
 257             'table' => 'civicrm_domain',
 258             'keyColumn' => 'id',
 259             'labelColumn' => 'name',
 260           ],
 261           'add' => '3.0',
 262         ],
 263         'membership_type' => [
 264           'name' => 'name',
 265           'type' => CRM_Utils_Type::T_STRING,
 266           'title' => ts('Membership Type'),
 267           'description' => ts('Name of Membership Type'),
 268           'required' => TRUE,
 269           'maxlength' => 128,
 270           'size' => CRM_Utils_Type::HUGE,
 271           'import' => TRUE,
 272           'where' => 'civicrm_membership_type.name',
 273           'export' => TRUE,
 274           'table_name' => 'civicrm_membership_type',
 275           'entity' => 'MembershipType',
 276           'bao' => 'CRM_Member_BAO_MembershipType',
 277           'localizable' => 1,
 278           'html' => [
 279             'type' => 'Text',
 280             'label' => ts("Name"),
 281           ],
 282           'add' => '1.5',
 283         ],
 284         'description' => [
 285           'name' => 'description',
 286           'type' => CRM_Utils_Type::T_STRING,
 287           'title' => ts('Description'),
 288           'description' => ts('Description of Membership Type'),
 289           'maxlength' => 255,
 290           'size' => CRM_Utils_Type::HUGE,
 291           'where' => 'civicrm_membership_type.description',
 292           'table_name' => 'civicrm_membership_type',
 293           'entity' => 'MembershipType',
 294           'bao' => 'CRM_Member_BAO_MembershipType',
 295           'localizable' => 1,
 296           'html' => [
 297             'type' => 'TextArea',
 298             'label' => ts("Description"),
 299           ],
 300           'add' => '1.5',
 301         ],
 302         'member_of_contact_id' => [
 303           'name' => 'member_of_contact_id',
 304           'type' => CRM_Utils_Type::T_INT,
 305           'title' => ts('Organization ID'),
 306           'description' => ts('Owner organization for this membership type. FK to Contact ID'),
 307           'required' => TRUE,
 308           'where' => 'civicrm_membership_type.member_of_contact_id',
 309           'table_name' => 'civicrm_membership_type',
 310           'entity' => 'MembershipType',
 311           'bao' => 'CRM_Member_BAO_MembershipType',
 312           'localizable' => 0,
 313           'FKClassName' => 'CRM_Contact_DAO_Contact',
 314           'html' => [
 315             'label' => ts("Organization"),
 316           ],
 317           'add' => '1.5',
 318         ],
 319         'financial_type_id' => [
 320           'name' => 'financial_type_id',
 321           'type' => CRM_Utils_Type::T_INT,
 322           'title' => ts('Financial Type ID'),
 323           'description' => ts('If membership is paid by a contribution - what financial type should be used. FK to civicrm_financial_type.id'),
 324           'required' => TRUE,
 325           'where' => 'civicrm_membership_type.financial_type_id',
 326           'table_name' => 'civicrm_membership_type',
 327           'entity' => 'MembershipType',
 328           'bao' => 'CRM_Member_BAO_MembershipType',
 329           'localizable' => 0,
 330           'FKClassName' => 'CRM_Financial_DAO_FinancialType',
 331           'html' => [
 332             'label' => ts("Financial Type"),
 333           ],
 334           'pseudoconstant' => [
 335             'table' => 'civicrm_financial_type',
 336             'keyColumn' => 'id',
 337             'labelColumn' => 'name',
 338           ],
 339           'add' => '4.3',
 340         ],
 341         'minimum_fee' => [
 342           'name' => 'minimum_fee',
 343           'type' => CRM_Utils_Type::T_MONEY,
 344           'title' => ts('Minimum Fee'),
 345           'description' => ts('Minimum fee for this membership (0 for free/complimentary memberships).'),
 346           'precision' => [
 347             18,
 348             9,
 349           ],
 350           'where' => 'civicrm_membership_type.minimum_fee',
 351           'default' => '0',
 352           'table_name' => 'civicrm_membership_type',
 353           'entity' => 'MembershipType',
 354           'bao' => 'CRM_Member_BAO_MembershipType',
 355           'localizable' => 0,
 356           'html' => [
 357             'type' => 'Text',
 358             'label' => ts("Minimum Fee"),
 359           ],
 360           'add' => '1.5',
 361         ],
 362         'duration_unit' => [
 363           'name' => 'duration_unit',
 364           'type' => CRM_Utils_Type::T_STRING,
 365           'title' => ts('Membership Type Duration Unit'),
 366           'description' => ts('Unit in which membership period is expressed.'),
 367           'maxlength' => 8,
 368           'size' => CRM_Utils_Type::EIGHT,
 369           'where' => 'civicrm_membership_type.duration_unit',
 370           'table_name' => 'civicrm_membership_type',
 371           'entity' => 'MembershipType',
 372           'bao' => 'CRM_Member_BAO_MembershipType',
 373           'localizable' => 0,
 374           'html' => [
 375             'type' => 'Select',
 376           ],
 377           'pseudoconstant' => [
 378             'callback' => 'CRM_Core_SelectValues::membershipTypeUnitList',
 379           ],
 380           'add' => '1.5',
 381         ],
 382         'duration_interval' => [
 383           'name' => 'duration_interval',
 384           'type' => CRM_Utils_Type::T_INT,
 385           'title' => ts('Membership Type Duration Interval'),
 386           'description' => ts('Number of duration units in membership period (e.g. 1 year, 12 months).'),
 387           'where' => 'civicrm_membership_type.duration_interval',
 388           'table_name' => 'civicrm_membership_type',
 389           'entity' => 'MembershipType',
 390           'bao' => 'CRM_Member_BAO_MembershipType',
 391           'localizable' => 0,
 392           'html' => [
 393             'type' => 'Text',
 394           ],
 395           'add' => '1.5',
 396         ],
 397         'period_type' => [
 398           'name' => 'period_type',
 399           'type' => CRM_Utils_Type::T_STRING,
 400           'title' => ts('Membership Type Plan'),
 401           'description' => ts('Rolling membership period starts on signup date. Fixed membership periods start on fixed_period_start_day.'),
 402           'required' => TRUE,
 403           'maxlength' => 8,
 404           'size' => CRM_Utils_Type::EIGHT,
 405           'where' => 'civicrm_membership_type.period_type',
 406           'table_name' => 'civicrm_membership_type',
 407           'entity' => 'MembershipType',
 408           'bao' => 'CRM_Member_BAO_MembershipType',
 409           'localizable' => 0,
 410           'html' => [
 411             'type' => 'Select',
 412           ],
 413           'pseudoconstant' => [
 414             'callback' => 'CRM_Core_SelectValues::periodType',
 415           ],
 416           'add' => '1.5',
 417         ],
 418         'fixed_period_start_day' => [
 419           'name' => 'fixed_period_start_day',
 420           'type' => CRM_Utils_Type::T_INT,
 421           'title' => ts('Fixed Period Start Day'),
 422           '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.'),
 423           'where' => 'civicrm_membership_type.fixed_period_start_day',
 424           'table_name' => 'civicrm_membership_type',
 425           'entity' => 'MembershipType',
 426           'bao' => 'CRM_Member_BAO_MembershipType',
 427           'localizable' => 0,
 428           'add' => '1.5',
 429         ],
 430         'fixed_period_rollover_day' => [
 431           'name' => 'fixed_period_rollover_day',
 432           'type' => CRM_Utils_Type::T_INT,
 433           'title' => ts('Fixed Period Rollover Day'),
 434           'description' => ts('For fixed period memberships, signups after this day (mmdd) rollover to next period.'),
 435           'where' => 'civicrm_membership_type.fixed_period_rollover_day',
 436           'table_name' => 'civicrm_membership_type',
 437           'entity' => 'MembershipType',
 438           'bao' => 'CRM_Member_BAO_MembershipType',
 439           'localizable' => 0,
 440           'add' => '1.5',
 441         ],
 442         'relationship_type_id' => [
 443           'name' => 'relationship_type_id',
 444           'type' => CRM_Utils_Type::T_STRING,
 445           'title' => ts('Membership Type Relationship'),
 446           'description' => ts('FK to Relationship Type ID'),
 447           'maxlength' => 64,
 448           'size' => CRM_Utils_Type::BIG,
 449           'where' => 'civicrm_membership_type.relationship_type_id',
 450           'table_name' => 'civicrm_membership_type',
 451           'entity' => 'MembershipType',
 452           'bao' => 'CRM_Member_BAO_MembershipType',
 453           'localizable' => 0,
 454           'serialize' => self::SERIALIZE_SEPARATOR_TRIMMED,
 455           'add' => '1.5',
 456         ],
 457         'relationship_direction' => [
 458           'name' => 'relationship_direction',
 459           'type' => CRM_Utils_Type::T_STRING,
 460           'title' => ts('Relationship Direction'),
 461           'maxlength' => 128,
 462           'size' => CRM_Utils_Type::HUGE,
 463           'where' => 'civicrm_membership_type.relationship_direction',
 464           'table_name' => 'civicrm_membership_type',
 465           'entity' => 'MembershipType',
 466           'bao' => 'CRM_Member_BAO_MembershipType',
 467           'localizable' => 0,
 468           'serialize' => self::SERIALIZE_SEPARATOR_TRIMMED,
 469           'html' => [
 470             'label' => ts("Relationship Direction"),
 471           ],
 472           'add' => '1.7',
 473         ],
 474         'max_related' => [
 475           'name' => 'max_related',
 476           'type' => CRM_Utils_Type::T_INT,
 477           'title' => ts('Max Related Members for Type'),
 478           'description' => ts('Maximum number of related memberships.'),
 479           'where' => 'civicrm_membership_type.max_related',
 480           'table_name' => 'civicrm_membership_type',
 481           'entity' => 'MembershipType',
 482           'bao' => 'CRM_Member_BAO_MembershipType',
 483           'localizable' => 0,
 484           'html' => [
 485             'type' => 'Text',
 486             'label' => ts("Max Related"),
 487           ],
 488           'add' => '4.3',
 489         ],
 490         'visibility' => [
 491           'name' => 'visibility',
 492           'type' => CRM_Utils_Type::T_STRING,
 493           'title' => ts('Visible'),
 494           'maxlength' => 64,
 495           'size' => CRM_Utils_Type::BIG,
 496           'where' => 'civicrm_membership_type.visibility',
 497           'table_name' => 'civicrm_membership_type',
 498           'entity' => 'MembershipType',
 499           'bao' => 'CRM_Member_BAO_MembershipType',
 500           'localizable' => 0,
 501           'html' => [
 502             'type' => 'Select',
 503           ],
 504           'pseudoconstant' => [
 505             'callback' => 'CRM_Core_SelectValues::memberVisibility',
 506           ],
 507           'add' => '1.5',
 508         ],
 509         'weight' => [
 510           'name' => 'weight',
 511           'type' => CRM_Utils_Type::T_INT,
 512           'title' => ts('Order'),
 513           'where' => 'civicrm_membership_type.weight',
 514           'table_name' => 'civicrm_membership_type',
 515           'entity' => 'MembershipType',
 516           'bao' => 'CRM_Member_BAO_MembershipType',
 517           'localizable' => 0,
 518           'html' => [
 519             'type' => 'Text',
 520           ],
 521           'add' => '1.5',
 522         ],
 523         'receipt_text_signup' => [
 524           'name' => 'receipt_text_signup',
 525           'type' => CRM_Utils_Type::T_STRING,
 526           'title' => ts('Membership Type Receipt Text'),
 527           'description' => ts('Receipt Text for membership signup'),
 528           'maxlength' => 255,
 529           'size' => CRM_Utils_Type::HUGE,
 530           'where' => 'civicrm_membership_type.receipt_text_signup',
 531           'table_name' => 'civicrm_membership_type',
 532           'entity' => 'MembershipType',
 533           'bao' => 'CRM_Member_BAO_MembershipType',
 534           'localizable' => 0,
 535           'html' => [
 536             'type' => 'TextArea',
 537           ],
 538           'add' => '2.0',
 539         ],
 540         'receipt_text_renewal' => [
 541           'name' => 'receipt_text_renewal',
 542           'type' => CRM_Utils_Type::T_STRING,
 543           'title' => ts('Membership Type Renewal Text'),
 544           'description' => ts('Receipt Text for membership renewal'),
 545           'maxlength' => 255,
 546           'size' => CRM_Utils_Type::HUGE,
 547           'where' => 'civicrm_membership_type.receipt_text_renewal',
 548           'table_name' => 'civicrm_membership_type',
 549           'entity' => 'MembershipType',
 550           'bao' => 'CRM_Member_BAO_MembershipType',
 551           'localizable' => 0,
 552           'html' => [
 553             'type' => 'TextArea',
 554           ],
 555           'add' => '2.0',
 556         ],
 557         'auto_renew' => [
 558           'name' => 'auto_renew',
 559           'type' => CRM_Utils_Type::T_BOOLEAN,
 560           'title' => ts('Auto Renew'),
 561           'description' => ts('0 = No auto-renew option; 1 = Give option, but not required; 2 = Auto-renew required;'),
 562           'where' => 'civicrm_membership_type.auto_renew',
 563           'default' => '0',
 564           'table_name' => 'civicrm_membership_type',
 565           'entity' => 'MembershipType',
 566           'bao' => 'CRM_Member_BAO_MembershipType',
 567           'localizable' => 0,
 568           'html' => [
 569             'type' => 'Radio',
 570             'label' => ts("Auto-Renew"),
 571           ],
 572           'pseudoconstant' => [
 573             'callback' => 'CRM_Core_SelectValues::memberAutoRenew',
 574           ],
 575           'add' => '3.3',
 576         ],
 577         'is_active' => [
 578           'name' => 'is_active',
 579           'type' => CRM_Utils_Type::T_BOOLEAN,
 580           'title' => ts('Is Active'),
 581           'description' => ts('Is this membership_type enabled'),
 582           'where' => 'civicrm_membership_type.is_active',
 583           'default' => '1',
 584           'table_name' => 'civicrm_membership_type',
 585           'entity' => 'MembershipType',
 586           'bao' => 'CRM_Member_BAO_MembershipType',
 587           'localizable' => 0,
 588           'html' => [
 589             'type' => 'CheckBox',
 590             'label' => ts("Enabled?"),
 591           ],
 592           'add' => '1.5',
 593         ],
 594       ];
 595       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 596     }
 597     return Civi::$statics[__CLASS__]['fields'];
 598   }
 599
 600   /**
 601    * Return a mapping from field-name to the corresponding key (as used in fields()).
 602    *
 603    * @return array
 604    *   Array(string $name => string $uniqueName).
 605    */
 606   public static function &fieldKeys() {
 607     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 608       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 609     }
 610     return Civi::$statics[__CLASS__]['fieldKeys'];
 611   }
 612
 613   /**
 614    * Returns the names of this table
 615    *
 616    * @return string
 617    */
 618   public static function getTableName() {
 619     return CRM_Core_DAO::getLocaleTableName(self::$_tableName);
 620   }
 621
 622   /**
 623    * Returns if this table needs to be logged
 624    *
 625    * @return bool
 626    */
 627   public function getLog() {
 628     return self::$_log;
 629   }
 630
 631   /**
 632    * Returns the list of fields that can be imported
 633    *
 634    * @param bool $prefix
 635    *
 636    * @return array
 637    */
 638   public static function &import($prefix = FALSE) {
 639     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'membership_type', $prefix, []);
 640     return $r;
 641   }
 642
 643   /**
 644    * Returns the list of fields that can be exported
 645    *
 646    * @param bool $prefix
 647    *
 648    * @return array
 649    */
 650   public static function &export($prefix = FALSE) {
 651     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'membership_type', $prefix, []);
 652     return $r;
 653   }
 654
 655   /**
 656    * Returns the list of indices
 657    *
 658    * @param bool $localize
 659    *
 660    * @return array
 661    */
 662   public static function indices($localize = TRUE) {
 663     $indices = [
 664       'index_relationship_type_id' => [
 665         'name' => 'index_relationship_type_id',
 666         'field' => [
 667           0 => 'relationship_type_id',
 668         ],
 669         'localizable' => FALSE,
 670         'sig' => 'civicrm_membership_type::0::relationship_type_id',
 671       ],
 672     ];
 673     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 674   }
 675
 676 }