CRM/Core/DAO/MessageTemplate.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Core/MessageTemplate.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:10bf11ca59e77fe7be9dfd775e5d5cd0)
  10  */
  11
  12 /**
  13  * Database access object for the MessageTemplate entity.
  14  */
  15 class CRM_Core_DAO_MessageTemplate extends CRM_Core_DAO {
  16   const EXT = 'civicrm';
  17   const TABLE_ADDED = '1.6';
  18
  19   /**
  20    * Static instance to hold the table name.
  21    *
  22    * @var string
  23    */
  24   public static $_tableName = 'civicrm_msg_template';
  25
  26   /**
  27    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  28    *
  29    * @var bool
  30    */
  31   public static $_log = FALSE;
  32
  33   /**
  34    * Message Template ID
  35    *
  36    * @var int
  37    */
  38   public $id;
  39
  40   /**
  41    * Descriptive title of message
  42    *
  43    * @var string
  44    */
  45   public $msg_title;
  46
  47   /**
  48    * Subject for email message.
  49    *
  50    * @var text
  51    */
  52   public $msg_subject;
  53
  54   /**
  55    * Text formatted message
  56    *
  57    * @var longtext
  58    */
  59   public $msg_text;
  60
  61   /**
  62    * HTML formatted message
  63    *
  64    * @var longtext
  65    */
  66   public $msg_html;
  67
  68   /**
  69    * @var bool
  70    */
  71   public $is_active;
  72
  73   /**
  74    * a pseudo-FK to civicrm_option_value
  75    *
  76    * @var int
  77    */
  78   public $workflow_id;
  79
  80   /**
  81    * @var string
  82    */
  83   public $workflow_name;
  84
  85   /**
  86    * is this the default message template for the workflow referenced by workflow_id?
  87    *
  88    * @var bool
  89    */
  90   public $is_default;
  91
  92   /**
  93    * is this the reserved message template which we ship for the workflow referenced by workflow_id?
  94    *
  95    * @var bool
  96    */
  97   public $is_reserved;
  98
  99   /**
 100    * Is this message template used for sms?
 101    *
 102    * @var bool
 103    */
 104   public $is_sms;
 105
 106   /**
 107    * a pseudo-FK to civicrm_option_value containing PDF Page Format.
 108    *
 109    * @var int
 110    */
 111   public $pdf_format_id;
 112
 113   /**
 114    * Class constructor.
 115    */
 116   public function __construct() {
 117     $this->__table = 'civicrm_msg_template';
 118     parent::__construct();
 119   }
 120
 121   /**
 122    * Returns localized title of this entity.
 123    *
 124    * @param bool $plural
 125    *   Whether to return the plural version of the title.
 126    */
 127   public static function getEntityTitle($plural = FALSE) {
 128     return $plural ? ts('Message Templates') : ts('Message Template');
 129   }
 130
 131   /**
 132    * Returns all the column names of this table
 133    *
 134    * @return array
 135    */
 136   public static function &fields() {
 137     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 138       Civi::$statics[__CLASS__]['fields'] = [
 139         'id' => [
 140           'name' => 'id',
 141           'type' => CRM_Utils_Type::T_INT,
 142           'title' => ts('Message Template ID'),
 143           'description' => ts('Message Template ID'),
 144           'required' => TRUE,
 145           'where' => 'civicrm_msg_template.id',
 146           'table_name' => 'civicrm_msg_template',
 147           'entity' => 'MessageTemplate',
 148           'bao' => 'CRM_Core_BAO_MessageTemplate',
 149           'localizable' => 0,
 150           'html' => [
 151             'type' => 'Number',
 152           ],
 153           'readonly' => TRUE,
 154           'add' => '1.6',
 155         ],
 156         'msg_title' => [
 157           'name' => 'msg_title',
 158           'type' => CRM_Utils_Type::T_STRING,
 159           'title' => ts('Message Template Title'),
 160           'description' => ts('Descriptive title of message'),
 161           'maxlength' => 255,
 162           'size' => CRM_Utils_Type::HUGE,
 163           'where' => 'civicrm_msg_template.msg_title',
 164           'table_name' => 'civicrm_msg_template',
 165           'entity' => 'MessageTemplate',
 166           'bao' => 'CRM_Core_BAO_MessageTemplate',
 167           'localizable' => 0,
 168           'add' => '1.6',
 169         ],
 170         'msg_subject' => [
 171           'name' => 'msg_subject',
 172           'type' => CRM_Utils_Type::T_TEXT,
 173           'title' => ts('Message Template Subject'),
 174           'description' => ts('Subject for email message.'),
 175           'where' => 'civicrm_msg_template.msg_subject',
 176           'table_name' => 'civicrm_msg_template',
 177           'entity' => 'MessageTemplate',
 178           'bao' => 'CRM_Core_BAO_MessageTemplate',
 179           'localizable' => 0,
 180           'add' => '1.6',
 181         ],
 182         'msg_text' => [
 183           'name' => 'msg_text',
 184           'type' => CRM_Utils_Type::T_LONGTEXT,
 185           'title' => ts('Message Template Text'),
 186           'description' => ts('Text formatted message'),
 187           'where' => 'civicrm_msg_template.msg_text',
 188           'table_name' => 'civicrm_msg_template',
 189           'entity' => 'MessageTemplate',
 190           'bao' => 'CRM_Core_BAO_MessageTemplate',
 191           'localizable' => 0,
 192           'html' => [
 193             'type' => 'TextArea',
 194           ],
 195           'add' => '1.6',
 196         ],
 197         'msg_html' => [
 198           'name' => 'msg_html',
 199           'type' => CRM_Utils_Type::T_LONGTEXT,
 200           'title' => ts('Message Template HTML'),
 201           'description' => ts('HTML formatted message'),
 202           'where' => 'civicrm_msg_template.msg_html',
 203           'table_name' => 'civicrm_msg_template',
 204           'entity' => 'MessageTemplate',
 205           'bao' => 'CRM_Core_BAO_MessageTemplate',
 206           'localizable' => 0,
 207           'html' => [
 208             'type' => 'RichTextEditor',
 209           ],
 210           'add' => '1.6',
 211         ],
 212         'is_active' => [
 213           'name' => 'is_active',
 214           'type' => CRM_Utils_Type::T_BOOLEAN,
 215           'title' => ts('Is Active'),
 216           'where' => 'civicrm_msg_template.is_active',
 217           'default' => '1',
 218           'table_name' => 'civicrm_msg_template',
 219           'entity' => 'MessageTemplate',
 220           'bao' => 'CRM_Core_BAO_MessageTemplate',
 221           'localizable' => 0,
 222           'add' => '1.6',
 223         ],
 224         'workflow_id' => [
 225           'name' => 'workflow_id',
 226           'type' => CRM_Utils_Type::T_INT,
 227           'title' => ts('Deprecated field for Message Template Workflow.'),
 228           'description' => ts('a pseudo-FK to civicrm_option_value'),
 229           'where' => 'civicrm_msg_template.workflow_id',
 230           'table_name' => 'civicrm_msg_template',
 231           'entity' => 'MessageTemplate',
 232           'bao' => 'CRM_Core_BAO_MessageTemplate',
 233           'localizable' => 0,
 234           'add' => '3.1',
 235         ],
 236         'workflow_name' => [
 237           'name' => 'workflow_name',
 238           'type' => CRM_Utils_Type::T_STRING,
 239           'title' => ts('Message Template Workflow Name'),
 240           'maxlength' => 255,
 241           'size' => CRM_Utils_Type::HUGE,
 242           'where' => 'civicrm_msg_template.workflow_name',
 243           'table_name' => 'civicrm_msg_template',
 244           'entity' => 'MessageTemplate',
 245           'bao' => 'CRM_Core_BAO_MessageTemplate',
 246           'localizable' => 0,
 247           'add' => '5.26',
 248         ],
 249         'is_default' => [
 250           'name' => 'is_default',
 251           'type' => CRM_Utils_Type::T_BOOLEAN,
 252           'title' => ts('Message Template Is Default?'),
 253           'description' => ts('is this the default message template for the workflow referenced by workflow_id?'),
 254           'where' => 'civicrm_msg_template.is_default',
 255           'default' => '1',
 256           'table_name' => 'civicrm_msg_template',
 257           'entity' => 'MessageTemplate',
 258           'bao' => 'CRM_Core_BAO_MessageTemplate',
 259           'localizable' => 0,
 260           'add' => '3.1',
 261         ],
 262         'is_reserved' => [
 263           'name' => 'is_reserved',
 264           'type' => CRM_Utils_Type::T_BOOLEAN,
 265           'title' => ts('Message Template Is Reserved?'),
 266           'description' => ts('is this the reserved message template which we ship for the workflow referenced by workflow_id?'),
 267           'where' => 'civicrm_msg_template.is_reserved',
 268           'table_name' => 'civicrm_msg_template',
 269           'entity' => 'MessageTemplate',
 270           'bao' => 'CRM_Core_BAO_MessageTemplate',
 271           'localizable' => 0,
 272           'add' => '3.1',
 273         ],
 274         'is_sms' => [
 275           'name' => 'is_sms',
 276           'type' => CRM_Utils_Type::T_BOOLEAN,
 277           'title' => ts('Message Template is used for SMS?'),
 278           'description' => ts('Is this message template used for sms?'),
 279           'where' => 'civicrm_msg_template.is_sms',
 280           'default' => '0',
 281           'table_name' => 'civicrm_msg_template',
 282           'entity' => 'MessageTemplate',
 283           'bao' => 'CRM_Core_BAO_MessageTemplate',
 284           'localizable' => 0,
 285           'add' => '4.5',
 286         ],
 287         'pdf_format_id' => [
 288           'name' => 'pdf_format_id',
 289           'type' => CRM_Utils_Type::T_INT,
 290           'title' => ts('Message Template Format'),
 291           'description' => ts('a pseudo-FK to civicrm_option_value containing PDF Page Format.'),
 292           'where' => 'civicrm_msg_template.pdf_format_id',
 293           'table_name' => 'civicrm_msg_template',
 294           'entity' => 'MessageTemplate',
 295           'bao' => 'CRM_Core_BAO_MessageTemplate',
 296           'localizable' => 0,
 297           'pseudoconstant' => [
 298             'optionGroupName' => 'pdf_format',
 299             'keyColumn' => 'id',
 300             'optionEditPath' => 'civicrm/admin/options/pdf_format',
 301           ],
 302           'add' => '3.4',
 303         ],
 304       ];
 305       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 306     }
 307     return Civi::$statics[__CLASS__]['fields'];
 308   }
 309
 310   /**
 311    * Return a mapping from field-name to the corresponding key (as used in fields()).
 312    *
 313    * @return array
 314    *   Array(string $name => string $uniqueName).
 315    */
 316   public static function &fieldKeys() {
 317     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 318       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 319     }
 320     return Civi::$statics[__CLASS__]['fieldKeys'];
 321   }
 322
 323   /**
 324    * Returns the names of this table
 325    *
 326    * @return string
 327    */
 328   public static function getTableName() {
 329     return self::$_tableName;
 330   }
 331
 332   /**
 333    * Returns if this table needs to be logged
 334    *
 335    * @return bool
 336    */
 337   public function getLog() {
 338     return self::$_log;
 339   }
 340
 341   /**
 342    * Returns the list of fields that can be imported
 343    *
 344    * @param bool $prefix
 345    *
 346    * @return array
 347    */
 348   public static function &import($prefix = FALSE) {
 349     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'msg_template', $prefix, []);
 350     return $r;
 351   }
 352
 353   /**
 354    * Returns the list of fields that can be exported
 355    *
 356    * @param bool $prefix
 357    *
 358    * @return array
 359    */
 360   public static function &export($prefix = FALSE) {
 361     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'msg_template', $prefix, []);
 362     return $r;
 363   }
 364
 365   /**
 366    * Returns the list of indices
 367    *
 368    * @param bool $localize
 369    *
 370    * @return array
 371    */
 372   public static function indices($localize = TRUE) {
 373     $indices = [];
 374     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 375   }
 376
 377 }