Commit | Line | Data |
---|---|---|
e501603b TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.7 | | |
5 | +--------------------------------------------------------------------+ | |
6 | | Copyright CiviCRM LLC (c) 2004-2016 | | |
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-2016 | |
30 | * | |
31 | * Generated from xml/schema/CRM/Contact/SubscriptionHistory.xml | |
32 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
437fafcf | 33 | * (GenCodeChecksum:1aa5b138c1294eb320ce13ff98c124ef) |
e501603b TO |
34 | */ |
35 | require_once 'CRM/Core/DAO.php'; | |
36 | require_once 'CRM/Utils/Type.php'; | |
37 | class CRM_Contact_DAO_SubscriptionHistory extends CRM_Core_DAO { | |
38 | /** | |
39 | * static instance to hold the table name | |
40 | * | |
41 | * @var string | |
42 | */ | |
43 | static $_tableName = 'civicrm_subscription_history'; | |
e501603b TO |
44 | /** |
45 | * static value to see if we should log any modifications to | |
46 | * this table in the civicrm_log table | |
47 | * | |
48 | * @var boolean | |
49 | */ | |
50 | static $_log = true; | |
51 | /** | |
52 | * Internal Id | |
53 | * | |
54 | * @var int unsigned | |
55 | */ | |
56 | public $id; | |
57 | /** | |
58 | * Contact Id | |
59 | * | |
60 | * @var int unsigned | |
61 | */ | |
62 | public $contact_id; | |
63 | /** | |
64 | * Group Id | |
65 | * | |
66 | * @var int unsigned | |
67 | */ | |
68 | public $group_id; | |
69 | /** | |
70 | * Date of the (un)subscription | |
71 | * | |
72 | * @var datetime | |
73 | */ | |
74 | public $date; | |
75 | /** | |
76 | * How the (un)subscription was triggered | |
77 | * | |
78 | * @var string | |
79 | */ | |
80 | public $method; | |
81 | /** | |
82 | * The state of the contact within the group | |
83 | * | |
84 | * @var string | |
85 | */ | |
86 | public $status; | |
87 | /** | |
88 | * IP address or other tracking info | |
89 | * | |
90 | * @var string | |
91 | */ | |
92 | public $tracking; | |
93 | /** | |
94 | * class constructor | |
95 | * | |
96 | * @return civicrm_subscription_history | |
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() { | |
346aaaba TO |
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']); | |
e501603b | 114 | } |
346aaaba | 115 | return Civi::$statics[__CLASS__]['links']; |
e501603b TO |
116 | } |
117 | /** | |
118 | * Returns all the column names of this table | |
119 | * | |
120 | * @return array | |
121 | */ | |
122 | static function &fields() { | |
346aaaba TO |
123 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
124 | Civi::$statics[__CLASS__]['fields'] = array( | |
e501603b TO |
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 | ); | |
346aaaba | 196 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 197 | } |
346aaaba | 198 | return Civi::$statics[__CLASS__]['fields']; |
e501603b TO |
199 | } |
200 | /** | |
bd8e0b14 | 201 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
202 | * |
203 | * @return array | |
bd8e0b14 | 204 | * Array(string $name => string $uniqueName). |
e501603b TO |
205 | */ |
206 | static function &fieldKeys() { | |
bd8e0b14 TO |
207 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
208 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 209 | } |
bd8e0b14 | 210 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b TO |
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) { | |
60808919 TO |
236 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'subscription_history', $prefix, array()); |
237 | return $r; | |
e501603b TO |
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) { | |
60808919 TO |
247 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'subscription_history', $prefix, array()); |
248 | return $r; | |
e501603b TO |
249 | } |
250 | } |