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:a110ab7dd0e4be40f840eae85b85048b)
  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           'readonly' => TRUE,
 153           'add' => '1.5',
 154         ],
 155         'membership_id' => [
 156           'name' => 'membership_id',
 157           'type' => CRM_Utils_Type::T_INT,
 158           'title' => ts('Membership ID'),
 159           'description' => ts('FK to Membership table'),
 160           'required' => TRUE,
 161           'where' => 'civicrm_membership_log.membership_id',
 162           'table_name' => 'civicrm_membership_log',
 163           'entity' => 'MembershipLog',
 164           'bao' => 'CRM_Member_BAO_MembershipLog',
 165           'localizable' => 0,
 166           'FKClassName' => 'CRM_Member_DAO_Membership',
 167           'html' => [
 168             'label' => ts("Membership"),
 169           ],
 170           'add' => '1.5',
 171         ],
 172         'status_id' => [
 173           'name' => 'status_id',
 174           'type' => CRM_Utils_Type::T_INT,
 175           'title' => ts('Membership Status ID'),
 176           'description' => ts('New status assigned to membership by this action. FK to Membership Status'),
 177           'required' => TRUE,
 178           'where' => 'civicrm_membership_log.status_id',
 179           'table_name' => 'civicrm_membership_log',
 180           'entity' => 'MembershipLog',
 181           'bao' => 'CRM_Member_BAO_MembershipLog',
 182           'localizable' => 0,
 183           'FKClassName' => 'CRM_Member_DAO_MembershipStatus',
 184           'html' => [
 185             'label' => ts("Membership Status"),
 186           ],
 187           'add' => '1.5',
 188         ],
 189         'start_date' => [
 190           'name' => 'start_date',
 191           'type' => CRM_Utils_Type::T_DATE,
 192           'title' => ts('Membership Log Start Date'),
 193           'description' => ts('New membership period start date'),
 194           'where' => 'civicrm_membership_log.start_date',
 195           'dataPattern' => '/\d{4}-?\d{2}-?\d{2}/',
 196           'table_name' => 'civicrm_membership_log',
 197           'entity' => 'MembershipLog',
 198           'bao' => 'CRM_Member_BAO_MembershipLog',
 199           'localizable' => 0,
 200           'add' => '1.5',
 201         ],
 202         'end_date' => [
 203           'name' => 'end_date',
 204           'type' => CRM_Utils_Type::T_DATE,
 205           'title' => ts('Membership Log End Date'),
 206           'description' => ts('New membership period expiration date.'),
 207           'where' => 'civicrm_membership_log.end_date',
 208           'dataPattern' => '/\d{4}-?\d{2}-?\d{2}/',
 209           'table_name' => 'civicrm_membership_log',
 210           'entity' => 'MembershipLog',
 211           'bao' => 'CRM_Member_BAO_MembershipLog',
 212           'localizable' => 0,
 213           'add' => '1.5',
 214         ],
 215         'modified_id' => [
 216           'name' => 'modified_id',
 217           'type' => CRM_Utils_Type::T_INT,
 218           'title' => ts('Modified By Contact ID'),
 219           'description' => ts('FK to Contact ID of person under whose credentials this data modification was made.'),
 220           'where' => 'civicrm_membership_log.modified_id',
 221           'table_name' => 'civicrm_membership_log',
 222           'entity' => 'MembershipLog',
 223           'bao' => 'CRM_Member_BAO_MembershipLog',
 224           'localizable' => 0,
 225           'FKClassName' => 'CRM_Contact_DAO_Contact',
 226           'html' => [
 227             'label' => ts("Modified By"),
 228           ],
 229           'readonly' => TRUE,
 230           'add' => '1.5',
 231         ],
 232         'modified_date' => [
 233           'name' => 'modified_date',
 234           'type' => CRM_Utils_Type::T_DATE,
 235           'title' => ts('Membership Change Date'),
 236           'description' => ts('Date this membership modification action was logged.'),
 237           'where' => 'civicrm_membership_log.modified_date',
 238           'dataPattern' => '/\d{4}-?\d{2}-?\d{2}/',
 239           'table_name' => 'civicrm_membership_log',
 240           'entity' => 'MembershipLog',
 241           'bao' => 'CRM_Member_BAO_MembershipLog',
 242           'localizable' => 0,
 243           'add' => '1.5',
 244         ],
 245         'membership_type_id' => [
 246           'name' => 'membership_type_id',
 247           'type' => CRM_Utils_Type::T_INT,
 248           'title' => ts('Membership Type ID'),
 249           'description' => ts('FK to Membership Type.'),
 250           'where' => 'civicrm_membership_log.membership_type_id',
 251           'table_name' => 'civicrm_membership_log',
 252           'entity' => 'MembershipLog',
 253           'bao' => 'CRM_Member_BAO_MembershipLog',
 254           'localizable' => 0,
 255           'FKClassName' => 'CRM_Member_DAO_MembershipType',
 256           'html' => [
 257             'label' => ts("Membership Type"),
 258           ],
 259           'add' => '3.4',
 260         ],
 261         'max_related' => [
 262           'name' => 'max_related',
 263           'type' => CRM_Utils_Type::T_INT,
 264           'title' => ts('Maximum Related Memberships'),
 265           'description' => ts('Maximum number of related memberships.'),
 266           'where' => 'civicrm_membership_log.max_related',
 267           'table_name' => 'civicrm_membership_log',
 268           'entity' => 'MembershipLog',
 269           'bao' => 'CRM_Member_BAO_MembershipLog',
 270           'localizable' => 0,
 271           'add' => '4.3',
 272         ],
 273       ];
 274       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 275     }
 276     return Civi::$statics[__CLASS__]['fields'];
 277   }
 278
 279   /**
 280    * Return a mapping from field-name to the corresponding key (as used in fields()).
 281    *
 282    * @return array
 283    *   Array(string $name => string $uniqueName).
 284    */
 285   public static function &fieldKeys() {
 286     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 287       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 288     }
 289     return Civi::$statics[__CLASS__]['fieldKeys'];
 290   }
 291
 292   /**
 293    * Returns the names of this table
 294    *
 295    * @return string
 296    */
 297   public static function getTableName() {
 298     return self::$_tableName;
 299   }
 300
 301   /**
 302    * Returns if this table needs to be logged
 303    *
 304    * @return bool
 305    */
 306   public function getLog() {
 307     return self::$_log;
 308   }
 309
 310   /**
 311    * Returns the list of fields that can be imported
 312    *
 313    * @param bool $prefix
 314    *
 315    * @return array
 316    */
 317   public static function &import($prefix = FALSE) {
 318     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'membership_log', $prefix, []);
 319     return $r;
 320   }
 321
 322   /**
 323    * Returns the list of fields that can be exported
 324    *
 325    * @param bool $prefix
 326    *
 327    * @return array
 328    */
 329   public static function &export($prefix = FALSE) {
 330     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'membership_log', $prefix, []);
 331     return $r;
 332   }
 333
 334   /**
 335    * Returns the list of indices
 336    *
 337    * @param bool $localize
 338    *
 339    * @return array
 340    */
 341   public static function indices($localize = TRUE) {
 342     $indices = [];
 343     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 344   }
 345
 346 }