CRM/Member/DAO/MembershipLog.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2018
   6  *
   7  * Generated from xml/schema/CRM/Member/MembershipLog.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:9182bcbeed0a05c3fed5f3027ba89668)
  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   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   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           'table_name' => 'civicrm_membership_log',
 132           'entity' => 'MembershipLog',
 133           'bao' => 'CRM_Member_BAO_MembershipLog',
 134           'localizable' => 0,
 135         ],
 136         'membership_id' => [
 137           'name' => 'membership_id',
 138           'type' => CRM_Utils_Type::T_INT,
 139           'title' => ts('Membership ID'),
 140           'description' => 'FK to Membership table',
 141           'required' => TRUE,
 142           'table_name' => 'civicrm_membership_log',
 143           'entity' => 'MembershipLog',
 144           'bao' => 'CRM_Member_BAO_MembershipLog',
 145           'localizable' => 0,
 146           'FKClassName' => 'CRM_Member_DAO_Membership',
 147         ],
 148         'status_id' => [
 149           'name' => 'status_id',
 150           'type' => CRM_Utils_Type::T_INT,
 151           'title' => ts('Membership Status'),
 152           'description' => 'New status assigned to membership by this action. FK to Membership Status',
 153           'required' => TRUE,
 154           'table_name' => 'civicrm_membership_log',
 155           'entity' => 'MembershipLog',
 156           'bao' => 'CRM_Member_BAO_MembershipLog',
 157           'localizable' => 0,
 158           'FKClassName' => 'CRM_Member_DAO_MembershipStatus',
 159         ],
 160         'start_date' => [
 161           'name' => 'start_date',
 162           'type' => CRM_Utils_Type::T_DATE,
 163           'title' => ts('Membership Log Start Date'),
 164           'description' => 'New membership period start date',
 165           'table_name' => 'civicrm_membership_log',
 166           'entity' => 'MembershipLog',
 167           'bao' => 'CRM_Member_BAO_MembershipLog',
 168           'localizable' => 0,
 169         ],
 170         'end_date' => [
 171           'name' => 'end_date',
 172           'type' => CRM_Utils_Type::T_DATE,
 173           'title' => ts('Membership Log End Date'),
 174           'description' => 'New membership period expiration date.',
 175           'table_name' => 'civicrm_membership_log',
 176           'entity' => 'MembershipLog',
 177           'bao' => 'CRM_Member_BAO_MembershipLog',
 178           'localizable' => 0,
 179         ],
 180         'modified_id' => [
 181           'name' => 'modified_id',
 182           'type' => CRM_Utils_Type::T_INT,
 183           'title' => ts('Membership Log modified By'),
 184           'description' => 'FK to Contact ID of person under whose credentials this data modification was made.',
 185           'table_name' => 'civicrm_membership_log',
 186           'entity' => 'MembershipLog',
 187           'bao' => 'CRM_Member_BAO_MembershipLog',
 188           'localizable' => 0,
 189           'FKClassName' => 'CRM_Contact_DAO_Contact',
 190         ],
 191         'modified_date' => [
 192           'name' => 'modified_date',
 193           'type' => CRM_Utils_Type::T_DATE,
 194           'title' => ts('Membership Change Date'),
 195           'description' => 'Date this membership modification action was logged.',
 196           'table_name' => 'civicrm_membership_log',
 197           'entity' => 'MembershipLog',
 198           'bao' => 'CRM_Member_BAO_MembershipLog',
 199           'localizable' => 0,
 200         ],
 201         'membership_type_id' => [
 202           'name' => 'membership_type_id',
 203           'type' => CRM_Utils_Type::T_INT,
 204           'title' => ts('Membership Type ID'),
 205           'description' => 'FK to Membership Type.',
 206           'table_name' => 'civicrm_membership_log',
 207           'entity' => 'MembershipLog',
 208           'bao' => 'CRM_Member_BAO_MembershipLog',
 209           'localizable' => 0,
 210           'FKClassName' => 'CRM_Member_DAO_MembershipType',
 211         ],
 212         'max_related' => [
 213           'name' => 'max_related',
 214           'type' => CRM_Utils_Type::T_INT,
 215           'title' => ts('Maximum Related Memberships'),
 216           'description' => 'Maximum number of related memberships.',
 217           'table_name' => 'civicrm_membership_log',
 218           'entity' => 'MembershipLog',
 219           'bao' => 'CRM_Member_BAO_MembershipLog',
 220           'localizable' => 0,
 221         ],
 222       ];
 223       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 224     }
 225     return Civi::$statics[__CLASS__]['fields'];
 226   }
 227
 228   /**
 229    * Return a mapping from field-name to the corresponding key (as used in fields()).
 230    *
 231    * @return array
 232    *   Array(string $name => string $uniqueName).
 233    */
 234   public static function &fieldKeys() {
 235     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 236       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 237     }
 238     return Civi::$statics[__CLASS__]['fieldKeys'];
 239   }
 240
 241   /**
 242    * Returns the names of this table
 243    *
 244    * @return string
 245    */
 246   public static function getTableName() {
 247     return self::$_tableName;
 248   }
 249
 250   /**
 251    * Returns if this table needs to be logged
 252    *
 253    * @return bool
 254    */
 255   public function getLog() {
 256     return self::$_log;
 257   }
 258
 259   /**
 260    * Returns the list of fields that can be imported
 261    *
 262    * @param bool $prefix
 263    *
 264    * @return array
 265    */
 266   public static function &import($prefix = FALSE) {
 267     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'membership_log', $prefix, []);
 268     return $r;
 269   }
 270
 271   /**
 272    * Returns the list of fields that can be exported
 273    *
 274    * @param bool $prefix
 275    *
 276    * @return array
 277    */
 278   public static function &export($prefix = FALSE) {
 279     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'membership_log', $prefix, []);
 280     return $r;
 281   }
 282
 283   /**
 284    * Returns the list of indices
 285    *
 286    * @param bool $localize
 287    *
 288    * @return array
 289    */
 290   public static function indices($localize = TRUE) {
 291     $indices = [];
 292     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 293   }
 294
 295 }