crm.fsf.org/20131203/files/sites/all/modules-new/civicrm/CRM/Mailing/Event/DAO/TrackableURLOpen.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.6                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  30  *
  31  * Generated from xml/schema/CRM/Mailing/Event/TrackableURLOpen.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  */
  34 require_once 'CRM/Core/DAO.php';
  35 require_once 'CRM/Utils/Type.php';
  36 class CRM_Mailing_Event_DAO_TrackableURLOpen extends CRM_Core_DAO {
  37   /**
  38    * static instance to hold the table name
  39    *
  40    * @var string
  41    */
  42   static $_tableName = 'civicrm_mailing_event_trackable_url_open';
  43   /**
  44    * static instance to hold the field values
  45    *
  46    * @var array
  47    */
  48   static $_fields = null;
  49   /**
  50    * static instance to hold the keys used in $_fields for each field.
  51    *
  52    * @var array
  53    */
  54   static $_fieldKeys = null;
  55   /**
  56    * static instance to hold the FK relationships
  57    *
  58    * @var string
  59    */
  60   static $_links = null;
  61   /**
  62    * static instance to hold the values that can
  63    * be imported
  64    *
  65    * @var array
  66    */
  67   static $_import = null;
  68   /**
  69    * static instance to hold the values that can
  70    * be exported
  71    *
  72    * @var array
  73    */
  74   static $_export = null;
  75   /**
  76    * static value to see if we should log any modifications to
  77    * this table in the civicrm_log table
  78    *
  79    * @var boolean
  80    */
  81   static $_log = false;
  82   /**
  83    *
  84    * @var int unsigned
  85    */
  86   public $id;
  87   /**
  88    * FK to EventQueue
  89    *
  90    * @var int unsigned
  91    */
  92   public $event_queue_id;
  93   /**
  94    * FK to TrackableURL
  95    *
  96    * @var int unsigned
  97    */
  98   public $trackable_url_id;
  99   /**
 100    * When this trackable URL open occurred.
 101    *
 102    * @var datetime
 103    */
 104   public $time_stamp;
 105   /**
 106    * class constructor
 107    *
 108    * @return civicrm_mailing_event_trackable_url_open
 109    */
 110   function __construct() {
 111     $this->__table = 'civicrm_mailing_event_trackable_url_open';
 112     parent::__construct();
 113   }
 114   /**
 115    * Returns foreign keys and entity references
 116    *
 117    * @return array
 118    *   [CRM_Core_Reference_Interface]
 119    */
 120   static function getReferenceColumns() {
 121     if (!self::$_links) {
 122       self::$_links = static ::createReferenceColumns(__CLASS__);
 123       self::$_links[] = new CRM_Core_Reference_Basic(self::getTableName() , 'event_queue_id', 'civicrm_mailing_event_queue', 'id');
 124       self::$_links[] = new CRM_Core_Reference_Basic(self::getTableName() , 'trackable_url_id', 'civicrm_mailing_trackable_url', 'id');
 125     }
 126     return self::$_links;
 127   }
 128   /**
 129    * Returns all the column names of this table
 130    *
 131    * @return array
 132    */
 133   static function &fields() {
 134     if (!(self::$_fields)) {
 135       self::$_fields = array(
 136         'id' => array(
 137           'name' => 'id',
 138           'type' => CRM_Utils_Type::T_INT,
 139           'required' => true,
 140         ) ,
 141         'event_queue_id' => array(
 142           'name' => 'event_queue_id',
 143           'type' => CRM_Utils_Type::T_INT,
 144           'description' => 'FK to EventQueue',
 145           'required' => true,
 146           'FKClassName' => 'CRM_Mailing_Event_DAO_Queue',
 147         ) ,
 148         'trackable_url_id' => array(
 149           'name' => 'trackable_url_id',
 150           'type' => CRM_Utils_Type::T_INT,
 151           'description' => 'FK to TrackableURL',
 152           'required' => true,
 153           'FKClassName' => 'CRM_Mailing_DAO_TrackableURL',
 154         ) ,
 155         'time_stamp' => array(
 156           'name' => 'time_stamp',
 157           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 158           'title' => ts('Time Stamp') ,
 159           'description' => 'When this trackable URL open occurred.',
 160           'required' => true,
 161         ) ,
 162       );
 163     }
 164     return self::$_fields;
 165   }
 166   /**
 167    * Returns an array containing, for each field, the arary key used for that
 168    * field in self::$_fields.
 169    *
 170    * @return array
 171    */
 172   static function &fieldKeys() {
 173     if (!(self::$_fieldKeys)) {
 174       self::$_fieldKeys = array(
 175         'id' => 'id',
 176         'event_queue_id' => 'event_queue_id',
 177         'trackable_url_id' => 'trackable_url_id',
 178         'time_stamp' => 'time_stamp',
 179       );
 180     }
 181     return self::$_fieldKeys;
 182   }
 183   /**
 184    * Returns the names of this table
 185    *
 186    * @return string
 187    */
 188   static function getTableName() {
 189     return self::$_tableName;
 190   }
 191   /**
 192    * Returns if this table needs to be logged
 193    *
 194    * @return boolean
 195    */
 196   function getLog() {
 197     return self::$_log;
 198   }
 199   /**
 200    * Returns the list of fields that can be imported
 201    *
 202    * @param bool $prefix
 203    *
 204    * @return array
 205    */
 206   static function &import($prefix = false) {
 207     if (!(self::$_import)) {
 208       self::$_import = array();
 209       $fields = self::fields();
 210       foreach($fields as $name => $field) {
 211         if (CRM_Utils_Array::value('import', $field)) {
 212           if ($prefix) {
 213             self::$_import['mailing_event_trackable_url_open'] = & $fields[$name];
 214           } else {
 215             self::$_import[$name] = & $fields[$name];
 216           }
 217         }
 218       }
 219     }
 220     return self::$_import;
 221   }
 222   /**
 223    * Returns the list of fields that can be exported
 224    *
 225    * @param bool $prefix
 226    *
 227    * @return array
 228    */
 229   static function &export($prefix = false) {
 230     if (!(self::$_export)) {
 231       self::$_export = array();
 232       $fields = self::fields();
 233       foreach($fields as $name => $field) {
 234         if (CRM_Utils_Array::value('export', $field)) {
 235           if ($prefix) {
 236             self::$_export['mailing_event_trackable_url_open'] = & $fields[$name];
 237           } else {
 238             self::$_export[$name] = & $fields[$name];
 239           }
 240         }
 241       }
 242     }
 243     return self::$_export;
 244   }
 245 }