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     <title>UF Join ID</title>
  13     <type>int unsigned</type>
  14     <required>true</required>
  15     <comment>Unique table ID</comment>
  16     <html>
  17       <type>Number</type>
  18     </html>
  19     <add>1.3</add>
  20   </field>
  21   <primaryKey>
  22     <name>id</name>
  23     <autoincrement>true</autoincrement>
  24   </primaryKey>
  25   <field>
  26     <name>is_active</name>
  27     <title>Profile Use is active</title>
  28     <type>boolean</type>
  29     <default>1</default>
  30     <comment>Is this join currently active?</comment>
  31     <add>1.3</add>
  32   </field>
  33   <field>
  34     <name>module</name>
  35     <title>Profile Module</title>
  36     <type>varchar</type>
  37     <length>64</length>
  38     <required>true</required>
  39     <comment>Module which owns this uf_join instance, e.g. User Registration, CiviDonate, etc.</comment>
  40     <add>1.3</add>
  41   </field>
  42   <field>
  43     <name>entity_table</name>
  44     <title>Profile Entity Table</title>
  45     <type>varchar</type>
  46     <length>64</length>
  47     <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>
  48     <pseudoconstant>
  49       <callback>CRM_Core_BAO_UFJoin::entityTables</callback>
  50     </pseudoconstant>
  51     <add>1.3</add>
  52   </field>
  53   <field>
  54     <name>entity_id</name>
  55     <title>Profile Entity ID</title>
  56     <type>int unsigned</type>
  57     <comment>Foreign key to the referenced item.</comment>
  58     <add>1.3</add>
  59   </field>
  60   <dynamicForeignKey>
  61     <idColumn>entity_id</idColumn>
  62     <typeColumn>entity_table</typeColumn>
  63     <add>1.3</add>
  64   </dynamicForeignKey>
  65   <index>
  66     <name>index_entity</name>
  67     <fieldName>entity_table</fieldName>
  68     <fieldName>entity_id</fieldName>
  69     <add>1.3</add>
  70   </index>
  71   <field>
  72     <name>weight</name>
  73     <title>Order</title>
  74     <type>int</type>
  75     <required>true</required>
  76     <default>1</default>
  77     <comment>Controls display order when multiple user framework groups are setup for concurrent display.</comment>
  78     <add>1.3</add>
  79   </field>
  80   <field>
  81     <name>uf_group_id</name>
  82     <title>Profile ID</title>
  83     <type>int unsigned</type>
  84     <required>true</required>
  85     <comment>Which form does this field belong to.</comment>
  86     <add>1.3</add>
  87     <pseudoconstant>
  88       <table>civicrm_uf_group</table>
  89       <keyColumn>id</keyColumn>
  90       <labelColumn>title</labelColumn>
  91     </pseudoconstant>
  92     <html>
  93       <type>Select</type>
  94       <label>Profile</label>
  95     </html>
  96   </field>
  97   <foreignKey>
  98     <name>uf_group_id</name>
  99     <table>civicrm_uf_group</table>
 100     <key>id</key>
 101     <add>1.3</add>
 102   </foreignKey>
 103   <field>
 104     <name>module_data</name>
 105     <title>Profile Use Data</title>
 106     <type>longtext</type>
 107     <comment>Json serialized array of data used by the ufjoin.module</comment>
 108     <serialize>JSON</serialize>
 109     <add>4.5</add>
 110   </field>
 111 </table>