xml/schema/Core/UFField.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2
   3 <table>
   4   <base>CRM/Core</base>
   5   <class>UFField</class>
   6   <name>civicrm_uf_field</name>
   7   <comment>User Framework fields and their properties.</comment>
   8   <add>1.1</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.1</add>
  16   </field>
  17   <primaryKey>
  18        <name>id</name>
  19        <autoincrement>true</autoincrement>
  20   </primaryKey>
  21   <field>
  22       <name>uf_group_id</name>
  23       <type>int unsigned</type>
  24       <required>true</required>
  25       <comment>Which form does this field belong to.</comment>
  26       <add>1.1</add>
  27       <pseudoconstant>
  28         <table>civicrm_uf_group</table>
  29         <keyColumn>id</keyColumn>
  30         <labelColumn>title</labelColumn>
  31       </pseudoconstant>
  32       <html>
  33         <type>Select</type>
  34       </html>
  35   </field>
  36   <foreignKey>
  37        <name>uf_group_id</name>
  38        <table>civicrm_uf_group</table>
  39        <key>id</key>
  40        <add>1.1</add>
  41        <onDelete>CASCADE</onDelete>
  42   </foreignKey>
  43   <field>
  44        <name>field_name</name>
  45        <type>varchar</type>
  46        <length>64</length>
  47        <required>true</required>
  48        <comment>Name for CiviCRM field which is being exposed for sharing.</comment>
  49        <add>1.1</add>
  50   </field>
  51   <field>
  52        <name>is_active</name>
  53        <type>boolean</type>
  54        <default>1</default>
  55        <comment>Is this field currently shareable? If false, hide the field for all sharing contexts.</comment>
  56        <add>1.1</add>
  57   </field>
  58   <field>
  59        <name>is_view</name>
  60        <type>boolean</type>
  61        <default>0</default>
  62        <comment>the field is view only and not editable in user forms.</comment>
  63        <add>1.1</add>
  64   </field>
  65   <field>
  66        <name>is_required</name>
  67        <type>boolean</type>
  68         <default>0</default>
  69        <comment>Is this field required when included in a user or registration form?</comment>
  70        <add>1.1</add>
  71   </field>
  72   <field>
  73       <name>weight</name>
  74       <type>int</type>
  75       <required>true</required>
  76       <default>1</default>
  77       <comment>Controls field display order when user framework fields are displayed in registration and account editing forms.</comment>
  78       <add>1.1</add>
  79   </field>
  80   <field>
  81      <name>help_post</name>
  82      <type>text</type>
  83      <localizable>true</localizable>
  84      <comment>Description and/or help text to display after this field.</comment>
  85      <add>1.1</add>
  86   </field>
  87   <field>
  88      <name>help_pre</name>
  89      <type>text</type>
  90      <localizable>true</localizable>
  91      <comment>Description and/or help text to display before this field.</comment>
  92      <add>3.2</add>
  93   </field>
  94   <field>
  95        <name>is_registration</name>
  96        <type>boolean</type>
  97        <default>0</default>
  98        <comment>Is this field included in new user registration forms?</comment>
  99        <add>1.1</add>
 100        <drop>1.3</drop>
 101   </field>
 102   <field>
 103        <name>is_match</name>
 104        <type>boolean</type>
 105        <default>0</default>
 106        <comment>Is this field part of the key for matching users to contacts?</comment>
 107        <add>1.1</add>
 108        <drop>1.3</drop>
 109   </field>
 110   <field>
 111        <name>visibility</name>
 112        <type>enum</type>
 113        <values>User and User Admin Only,Public Pages,Public Pages and Listings</values>
 114        <default>'User and User Admin Only'</default>
 115        <comment>In what context(s) is this field visible.</comment>
 116        <add>1.1</add>
 117        <html>
 118          <type>Select</type>
 119        </html>
 120   </field>
 121   <field>
 122        <name>listings_title</name>
 123        <type>varchar</type>
 124        <length>64</length>
 125        <comment>Page title for listings page (users who share a common value for this property).</comment>
 126        <add>1.1</add>
 127        <drop>1.2</drop>
 128   </field>
 129   <field>
 130        <name>in_selector</name>
 131        <type>boolean</type>
 132        <default>0</default>
 133        <comment>Is this field included as a column in the selector table?</comment>
 134        <add>1.2</add>
 135   </field>
 136   <field>
 137        <name>is_searchable</name>
 138        <type>boolean</type>
 139        <default>0</default>
 140        <comment>Is this field included search form of profile?</comment>
 141        <add>1.4</add>
 142   </field>
 143   <field>
 144        <name>location_type_id</name>
 145        <type>int unsigned</type>
 146        <comment>Location type of this mapping, if required</comment>
 147       <add>1.3</add>
 148   </field>
 149   <foreignKey>
 150        <name>location_type_id</name>
 151        <table>civicrm_location_type</table>
 152        <key>id</key>
 153        <add>1.3</add>
 154        <onDelete>SET NULL</onDelete>
 155   </foreignKey>
 156   <field>
 157        <name>phone_type</name>
 158        <type>varchar</type>
 159        <length>64</length>
 160        <comment>Phone type, if required</comment>
 161        <add>1.3</add>
 162        <drop>2.2</drop>
 163   </field>
 164   <field>
 165        <name>phone_type_id</name>
 166        <type>int unsigned</type>
 167        <comment>Phone Type Id, if required</comment>
 168        <add>2.2</add>
 169   </field>
 170   <field>
 171        <name>label</name>
 172        <type>varchar</type>
 173        <length>255</length>
 174        <required>true</required>
 175        <localizable>true</localizable>
 176        <comment>To save label for fields.</comment>
 177       <add>1.4</add>
 178   </field>
 179   <field>
 180        <name>field_type</name>
 181        <type>varchar</type>
 182        <length>255</length>
 183        <comment>This field saves field type (ie individual,household.. field etc).</comment>
 184       <add>1.4</add>
 185   </field>
 186   <field>
 187     <name>is_reserved</name>
 188     <type>boolean</type>
 189     <comment>Is this field reserved for use by some other CiviCRM functionality?</comment>
 190     <add>3.0</add>
 191   </field>
 192   <field>
 193     <name>is_multi_summary</name>
 194     <type>boolean</type>
 195     <default>0</default>
 196     <comment>Include in multi-record listing?</comment>
 197     <add>4.3</add>
 198   </field>
 199 </table>