5 * @copyright CiviCRM LLC (c) 2004-2019
7 * Generated from xml/schema/CRM/Mailing/Event/Forward.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:fbff44da80d2e268d0fcb1514dc41ffd)
13 * Database access object for the Forward entity.
15 class CRM_Mailing_Event_DAO_Forward
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 public static $_tableName = 'civicrm_mailing_event_forward';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
29 public static $_log = FALSE;
41 public $event_queue_id;
44 * FK to EventQueue for destination
48 public $dest_queue_id;
51 * When this forward event occurred.
60 public function __construct() {
61 $this->__table
= 'civicrm_mailing_event_forward';
62 parent
::__construct();
66 * Returns foreign keys and entity references.
69 * [CRM_Core_Reference_Interface]
71 public static function getReferenceColumns() {
72 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
73 Civi
::$statics[__CLASS__
]['links'] = static::createReferenceColumns(__CLASS__
);
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');
76 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
78 return Civi
::$statics[__CLASS__
]['links'];
82 * Returns all the column names of this table
86 public static function &fields() {
87 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
88 Civi
::$statics[__CLASS__
]['fields'] = [
91 'type' => CRM_Utils_Type
::T_INT
,
92 'title' => ts('Forward ID'),
94 'where' => 'civicrm_mailing_event_forward.id',
95 'table_name' => 'civicrm_mailing_event_forward',
96 'entity' => 'Forward',
97 'bao' => 'CRM_Mailing_Event_BAO_Forward',
100 'event_queue_id' => [
101 'name' => 'event_queue_id',
102 'type' => CRM_Utils_Type
::T_INT
,
103 'title' => ts('Mailing Event Queue'),
104 'description' => ts('FK to EventQueue'),
106 'where' => 'civicrm_mailing_event_forward.event_queue_id',
107 'table_name' => 'civicrm_mailing_event_forward',
108 'entity' => 'Forward',
109 'bao' => 'CRM_Mailing_Event_BAO_Forward',
111 'FKClassName' => 'CRM_Mailing_Event_DAO_Queue',
114 'name' => 'dest_queue_id',
115 'type' => CRM_Utils_Type
::T_INT
,
116 'title' => ts('Destination Queue'),
117 'description' => ts('FK to EventQueue for destination'),
118 'where' => 'civicrm_mailing_event_forward.dest_queue_id',
119 'table_name' => 'civicrm_mailing_event_forward',
120 'entity' => 'Forward',
121 'bao' => 'CRM_Mailing_Event_BAO_Forward',
123 'FKClassName' => 'CRM_Mailing_Event_DAO_Queue',
126 'name' => 'time_stamp',
127 'type' => CRM_Utils_Type
::T_TIMESTAMP
,
128 'title' => ts('Timestamp'),
129 'description' => ts('When this forward event occurred.'),
131 'where' => 'civicrm_mailing_event_forward.time_stamp',
132 'default' => 'CURRENT_TIMESTAMP',
133 'table_name' => 'civicrm_mailing_event_forward',
134 'entity' => 'Forward',
135 'bao' => 'CRM_Mailing_Event_BAO_Forward',
139 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
141 return Civi
::$statics[__CLASS__
]['fields'];
145 * Return a mapping from field-name to the corresponding key (as used in fields()).
148 * Array(string $name => string $uniqueName).
150 public static function &fieldKeys() {
151 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
152 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
154 return Civi
::$statics[__CLASS__
]['fieldKeys'];
158 * Returns the names of this table
162 public static function getTableName() {
163 return self
::$_tableName;
167 * Returns if this table needs to be logged
171 public function getLog() {
176 * Returns the list of fields that can be imported
178 * @param bool $prefix
182 public static function &import($prefix = FALSE) {
183 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'mailing_event_forward', $prefix, []);
188 * Returns the list of fields that can be exported
190 * @param bool $prefix
194 public static function &export($prefix = FALSE) {
195 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'mailing_event_forward', $prefix, []);
200 * Returns the list of indices
202 * @param bool $localize
206 public static function indices($localize = TRUE) {
208 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;