Commit | Line | Data |
---|---|---|
e501603b | 1 | <?php |
c3fc2621 | 2 | |
e501603b TO |
3 | /** |
4 | * @package CRM | |
f299f7db | 5 | * @copyright CiviCRM LLC (c) 2004-2020 |
e501603b TO |
6 | * |
7 | * Generated from xml/schema/CRM/Mailing/Event/Opened.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
74db51d3 | 9 | * (GenCodeChecksum:09dbc5750f23402fe8ffe9ca0cffd0ba) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the Opened entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Mailing_Event_DAO_Opened 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_opened'; |
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 open 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_opened'; |
55 | parent::__construct(); | |
56 | } | |
c3fc2621 | 57 | |
e501603b | 58 | /** |
f41f0342 | 59 | * Returns foreign keys and entity references. |
e501603b TO |
60 | * |
61 | * @return array | |
62 | * [CRM_Core_Reference_Interface] | |
63 | */ | |
c3fc2621 | 64 | public static function getReferenceColumns() { |
346aaaba | 65 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
a36434b9 | 66 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 | 67 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'event_queue_id', 'civicrm_mailing_event_queue', 'id'); |
346aaaba | 68 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 69 | } |
346aaaba | 70 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 71 | } |
c3fc2621 | 72 | |
e501603b TO |
73 | /** |
74 | * Returns all the column names of this table | |
75 | * | |
76 | * @return array | |
77 | */ | |
c3fc2621 | 78 | public static function &fields() { |
346aaaba | 79 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
80 | Civi::$statics[__CLASS__]['fields'] = [ |
81 | 'id' => [ | |
e501603b TO |
82 | 'name' => 'id', |
83 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 CW |
84 | 'title' => ts('Mailing Opened ID'), |
85 | 'required' => TRUE, | |
a36434b9 | 86 | 'where' => 'civicrm_mailing_event_opened.id', |
522a26c9 | 87 | 'table_name' => 'civicrm_mailing_event_opened', |
88 | 'entity' => 'Opened', | |
89 | 'bao' => 'CRM_Mailing_Event_BAO_Opened', | |
6a7e5e5d | 90 | 'localizable' => 0, |
c3fc2621 CW |
91 | ], |
92 | 'event_queue_id' => [ | |
e501603b TO |
93 | 'name' => 'event_queue_id', |
94 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 95 | 'title' => ts('Event Queue'), |
215b423e | 96 | 'description' => ts('FK to EventQueue'), |
c3fc2621 | 97 | 'required' => TRUE, |
a36434b9 | 98 | 'where' => 'civicrm_mailing_event_opened.event_queue_id', |
522a26c9 | 99 | 'table_name' => 'civicrm_mailing_event_opened', |
100 | 'entity' => 'Opened', | |
101 | 'bao' => 'CRM_Mailing_Event_BAO_Opened', | |
6a7e5e5d | 102 | 'localizable' => 0, |
e501603b | 103 | 'FKClassName' => 'CRM_Mailing_Event_DAO_Queue', |
c3fc2621 CW |
104 | ], |
105 | 'time_stamp' => [ | |
e501603b | 106 | 'name' => 'time_stamp', |
6c2b97b7 | 107 | 'type' => CRM_Utils_Type::T_TIMESTAMP, |
c3fc2621 | 108 | 'title' => ts('Timestamp'), |
215b423e | 109 | 'description' => ts('When this open event occurred.'), |
c3fc2621 | 110 | 'required' => TRUE, |
a36434b9 | 111 | 'where' => 'civicrm_mailing_event_opened.time_stamp', |
6c2b97b7 | 112 | 'default' => 'CURRENT_TIMESTAMP', |
522a26c9 | 113 | 'table_name' => 'civicrm_mailing_event_opened', |
114 | 'entity' => 'Opened', | |
115 | 'bao' => 'CRM_Mailing_Event_BAO_Opened', | |
6a7e5e5d | 116 | 'localizable' => 0, |
c3fc2621 CW |
117 | ], |
118 | ]; | |
346aaaba | 119 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 120 | } |
346aaaba | 121 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 122 | } |
c3fc2621 | 123 | |
e501603b | 124 | /** |
bd8e0b14 | 125 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
126 | * |
127 | * @return array | |
bd8e0b14 | 128 | * Array(string $name => string $uniqueName). |
e501603b | 129 | */ |
c3fc2621 | 130 | public static function &fieldKeys() { |
bd8e0b14 TO |
131 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
132 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 133 | } |
bd8e0b14 | 134 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 135 | } |
c3fc2621 | 136 | |
e501603b TO |
137 | /** |
138 | * Returns the names of this table | |
139 | * | |
140 | * @return string | |
141 | */ | |
c3fc2621 | 142 | public static function getTableName() { |
e501603b TO |
143 | return self::$_tableName; |
144 | } | |
c3fc2621 | 145 | |
e501603b TO |
146 | /** |
147 | * Returns if this table needs to be logged | |
148 | * | |
c3fc2621 | 149 | * @return bool |
e501603b | 150 | */ |
c3fc2621 | 151 | public function getLog() { |
e501603b TO |
152 | return self::$_log; |
153 | } | |
c3fc2621 | 154 | |
e501603b TO |
155 | /** |
156 | * Returns the list of fields that can be imported | |
157 | * | |
158 | * @param bool $prefix | |
159 | * | |
160 | * @return array | |
161 | */ | |
c3fc2621 CW |
162 | public static function &import($prefix = FALSE) { |
163 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_event_opened', $prefix, []); | |
60808919 | 164 | return $r; |
e501603b | 165 | } |
c3fc2621 | 166 | |
e501603b TO |
167 | /** |
168 | * Returns the list of fields that can be exported | |
169 | * | |
170 | * @param bool $prefix | |
171 | * | |
172 | * @return array | |
173 | */ | |
c3fc2621 CW |
174 | public static function &export($prefix = FALSE) { |
175 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_event_opened', $prefix, []); | |
60808919 | 176 | return $r; |
e501603b | 177 | } |
c3fc2621 | 178 | |
e7a6b91a AS |
179 | /** |
180 | * Returns the list of indices | |
c3fc2621 CW |
181 | * |
182 | * @param bool $localize | |
183 | * | |
184 | * @return array | |
e7a6b91a AS |
185 | */ |
186 | public static function indices($localize = TRUE) { | |
c3fc2621 | 187 | $indices = []; |
e7a6b91a AS |
188 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
189 | } | |
c3fc2621 | 190 | |
e501603b | 191 | } |