CRM/Mailing/Event/DAO/Bounce.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.7                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2017                                |
   7 +--------------------------------------------------------------------+
   8 | This file is a part of CiviCRM.                                    |
   9 |                                                                    |
  10 | CiviCRM is free software; you can copy, modify, and distribute it  |
  11 | under the terms of the GNU Affero General Public License           |
  12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13 |                                                                    |
  14 | CiviCRM is distributed in the hope that it will be useful, but     |
  15 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17 | See the GNU Affero General Public License for more details.        |
  18 |                                                                    |
  19 | You should have received a copy of the GNU Affero General Public   |
  20 | License and the CiviCRM Licensing Exception along                  |
  21 | with this program; if not, contact CiviCRM LLC                     |
  22 | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23 | GNU Affero General Public License or the licensing of CiviCRM,     |
  24 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25 +--------------------------------------------------------------------+
  26 */
  27 /**
  28  * @package CRM
  29  * @copyright CiviCRM LLC (c) 2004-2017
  30  *
  31  * Generated from xml/schema/CRM/Mailing/Event/Bounce.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:c63363ca2be2a2fb9eb090786bdf0fa3)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Mailing_Event_DAO_Bounce constructor.
  39  */
  40 class CRM_Mailing_Event_DAO_Bounce extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_mailing_event_bounce';
  47   /**
  48    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  49    *
  50    * @var boolean
  51    */
  52   static $_log = false;
  53   /**
  54    *
  55    * @var int unsigned
  56    */
  57   public $id;
  58   /**
  59    * FK to EventQueue
  60    *
  61    * @var int unsigned
  62    */
  63   public $event_queue_id;
  64   /**
  65    * What type of bounce was it?
  66    *
  67    * @var int unsigned
  68    */
  69   public $bounce_type_id;
  70   /**
  71    * The reason the email bounced.
  72    *
  73    * @var string
  74    */
  75   public $bounce_reason;
  76   /**
  77    * When this bounce event occurred.
  78    *
  79    * @var timestamp
  80    */
  81   public $time_stamp;
  82   /**
  83    * Class constructor.
  84    */
  85   function __construct() {
  86     $this->__table = 'civicrm_mailing_event_bounce';
  87     parent::__construct();
  88   }
  89   /**
  90    * Returns foreign keys and entity references.
  91    *
  92    * @return array
  93    *   [CRM_Core_Reference_Interface]
  94    */
  95   static function getReferenceColumns() {
  96     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  97       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
  98       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'event_queue_id', 'civicrm_mailing_event_queue', 'id');
  99       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 100     }
 101     return Civi::$statics[__CLASS__]['links'];
 102   }
 103   /**
 104    * Returns all the column names of this table
 105    *
 106    * @return array
 107    */
 108   static function &fields() {
 109     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 110       Civi::$statics[__CLASS__]['fields'] = array(
 111         'id' => array(
 112           'name' => 'id',
 113           'type' => CRM_Utils_Type::T_INT,
 114           'title' => ts('Bounce ID') ,
 115           'required' => true,
 116           'table_name' => 'civicrm_mailing_event_bounce',
 117           'entity' => 'Bounce',
 118           'bao' => 'CRM_Mailing_Event_BAO_Bounce',
 119           'localizable' => 0,
 120         ) ,
 121         'event_queue_id' => array(
 122           'name' => 'event_queue_id',
 123           'type' => CRM_Utils_Type::T_INT,
 124           'title' => ts('Event Queue') ,
 125           'description' => 'FK to EventQueue',
 126           'required' => true,
 127           'table_name' => 'civicrm_mailing_event_bounce',
 128           'entity' => 'Bounce',
 129           'bao' => 'CRM_Mailing_Event_BAO_Bounce',
 130           'localizable' => 0,
 131           'FKClassName' => 'CRM_Mailing_Event_DAO_Queue',
 132         ) ,
 133         'bounce_type_id' => array(
 134           'name' => 'bounce_type_id',
 135           'type' => CRM_Utils_Type::T_INT,
 136           'title' => ts('Bounce Type') ,
 137           'description' => 'What type of bounce was it?',
 138           'table_name' => 'civicrm_mailing_event_bounce',
 139           'entity' => 'Bounce',
 140           'bao' => 'CRM_Mailing_Event_BAO_Bounce',
 141           'localizable' => 0,
 142           'html' => array(
 143             'type' => 'Select',
 144           ) ,
 145           'pseudoconstant' => array(
 146             'table' => 'civicrm_mailing_bounce_type',
 147             'keyColumn' => 'id',
 148             'labelColumn' => 'name',
 149           )
 150         ) ,
 151         'bounce_reason' => array(
 152           'name' => 'bounce_reason',
 153           'type' => CRM_Utils_Type::T_STRING,
 154           'title' => ts('Bounce Reason') ,
 155           'description' => 'The reason the email bounced.',
 156           'maxlength' => 255,
 157           'size' => CRM_Utils_Type::HUGE,
 158           'table_name' => 'civicrm_mailing_event_bounce',
 159           'entity' => 'Bounce',
 160           'bao' => 'CRM_Mailing_Event_BAO_Bounce',
 161           'localizable' => 0,
 162         ) ,
 163         'time_stamp' => array(
 164           'name' => 'time_stamp',
 165           'type' => CRM_Utils_Type::T_TIMESTAMP,
 166           'title' => ts('Timestamp') ,
 167           'description' => 'When this bounce event occurred.',
 168           'required' => true,
 169           'default' => 'CURRENT_TIMESTAMP',
 170           'table_name' => 'civicrm_mailing_event_bounce',
 171           'entity' => 'Bounce',
 172           'bao' => 'CRM_Mailing_Event_BAO_Bounce',
 173           'localizable' => 0,
 174         ) ,
 175       );
 176       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 177     }
 178     return Civi::$statics[__CLASS__]['fields'];
 179   }
 180   /**
 181    * Return a mapping from field-name to the corresponding key (as used in fields()).
 182    *
 183    * @return array
 184    *   Array(string $name => string $uniqueName).
 185    */
 186   static function &fieldKeys() {
 187     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 188       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 189     }
 190     return Civi::$statics[__CLASS__]['fieldKeys'];
 191   }
 192   /**
 193    * Returns the names of this table
 194    *
 195    * @return string
 196    */
 197   static function getTableName() {
 198     return self::$_tableName;
 199   }
 200   /**
 201    * Returns if this table needs to be logged
 202    *
 203    * @return boolean
 204    */
 205   function getLog() {
 206     return self::$_log;
 207   }
 208   /**
 209    * Returns the list of fields that can be imported
 210    *
 211    * @param bool $prefix
 212    *
 213    * @return array
 214    */
 215   static function &import($prefix = false) {
 216     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_event_bounce', $prefix, array());
 217     return $r;
 218   }
 219   /**
 220    * Returns the list of fields that can be exported
 221    *
 222    * @param bool $prefix
 223    *
 224    * @return array
 225    */
 226   static function &export($prefix = false) {
 227     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_event_bounce', $prefix, array());
 228     return $r;
 229   }
 230   /**
 231    * Returns the list of indices
 232    */
 233   public static function indices($localize = TRUE) {
 234     $indices = array();
 235     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 236   }
 237 }