CRM/Contact/DAO/SubscriptionHistory.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/Contact/SubscriptionHistory.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:8b7f0a4e3593bc26947b4bb6cf54c2d2)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Contact_DAO_SubscriptionHistory constructor.
  39  */
  40 class CRM_Contact_DAO_SubscriptionHistory extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_subscription_history';
  47   /**
  48    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  49    *
  50    * @var boolean
  51    */
  52   static $_log = true;
  53   /**
  54    * Internal Id
  55    *
  56    * @var int unsigned
  57    */
  58   public $id;
  59   /**
  60    * Contact Id
  61    *
  62    * @var int unsigned
  63    */
  64   public $contact_id;
  65   /**
  66    * Group Id
  67    *
  68    * @var int unsigned
  69    */
  70   public $group_id;
  71   /**
  72    * Date of the (un)subscription
  73    *
  74    * @var timestamp
  75    */
  76   public $date;
  77   /**
  78    * How the (un)subscription was triggered
  79    *
  80    * @var string
  81    */
  82   public $method;
  83   /**
  84    * The state of the contact within the group
  85    *
  86    * @var string
  87    */
  88   public $status;
  89   /**
  90    * IP address or other tracking info
  91    *
  92    * @var string
  93    */
  94   public $tracking;
  95   /**
  96    * Class constructor.
  97    */
  98   function __construct() {
  99     $this->__table = 'civicrm_subscription_history';
 100     parent::__construct();
 101   }
 102   /**
 103    * Returns foreign keys and entity references.
 104    *
 105    * @return array
 106    *   [CRM_Core_Reference_Interface]
 107    */
 108   static function getReferenceColumns() {
 109     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 110       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
 111       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'contact_id', 'civicrm_contact', 'id');
 112       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'group_id', 'civicrm_group', 'id');
 113       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 114     }
 115     return Civi::$statics[__CLASS__]['links'];
 116   }
 117   /**
 118    * Returns all the column names of this table
 119    *
 120    * @return array
 121    */
 122   static function &fields() {
 123     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 124       Civi::$statics[__CLASS__]['fields'] = array(
 125         'id' => array(
 126           'name' => 'id',
 127           'type' => CRM_Utils_Type::T_INT,
 128           'title' => ts('Group Membership History ID') ,
 129           'description' => 'Internal Id',
 130           'required' => true,
 131           'table_name' => 'civicrm_subscription_history',
 132           'entity' => 'SubscriptionHistory',
 133           'bao' => 'CRM_Contact_BAO_SubscriptionHistory',
 134           'localizable' => 0,
 135         ) ,
 136         'contact_id' => array(
 137           'name' => 'contact_id',
 138           'type' => CRM_Utils_Type::T_INT,
 139           'title' => ts('Contact ID') ,
 140           'description' => 'Contact Id',
 141           'required' => true,
 142           'table_name' => 'civicrm_subscription_history',
 143           'entity' => 'SubscriptionHistory',
 144           'bao' => 'CRM_Contact_BAO_SubscriptionHistory',
 145           'localizable' => 0,
 146           'FKClassName' => 'CRM_Contact_DAO_Contact',
 147         ) ,
 148         'group_id' => array(
 149           'name' => 'group_id',
 150           'type' => CRM_Utils_Type::T_INT,
 151           'title' => ts('Group') ,
 152           'description' => 'Group Id',
 153           'table_name' => 'civicrm_subscription_history',
 154           'entity' => 'SubscriptionHistory',
 155           'bao' => 'CRM_Contact_BAO_SubscriptionHistory',
 156           'localizable' => 0,
 157           'FKClassName' => 'CRM_Contact_DAO_Group',
 158           'html' => array(
 159             'type' => 'Select',
 160           ) ,
 161           'pseudoconstant' => array(
 162             'table' => 'civicrm_group',
 163             'keyColumn' => 'id',
 164             'labelColumn' => 'title',
 165           )
 166         ) ,
 167         'date' => array(
 168           'name' => 'date',
 169           'type' => CRM_Utils_Type::T_TIMESTAMP,
 170           'title' => ts('Group Membership Action Date') ,
 171           'description' => 'Date of the (un)subscription',
 172           'required' => true,
 173           'default' => 'CURRENT_TIMESTAMP',
 174           'table_name' => 'civicrm_subscription_history',
 175           'entity' => 'SubscriptionHistory',
 176           'bao' => 'CRM_Contact_BAO_SubscriptionHistory',
 177           'localizable' => 0,
 178         ) ,
 179         'method' => array(
 180           'name' => 'method',
 181           'type' => CRM_Utils_Type::T_STRING,
 182           'title' => ts('Group Membership Action') ,
 183           'description' => 'How the (un)subscription was triggered',
 184           'maxlength' => 8,
 185           'size' => CRM_Utils_Type::EIGHT,
 186           'table_name' => 'civicrm_subscription_history',
 187           'entity' => 'SubscriptionHistory',
 188           'bao' => 'CRM_Contact_BAO_SubscriptionHistory',
 189           'localizable' => 0,
 190           'html' => array(
 191             'type' => 'Select',
 192           ) ,
 193           'pseudoconstant' => array(
 194             'callback' => 'CRM_Core_SelectValues::getSubscriptionHistoryMethods',
 195           )
 196         ) ,
 197         'status' => array(
 198           'name' => 'status',
 199           'type' => CRM_Utils_Type::T_STRING,
 200           'title' => ts('Group Membership Status') ,
 201           'description' => 'The state of the contact within the group',
 202           'maxlength' => 8,
 203           'size' => CRM_Utils_Type::EIGHT,
 204           'table_name' => 'civicrm_subscription_history',
 205           'entity' => 'SubscriptionHistory',
 206           'bao' => 'CRM_Contact_BAO_SubscriptionHistory',
 207           'localizable' => 0,
 208           'pseudoconstant' => array(
 209             'callback' => 'CRM_Core_SelectValues::groupContactStatus',
 210           )
 211         ) ,
 212         'tracking' => array(
 213           'name' => 'tracking',
 214           'type' => CRM_Utils_Type::T_STRING,
 215           'title' => ts('Group Membership Tracking') ,
 216           'description' => 'IP address or other tracking info',
 217           'maxlength' => 255,
 218           'size' => CRM_Utils_Type::HUGE,
 219           'table_name' => 'civicrm_subscription_history',
 220           'entity' => 'SubscriptionHistory',
 221           'bao' => 'CRM_Contact_BAO_SubscriptionHistory',
 222           'localizable' => 0,
 223         ) ,
 224       );
 225       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 226     }
 227     return Civi::$statics[__CLASS__]['fields'];
 228   }
 229   /**
 230    * Return a mapping from field-name to the corresponding key (as used in fields()).
 231    *
 232    * @return array
 233    *   Array(string $name => string $uniqueName).
 234    */
 235   static function &fieldKeys() {
 236     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 237       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 238     }
 239     return Civi::$statics[__CLASS__]['fieldKeys'];
 240   }
 241   /**
 242    * Returns the names of this table
 243    *
 244    * @return string
 245    */
 246   static function getTableName() {
 247     return self::$_tableName;
 248   }
 249   /**
 250    * Returns if this table needs to be logged
 251    *
 252    * @return boolean
 253    */
 254   function getLog() {
 255     return self::$_log;
 256   }
 257   /**
 258    * Returns the list of fields that can be imported
 259    *
 260    * @param bool $prefix
 261    *
 262    * @return array
 263    */
 264   static function &import($prefix = false) {
 265     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'subscription_history', $prefix, array());
 266     return $r;
 267   }
 268   /**
 269    * Returns the list of fields that can be exported
 270    *
 271    * @param bool $prefix
 272    *
 273    * @return array
 274    */
 275   static function &export($prefix = false) {
 276     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'subscription_history', $prefix, array());
 277     return $r;
 278   }
 279   /**
 280    * Returns the list of indices
 281    */
 282   public static function indices($localize = TRUE) {
 283     $indices = array();
 284     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 285   }
 286 }