CRM/Mailing/DAO/BouncePattern.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Mailing/BouncePattern.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:15aed9731c3f63c29d9d3c0c57297619)
  10  */
  11
  12 /**
  13  * Database access object for the BouncePattern entity.
  14  */
  15 class CRM_Mailing_DAO_BouncePattern extends CRM_Core_DAO {
  16   const EXT = 'civicrm';
  17   const TABLE_ADDED = '';
  18   const COMPONENT = 'CiviMail';
  19
  20   /**
  21    * Static instance to hold the table name.
  22    *
  23    * @var string
  24    */
  25   public static $_tableName = 'civicrm_mailing_bounce_pattern';
  26
  27   /**
  28    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  29    *
  30    * @var bool
  31    */
  32   public static $_log = FALSE;
  33
  34   /**
  35    * @var int|string|null
  36    *   (SQL type: int unsigned)
  37    *   Note that values will be retrieved from the database as a string.
  38    */
  39   public $id;
  40
  41   /**
  42    * Type of bounce
  43    *
  44    * @var int|string
  45    *   (SQL type: int unsigned)
  46    *   Note that values will be retrieved from the database as a string.
  47    */
  48   public $bounce_type_id;
  49
  50   /**
  51    * A regexp to match a message to a bounce type
  52    *
  53    * @var string|null
  54    *   (SQL type: varchar(255))
  55    *   Note that values will be retrieved from the database as a string.
  56    */
  57   public $pattern;
  58
  59   /**
  60    * Class constructor.
  61    */
  62   public function __construct() {
  63     $this->__table = 'civicrm_mailing_bounce_pattern';
  64     parent::__construct();
  65   }
  66
  67   /**
  68    * Returns localized title of this entity.
  69    *
  70    * @param bool $plural
  71    *   Whether to return the plural version of the title.
  72    */
  73   public static function getEntityTitle($plural = FALSE) {
  74     return $plural ? ts('Bounce Patterns') : ts('Bounce Pattern');
  75   }
  76
  77   /**
  78    * Returns foreign keys and entity references.
  79    *
  80    * @return array
  81    *   [CRM_Core_Reference_Interface]
  82    */
  83   public static function getReferenceColumns() {
  84     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  85       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
  86       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'bounce_type_id', 'civicrm_mailing_bounce_type', 'id');
  87       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  88     }
  89     return Civi::$statics[__CLASS__]['links'];
  90   }
  91
  92   /**
  93    * Returns all the column names of this table
  94    *
  95    * @return array
  96    */
  97   public static function &fields() {
  98     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
  99       Civi::$statics[__CLASS__]['fields'] = [
 100         'id' => [
 101           'name' => 'id',
 102           'type' => CRM_Utils_Type::T_INT,
 103           'title' => ts('Bounce Pattern ID'),
 104           'required' => TRUE,
 105           'where' => 'civicrm_mailing_bounce_pattern.id',
 106           'table_name' => 'civicrm_mailing_bounce_pattern',
 107           'entity' => 'BouncePattern',
 108           'bao' => 'CRM_Mailing_BAO_BouncePattern',
 109           'localizable' => 0,
 110           'html' => [
 111             'type' => 'Number',
 112           ],
 113           'readonly' => TRUE,
 114           'add' => NULL,
 115         ],
 116         'bounce_type_id' => [
 117           'name' => 'bounce_type_id',
 118           'type' => CRM_Utils_Type::T_INT,
 119           'title' => ts('Bounce Type ID'),
 120           'description' => ts('Type of bounce'),
 121           'required' => TRUE,
 122           'where' => 'civicrm_mailing_bounce_pattern.bounce_type_id',
 123           'table_name' => 'civicrm_mailing_bounce_pattern',
 124           'entity' => 'BouncePattern',
 125           'bao' => 'CRM_Mailing_BAO_BouncePattern',
 126           'localizable' => 0,
 127           'FKClassName' => 'CRM_Mailing_DAO_BounceType',
 128           'html' => [
 129             'label' => ts("Bounce Type"),
 130           ],
 131           'pseudoconstant' => [
 132             'table' => 'civicrm_mailing_bounce_type',
 133             'keyColumn' => 'id',
 134             'labelColumn' => 'name',
 135           ],
 136           'add' => NULL,
 137         ],
 138         'pattern' => [
 139           'name' => 'pattern',
 140           'type' => CRM_Utils_Type::T_STRING,
 141           'title' => ts('Pattern'),
 142           'description' => ts('A regexp to match a message to a bounce type'),
 143           'maxlength' => 255,
 144           'size' => CRM_Utils_Type::HUGE,
 145           'where' => 'civicrm_mailing_bounce_pattern.pattern',
 146           'table_name' => 'civicrm_mailing_bounce_pattern',
 147           'entity' => 'BouncePattern',
 148           'bao' => 'CRM_Mailing_BAO_BouncePattern',
 149           'localizable' => 0,
 150           'add' => NULL,
 151         ],
 152       ];
 153       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 154     }
 155     return Civi::$statics[__CLASS__]['fields'];
 156   }
 157
 158   /**
 159    * Return a mapping from field-name to the corresponding key (as used in fields()).
 160    *
 161    * @return array
 162    *   Array(string $name => string $uniqueName).
 163    */
 164   public static function &fieldKeys() {
 165     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 166       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 167     }
 168     return Civi::$statics[__CLASS__]['fieldKeys'];
 169   }
 170
 171   /**
 172    * Returns the names of this table
 173    *
 174    * @return string
 175    */
 176   public static function getTableName() {
 177     return self::$_tableName;
 178   }
 179
 180   /**
 181    * Returns if this table needs to be logged
 182    *
 183    * @return bool
 184    */
 185   public function getLog() {
 186     return self::$_log;
 187   }
 188
 189   /**
 190    * Returns the list of fields that can be imported
 191    *
 192    * @param bool $prefix
 193    *
 194    * @return array
 195    */
 196   public static function &import($prefix = FALSE) {
 197     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_bounce_pattern', $prefix, []);
 198     return $r;
 199   }
 200
 201   /**
 202    * Returns the list of fields that can be exported
 203    *
 204    * @param bool $prefix
 205    *
 206    * @return array
 207    */
 208   public static function &export($prefix = FALSE) {
 209     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_bounce_pattern', $prefix, []);
 210     return $r;
 211   }
 212
 213   /**
 214    * Returns the list of indices
 215    *
 216    * @param bool $localize
 217    *
 218    * @return array
 219    */
 220   public static function indices($localize = TRUE) {
 221     $indices = [];
 222     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 223   }
 224
 225 }