1 <?xml version=
"1.0" encoding=
"iso-8859-1" ?>
5 <class>OptionValue
</class>
6 <name>civicrm_option_value
</name>
11 <title>Option Value ID
</title>
12 <type>int unsigned
</type>
13 <required>true
</required>
14 <comment>Option ID
</comment>
19 <autoincrement>true
</autoincrement>
22 <name>option_group_id
</name>
23 <title>Option Group ID
</title>
24 <type>int unsigned
</type>
25 <required>true
</required>
26 <comment>Group which this option belongs to.
</comment>
29 <table>civicrm_option_group
</table>
30 <keyColumn>id
</keyColumn>
31 <nameColumn>name
</nameColumn>
32 <labelColumn>title
</labelColumn>
39 <name>option_group_id
</name>
40 <table>civicrm_option_group
</table>
43 <onDelete>CASCADE
</onDelete>
47 <title>Option Label
</title>
49 <required>true
</required>
51 <localizable>true
</localizable>
52 <comment>Option string as displayed to users - e.g. the label in an HTML OPTION tag.
</comment>
57 <title>Option Value
</title>
60 <required>true
</required>
61 <comment>The actual value stored (as a foreign key) in the data record. Functions which need lookup option_value.title should use civicrm_option_value.option_group_id plus civicrm_option_value.value as the key.
</comment>
67 <title>Option Name
</title>
71 <comment>Stores a fixed (non-translated) name for this option value. Lookup functions should use the name as the key for the option value row.
</comment>
76 <title>Option Grouping Name
</title>
79 <comment>Use to sort and/or set display properties for sub-set(s) of options within an option group. EXAMPLE: Use for college_interest field, to differentiate partners from non-partners.
</comment>
84 <type>int unsigned
</type>
86 <comment>Bitwise logic can be used to create subsets of options within an option_group for different uses.
</comment>
90 <name>is_default
</name>
91 <title>Option is Default?
</title>
94 <comment>Is this the default option for the group?
</comment>
100 <type>int unsigned
</type>
101 <required>true
</required>
102 <comment>Controls display sort order.
</comment>
106 <name>description
</name>
107 <title>Option Description
</title>
110 <type>TextArea
</type>
114 <localizable>true
</localizable>
115 <comment>Optional description.
</comment>
119 <name>is_optgroup
</name>
120 <title>Option is Header?
</title>
123 <comment>Is this row simply a display header? Expected usage is to render these as OPTGROUP tags within a SELECT field list of options?
</comment>
127 <name>is_reserved
</name>
128 <title>Option Is Reserved?
</title>
131 <comment>Is this a predefined system object?
</comment>
135 <name>is_active
</name>
136 <title>Option Is Active
</title>
139 <comment>Is this option active?
</comment>
143 <name>component_id
</name>
144 <title>Option Component
</title>
145 <type>int unsigned
</type>
146 <comment>Component that this option value belongs/caters to.
</comment>
149 <table>civicrm_component
</table>
150 <keyColumn>id
</keyColumn>
151 <labelColumn>name
</labelColumn>
158 <name>component_id
</name>
159 <table>civicrm_component
</table>
164 <name>domain_id
</name>
165 <title>Option Domain
</title>
166 <type>int unsigned
</type>
168 <table>civicrm_domain
</table>
169 <keyColumn>id
</keyColumn>
170 <labelColumn>name
</labelColumn>
172 <comment>Which Domain is this option value for
</comment>
176 <name>domain_id
</name>
177 <table>civicrm_domain
</table>
182 <name>visibility_id
</name>
183 <title>Option Visibility
</title>
184 <type>int unsigned
</type>
185 <default>NULL
</default>
188 <optionGroupName>visibility
</optionGroupName>
196 <default>NULL
</default>
197 <comment>crm-i icon class
</comment>
205 <comment>Hex color value e.g. #ffffff
</comment>
206 <default>NULL
</default>
210 <name>index_option_group_id_value
</name>
211 <fieldName length=
"128">value
</fieldName>
212 <fieldName>option_group_id
</fieldName>
216 <name>index_option_group_id_name
</name>
217 <fieldName length=
"128">name
</fieldName>
218 <fieldName>option_group_id
</fieldName>