CRM/Mailing/Event/DAO/Forward.php

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