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>
10 <icon>fa-id-badge
</icon>
11 <component>CiviMember
</component>
13 <add>civicrm/member/add?reset=
1&action=add
&context=standalone
</add>
14 <view>civicrm/contact/view/membership?reset=
1&action=view
&id=[id]
&cid=[contact_id]
</view>
15 <update>civicrm/contact/view/membership?reset=
1&action=update
&id=[id]
&cid=[contact_id]
</update>
16 <delete>civicrm/contact/view/membership?reset=
1&action=delete
&id=[id]
&cid=[contact_id]
</delete>
20 <uniqueName>membership_id
</uniqueName>
21 <type>int unsigned
</type>
22 <required>true
</required>
24 <title>Membership ID
</title>
25 <headerPattern>/^(m(embership\s)?id)$/i
</headerPattern>
26 <comment>Membership Id
</comment>
31 <autoincrement>true
</autoincrement>
35 <name>contact_id
</name>
36 <uniqueName>membership_contact_id
</uniqueName>
37 <type>int unsigned
</type>
38 <required>true
</required>
39 <title>Contact ID
</title>
40 <headerPattern>/contact(.?id)?/i
</headerPattern>
41 <dataPattern>/^\d+$/
</dataPattern>
43 <comment>FK to Contact ID
</comment>
46 <type>EntityRef
</type>
50 <name>contact_id
</name>
51 <table>civicrm_contact
</table>
54 <onDelete>CASCADE
</onDelete>
57 <name>membership_type_id
</name>
58 <type>int unsigned
</type>
59 <title>Membership Type Id
</title>
61 <headerPattern>/^(m(embership\s)?type)$/i
</headerPattern>
62 <export>false
</export>
63 <required>true
</required>
64 <comment>FK to Membership Type
</comment>
66 <table>civicrm_membership_type
</table>
67 <keyColumn>id
</keyColumn>
68 <labelColumn>name
</labelColumn>
72 <label>Membership Type
</label>
77 <name>membership_type_id
</name>
78 <table>civicrm_membership_type
</table>
81 <onDelete>CASCADE
</onDelete>
84 <name>join_date
</name>
85 <title>Member Since
</title>
88 <headerPattern>/^join|(j(oin\s)?date)$/i
</headerPattern>
89 <dataPattern>/\d{
4}-?\d{
2}-?\d{
2}/
</dataPattern>
90 <comment>Beginning of initial membership period (member since...).
</comment>
93 <type>Select Date
</type>
94 <formatType>activityDate
</formatType>
96 <uniqueName>membership_join_date
</uniqueName>
99 <name>start_date
</name>
100 <uniqueName>membership_start_date
</uniqueName>
101 <title>Membership Start Date
</title>
103 <import>true
</import>
104 <headerPattern>/(member(ship)?.)?start(s)?(.date$)?/i
</headerPattern>
105 <dataPattern>/\d{
4}-?\d{
2}-?\d{
2}/
</dataPattern>
106 <comment>Beginning of current uninterrupted membership period.
</comment>
109 <type>Select Date
</type>
110 <formatType>activityDate
</formatType>
114 <name>end_date
</name>
115 <uniqueName>membership_end_date
</uniqueName>
116 <title>Membership Expiration Date
</title>
118 <import>true
</import>
119 <headerPattern>/(member(ship)?.)?end(s)?(.date$)?/i
</headerPattern>
120 <dataPattern>/\d{
4}-?\d{
2}-?\d{
2}/
</dataPattern>
121 <comment>Current membership period expire date.
</comment>
124 <type>Select Date
</type>
125 <formatType>activityDate
</formatType>
130 <uniqueName>membership_source
</uniqueName>
131 <title>Source
</title>
132 <import>true
</import>
133 <headerPattern>/^(member(ship?))?source$/i
</headerPattern>
142 <name>status_id
</name>
143 <title>Membership Status Id
</title>
144 <import>true
</import>
145 <headerPattern>/(member(ship|).)?(status)$/i
</headerPattern>
146 <type>int unsigned
</type>
147 <export>false
</export>
148 <required>true
</required>
149 <comment>FK to Membership Status
</comment>
151 <table>civicrm_membership_status
</table>
152 <keyColumn>id
</keyColumn>
153 <labelColumn>label
</labelColumn>
161 <name>status_id
</name>
162 <table>civicrm_membership_status
</table>
165 <onDelete>CASCADE
</onDelete>
168 <name>is_override
</name>
169 <uniqueName>member_is_override
</uniqueName>
170 <title>Status Override
</title>
171 <import>true
</import>
172 <export>true
</export>
173 <headerPattern>/override$/i
</headerPattern>
175 <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>
177 <type>CheckBox
</type>
182 <name>status_override_end_date
</name>
183 <title>Status Override End Date
</title>
185 <default>NULL
</default>
186 <import>true
</import>
187 <comment>Then end date of membership status override if 'Override until selected date' override type is selected.
</comment>
190 <type>Select Date
</type>
191 <formatType>activityDate
</formatType>
195 <name>owner_membership_id
</name>
196 <type>int unsigned
</type>
197 <title>Primary Member ID
</title>
198 <comment>Optional FK to Parent Membership.
</comment>
199 <export>true
</export>
203 <name>owner_membership_id
</name>
204 <table>civicrm_membership
</table>
207 <onDelete>SET NULL
</onDelete>
210 <name>index_owner_membership_id
</name>
211 <fieldName>owner_membership_id
</fieldName>
215 <name>max_related
</name>
217 <comment>Maximum number of related memberships (membership_type override).
</comment>
219 <export>true
</export>
227 <uniqueName>member_is_test
</uniqueName>
230 <import>true
</import>
231 <headerPattern>/(is.)?test(.member(ship)?)?/i
</headerPattern>
233 <type>CheckBox
</type>
237 <name>is_pay_later
</name>
238 <uniqueName>member_is_pay_later
</uniqueName>
239 <title>Is Pay Later
</title>
242 <import>true
</import>
243 <headerPattern>/(is.)?(pay(.)?later)$/i
</headerPattern>
246 <type>CheckBox
</type>
250 <name>contribution_recur_id
</name>
251 <uniqueName>membership_recur_id
</uniqueName>
252 <title>Membership Recurring Contribution
</title>
253 <type>int unsigned
</type>
254 <export>true
</export>
255 <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>
259 <name>contribution_recur_id
</name>
260 <table>civicrm_contribution_recur
</table>
263 <onDelete>SET NULL
</onDelete>
266 <name>campaign_id
</name>
267 <uniqueName>member_campaign_id
</uniqueName>
268 <type>int unsigned
</type>
269 <title>Campaign
</title>
270 <import>true
</import>
271 <comment>The campaign for which this membership is attached.
</comment>
273 <table>civicrm_campaign
</table>
274 <keyColumn>id
</keyColumn>
275 <labelColumn>title
</labelColumn>
283 <name>campaign_id
</name>
284 <table>civicrm_campaign
</table>
286 <onDelete>SET NULL
</onDelete>