3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * @copyright CiviCRM LLC (c) 2004-2017
31 * Generated from xml/schema/CRM/Contact/SubscriptionHistory.xml
32 * DO NOT EDIT. Generated by CRM_Core_CodeGen
33 * (GenCodeChecksum:ec4a81f7d1a8999051ec7292f499b4c1)
35 require_once 'CRM/Core/DAO.php';
36 require_once 'CRM/Utils/Type.php';
38 * CRM_Contact_DAO_SubscriptionHistory constructor.
40 class CRM_Contact_DAO_SubscriptionHistory
extends CRM_Core_DAO
{
42 * Static instance to hold the table name.
46 static $_tableName = 'civicrm_subscription_history';
48 * Should CiviCRM log any modifications to this table in the civicrm_log table.
72 * Date of the (un)subscription
78 * How the (un)subscription was triggered
84 * The state of the contact within the group
90 * IP address or other tracking info
98 function __construct() {
99 $this->__table
= 'civicrm_subscription_history';
100 parent
::__construct();
103 * Returns foreign keys and entity references.
106 * [CRM_Core_Reference_Interface]
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']);
115 return Civi
::$statics[__CLASS__
]['links'];
118 * Returns all the column names of this table
122 static function &fields() {
123 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
124 Civi
::$statics[__CLASS__
]['fields'] = array(
127 'type' => CRM_Utils_Type
::T_INT
,
128 'title' => ts('Group Membership History ID') ,
129 'description' => 'Internal Id',
131 'table_name' => 'civicrm_subscription_history',
132 'entity' => 'SubscriptionHistory',
133 'bao' => 'CRM_Contact_BAO_SubscriptionHistory',
135 'contact_id' => array(
136 'name' => 'contact_id',
137 'type' => CRM_Utils_Type
::T_INT
,
138 'title' => ts('Contact ID') ,
139 'description' => 'Contact Id',
141 'table_name' => 'civicrm_subscription_history',
142 'entity' => 'SubscriptionHistory',
143 'bao' => 'CRM_Contact_BAO_SubscriptionHistory',
144 'FKClassName' => 'CRM_Contact_DAO_Contact',
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',
158 'pseudoconstant' => array(
159 'table' => 'civicrm_group',
161 'labelColumn' => 'title',
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',
170 'table_name' => 'civicrm_subscription_history',
171 'entity' => 'SubscriptionHistory',
172 'bao' => 'CRM_Contact_BAO_SubscriptionHistory',
176 'type' => CRM_Utils_Type
::T_STRING
,
177 'title' => ts('Group Membership Action') ,
178 'description' => 'How the (un)subscription was triggered',
180 'size' => CRM_Utils_Type
::EIGHT
,
181 'table_name' => 'civicrm_subscription_history',
182 'entity' => 'SubscriptionHistory',
183 'bao' => 'CRM_Contact_BAO_SubscriptionHistory',
187 'pseudoconstant' => array(
188 'callback' => 'CRM_Core_SelectValues::getSubscriptionHistoryMethods',
193 'type' => CRM_Utils_Type
::T_STRING
,
194 'title' => ts('Group Membership Status') ,
195 'description' => 'The state of the contact within the group',
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',
206 'name' => 'tracking',
207 'type' => CRM_Utils_Type
::T_STRING
,
208 'title' => ts('Group Membership Tracking') ,
209 'description' => 'IP address or other tracking info',
211 'size' => CRM_Utils_Type
::HUGE
,
212 'table_name' => 'civicrm_subscription_history',
213 'entity' => 'SubscriptionHistory',
214 'bao' => 'CRM_Contact_BAO_SubscriptionHistory',
217 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
219 return Civi
::$statics[__CLASS__
]['fields'];
222 * Return a mapping from field-name to the corresponding key (as used in fields()).
225 * Array(string $name => string $uniqueName).
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()));
231 return Civi
::$statics[__CLASS__
]['fieldKeys'];
234 * Returns the names of this table
238 static function getTableName() {
239 return self
::$_tableName;
242 * Returns if this table needs to be logged
250 * Returns the list of fields that can be imported
252 * @param bool $prefix
256 static function &import($prefix = false) {
257 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'subscription_history', $prefix, array());
261 * Returns the list of fields that can be exported
263 * @param bool $prefix
267 static function &export($prefix = false) {
268 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'subscription_history', $prefix, array());