| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * @package CRM |
| 5 | * @copyright CiviCRM LLC (c) 2004-2018 |
| 6 | * |
| 7 | * Generated from xml/schema/CRM/Core/Log.xml |
| 8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen |
| 9 | * (GenCodeChecksum:38303a678c8e5104d63803ce900dc370) |
| 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 | 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 | static $_log = FALSE; |
| 30 | |
| 31 | /** |
| 32 | * Log ID |
| 33 | * |
| 34 | * @var int unsigned |
| 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 unsigned |
| 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 unsigned |
| 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 foreign keys and entity references. |
| 83 | * |
| 84 | * @return array |
| 85 | * [CRM_Core_Reference_Interface] |
| 86 | */ |
| 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']); |
| 93 | } |
| 94 | return Civi::$statics[__CLASS__]['links']; |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * Returns all the column names of this table |
| 99 | * |
| 100 | * @return array |
| 101 | */ |
| 102 | public static function &fields() { |
| 103 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
| 104 | Civi::$statics[__CLASS__]['fields'] = [ |
| 105 | 'id' => [ |
| 106 | 'name' => 'id', |
| 107 | 'type' => CRM_Utils_Type::T_INT, |
| 108 | 'title' => ts('Log ID'), |
| 109 | 'description' => ts('Log ID'), |
| 110 | 'required' => TRUE, |
| 111 | 'table_name' => 'civicrm_log', |
| 112 | 'entity' => 'Log', |
| 113 | 'bao' => 'CRM_Core_BAO_Log', |
| 114 | 'localizable' => 0, |
| 115 | ], |
| 116 | 'entity_table' => [ |
| 117 | 'name' => 'entity_table', |
| 118 | 'type' => CRM_Utils_Type::T_STRING, |
| 119 | 'title' => ts('Entity Table'), |
| 120 | 'description' => ts('Name of table where item being referenced is stored.'), |
| 121 | 'required' => TRUE, |
| 122 | 'maxlength' => 64, |
| 123 | 'size' => CRM_Utils_Type::BIG, |
| 124 | 'table_name' => 'civicrm_log', |
| 125 | 'entity' => 'Log', |
| 126 | 'bao' => 'CRM_Core_BAO_Log', |
| 127 | 'localizable' => 0, |
| 128 | ], |
| 129 | 'entity_id' => [ |
| 130 | 'name' => 'entity_id', |
| 131 | 'type' => CRM_Utils_Type::T_INT, |
| 132 | 'title' => ts('Entity ID '), |
| 133 | 'description' => ts('Foreign key to the referenced item.'), |
| 134 | 'required' => TRUE, |
| 135 | 'table_name' => 'civicrm_log', |
| 136 | 'entity' => 'Log', |
| 137 | 'bao' => 'CRM_Core_BAO_Log', |
| 138 | 'localizable' => 0, |
| 139 | ], |
| 140 | 'data' => [ |
| 141 | 'name' => 'data', |
| 142 | 'type' => CRM_Utils_Type::T_TEXT, |
| 143 | 'title' => ts('Data'), |
| 144 | 'description' => ts('Updates does to this object if any.'), |
| 145 | 'table_name' => 'civicrm_log', |
| 146 | 'entity' => 'Log', |
| 147 | 'bao' => 'CRM_Core_BAO_Log', |
| 148 | 'localizable' => 0, |
| 149 | ], |
| 150 | 'modified_id' => [ |
| 151 | 'name' => 'modified_id', |
| 152 | 'type' => CRM_Utils_Type::T_INT, |
| 153 | 'title' => ts('Modified By'), |
| 154 | 'description' => ts('FK to Contact ID of person under whose credentials this data modification was made.'), |
| 155 | 'table_name' => 'civicrm_log', |
| 156 | 'entity' => 'Log', |
| 157 | 'bao' => 'CRM_Core_BAO_Log', |
| 158 | 'localizable' => 0, |
| 159 | 'FKClassName' => 'CRM_Contact_DAO_Contact', |
| 160 | ], |
| 161 | 'modified_date' => [ |
| 162 | 'name' => 'modified_date', |
| 163 | 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, |
| 164 | 'title' => ts('Modified Date'), |
| 165 | 'description' => ts('When was the referenced entity created or modified or deleted.'), |
| 166 | 'table_name' => 'civicrm_log', |
| 167 | 'entity' => 'Log', |
| 168 | 'bao' => 'CRM_Core_BAO_Log', |
| 169 | 'localizable' => 0, |
| 170 | ], |
| 171 | ]; |
| 172 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
| 173 | } |
| 174 | return Civi::$statics[__CLASS__]['fields']; |
| 175 | } |
| 176 | |
| 177 | /** |
| 178 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
| 179 | * |
| 180 | * @return array |
| 181 | * Array(string $name => string $uniqueName). |
| 182 | */ |
| 183 | public static function &fieldKeys() { |
| 184 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
| 185 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); |
| 186 | } |
| 187 | return Civi::$statics[__CLASS__]['fieldKeys']; |
| 188 | } |
| 189 | |
| 190 | /** |
| 191 | * Returns the names of this table |
| 192 | * |
| 193 | * @return string |
| 194 | */ |
| 195 | public static function getTableName() { |
| 196 | return self::$_tableName; |
| 197 | } |
| 198 | |
| 199 | /** |
| 200 | * Returns if this table needs to be logged |
| 201 | * |
| 202 | * @return bool |
| 203 | */ |
| 204 | public function getLog() { |
| 205 | return self::$_log; |
| 206 | } |
| 207 | |
| 208 | /** |
| 209 | * Returns the list of fields that can be imported |
| 210 | * |
| 211 | * @param bool $prefix |
| 212 | * |
| 213 | * @return array |
| 214 | */ |
| 215 | public static function &import($prefix = FALSE) { |
| 216 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'log', $prefix, []); |
| 217 | return $r; |
| 218 | } |
| 219 | |
| 220 | /** |
| 221 | * Returns the list of fields that can be exported |
| 222 | * |
| 223 | * @param bool $prefix |
| 224 | * |
| 225 | * @return array |
| 226 | */ |
| 227 | public static function &export($prefix = FALSE) { |
| 228 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'log', $prefix, []); |
| 229 | return $r; |
| 230 | } |
| 231 | |
| 232 | /** |
| 233 | * Returns the list of indices |
| 234 | * |
| 235 | * @param bool $localize |
| 236 | * |
| 237 | * @return array |
| 238 | */ |
| 239 | public static function indices($localize = TRUE) { |
| 240 | $indices = [ |
| 241 | 'index_entity' => [ |
| 242 | 'name' => 'index_entity', |
| 243 | 'field' => [ |
| 244 | 0 => 'entity_table', |
| 245 | 1 => 'entity_id', |
| 246 | ], |
| 247 | 'localizable' => FALSE, |
| 248 | 'sig' => 'civicrm_log::0::entity_table::entity_id', |
| 249 | ], |
| 250 | ]; |
| 251 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
| 252 | } |
| 253 | |
| 254 | } |