CRM/Member/DAO/MembershipLog.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2019
   6  *
   7  * Generated from xml/schema/CRM/Member/MembershipLog.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:2cb06011cc106182d7274c894fa14a0b)
  10  */
  11
  12 /**
  13  * Database access object for the MembershipLog entity.
  14  */
  15 class CRM_Member_DAO_MembershipLog 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_log';
  23
  24   /**
  25    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  26    *
  27    * @var bool
  28    */
  29   public static $_log = TRUE;
  30
  31   /**
  32    * @var int unsigned
  33    */
  34   public $id;
  35
  36   /**
  37    * FK to Membership table
  38    *
  39    * @var int unsigned
  40    */
  41   public $membership_id;
  42
  43   /**
  44    * New status assigned to membership by this action. FK to Membership Status
  45    *
  46    * @var int unsigned
  47    */
  48   public $status_id;
  49
  50   /**
  51    * New membership period start date
  52    *
  53    * @var date
  54    */
  55   public $start_date;
  56
  57   /**
  58    * New membership period expiration date.
  59    *
  60    * @var date
  61    */
  62   public $end_date;
  63
  64   /**
  65    * FK to Contact ID of person under whose credentials this data modification was made.
  66    *
  67    * @var int unsigned
  68    */
  69   public $modified_id;
  70
  71   /**
  72    * Date this membership modification action was logged.
  73    *
  74    * @var date
  75    */
  76   public $modified_date;
  77
  78   /**
  79    * FK to Membership Type.
  80    *
  81    * @var int unsigned
  82    */
  83   public $membership_type_id;
  84
  85   /**
  86    * Maximum number of related memberships.
  87    *
  88    * @var int
  89    */
  90   public $max_related;
  91
  92   /**
  93    * Class constructor.
  94    */
  95   public function __construct() {
  96     $this->__table = 'civicrm_membership_log';
  97     parent::__construct();
  98   }
  99
 100   /**
 101    * Returns foreign keys and entity references.
 102    *
 103    * @return array
 104    *   [CRM_Core_Reference_Interface]
 105    */
 106   public static function getReferenceColumns() {
 107     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 108       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
 109       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'membership_id', 'civicrm_membership', 'id');
 110       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'status_id', 'civicrm_membership_status', 'id');
 111       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'modified_id', 'civicrm_contact', 'id');
 112       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'membership_type_id', 'civicrm_membership_type', 'id');
 113       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 114     }
 115     return Civi::$statics[__CLASS__]['links'];
 116   }
 117
 118   /**
 119    * Returns all the column names of this table
 120    *
 121    * @return array
 122    */
 123   public static function &fields() {
 124     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 125       Civi::$statics[__CLASS__]['fields'] = [
 126         'id' => [
 127           'name' => 'id',
 128           'type' => CRM_Utils_Type::T_INT,
 129           'title' => ts('Membership Log ID'),
 130           'required' => TRUE,
 131           'where' => 'civicrm_membership_log.id',
 132           'table_name' => 'civicrm_membership_log',
 133           'entity' => 'MembershipLog',
 134           'bao' => 'CRM_Member_BAO_MembershipLog',
 135           'localizable' => 0,
 136         ],
 137         'membership_id' => [
 138           'name' => 'membership_id',
 139           'type' => CRM_Utils_Type::T_INT,
 140           'title' => ts('Membership ID'),
 141           'description' => ts('FK to Membership table'),
 142           'required' => TRUE,
 143           'where' => 'civicrm_membership_log.membership_id',
 144           'table_name' => 'civicrm_membership_log',
 145           'entity' => 'MembershipLog',
 146           'bao' => 'CRM_Member_BAO_MembershipLog',
 147           'localizable' => 0,
 148           'FKClassName' => 'CRM_Member_DAO_Membership',
 149         ],
 150         'status_id' => [
 151           'name' => 'status_id',
 152           'type' => CRM_Utils_Type::T_INT,
 153           'title' => ts('Membership Status'),
 154           'description' => ts('New status assigned to membership by this action. FK to Membership Status'),
 155           'required' => TRUE,
 156           'where' => 'civicrm_membership_log.status_id',
 157           'table_name' => 'civicrm_membership_log',
 158           'entity' => 'MembershipLog',
 159           'bao' => 'CRM_Member_BAO_MembershipLog',
 160           'localizable' => 0,
 161           'FKClassName' => 'CRM_Member_DAO_MembershipStatus',
 162         ],
 163         'start_date' => [
 164           'name' => 'start_date',
 165           'type' => CRM_Utils_Type::T_DATE,
 166           'title' => ts('Membership Log Start Date'),
 167           'description' => ts('New membership period start date'),
 168           'where' => 'civicrm_membership_log.start_date',
 169           'dataPattern' => '/\d{4}-?\d{2}-?\d{2}/',
 170           'table_name' => 'civicrm_membership_log',
 171           'entity' => 'MembershipLog',
 172           'bao' => 'CRM_Member_BAO_MembershipLog',
 173           'localizable' => 0,
 174         ],
 175         'end_date' => [
 176           'name' => 'end_date',
 177           'type' => CRM_Utils_Type::T_DATE,
 178           'title' => ts('Membership Log End Date'),
 179           'description' => ts('New membership period expiration date.'),
 180           'where' => 'civicrm_membership_log.end_date',
 181           'dataPattern' => '/\d{4}-?\d{2}-?\d{2}/',
 182           'table_name' => 'civicrm_membership_log',
 183           'entity' => 'MembershipLog',
 184           'bao' => 'CRM_Member_BAO_MembershipLog',
 185           'localizable' => 0,
 186         ],
 187         'modified_id' => [
 188           'name' => 'modified_id',
 189           'type' => CRM_Utils_Type::T_INT,
 190           'title' => ts('Membership Log modified By'),
 191           'description' => ts('FK to Contact ID of person under whose credentials this data modification was made.'),
 192           'where' => 'civicrm_membership_log.modified_id',
 193           'table_name' => 'civicrm_membership_log',
 194           'entity' => 'MembershipLog',
 195           'bao' => 'CRM_Member_BAO_MembershipLog',
 196           'localizable' => 0,
 197           'FKClassName' => 'CRM_Contact_DAO_Contact',
 198         ],
 199         'modified_date' => [
 200           'name' => 'modified_date',
 201           'type' => CRM_Utils_Type::T_DATE,
 202           'title' => ts('Membership Change Date'),
 203           'description' => ts('Date this membership modification action was logged.'),
 204           'where' => 'civicrm_membership_log.modified_date',
 205           'dataPattern' => '/\d{4}-?\d{2}-?\d{2}/',
 206           'table_name' => 'civicrm_membership_log',
 207           'entity' => 'MembershipLog',
 208           'bao' => 'CRM_Member_BAO_MembershipLog',
 209           'localizable' => 0,
 210         ],
 211         'membership_type_id' => [
 212           'name' => 'membership_type_id',
 213           'type' => CRM_Utils_Type::T_INT,
 214           'title' => ts('Membership Type ID'),
 215           'description' => ts('FK to Membership Type.'),
 216           'where' => 'civicrm_membership_log.membership_type_id',
 217           'table_name' => 'civicrm_membership_log',
 218           'entity' => 'MembershipLog',
 219           'bao' => 'CRM_Member_BAO_MembershipLog',
 220           'localizable' => 0,
 221           'FKClassName' => 'CRM_Member_DAO_MembershipType',
 222         ],
 223         'max_related' => [
 224           'name' => 'max_related',
 225           'type' => CRM_Utils_Type::T_INT,
 226           'title' => ts('Maximum Related Memberships'),
 227           'description' => ts('Maximum number of related memberships.'),
 228           'where' => 'civicrm_membership_log.max_related',
 229           'table_name' => 'civicrm_membership_log',
 230           'entity' => 'MembershipLog',
 231           'bao' => 'CRM_Member_BAO_MembershipLog',
 232           'localizable' => 0,
 233         ],
 234       ];
 235       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 236     }
 237     return Civi::$statics[__CLASS__]['fields'];
 238   }
 239
 240   /**
 241    * Return a mapping from field-name to the corresponding key (as used in fields()).
 242    *
 243    * @return array
 244    *   Array(string $name => string $uniqueName).
 245    */
 246   public static function &fieldKeys() {
 247     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 248       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 249     }
 250     return Civi::$statics[__CLASS__]['fieldKeys'];
 251   }
 252
 253   /**
 254    * Returns the names of this table
 255    *
 256    * @return string
 257    */
 258   public static function getTableName() {
 259     return self::$_tableName;
 260   }
 261
 262   /**
 263    * Returns if this table needs to be logged
 264    *
 265    * @return bool
 266    */
 267   public function getLog() {
 268     return self::$_log;
 269   }
 270
 271   /**
 272    * Returns the list of fields that can be imported
 273    *
 274    * @param bool $prefix
 275    *
 276    * @return array
 277    */
 278   public static function &import($prefix = FALSE) {
 279     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'membership_log', $prefix, []);
 280     return $r;
 281   }
 282
 283   /**
 284    * Returns the list of fields that can be exported
 285    *
 286    * @param bool $prefix
 287    *
 288    * @return array
 289    */
 290   public static function &export($prefix = FALSE) {
 291     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'membership_log', $prefix, []);
 292     return $r;
 293   }
 294
 295   /**
 296    * Returns the list of indices
 297    *
 298    * @param bool $localize
 299    *
 300    * @return array
 301    */
 302   public static function indices($localize = TRUE) {
 303     $indices = [];
 304     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 305   }
 306
 307 }