CRM-20312 regenerated DAO with localisation
[civicrm-core.git] / CRM / Mailing / DAO / BounceType.php
CommitLineData
e501603b
TO
1<?php
2/*
3+--------------------------------------------------------------------+
4| CiviCRM version 4.7 |
5+--------------------------------------------------------------------+
0f03f337 6| Copyright CiviCRM LLC (c) 2004-2017 |
e501603b
TO
7+--------------------------------------------------------------------+
8| This file is a part of CiviCRM. |
9| |
10| CiviCRM is free software; you can copy, modify, and distribute it |
11| under the terms of the GNU Affero General Public License |
12| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
13| |
14| CiviCRM is distributed in the hope that it will be useful, but |
15| WITHOUT ANY WARRANTY; without even the implied warranty of |
16| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17| See the GNU Affero General Public License for more details. |
18| |
19| You should have received a copy of the GNU Affero General Public |
20| License and the CiviCRM Licensing Exception along |
21| with this program; if not, contact CiviCRM LLC |
22| at info[AT]civicrm[DOT]org. If you have questions about the |
23| GNU Affero General Public License or the licensing of CiviCRM, |
24| see the CiviCRM license FAQ at http://civicrm.org/licensing |
25+--------------------------------------------------------------------+
26*/
27/**
28 * @package CRM
0f03f337 29 * @copyright CiviCRM LLC (c) 2004-2017
e501603b
TO
30 *
31 * Generated from xml/schema/CRM/Mailing/BounceType.xml
32 * DO NOT EDIT. Generated by CRM_Core_CodeGen
022785d8 33 * (GenCodeChecksum:58e082dadf7a5125e5c34d0f9cffb0f1)
e501603b
TO
34 */
35require_once 'CRM/Core/DAO.php';
36require_once 'CRM/Utils/Type.php';
f41f0342 37/**
38 * CRM_Mailing_DAO_BounceType constructor.
39 */
e501603b
TO
40class CRM_Mailing_DAO_BounceType extends CRM_Core_DAO {
41 /**
f41f0342 42 * Static instance to hold the table name.
e501603b
TO
43 *
44 * @var string
45 */
46 static $_tableName = 'civicrm_mailing_bounce_type';
e501603b 47 /**
f41f0342 48 * Should CiviCRM log any modifications to this table in the civicrm_log table.
e501603b
TO
49 *
50 * @var boolean
51 */
52 static $_log = false;
53 /**
54 *
55 * @var int unsigned
56 */
57 public $id;
58 /**
59 * Type of bounce
60 *
61 * @var string
62 */
63 public $name;
64 /**
65 * A description of this bounce type
66 *
67 * @var string
68 */
69 public $description;
70 /**
71 * Number of bounces of this type required before the email address is put on bounce hold
72 *
73 * @var int unsigned
74 */
75 public $hold_threshold;
76 /**
f41f0342 77 * Class constructor.
e501603b
TO
78 */
79 function __construct() {
80 $this->__table = 'civicrm_mailing_bounce_type';
81 parent::__construct();
82 }
83 /**
84 * Returns all the column names of this table
85 *
86 * @return array
87 */
88 static function &fields() {
346aaaba
TO
89 if (!isset(Civi::$statics[__CLASS__]['fields'])) {
90 Civi::$statics[__CLASS__]['fields'] = array(
e501603b
TO
91 'id' => array(
92 'name' => 'id',
93 'type' => CRM_Utils_Type::T_INT,
94 'title' => ts('Bounce Type ID') ,
95 'required' => true,
522a26c9 96 'table_name' => 'civicrm_mailing_bounce_type',
97 'entity' => 'BounceType',
98 'bao' => 'CRM_Mailing_DAO_BounceType',
6a7e5e5d 99 'localizable' => 0,
e501603b
TO
100 ) ,
101 'name' => array(
102 'name' => 'name',
103 'type' => CRM_Utils_Type::T_STRING,
104 'title' => ts('Bounce Type Name') ,
105 'description' => 'Type of bounce',
106 'required' => true,
107 'maxlength' => 24,
108 'size' => CRM_Utils_Type::MEDIUM,
522a26c9 109 'table_name' => 'civicrm_mailing_bounce_type',
110 'entity' => 'BounceType',
111 'bao' => 'CRM_Mailing_DAO_BounceType',
6a7e5e5d 112 'localizable' => 0,
e501603b
TO
113 ) ,
114 'description' => array(
115 'name' => 'description',
116 'type' => CRM_Utils_Type::T_STRING,
117 'title' => ts('Bounce Type Description') ,
118 'description' => 'A description of this bounce type',
119 'maxlength' => 255,
120 'size' => CRM_Utils_Type::HUGE,
522a26c9 121 'table_name' => 'civicrm_mailing_bounce_type',
122 'entity' => 'BounceType',
123 'bao' => 'CRM_Mailing_DAO_BounceType',
6a7e5e5d 124 'localizable' => 0,
e501603b
TO
125 ) ,
126 'hold_threshold' => array(
127 'name' => 'hold_threshold',
128 'type' => CRM_Utils_Type::T_INT,
129 'title' => ts('Hold Threshold') ,
130 'description' => 'Number of bounces of this type required before the email address is put on bounce hold',
131 'required' => true,
522a26c9 132 'table_name' => 'civicrm_mailing_bounce_type',
133 'entity' => 'BounceType',
134 'bao' => 'CRM_Mailing_DAO_BounceType',
6a7e5e5d 135 'localizable' => 0,
e501603b
TO
136 ) ,
137 );
346aaaba 138 CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
e501603b 139 }
346aaaba 140 return Civi::$statics[__CLASS__]['fields'];
e501603b
TO
141 }
142 /**
bd8e0b14 143 * Return a mapping from field-name to the corresponding key (as used in fields()).
e501603b
TO
144 *
145 * @return array
bd8e0b14 146 * Array(string $name => string $uniqueName).
e501603b
TO
147 */
148 static function &fieldKeys() {
bd8e0b14
TO
149 if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
150 Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
e501603b 151 }
bd8e0b14 152 return Civi::$statics[__CLASS__]['fieldKeys'];
e501603b
TO
153 }
154 /**
155 * Returns the names of this table
156 *
157 * @return string
158 */
159 static function getTableName() {
160 return self::$_tableName;
161 }
162 /**
163 * Returns if this table needs to be logged
164 *
165 * @return boolean
166 */
167 function getLog() {
168 return self::$_log;
169 }
170 /**
171 * Returns the list of fields that can be imported
172 *
173 * @param bool $prefix
174 *
175 * @return array
176 */
177 static function &import($prefix = false) {
60808919
TO
178 $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_bounce_type', $prefix, array());
179 return $r;
e501603b
TO
180 }
181 /**
182 * Returns the list of fields that can be exported
183 *
184 * @param bool $prefix
185 *
186 * @return array
187 */
188 static function &export($prefix = false) {
60808919
TO
189 $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_bounce_type', $prefix, array());
190 return $r;
e501603b
TO
191 }
192}