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/Forward.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
74db51d3 | 9 | * (GenCodeChecksum:b96d36e0d04a4a6039a8e9a3b782a35e) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the Forward entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Mailing_Event_DAO_Forward 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_forward'; |
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 | * FK to EventQueue for destination | |
45 | * | |
e6ca0a57 | 46 | * @var int |
e501603b TO |
47 | */ |
48 | public $dest_queue_id; | |
c3fc2621 | 49 | |
e501603b TO |
50 | /** |
51 | * When this forward 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_forward'; |
62 | parent::__construct(); | |
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 CW |
74 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'event_queue_id', 'civicrm_mailing_event_queue', 'id'); |
75 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'dest_queue_id', 'civicrm_mailing_event_queue', 'id'); | |
346aaaba | 76 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 77 | } |
346aaaba | 78 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 79 | } |
c3fc2621 | 80 | |
e501603b TO |
81 | /** |
82 | * Returns all the column names of this table | |
83 | * | |
84 | * @return array | |
85 | */ | |
c3fc2621 | 86 | public static function &fields() { |
346aaaba | 87 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
88 | Civi::$statics[__CLASS__]['fields'] = [ |
89 | 'id' => [ | |
e501603b TO |
90 | 'name' => 'id', |
91 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 CW |
92 | 'title' => ts('Forward ID'), |
93 | 'required' => TRUE, | |
a36434b9 | 94 | 'where' => 'civicrm_mailing_event_forward.id', |
522a26c9 | 95 | 'table_name' => 'civicrm_mailing_event_forward', |
96 | 'entity' => 'Forward', | |
97 | 'bao' => 'CRM_Mailing_Event_BAO_Forward', | |
6a7e5e5d | 98 | 'localizable' => 0, |
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('Mailing Event Queue'), |
215b423e | 104 | 'description' => ts('FK to EventQueue'), |
c3fc2621 | 105 | 'required' => TRUE, |
a36434b9 | 106 | 'where' => 'civicrm_mailing_event_forward.event_queue_id', |
522a26c9 | 107 | 'table_name' => 'civicrm_mailing_event_forward', |
108 | 'entity' => 'Forward', | |
109 | 'bao' => 'CRM_Mailing_Event_BAO_Forward', | |
6a7e5e5d | 110 | 'localizable' => 0, |
e501603b | 111 | 'FKClassName' => 'CRM_Mailing_Event_DAO_Queue', |
c3fc2621 CW |
112 | ], |
113 | 'dest_queue_id' => [ | |
e501603b TO |
114 | 'name' => 'dest_queue_id', |
115 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 116 | 'title' => ts('Destination Queue'), |
215b423e | 117 | 'description' => ts('FK to EventQueue for destination'), |
a36434b9 | 118 | 'where' => 'civicrm_mailing_event_forward.dest_queue_id', |
522a26c9 | 119 | 'table_name' => 'civicrm_mailing_event_forward', |
120 | 'entity' => 'Forward', | |
121 | 'bao' => 'CRM_Mailing_Event_BAO_Forward', | |
6a7e5e5d | 122 | 'localizable' => 0, |
e501603b | 123 | 'FKClassName' => 'CRM_Mailing_Event_DAO_Queue', |
c3fc2621 CW |
124 | ], |
125 | 'time_stamp' => [ | |
e501603b | 126 | 'name' => 'time_stamp', |
6c2b97b7 | 127 | 'type' => CRM_Utils_Type::T_TIMESTAMP, |
c3fc2621 | 128 | 'title' => ts('Timestamp'), |
215b423e | 129 | 'description' => ts('When this forward event occurred.'), |
c3fc2621 | 130 | 'required' => TRUE, |
a36434b9 | 131 | 'where' => 'civicrm_mailing_event_forward.time_stamp', |
6c2b97b7 | 132 | 'default' => 'CURRENT_TIMESTAMP', |
522a26c9 | 133 | 'table_name' => 'civicrm_mailing_event_forward', |
134 | 'entity' => 'Forward', | |
135 | 'bao' => 'CRM_Mailing_Event_BAO_Forward', | |
6a7e5e5d | 136 | 'localizable' => 0, |
c3fc2621 CW |
137 | ], |
138 | ]; | |
346aaaba | 139 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 140 | } |
346aaaba | 141 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 142 | } |
c3fc2621 | 143 | |
e501603b | 144 | /** |
bd8e0b14 | 145 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
146 | * |
147 | * @return array | |
bd8e0b14 | 148 | * Array(string $name => string $uniqueName). |
e501603b | 149 | */ |
c3fc2621 | 150 | public static function &fieldKeys() { |
bd8e0b14 TO |
151 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
152 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 153 | } |
bd8e0b14 | 154 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 155 | } |
c3fc2621 | 156 | |
e501603b TO |
157 | /** |
158 | * Returns the names of this table | |
159 | * | |
160 | * @return string | |
161 | */ | |
c3fc2621 | 162 | public static function getTableName() { |
e501603b TO |
163 | return self::$_tableName; |
164 | } | |
c3fc2621 | 165 | |
e501603b TO |
166 | /** |
167 | * Returns if this table needs to be logged | |
168 | * | |
c3fc2621 | 169 | * @return bool |
e501603b | 170 | */ |
c3fc2621 | 171 | public function getLog() { |
e501603b TO |
172 | return self::$_log; |
173 | } | |
c3fc2621 | 174 | |
e501603b TO |
175 | /** |
176 | * Returns the list of fields that can be imported | |
177 | * | |
178 | * @param bool $prefix | |
179 | * | |
180 | * @return array | |
181 | */ | |
c3fc2621 CW |
182 | public static function &import($prefix = FALSE) { |
183 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_event_forward', $prefix, []); | |
60808919 | 184 | return $r; |
e501603b | 185 | } |
c3fc2621 | 186 | |
e501603b TO |
187 | /** |
188 | * Returns the list of fields that can be exported | |
189 | * | |
190 | * @param bool $prefix | |
191 | * | |
192 | * @return array | |
193 | */ | |
c3fc2621 CW |
194 | public static function &export($prefix = FALSE) { |
195 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_event_forward', $prefix, []); | |
60808919 | 196 | return $r; |
e501603b | 197 | } |
c3fc2621 | 198 | |
e7a6b91a AS |
199 | /** |
200 | * Returns the list of indices | |
c3fc2621 CW |
201 | * |
202 | * @param bool $localize | |
203 | * | |
204 | * @return array | |
e7a6b91a AS |
205 | */ |
206 | public static function indices($localize = TRUE) { | |
c3fc2621 | 207 | $indices = []; |
e7a6b91a AS |
208 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
209 | } | |
c3fc2621 | 210 | |
e501603b | 211 | } |