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     <title>Profile Field 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.1</add>
  20   </field>
  21   <primaryKey>
  22     <name>id</name>
  23     <autoincrement>true</autoincrement>
  24   </primaryKey>
  25   <field>
  26     <name>uf_group_id</name>
  27     <title>Profile ID</title>
  28     <type>int unsigned</type>
  29     <required>true</required>
  30     <comment>Which form does this field belong to.</comment>
  31     <add>1.1</add>
  32     <pseudoconstant>
  33       <table>civicrm_uf_group</table>
  34       <keyColumn>id</keyColumn>
  35       <labelColumn>title</labelColumn>
  36     </pseudoconstant>
  37     <html>
  38       <type>Select</type>
  39       <label>Profile</label>
  40     </html>
  41   </field>
  42   <foreignKey>
  43     <name>uf_group_id</name>
  44     <table>civicrm_uf_group</table>
  45     <key>id</key>
  46     <add>1.1</add>
  47     <onDelete>CASCADE</onDelete>
  48   </foreignKey>
  49   <field>
  50     <name>field_name</name>
  51     <title>Profile Field Name</title>
  52     <type>varchar</type>
  53     <length>64</length>
  54     <required>true</required>
  55     <comment>Name for CiviCRM field which is being exposed for sharing.</comment>
  56     <pseudoconstant>
  57       <callback>CRM_Core_BAO_UFField::getAvailableFieldTitles</callback>
  58     </pseudoconstant>
  59     <add>1.1</add>
  60   </field>
  61   <field>
  62     <name>is_active</name>
  63     <title>Profile Field Is Active</title>
  64     <type>boolean</type>
  65     <default>1</default>
  66     <comment>Is this field currently shareable? If false, hide the field for all sharing contexts.</comment>
  67     <add>1.1</add>
  68   </field>
  69   <field>
  70     <name>is_view</name>
  71     <title>Profile Is View Only</title>
  72     <type>boolean</type>
  73     <default>0</default>
  74     <comment>the field is view only and not editable in user forms.</comment>
  75     <add>1.1</add>
  76   </field>
  77   <field>
  78     <name>is_required</name>
  79     <title>Profile Field Is Required</title>
  80     <type>boolean</type>
  81     <default>0</default>
  82     <comment>Is this field required when included in a user or registration form?</comment>
  83     <add>1.1</add>
  84   </field>
  85   <field>
  86     <name>weight</name>
  87     <title>Order</title>
  88     <type>int</type>
  89     <required>true</required>
  90     <default>1</default>
  91     <comment>Controls field display order when user framework fields are displayed in registration and account editing forms.</comment>
  92     <add>1.1</add>
  93   </field>
  94   <field>
  95     <name>help_post</name>
  96     <title>Profile Field Post Help</title>
  97     <type>text</type>
  98     <localizable>true</localizable>
  99     <comment>Description and/or help text to display after this field.</comment>
 100     <add>1.1</add>
 101   </field>
 102   <field>
 103     <name>help_pre</name>
 104     <title>Profile Field Pre Help</title>
 105     <type>text</type>
 106     <localizable>true</localizable>
 107     <comment>Description and/or help text to display before this field.</comment>
 108     <add>3.2</add>
 109   </field>
 110   <field>
 111     <name>visibility</name>
 112     <title>Profile Field Visibility</title>
 113     <type>varchar</type>
 114     <length>32</length>
 115     <default>'User and User Admin Only'</default>
 116     <comment>In what context(s) is this field visible.</comment>
 117     <pseudoconstant>
 118       <callback>CRM_Core_SelectValues::ufVisibility</callback>
 119     </pseudoconstant>
 120     <add>1.1</add>
 121     <html>
 122       <type>Select</type>
 123     </html>
 124   </field>
 125   <field>
 126     <name>in_selector</name>
 127     <title>Profile Field Is a Filter</title>
 128     <type>boolean</type>
 129     <default>0</default>
 130     <comment>Is this field included as a column in the selector table?</comment>
 131     <add>1.2</add>
 132   </field>
 133   <field>
 134     <name>is_searchable</name>
 135     <title>Profile Field Is Searchable</title>
 136     <type>boolean</type>
 137     <default>0</default>
 138     <comment>Is this field included search form of profile?</comment>
 139     <add>1.4</add>
 140   </field>
 141   <field>
 142     <name>location_type_id</name>
 143     <title>Location Type ID</title>
 144     <type>int unsigned</type>
 145     <comment>Location type of this mapping, if required</comment>
 146     <html>
 147       <label>Location Type</label>
 148     </html>
 149     <add>1.3</add>
 150   </field>
 151   <foreignKey>
 152     <name>location_type_id</name>
 153     <table>civicrm_location_type</table>
 154     <key>id</key>
 155     <add>1.3</add>
 156     <onDelete>SET NULL</onDelete>
 157   </foreignKey>
 158   <field>
 159     <name>phone_type_id</name>
 160     <title>Profile Field Phone Type</title>
 161     <type>int unsigned</type>
 162     <comment>Phone Type ID, if required</comment>
 163     <add>2.2</add>
 164     <pseudoconstant>
 165       <optionGroupName>phone_type</optionGroupName>
 166     </pseudoconstant>
 167   </field>
 168   <field>
 169     <name>website_type_id</name>
 170     <title>Profile Field Website Type</title>
 171     <type>int unsigned</type>
 172     <comment>Website Type ID, if required</comment>
 173     <add>4.5</add>
 174     <pseudoconstant>
 175       <optionGroupName>website_type</optionGroupName>
 176     </pseudoconstant>
 177   </field>
 178   <field>
 179     <name>label</name>
 180     <title>Profile Field Label</title>
 181     <type>varchar</type>
 182     <length>255</length>
 183     <required>true</required>
 184     <localizable>true</localizable>
 185     <comment>To save label for fields.</comment>
 186     <add>1.4</add>
 187   </field>
 188   <field>
 189     <name>field_type</name>
 190     <title>Profile Field Type</title>
 191     <type>varchar</type>
 192     <length>255</length>
 193     <comment>This field saves field type (ie individual,household.. field etc).</comment>
 194     <add>1.4</add>
 195   </field>
 196   <field>
 197     <name>is_reserved</name>
 198     <title>Profile Field Is Reserved</title>
 199     <type>boolean</type>
 200     <comment>Is this field reserved for use by some other CiviCRM functionality?</comment>
 201     <add>3.0</add>
 202   </field>
 203   <field>
 204     <name>is_multi_summary</name>
 205     <title>Profile Field Supports Multiple</title>
 206     <type>boolean</type>
 207     <default>0</default>
 208     <comment>Include in multi-record listing?</comment>
 209     <add>4.3</add>
 210   </field>
 211   <index>
 212     <name>IX_website_type_id</name>
 213     <title>Profile Field Website Type</title>
 214     <fieldName>website_type_id</fieldName>
 215     <add>4.5</add>
 216   </index>
 217 </table>