CRM/Member/DAO/MembershipLog.php

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