CRM/Core/DAO/Log.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Core/Log.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:3f7c58e17bdae8212004611d6fa2f6f3)
  10  */
  11
  12 /**
  13  * Database access object for the Log entity.
  14  */
  15 class CRM_Core_DAO_Log extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   public static $_tableName = 'civicrm_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 = FALSE;
  30
  31   /**
  32    * Log ID
  33    *
  34    * @var int
  35    */
  36   public $id;
  37
  38   /**
  39    * Name of table where item being referenced is stored.
  40    *
  41    * @var string
  42    */
  43   public $entity_table;
  44
  45   /**
  46    * Foreign key to the referenced item.
  47    *
  48    * @var int
  49    */
  50   public $entity_id;
  51
  52   /**
  53    * Updates does to this object if any.
  54    *
  55    * @var text
  56    */
  57   public $data;
  58
  59   /**
  60    * FK to Contact ID of person under whose credentials this data modification was made.
  61    *
  62    * @var int
  63    */
  64   public $modified_id;
  65
  66   /**
  67    * When was the referenced entity created or modified or deleted.
  68    *
  69    * @var datetime
  70    */
  71   public $modified_date;
  72
  73   /**
  74    * Class constructor.
  75    */
  76   public function __construct() {
  77     $this->__table = 'civicrm_log';
  78     parent::__construct();
  79   }
  80
  81   /**
  82    * Returns localized title of this entity.
  83    */
  84   public static function getEntityTitle() {
  85     return ts('Logs');
  86   }
  87
  88   /**
  89    * Returns foreign keys and entity references.
  90    *
  91    * @return array
  92    *   [CRM_Core_Reference_Interface]
  93    */
  94   public static function getReferenceColumns() {
  95     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  96       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
  97       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'modified_id', 'civicrm_contact', 'id');
  98       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), 'entity_id', NULL, 'id', 'entity_table');
  99       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 100     }
 101     return Civi::$statics[__CLASS__]['links'];
 102   }
 103
 104   /**
 105    * Returns all the column names of this table
 106    *
 107    * @return array
 108    */
 109   public static function &fields() {
 110     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 111       Civi::$statics[__CLASS__]['fields'] = [
 112         'id' => [
 113           'name' => 'id',
 114           'type' => CRM_Utils_Type::T_INT,
 115           'title' => ts('Log ID'),
 116           'description' => ts('Log ID'),
 117           'required' => TRUE,
 118           'where' => 'civicrm_log.id',
 119           'table_name' => 'civicrm_log',
 120           'entity' => 'Log',
 121           'bao' => 'CRM_Core_BAO_Log',
 122           'localizable' => 0,
 123         ],
 124         'entity_table' => [
 125           'name' => 'entity_table',
 126           'type' => CRM_Utils_Type::T_STRING,
 127           'title' => ts('Entity Table'),
 128           'description' => ts('Name of table where item being referenced is stored.'),
 129           'required' => TRUE,
 130           'maxlength' => 64,
 131           'size' => CRM_Utils_Type::BIG,
 132           'where' => 'civicrm_log.entity_table',
 133           'table_name' => 'civicrm_log',
 134           'entity' => 'Log',
 135           'bao' => 'CRM_Core_BAO_Log',
 136           'localizable' => 0,
 137         ],
 138         'entity_id' => [
 139           'name' => 'entity_id',
 140           'type' => CRM_Utils_Type::T_INT,
 141           'title' => ts('Entity ID '),
 142           'description' => ts('Foreign key to the referenced item.'),
 143           'required' => TRUE,
 144           'where' => 'civicrm_log.entity_id',
 145           'table_name' => 'civicrm_log',
 146           'entity' => 'Log',
 147           'bao' => 'CRM_Core_BAO_Log',
 148           'localizable' => 0,
 149         ],
 150         'data' => [
 151           'name' => 'data',
 152           'type' => CRM_Utils_Type::T_TEXT,
 153           'title' => ts('Data'),
 154           'description' => ts('Updates does to this object if any.'),
 155           'where' => 'civicrm_log.data',
 156           'table_name' => 'civicrm_log',
 157           'entity' => 'Log',
 158           'bao' => 'CRM_Core_BAO_Log',
 159           'localizable' => 0,
 160         ],
 161         'modified_id' => [
 162           'name' => 'modified_id',
 163           'type' => CRM_Utils_Type::T_INT,
 164           'title' => ts('Modified By'),
 165           'description' => ts('FK to Contact ID of person under whose credentials this data modification was made.'),
 166           'where' => 'civicrm_log.modified_id',
 167           'table_name' => 'civicrm_log',
 168           'entity' => 'Log',
 169           'bao' => 'CRM_Core_BAO_Log',
 170           'localizable' => 0,
 171           'FKClassName' => 'CRM_Contact_DAO_Contact',
 172         ],
 173         'modified_date' => [
 174           'name' => 'modified_date',
 175           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 176           'title' => ts('Modified Date'),
 177           'description' => ts('When was the referenced entity created or modified or deleted.'),
 178           'where' => 'civicrm_log.modified_date',
 179           'table_name' => 'civicrm_log',
 180           'entity' => 'Log',
 181           'bao' => 'CRM_Core_BAO_Log',
 182           'localizable' => 0,
 183         ],
 184       ];
 185       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 186     }
 187     return Civi::$statics[__CLASS__]['fields'];
 188   }
 189
 190   /**
 191    * Return a mapping from field-name to the corresponding key (as used in fields()).
 192    *
 193    * @return array
 194    *   Array(string $name => string $uniqueName).
 195    */
 196   public static function &fieldKeys() {
 197     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 198       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 199     }
 200     return Civi::$statics[__CLASS__]['fieldKeys'];
 201   }
 202
 203   /**
 204    * Returns the names of this table
 205    *
 206    * @return string
 207    */
 208   public static function getTableName() {
 209     return self::$_tableName;
 210   }
 211
 212   /**
 213    * Returns if this table needs to be logged
 214    *
 215    * @return bool
 216    */
 217   public function getLog() {
 218     return self::$_log;
 219   }
 220
 221   /**
 222    * Returns the list of fields that can be imported
 223    *
 224    * @param bool $prefix
 225    *
 226    * @return array
 227    */
 228   public static function &import($prefix = FALSE) {
 229     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'log', $prefix, []);
 230     return $r;
 231   }
 232
 233   /**
 234    * Returns the list of fields that can be exported
 235    *
 236    * @param bool $prefix
 237    *
 238    * @return array
 239    */
 240   public static function &export($prefix = FALSE) {
 241     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'log', $prefix, []);
 242     return $r;
 243   }
 244
 245   /**
 246    * Returns the list of indices
 247    *
 248    * @param bool $localize
 249    *
 250    * @return array
 251    */
 252   public static function indices($localize = TRUE) {
 253     $indices = [
 254       'index_entity' => [
 255         'name' => 'index_entity',
 256         'field' => [
 257           0 => 'entity_table',
 258           1 => 'entity_id',
 259         ],
 260         'localizable' => FALSE,
 261         'sig' => 'civicrm_log::0::entity_table::entity_id',
 262       ],
 263     ];
 264     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 265   }
 266
 267 }