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