Commit | Line | Data |
---|---|---|
e501603b | 1 | <?php |
c3fc2621 | 2 | |
e501603b TO |
3 | /** |
4 | * @package CRM | |
8c9251b3 | 5 | * @copyright CiviCRM LLC (c) 2004-2018 |
e501603b TO |
6 | * |
7 | * Generated from xml/schema/CRM/Mailing/Event/Delivered.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
6c2b97b7 | 9 | * (GenCodeChecksum:f5c02a90e7ec94814797559e9080c96a) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the Delivered entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Mailing_Event_DAO_Delivered extends CRM_Core_DAO { |
c3fc2621 | 16 | |
e501603b | 17 | /** |
f41f0342 | 18 | * Static instance to hold the table name. |
e501603b TO |
19 | * |
20 | * @var string | |
21 | */ | |
22 | static $_tableName = 'civicrm_mailing_event_delivered'; | |
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 | */ |
c3fc2621 CW |
29 | static $_log = FALSE; |
30 | ||
e501603b | 31 | /** |
e501603b TO |
32 | * @var int unsigned |
33 | */ | |
34 | public $id; | |
c3fc2621 | 35 | |
e501603b TO |
36 | /** |
37 | * FK to EventQueue | |
38 | * | |
39 | * @var int unsigned | |
40 | */ | |
41 | public $event_queue_id; | |
c3fc2621 | 42 | |
e501603b TO |
43 | /** |
44 | * When this delivery 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_delivered'; |
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 TO |
65 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
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('Delivered ID'), |
85 | 'required' => TRUE, | |
522a26c9 | 86 | 'table_name' => 'civicrm_mailing_event_delivered', |
87 | 'entity' => 'Delivered', | |
88 | 'bao' => 'CRM_Mailing_Event_BAO_Delivered', | |
6a7e5e5d | 89 | 'localizable' => 0, |
c3fc2621 CW |
90 | ], |
91 | 'event_queue_id' => [ | |
e501603b TO |
92 | 'name' => 'event_queue_id', |
93 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 94 | 'title' => ts('Event Queue'), |
215b423e | 95 | 'description' => ts('FK to EventQueue'), |
c3fc2621 | 96 | 'required' => TRUE, |
522a26c9 | 97 | 'table_name' => 'civicrm_mailing_event_delivered', |
98 | 'entity' => 'Delivered', | |
99 | 'bao' => 'CRM_Mailing_Event_BAO_Delivered', | |
6a7e5e5d | 100 | 'localizable' => 0, |
e501603b | 101 | 'FKClassName' => 'CRM_Mailing_Event_DAO_Queue', |
c3fc2621 CW |
102 | ], |
103 | 'time_stamp' => [ | |
e501603b | 104 | 'name' => 'time_stamp', |
6c2b97b7 | 105 | 'type' => CRM_Utils_Type::T_TIMESTAMP, |
c3fc2621 | 106 | 'title' => ts('Timestamp'), |
215b423e | 107 | 'description' => ts('When this delivery event occurred.'), |
c3fc2621 | 108 | 'required' => TRUE, |
6c2b97b7 | 109 | 'default' => 'CURRENT_TIMESTAMP', |
522a26c9 | 110 | 'table_name' => 'civicrm_mailing_event_delivered', |
111 | 'entity' => 'Delivered', | |
112 | 'bao' => 'CRM_Mailing_Event_BAO_Delivered', | |
6a7e5e5d | 113 | 'localizable' => 0, |
c3fc2621 CW |
114 | ], |
115 | ]; | |
346aaaba | 116 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 117 | } |
346aaaba | 118 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 119 | } |
c3fc2621 | 120 | |
e501603b | 121 | /** |
bd8e0b14 | 122 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
123 | * |
124 | * @return array | |
bd8e0b14 | 125 | * Array(string $name => string $uniqueName). |
e501603b | 126 | */ |
c3fc2621 | 127 | public static function &fieldKeys() { |
bd8e0b14 TO |
128 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
129 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 130 | } |
bd8e0b14 | 131 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 132 | } |
c3fc2621 | 133 | |
e501603b TO |
134 | /** |
135 | * Returns the names of this table | |
136 | * | |
137 | * @return string | |
138 | */ | |
c3fc2621 | 139 | public static function getTableName() { |
e501603b TO |
140 | return self::$_tableName; |
141 | } | |
c3fc2621 | 142 | |
e501603b TO |
143 | /** |
144 | * Returns if this table needs to be logged | |
145 | * | |
c3fc2621 | 146 | * @return bool |
e501603b | 147 | */ |
c3fc2621 | 148 | public function getLog() { |
e501603b TO |
149 | return self::$_log; |
150 | } | |
c3fc2621 | 151 | |
e501603b TO |
152 | /** |
153 | * Returns the list of fields that can be imported | |
154 | * | |
155 | * @param bool $prefix | |
156 | * | |
157 | * @return array | |
158 | */ | |
c3fc2621 CW |
159 | public static function &import($prefix = FALSE) { |
160 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_event_delivered', $prefix, []); | |
60808919 | 161 | return $r; |
e501603b | 162 | } |
c3fc2621 | 163 | |
e501603b TO |
164 | /** |
165 | * Returns the list of fields that can be exported | |
166 | * | |
167 | * @param bool $prefix | |
168 | * | |
169 | * @return array | |
170 | */ | |
c3fc2621 CW |
171 | public static function &export($prefix = FALSE) { |
172 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_event_delivered', $prefix, []); | |
60808919 | 173 | return $r; |
e501603b | 174 | } |
c3fc2621 | 175 | |
e7a6b91a AS |
176 | /** |
177 | * Returns the list of indices | |
c3fc2621 CW |
178 | * |
179 | * @param bool $localize | |
180 | * | |
181 | * @return array | |
e7a6b91a AS |
182 | */ |
183 | public static function indices($localize = TRUE) { | |
c3fc2621 | 184 | $indices = []; |
e7a6b91a AS |
185 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
186 | } | |
c3fc2621 | 187 | |
e501603b | 188 | } |