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