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