[civicrm-core.git] / xml / schema / Core / UFJoin.xml

<?xml version="1.0" encoding="iso-8859-1" ?>

<table>
  <base>CRM/Core</base>
  <class>UFJoin</class>
  <name>civicrm_uf_join</name>
  <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>
  <add>1.3</add>
  <log>true</log>
  <field>
    <name>id</name>
    <title>UF Join ID</title>
    <type>int unsigned</type>
    <required>true</required>
    <comment>Unique table ID</comment>
    <html>
      <type>Number</type>
    </html>
    <add>1.3</add>
  </field>
  <primaryKey>
    <name>id</name>
    <autoincrement>true</autoincrement>
  </primaryKey>
  <field>
    <name>is_active</name>
    <title>Profile Use is active</title>
    <type>boolean</type>
    <default>1</default>
    <comment>Is this join currently active?</comment>
    <add>1.3</add>
  </field>
  <field>
    <name>module</name>
    <title>Profile Module</title>
    <type>varchar</type>
    <length>64</length>
    <required>true</required>
    <comment>Module which owns this uf_join instance, e.g. User Registration, CiviDonate, etc.</comment>
    <add>1.3</add>
  </field>
  <field>
    <name>entity_table</name>
    <title>Profile Entity Table</title>
    <type>varchar</type>
    <length>64</length>
    <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>
    <pseudoconstant>
      <callback>CRM_Core_BAO_UFJoin::entityTables</callback>
    </pseudoconstant>
    <add>1.3</add>
  </field>
  <field>
    <name>entity_id</name>
    <title>Profile Entity ID</title>
    <type>int unsigned</type>
    <comment>Foreign key to the referenced item.</comment>
    <add>1.3</add>
  </field>
  <dynamicForeignKey>
    <idColumn>entity_id</idColumn>
    <typeColumn>entity_table</typeColumn>
    <add>1.3</add>
  </dynamicForeignKey>
  <index>
    <name>index_entity</name>
    <fieldName>entity_table</fieldName>
    <fieldName>entity_id</fieldName>
    <add>1.3</add>
  </index>
  <field>
    <name>weight</name>
    <title>Order</title>
    <type>int</type>
    <required>true</required>
    <default>1</default>
    <comment>Controls display order when multiple user framework groups are setup for concurrent display.</comment>
    <add>1.3</add>
  </field>
  <field>
    <name>uf_group_id</name>
    <title>Profile ID</title>
    <type>int unsigned</type>
    <required>true</required>
    <comment>Which form does this field belong to.</comment>
    <add>1.3</add>
    <pseudoconstant>
      <table>civicrm_uf_group</table>
      <keyColumn>id</keyColumn>
      <labelColumn>title</labelColumn>
    </pseudoconstant>
    <html>
      <type>Select</type>
      <label>Profile</label>
    </html>
  </field>
  <foreignKey>
    <name>uf_group_id</name>
    <table>civicrm_uf_group</table>
    <key>id</key>
    <add>1.3</add>
  </foreignKey>
  <field>
    <name>module_data</name>
    <title>Profile Use Data</title>
    <type>longtext</type>
    <comment>Json serialized array of data used by the ufjoin.module</comment>
    <serialize>JSON</serialize>
    <add>4.5</add>
  </field>
</table>
Commit	Line	Data
6a488035 TO	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>
8f069c03 EM	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>
0481e12c A	16	<html>
	17	<type>Number</type>
	18	</html>
8f069c03	19	<add>1.3</add>
6a488035 TO	20	</field>
6a488035 TO	21	<primaryKey>
8f069c03 EM	22	<name>id</name>
8f069c03 EM	23	<autoincrement>true</autoincrement>
6a488035 TO	24	</primaryKey>
6a488035 TO	25	<field>
8f069c03 EM	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>
6a488035	32	</field>
3c7d2158	33	<field>
8f069c03 EM	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>
3c7d2158	41	</field>
3c7d2158	42	<field>
8f069c03 EM	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>
27307972 SL	48	<pseudoconstant>
	49	<callback>CRM_Core_BAO_UFJoin::entityTables</callback>
	50	</pseudoconstant>
8f069c03	51	<add>1.3</add>
3c7d2158	52	</field>
3c7d2158	53	<field>
8f069c03 EM	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>
6a488035	59	</field>
71e5aa5c	60	<dynamicForeignKey>
8f069c03 EM	61	<idColumn>entity_id</idColumn>
	62	<typeColumn>entity_table</typeColumn>
	63	<add>1.3</add>
71e5aa5c	64	</dynamicForeignKey>
3c7d2158	65	<index>
8f069c03	66	<name>index_entity</name>
8f069c03 EM	67	<fieldName>entity_table</fieldName>
	68	<fieldName>entity_id</fieldName>
	69	<add>1.3</add>
6a488035 TO	70	</index>
6a488035 TO	71	<field>
8f069c03	72	<name>weight</name>
7ecddde4	73	<title>Order</title>
8f069c03 EM	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>
6a488035	79	</field>
3c7d2158	80	<field>
8f069c03 EM	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>
57e94608	94	<label>Profile</label>
8f069c03	95	</html>
3c7d2158	96	</field>
3c7d2158	97	<foreignKey>
8f069c03 EM	98	<name>uf_group_id</name>
	99	<table>civicrm_uf_group</table>
	100	<key>id</key>
	101	<add>1.3</add>
3c7d2158	102	</foreignKey>
133e2c99	103	<field>
8f069c03 EM	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>
2a5c9b4d	108	<serialize>JSON</serialize>
8f069c03	109	<add>4.5</add>
133e2c99	110	</field>
6a488035	111	</table>