5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/Core/Log.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:0a82a165e8054985acc0f57feebc65ff)
13 * Database access object for the Log entity.
15 class CRM_Core_DAO_Log
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 public static $_tableName = 'civicrm_log';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
29 public static $_log = FALSE;
39 * Name of table where item being referenced is stored.
46 * Foreign key to the referenced item.
53 * Updates does to this object if any.
60 * FK to Contact ID of person under whose credentials this data modification was made.
67 * When was the referenced entity created or modified or deleted.
71 public $modified_date;
76 public function __construct() {
77 $this->__table
= 'civicrm_log';
78 parent
::__construct();
82 * Returns foreign keys and entity references.
85 * [CRM_Core_Reference_Interface]
87 public static function getReferenceColumns() {
88 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
89 Civi
::$statics[__CLASS__
]['links'] = static::createReferenceColumns(__CLASS__
);
90 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'modified_id', 'civicrm_contact', 'id');
91 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Dynamic(self
::getTableName(), 'entity_id', NULL, 'id', 'entity_table');
92 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
94 return Civi
::$statics[__CLASS__
]['links'];
98 * Returns all the column names of this table
102 public static function &fields() {
103 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
104 Civi
::$statics[__CLASS__
]['fields'] = [
107 'type' => CRM_Utils_Type
::T_INT
,
108 'title' => ts('Log ID'),
109 'description' => ts('Log ID'),
111 'where' => 'civicrm_log.id',
112 'table_name' => 'civicrm_log',
114 'bao' => 'CRM_Core_BAO_Log',
118 'name' => 'entity_table',
119 'type' => CRM_Utils_Type
::T_STRING
,
120 'title' => ts('Entity Table'),
121 'description' => ts('Name of table where item being referenced is stored.'),
124 'size' => CRM_Utils_Type
::BIG
,
125 'where' => 'civicrm_log.entity_table',
126 'table_name' => 'civicrm_log',
128 'bao' => 'CRM_Core_BAO_Log',
132 'name' => 'entity_id',
133 'type' => CRM_Utils_Type
::T_INT
,
134 'title' => ts('Entity ID '),
135 'description' => ts('Foreign key to the referenced item.'),
137 'where' => 'civicrm_log.entity_id',
138 'table_name' => 'civicrm_log',
140 'bao' => 'CRM_Core_BAO_Log',
145 'type' => CRM_Utils_Type
::T_TEXT
,
146 'title' => ts('Data'),
147 'description' => ts('Updates does to this object if any.'),
148 'where' => 'civicrm_log.data',
149 'table_name' => 'civicrm_log',
151 'bao' => 'CRM_Core_BAO_Log',
155 'name' => 'modified_id',
156 'type' => CRM_Utils_Type
::T_INT
,
157 'title' => ts('Modified By'),
158 'description' => ts('FK to Contact ID of person under whose credentials this data modification was made.'),
159 'where' => 'civicrm_log.modified_id',
160 'table_name' => 'civicrm_log',
162 'bao' => 'CRM_Core_BAO_Log',
164 'FKClassName' => 'CRM_Contact_DAO_Contact',
167 'name' => 'modified_date',
168 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
169 'title' => ts('Modified Date'),
170 'description' => ts('When was the referenced entity created or modified or deleted.'),
171 'where' => 'civicrm_log.modified_date',
172 'table_name' => 'civicrm_log',
174 'bao' => 'CRM_Core_BAO_Log',
178 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
180 return Civi
::$statics[__CLASS__
]['fields'];
184 * Return a mapping from field-name to the corresponding key (as used in fields()).
187 * Array(string $name => string $uniqueName).
189 public static function &fieldKeys() {
190 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
191 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
193 return Civi
::$statics[__CLASS__
]['fieldKeys'];
197 * Returns the names of this table
201 public static function getTableName() {
202 return self
::$_tableName;
206 * Returns if this table needs to be logged
210 public function getLog() {
215 * Returns the list of fields that can be imported
217 * @param bool $prefix
221 public static function &import($prefix = FALSE) {
222 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'log', $prefix, []);
227 * Returns the list of fields that can be exported
229 * @param bool $prefix
233 public static function &export($prefix = FALSE) {
234 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'log', $prefix, []);
239 * Returns the list of indices
241 * @param bool $localize
245 public static function indices($localize = TRUE) {
248 'name' => 'index_entity',
253 'localizable' => FALSE,
254 'sig' => 'civicrm_log::0::entity_table::entity_id',
257 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;