5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/Core/ActionLog.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:e23a4eda4386716e3553aeb30bf1f255)
13 * Database access object for the ActionLog entity.
15 class CRM_Core_DAO_ActionLog
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 public static $_tableName = 'civicrm_action_log';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
29 public static $_log = FALSE;
44 * FK to id of the entity that the action was performed on. Pseudo - FK.
51 * name of the entity table for the above id, e.g. civicrm_activity, civicrm_participant
58 * FK to the action schedule that this action originated from.
62 public $action_schedule_id;
65 * date time that the action was performed on.
69 public $action_date_time;
72 * Was there any error sending the reminder?
79 * Description / text in case there was an error encountered.
86 * Keeps track of the sequence number of this repetition.
90 public $repetition_number;
93 * Stores the date from the entity which triggered this reminder action (e.g. membership.end_date for most membership renewal reminders)
97 public $reference_date;
102 public function __construct() {
103 $this->__table
= 'civicrm_action_log';
104 parent
::__construct();
108 * Returns foreign keys and entity references.
111 * [CRM_Core_Reference_Interface]
113 public static function getReferenceColumns() {
114 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
115 Civi
::$statics[__CLASS__
]['links'] = static::createReferenceColumns(__CLASS__
);
116 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'contact_id', 'civicrm_contact', 'id');
117 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'action_schedule_id', 'civicrm_action_schedule', 'id');
118 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Dynamic(self
::getTableName(), 'entity_id', NULL, 'id', 'entity_table');
119 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
121 return Civi
::$statics[__CLASS__
]['links'];
125 * Returns all the column names of this table
129 public static function &fields() {
130 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
131 Civi
::$statics[__CLASS__
]['fields'] = [
134 'type' => CRM_Utils_Type
::T_INT
,
135 'title' => ts('Action Schedule ID'),
137 'where' => 'civicrm_action_log.id',
138 'table_name' => 'civicrm_action_log',
139 'entity' => 'ActionLog',
140 'bao' => 'CRM_Core_BAO_ActionLog',
144 'name' => 'contact_id',
145 'type' => CRM_Utils_Type
::T_INT
,
146 'title' => ts('Action Schedule Contact ID'),
147 'description' => ts('FK to Contact ID'),
148 'where' => 'civicrm_action_log.contact_id',
149 'table_name' => 'civicrm_action_log',
150 'entity' => 'ActionLog',
151 'bao' => 'CRM_Core_BAO_ActionLog',
153 'FKClassName' => 'CRM_Contact_DAO_Contact',
156 'name' => 'entity_id',
157 'type' => CRM_Utils_Type
::T_INT
,
158 'title' => ts('Entity ID'),
159 'description' => ts('FK to id of the entity that the action was performed on. Pseudo - FK.'),
161 'where' => 'civicrm_action_log.entity_id',
162 'table_name' => 'civicrm_action_log',
163 'entity' => 'ActionLog',
164 'bao' => 'CRM_Core_BAO_ActionLog',
168 'name' => 'entity_table',
169 'type' => CRM_Utils_Type
::T_STRING
,
170 'title' => ts('Entity Table'),
171 'description' => ts('name of the entity table for the above id, e.g. civicrm_activity, civicrm_participant'),
173 'size' => CRM_Utils_Type
::HUGE
,
174 'where' => 'civicrm_action_log.entity_table',
175 'table_name' => 'civicrm_action_log',
176 'entity' => 'ActionLog',
177 'bao' => 'CRM_Core_BAO_ActionLog',
180 'action_schedule_id' => [
181 'name' => 'action_schedule_id',
182 'type' => CRM_Utils_Type
::T_INT
,
183 'title' => ts('Schedule'),
184 'description' => ts('FK to the action schedule that this action originated from.'),
186 'where' => 'civicrm_action_log.action_schedule_id',
187 'table_name' => 'civicrm_action_log',
188 'entity' => 'ActionLog',
189 'bao' => 'CRM_Core_BAO_ActionLog',
191 'FKClassName' => 'CRM_Core_DAO_ActionSchedule',
193 'action_date_time' => [
194 'name' => 'action_date_time',
195 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
196 'title' => ts('Action Date And Time'),
197 'description' => ts('date time that the action was performed on.'),
198 'where' => 'civicrm_action_log.action_date_time',
199 'table_name' => 'civicrm_action_log',
200 'entity' => 'ActionLog',
201 'bao' => 'CRM_Core_BAO_ActionLog',
205 'name' => 'is_error',
206 'type' => CRM_Utils_Type
::T_BOOLEAN
,
207 'title' => ts('Error?'),
208 'description' => ts('Was there any error sending the reminder?'),
209 'where' => 'civicrm_action_log.is_error',
211 'table_name' => 'civicrm_action_log',
212 'entity' => 'ActionLog',
213 'bao' => 'CRM_Core_BAO_ActionLog',
218 'type' => CRM_Utils_Type
::T_TEXT
,
219 'title' => ts('Message'),
220 'description' => ts('Description / text in case there was an error encountered.'),
221 'where' => 'civicrm_action_log.message',
222 'table_name' => 'civicrm_action_log',
223 'entity' => 'ActionLog',
224 'bao' => 'CRM_Core_BAO_ActionLog',
227 'repetition_number' => [
228 'name' => 'repetition_number',
229 'type' => CRM_Utils_Type
::T_INT
,
230 'title' => ts('Repetition Number'),
231 'description' => ts('Keeps track of the sequence number of this repetition.'),
232 'where' => 'civicrm_action_log.repetition_number',
233 'table_name' => 'civicrm_action_log',
234 'entity' => 'ActionLog',
235 'bao' => 'CRM_Core_BAO_ActionLog',
238 'reference_date' => [
239 'name' => 'reference_date',
240 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
241 'title' => ts('Reference Date'),
242 'description' => ts('Stores the date from the entity which triggered this reminder action (e.g. membership.end_date for most membership renewal reminders)'),
243 'where' => 'civicrm_action_log.reference_date',
245 'table_name' => 'civicrm_action_log',
246 'entity' => 'ActionLog',
247 'bao' => 'CRM_Core_BAO_ActionLog',
251 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
253 return Civi
::$statics[__CLASS__
]['fields'];
257 * Return a mapping from field-name to the corresponding key (as used in fields()).
260 * Array(string $name => string $uniqueName).
262 public static function &fieldKeys() {
263 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
264 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
266 return Civi
::$statics[__CLASS__
]['fieldKeys'];
270 * Returns the names of this table
274 public static function getTableName() {
275 return self
::$_tableName;
279 * Returns if this table needs to be logged
283 public function getLog() {
288 * Returns the list of fields that can be imported
290 * @param bool $prefix
294 public static function &import($prefix = FALSE) {
295 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'action_log', $prefix, []);
300 * Returns the list of fields that can be exported
302 * @param bool $prefix
306 public static function &export($prefix = FALSE) {
307 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'action_log', $prefix, []);
312 * Returns the list of indices
314 * @param bool $localize
318 public static function indices($localize = TRUE) {
320 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;