CRM/Mailing/Event/DAO/Forward.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Mailing/Event/Forward.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:ea0e4a784e682347d7320337cb5bc1ac)
  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   public 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   public static $_log = FALSE;
  30
  31   /**
  32    * @var int
  33    */
  34   public $id;
  35
  36   /**
  37    * FK to EventQueue
  38    *
  39    * @var int
  40    */
  41   public $event_queue_id;
  42
  43   /**
  44    * FK to EventQueue for destination
  45    *
  46    * @var int
  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 localized title of this entity.
  67    */
  68   public static function getEntityTitle() {
  69     return ts('Forwards');
  70   }
  71
  72   /**
  73    * Returns foreign keys and entity references.
  74    *
  75    * @return array
  76    *   [CRM_Core_Reference_Interface]
  77    */
  78   public static function getReferenceColumns() {
  79     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  80       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
  81       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'event_queue_id', 'civicrm_mailing_event_queue', 'id');
  82       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'dest_queue_id', 'civicrm_mailing_event_queue', 'id');
  83       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  84     }
  85     return Civi::$statics[__CLASS__]['links'];
  86   }
  87
  88   /**
  89    * Returns all the column names of this table
  90    *
  91    * @return array
  92    */
  93   public static function &fields() {
  94     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
  95       Civi::$statics[__CLASS__]['fields'] = [
  96         'id' => [
  97           'name' => 'id',
  98           'type' => CRM_Utils_Type::T_INT,
  99           'title' => ts('Forward ID'),
 100           'required' => TRUE,
 101           'where' => 'civicrm_mailing_event_forward.id',
 102           'table_name' => 'civicrm_mailing_event_forward',
 103           'entity' => 'Forward',
 104           'bao' => 'CRM_Mailing_Event_BAO_Forward',
 105           'localizable' => 0,
 106           'add' => NULL,
 107         ],
 108         'event_queue_id' => [
 109           'name' => 'event_queue_id',
 110           'type' => CRM_Utils_Type::T_INT,
 111           'title' => ts('Mailing Event Queue'),
 112           'description' => ts('FK to EventQueue'),
 113           'required' => TRUE,
 114           'where' => 'civicrm_mailing_event_forward.event_queue_id',
 115           'table_name' => 'civicrm_mailing_event_forward',
 116           'entity' => 'Forward',
 117           'bao' => 'CRM_Mailing_Event_BAO_Forward',
 118           'localizable' => 0,
 119           'FKClassName' => 'CRM_Mailing_Event_DAO_Queue',
 120           'add' => NULL,
 121         ],
 122         'dest_queue_id' => [
 123           'name' => 'dest_queue_id',
 124           'type' => CRM_Utils_Type::T_INT,
 125           'title' => ts('Destination Queue'),
 126           'description' => ts('FK to EventQueue for destination'),
 127           'where' => 'civicrm_mailing_event_forward.dest_queue_id',
 128           'table_name' => 'civicrm_mailing_event_forward',
 129           'entity' => 'Forward',
 130           'bao' => 'CRM_Mailing_Event_BAO_Forward',
 131           'localizable' => 0,
 132           'FKClassName' => 'CRM_Mailing_Event_DAO_Queue',
 133           'add' => NULL,
 134         ],
 135         'time_stamp' => [
 136           'name' => 'time_stamp',
 137           'type' => CRM_Utils_Type::T_TIMESTAMP,
 138           'title' => ts('Timestamp'),
 139           'description' => ts('When this forward event occurred.'),
 140           'required' => TRUE,
 141           'where' => 'civicrm_mailing_event_forward.time_stamp',
 142           'default' => 'CURRENT_TIMESTAMP',
 143           'table_name' => 'civicrm_mailing_event_forward',
 144           'entity' => 'Forward',
 145           'bao' => 'CRM_Mailing_Event_BAO_Forward',
 146           'localizable' => 0,
 147           'add' => NULL,
 148         ],
 149       ];
 150       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 151     }
 152     return Civi::$statics[__CLASS__]['fields'];
 153   }
 154
 155   /**
 156    * Return a mapping from field-name to the corresponding key (as used in fields()).
 157    *
 158    * @return array
 159    *   Array(string $name => string $uniqueName).
 160    */
 161   public static function &fieldKeys() {
 162     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 163       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 164     }
 165     return Civi::$statics[__CLASS__]['fieldKeys'];
 166   }
 167
 168   /**
 169    * Returns the names of this table
 170    *
 171    * @return string
 172    */
 173   public static function getTableName() {
 174     return self::$_tableName;
 175   }
 176
 177   /**
 178    * Returns if this table needs to be logged
 179    *
 180    * @return bool
 181    */
 182   public function getLog() {
 183     return self::$_log;
 184   }
 185
 186   /**
 187    * Returns the list of fields that can be imported
 188    *
 189    * @param bool $prefix
 190    *
 191    * @return array
 192    */
 193   public static function &import($prefix = FALSE) {
 194     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_event_forward', $prefix, []);
 195     return $r;
 196   }
 197
 198   /**
 199    * Returns the list of fields that can be exported
 200    *
 201    * @param bool $prefix
 202    *
 203    * @return array
 204    */
 205   public static function &export($prefix = FALSE) {
 206     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_event_forward', $prefix, []);
 207     return $r;
 208   }
 209
 210   /**
 211    * Returns the list of indices
 212    *
 213    * @param bool $localize
 214    *
 215    * @return array
 216    */
 217   public static function indices($localize = TRUE) {
 218     $indices = [];
 219     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 220   }
 221
 222 }