1 <?xml version=
"1.0" encoding=
"iso-8859-1" ?>
4 <base>CRM/Member
</base>
5 <class>Membership
</class>
6 <name>civicrm_membership
</name>
7 <comment>Contact Membership records.
</comment>
12 <uniqueName>membership_id
</uniqueName>
13 <type>int unsigned
</type>
14 <required>true
</required>
16 <title>Membership ID
</title>
17 <headerPattern>/^(m(embership\s)?id)$/i
</headerPattern>
18 <comment>Membership Id
</comment>
23 <autoincrement>true
</autoincrement>
27 <name>contact_id
</name>
28 <uniqueName>membership_contact_id
</uniqueName>
29 <type>int unsigned
</type>
30 <required>true
</required>
31 <title>Contact ID
</title>
32 <headerPattern>/contact(.?id)?/i
</headerPattern>
33 <dataPattern>/^\d+$/
</dataPattern>
35 <comment>FK to Contact ID
</comment>
38 <type>EntityRef
</type>
42 <name>contact_id
</name>
43 <table>civicrm_contact
</table>
46 <onDelete>CASCADE
</onDelete>
49 <name>membership_type_id
</name>
50 <type>int unsigned
</type>
51 <title>Membership Type Id
</title>
53 <headerPattern>/^(m(embership\s)?type)$/i
</headerPattern>
54 <export>false
</export>
55 <required>true
</required>
56 <comment>FK to Membership Type
</comment>
58 <table>civicrm_membership_type
</table>
59 <keyColumn>id
</keyColumn>
60 <labelColumn>name
</labelColumn>
68 <name>membership_type_id
</name>
69 <table>civicrm_membership_type
</table>
72 <onDelete>CASCADE
</onDelete>
75 <name>join_date
</name>
76 <title>Member Since
</title>
79 <headerPattern>/^join|(j(oin\s)?date)$/i
</headerPattern>
80 <dataPattern>/\d{
4}-?\d{
2}-?\d{
2}/
</dataPattern>
81 <comment>Beginning of initial membership period (member since...).
</comment>
84 <type>Select Date
</type>
85 <formatType>activityDate
</formatType>
87 <uniqueName>membership_join_date
</uniqueName>
90 <name>start_date
</name>
91 <uniqueName>membership_start_date
</uniqueName>
92 <title>Membership Start Date
</title>
95 <headerPattern>/(member(ship)?.)?start(s)?(.date$)?/i
</headerPattern>
96 <dataPattern>/\d{
4}-?\d{
2}-?\d{
2}/
</dataPattern>
97 <comment>Beginning of current uninterrupted membership period.
</comment>
100 <type>Select Date
</type>
101 <formatType>activityDate
</formatType>
105 <name>end_date
</name>
106 <uniqueName>membership_end_date
</uniqueName>
107 <title>Membership Expiration Date
</title>
109 <import>true
</import>
110 <headerPattern>/(member(ship)?.)?end(s)?(.date$)?/i
</headerPattern>
111 <dataPattern>/\d{
4}-?\d{
2}-?\d{
2}/
</dataPattern>
112 <comment>Current membership period expire date.
</comment>
115 <type>Select Date
</type>
116 <formatType>activityDate
</formatType>
121 <uniqueName>membership_source
</uniqueName>
122 <title>Source
</title>
123 <import>true
</import>
124 <headerPattern>/^(member(ship?))?source$/i
</headerPattern>
133 <name>status_id
</name>
134 <title>Membership Status Id
</title>
135 <import>true
</import>
136 <headerPattern>/(member(ship|).)?(status)$/i
</headerPattern>
137 <type>int unsigned
</type>
138 <export>false
</export>
139 <required>true
</required>
140 <comment>FK to Membership Status
</comment>
142 <table>civicrm_membership_status
</table>
143 <keyColumn>id
</keyColumn>
144 <labelColumn>label
</labelColumn>
152 <name>status_id
</name>
153 <table>civicrm_membership_status
</table>
156 <onDelete>CASCADE
</onDelete>
159 <name>is_override
</name>
160 <uniqueName>member_is_override
</uniqueName>
161 <title>Status Override
</title>
162 <import>true
</import>
163 <export>true
</export>
164 <headerPattern>/override$/i
</headerPattern>
166 <comment>Admin users may set a manual status which overrides the calculated status. When this flag is true, automated status update scripts should NOT modify status for the record.
</comment>
168 <type>CheckBox
</type>
173 <name>status_override_end_date
</name>
174 <title>Status Override End Date
</title>
176 <default>NULL
</default>
177 <import>true
</import>
178 <comment>Then end date of membership status override if 'Override until selected date' override type is selected.
</comment>
181 <type>Select Date
</type>
185 <name>owner_membership_id
</name>
186 <type>int unsigned
</type>
187 <title>Primary Member ID
</title>
188 <comment>Optional FK to Parent Membership.
</comment>
189 <export>true
</export>
193 <name>owner_membership_id
</name>
194 <table>civicrm_membership
</table>
197 <onDelete>SET NULL
</onDelete>
200 <name>index_owner_membership_id
</name>
201 <fieldName>owner_membership_id
</fieldName>
205 <name>max_related
</name>
207 <comment>Maximum number of related memberships (membership_type override).
</comment>
209 <export>true
</export>
217 <uniqueName>member_is_test
</uniqueName>
220 <import>true
</import>
221 <headerPattern>/(is.)?test(.member(ship)?)?/i
</headerPattern>
223 <type>CheckBox
</type>
227 <name>is_pay_later
</name>
228 <uniqueName>member_is_pay_later
</uniqueName>
229 <title>Is Pay Later
</title>
232 <import>true
</import>
233 <headerPattern>/(is.)?(pay(.)?later)$/i
</headerPattern>
236 <type>CheckBox
</type>
240 <name>contribution_recur_id
</name>
241 <uniqueName>membership_recur_id
</uniqueName>
242 <title>Membership Recurring Contribution
</title>
243 <type>int unsigned
</type>
244 <export>true
</export>
245 <comment>Conditional foreign key to civicrm_contribution_recur id. Each membership in connection with a recurring contribution carries a foreign key to the recurring contribution record. This assumes we can track these processor initiated events.
</comment>
249 <name>contribution_recur_id
</name>
250 <table>civicrm_contribution_recur
</table>
253 <onDelete>SET NULL
</onDelete>
256 <name>campaign_id
</name>
257 <uniqueName>member_campaign_id
</uniqueName>
258 <type>int unsigned
</type>
259 <title>Campaign
</title>
260 <import>true
</import>
261 <comment>The campaign for which this membership is attached.
</comment>
263 <table>civicrm_campaign
</table>
264 <keyColumn>id
</keyColumn>
265 <labelColumn>title
</labelColumn>
273 <name>campaign_id
</name>
274 <table>civicrm_campaign
</table>
276 <onDelete>SET NULL
</onDelete>