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:51b478b01b1ef20a54b1039ccc29d0ab)
  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             'label' => ts("Name"),
 252           ],
 253         ],
 254         'description' => [
 255           'name' => 'description',
 256           'type' => CRM_Utils_Type::T_STRING,
 257           'title' => ts('Membership Type Description'),
 258           'description' => 'Description of Membership Type',
 259           'maxlength' => 255,
 260           'size' => CRM_Utils_Type::HUGE,
 261           'table_name' => 'civicrm_membership_type',
 262           'entity' => 'MembershipType',
 263           'bao' => 'CRM_Member_BAO_MembershipType',
 264           'localizable' => 1,
 265           'html' => [
 266             'type' => 'TextArea',
 267             'label' => ts("Description"),
 268           ],
 269         ],
 270         'member_of_contact_id' => [
 271           'name' => 'member_of_contact_id',
 272           'type' => CRM_Utils_Type::T_INT,
 273           'title' => ts('Membership Type Organization'),
 274           'description' => 'Owner organization for this membership type. FK to Contact ID',
 275           'required' => TRUE,
 276           'table_name' => 'civicrm_membership_type',
 277           'entity' => 'MembershipType',
 278           'bao' => 'CRM_Member_BAO_MembershipType',
 279           'localizable' => 0,
 280           'FKClassName' => 'CRM_Contact_DAO_Contact',
 281         ],
 282         'financial_type_id' => [
 283           'name' => 'financial_type_id',
 284           'type' => CRM_Utils_Type::T_INT,
 285           'title' => ts('Membership Financial Type'),
 286           'description' => 'If membership is paid by a contribution - what financial type should be used. FK to civicrm_financial_type.id',
 287           'required' => TRUE,
 288           'table_name' => 'civicrm_membership_type',
 289           'entity' => 'MembershipType',
 290           'bao' => 'CRM_Member_BAO_MembershipType',
 291           'localizable' => 0,
 292           'FKClassName' => 'CRM_Financial_DAO_FinancialType',
 293           'pseudoconstant' => [
 294             'table' => 'civicrm_financial_type',
 295             'keyColumn' => 'id',
 296             'labelColumn' => 'name',
 297           ]
 298         ],
 299         'minimum_fee' => [
 300           'name' => 'minimum_fee',
 301           'type' => CRM_Utils_Type::T_MONEY,
 302           'title' => ts('Membership Type Minimum Fee'),
 303           'description' => 'Minimum fee for this membership (0 for free/complimentary memberships).',
 304           'precision' => [
 305             18,
 306             9
 307           ],
 308           'table_name' => 'civicrm_membership_type',
 309           'entity' => 'MembershipType',
 310           'bao' => 'CRM_Member_BAO_MembershipType',
 311           'localizable' => 0,
 312           'html' => [
 313             'type' => 'Text',
 314             'label' => ts("Minimum Fee"),
 315           ],
 316         ],
 317         'duration_unit' => [
 318           'name' => 'duration_unit',
 319           'type' => CRM_Utils_Type::T_STRING,
 320           'title' => ts('Membership Type Duration Unit'),
 321           'description' => 'Unit in which membership period is expressed.',
 322           'maxlength' => 8,
 323           'size' => CRM_Utils_Type::EIGHT,
 324           'table_name' => 'civicrm_membership_type',
 325           'entity' => 'MembershipType',
 326           'bao' => 'CRM_Member_BAO_MembershipType',
 327           'localizable' => 0,
 328           'html' => [
 329             'type' => 'Select',
 330           ],
 331           'pseudoconstant' => [
 332             'callback' => 'CRM_Core_SelectValues::membershipTypeUnitList',
 333           ]
 334         ],
 335         'duration_interval' => [
 336           'name' => 'duration_interval',
 337           'type' => CRM_Utils_Type::T_INT,
 338           'title' => ts('Membership Type Duration Interval'),
 339           'description' => 'Number of duration units in membership period (e.g. 1 year, 12 months).',
 340           'table_name' => 'civicrm_membership_type',
 341           'entity' => 'MembershipType',
 342           'bao' => 'CRM_Member_BAO_MembershipType',
 343           'localizable' => 0,
 344           'html' => [
 345             'type' => 'Text',
 346           ],
 347         ],
 348         'period_type' => [
 349           'name' => 'period_type',
 350           'type' => CRM_Utils_Type::T_STRING,
 351           'title' => ts('Membership Type Plan'),
 352           'description' => 'Rolling membership period starts on signup date. Fixed membership periods start on fixed_period_start_day.',
 353           'maxlength' => 8,
 354           'size' => CRM_Utils_Type::EIGHT,
 355           'table_name' => 'civicrm_membership_type',
 356           'entity' => 'MembershipType',
 357           'bao' => 'CRM_Member_BAO_MembershipType',
 358           'localizable' => 0,
 359           'html' => [
 360             'type' => 'Select',
 361           ],
 362           'pseudoconstant' => [
 363             'callback' => 'CRM_Core_SelectValues::periodType',
 364           ]
 365         ],
 366         'fixed_period_start_day' => [
 367           'name' => 'fixed_period_start_day',
 368           'type' => CRM_Utils_Type::T_INT,
 369           'title' => ts('Fixed Period Start Day'),
 370           'description' => 'For fixed period memberships, month and day (mmdd) on which subscription/membership will start. Period start is back-dated unless after rollover day.',
 371           'table_name' => 'civicrm_membership_type',
 372           'entity' => 'MembershipType',
 373           'bao' => 'CRM_Member_BAO_MembershipType',
 374           'localizable' => 0,
 375         ],
 376         'fixed_period_rollover_day' => [
 377           'name' => 'fixed_period_rollover_day',
 378           'type' => CRM_Utils_Type::T_INT,
 379           'title' => ts('Fixed Period Rollover Day'),
 380           'description' => 'For fixed period memberships, signups after this day (mmdd) rollover to next period.',
 381           'table_name' => 'civicrm_membership_type',
 382           'entity' => 'MembershipType',
 383           'bao' => 'CRM_Member_BAO_MembershipType',
 384           'localizable' => 0,
 385         ],
 386         'relationship_type_id' => [
 387           'name' => 'relationship_type_id',
 388           'type' => CRM_Utils_Type::T_STRING,
 389           'title' => ts('Membership Type Relationship'),
 390           'description' => 'FK to Relationship Type ID',
 391           'maxlength' => 64,
 392           'size' => CRM_Utils_Type::BIG,
 393           'table_name' => 'civicrm_membership_type',
 394           'entity' => 'MembershipType',
 395           'bao' => 'CRM_Member_BAO_MembershipType',
 396           'localizable' => 0,
 397         ],
 398         'relationship_direction' => [
 399           'name' => 'relationship_direction',
 400           'type' => CRM_Utils_Type::T_STRING,
 401           'title' => ts('Relationship Direction'),
 402           'maxlength' => 128,
 403           'size' => CRM_Utils_Type::HUGE,
 404           'table_name' => 'civicrm_membership_type',
 405           'entity' => 'MembershipType',
 406           'bao' => 'CRM_Member_BAO_MembershipType',
 407           'localizable' => 0,
 408         ],
 409         'max_related' => [
 410           'name' => 'max_related',
 411           'type' => CRM_Utils_Type::T_INT,
 412           'title' => ts('Max Related Members for Type'),
 413           'description' => 'Maximum number of related memberships.',
 414           'table_name' => 'civicrm_membership_type',
 415           'entity' => 'MembershipType',
 416           'bao' => 'CRM_Member_BAO_MembershipType',
 417           'localizable' => 0,
 418           'html' => [
 419             'type' => 'Text',
 420             'label' => ts("Max Related"),
 421           ],
 422         ],
 423         'visibility' => [
 424           'name' => 'visibility',
 425           'type' => CRM_Utils_Type::T_STRING,
 426           'title' => ts('Visible'),
 427           'maxlength' => 64,
 428           'size' => CRM_Utils_Type::BIG,
 429           'table_name' => 'civicrm_membership_type',
 430           'entity' => 'MembershipType',
 431           'bao' => 'CRM_Member_BAO_MembershipType',
 432           'localizable' => 0,
 433           'html' => [
 434             'type' => 'Select',
 435           ],
 436           'pseudoconstant' => [
 437             'callback' => 'CRM_Core_SelectValues::memberVisibility',
 438           ]
 439         ],
 440         'weight' => [
 441           'name' => 'weight',
 442           'type' => CRM_Utils_Type::T_INT,
 443           'title' => ts('Order'),
 444           'table_name' => 'civicrm_membership_type',
 445           'entity' => 'MembershipType',
 446           'bao' => 'CRM_Member_BAO_MembershipType',
 447           'localizable' => 0,
 448           'html' => [
 449             'type' => 'Text',
 450           ],
 451         ],
 452         'receipt_text_signup' => [
 453           'name' => 'receipt_text_signup',
 454           'type' => CRM_Utils_Type::T_STRING,
 455           'title' => ts('Membership Type Receipt Text'),
 456           'description' => 'Receipt Text for membership signup',
 457           'maxlength' => 255,
 458           'size' => CRM_Utils_Type::HUGE,
 459           'table_name' => 'civicrm_membership_type',
 460           'entity' => 'MembershipType',
 461           'bao' => 'CRM_Member_BAO_MembershipType',
 462           'localizable' => 0,
 463           'html' => [
 464             'type' => 'TextArea',
 465           ],
 466         ],
 467         'receipt_text_renewal' => [
 468           'name' => 'receipt_text_renewal',
 469           'type' => CRM_Utils_Type::T_STRING,
 470           'title' => ts('Membership Type Renewal Text'),
 471           'description' => 'Receipt Text for membership renewal',
 472           'maxlength' => 255,
 473           'size' => CRM_Utils_Type::HUGE,
 474           'table_name' => 'civicrm_membership_type',
 475           'entity' => 'MembershipType',
 476           'bao' => 'CRM_Member_BAO_MembershipType',
 477           'localizable' => 0,
 478           'html' => [
 479             'type' => 'TextArea',
 480           ],
 481         ],
 482         'auto_renew' => [
 483           'name' => 'auto_renew',
 484           'type' => CRM_Utils_Type::T_BOOLEAN,
 485           'title' => ts('Auto Renew'),
 486           'description' => '0 = No auto-renew option; 1 = Give option, but not required; 2 = Auto-renew required;',
 487           'table_name' => 'civicrm_membership_type',
 488           'entity' => 'MembershipType',
 489           'bao' => 'CRM_Member_BAO_MembershipType',
 490           'localizable' => 0,
 491           'pseudoconstant' => [
 492             'callback' => 'CRM_Core_SelectValues::memberAutoRenew',
 493           ]
 494         ],
 495         'is_active' => [
 496           'name' => 'is_active',
 497           'type' => CRM_Utils_Type::T_BOOLEAN,
 498           'title' => ts('Is Active'),
 499           'description' => 'Is this membership_type enabled',
 500           'default' => '1',
 501           'table_name' => 'civicrm_membership_type',
 502           'entity' => 'MembershipType',
 503           'bao' => 'CRM_Member_BAO_MembershipType',
 504           'localizable' => 0,
 505           'html' => [
 506             'type' => 'CheckBox',
 507             'label' => ts("Enabled?"),
 508           ],
 509         ],
 510       ];
 511       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 512     }
 513     return Civi::$statics[__CLASS__]['fields'];
 514   }
 515
 516   /**
 517    * Return a mapping from field-name to the corresponding key (as used in fields()).
 518    *
 519    * @return array
 520    *   Array(string $name => string $uniqueName).
 521    */
 522   public static function &fieldKeys() {
 523     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 524       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 525     }
 526     return Civi::$statics[__CLASS__]['fieldKeys'];
 527   }
 528
 529   /**
 530    * Returns the names of this table
 531    *
 532    * @return string
 533    */
 534   public static function getTableName() {
 535     return CRM_Core_DAO::getLocaleTableName(self::$_tableName);
 536   }
 537
 538   /**
 539    * Returns if this table needs to be logged
 540    *
 541    * @return bool
 542    */
 543   public function getLog() {
 544     return self::$_log;
 545   }
 546
 547   /**
 548    * Returns the list of fields that can be imported
 549    *
 550    * @param bool $prefix
 551    *
 552    * @return array
 553    */
 554   public static function &import($prefix = FALSE) {
 555     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'membership_type', $prefix, []);
 556     return $r;
 557   }
 558
 559   /**
 560    * Returns the list of fields that can be exported
 561    *
 562    * @param bool $prefix
 563    *
 564    * @return array
 565    */
 566   public static function &export($prefix = FALSE) {
 567     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'membership_type', $prefix, []);
 568     return $r;
 569   }
 570
 571   /**
 572    * Returns the list of indices
 573    *
 574    * @param bool $localize
 575    *
 576    * @return array
 577    */
 578   public static function indices($localize = TRUE) {
 579     $indices = [
 580       'index_relationship_type_id' => [
 581         'name' => 'index_relationship_type_id',
 582         'field' => [
 583           0 => 'relationship_type_id',
 584         ],
 585         'localizable' => FALSE,
 586         'sig' => 'civicrm_membership_type::0::relationship_type_id',
 587       ],
 588     ];
 589     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 590   }
 591
 592 }