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