CRM/Mailing/Event/DAO/Forward.php

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