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