xml/schema/Core/UFJoin.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2
   3 <table>
   4   <base>CRM/Core</base>
   5   <class>UFJoin</class>
   6   <name>civicrm_uf_join</name>
   7   <comment>User framework join table. This links various internal civicrm object with a profile. Initial use cases are the donation object and the user module</comment>
   8   <add>1.3</add>
   9   <log>true</log>
  10   <field>
  11       <name>id</name>
  12       <type>int unsigned</type>
  13       <required>true</required>
  14       <comment>Unique table ID</comment>
  15       <add>1.3</add>
  16   </field>
  17   <primaryKey>
  18        <name>id</name>
  19        <autoincrement>true</autoincrement>
  20   </primaryKey>
  21   <field>
  22        <name>is_active</name>
  23        <type>boolean</type>
  24         <default>1</default>
  25        <comment>Is this join currently active?</comment>
  26        <add>1.3</add>
  27   </field>
  28   <field>
  29        <name>module</name>
  30        <type>varchar</type>
  31        <length>64</length>
  32        <required>true</required>
  33        <comment>Module which owns this uf_join instance, e.g. User Registration, CiviDonate, etc.</comment>
  34        <add>1.3</add>
  35   </field>
  36   <field>
  37        <name>entity_table</name>
  38        <type>varchar</type>
  39        <length>64</length>
  40        <comment>Name of table where item being referenced is stored. Modules which only need a single collection of uf_join instances may choose not to populate entity_table and entity_id.</comment>
  41        <add>1.3</add>
  42   </field>
  43   <field>
  44        <name>entity_id</name>
  45        <type>int unsigned</type>
  46        <comment>Foreign key to the referenced item.</comment>
  47        <add>1.3</add>
  48   </field>
  49   <dynamicForeignKey>
  50        <idColumn>entity_id</idColumn>
  51        <typeColumn>entity_table</typeColumn>
  52        <add>1.3</add>
  53   </dynamicForeignKey>
  54   <index>
  55        <name>index_entity</name>
  56        <add>1.3</add>
  57        <fieldName>entity_table</fieldName>
  58        <fieldName>entity_id</fieldName>
  59        <add>1.3</add>
  60   </index>
  61   <field>
  62       <name>weight</name>
  63       <type>int</type>
  64       <required>true</required>
  65       <default>1</default>
  66       <comment>Controls display order when multiple user framework groups are setup for concurrent display.</comment>
  67       <add>1.3</add>
  68   </field>
  69   <field>
  70       <name>uf_group_id</name>
  71       <type>int unsigned</type>
  72       <required>true</required>
  73       <comment>Which form does this field belong to.</comment>
  74       <add>1.3</add>
  75       <pseudoconstant>
  76         <table>civicrm_uf_group</table>
  77         <keyColumn>id</keyColumn>
  78         <labelColumn>title</labelColumn>
  79       </pseudoconstant>
  80       <html>
  81         <type>Select</type>
  82       </html>
  83   </field>
  84   <foreignKey>
  85        <name>uf_group_id</name>
  86        <table>civicrm_uf_group</table>
  87        <key>id</key>
  88        <add>1.3</add>
  89   </foreignKey>
  90   <field>
  91        <name>module_data</name>
  92        <type>varchar</type>
  93        <length>255</length>
  94        <comment>Json serialized array of data used by the ufjoin.module</comment>
  95        <add>4.5</add>
  96   </field>
  97 </table>