1 <?xml version=
"1.0" encoding=
"iso-8859-1" ?>
5 <class>CustomField
</class>
6 <name>civicrm_custom_field
</name>
7 <comment>Stores info about an extended (custom) property (data and form field info).
</comment>
12 <type>int unsigned
</type>
13 <title>Custom Field ID
</title>
14 <required>true
</required>
15 <comment>Unique Custom Field ID
</comment>
20 <autoincrement>true
</autoincrement>
23 <name>custom_group_id
</name>
24 <type>int unsigned
</type>
25 <title>Custom Group
</title>
26 <required>true
</required>
27 <comment>FK to civicrm_custom_group.
</comment>
30 <table>civicrm_custom_group
</table>
31 <keyColumn>id
</keyColumn>
32 <labelColumn>title
</labelColumn>
39 <name>custom_group_id
</name>
40 <table>civicrm_custom_group
</table>
43 <onDelete>CASCADE
</onDelete>
48 <title>Custom Field Name
</title>
50 <comment>Variable name/programmatic handle for this group.
</comment>
56 <title>Custom Field Label
</title>
58 <required>true
</required>
59 <localizable>true
</localizable>
60 <comment>Text for form field label (also friendly name for administering this custom property).
</comment>
64 <name>data_type
</name>
66 <title>Custom Field Data Type
</title>
68 <required>true
</required>
69 <comment>Controls location of data storage in extended_data table.
</comment>
71 <callback>CRM_Core_BAO_CustomField::dataType
</callback>
79 <name>html_type
</name>
81 <title>Custom Field HTML Type
</title>
83 <required>true
</required>
84 <comment>HTML types plus several built-in extended types.
</comment>
86 <callback>CRM_Core_SelectValues::customHtmlType
</callback>
91 <name>default_value
</name>
93 <title>Custom Field Default
</title>
95 <comment>Use form_options.is_default for field_types which use options.
</comment>
99 <name>is_required
</name>
100 <title>Custom Field Is Required?
</title>
102 <comment>Is a value required for this property.
</comment>
107 <name>is_searchable
</name>
108 <title>Allow Searching on Field?
</title>
110 <comment>Is this property searchable.
</comment>
115 <name>is_search_range
</name>
117 <title>Search as a Range
</title>
118 <comment>Is this property range searchable.
</comment>
126 <required>true
</required>
128 <comment>Controls field display order within an extended property group.
</comment>
132 <name>help_pre
</name>
134 <title>Custom Field Pre Text
</title>
135 <localizable>true
</localizable>
136 <comment>Description and/or help text to display before this field.
</comment>
140 <name>help_post
</name>
142 <title>Custom Field Post Text
</title>
143 <localizable>true
</localizable>
144 <comment>Description and/or help text to display after this field.
</comment>
150 <title>Custom Field Formatting
</title>
152 <comment>Optional format instructions for specific field types, like date types.
</comment>
156 <name>attributes
</name>
158 <title>Custom Field Attributes
</title>
160 <comment>Store collection of type-appropriate attributes, e.g. textarea needs rows/cols attributes
</comment>
164 <name>javascript
</name>
166 <title>Custom Field Javascript
</title>
168 <comment>Optional scripting attributes for field.
</comment>
172 <name>is_active
</name>
174 <title>Custom Field Is Active?
</title>
175 <comment>Is this property active?
</comment>
182 <title>Field is Viewable
</title>
184 <comment>Is this property set by PHP Code? A code field is viewable but not editable
</comment>
188 <name>options_per_line
</name>
189 <type>int unsigned
</type>
190 <title>Field Options Per Line
</title>
191 <comment>number of options per line for checkbox and radio
</comment>
194 <name>text_length
</name>
195 <type>int unsigned
</type>
196 <title>Field Length
</title>
197 <comment>field length if alphanumeric
</comment>
201 <name>start_date_years
</name>
203 <title>Field Start Date
</title>
204 <comment>Date may be up to start_date_years years prior to the current date.
</comment>
208 <name>end_date_years
</name>
210 <title>Field End Date
</title>
211 <comment>Date may be up to end_date_years years after the current date.
</comment>
215 <name>date_parts
</name>
218 <comment>which date part included in display
</comment>
223 <name>date_format
</name>
225 <title>Field Data Format
</title>
227 <comment>date format for custom date
</comment>
230 <callback>CRM_Core_SelectValues::getDatePluginInputFormats
</callback>
234 <name>time_format
</name>
235 <type>int unsigned
</type>
236 <title>Field Time Format
</title>
237 <comment>time format for custom date
</comment>
240 <callback>CRM_Core_SelectValues::getTimeFormats
</callback>
244 <name>note_columns
</name>
245 <type>int unsigned
</type>
246 <title>Field Note Columns
</title>
247 <comment>Number of columns in Note Field
</comment>
251 <name>note_rows
</name>
252 <type>int unsigned
</type>
253 <title>Field Note Rows
</title>
254 <comment>Number of rows in Note Field
</comment>
258 <name>column_name
</name>
260 <title>Field Column Name
</title>
262 <comment>Name of the column that holds the values for this field.
</comment>
266 <name>option_group_id
</name>
267 <type>int unsigned
</type>
268 <title>Field Option Group
</title>
269 <comment>For elements with options, the option group id that is used
</comment>
272 <table>civicrm_option_group
</table>
273 <keyColumn>id
</keyColumn>
274 <labelColumn>title
</labelColumn>
278 <name>option_group_id
</name>
279 <table>civicrm_option_group
</table>
282 <onDelete>SET NULL
</onDelete>
285 <name>serialize
</name>
286 <type>int unsigned
</type>
287 <title>Serialize
</title>
289 <comment>Serialization method - a non-null value indicates a multi-valued field.
</comment>
291 <callback>CRM_Core_SelectValues::fieldSerialization
</callback>
298 <title>Field Filter
</title>
300 <comment>Stores Contact Get API params contact reference custom fields. May be used for other filters in the future.
</comment>
304 <name>in_selector
</name>
306 <title>Field Display
</title>
308 <comment>Should the multi-record custom field values be displayed in tab table listing
</comment>
312 <name>UI_label_custom_group_id
</name>
313 <fieldName>label
</fieldName>
314 <fieldName>custom_group_id
</fieldName>
315 <unique>true
</unique>
319 <name>UI_name_custom_group_id
</name>
320 <fieldName>name
</fieldName>
321 <fieldName>custom_group_id
</fieldName>
322 <unique>true
</unique>