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     <type>int unsigned</type>
  13     <required>true</required>
  14     <comment>Membership Id</comment>
  15     <add>1.5</add>
  16   </field>
  17   <primaryKey>
  18     <name>id</name>
  19     <autoincrement>true</autoincrement>
  20   </primaryKey>
  21   <field>
  22     <name>domain_id</name>
  23     <type>int unsigned</type>
  24     <required>true</required>
  25     <comment>Which Domain is this match entry for</comment>
  26     <add>3.0</add>
  27   </field>
  28   <foreignKey>
  29     <name>domain_id</name>
  30     <table>civicrm_domain</table>
  31     <key>id</key>
  32     <add>3.0</add>
  33   </foreignKey>
  34   <field>
  35     <name>name</name>
  36     <uniqueName>membership_type</uniqueName>
  37     <title>Membership Type</title>
  38     <type>varchar</type>
  39     <import>true</import>
  40     <length>128</length>
  41     <localizable>true</localizable>
  42     <comment>Name of Membership Type</comment>
  43     <add>1.5</add>
  44   </field>
  45   <field>
  46     <name>description</name>
  47     <type>varchar</type>
  48     <htmlType>textarea</htmlType>
  49     <rows>6</rows>
  50     <cols>50</cols>
  51     <length>255</length>
  52     <localizable>true</localizable>
  53     <comment>Description of Membership Type</comment>
  54     <add>1.5</add>
  55   </field>
  56   <field>
  57     <name>member_of_contact_id</name>
  58     <type>int unsigned</type>
  59     <required>true</required>
  60     <comment>Owner organization for this membership type. FK to Contact ID</comment>
  61     <add>1.5</add>
  62   </field>
  63   <foreignKey>
  64     <name>member_of_contact_id</name>
  65     <table>civicrm_contact</table>
  66     <key>id</key>
  67     <add>1.5</add>
  68     <onDelete>RESTRICT</onDelete>
  69   </foreignKey>
  70   <field>
  71     <name>contribution_type_id</name>
  72     <type>int unsigned</type>
  73     <required>true</required>
  74     <comment>If membership is paid by a contribution - what contribution type should be used. FK to Contribution Type ID</comment>
  75     <add>1.5</add>
  76     <drop>4.3</drop>
  77   </field>
  78   <foreignKey>
  79     <name>contribution_type_id</name>
  80     <table>civicrm_contribution_type</table>
  81     <key>id</key>
  82     <add>1.5</add>
  83     <drop>4.3</drop>
  84   </foreignKey>
  85   <field>
  86     <name>financial_type_id</name>
  87     <type>int unsigned</type>
  88     <required>true</required>
  89     <comment>If membership is paid by a contribution - what financial type should be used. FK to civicrm_financial_type.id</comment>
  90     <add>4.3</add>
  91   </field>
  92   <foreignKey>
  93     <name>financial_type_id</name>
  94     <table>civicrm_financial_type</table>
  95     <key>id</key>
  96     <add>4.3</add>
  97   </foreignKey>
  98   <field>
  99     <name>minimum_fee</name>
 100     <type>decimal</type>
 101     <comment>Minimum fee for this membership (0 for free/complimentary memberships).</comment>
 102     <default>0</default>
 103     <add>1.5</add>
 104   </field>
 105   <field>
 106     <name>duration_unit</name>
 107     <type>enum</type>
 108     <values>day, month, year, lifetime</values>
 109     <comment>Unit in which membership period is expressed.</comment>
 110     <add>1.5</add>
 111   </field>
 112   <field>
 113     <name>duration_interval</name>
 114     <type>int</type>
 115     <comment>Number of duration units in membership period (e.g. 1 year, 12 months).</comment>
 116     <add>1.5</add>
 117   </field>
 118   <field>
 119     <name>period_type</name>
 120     <type>enum</type>
 121     <values>rolling, fixed</values>
 122     <comment>Rolling membership period starts on signup date. Fixed membership periods start on fixed_period_start_day.</comment>
 123     <add>1.5</add>
 124   </field>
 125   <field>
 126     <name>fixed_period_start_day</name>
 127     <type>int</type>
 128     <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>
 129     <add>1.5</add>
 130   </field>
 131   <field>
 132     <name>fixed_period_rollover_day</name>
 133     <type>int</type>
 134     <comment>For fixed period memberships, signups after this day (mmdd) rollover to next period.</comment>
 135     <add>1.5</add>
 136   </field>
 137   <field>
 138     <name>relationship_type_id</name>
 139     <type>varchar</type>
 140     <length>64</length>
 141     <comment>FK to Relationship Type ID</comment>
 142     <add>1.5</add>
 143   </field>
 144   <foreignKey>
 145     <name>relationship_type_id</name>
 146     <table>civicrm_relationship_type</table>
 147     <key>id</key>
 148     <add>1.5</add>
 149     <drop>3.3</drop>
 150   </foreignKey>
 151   <index>
 152     <name>index_relationship_type_id</name>
 153     <fieldName>relationship_type_id</fieldName>
 154     <add>3.3</add>
 155   </index>
 156   <field>
 157     <name>relationship_direction</name>
 158     <type>varchar</type>
 159     <length>128</length>
 160     <add>1.7</add>
 161   </field>
 162   <field>
 163     <name>max_related</name>
 164     <type>int</type>
 165     <comment>Maximum number of related memberships.</comment>
 166     <add>4.3</add>
 167   </field>
 168   <field>
 169     <name>visibility</name>
 170     <title>Visible</title>
 171     <type>varchar</type>
 172     <length>64</length>
 173     <add>1.5</add>
 174     <pseudoconstant>
 175       <optionGroupName>visibility</optionGroupName>
 176     </pseudoconstant>
 177   </field>
 178   <field>
 179     <name>weight</name>
 180     <title>Weight</title>
 181     <type>int</type>
 182     <add>1.5</add>
 183   </field>
 184   <field>
 185     <name>receipt_text_signup</name>
 186     <type>varchar</type>
 187     <htmlType>textarea</htmlType>
 188     <rows>6</rows>
 189     <cols>50</cols>
 190     <length>255</length>
 191     <comment>Receipt Text for membership signup</comment>
 192     <add>2.0</add>
 193   </field>
 194   <field>
 195     <name>receipt_text_renewal</name>
 196     <type>varchar</type>
 197     <htmlType>textarea</htmlType>
 198     <rows>6</rows>
 199     <cols>50</cols>
 200     <length>255</length>
 201     <comment>Receipt Text for membership renewal</comment>
 202     <add>2.0</add>
 203   </field>
 204   <field>
 205     <name>auto_renew</name>
 206     <type>boolean</type>
 207     <default>0</default>
 208     <comment>0 = No auto-renew option; 1 = Give option, but not required; 2 = Auto-renew required;</comment>
 209     <add>3.3</add>
 210   </field>
 211   <field>
 212     <name>is_active</name>
 213     <title>Is Active</title>
 214     <type>boolean</type>
 215     <default>1</default>
 216     <comment>Is this membership_type enabled</comment>
 217     <add>1.5</add>
 218   </field>
 219 </table>