CRM/Member/DAO/Membership.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Member/Membership.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:9a307c1a63b4df70ae38f36ce4171cb6)
  10  */
  11
  12 /**
  13  * Database access object for the Membership entity.
  14  */
  15 class CRM_Member_DAO_Membership extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   public static $_tableName = 'civicrm_membership';
  23
  24   /**
  25    * Icon associated with this entity.
  26    *
  27    * @var string
  28    */
  29   public static $_icon = 'fa-id-badge';
  30
  31   /**
  32    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  33    *
  34    * @var bool
  35    */
  36   public static $_log = TRUE;
  37
  38   /**
  39    * Membership Id
  40    *
  41    * @var int
  42    */
  43   public $id;
  44
  45   /**
  46    * FK to Contact ID
  47    *
  48    * @var int
  49    */
  50   public $contact_id;
  51
  52   /**
  53    * FK to Membership Type
  54    *
  55    * @var int
  56    */
  57   public $membership_type_id;
  58
  59   /**
  60    * Beginning of initial membership period (member since...).
  61    *
  62    * @var date
  63    */
  64   public $join_date;
  65
  66   /**
  67    * Beginning of current uninterrupted membership period.
  68    *
  69    * @var date
  70    */
  71   public $start_date;
  72
  73   /**
  74    * Current membership period expire date.
  75    *
  76    * @var date
  77    */
  78   public $end_date;
  79
  80   /**
  81    * @var string
  82    */
  83   public $source;
  84
  85   /**
  86    * FK to Membership Status
  87    *
  88    * @var int
  89    */
  90   public $status_id;
  91
  92   /**
  93    * Admin users may set a manual status which overrides the calculated status. When this flag is true, automated status update scripts should NOT modify status for the record.
  94    *
  95    * @var bool
  96    */
  97   public $is_override;
  98
  99   /**
 100    * Then end date of membership status override if 'Override until selected date' override type is selected.
 101    *
 102    * @var date
 103    */
 104   public $status_override_end_date;
 105
 106   /**
 107    * Optional FK to Parent Membership.
 108    *
 109    * @var int
 110    */
 111   public $owner_membership_id;
 112
 113   /**
 114    * Maximum number of related memberships (membership_type override).
 115    *
 116    * @var int
 117    */
 118   public $max_related;
 119
 120   /**
 121    * @var bool
 122    */
 123   public $is_test;
 124
 125   /**
 126    * @var bool
 127    */
 128   public $is_pay_later;
 129
 130   /**
 131    * Conditional foreign key to civicrm_contribution_recur id. Each membership in connection with a recurring contribution carries a foreign key to the recurring contribution record. This assumes we can track these processor initiated events.
 132    *
 133    * @var int
 134    */
 135   public $contribution_recur_id;
 136
 137   /**
 138    * The campaign for which this membership is attached.
 139    *
 140    * @var int
 141    */
 142   public $campaign_id;
 143
 144   /**
 145    * Class constructor.
 146    */
 147   public function __construct() {
 148     $this->__table = 'civicrm_membership';
 149     parent::__construct();
 150   }
 151
 152   /**
 153    * Returns localized title of this entity.
 154    */
 155   public static function getEntityTitle() {
 156     return ts('Memberships');
 157   }
 158
 159   /**
 160    * Returns foreign keys and entity references.
 161    *
 162    * @return array
 163    *   [CRM_Core_Reference_Interface]
 164    */
 165   public static function getReferenceColumns() {
 166     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 167       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
 168       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id', 'civicrm_contact', 'id');
 169       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'membership_type_id', 'civicrm_membership_type', 'id');
 170       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'status_id', 'civicrm_membership_status', 'id');
 171       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'owner_membership_id', 'civicrm_membership', 'id');
 172       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contribution_recur_id', 'civicrm_contribution_recur', 'id');
 173       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'campaign_id', 'civicrm_campaign', 'id');
 174       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 175     }
 176     return Civi::$statics[__CLASS__]['links'];
 177   }
 178
 179   /**
 180    * Returns all the column names of this table
 181    *
 182    * @return array
 183    */
 184   public static function &fields() {
 185     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 186       Civi::$statics[__CLASS__]['fields'] = [
 187         'membership_id' => [
 188           'name' => 'id',
 189           'type' => CRM_Utils_Type::T_INT,
 190           'title' => ts('Membership ID'),
 191           'description' => ts('Membership Id'),
 192           'required' => TRUE,
 193           'import' => TRUE,
 194           'where' => 'civicrm_membership.id',
 195           'headerPattern' => '/^(m(embership\s)?id)$/i',
 196           'export' => TRUE,
 197           'table_name' => 'civicrm_membership',
 198           'entity' => 'Membership',
 199           'bao' => 'CRM_Member_BAO_Membership',
 200           'localizable' => 0,
 201           'add' => '1.5',
 202         ],
 203         'membership_contact_id' => [
 204           'name' => 'contact_id',
 205           'type' => CRM_Utils_Type::T_INT,
 206           'title' => ts('Contact ID'),
 207           'description' => ts('FK to Contact ID'),
 208           'required' => TRUE,
 209           'import' => TRUE,
 210           'where' => 'civicrm_membership.contact_id',
 211           'headerPattern' => '/contact(.?id)?/i',
 212           'dataPattern' => '/^\d+$/',
 213           'export' => TRUE,
 214           'table_name' => 'civicrm_membership',
 215           'entity' => 'Membership',
 216           'bao' => 'CRM_Member_BAO_Membership',
 217           'localizable' => 0,
 218           'FKClassName' => 'CRM_Contact_DAO_Contact',
 219           'html' => [
 220             'type' => 'EntityRef',
 221           ],
 222           'add' => '1.5',
 223         ],
 224         'membership_type_id' => [
 225           'name' => 'membership_type_id',
 226           'type' => CRM_Utils_Type::T_INT,
 227           'title' => ts('Membership Type Id'),
 228           'description' => ts('FK to Membership Type'),
 229           'required' => TRUE,
 230           'import' => TRUE,
 231           'where' => 'civicrm_membership.membership_type_id',
 232           'headerPattern' => '/^(m(embership\s)?type)$/i',
 233           'export' => FALSE,
 234           'table_name' => 'civicrm_membership',
 235           'entity' => 'Membership',
 236           'bao' => 'CRM_Member_BAO_Membership',
 237           'localizable' => 0,
 238           'FKClassName' => 'CRM_Member_DAO_MembershipType',
 239           'html' => [
 240             'type' => 'Select',
 241             'label' => ts("Membership Type"),
 242           ],
 243           'pseudoconstant' => [
 244             'table' => 'civicrm_membership_type',
 245             'keyColumn' => 'id',
 246             'labelColumn' => 'name',
 247           ],
 248           'add' => '1.5',
 249         ],
 250         'membership_join_date' => [
 251           'name' => 'join_date',
 252           'type' => CRM_Utils_Type::T_DATE,
 253           'title' => ts('Member Since'),
 254           'description' => ts('Beginning of initial membership period (member since...).'),
 255           'import' => TRUE,
 256           'where' => 'civicrm_membership.join_date',
 257           'headerPattern' => '/^join|(j(oin\s)?date)$/i',
 258           'dataPattern' => '/\d{4}-?\d{2}-?\d{2}/',
 259           'export' => TRUE,
 260           'table_name' => 'civicrm_membership',
 261           'entity' => 'Membership',
 262           'bao' => 'CRM_Member_BAO_Membership',
 263           'localizable' => 0,
 264           'html' => [
 265             'type' => 'Select Date',
 266             'formatType' => 'activityDate',
 267           ],
 268           'add' => '1.5',
 269         ],
 270         'membership_start_date' => [
 271           'name' => 'start_date',
 272           'type' => CRM_Utils_Type::T_DATE,
 273           'title' => ts('Membership Start Date'),
 274           'description' => ts('Beginning of current uninterrupted membership period.'),
 275           'import' => TRUE,
 276           'where' => 'civicrm_membership.start_date',
 277           'headerPattern' => '/(member(ship)?.)?start(s)?(.date$)?/i',
 278           'dataPattern' => '/\d{4}-?\d{2}-?\d{2}/',
 279           'export' => TRUE,
 280           'table_name' => 'civicrm_membership',
 281           'entity' => 'Membership',
 282           'bao' => 'CRM_Member_BAO_Membership',
 283           'localizable' => 0,
 284           'html' => [
 285             'type' => 'Select Date',
 286             'formatType' => 'activityDate',
 287           ],
 288           'add' => '1.5',
 289         ],
 290         'membership_end_date' => [
 291           'name' => 'end_date',
 292           'type' => CRM_Utils_Type::T_DATE,
 293           'title' => ts('Membership Expiration Date'),
 294           'description' => ts('Current membership period expire date.'),
 295           'import' => TRUE,
 296           'where' => 'civicrm_membership.end_date',
 297           'headerPattern' => '/(member(ship)?.)?end(s)?(.date$)?/i',
 298           'dataPattern' => '/\d{4}-?\d{2}-?\d{2}/',
 299           'export' => TRUE,
 300           'table_name' => 'civicrm_membership',
 301           'entity' => 'Membership',
 302           'bao' => 'CRM_Member_BAO_Membership',
 303           'localizable' => 0,
 304           'html' => [
 305             'type' => 'Select Date',
 306             'formatType' => 'activityDate',
 307           ],
 308           'add' => '1.5',
 309         ],
 310         'membership_source' => [
 311           'name' => 'source',
 312           'type' => CRM_Utils_Type::T_STRING,
 313           'title' => ts('Source'),
 314           'maxlength' => 128,
 315           'size' => CRM_Utils_Type::HUGE,
 316           'import' => TRUE,
 317           'where' => 'civicrm_membership.source',
 318           'headerPattern' => '/^(member(ship?))?source$/i',
 319           'export' => TRUE,
 320           'table_name' => 'civicrm_membership',
 321           'entity' => 'Membership',
 322           'bao' => 'CRM_Member_BAO_Membership',
 323           'localizable' => 0,
 324           'html' => [
 325             'type' => 'Text',
 326           ],
 327           'add' => '1.5',
 328         ],
 329         'status_id' => [
 330           'name' => 'status_id',
 331           'type' => CRM_Utils_Type::T_INT,
 332           'title' => ts('Membership Status Id'),
 333           'description' => ts('FK to Membership Status'),
 334           'required' => TRUE,
 335           'import' => TRUE,
 336           'where' => 'civicrm_membership.status_id',
 337           'headerPattern' => '/(member(ship|).)?(status)$/i',
 338           'export' => FALSE,
 339           'table_name' => 'civicrm_membership',
 340           'entity' => 'Membership',
 341           'bao' => 'CRM_Member_BAO_Membership',
 342           'localizable' => 0,
 343           'FKClassName' => 'CRM_Member_DAO_MembershipStatus',
 344           'html' => [
 345             'type' => 'Select',
 346           ],
 347           'pseudoconstant' => [
 348             'table' => 'civicrm_membership_status',
 349             'keyColumn' => 'id',
 350             'labelColumn' => 'label',
 351           ],
 352           'add' => '1.5',
 353         ],
 354         'member_is_override' => [
 355           'name' => 'is_override',
 356           'type' => CRM_Utils_Type::T_BOOLEAN,
 357           'title' => ts('Status Override'),
 358           'description' => ts('Admin users may set a manual status which overrides the calculated status. When this flag is true, automated status update scripts should NOT modify status for the record.'),
 359           'import' => TRUE,
 360           'where' => 'civicrm_membership.is_override',
 361           'headerPattern' => '/override$/i',
 362           'export' => TRUE,
 363           'table_name' => 'civicrm_membership',
 364           'entity' => 'Membership',
 365           'bao' => 'CRM_Member_BAO_Membership',
 366           'localizable' => 0,
 367           'html' => [
 368             'type' => 'CheckBox',
 369           ],
 370           'add' => '1.5',
 371         ],
 372         'status_override_end_date' => [
 373           'name' => 'status_override_end_date',
 374           'type' => CRM_Utils_Type::T_DATE,
 375           'title' => ts('Status Override End Date'),
 376           'description' => ts('Then end date of membership status override if \'Override until selected date\' override type is selected.'),
 377           'import' => TRUE,
 378           'where' => 'civicrm_membership.status_override_end_date',
 379           'export' => TRUE,
 380           'default' => 'NULL',
 381           'table_name' => 'civicrm_membership',
 382           'entity' => 'Membership',
 383           'bao' => 'CRM_Member_BAO_Membership',
 384           'localizable' => 0,
 385           'html' => [
 386             'type' => 'Select Date',
 387             'formatType' => 'activityDate',
 388           ],
 389           'add' => '4.7',
 390         ],
 391         'owner_membership_id' => [
 392           'name' => 'owner_membership_id',
 393           'type' => CRM_Utils_Type::T_INT,
 394           'title' => ts('Primary Member ID'),
 395           'description' => ts('Optional FK to Parent Membership.'),
 396           'where' => 'civicrm_membership.owner_membership_id',
 397           'export' => TRUE,
 398           'table_name' => 'civicrm_membership',
 399           'entity' => 'Membership',
 400           'bao' => 'CRM_Member_BAO_Membership',
 401           'localizable' => 0,
 402           'FKClassName' => 'CRM_Member_DAO_Membership',
 403           'add' => '1.7',
 404         ],
 405         'max_related' => [
 406           'name' => 'max_related',
 407           'type' => CRM_Utils_Type::T_INT,
 408           'title' => ts('Max Related'),
 409           'description' => ts('Maximum number of related memberships (membership_type override).'),
 410           'where' => 'civicrm_membership.max_related',
 411           'export' => TRUE,
 412           'table_name' => 'civicrm_membership',
 413           'entity' => 'Membership',
 414           'bao' => 'CRM_Member_BAO_Membership',
 415           'localizable' => 0,
 416           'html' => [
 417             'type' => 'Text',
 418           ],
 419           'add' => '4.3',
 420         ],
 421         'member_is_test' => [
 422           'name' => 'is_test',
 423           'type' => CRM_Utils_Type::T_BOOLEAN,
 424           'title' => ts('Test'),
 425           'import' => TRUE,
 426           'where' => 'civicrm_membership.is_test',
 427           'headerPattern' => '/(is.)?test(.member(ship)?)?/i',
 428           'export' => TRUE,
 429           'default' => '0',
 430           'table_name' => 'civicrm_membership',
 431           'entity' => 'Membership',
 432           'bao' => 'CRM_Member_BAO_Membership',
 433           'localizable' => 0,
 434           'html' => [
 435             'type' => 'CheckBox',
 436           ],
 437           'add' => NULL,
 438         ],
 439         'member_is_pay_later' => [
 440           'name' => 'is_pay_later',
 441           'type' => CRM_Utils_Type::T_BOOLEAN,
 442           'title' => ts('Is Pay Later'),
 443           'import' => TRUE,
 444           'where' => 'civicrm_membership.is_pay_later',
 445           'headerPattern' => '/(is.)?(pay(.)?later)$/i',
 446           'export' => TRUE,
 447           'default' => '0',
 448           'table_name' => 'civicrm_membership',
 449           'entity' => 'Membership',
 450           'bao' => 'CRM_Member_BAO_Membership',
 451           'localizable' => 0,
 452           'html' => [
 453             'type' => 'CheckBox',
 454           ],
 455           'add' => '2.1',
 456         ],
 457         'membership_recur_id' => [
 458           'name' => 'contribution_recur_id',
 459           'type' => CRM_Utils_Type::T_INT,
 460           'title' => ts('Membership Recurring Contribution'),
 461           'description' => ts('Conditional foreign key to civicrm_contribution_recur id. Each membership in connection with a recurring contribution carries a foreign key to the recurring contribution record. This assumes we can track these processor initiated events.'),
 462           'where' => 'civicrm_membership.contribution_recur_id',
 463           'export' => TRUE,
 464           'table_name' => 'civicrm_membership',
 465           'entity' => 'Membership',
 466           'bao' => 'CRM_Member_BAO_Membership',
 467           'localizable' => 0,
 468           'FKClassName' => 'CRM_Contribute_DAO_ContributionRecur',
 469           'add' => '3.3',
 470         ],
 471         'member_campaign_id' => [
 472           'name' => 'campaign_id',
 473           'type' => CRM_Utils_Type::T_INT,
 474           'title' => ts('Campaign'),
 475           'description' => ts('The campaign for which this membership is attached.'),
 476           'import' => TRUE,
 477           'where' => 'civicrm_membership.campaign_id',
 478           'export' => TRUE,
 479           'table_name' => 'civicrm_membership',
 480           'entity' => 'Membership',
 481           'bao' => 'CRM_Member_BAO_Membership',
 482           'localizable' => 0,
 483           'FKClassName' => 'CRM_Campaign_DAO_Campaign',
 484           'html' => [
 485             'type' => 'Select',
 486           ],
 487           'pseudoconstant' => [
 488             'table' => 'civicrm_campaign',
 489             'keyColumn' => 'id',
 490             'labelColumn' => 'title',
 491           ],
 492           'add' => '3.4',
 493         ],
 494       ];
 495       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 496     }
 497     return Civi::$statics[__CLASS__]['fields'];
 498   }
 499
 500   /**
 501    * Return a mapping from field-name to the corresponding key (as used in fields()).
 502    *
 503    * @return array
 504    *   Array(string $name => string $uniqueName).
 505    */
 506   public static function &fieldKeys() {
 507     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 508       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 509     }
 510     return Civi::$statics[__CLASS__]['fieldKeys'];
 511   }
 512
 513   /**
 514    * Returns the names of this table
 515    *
 516    * @return string
 517    */
 518   public static function getTableName() {
 519     return self::$_tableName;
 520   }
 521
 522   /**
 523    * Returns if this table needs to be logged
 524    *
 525    * @return bool
 526    */
 527   public function getLog() {
 528     return self::$_log;
 529   }
 530
 531   /**
 532    * Returns the list of fields that can be imported
 533    *
 534    * @param bool $prefix
 535    *
 536    * @return array
 537    */
 538   public static function &import($prefix = FALSE) {
 539     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'membership', $prefix, []);
 540     return $r;
 541   }
 542
 543   /**
 544    * Returns the list of fields that can be exported
 545    *
 546    * @param bool $prefix
 547    *
 548    * @return array
 549    */
 550   public static function &export($prefix = FALSE) {
 551     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'membership', $prefix, []);
 552     return $r;
 553   }
 554
 555   /**
 556    * Returns the list of indices
 557    *
 558    * @param bool $localize
 559    *
 560    * @return array
 561    */
 562   public static function indices($localize = TRUE) {
 563     $indices = [
 564       'index_owner_membership_id' => [
 565         'name' => 'index_owner_membership_id',
 566         'field' => [
 567           0 => 'owner_membership_id',
 568         ],
 569         'localizable' => FALSE,
 570         'sig' => 'civicrm_membership::0::owner_membership_id',
 571       ],
 572     ];
 573     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 574   }
 575
 576 }