5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/Mailing/MailingComponent.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:1d0efc3e5ba8dcd6d6bbc422877b86b4)
13 * Database access object for the MailingComponent entity.
15 class CRM_Mailing_DAO_MailingComponent
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 public static $_tableName = 'civicrm_mailing_component';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
29 public static $_log = FALSE;
37 * The name of this component
48 public $component_type;
56 * Body of the component in html format.
63 * Body of the component in text format.
70 * Is this the default component for this component_type?
77 * Is this property active?
86 public function __construct() {
87 $this->__table
= 'civicrm_mailing_component';
88 parent
::__construct();
92 * Returns localized title of this entity.
94 public static function getEntityTitle() {
95 return ts('Mailing Components');
99 * Returns all the column names of this table
103 public static function &fields() {
104 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
105 Civi
::$statics[__CLASS__
]['fields'] = [
108 'type' => CRM_Utils_Type
::T_INT
,
109 'title' => ts('Mailing Component ID'),
111 'where' => 'civicrm_mailing_component.id',
112 'table_name' => 'civicrm_mailing_component',
113 'entity' => 'MailingComponent',
114 'bao' => 'CRM_Mailing_BAO_MailingComponent',
120 'type' => CRM_Utils_Type
::T_STRING
,
121 'title' => ts('Component Name'),
122 'description' => ts('The name of this component'),
124 'size' => CRM_Utils_Type
::BIG
,
125 'where' => 'civicrm_mailing_component.name',
126 'table_name' => 'civicrm_mailing_component',
127 'entity' => 'MailingComponent',
128 'bao' => 'CRM_Mailing_BAO_MailingComponent',
132 'component_type' => [
133 'name' => 'component_type',
134 'type' => CRM_Utils_Type
::T_STRING
,
135 'title' => ts('Mailing Component Type'),
136 'description' => ts('Type of Component.'),
138 'size' => CRM_Utils_Type
::TWELVE
,
139 'where' => 'civicrm_mailing_component.component_type',
140 'table_name' => 'civicrm_mailing_component',
141 'entity' => 'MailingComponent',
142 'bao' => 'CRM_Mailing_BAO_MailingComponent',
147 'pseudoconstant' => [
148 'callback' => 'CRM_Core_SelectValues::mailingComponents',
154 'type' => CRM_Utils_Type
::T_STRING
,
155 'title' => ts('Subject'),
157 'size' => CRM_Utils_Type
::HUGE
,
158 'where' => 'civicrm_mailing_component.subject',
159 'table_name' => 'civicrm_mailing_component',
160 'entity' => 'MailingComponent',
161 'bao' => 'CRM_Mailing_BAO_MailingComponent',
166 'name' => 'body_html',
167 'type' => CRM_Utils_Type
::T_TEXT
,
168 'title' => ts('Mailing Component Body HTML'),
169 'description' => ts('Body of the component in html format.'),
172 'where' => 'civicrm_mailing_component.body_html',
173 'table_name' => 'civicrm_mailing_component',
174 'entity' => 'MailingComponent',
175 'bao' => 'CRM_Mailing_BAO_MailingComponent',
178 'type' => 'TextArea',
183 'name' => 'body_text',
184 'type' => CRM_Utils_Type
::T_TEXT
,
185 'title' => ts('Body Text'),
186 'description' => ts('Body of the component in text format.'),
189 'where' => 'civicrm_mailing_component.body_text',
190 'table_name' => 'civicrm_mailing_component',
191 'entity' => 'MailingComponent',
192 'bao' => 'CRM_Mailing_BAO_MailingComponent',
195 'type' => 'TextArea',
200 'name' => 'is_default',
201 'type' => CRM_Utils_Type
::T_BOOLEAN
,
202 'title' => ts('Mailing Component is Default?'),
203 'description' => ts('Is this the default component for this component_type?'),
204 'where' => 'civicrm_mailing_component.is_default',
206 'table_name' => 'civicrm_mailing_component',
207 'entity' => 'MailingComponent',
208 'bao' => 'CRM_Mailing_BAO_MailingComponent',
213 'name' => 'is_active',
214 'type' => CRM_Utils_Type
::T_BOOLEAN
,
215 'title' => ts('Mailing Component Is Active?'),
216 'description' => ts('Is this property active?'),
217 'where' => 'civicrm_mailing_component.is_active',
218 'table_name' => 'civicrm_mailing_component',
219 'entity' => 'MailingComponent',
220 'bao' => 'CRM_Mailing_BAO_MailingComponent',
225 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
227 return Civi
::$statics[__CLASS__
]['fields'];
231 * Return a mapping from field-name to the corresponding key (as used in fields()).
234 * Array(string $name => string $uniqueName).
236 public static function &fieldKeys() {
237 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
238 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
240 return Civi
::$statics[__CLASS__
]['fieldKeys'];
244 * Returns the names of this table
248 public static function getTableName() {
249 return self
::$_tableName;
253 * Returns if this table needs to be logged
257 public function getLog() {
262 * Returns the list of fields that can be imported
264 * @param bool $prefix
268 public static function &import($prefix = FALSE) {
269 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'mailing_component', $prefix, []);
274 * Returns the list of fields that can be exported
276 * @param bool $prefix
280 public static function &export($prefix = FALSE) {
281 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'mailing_component', $prefix, []);
286 * Returns the list of indices
288 * @param bool $localize
292 public static function indices($localize = TRUE) {
294 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;