CodeGen - Add EXT and TABLE_ADDED to each DAO file
[civicrm-core.git] / CRM / Mailing / Event / DAO / Reply.php
CommitLineData
e501603b 1<?php
c3fc2621 2
e501603b
TO
3/**
4 * @package CRM
ca5cec67 5 * @copyright CiviCRM LLC https://civicrm.org/licensing
e501603b
TO
6 *
7 * Generated from xml/schema/CRM/Mailing/Event/Reply.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
a9d0587b 9 * (GenCodeChecksum:a8246c6739f95a8e25d17ddebe882db7)
e501603b 10 */
c3fc2621 11
f41f0342 12/**
c3fc2621 13 * Database access object for the Reply entity.
f41f0342 14 */
e501603b 15class CRM_Mailing_Event_DAO_Reply extends CRM_Core_DAO {
c3fc2621 16
e501603b 17 /**
f41f0342 18 * Static instance to hold the table name.
e501603b
TO
19 *
20 * @var string
21 */
fa45b5b9 22 public static $_tableName = 'civicrm_mailing_event_reply';
c3fc2621 23
e501603b 24 /**
f41f0342 25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
e501603b 26 *
c3fc2621 27 * @var bool
e501603b 28 */
fa45b5b9 29 public static $_log = FALSE;
c3fc2621 30
e501603b 31 /**
e6ca0a57 32 * @var int
e501603b
TO
33 */
34 public $id;
c3fc2621 35
e501603b
TO
36 /**
37 * FK to EventQueue
38 *
e6ca0a57 39 * @var int
e501603b
TO
40 */
41 public $event_queue_id;
c3fc2621 42
e501603b
TO
43 /**
44 * When this reply event occurred.
45 *
6c2b97b7 46 * @var timestamp
e501603b
TO
47 */
48 public $time_stamp;
c3fc2621 49
e501603b 50 /**
f41f0342 51 * Class constructor.
e501603b 52 */
c3fc2621 53 public function __construct() {
e501603b
TO
54 $this->__table = 'civicrm_mailing_event_reply';
55 parent::__construct();
56 }
449c4e6b
CW
57
58 /**
59 * Returns localized title of this entity.
60 */
61 public static function getEntityTitle() {
62 return ts('Replies');
63 }
c3fc2621 64
e501603b 65 /**
f41f0342 66 * Returns foreign keys and entity references.
e501603b
TO
67 *
68 * @return array
69 * [CRM_Core_Reference_Interface]
70 */
c3fc2621 71 public static function getReferenceColumns() {
346aaaba 72 if (!isset(Civi::$statics[__CLASS__]['links'])) {
a36434b9 73 Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
c3fc2621 74 Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'event_queue_id', 'civicrm_mailing_event_queue', 'id');
346aaaba 75 CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
e501603b 76 }
346aaaba 77 return Civi::$statics[__CLASS__]['links'];
e501603b 78 }
c3fc2621 79
e501603b
TO
80 /**
81 * Returns all the column names of this table
82 *
83 * @return array
84 */
c3fc2621 85 public static function &fields() {
346aaaba 86 if (!isset(Civi::$statics[__CLASS__]['fields'])) {
c3fc2621
CW
87 Civi::$statics[__CLASS__]['fields'] = [
88 'id' => [
e501603b
TO
89 'name' => 'id',
90 'type' => CRM_Utils_Type::T_INT,
c3fc2621
CW
91 'title' => ts('Reply ID'),
92 'required' => TRUE,
a36434b9 93 'where' => 'civicrm_mailing_event_reply.id',
522a26c9 94 'table_name' => 'civicrm_mailing_event_reply',
95 'entity' => 'Reply',
96 'bao' => 'CRM_Mailing_Event_BAO_Reply',
6a7e5e5d 97 'localizable' => 0,
a9d0587b 98 'add' => NULL,
c3fc2621
CW
99 ],
100 'event_queue_id' => [
e501603b
TO
101 'name' => 'event_queue_id',
102 'type' => CRM_Utils_Type::T_INT,
c3fc2621 103 'title' => ts('Event Queue'),
215b423e 104 'description' => ts('FK to EventQueue'),
c3fc2621 105 'required' => TRUE,
a36434b9 106 'where' => 'civicrm_mailing_event_reply.event_queue_id',
522a26c9 107 'table_name' => 'civicrm_mailing_event_reply',
108 'entity' => 'Reply',
109 'bao' => 'CRM_Mailing_Event_BAO_Reply',
6a7e5e5d 110 'localizable' => 0,
e501603b 111 'FKClassName' => 'CRM_Mailing_Event_DAO_Queue',
a9d0587b 112 'add' => NULL,
c3fc2621
CW
113 ],
114 'time_stamp' => [
e501603b 115 'name' => 'time_stamp',
6c2b97b7 116 'type' => CRM_Utils_Type::T_TIMESTAMP,
c3fc2621 117 'title' => ts('Reply Timestamp'),
215b423e 118 'description' => ts('When this reply event occurred.'),
c3fc2621 119 'required' => TRUE,
a36434b9 120 'where' => 'civicrm_mailing_event_reply.time_stamp',
6c2b97b7 121 'default' => 'CURRENT_TIMESTAMP',
522a26c9 122 'table_name' => 'civicrm_mailing_event_reply',
123 'entity' => 'Reply',
124 'bao' => 'CRM_Mailing_Event_BAO_Reply',
6a7e5e5d 125 'localizable' => 0,
a9d0587b 126 'add' => NULL,
c3fc2621
CW
127 ],
128 ];
346aaaba 129 CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
e501603b 130 }
346aaaba 131 return Civi::$statics[__CLASS__]['fields'];
e501603b 132 }
c3fc2621 133
e501603b 134 /**
bd8e0b14 135 * Return a mapping from field-name to the corresponding key (as used in fields()).
e501603b
TO
136 *
137 * @return array
bd8e0b14 138 * Array(string $name => string $uniqueName).
e501603b 139 */
c3fc2621 140 public static function &fieldKeys() {
bd8e0b14
TO
141 if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
142 Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
e501603b 143 }
bd8e0b14 144 return Civi::$statics[__CLASS__]['fieldKeys'];
e501603b 145 }
c3fc2621 146
e501603b
TO
147 /**
148 * Returns the names of this table
149 *
150 * @return string
151 */
c3fc2621 152 public static function getTableName() {
e501603b
TO
153 return self::$_tableName;
154 }
c3fc2621 155
e501603b
TO
156 /**
157 * Returns if this table needs to be logged
158 *
c3fc2621 159 * @return bool
e501603b 160 */
c3fc2621 161 public function getLog() {
e501603b
TO
162 return self::$_log;
163 }
c3fc2621 164
e501603b
TO
165 /**
166 * Returns the list of fields that can be imported
167 *
168 * @param bool $prefix
169 *
170 * @return array
171 */
c3fc2621
CW
172 public static function &import($prefix = FALSE) {
173 $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_event_reply', $prefix, []);
60808919 174 return $r;
e501603b 175 }
c3fc2621 176
e501603b
TO
177 /**
178 * Returns the list of fields that can be exported
179 *
180 * @param bool $prefix
181 *
182 * @return array
183 */
c3fc2621
CW
184 public static function &export($prefix = FALSE) {
185 $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_event_reply', $prefix, []);
60808919 186 return $r;
e501603b 187 }
c3fc2621 188
e7a6b91a
AS
189 /**
190 * Returns the list of indices
c3fc2621
CW
191 *
192 * @param bool $localize
193 *
194 * @return array
e7a6b91a
AS
195 */
196 public static function indices($localize = TRUE) {
c3fc2621 197 $indices = [];
e7a6b91a
AS
198 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
199 }
c3fc2621 200
e501603b 201}