crm.fsf.org/20131203/files/sites/all/modules-new/civicrm/xml/schema/Member/Membership.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2
   3 <table>
   4   <base>CRM/Member</base>
   5   <class>Membership</class>
   6   <name>civicrm_membership</name>
   7   <comment>Contact Membership records.</comment>
   8   <add>1.5</add>
   9   <log>true</log>
  10   <field>
  11     <name>id</name>
  12     <uniqueName>membership_id</uniqueName>
  13     <type>int unsigned</type>
  14     <required>true</required>
  15     <import>true</import>
  16     <title>Membership ID</title>
  17     <headerPattern>/^(m(embership\s)?id)$/i</headerPattern>
  18     <comment>Membership Id</comment>
  19     <add>1.5</add>
  20   </field>
  21   <primaryKey>
  22     <name>id</name>
  23     <autoincrement>true</autoincrement>
  24   </primaryKey>
  25
  26   <field>
  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>
  34     <import>true</import>
  35     <comment>FK to Contact ID</comment>
  36     <add>1.5</add>
  37     <html>
  38       <type>Autocomplete-Select</type>
  39     </html>
  40   </field>
  41   <foreignKey>
  42     <name>contact_id</name>
  43     <table>civicrm_contact</table>
  44     <key>id</key>
  45     <add>1.5</add>
  46     <onDelete>CASCADE</onDelete>
  47   </foreignKey>
  48   <field>
  49     <name>membership_type_id</name>
  50     <type>int unsigned</type>
  51     <title>Membership Type Id</title>
  52     <import>true</import>
  53     <headerPattern>/^(m(embership\s)?type)$/i</headerPattern>
  54     <export>false</export>
  55     <required>true</required>
  56     <comment>FK to Membership Type</comment>
  57     <pseudoconstant>
  58       <table>civicrm_membership_type</table>
  59       <keyColumn>id</keyColumn>
  60       <labelColumn>name</labelColumn>
  61     </pseudoconstant>
  62     <html>
  63       <type>Select</type>
  64     </html>
  65     <add>1.5</add>
  66   </field>
  67   <foreignKey>
  68     <name>membership_type_id</name>
  69     <table>civicrm_membership_type</table>
  70     <key>id</key>
  71     <add>1.5</add>
  72     <onDelete>CASCADE</onDelete>
  73   </foreignKey>
  74   <field>
  75     <name>join_date</name>
  76     <title>Member Since</title>
  77     <type>date</type>
  78     <import>true</import>
  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>
  82     <add>1.5</add>
  83     <html>
  84       <type>Select Date</type>
  85     </html>
  86   </field>
  87   <field>
  88     <name>start_date</name>
  89     <uniqueName>membership_start_date</uniqueName>
  90     <title>Membership Start Date</title>
  91     <type>date</type>
  92     <import>true</import>
  93     <headerPattern>/(member(ship)?.)?start(s)?(.date$)?/i</headerPattern>
  94     <dataPattern>/\d{4}-?\d{2}-?\d{2}/</dataPattern>
  95     <comment>Beginning of current uninterrupted membership period.</comment>
  96     <add>1.5</add>
  97     <html>
  98       <type>Select Date</type>
  99     </html>
 100   </field>
 101   <field>
 102     <name>end_date</name>
 103     <uniqueName>membership_end_date</uniqueName>
 104     <title>Membership Expiration Date</title>
 105     <type>date</type>
 106     <import>true</import>
 107     <headerPattern>/(member(ship)?.)?end(s)?(.date$)?/i</headerPattern>
 108     <dataPattern>/\d{4}-?\d{2}-?\d{2}/</dataPattern>
 109     <comment>Current membership period expire date.</comment>
 110     <add>1.5</add>
 111     <html>
 112       <type>Select Date</type>
 113     </html>
 114   </field>
 115   <field>
 116     <name>source</name>
 117     <uniqueName>membership_source</uniqueName>
 118     <title>Source</title>
 119     <import>true</import>
 120     <headerPattern>/^(member(ship?))?source$/i</headerPattern>
 121     <type>varchar</type>
 122     <length>128</length>
 123     <add>1.5</add>
 124     <html>
 125       <type>Text</type>
 126     </html>
 127   </field>
 128   <field>
 129     <name>status_id</name>
 130     <title>Membership Status Id</title>
 131     <import>true</import>
 132     <headerPattern>/(member(ship|).)?(status)$/i</headerPattern>
 133     <type>int unsigned</type>
 134     <export>false</export>
 135     <required>true</required>
 136     <comment>FK to Membership Status</comment>
 137     <pseudoconstant>
 138       <table>civicrm_membership_status</table>
 139       <keyColumn>id</keyColumn>
 140       <labelColumn>label</labelColumn>
 141     </pseudoconstant>
 142     <html>
 143       <type>Select</type>
 144     </html>
 145     <add>1.5</add>
 146   </field>
 147   <foreignKey>
 148     <name>status_id</name>
 149     <table>civicrm_membership_status</table>
 150     <key>id</key>
 151     <add>1.5</add>
 152     <onDelete>CASCADE</onDelete>
 153   </foreignKey>
 154   <field>
 155     <name>is_override</name>
 156     <title>Status Override</title>
 157     <import>true</import>
 158     <headerPattern>/override$/i</headerPattern>
 159     <type>boolean</type>
 160     <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>
 161     <html>
 162       <type>CheckBox</type>
 163     </html>
 164     <add>1.5</add>
 165   </field>
 166   <field>
 167     <name>owner_membership_id</name>
 168     <type>int unsigned</type>
 169     <title>Primary Member ID</title>
 170     <comment>Optional FK to Parent Membership.</comment>
 171     <export>true</export>
 172     <add>1.7</add>
 173   </field>
 174   <foreignKey>
 175     <name>owner_membership_id</name>
 176     <table>civicrm_membership</table>
 177     <key>id</key>
 178     <add>1.7</add>
 179     <onDelete>SET NULL</onDelete>
 180   </foreignKey>
 181   <index>
 182     <name>index_owner_membership_id</name>
 183     <fieldName>owner_membership_id</fieldName>
 184     <add>1.7</add>
 185   </index>
 186   <field>
 187     <name>max_related</name>
 188     <type>int</type>
 189     <comment>Maximum number of related memberships (membership_type override).</comment>
 190     <add>4.3</add>
 191     <html>
 192       <type>Text</type>
 193     </html>
 194   </field>
 195   <field>
 196     <name>is_test</name>
 197     <title>Test</title>
 198     <uniqueName>member_is_test</uniqueName>
 199     <type>boolean</type>
 200     <default>0</default>
 201     <import>true</import>
 202     <headerPattern>/(is.)?test(.member(ship)?)?/i</headerPattern>
 203     <html>
 204       <type>CheckBox</type>
 205     </html>
 206   </field>
 207   <field>
 208     <name>is_pay_later</name>
 209     <uniqueName>member_is_pay_later</uniqueName>
 210     <title>Is Pay Later</title>
 211     <type>boolean</type>
 212     <default>0</default>
 213     <import>true</import>
 214     <headerPattern>/(is.)?(pay(.)?later)$/i</headerPattern>
 215     <add>2.1</add>
 216     <html>
 217       <type>CheckBox</type>
 218     </html>
 219   </field>
 220   <field>
 221     <name>contribution_recur_id</name>
 222     <title>Memberhip Recurring Contribution</title>
 223     <type>int unsigned</type>
 224     <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>
 225     <add>3.3</add>
 226   </field>
 227   <foreignKey>
 228     <name>contribution_recur_id</name>
 229     <table>civicrm_contribution_recur</table>
 230     <key>id</key>
 231     <add>3.3</add>
 232     <onDelete>SET NULL</onDelete>
 233   </foreignKey>
 234   <field>
 235     <name>campaign_id</name>
 236     <uniqueName>member_campaign_id</uniqueName>
 237     <type>int unsigned</type>
 238     <title>Campaign</title>
 239     <import>true</import>
 240     <comment>The campaign for which this membership is attached.</comment>
 241     <pseudoconstant>
 242       <table>civicrm_campaign</table>
 243       <keyColumn>id</keyColumn>
 244       <labelColumn>title</labelColumn>
 245     </pseudoconstant>
 246     <add>3.4</add>
 247     <html>
 248       <type>Select</type>
 249     </html>
 250   </field>
 251   <foreignKey>
 252     <name>campaign_id</name>
 253     <table>civicrm_campaign</table>
 254     <key>id</key>
 255     <onDelete>SET NULL</onDelete>
 256   </foreignKey>
 257 </table>