5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/Mailing/BouncePattern.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:e36e2c40e59bfe04998b2e4e216724b6)
13 * Database access object for the BouncePattern entity.
15 class CRM_Mailing_DAO_BouncePattern
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 public static $_tableName = 'civicrm_mailing_bounce_pattern';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
29 public static $_log = FALSE;
41 public $bounce_type_id;
44 * A regexp to match a message to a bounce type
53 public function __construct() {
54 $this->__table
= 'civicrm_mailing_bounce_pattern';
55 parent
::__construct();
59 * Returns localized title of this entity.
61 public static function getEntityTitle() {
62 return ts('Bounce Patterns');
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(), 'bounce_type_id', 'civicrm_mailing_bounce_type', 'id');
75 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
77 return Civi
::$statics[__CLASS__
]['links'];
81 * Returns all the column names of this table
85 public static function &fields() {
86 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
87 Civi
::$statics[__CLASS__
]['fields'] = [
90 'type' => CRM_Utils_Type
::T_INT
,
91 'title' => ts('Bounce Pattern ID'),
93 'where' => 'civicrm_mailing_bounce_pattern.id',
94 'table_name' => 'civicrm_mailing_bounce_pattern',
95 'entity' => 'BouncePattern',
96 'bao' => 'CRM_Mailing_BAO_BouncePattern',
100 'bounce_type_id' => [
101 'name' => 'bounce_type_id',
102 'type' => CRM_Utils_Type
::T_INT
,
103 'title' => ts('Bounce Type'),
104 'description' => ts('Type of bounce'),
106 'where' => 'civicrm_mailing_bounce_pattern.bounce_type_id',
107 'table_name' => 'civicrm_mailing_bounce_pattern',
108 'entity' => 'BouncePattern',
109 'bao' => 'CRM_Mailing_BAO_BouncePattern',
111 'FKClassName' => 'CRM_Mailing_DAO_BounceType',
112 'pseudoconstant' => [
113 'table' => 'civicrm_mailing_bounce_type',
115 'labelColumn' => 'name',
121 'type' => CRM_Utils_Type
::T_STRING
,
122 'title' => ts('Pattern'),
123 'description' => ts('A regexp to match a message to a bounce type'),
125 'size' => CRM_Utils_Type
::HUGE
,
126 'where' => 'civicrm_mailing_bounce_pattern.pattern',
127 'table_name' => 'civicrm_mailing_bounce_pattern',
128 'entity' => 'BouncePattern',
129 'bao' => 'CRM_Mailing_BAO_BouncePattern',
134 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
136 return Civi
::$statics[__CLASS__
]['fields'];
140 * Return a mapping from field-name to the corresponding key (as used in fields()).
143 * Array(string $name => string $uniqueName).
145 public static function &fieldKeys() {
146 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
147 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
149 return Civi
::$statics[__CLASS__
]['fieldKeys'];
153 * Returns the names of this table
157 public static function getTableName() {
158 return self
::$_tableName;
162 * Returns if this table needs to be logged
166 public function getLog() {
171 * Returns the list of fields that can be imported
173 * @param bool $prefix
177 public static function &import($prefix = FALSE) {
178 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'mailing_bounce_pattern', $prefix, []);
183 * Returns the list of fields that can be exported
185 * @param bool $prefix
189 public static function &export($prefix = FALSE) {
190 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'mailing_bounce_pattern', $prefix, []);
195 * Returns the list of indices
197 * @param bool $localize
201 public static function indices($localize = TRUE) {
203 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;