CRM/Mailing/DAO/BounceType.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Mailing/BounceType.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:3870b655b29d0264bd4915d3c93a3018)
  10  */
  11
  12 /**
  13  * Database access object for the BounceType entity.
  14  */
  15 class CRM_Mailing_DAO_BounceType extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   public static $_tableName = 'civicrm_mailing_bounce_type';
  23
  24   /**
  25    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  26    *
  27    * @var bool
  28    */
  29   public static $_log = FALSE;
  30
  31   /**
  32    * @var int
  33    */
  34   public $id;
  35
  36   /**
  37    * Type of bounce
  38    *
  39    * @var string
  40    */
  41   public $name;
  42
  43   /**
  44    * A description of this bounce type
  45    *
  46    * @var string
  47    */
  48   public $description;
  49
  50   /**
  51    * Number of bounces of this type required before the email address is put on bounce hold
  52    *
  53    * @var int
  54    */
  55   public $hold_threshold;
  56
  57   /**
  58    * Class constructor.
  59    */
  60   public function __construct() {
  61     $this->__table = 'civicrm_mailing_bounce_type';
  62     parent::__construct();
  63   }
  64
  65   /**
  66    * Returns localized title of this entity.
  67    */
  68   public static function getEntityTitle() {
  69     return ts('Bounce Types');
  70   }
  71
  72   /**
  73    * Returns all the column names of this table
  74    *
  75    * @return array
  76    */
  77   public static function &fields() {
  78     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
  79       Civi::$statics[__CLASS__]['fields'] = [
  80         'id' => [
  81           'name' => 'id',
  82           'type' => CRM_Utils_Type::T_INT,
  83           'title' => ts('Bounce Type ID'),
  84           'required' => TRUE,
  85           'where' => 'civicrm_mailing_bounce_type.id',
  86           'table_name' => 'civicrm_mailing_bounce_type',
  87           'entity' => 'BounceType',
  88           'bao' => 'CRM_Mailing_DAO_BounceType',
  89           'localizable' => 0,
  90         ],
  91         'name' => [
  92           'name' => 'name',
  93           'type' => CRM_Utils_Type::T_STRING,
  94           'title' => ts('Bounce Type Name'),
  95           'description' => ts('Type of bounce'),
  96           'required' => TRUE,
  97           'maxlength' => 24,
  98           'size' => CRM_Utils_Type::MEDIUM,
  99           'where' => 'civicrm_mailing_bounce_type.name',
 100           'table_name' => 'civicrm_mailing_bounce_type',
 101           'entity' => 'BounceType',
 102           'bao' => 'CRM_Mailing_DAO_BounceType',
 103           'localizable' => 0,
 104         ],
 105         'description' => [
 106           'name' => 'description',
 107           'type' => CRM_Utils_Type::T_STRING,
 108           'title' => ts('Bounce Type Description'),
 109           'description' => ts('A description of this bounce type'),
 110           'maxlength' => 255,
 111           'size' => CRM_Utils_Type::HUGE,
 112           'where' => 'civicrm_mailing_bounce_type.description',
 113           'table_name' => 'civicrm_mailing_bounce_type',
 114           'entity' => 'BounceType',
 115           'bao' => 'CRM_Mailing_DAO_BounceType',
 116           'localizable' => 0,
 117         ],
 118         'hold_threshold' => [
 119           'name' => 'hold_threshold',
 120           'type' => CRM_Utils_Type::T_INT,
 121           'title' => ts('Hold Threshold'),
 122           'description' => ts('Number of bounces of this type required before the email address is put on bounce hold'),
 123           'required' => TRUE,
 124           'where' => 'civicrm_mailing_bounce_type.hold_threshold',
 125           'table_name' => 'civicrm_mailing_bounce_type',
 126           'entity' => 'BounceType',
 127           'bao' => 'CRM_Mailing_DAO_BounceType',
 128           'localizable' => 0,
 129         ],
 130       ];
 131       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 132     }
 133     return Civi::$statics[__CLASS__]['fields'];
 134   }
 135
 136   /**
 137    * Return a mapping from field-name to the corresponding key (as used in fields()).
 138    *
 139    * @return array
 140    *   Array(string $name => string $uniqueName).
 141    */
 142   public static function &fieldKeys() {
 143     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 144       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 145     }
 146     return Civi::$statics[__CLASS__]['fieldKeys'];
 147   }
 148
 149   /**
 150    * Returns the names of this table
 151    *
 152    * @return string
 153    */
 154   public static function getTableName() {
 155     return self::$_tableName;
 156   }
 157
 158   /**
 159    * Returns if this table needs to be logged
 160    *
 161    * @return bool
 162    */
 163   public function getLog() {
 164     return self::$_log;
 165   }
 166
 167   /**
 168    * Returns the list of fields that can be imported
 169    *
 170    * @param bool $prefix
 171    *
 172    * @return array
 173    */
 174   public static function &import($prefix = FALSE) {
 175     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_bounce_type', $prefix, []);
 176     return $r;
 177   }
 178
 179   /**
 180    * Returns the list of fields that can be exported
 181    *
 182    * @param bool $prefix
 183    *
 184    * @return array
 185    */
 186   public static function &export($prefix = FALSE) {
 187     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_bounce_type', $prefix, []);
 188     return $r;
 189   }
 190
 191   /**
 192    * Returns the list of indices
 193    *
 194    * @param bool $localize
 195    *
 196    * @return array
 197    */
 198   public static function indices($localize = TRUE) {
 199     $indices = [];
 200     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 201   }
 202
 203 }