xml/schema/Member/MembershipType.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2
   3 <table>
   4   <base>CRM/Member</base>
   5   <class>MembershipType</class>
   6   <name>civicrm_membership_type</name>
   7   <comment>Sites can configure multiple types of memberships. They encode the owner organization, fee, and the rules needed to set start and end (expire) dates when a member signs up for that type.</comment>
   8   <add>1.5</add>
   9   <log>true</log>
  10   <field>
  11     <name>id</name>
  12     <title>Membership Type ID</title>
  13     <type>int unsigned</type>
  14     <required>true</required>
  15     <comment>Membership Id</comment>
  16     <add>1.5</add>
  17   </field>
  18   <primaryKey>
  19     <name>id</name>
  20     <autoincrement>true</autoincrement>
  21   </primaryKey>
  22   <field>
  23     <name>domain_id</name>
  24     <title>Membership Type Domain</title>
  25     <type>int unsigned</type>
  26     <required>true</required>
  27     <pseudoconstant>
  28       <table>civicrm_domain</table>
  29       <keyColumn>id</keyColumn>
  30       <labelColumn>name</labelColumn>
  31     </pseudoconstant>
  32     <comment>Which Domain is this match entry for</comment>
  33     <add>3.0</add>
  34   </field>
  35   <foreignKey>
  36     <name>domain_id</name>
  37     <table>civicrm_domain</table>
  38     <key>id</key>
  39     <add>3.0</add>
  40   </foreignKey>
  41   <field>
  42     <name>name</name>
  43     <uniqueName>membership_type</uniqueName>
  44     <title>Membership Type</title>
  45     <type>varchar</type>
  46     <import>true</import>
  47     <length>128</length>
  48     <localizable>true</localizable>
  49     <comment>Name of Membership Type</comment>
  50     <html>
  51       <type>Text</type>
  52       <label>Name</label>
  53     </html>
  54     <add>1.5</add>
  55   </field>
  56   <field>
  57     <name>description</name>
  58     <title>Membership Type Description</title>
  59     <type>varchar</type>
  60     <html>
  61       <type>TextArea</type>
  62       <rows>6</rows>
  63       <cols>50</cols>
  64       <label>Description</label>
  65     </html>
  66     <length>255</length>
  67     <localizable>true</localizable>
  68     <comment>Description of Membership Type</comment>
  69     <add>1.5</add>
  70   </field>
  71   <field>
  72     <name>member_of_contact_id</name>
  73     <title>Membership Type Organization</title>
  74     <type>int unsigned</type>
  75     <required>true</required>
  76     <comment>Owner organization for this membership type. FK to Contact ID</comment>
  77     <add>1.5</add>
  78   </field>
  79   <foreignKey>
  80     <name>member_of_contact_id</name>
  81     <table>civicrm_contact</table>
  82     <key>id</key>
  83     <add>1.5</add>
  84     <onDelete>RESTRICT</onDelete>
  85   </foreignKey>
  86   <field>
  87     <name>contribution_type_id</name>
  88     <type>int unsigned</type>
  89     <required>true</required>
  90     <comment>If membership is paid by a contribution - what contribution type should be used. FK to Contribution Type ID</comment>
  91     <add>1.5</add>
  92     <drop>4.3</drop>
  93   </field>
  94   <foreignKey>
  95     <name>contribution_type_id</name>
  96     <table>civicrm_contribution_type</table>
  97     <key>id</key>
  98     <add>1.5</add>
  99     <drop>4.3</drop>
 100   </foreignKey>
 101   <field>
 102     <name>financial_type_id</name>
 103     <title>Membership Financial Type</title>
 104     <type>int unsigned</type>
 105     <required>true</required>
 106     <pseudoconstant>
 107       <table>civicrm_financial_type</table>
 108       <keyColumn>id</keyColumn>
 109       <labelColumn>name</labelColumn>
 110     </pseudoconstant>
 111     <comment>If membership is paid by a contribution - what financial type should be used. FK to civicrm_financial_type.id</comment>
 112     <add>4.3</add>
 113   </field>
 114   <foreignKey>
 115     <name>financial_type_id</name>
 116     <table>civicrm_financial_type</table>
 117     <key>id</key>
 118     <add>4.3</add>
 119   </foreignKey>
 120   <field>
 121     <name>minimum_fee</name>
 122     <title>Membership Type Minimum Fee</title>
 123     <type>decimal</type>
 124     <length>18,9</length>
 125     <comment>Minimum fee for this membership (0 for free/complimentary memberships).</comment>
 126     <default>0</default>
 127     <html>
 128       <type>Text</type>
 129       <label>Minimum Fee</label>
 130     </html>
 131     <add>1.5</add>
 132   </field>
 133   <field>
 134     <name>duration_unit</name>
 135     <title>Membership Type Duration Unit</title>
 136     <type>varchar</type>
 137     <length>8</length>
 138     <comment>Unit in which membership period is expressed.</comment>
 139     <pseudoconstant>
 140       <callback>CRM_Core_SelectValues::membershipTypeUnitList</callback>
 141     </pseudoconstant>
 142     <add>1.5</add>
 143     <html>
 144       <type>Select</type>
 145     </html>
 146   </field>
 147   <field>
 148     <name>duration_interval</name>
 149     <title>Membership Type Duration Interval</title>
 150     <type>int</type>
 151     <html>
 152       <type>Text</type>
 153     </html>
 154     <comment>Number of duration units in membership period (e.g. 1 year, 12 months).</comment>
 155     <add>1.5</add>
 156   </field>
 157   <field>
 158     <name>period_type</name>
 159     <title>Membership Type Plan</title>
 160     <type>varchar</type>
 161     <length>8</length>
 162     <comment>Rolling membership period starts on signup date. Fixed membership periods start on fixed_period_start_day.</comment>
 163     <html>
 164       <type>Select</type>
 165     </html>
 166     <pseudoconstant>
 167       <callback>CRM_Core_SelectValues::periodType</callback>
 168     </pseudoconstant>
 169     <add>1.5</add>
 170   </field>
 171   <field>
 172     <name>fixed_period_start_day</name>
 173     <title>Fixed Period Start Day</title>
 174     <type>int</type>
 175     <comment>For fixed period memberships, month and day (mmdd) on which subscription/membership will start. Period start is back-dated unless after rollover day.</comment>
 176     <add>1.5</add>
 177   </field>
 178   <field>
 179     <name>fixed_period_rollover_day</name>
 180     <title>Fixed Period Rollover Day</title>
 181     <type>int</type>
 182     <comment>For fixed period memberships, signups after this day (mmdd) rollover to next period.</comment>
 183     <add>1.5</add>
 184   </field>
 185   <field>
 186     <name>relationship_type_id</name>
 187     <title>Membership Type Relationship</title>
 188     <type>varchar</type>
 189     <length>64</length>
 190     <comment>FK to Relationship Type ID</comment>
 191     <add>1.5</add>
 192     <serialize>SEPARATOR_TRIMMED</serialize>
 193   </field>
 194   <foreignKey>
 195     <name>relationship_type_id</name>
 196     <table>civicrm_relationship_type</table>
 197     <key>id</key>
 198     <add>1.5</add>
 199     <drop>3.3</drop>
 200   </foreignKey>
 201   <index>
 202     <name>index_relationship_type_id</name>
 203     <fieldName>relationship_type_id</fieldName>
 204     <add>3.3</add>
 205   </index>
 206   <field>
 207     <name>relationship_direction</name>
 208     <type>varchar</type>
 209     <length>128</length>
 210     <add>1.7</add>
 211     <serialize>SEPARATOR_TRIMMED</serialize>
 212   </field>
 213   <field>
 214     <name>max_related</name>
 215     <title>Max Related Members for Type</title>
 216     <type>int</type>
 217     <comment>Maximum number of related memberships.</comment>
 218     <add>4.3</add>
 219     <html>
 220       <type>Text</type>
 221       <label>Max Related</label>
 222     </html>
 223   </field>
 224   <field>
 225     <name>visibility</name>
 226     <title>Visible</title>
 227     <type>varchar</type>
 228     <length>64</length>
 229     <add>1.5</add>
 230     <pseudoconstant>
 231       <callback>CRM_Core_SelectValues::memberVisibility</callback>
 232     </pseudoconstant>
 233     <html>
 234       <type>Select</type>
 235     </html>
 236   </field>
 237   <field>
 238     <name>weight</name>
 239     <title>Order</title>
 240     <type>int</type>
 241     <html>
 242       <type>Text</type>
 243     </html>
 244     <add>1.5</add>
 245   </field>
 246   <field>
 247     <name>receipt_text_signup</name>
 248     <title>Membership Type Receipt Text</title>
 249     <type>varchar</type>
 250     <html>
 251       <type>TextArea</type>
 252       <rows>6</rows>
 253       <cols>50</cols>
 254     </html>
 255     <length>255</length>
 256     <comment>Receipt Text for membership signup</comment>
 257     <add>2.0</add>
 258   </field>
 259   <field>
 260     <name>receipt_text_renewal</name>
 261     <title>Membership Type Renewal Text</title>
 262     <type>varchar</type>
 263     <html>
 264       <type>TextArea</type>
 265       <rows>6</rows>
 266       <cols>50</cols>
 267     </html>
 268     <length>255</length>
 269     <comment>Receipt Text for membership renewal</comment>
 270     <add>2.0</add>
 271   </field>
 272   <field>
 273     <name>auto_renew</name>
 274     <type>boolean</type>
 275     <default>0</default>
 276     <html>
 277       <type>Radio</type>
 278     </html>
 279     <pseudoconstant>
 280       <callback>CRM_Core_SelectValues::memberAutoRenew</callback>
 281     </pseudoconstant>
 282     <comment>0 = No auto-renew option; 1 = Give option, but not required; 2 = Auto-renew required;</comment>
 283     <add>3.3</add>
 284   </field>
 285   <field>
 286     <name>is_active</name>
 287     <title>Is Active</title>
 288     <type>boolean</type>
 289     <default>1</default>
 290     <comment>Is this membership_type enabled</comment>
 291     <add>1.5</add>
 292     <html>
 293       <type>CheckBox</type>
 294       <label>Enabled?</label>
 295     </html>
 296   </field>
 297 </table>