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