CRM/Mailing/Event/DAO/TrackableURLOpen.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2019
   6  *
   7  * Generated from xml/schema/CRM/Mailing/Event/TrackableURLOpen.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:1dd0644af19360b30531b6f23dde78c1)
  10  */
  11
  12 /**
  13  * Database access object for the TrackableURLOpen entity.
  14  */
  15 class CRM_Mailing_Event_DAO_TrackableURLOpen 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_trackable_url_open';
  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 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 TrackableURL
  45    *
  46    * @var int unsigned
  47    */
  48   public $trackable_url_id;
  49
  50   /**
  51    * When this trackable URL open 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_trackable_url_open';
  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(), 'trackable_url_id', 'civicrm_mailing_trackable_url', '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('Trackable URL Open ID'),
  93           'required' => TRUE,
  94           'where' => 'civicrm_mailing_event_trackable_url_open.id',
  95           'table_name' => 'civicrm_mailing_event_trackable_url_open',
  96           'entity' => 'TrackableURLOpen',
  97           'bao' => 'CRM_Mailing_Event_BAO_TrackableURLOpen',
  98           'localizable' => 0,
  99         ],
 100         'event_queue_id' => [
 101           'name' => 'event_queue_id',
 102           'type' => CRM_Utils_Type::T_INT,
 103           'title' => ts('Event Queue'),
 104           'description' => ts('FK to EventQueue'),
 105           'required' => TRUE,
 106           'where' => 'civicrm_mailing_event_trackable_url_open.event_queue_id',
 107           'table_name' => 'civicrm_mailing_event_trackable_url_open',
 108           'entity' => 'TrackableURLOpen',
 109           'bao' => 'CRM_Mailing_Event_BAO_TrackableURLOpen',
 110           'localizable' => 0,
 111           'FKClassName' => 'CRM_Mailing_Event_DAO_Queue',
 112         ],
 113         'trackable_url_id' => [
 114           'name' => 'trackable_url_id',
 115           'type' => CRM_Utils_Type::T_INT,
 116           'title' => ts('Trackable Url'),
 117           'description' => ts('FK to TrackableURL'),
 118           'required' => TRUE,
 119           'where' => 'civicrm_mailing_event_trackable_url_open.trackable_url_id',
 120           'table_name' => 'civicrm_mailing_event_trackable_url_open',
 121           'entity' => 'TrackableURLOpen',
 122           'bao' => 'CRM_Mailing_Event_BAO_TrackableURLOpen',
 123           'localizable' => 0,
 124           'FKClassName' => 'CRM_Mailing_DAO_TrackableURL',
 125         ],
 126         'time_stamp' => [
 127           'name' => 'time_stamp',
 128           'type' => CRM_Utils_Type::T_TIMESTAMP,
 129           'title' => ts('Timestamp'),
 130           'description' => ts('When this trackable URL open occurred.'),
 131           'required' => TRUE,
 132           'where' => 'civicrm_mailing_event_trackable_url_open.time_stamp',
 133           'default' => 'CURRENT_TIMESTAMP',
 134           'table_name' => 'civicrm_mailing_event_trackable_url_open',
 135           'entity' => 'TrackableURLOpen',
 136           'bao' => 'CRM_Mailing_Event_BAO_TrackableURLOpen',
 137           'localizable' => 0,
 138         ],
 139       ];
 140       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 141     }
 142     return Civi::$statics[__CLASS__]['fields'];
 143   }
 144
 145   /**
 146    * Return a mapping from field-name to the corresponding key (as used in fields()).
 147    *
 148    * @return array
 149    *   Array(string $name => string $uniqueName).
 150    */
 151   public static function &fieldKeys() {
 152     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 153       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 154     }
 155     return Civi::$statics[__CLASS__]['fieldKeys'];
 156   }
 157
 158   /**
 159    * Returns the names of this table
 160    *
 161    * @return string
 162    */
 163   public static function getTableName() {
 164     return self::$_tableName;
 165   }
 166
 167   /**
 168    * Returns if this table needs to be logged
 169    *
 170    * @return bool
 171    */
 172   public function getLog() {
 173     return self::$_log;
 174   }
 175
 176   /**
 177    * Returns the list of fields that can be imported
 178    *
 179    * @param bool $prefix
 180    *
 181    * @return array
 182    */
 183   public static function &import($prefix = FALSE) {
 184     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_event_trackable_url_open', $prefix, []);
 185     return $r;
 186   }
 187
 188   /**
 189    * Returns the list of fields that can be exported
 190    *
 191    * @param bool $prefix
 192    *
 193    * @return array
 194    */
 195   public static function &export($prefix = FALSE) {
 196     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_event_trackable_url_open', $prefix, []);
 197     return $r;
 198   }
 199
 200   /**
 201    * Returns the list of indices
 202    *
 203    * @param bool $localize
 204    *
 205    * @return array
 206    */
 207   public static function indices($localize = TRUE) {
 208     $indices = [];
 209     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 210   }
 211
 212 }