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:ec4a81f7d1a8999051ec7292f499b4c1)
  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 datetime
  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         ) ,
 135         'contact_id' => array(
 136           'name' => 'contact_id',
 137           'type' => CRM_Utils_Type::T_INT,
 138           'title' => ts('Contact ID') ,
 139           'description' => 'Contact Id',
 140           'required' => true,
 141           'table_name' => 'civicrm_subscription_history',
 142           'entity' => 'SubscriptionHistory',
 143           'bao' => 'CRM_Contact_BAO_SubscriptionHistory',
 144           'FKClassName' => 'CRM_Contact_DAO_Contact',
 145         ) ,
 146         'group_id' => array(
 147           'name' => 'group_id',
 148           'type' => CRM_Utils_Type::T_INT,
 149           'title' => ts('Group') ,
 150           'description' => 'Group Id',
 151           'table_name' => 'civicrm_subscription_history',
 152           'entity' => 'SubscriptionHistory',
 153           'bao' => 'CRM_Contact_BAO_SubscriptionHistory',
 154           'FKClassName' => 'CRM_Contact_DAO_Group',
 155           'html' => array(
 156             'type' => 'Select',
 157           ) ,
 158           'pseudoconstant' => array(
 159             'table' => 'civicrm_group',
 160             'keyColumn' => 'id',
 161             'labelColumn' => 'title',
 162           )
 163         ) ,
 164         'date' => array(
 165           'name' => 'date',
 166           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 167           'title' => ts('Group Membership Action Date') ,
 168           'description' => 'Date of the (un)subscription',
 169           'required' => true,
 170           'table_name' => 'civicrm_subscription_history',
 171           'entity' => 'SubscriptionHistory',
 172           'bao' => 'CRM_Contact_BAO_SubscriptionHistory',
 173         ) ,
 174         'method' => array(
 175           'name' => 'method',
 176           'type' => CRM_Utils_Type::T_STRING,
 177           'title' => ts('Group Membership Action') ,
 178           'description' => 'How the (un)subscription was triggered',
 179           'maxlength' => 8,
 180           'size' => CRM_Utils_Type::EIGHT,
 181           'table_name' => 'civicrm_subscription_history',
 182           'entity' => 'SubscriptionHistory',
 183           'bao' => 'CRM_Contact_BAO_SubscriptionHistory',
 184           'html' => array(
 185             'type' => 'Select',
 186           ) ,
 187           'pseudoconstant' => array(
 188             'callback' => 'CRM_Core_SelectValues::getSubscriptionHistoryMethods',
 189           )
 190         ) ,
 191         'status' => array(
 192           'name' => 'status',
 193           'type' => CRM_Utils_Type::T_STRING,
 194           'title' => ts('Group Membership Status') ,
 195           'description' => 'The state of the contact within the group',
 196           'maxlength' => 8,
 197           'size' => CRM_Utils_Type::EIGHT,
 198           'table_name' => 'civicrm_subscription_history',
 199           'entity' => 'SubscriptionHistory',
 200           'bao' => 'CRM_Contact_BAO_SubscriptionHistory',
 201           'pseudoconstant' => array(
 202             'callback' => 'CRM_Core_SelectValues::groupContactStatus',
 203           )
 204         ) ,
 205         'tracking' => array(
 206           'name' => 'tracking',
 207           'type' => CRM_Utils_Type::T_STRING,
 208           'title' => ts('Group Membership Tracking') ,
 209           'description' => 'IP address or other tracking info',
 210           'maxlength' => 255,
 211           'size' => CRM_Utils_Type::HUGE,
 212           'table_name' => 'civicrm_subscription_history',
 213           'entity' => 'SubscriptionHistory',
 214           'bao' => 'CRM_Contact_BAO_SubscriptionHistory',
 215         ) ,
 216       );
 217       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 218     }
 219     return Civi::$statics[__CLASS__]['fields'];
 220   }
 221   /**
 222    * Return a mapping from field-name to the corresponding key (as used in fields()).
 223    *
 224    * @return array
 225    *   Array(string $name => string $uniqueName).
 226    */
 227   static function &fieldKeys() {
 228     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 229       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 230     }
 231     return Civi::$statics[__CLASS__]['fieldKeys'];
 232   }
 233   /**
 234    * Returns the names of this table
 235    *
 236    * @return string
 237    */
 238   static function getTableName() {
 239     return self::$_tableName;
 240   }
 241   /**
 242    * Returns if this table needs to be logged
 243    *
 244    * @return boolean
 245    */
 246   function getLog() {
 247     return self::$_log;
 248   }
 249   /**
 250    * Returns the list of fields that can be imported
 251    *
 252    * @param bool $prefix
 253    *
 254    * @return array
 255    */
 256   static function &import($prefix = false) {
 257     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'subscription_history', $prefix, array());
 258     return $r;
 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     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'subscription_history', $prefix, array());
 269     return $r;
 270   }
 271 }