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