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:e989278865fbeabd9f3d6efc7271a2d1)
  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           'readonly' => TRUE,
 240           'add' => '1.5',
 241         ],
 242         'domain_id' => [
 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'),
 247           'required' => TRUE,
 248           'where' => 'civicrm_membership_type.domain_id',
 249           'table_name' => 'civicrm_membership_type',
 250           'entity' => 'MembershipType',
 251           'bao' => 'CRM_Member_BAO_MembershipType',
 252           'localizable' => 0,
 253           'FKClassName' => 'CRM_Core_DAO_Domain',
 254           'html' => [
 255             'label' => ts("Domain"),
 256           ],
 257           'pseudoconstant' => [
 258             'table' => 'civicrm_domain',
 259             'keyColumn' => 'id',
 260             'labelColumn' => 'name',
 261           ],
 262           'add' => '3.0',
 263         ],
 264         'membership_type' => [
 265           'name' => 'name',
 266           'type' => CRM_Utils_Type::T_STRING,
 267           'title' => ts('Membership Type'),
 268           'description' => ts('Name of Membership Type'),
 269           'required' => TRUE,
 270           'maxlength' => 128,
 271           'size' => CRM_Utils_Type::HUGE,
 272           'import' => TRUE,
 273           'where' => 'civicrm_membership_type.name',
 274           'export' => TRUE,
 275           'table_name' => 'civicrm_membership_type',
 276           'entity' => 'MembershipType',
 277           'bao' => 'CRM_Member_BAO_MembershipType',
 278           'localizable' => 1,
 279           'html' => [
 280             'type' => 'Text',
 281             'label' => ts("Name"),
 282           ],
 283           'add' => '1.5',
 284         ],
 285         'description' => [
 286           'name' => 'description',
 287           'type' => CRM_Utils_Type::T_STRING,
 288           'title' => ts('Description'),
 289           'description' => ts('Description of Membership Type'),
 290           'maxlength' => 255,
 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',
 296           'localizable' => 1,
 297           'html' => [
 298             'type' => 'TextArea',
 299             'label' => ts("Description"),
 300           ],
 301           'add' => '1.5',
 302         ],
 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'),
 308           'required' => TRUE,
 309           'where' => 'civicrm_membership_type.member_of_contact_id',
 310           'table_name' => 'civicrm_membership_type',
 311           'entity' => 'MembershipType',
 312           'bao' => 'CRM_Member_BAO_MembershipType',
 313           'localizable' => 0,
 314           'FKClassName' => 'CRM_Contact_DAO_Contact',
 315           'html' => [
 316             'label' => ts("Organization"),
 317           ],
 318           'add' => '1.5',
 319         ],
 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'),
 325           'required' => TRUE,
 326           'where' => 'civicrm_membership_type.financial_type_id',
 327           'table_name' => 'civicrm_membership_type',
 328           'entity' => 'MembershipType',
 329           'bao' => 'CRM_Member_BAO_MembershipType',
 330           'localizable' => 0,
 331           'FKClassName' => 'CRM_Financial_DAO_FinancialType',
 332           'html' => [
 333             'label' => ts("Financial Type"),
 334           ],
 335           'pseudoconstant' => [
 336             'table' => 'civicrm_financial_type',
 337             'keyColumn' => 'id',
 338             'labelColumn' => 'name',
 339           ],
 340           'add' => '4.3',
 341         ],
 342         'minimum_fee' => [
 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).'),
 347           'precision' => [
 348             18,
 349             9,
 350           ],
 351           'where' => 'civicrm_membership_type.minimum_fee',
 352           'default' => '0',
 353           'table_name' => 'civicrm_membership_type',
 354           'entity' => 'MembershipType',
 355           'bao' => 'CRM_Member_BAO_MembershipType',
 356           'localizable' => 0,
 357           'html' => [
 358             'type' => 'Text',
 359             'label' => ts("Minimum Fee"),
 360           ],
 361           'add' => '1.5',
 362         ],
 363         'duration_unit' => [
 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.'),
 368           'maxlength' => 8,
 369           'size' => CRM_Utils_Type::EIGHT,
 370           'where' => 'civicrm_membership_type.duration_unit',
 371           'table_name' => 'civicrm_membership_type',
 372           'entity' => 'MembershipType',
 373           'bao' => 'CRM_Member_BAO_MembershipType',
 374           'localizable' => 0,
 375           'html' => [
 376             'type' => 'Select',
 377           ],
 378           'pseudoconstant' => [
 379             'callback' => 'CRM_Core_SelectValues::membershipTypeUnitList',
 380           ],
 381           'add' => '1.5',
 382         ],
 383         'duration_interval' => [
 384           'name' => 'duration_interval',
 385           'type' => CRM_Utils_Type::T_INT,
 386           'title' => ts('Membership Type Duration Interval'),
 387           'description' => ts('Number of duration units in membership period (e.g. 1 year, 12 months).'),
 388           'where' => 'civicrm_membership_type.duration_interval',
 389           'table_name' => 'civicrm_membership_type',
 390           'entity' => 'MembershipType',
 391           'bao' => 'CRM_Member_BAO_MembershipType',
 392           'localizable' => 0,
 393           'html' => [
 394             'type' => 'Text',
 395           ],
 396           'add' => '1.5',
 397         ],
 398         'period_type' => [
 399           'name' => 'period_type',
 400           'type' => CRM_Utils_Type::T_STRING,
 401           'title' => ts('Membership Type Plan'),
 402           'description' => ts('Rolling membership period starts on signup date. Fixed membership periods start on fixed_period_start_day.'),
 403           'required' => TRUE,
 404           'maxlength' => 8,
 405           'size' => CRM_Utils_Type::EIGHT,
 406           'where' => 'civicrm_membership_type.period_type',
 407           'table_name' => 'civicrm_membership_type',
 408           'entity' => 'MembershipType',
 409           'bao' => 'CRM_Member_BAO_MembershipType',
 410           'localizable' => 0,
 411           'html' => [
 412             'type' => 'Select',
 413           ],
 414           'pseudoconstant' => [
 415             'callback' => 'CRM_Core_SelectValues::periodType',
 416           ],
 417           'add' => '1.5',
 418         ],
 419         'fixed_period_start_day' => [
 420           'name' => 'fixed_period_start_day',
 421           'type' => CRM_Utils_Type::T_INT,
 422           'title' => ts('Fixed Period Start Day'),
 423           '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.'),
 424           'where' => 'civicrm_membership_type.fixed_period_start_day',
 425           'table_name' => 'civicrm_membership_type',
 426           'entity' => 'MembershipType',
 427           'bao' => 'CRM_Member_BAO_MembershipType',
 428           'localizable' => 0,
 429           'add' => '1.5',
 430         ],
 431         'fixed_period_rollover_day' => [
 432           'name' => 'fixed_period_rollover_day',
 433           'type' => CRM_Utils_Type::T_INT,
 434           'title' => ts('Fixed Period Rollover Day'),
 435           'description' => ts('For fixed period memberships, signups after this day (mmdd) rollover to next period.'),
 436           'where' => 'civicrm_membership_type.fixed_period_rollover_day',
 437           'table_name' => 'civicrm_membership_type',
 438           'entity' => 'MembershipType',
 439           'bao' => 'CRM_Member_BAO_MembershipType',
 440           'localizable' => 0,
 441           'add' => '1.5',
 442         ],
 443         'relationship_type_id' => [
 444           'name' => 'relationship_type_id',
 445           'type' => CRM_Utils_Type::T_STRING,
 446           'title' => ts('Membership Type Relationship'),
 447           'description' => ts('FK to Relationship Type ID'),
 448           'maxlength' => 64,
 449           'size' => CRM_Utils_Type::BIG,
 450           'where' => 'civicrm_membership_type.relationship_type_id',
 451           'table_name' => 'civicrm_membership_type',
 452           'entity' => 'MembershipType',
 453           'bao' => 'CRM_Member_BAO_MembershipType',
 454           'localizable' => 0,
 455           'serialize' => self::SERIALIZE_SEPARATOR_TRIMMED,
 456           'add' => '1.5',
 457         ],
 458         'relationship_direction' => [
 459           'name' => 'relationship_direction',
 460           'type' => CRM_Utils_Type::T_STRING,
 461           'title' => ts('Relationship Direction'),
 462           'maxlength' => 128,
 463           'size' => CRM_Utils_Type::HUGE,
 464           'where' => 'civicrm_membership_type.relationship_direction',
 465           'table_name' => 'civicrm_membership_type',
 466           'entity' => 'MembershipType',
 467           'bao' => 'CRM_Member_BAO_MembershipType',
 468           'localizable' => 0,
 469           'serialize' => self::SERIALIZE_SEPARATOR_TRIMMED,
 470           'html' => [
 471             'label' => ts("Relationship Direction"),
 472           ],
 473           'add' => '1.7',
 474         ],
 475         'max_related' => [
 476           'name' => 'max_related',
 477           'type' => CRM_Utils_Type::T_INT,
 478           'title' => ts('Max Related Members for Type'),
 479           'description' => ts('Maximum number of related memberships.'),
 480           'where' => 'civicrm_membership_type.max_related',
 481           'table_name' => 'civicrm_membership_type',
 482           'entity' => 'MembershipType',
 483           'bao' => 'CRM_Member_BAO_MembershipType',
 484           'localizable' => 0,
 485           'html' => [
 486             'type' => 'Text',
 487             'label' => ts("Max Related"),
 488           ],
 489           'add' => '4.3',
 490         ],
 491         'visibility' => [
 492           'name' => 'visibility',
 493           'type' => CRM_Utils_Type::T_STRING,
 494           'title' => ts('Visible'),
 495           'maxlength' => 64,
 496           'size' => CRM_Utils_Type::BIG,
 497           'where' => 'civicrm_membership_type.visibility',
 498           'table_name' => 'civicrm_membership_type',
 499           'entity' => 'MembershipType',
 500           'bao' => 'CRM_Member_BAO_MembershipType',
 501           'localizable' => 0,
 502           'html' => [
 503             'type' => 'Select',
 504           ],
 505           'pseudoconstant' => [
 506             'callback' => 'CRM_Core_SelectValues::memberVisibility',
 507           ],
 508           'add' => '1.5',
 509         ],
 510         'weight' => [
 511           'name' => 'weight',
 512           'type' => CRM_Utils_Type::T_INT,
 513           'title' => ts('Order'),
 514           'where' => 'civicrm_membership_type.weight',
 515           'table_name' => 'civicrm_membership_type',
 516           'entity' => 'MembershipType',
 517           'bao' => 'CRM_Member_BAO_MembershipType',
 518           'localizable' => 0,
 519           'html' => [
 520             'type' => 'Text',
 521           ],
 522           'add' => '1.5',
 523         ],
 524         'receipt_text_signup' => [
 525           'name' => 'receipt_text_signup',
 526           'type' => CRM_Utils_Type::T_STRING,
 527           'title' => ts('Membership Type Receipt Text'),
 528           'description' => ts('Receipt Text for membership signup'),
 529           'maxlength' => 255,
 530           'size' => CRM_Utils_Type::HUGE,
 531           'where' => 'civicrm_membership_type.receipt_text_signup',
 532           'table_name' => 'civicrm_membership_type',
 533           'entity' => 'MembershipType',
 534           'bao' => 'CRM_Member_BAO_MembershipType',
 535           'localizable' => 0,
 536           'html' => [
 537             'type' => 'TextArea',
 538           ],
 539           'add' => '2.0',
 540         ],
 541         'receipt_text_renewal' => [
 542           'name' => 'receipt_text_renewal',
 543           'type' => CRM_Utils_Type::T_STRING,
 544           'title' => ts('Membership Type Renewal Text'),
 545           'description' => ts('Receipt Text for membership renewal'),
 546           'maxlength' => 255,
 547           'size' => CRM_Utils_Type::HUGE,
 548           'where' => 'civicrm_membership_type.receipt_text_renewal',
 549           'table_name' => 'civicrm_membership_type',
 550           'entity' => 'MembershipType',
 551           'bao' => 'CRM_Member_BAO_MembershipType',
 552           'localizable' => 0,
 553           'html' => [
 554             'type' => 'TextArea',
 555           ],
 556           'add' => '2.0',
 557         ],
 558         'auto_renew' => [
 559           'name' => 'auto_renew',
 560           'type' => CRM_Utils_Type::T_BOOLEAN,
 561           'title' => ts('Auto Renew'),
 562           'description' => ts('0 = No auto-renew option; 1 = Give option, but not required; 2 = Auto-renew required;'),
 563           'where' => 'civicrm_membership_type.auto_renew',
 564           'default' => '0',
 565           'table_name' => 'civicrm_membership_type',
 566           'entity' => 'MembershipType',
 567           'bao' => 'CRM_Member_BAO_MembershipType',
 568           'localizable' => 0,
 569           'html' => [
 570             'type' => 'Radio',
 571             'label' => ts("Auto-Renew"),
 572           ],
 573           'pseudoconstant' => [
 574             'callback' => 'CRM_Core_SelectValues::memberAutoRenew',
 575           ],
 576           'add' => '3.3',
 577         ],
 578         'is_active' => [
 579           'name' => 'is_active',
 580           'type' => CRM_Utils_Type::T_BOOLEAN,
 581           'title' => ts('Is Active'),
 582           'description' => ts('Is this membership_type enabled'),
 583           'where' => 'civicrm_membership_type.is_active',
 584           'default' => '1',
 585           'table_name' => 'civicrm_membership_type',
 586           'entity' => 'MembershipType',
 587           'bao' => 'CRM_Member_BAO_MembershipType',
 588           'localizable' => 0,
 589           'html' => [
 590             'type' => 'CheckBox',
 591             'label' => ts("Enabled?"),
 592           ],
 593           'add' => '1.5',
 594         ],
 595       ];
 596       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 597     }
 598     return Civi::$statics[__CLASS__]['fields'];
 599   }
 600
 601   /**
 602    * Return a mapping from field-name to the corresponding key (as used in fields()).
 603    *
 604    * @return array
 605    *   Array(string $name => string $uniqueName).
 606    */
 607   public static function &fieldKeys() {
 608     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 609       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 610     }
 611     return Civi::$statics[__CLASS__]['fieldKeys'];
 612   }
 613
 614   /**
 615    * Returns the names of this table
 616    *
 617    * @return string
 618    */
 619   public static function getTableName() {
 620     return CRM_Core_DAO::getLocaleTableName(self::$_tableName);
 621   }
 622
 623   /**
 624    * Returns if this table needs to be logged
 625    *
 626    * @return bool
 627    */
 628   public function getLog() {
 629     return self::$_log;
 630   }
 631
 632   /**
 633    * Returns the list of fields that can be imported
 634    *
 635    * @param bool $prefix
 636    *
 637    * @return array
 638    */
 639   public static function &import($prefix = FALSE) {
 640     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'membership_type', $prefix, []);
 641     return $r;
 642   }
 643
 644   /**
 645    * Returns the list of fields that can be exported
 646    *
 647    * @param bool $prefix
 648    *
 649    * @return array
 650    */
 651   public static function &export($prefix = FALSE) {
 652     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'membership_type', $prefix, []);
 653     return $r;
 654   }
 655
 656   /**
 657    * Returns the list of indices
 658    *
 659    * @param bool $localize
 660    *
 661    * @return array
 662    */
 663   public static function indices($localize = TRUE) {
 664     $indices = [
 665       'index_relationship_type_id' => [
 666         'name' => 'index_relationship_type_id',
 667         'field' => [
 668           0 => 'relationship_type_id',
 669         ],
 670         'localizable' => FALSE,
 671         'sig' => 'civicrm_membership_type::0::relationship_type_id',
 672       ],
 673     ];
 674     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 675   }
 676
 677 }