CRM/Mailing/Event/DAO/Opened.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/Opened.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:e874762899f7abc3c57b64d13585a9c4)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 class CRM_Mailing_Event_DAO_Opened extends CRM_Core_DAO {
  38   /**
  39    * static instance to hold the table name
  40    *
  41    * @var string
  42    */
  43   static $_tableName = 'civicrm_mailing_event_opened';
  44   /**
  45    * static value to see if we should log any modifications to
  46    * this table in the civicrm_log table
  47    *
  48    * @var boolean
  49    */
  50   static $_log = false;
  51   /**
  52    *
  53    * @var int unsigned
  54    */
  55   public $id;
  56   /**
  57    * FK to EventQueue
  58    *
  59    * @var int unsigned
  60    */
  61   public $event_queue_id;
  62   /**
  63    * When this open event occurred.
  64    *
  65    * @var datetime
  66    */
  67   public $time_stamp;
  68   /**
  69    * class constructor
  70    *
  71    * @return civicrm_mailing_event_opened
  72    */
  73   function __construct() {
  74     $this->__table = 'civicrm_mailing_event_opened';
  75     parent::__construct();
  76   }
  77   /**
  78    * Returns foreign keys and entity references
  79    *
  80    * @return array
  81    *   [CRM_Core_Reference_Interface]
  82    */
  83   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() , 'event_queue_id', 'civicrm_mailing_event_queue', 'id');
  87       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  88     }
  89     return Civi::$statics[__CLASS__]['links'];
  90   }
  91   /**
  92    * Returns all the column names of this table
  93    *
  94    * @return array
  95    */
  96   static function &fields() {
  97     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
  98       Civi::$statics[__CLASS__]['fields'] = array(
  99         'id' => array(
 100           'name' => 'id',
 101           'type' => CRM_Utils_Type::T_INT,
 102           'title' => ts('Mailing Opened ID') ,
 103           'required' => true,
 104         ) ,
 105         'event_queue_id' => array(
 106           'name' => 'event_queue_id',
 107           'type' => CRM_Utils_Type::T_INT,
 108           'title' => ts('Event Queue') ,
 109           'description' => 'FK to EventQueue',
 110           'required' => true,
 111           'FKClassName' => 'CRM_Mailing_Event_DAO_Queue',
 112         ) ,
 113         'time_stamp' => array(
 114           'name' => 'time_stamp',
 115           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 116           'title' => ts('Timestamp') ,
 117           'description' => 'When this open event occurred.',
 118           'required' => true,
 119         ) ,
 120       );
 121       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 122     }
 123     return Civi::$statics[__CLASS__]['fields'];
 124   }
 125   /**
 126    * Return a mapping from field-name to the corresponding key (as used in fields()).
 127    *
 128    * @return array
 129    *   Array(string $name => string $uniqueName).
 130    */
 131   static function &fieldKeys() {
 132     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 133       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 134     }
 135     return Civi::$statics[__CLASS__]['fieldKeys'];
 136   }
 137   /**
 138    * Returns the names of this table
 139    *
 140    * @return string
 141    */
 142   static function getTableName() {
 143     return self::$_tableName;
 144   }
 145   /**
 146    * Returns if this table needs to be logged
 147    *
 148    * @return boolean
 149    */
 150   function getLog() {
 151     return self::$_log;
 152   }
 153   /**
 154    * Returns the list of fields that can be imported
 155    *
 156    * @param bool $prefix
 157    *
 158    * @return array
 159    */
 160   static function &import($prefix = false) {
 161     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_event_opened', $prefix, array());
 162     return $r;
 163   }
 164   /**
 165    * Returns the list of fields that can be exported
 166    *
 167    * @param bool $prefix
 168    *
 169    * @return array
 170    */
 171   static function &export($prefix = false) {
 172     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_event_opened', $prefix, array());
 173     return $r;
 174   }
 175 }