CRM/Mailing/Event/DAO/Queue.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/Queue.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:b774f21eb9f8b5977e3fa07c4bcfe299)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 class CRM_Mailing_Event_DAO_Queue extends CRM_Core_DAO {
  38   /**
  39    * static instance to hold the table name
  40    *
  41    * @var string
  42    */
  43   static $_tableName = 'civicrm_mailing_event_queue';
  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 Job
  90    *
  91    * @var int unsigned
  92    */
  93   public $job_id;
  94   /**
  95    * FK to Email
  96    *
  97    * @var int unsigned
  98    */
  99   public $email_id;
 100   /**
 101    * FK to Contact
 102    *
 103    * @var int unsigned
 104    */
 105   public $contact_id;
 106   /**
 107    * Security hash
 108    *
 109    * @var string
 110    */
 111   public $hash;
 112   /**
 113    * FK to Phone
 114    *
 115    * @var int unsigned
 116    */
 117   public $phone_id;
 118   /**
 119    * class constructor
 120    *
 121    * @return civicrm_mailing_event_queue
 122    */
 123   function __construct() {
 124     $this->__table = 'civicrm_mailing_event_queue';
 125     parent::__construct();
 126   }
 127   /**
 128    * Returns foreign keys and entity references
 129    *
 130    * @return array
 131    *   [CRM_Core_Reference_Interface]
 132    */
 133   static function getReferenceColumns() {
 134     if (!self::$_links) {
 135       self::$_links = static ::createReferenceColumns(__CLASS__);
 136       self::$_links[] = new CRM_Core_Reference_Basic(self::getTableName() , 'job_id', 'civicrm_mailing_job', 'id');
 137       self::$_links[] = new CRM_Core_Reference_Basic(self::getTableName() , 'email_id', 'civicrm_email', 'id');
 138       self::$_links[] = new CRM_Core_Reference_Basic(self::getTableName() , 'contact_id', 'civicrm_contact', 'id');
 139       self::$_links[] = new CRM_Core_Reference_Basic(self::getTableName() , 'phone_id', 'civicrm_phone', 'id');
 140     }
 141     return self::$_links;
 142   }
 143   /**
 144    * Returns all the column names of this table
 145    *
 146    * @return array
 147    */
 148   static function &fields() {
 149     if (!(self::$_fields)) {
 150       self::$_fields = array(
 151         'id' => array(
 152           'name' => 'id',
 153           'type' => CRM_Utils_Type::T_INT,
 154           'title' => ts('Mailing Event Queue ID') ,
 155           'required' => true,
 156         ) ,
 157         'job_id' => array(
 158           'name' => 'job_id',
 159           'type' => CRM_Utils_Type::T_INT,
 160           'title' => ts('Job ID') ,
 161           'description' => 'FK to Job',
 162           'required' => true,
 163           'FKClassName' => 'CRM_Mailing_DAO_MailingJob',
 164         ) ,
 165         'email_id' => array(
 166           'name' => 'email_id',
 167           'type' => CRM_Utils_Type::T_INT,
 168           'title' => ts('Email ID') ,
 169           'description' => 'FK to Email',
 170           'default' => 'NULL',
 171           'FKClassName' => 'CRM_Core_DAO_Email',
 172         ) ,
 173         'contact_id' => array(
 174           'name' => 'contact_id',
 175           'type' => CRM_Utils_Type::T_INT,
 176           'title' => ts('Contact ID') ,
 177           'description' => 'FK to Contact',
 178           'required' => true,
 179           'FKClassName' => 'CRM_Contact_DAO_Contact',
 180         ) ,
 181         'hash' => array(
 182           'name' => 'hash',
 183           'type' => CRM_Utils_Type::T_STRING,
 184           'title' => ts('Security Hash') ,
 185           'description' => 'Security hash',
 186           'required' => true,
 187           'maxlength' => 255,
 188           'size' => CRM_Utils_Type::HUGE,
 189         ) ,
 190         'phone_id' => array(
 191           'name' => 'phone_id',
 192           'type' => CRM_Utils_Type::T_INT,
 193           'title' => ts('Phone ID') ,
 194           'description' => 'FK to Phone',
 195           'default' => 'NULL',
 196           'FKClassName' => 'CRM_Core_DAO_Phone',
 197         ) ,
 198       );
 199     }
 200     return self::$_fields;
 201   }
 202   /**
 203    * Returns an array containing, for each field, the arary key used for that
 204    * field in self::$_fields.
 205    *
 206    * @return array
 207    */
 208   static function &fieldKeys() {
 209     if (!(self::$_fieldKeys)) {
 210       self::$_fieldKeys = array(
 211         'id' => 'id',
 212         'job_id' => 'job_id',
 213         'email_id' => 'email_id',
 214         'contact_id' => 'contact_id',
 215         'hash' => 'hash',
 216         'phone_id' => 'phone_id',
 217       );
 218     }
 219     return self::$_fieldKeys;
 220   }
 221   /**
 222    * Returns the names of this table
 223    *
 224    * @return string
 225    */
 226   static function getTableName() {
 227     return self::$_tableName;
 228   }
 229   /**
 230    * Returns if this table needs to be logged
 231    *
 232    * @return boolean
 233    */
 234   function getLog() {
 235     return self::$_log;
 236   }
 237   /**
 238    * Returns the list of fields that can be imported
 239    *
 240    * @param bool $prefix
 241    *
 242    * @return array
 243    */
 244   static function &import($prefix = false) {
 245     if (!(self::$_import)) {
 246       self::$_import = array();
 247       $fields = self::fields();
 248       foreach($fields as $name => $field) {
 249         if (CRM_Utils_Array::value('import', $field)) {
 250           if ($prefix) {
 251             self::$_import['mailing_event_queue'] = & $fields[$name];
 252           } else {
 253             self::$_import[$name] = & $fields[$name];
 254           }
 255         }
 256       }
 257     }
 258     return self::$_import;
 259   }
 260   /**
 261    * Returns the list of fields that can be exported
 262    *
 263    * @param bool $prefix
 264    *
 265    * @return array
 266    */
 267   static function &export($prefix = false) {
 268     if (!(self::$_export)) {
 269       self::$_export = array();
 270       $fields = self::fields();
 271       foreach($fields as $name => $field) {
 272         if (CRM_Utils_Array::value('export', $field)) {
 273           if ($prefix) {
 274             self::$_export['mailing_event_queue'] = & $fields[$name];
 275           } else {
 276             self::$_export[$name] = & $fields[$name];
 277           }
 278         }
 279       }
 280     }
 281     return self::$_export;
 282   }
 283 }