5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/Mailing/BounceType.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:9b56dea1b4b84d786209fd4af84a3e09)
13 * Database access object for the BounceType entity.
15 class CRM_Mailing_DAO_BounceType
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 public static $_tableName = 'civicrm_mailing_bounce_type';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
29 public static $_log = FALSE;
44 * A description of this bounce type
51 * Number of bounces of this type required before the email address is put on bounce hold
55 public $hold_threshold;
60 public function __construct() {
61 $this->__table
= 'civicrm_mailing_bounce_type';
62 parent
::__construct();
66 * Returns all the column names of this table
70 public static function &fields() {
71 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
72 Civi
::$statics[__CLASS__
]['fields'] = [
75 'type' => CRM_Utils_Type
::T_INT
,
76 'title' => ts('Bounce Type ID'),
78 'where' => 'civicrm_mailing_bounce_type.id',
79 'table_name' => 'civicrm_mailing_bounce_type',
80 'entity' => 'BounceType',
81 'bao' => 'CRM_Mailing_DAO_BounceType',
86 'type' => CRM_Utils_Type
::T_STRING
,
87 'title' => ts('Bounce Type Name'),
88 'description' => ts('Type of bounce'),
91 'size' => CRM_Utils_Type
::MEDIUM
,
92 'where' => 'civicrm_mailing_bounce_type.name',
93 'table_name' => 'civicrm_mailing_bounce_type',
94 'entity' => 'BounceType',
95 'bao' => 'CRM_Mailing_DAO_BounceType',
99 'name' => 'description',
100 'type' => CRM_Utils_Type
::T_STRING
,
101 'title' => ts('Bounce Type Description'),
102 'description' => ts('A description of this bounce type'),
104 'size' => CRM_Utils_Type
::HUGE
,
105 'where' => 'civicrm_mailing_bounce_type.description',
106 'table_name' => 'civicrm_mailing_bounce_type',
107 'entity' => 'BounceType',
108 'bao' => 'CRM_Mailing_DAO_BounceType',
111 'hold_threshold' => [
112 'name' => 'hold_threshold',
113 'type' => CRM_Utils_Type
::T_INT
,
114 'title' => ts('Hold Threshold'),
115 'description' => ts('Number of bounces of this type required before the email address is put on bounce hold'),
117 'where' => 'civicrm_mailing_bounce_type.hold_threshold',
118 'table_name' => 'civicrm_mailing_bounce_type',
119 'entity' => 'BounceType',
120 'bao' => 'CRM_Mailing_DAO_BounceType',
124 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
126 return Civi
::$statics[__CLASS__
]['fields'];
130 * Return a mapping from field-name to the corresponding key (as used in fields()).
133 * Array(string $name => string $uniqueName).
135 public static function &fieldKeys() {
136 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
137 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
139 return Civi
::$statics[__CLASS__
]['fieldKeys'];
143 * Returns the names of this table
147 public static function getTableName() {
148 return self
::$_tableName;
152 * Returns if this table needs to be logged
156 public function getLog() {
161 * Returns the list of fields that can be imported
163 * @param bool $prefix
167 public static function &import($prefix = FALSE) {
168 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'mailing_bounce_type', $prefix, []);
173 * Returns the list of fields that can be exported
175 * @param bool $prefix
179 public static function &export($prefix = FALSE) {
180 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'mailing_bounce_type', $prefix, []);
185 * Returns the list of indices
187 * @param bool $localize
191 public static function indices($localize = TRUE) {
193 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;