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>
76 <label>Data Type
</label>
80 <name>html_type
</name>
82 <title>Custom Field HTML Type
</title>
84 <required>true
</required>
85 <comment>HTML types plus several built-in extended types.
</comment>
87 <callback>CRM_Core_SelectValues::customHtmlType
</callback>
91 <label>Field Input Type
</label>
96 <name>default_value
</name>
98 <title>Custom Field Default
</title>
100 <comment>Use form_options.is_default for field_types which use options.
</comment>
104 <name>is_required
</name>
105 <title>Custom Field Is Required?
</title>
107 <comment>Is a value required for this property.
</comment>
112 <name>is_searchable
</name>
113 <title>Allow Searching on Field?
</title>
115 <comment>Is this property searchable.
</comment>
120 <name>is_search_range
</name>
122 <title>Search as a Range
</title>
123 <comment>Is this property range searchable.
</comment>
131 <required>true
</required>
133 <comment>Controls field display order within an extended property group.
</comment>
137 <name>help_pre
</name>
139 <title>Custom Field Pre Text
</title>
140 <localizable>true
</localizable>
141 <comment>Description and/or help text to display before this field.
</comment>
145 <name>help_post
</name>
147 <title>Custom Field Post Text
</title>
148 <localizable>true
</localizable>
149 <comment>Description and/or help text to display after this field.
</comment>
155 <title>Custom Field Formatting
</title>
157 <comment>Optional format instructions for specific field types, like date types.
</comment>
161 <name>attributes
</name>
163 <title>Custom Field Attributes
</title>
165 <comment>Store collection of type-appropriate attributes, e.g. textarea needs rows/cols attributes
</comment>
169 <name>javascript
</name>
171 <title>Custom Field Javascript
</title>
173 <comment>Optional scripting attributes for field.
</comment>
177 <name>is_active
</name>
179 <title>Custom Field Is Active?
</title>
180 <comment>Is this property active?
</comment>
187 <title>Field is Viewable
</title>
189 <comment>Is this property set by PHP Code? A code field is viewable but not editable
</comment>
193 <name>options_per_line
</name>
194 <type>int unsigned
</type>
195 <title>Field Options Per Line
</title>
196 <comment>number of options per line for checkbox and radio
</comment>
199 <name>text_length
</name>
200 <type>int unsigned
</type>
201 <title>Field Length
</title>
202 <comment>field length if alphanumeric
</comment>
206 <name>start_date_years
</name>
208 <title>Field Start Date
</title>
209 <comment>Date may be up to start_date_years years prior to the current date.
</comment>
213 <name>end_date_years
</name>
215 <title>Field End Date
</title>
216 <comment>Date may be up to end_date_years years after the current date.
</comment>
220 <name>date_format
</name>
222 <title>Field Data Format
</title>
224 <comment>date format for custom date
</comment>
227 <callback>CRM_Core_SelectValues::getDatePluginInputFormats
</callback>
231 <name>time_format
</name>
232 <type>int unsigned
</type>
233 <title>Field Time Format
</title>
234 <comment>time format for custom date
</comment>
237 <callback>CRM_Core_SelectValues::getTimeFormats
</callback>
241 <name>note_columns
</name>
242 <type>int unsigned
</type>
243 <title>Field Note Columns
</title>
244 <comment>Number of columns in Note Field
</comment>
248 <name>note_rows
</name>
249 <type>int unsigned
</type>
250 <title>Field Note Rows
</title>
251 <comment>Number of rows in Note Field
</comment>
255 <name>column_name
</name>
257 <title>Field Column Name
</title>
259 <comment>Name of the column that holds the values for this field.
</comment>
263 <name>option_group_id
</name>
264 <type>int unsigned
</type>
265 <title>Field Option Group
</title>
266 <comment>For elements with options, the option group id that is used
</comment>
269 <table>civicrm_option_group
</table>
270 <keyColumn>id
</keyColumn>
271 <labelColumn>title
</labelColumn>
275 <name>option_group_id
</name>
276 <table>civicrm_option_group
</table>
279 <onDelete>SET NULL
</onDelete>
282 <name>serialize
</name>
283 <type>int unsigned
</type>
284 <title>Serialize
</title>
286 <comment>Serialization method - a non-zero value indicates a multi-valued field.
</comment>
288 <callback>CRM_Core_SelectValues::fieldSerialization
</callback>
291 <required>true
</required>
297 <title>Field Filter
</title>
299 <comment>Stores Contact Get API params contact reference custom fields. May be used for other filters in the future.
</comment>
303 <name>in_selector
</name>
305 <title>Field Display
</title>
307 <comment>Should the multi-record custom field values be displayed in tab table listing
</comment>
311 <name>UI_label_custom_group_id
</name>
312 <fieldName>label
</fieldName>
313 <fieldName>custom_group_id
</fieldName>
314 <unique>true
</unique>
318 <name>UI_name_custom_group_id
</name>
319 <fieldName>name
</fieldName>
320 <fieldName>custom_group_id
</fieldName>
321 <unique>true
</unique>