CRM/Member/DAO/MembershipType.php

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