CRM/Mailing/Event/DAO/Unsubscribe.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/Unsubscribe.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:a44ecc4ce8b1a8ecdca57fff8d053392)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Mailing_Event_DAO_Unsubscribe constructor.
  39  */
  40 class CRM_Mailing_Event_DAO_Unsubscribe extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_mailing_event_unsubscribe';
  47   /**
  48    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  49    *
  50    * @var boolean
  51    */
  52   static $_log = false;
  53   /**
  54    *
  55    * @var int unsigned
  56    */
  57   public $id;
  58   /**
  59    * FK to EventQueue
  60    *
  61    * @var int unsigned
  62    */
  63   public $event_queue_id;
  64   /**
  65    * Unsubscribe at org- or group-level
  66    *
  67    * @var boolean
  68    */
  69   public $org_unsubscribe;
  70   /**
  71    * When this delivery event occurred.
  72    *
  73    * @var timestamp
  74    */
  75   public $time_stamp;
  76   /**
  77    * Class constructor.
  78    */
  79   function __construct() {
  80     $this->__table = 'civicrm_mailing_event_unsubscribe';
  81     parent::__construct();
  82   }
  83   /**
  84    * Returns foreign keys and entity references.
  85    *
  86    * @return array
  87    *   [CRM_Core_Reference_Interface]
  88    */
  89   static function getReferenceColumns() {
  90     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  91       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
  92       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'event_queue_id', 'civicrm_mailing_event_queue', 'id');
  93       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  94     }
  95     return Civi::$statics[__CLASS__]['links'];
  96   }
  97   /**
  98    * Returns all the column names of this table
  99    *
 100    * @return array
 101    */
 102   static function &fields() {
 103     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 104       Civi::$statics[__CLASS__]['fields'] = array(
 105         'id' => array(
 106           'name' => 'id',
 107           'type' => CRM_Utils_Type::T_INT,
 108           'title' => ts('Unsubscribe ID') ,
 109           'required' => true,
 110           'table_name' => 'civicrm_mailing_event_unsubscribe',
 111           'entity' => 'Unsubscribe',
 112           'bao' => 'CRM_Mailing_Event_BAO_Unsubscribe',
 113           'localizable' => 0,
 114         ) ,
 115         'event_queue_id' => array(
 116           'name' => 'event_queue_id',
 117           'type' => CRM_Utils_Type::T_INT,
 118           'title' => ts('Mailing Event Queue') ,
 119           'description' => 'FK to EventQueue',
 120           'required' => true,
 121           'table_name' => 'civicrm_mailing_event_unsubscribe',
 122           'entity' => 'Unsubscribe',
 123           'bao' => 'CRM_Mailing_Event_BAO_Unsubscribe',
 124           'localizable' => 0,
 125           'FKClassName' => 'CRM_Mailing_Event_DAO_Queue',
 126         ) ,
 127         'org_unsubscribe' => array(
 128           'name' => 'org_unsubscribe',
 129           'type' => CRM_Utils_Type::T_BOOLEAN,
 130           'title' => ts('Unsubscribe is for Organization?') ,
 131           'description' => 'Unsubscribe at org- or group-level',
 132           'required' => true,
 133           'table_name' => 'civicrm_mailing_event_unsubscribe',
 134           'entity' => 'Unsubscribe',
 135           'bao' => 'CRM_Mailing_Event_BAO_Unsubscribe',
 136           'localizable' => 0,
 137         ) ,
 138         'time_stamp' => array(
 139           'name' => 'time_stamp',
 140           'type' => CRM_Utils_Type::T_TIMESTAMP,
 141           'title' => ts('Unsubscribe Timestamp') ,
 142           'description' => 'When this delivery event occurred.',
 143           'required' => true,
 144           'default' => 'CURRENT_TIMESTAMP',
 145           'table_name' => 'civicrm_mailing_event_unsubscribe',
 146           'entity' => 'Unsubscribe',
 147           'bao' => 'CRM_Mailing_Event_BAO_Unsubscribe',
 148           'localizable' => 0,
 149         ) ,
 150       );
 151       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 152     }
 153     return Civi::$statics[__CLASS__]['fields'];
 154   }
 155   /**
 156    * Return a mapping from field-name to the corresponding key (as used in fields()).
 157    *
 158    * @return array
 159    *   Array(string $name => string $uniqueName).
 160    */
 161   static function &fieldKeys() {
 162     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 163       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 164     }
 165     return Civi::$statics[__CLASS__]['fieldKeys'];
 166   }
 167   /**
 168    * Returns the names of this table
 169    *
 170    * @return string
 171    */
 172   static function getTableName() {
 173     return self::$_tableName;
 174   }
 175   /**
 176    * Returns if this table needs to be logged
 177    *
 178    * @return boolean
 179    */
 180   function getLog() {
 181     return self::$_log;
 182   }
 183   /**
 184    * Returns the list of fields that can be imported
 185    *
 186    * @param bool $prefix
 187    *
 188    * @return array
 189    */
 190   static function &import($prefix = false) {
 191     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_event_unsubscribe', $prefix, array());
 192     return $r;
 193   }
 194   /**
 195    * Returns the list of fields that can be exported
 196    *
 197    * @param bool $prefix
 198    *
 199    * @return array
 200    */
 201   static function &export($prefix = false) {
 202     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_event_unsubscribe', $prefix, array());
 203     return $r;
 204   }
 205   /**
 206    * Returns the list of indices
 207    */
 208   public static function indices($localize = TRUE) {
 209     $indices = array();
 210     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 211   }
 212 }