Commit | Line | Data |
---|---|---|
e501603b | 1 | <?php |
c3fc2621 | 2 | |
e501603b TO |
3 | /** |
4 | * @package CRM | |
ca5cec67 | 5 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
e501603b | 6 | * |
807f8008 | 7 | * Generated from xml/schema/CRM/Mailing/MailingComponent.xml |
e501603b | 8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen |
449c4e6b | 9 | * (GenCodeChecksum:0a36b87bc4baaec899f666c22187a071) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
807f8008 | 13 | * Database access object for the MailingComponent entity. |
f41f0342 | 14 | */ |
807f8008 | 15 | class CRM_Mailing_DAO_MailingComponent 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_component'; |
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 | * The name of this component | |
38 | * | |
39 | * @var string | |
40 | */ | |
41 | public $name; | |
c3fc2621 | 42 | |
e501603b TO |
43 | /** |
44 | * Type of Component. | |
45 | * | |
46 | * @var string | |
47 | */ | |
48 | public $component_type; | |
c3fc2621 | 49 | |
e501603b | 50 | /** |
e501603b TO |
51 | * @var string |
52 | */ | |
53 | public $subject; | |
c3fc2621 | 54 | |
e501603b TO |
55 | /** |
56 | * Body of the component in html format. | |
57 | * | |
58 | * @var text | |
59 | */ | |
60 | public $body_html; | |
c3fc2621 | 61 | |
e501603b TO |
62 | /** |
63 | * Body of the component in text format. | |
64 | * | |
65 | * @var text | |
66 | */ | |
67 | public $body_text; | |
c3fc2621 | 68 | |
e501603b TO |
69 | /** |
70 | * Is this the default component for this component_type? | |
71 | * | |
e6ca0a57 | 72 | * @var bool |
e501603b TO |
73 | */ |
74 | public $is_default; | |
c3fc2621 | 75 | |
e501603b TO |
76 | /** |
77 | * Is this property active? | |
78 | * | |
e6ca0a57 | 79 | * @var bool |
e501603b TO |
80 | */ |
81 | public $is_active; | |
c3fc2621 | 82 | |
e501603b | 83 | /** |
f41f0342 | 84 | * Class constructor. |
e501603b | 85 | */ |
c3fc2621 | 86 | public function __construct() { |
e501603b TO |
87 | $this->__table = 'civicrm_mailing_component'; |
88 | parent::__construct(); | |
89 | } | |
c3fc2621 | 90 | |
449c4e6b CW |
91 | /** |
92 | * Returns localized title of this entity. | |
93 | */ | |
94 | public static function getEntityTitle() { | |
95 | return ts('Mailing Components'); | |
96 | } | |
97 | ||
e501603b TO |
98 | /** |
99 | * Returns all the column names of this table | |
100 | * | |
101 | * @return array | |
102 | */ | |
c3fc2621 | 103 | public static function &fields() { |
346aaaba | 104 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
105 | Civi::$statics[__CLASS__]['fields'] = [ |
106 | 'id' => [ | |
e501603b TO |
107 | 'name' => 'id', |
108 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 CW |
109 | 'title' => ts('Mailing Component ID'), |
110 | 'required' => TRUE, | |
a36434b9 | 111 | 'where' => 'civicrm_mailing_component.id', |
522a26c9 | 112 | 'table_name' => 'civicrm_mailing_component', |
807f8008 | 113 | 'entity' => 'MailingComponent', |
a0eea7b9 | 114 | 'bao' => 'CRM_Mailing_BAO_MailingComponent', |
6a7e5e5d | 115 | 'localizable' => 0, |
c3fc2621 CW |
116 | ], |
117 | 'name' => [ | |
e501603b TO |
118 | 'name' => 'name', |
119 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 120 | 'title' => ts('Component Name'), |
215b423e | 121 | 'description' => ts('The name of this component'), |
e501603b TO |
122 | 'maxlength' => 64, |
123 | 'size' => CRM_Utils_Type::BIG, | |
a36434b9 | 124 | 'where' => 'civicrm_mailing_component.name', |
522a26c9 | 125 | 'table_name' => 'civicrm_mailing_component', |
807f8008 | 126 | 'entity' => 'MailingComponent', |
a0eea7b9 | 127 | 'bao' => 'CRM_Mailing_BAO_MailingComponent', |
6a7e5e5d | 128 | 'localizable' => 0, |
c3fc2621 CW |
129 | ], |
130 | 'component_type' => [ | |
e501603b TO |
131 | 'name' => 'component_type', |
132 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 133 | 'title' => ts('Mailing Component Type'), |
215b423e | 134 | 'description' => ts('Type of Component.'), |
e501603b TO |
135 | 'maxlength' => 12, |
136 | 'size' => CRM_Utils_Type::TWELVE, | |
a36434b9 | 137 | 'where' => 'civicrm_mailing_component.component_type', |
522a26c9 | 138 | 'table_name' => 'civicrm_mailing_component', |
807f8008 | 139 | 'entity' => 'MailingComponent', |
a0eea7b9 | 140 | 'bao' => 'CRM_Mailing_BAO_MailingComponent', |
6a7e5e5d | 141 | 'localizable' => 0, |
c3fc2621 | 142 | 'html' => [ |
e501603b | 143 | 'type' => 'Select', |
c3fc2621 CW |
144 | ], |
145 | 'pseudoconstant' => [ | |
e501603b | 146 | 'callback' => 'CRM_Core_SelectValues::mailingComponents', |
e6ca0a57 | 147 | ], |
c3fc2621 CW |
148 | ], |
149 | 'subject' => [ | |
e501603b TO |
150 | 'name' => 'subject', |
151 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 152 | 'title' => ts('Subject'), |
e501603b TO |
153 | 'maxlength' => 255, |
154 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 155 | 'where' => 'civicrm_mailing_component.subject', |
522a26c9 | 156 | 'table_name' => 'civicrm_mailing_component', |
807f8008 | 157 | 'entity' => 'MailingComponent', |
a0eea7b9 | 158 | 'bao' => 'CRM_Mailing_BAO_MailingComponent', |
6a7e5e5d | 159 | 'localizable' => 0, |
c3fc2621 CW |
160 | ], |
161 | 'body_html' => [ | |
e501603b TO |
162 | 'name' => 'body_html', |
163 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 164 | 'title' => ts('Mailing Component Body HTML'), |
215b423e | 165 | 'description' => ts('Body of the component in html format.'), |
e501603b TO |
166 | 'rows' => 8, |
167 | 'cols' => 80, | |
a36434b9 | 168 | 'where' => 'civicrm_mailing_component.body_html', |
522a26c9 | 169 | 'table_name' => 'civicrm_mailing_component', |
807f8008 | 170 | 'entity' => 'MailingComponent', |
a0eea7b9 | 171 | 'bao' => 'CRM_Mailing_BAO_MailingComponent', |
6a7e5e5d | 172 | 'localizable' => 0, |
c3fc2621 | 173 | 'html' => [ |
e501603b | 174 | 'type' => 'TextArea', |
c3fc2621 CW |
175 | ], |
176 | ], | |
177 | 'body_text' => [ | |
e501603b TO |
178 | 'name' => 'body_text', |
179 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 180 | 'title' => ts('Body Text'), |
215b423e | 181 | 'description' => ts('Body of the component in text format.'), |
e501603b TO |
182 | 'rows' => 8, |
183 | 'cols' => 80, | |
a36434b9 | 184 | 'where' => 'civicrm_mailing_component.body_text', |
522a26c9 | 185 | 'table_name' => 'civicrm_mailing_component', |
807f8008 | 186 | 'entity' => 'MailingComponent', |
a0eea7b9 | 187 | 'bao' => 'CRM_Mailing_BAO_MailingComponent', |
6a7e5e5d | 188 | 'localizable' => 0, |
c3fc2621 | 189 | 'html' => [ |
e501603b | 190 | 'type' => 'TextArea', |
c3fc2621 CW |
191 | ], |
192 | ], | |
193 | 'is_default' => [ | |
e501603b TO |
194 | 'name' => 'is_default', |
195 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 196 | 'title' => ts('Mailing Component is Default?'), |
215b423e | 197 | 'description' => ts('Is this the default component for this component_type?'), |
a36434b9 | 198 | 'where' => 'civicrm_mailing_component.is_default', |
45a83e42 | 199 | 'default' => '0', |
522a26c9 | 200 | 'table_name' => 'civicrm_mailing_component', |
807f8008 | 201 | 'entity' => 'MailingComponent', |
a0eea7b9 | 202 | 'bao' => 'CRM_Mailing_BAO_MailingComponent', |
6a7e5e5d | 203 | 'localizable' => 0, |
c3fc2621 CW |
204 | ], |
205 | 'is_active' => [ | |
e501603b TO |
206 | 'name' => 'is_active', |
207 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 208 | 'title' => ts('Mailing Component Is Active?'), |
215b423e | 209 | 'description' => ts('Is this property active?'), |
a36434b9 | 210 | 'where' => 'civicrm_mailing_component.is_active', |
522a26c9 | 211 | 'table_name' => 'civicrm_mailing_component', |
807f8008 | 212 | 'entity' => 'MailingComponent', |
a0eea7b9 | 213 | 'bao' => 'CRM_Mailing_BAO_MailingComponent', |
6a7e5e5d | 214 | 'localizable' => 0, |
c3fc2621 CW |
215 | ], |
216 | ]; | |
346aaaba | 217 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 218 | } |
346aaaba | 219 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 220 | } |
c3fc2621 | 221 | |
e501603b | 222 | /** |
bd8e0b14 | 223 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
224 | * |
225 | * @return array | |
bd8e0b14 | 226 | * Array(string $name => string $uniqueName). |
e501603b | 227 | */ |
c3fc2621 | 228 | public static function &fieldKeys() { |
bd8e0b14 TO |
229 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
230 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 231 | } |
bd8e0b14 | 232 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 233 | } |
c3fc2621 | 234 | |
e501603b TO |
235 | /** |
236 | * Returns the names of this table | |
237 | * | |
238 | * @return string | |
239 | */ | |
c3fc2621 | 240 | public static function getTableName() { |
e501603b TO |
241 | return self::$_tableName; |
242 | } | |
c3fc2621 | 243 | |
e501603b TO |
244 | /** |
245 | * Returns if this table needs to be logged | |
246 | * | |
c3fc2621 | 247 | * @return bool |
e501603b | 248 | */ |
c3fc2621 | 249 | public function getLog() { |
e501603b TO |
250 | return self::$_log; |
251 | } | |
c3fc2621 | 252 | |
e501603b TO |
253 | /** |
254 | * Returns the list of fields that can be imported | |
255 | * | |
256 | * @param bool $prefix | |
257 | * | |
258 | * @return array | |
259 | */ | |
c3fc2621 CW |
260 | public static function &import($prefix = FALSE) { |
261 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_component', $prefix, []); | |
60808919 | 262 | return $r; |
e501603b | 263 | } |
c3fc2621 | 264 | |
e501603b TO |
265 | /** |
266 | * Returns the list of fields that can be exported | |
267 | * | |
268 | * @param bool $prefix | |
269 | * | |
270 | * @return array | |
271 | */ | |
c3fc2621 CW |
272 | public static function &export($prefix = FALSE) { |
273 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_component', $prefix, []); | |
60808919 | 274 | return $r; |
e501603b | 275 | } |
c3fc2621 | 276 | |
e7a6b91a AS |
277 | /** |
278 | * Returns the list of indices | |
c3fc2621 CW |
279 | * |
280 | * @param bool $localize | |
281 | * | |
282 | * @return array | |
e7a6b91a AS |
283 | */ |
284 | public static function indices($localize = TRUE) { | |
c3fc2621 | 285 | $indices = []; |
e7a6b91a AS |
286 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
287 | } | |
c3fc2621 | 288 | |
e501603b | 289 | } |