5 * @copyright CiviCRM LLC (c) 2004-2019
7 * Generated from xml/schema/CRM/Mailing/Event/Subscribe.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:081be4da95465c1f28e13d936b372345)
13 * Database access object for the Subscribe entity.
15 class CRM_Mailing_Event_DAO_Subscribe
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 public static $_tableName = 'civicrm_mailing_event_subscribe';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
29 public static $_log = FALSE;
58 * When this subscription event occurred.
67 public function __construct() {
68 $this->__table
= 'civicrm_mailing_event_subscribe';
69 parent
::__construct();
73 * Returns foreign keys and entity references.
76 * [CRM_Core_Reference_Interface]
78 public static function getReferenceColumns() {
79 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
80 Civi
::$statics[__CLASS__
]['links'] = static::createReferenceColumns(__CLASS__
);
81 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'group_id', 'civicrm_group', 'id');
82 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'contact_id', 'civicrm_contact', 'id');
83 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
85 return Civi
::$statics[__CLASS__
]['links'];
89 * Returns all the column names of this table
93 public static function &fields() {
94 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
95 Civi
::$statics[__CLASS__
]['fields'] = [
98 'type' => CRM_Utils_Type
::T_INT
,
99 'title' => ts('Mailing Subscribe ID'),
101 'where' => 'civicrm_mailing_event_subscribe.id',
102 'table_name' => 'civicrm_mailing_event_subscribe',
103 'entity' => 'Subscribe',
104 'bao' => 'CRM_Mailing_Event_BAO_Subscribe',
108 'name' => 'group_id',
109 'type' => CRM_Utils_Type
::T_INT
,
110 'title' => ts('Mailing Subscribe Group'),
111 'description' => ts('FK to Group'),
113 'where' => 'civicrm_mailing_event_subscribe.group_id',
114 'table_name' => 'civicrm_mailing_event_subscribe',
115 'entity' => 'Subscribe',
116 'bao' => 'CRM_Mailing_Event_BAO_Subscribe',
118 'FKClassName' => 'CRM_Contact_DAO_Group',
122 'pseudoconstant' => [
123 'table' => 'civicrm_group',
125 'labelColumn' => 'title',
129 'name' => 'contact_id',
130 'type' => CRM_Utils_Type
::T_INT
,
131 'title' => ts('Mailing Subscribe Contact'),
132 'description' => ts('FK to Contact'),
134 'where' => 'civicrm_mailing_event_subscribe.contact_id',
135 'table_name' => 'civicrm_mailing_event_subscribe',
136 'entity' => 'Subscribe',
137 'bao' => 'CRM_Mailing_Event_BAO_Subscribe',
139 'FKClassName' => 'CRM_Contact_DAO_Contact',
143 'type' => CRM_Utils_Type
::T_STRING
,
144 'title' => ts('Mailing Subscribe Hash'),
145 'description' => ts('Security hash'),
148 'size' => CRM_Utils_Type
::HUGE
,
149 'where' => 'civicrm_mailing_event_subscribe.hash',
150 'table_name' => 'civicrm_mailing_event_subscribe',
151 'entity' => 'Subscribe',
152 'bao' => 'CRM_Mailing_Event_BAO_Subscribe',
156 'name' => 'time_stamp',
157 'type' => CRM_Utils_Type
::T_TIMESTAMP
,
158 'title' => ts('Mailing Subscribe Timestamp'),
159 'description' => ts('When this subscription event occurred.'),
161 'where' => 'civicrm_mailing_event_subscribe.time_stamp',
162 'default' => 'CURRENT_TIMESTAMP',
163 'table_name' => 'civicrm_mailing_event_subscribe',
164 'entity' => 'Subscribe',
165 'bao' => 'CRM_Mailing_Event_BAO_Subscribe',
169 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
171 return Civi
::$statics[__CLASS__
]['fields'];
175 * Return a mapping from field-name to the corresponding key (as used in fields()).
178 * Array(string $name => string $uniqueName).
180 public static function &fieldKeys() {
181 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
182 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
184 return Civi
::$statics[__CLASS__
]['fieldKeys'];
188 * Returns the names of this table
192 public static function getTableName() {
193 return self
::$_tableName;
197 * Returns if this table needs to be logged
201 public function getLog() {
206 * Returns the list of fields that can be imported
208 * @param bool $prefix
212 public static function &import($prefix = FALSE) {
213 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'mailing_event_subscribe', $prefix, []);
218 * Returns the list of fields that can be exported
220 * @param bool $prefix
224 public static function &export($prefix = FALSE) {
225 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'mailing_event_subscribe', $prefix, []);
230 * Returns the list of indices
232 * @param bool $localize
236 public static function indices($localize = TRUE) {
238 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;