Commit | Line | Data |
---|---|---|
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/Unsubscribe.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
449c4e6b | 9 | * (GenCodeChecksum:b7ec3c7157b019ce2783d5d0b369690c) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the Unsubscribe entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Mailing_Event_DAO_Unsubscribe 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_unsubscribe'; |
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 | * Unsubscribe at org- or group-level | |
45 | * | |
e6ca0a57 | 46 | * @var bool |
e501603b TO |
47 | */ |
48 | public $org_unsubscribe; | |
c3fc2621 | 49 | |
e501603b TO |
50 | /** |
51 | * When this delivery event occurred. | |
52 | * | |
6c2b97b7 | 53 | * @var timestamp |
e501603b TO |
54 | */ |
55 | public $time_stamp; | |
c3fc2621 | 56 | |
e501603b | 57 | /** |
f41f0342 | 58 | * Class constructor. |
e501603b | 59 | */ |
c3fc2621 | 60 | public function __construct() { |
e501603b TO |
61 | $this->__table = 'civicrm_mailing_event_unsubscribe'; |
62 | parent::__construct(); | |
63 | } | |
c3fc2621 | 64 | |
449c4e6b CW |
65 | /** |
66 | * Returns localized title of this entity. | |
67 | */ | |
68 | public static function getEntityTitle() { | |
69 | return ts('Unsubscribes'); | |
70 | } | |
71 | ||
e501603b | 72 | /** |
f41f0342 | 73 | * Returns foreign keys and entity references. |
e501603b TO |
74 | * |
75 | * @return array | |
76 | * [CRM_Core_Reference_Interface] | |
77 | */ | |
c3fc2621 | 78 | public static function getReferenceColumns() { |
346aaaba | 79 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
a36434b9 | 80 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 | 81 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'event_queue_id', 'civicrm_mailing_event_queue', 'id'); |
346aaaba | 82 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 83 | } |
346aaaba | 84 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 85 | } |
c3fc2621 | 86 | |
e501603b TO |
87 | /** |
88 | * Returns all the column names of this table | |
89 | * | |
90 | * @return array | |
91 | */ | |
c3fc2621 | 92 | public static function &fields() { |
346aaaba | 93 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
94 | Civi::$statics[__CLASS__]['fields'] = [ |
95 | 'id' => [ | |
e501603b TO |
96 | 'name' => 'id', |
97 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 CW |
98 | 'title' => ts('Unsubscribe ID'), |
99 | 'required' => TRUE, | |
a36434b9 | 100 | 'where' => 'civicrm_mailing_event_unsubscribe.id', |
522a26c9 | 101 | 'table_name' => 'civicrm_mailing_event_unsubscribe', |
102 | 'entity' => 'Unsubscribe', | |
103 | 'bao' => 'CRM_Mailing_Event_BAO_Unsubscribe', | |
6a7e5e5d | 104 | 'localizable' => 0, |
c3fc2621 CW |
105 | ], |
106 | 'event_queue_id' => [ | |
e501603b TO |
107 | 'name' => 'event_queue_id', |
108 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 109 | 'title' => ts('Mailing Event Queue'), |
215b423e | 110 | 'description' => ts('FK to EventQueue'), |
c3fc2621 | 111 | 'required' => TRUE, |
a36434b9 | 112 | 'where' => 'civicrm_mailing_event_unsubscribe.event_queue_id', |
522a26c9 | 113 | 'table_name' => 'civicrm_mailing_event_unsubscribe', |
114 | 'entity' => 'Unsubscribe', | |
115 | 'bao' => 'CRM_Mailing_Event_BAO_Unsubscribe', | |
6a7e5e5d | 116 | 'localizable' => 0, |
e501603b | 117 | 'FKClassName' => 'CRM_Mailing_Event_DAO_Queue', |
c3fc2621 CW |
118 | ], |
119 | 'org_unsubscribe' => [ | |
e501603b TO |
120 | 'name' => 'org_unsubscribe', |
121 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 122 | 'title' => ts('Unsubscribe is for Organization?'), |
215b423e | 123 | 'description' => ts('Unsubscribe at org- or group-level'), |
c3fc2621 | 124 | 'required' => TRUE, |
a36434b9 | 125 | 'where' => 'civicrm_mailing_event_unsubscribe.org_unsubscribe', |
522a26c9 | 126 | 'table_name' => 'civicrm_mailing_event_unsubscribe', |
127 | 'entity' => 'Unsubscribe', | |
128 | 'bao' => 'CRM_Mailing_Event_BAO_Unsubscribe', | |
6a7e5e5d | 129 | 'localizable' => 0, |
c3fc2621 CW |
130 | ], |
131 | 'time_stamp' => [ | |
e501603b | 132 | 'name' => 'time_stamp', |
6c2b97b7 | 133 | 'type' => CRM_Utils_Type::T_TIMESTAMP, |
c3fc2621 | 134 | 'title' => ts('Unsubscribe Timestamp'), |
215b423e | 135 | 'description' => ts('When this delivery event occurred.'), |
c3fc2621 | 136 | 'required' => TRUE, |
a36434b9 | 137 | 'where' => 'civicrm_mailing_event_unsubscribe.time_stamp', |
6c2b97b7 | 138 | 'default' => 'CURRENT_TIMESTAMP', |
522a26c9 | 139 | 'table_name' => 'civicrm_mailing_event_unsubscribe', |
140 | 'entity' => 'Unsubscribe', | |
141 | 'bao' => 'CRM_Mailing_Event_BAO_Unsubscribe', | |
6a7e5e5d | 142 | 'localizable' => 0, |
c3fc2621 CW |
143 | ], |
144 | ]; | |
346aaaba | 145 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 146 | } |
346aaaba | 147 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 148 | } |
c3fc2621 | 149 | |
e501603b | 150 | /** |
bd8e0b14 | 151 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
152 | * |
153 | * @return array | |
bd8e0b14 | 154 | * Array(string $name => string $uniqueName). |
e501603b | 155 | */ |
c3fc2621 | 156 | public static function &fieldKeys() { |
bd8e0b14 TO |
157 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
158 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 159 | } |
bd8e0b14 | 160 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 161 | } |
c3fc2621 | 162 | |
e501603b TO |
163 | /** |
164 | * Returns the names of this table | |
165 | * | |
166 | * @return string | |
167 | */ | |
c3fc2621 | 168 | public static function getTableName() { |
e501603b TO |
169 | return self::$_tableName; |
170 | } | |
c3fc2621 | 171 | |
e501603b TO |
172 | /** |
173 | * Returns if this table needs to be logged | |
174 | * | |
c3fc2621 | 175 | * @return bool |
e501603b | 176 | */ |
c3fc2621 | 177 | public function getLog() { |
e501603b TO |
178 | return self::$_log; |
179 | } | |
c3fc2621 | 180 | |
e501603b TO |
181 | /** |
182 | * Returns the list of fields that can be imported | |
183 | * | |
184 | * @param bool $prefix | |
185 | * | |
186 | * @return array | |
187 | */ | |
c3fc2621 CW |
188 | public static function &import($prefix = FALSE) { |
189 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_event_unsubscribe', $prefix, []); | |
60808919 | 190 | return $r; |
e501603b | 191 | } |
c3fc2621 | 192 | |
e501603b TO |
193 | /** |
194 | * Returns the list of fields that can be exported | |
195 | * | |
196 | * @param bool $prefix | |
197 | * | |
198 | * @return array | |
199 | */ | |
c3fc2621 CW |
200 | public static function &export($prefix = FALSE) { |
201 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_event_unsubscribe', $prefix, []); | |
60808919 | 202 | return $r; |
e501603b | 203 | } |
c3fc2621 | 204 | |
e7a6b91a AS |
205 | /** |
206 | * Returns the list of indices | |
c3fc2621 CW |
207 | * |
208 | * @param bool $localize | |
209 | * | |
210 | * @return array | |
e7a6b91a AS |
211 | */ |
212 | public static function indices($localize = TRUE) { | |
c3fc2621 | 213 | $indices = []; |
e7a6b91a AS |
214 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
215 | } | |
c3fc2621 | 216 | |
e501603b | 217 | } |