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/BounceType.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
449c4e6b | 9 | * (GenCodeChecksum:3870b655b29d0264bd4915d3c93a3018) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the BounceType entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Mailing_DAO_BounceType 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_bounce_type'; |
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 | * Type of bounce | |
38 | * | |
39 | * @var string | |
40 | */ | |
41 | public $name; | |
c3fc2621 | 42 | |
e501603b TO |
43 | /** |
44 | * A description of this bounce type | |
45 | * | |
46 | * @var string | |
47 | */ | |
48 | public $description; | |
c3fc2621 | 49 | |
e501603b TO |
50 | /** |
51 | * Number of bounces of this type required before the email address is put on bounce hold | |
52 | * | |
e6ca0a57 | 53 | * @var int |
e501603b TO |
54 | */ |
55 | public $hold_threshold; | |
c3fc2621 | 56 | |
e501603b | 57 | /** |
f41f0342 | 58 | * Class constructor. |
e501603b | 59 | */ |
c3fc2621 | 60 | public function __construct() { |
e501603b TO |
61 | $this->__table = 'civicrm_mailing_bounce_type'; |
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('Bounce Types'); | |
70 | } | |
71 | ||
e501603b TO |
72 | /** |
73 | * Returns all the column names of this table | |
74 | * | |
75 | * @return array | |
76 | */ | |
c3fc2621 | 77 | public static function &fields() { |
346aaaba | 78 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
79 | Civi::$statics[__CLASS__]['fields'] = [ |
80 | 'id' => [ | |
e501603b TO |
81 | 'name' => 'id', |
82 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 CW |
83 | 'title' => ts('Bounce Type ID'), |
84 | 'required' => TRUE, | |
a36434b9 | 85 | 'where' => 'civicrm_mailing_bounce_type.id', |
522a26c9 | 86 | 'table_name' => 'civicrm_mailing_bounce_type', |
87 | 'entity' => 'BounceType', | |
88 | 'bao' => 'CRM_Mailing_DAO_BounceType', | |
6a7e5e5d | 89 | 'localizable' => 0, |
c3fc2621 CW |
90 | ], |
91 | 'name' => [ | |
e501603b TO |
92 | 'name' => 'name', |
93 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 94 | 'title' => ts('Bounce Type Name'), |
215b423e | 95 | 'description' => ts('Type of bounce'), |
c3fc2621 | 96 | 'required' => TRUE, |
e501603b TO |
97 | 'maxlength' => 24, |
98 | 'size' => CRM_Utils_Type::MEDIUM, | |
a36434b9 | 99 | 'where' => 'civicrm_mailing_bounce_type.name', |
522a26c9 | 100 | 'table_name' => 'civicrm_mailing_bounce_type', |
101 | 'entity' => 'BounceType', | |
102 | 'bao' => 'CRM_Mailing_DAO_BounceType', | |
6a7e5e5d | 103 | 'localizable' => 0, |
c3fc2621 CW |
104 | ], |
105 | 'description' => [ | |
e501603b TO |
106 | 'name' => 'description', |
107 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 108 | 'title' => ts('Bounce Type Description'), |
215b423e | 109 | 'description' => ts('A description of this bounce type'), |
e501603b TO |
110 | 'maxlength' => 255, |
111 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 112 | 'where' => 'civicrm_mailing_bounce_type.description', |
522a26c9 | 113 | 'table_name' => 'civicrm_mailing_bounce_type', |
114 | 'entity' => 'BounceType', | |
115 | 'bao' => 'CRM_Mailing_DAO_BounceType', | |
6a7e5e5d | 116 | 'localizable' => 0, |
c3fc2621 CW |
117 | ], |
118 | 'hold_threshold' => [ | |
e501603b TO |
119 | 'name' => 'hold_threshold', |
120 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 121 | 'title' => ts('Hold Threshold'), |
215b423e | 122 | 'description' => ts('Number of bounces of this type required before the email address is put on bounce hold'), |
c3fc2621 | 123 | 'required' => TRUE, |
a36434b9 | 124 | 'where' => 'civicrm_mailing_bounce_type.hold_threshold', |
522a26c9 | 125 | 'table_name' => 'civicrm_mailing_bounce_type', |
126 | 'entity' => 'BounceType', | |
127 | 'bao' => 'CRM_Mailing_DAO_BounceType', | |
6a7e5e5d | 128 | 'localizable' => 0, |
c3fc2621 CW |
129 | ], |
130 | ]; | |
346aaaba | 131 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 132 | } |
346aaaba | 133 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 134 | } |
c3fc2621 | 135 | |
e501603b | 136 | /** |
bd8e0b14 | 137 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
138 | * |
139 | * @return array | |
bd8e0b14 | 140 | * Array(string $name => string $uniqueName). |
e501603b | 141 | */ |
c3fc2621 | 142 | public static function &fieldKeys() { |
bd8e0b14 TO |
143 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
144 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 145 | } |
bd8e0b14 | 146 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 147 | } |
c3fc2621 | 148 | |
e501603b TO |
149 | /** |
150 | * Returns the names of this table | |
151 | * | |
152 | * @return string | |
153 | */ | |
c3fc2621 | 154 | public static function getTableName() { |
e501603b TO |
155 | return self::$_tableName; |
156 | } | |
c3fc2621 | 157 | |
e501603b TO |
158 | /** |
159 | * Returns if this table needs to be logged | |
160 | * | |
c3fc2621 | 161 | * @return bool |
e501603b | 162 | */ |
c3fc2621 | 163 | public function getLog() { |
e501603b TO |
164 | return self::$_log; |
165 | } | |
c3fc2621 | 166 | |
e501603b TO |
167 | /** |
168 | * Returns the list of fields that can be imported | |
169 | * | |
170 | * @param bool $prefix | |
171 | * | |
172 | * @return array | |
173 | */ | |
c3fc2621 CW |
174 | public static function &import($prefix = FALSE) { |
175 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_bounce_type', $prefix, []); | |
60808919 | 176 | return $r; |
e501603b | 177 | } |
c3fc2621 | 178 | |
e501603b TO |
179 | /** |
180 | * Returns the list of fields that can be exported | |
181 | * | |
182 | * @param bool $prefix | |
183 | * | |
184 | * @return array | |
185 | */ | |
c3fc2621 CW |
186 | public static function &export($prefix = FALSE) { |
187 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_bounce_type', $prefix, []); | |
60808919 | 188 | return $r; |
e501603b | 189 | } |
c3fc2621 | 190 | |
e7a6b91a AS |
191 | /** |
192 | * Returns the list of indices | |
c3fc2621 CW |
193 | * |
194 | * @param bool $localize | |
195 | * | |
196 | * @return array | |
e7a6b91a AS |
197 | */ |
198 | public static function indices($localize = TRUE) { | |
c3fc2621 | 199 | $indices = []; |
e7a6b91a AS |
200 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
201 | } | |
c3fc2621 | 202 | |
e501603b | 203 | } |