5 * @copyright CiviCRM LLC (c) 2004-2017
7 * Generated from xml/schema/CRM/Member/MembershipLog.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:9182bcbeed0a05c3fed5f3027ba89668)
13 * Database access object for the MembershipLog entity.
15 class CRM_Member_DAO_MembershipLog
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 static $_tableName = 'civicrm_membership_log';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
37 * FK to Membership table
41 public $membership_id;
44 * New status assigned to membership by this action. FK to Membership Status
51 * New membership period start date
58 * New membership period expiration date.
65 * FK to Contact ID of person under whose credentials this data modification was made.
72 * Date this membership modification action was logged.
76 public $modified_date;
79 * FK to Membership Type.
83 public $membership_type_id;
86 * Maximum number of related memberships.
95 public function __construct() {
96 $this->__table
= 'civicrm_membership_log';
97 parent
::__construct();
101 * Returns foreign keys and entity references.
104 * [CRM_Core_Reference_Interface]
106 public static function getReferenceColumns() {
107 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
108 Civi
::$statics[__CLASS__
]['links'] = static ::createReferenceColumns(__CLASS__
);
109 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'membership_id', 'civicrm_membership', 'id');
110 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'status_id', 'civicrm_membership_status', 'id');
111 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'modified_id', 'civicrm_contact', 'id');
112 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'membership_type_id', 'civicrm_membership_type', 'id');
113 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
115 return Civi
::$statics[__CLASS__
]['links'];
119 * Returns all the column names of this table
123 public static function &fields() {
124 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
125 Civi
::$statics[__CLASS__
]['fields'] = [
128 'type' => CRM_Utils_Type
::T_INT
,
129 'title' => ts('Membership Log ID'),
131 'table_name' => 'civicrm_membership_log',
132 'entity' => 'MembershipLog',
133 'bao' => 'CRM_Member_BAO_MembershipLog',
137 'name' => 'membership_id',
138 'type' => CRM_Utils_Type
::T_INT
,
139 'title' => ts('Membership ID'),
140 'description' => 'FK to Membership table',
142 'table_name' => 'civicrm_membership_log',
143 'entity' => 'MembershipLog',
144 'bao' => 'CRM_Member_BAO_MembershipLog',
146 'FKClassName' => 'CRM_Member_DAO_Membership',
149 'name' => 'status_id',
150 'type' => CRM_Utils_Type
::T_INT
,
151 'title' => ts('Membership Status'),
152 'description' => 'New status assigned to membership by this action. FK to Membership Status',
154 'table_name' => 'civicrm_membership_log',
155 'entity' => 'MembershipLog',
156 'bao' => 'CRM_Member_BAO_MembershipLog',
158 'FKClassName' => 'CRM_Member_DAO_MembershipStatus',
161 'name' => 'start_date',
162 'type' => CRM_Utils_Type
::T_DATE
,
163 'title' => ts('Membership Log Start Date'),
164 'description' => 'New membership period start date',
165 'table_name' => 'civicrm_membership_log',
166 'entity' => 'MembershipLog',
167 'bao' => 'CRM_Member_BAO_MembershipLog',
171 'name' => 'end_date',
172 'type' => CRM_Utils_Type
::T_DATE
,
173 'title' => ts('Membership Log End Date'),
174 'description' => 'New membership period expiration date.',
175 'table_name' => 'civicrm_membership_log',
176 'entity' => 'MembershipLog',
177 'bao' => 'CRM_Member_BAO_MembershipLog',
181 'name' => 'modified_id',
182 'type' => CRM_Utils_Type
::T_INT
,
183 'title' => ts('Membership Log modified By'),
184 'description' => 'FK to Contact ID of person under whose credentials this data modification was made.',
185 'table_name' => 'civicrm_membership_log',
186 'entity' => 'MembershipLog',
187 'bao' => 'CRM_Member_BAO_MembershipLog',
189 'FKClassName' => 'CRM_Contact_DAO_Contact',
192 'name' => 'modified_date',
193 'type' => CRM_Utils_Type
::T_DATE
,
194 'title' => ts('Membership Change Date'),
195 'description' => 'Date this membership modification action was logged.',
196 'table_name' => 'civicrm_membership_log',
197 'entity' => 'MembershipLog',
198 'bao' => 'CRM_Member_BAO_MembershipLog',
201 'membership_type_id' => [
202 'name' => 'membership_type_id',
203 'type' => CRM_Utils_Type
::T_INT
,
204 'title' => ts('Membership Type ID'),
205 'description' => 'FK to Membership Type.',
206 'table_name' => 'civicrm_membership_log',
207 'entity' => 'MembershipLog',
208 'bao' => 'CRM_Member_BAO_MembershipLog',
210 'FKClassName' => 'CRM_Member_DAO_MembershipType',
213 'name' => 'max_related',
214 'type' => CRM_Utils_Type
::T_INT
,
215 'title' => ts('Maximum Related Memberships'),
216 'description' => 'Maximum number of related memberships.',
217 'table_name' => 'civicrm_membership_log',
218 'entity' => 'MembershipLog',
219 'bao' => 'CRM_Member_BAO_MembershipLog',
223 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
225 return Civi
::$statics[__CLASS__
]['fields'];
229 * Return a mapping from field-name to the corresponding key (as used in fields()).
232 * Array(string $name => string $uniqueName).
234 public static function &fieldKeys() {
235 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
236 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
238 return Civi
::$statics[__CLASS__
]['fieldKeys'];
242 * Returns the names of this table
246 public static function getTableName() {
247 return self
::$_tableName;
251 * Returns if this table needs to be logged
255 public function getLog() {
260 * Returns the list of fields that can be imported
262 * @param bool $prefix
266 public static function &import($prefix = FALSE) {
267 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'membership_log', $prefix, []);
272 * Returns the list of fields that can be exported
274 * @param bool $prefix
278 public static function &export($prefix = FALSE) {
279 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'membership_log', $prefix, []);
284 * Returns the list of indices
286 * @param bool $localize
290 public static function indices($localize = TRUE) {
292 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;