1 <?xml version=
"1.0" encoding=
"iso-8859-1" ?>
5 <class>OptionValue
</class>
6 <name>civicrm_option_value
</name>
10 <update>civicrm/admin/options/[option_group_id:name]?reset=
1&action=update
&id=[id]
</update>
11 <delete>civicrm/admin/options/[option_group_id:name]?reset=
1&action=delete
&id=[id]
</delete>
15 <title>Option Value ID
</title>
16 <type>int unsigned
</type>
17 <required>true
</required>
18 <comment>Option ID
</comment>
23 <autoincrement>true
</autoincrement>
26 <name>option_group_id
</name>
27 <title>Option Group ID
</title>
28 <type>int unsigned
</type>
29 <required>true
</required>
30 <comment>Group which this option belongs to.
</comment>
33 <table>civicrm_option_group
</table>
34 <keyColumn>id
</keyColumn>
35 <nameColumn>name
</nameColumn>
36 <labelColumn>title
</labelColumn>
40 <label>Option Group
</label>
44 <name>option_group_id
</name>
45 <table>civicrm_option_group
</table>
48 <onDelete>CASCADE
</onDelete>
52 <title>Option Label
</title>
54 <required>true
</required>
56 <localizable>true
</localizable>
57 <comment>Option string as displayed to users - e.g. the label in an HTML OPTION tag.
</comment>
62 <title>Option Value
</title>
65 <required>true
</required>
66 <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>
72 <title>Option Name
</title>
76 <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>
81 <title>Option Grouping Name
</title>
84 <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>
89 <type>int unsigned
</type>
91 <comment>Bitwise logic can be used to create subsets of options within an option_group for different uses.
</comment>
98 <name>is_default
</name>
99 <title>Option is Default?
</title>
102 <comment>Is this the default option for the group?
</comment>
108 <type>int unsigned
</type>
109 <required>true
</required>
110 <comment>Controls display sort order.
</comment>
114 <name>description
</name>
115 <title>Option Description
</title>
118 <type>TextArea
</type>
122 <localizable>true
</localizable>
123 <comment>Optional description.
</comment>
127 <name>is_optgroup
</name>
128 <title>Option is Header?
</title>
131 <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>
135 <name>is_reserved
</name>
136 <title>Option Is Reserved?
</title>
139 <comment>Is this a predefined system object?
</comment>
143 <name>is_active
</name>
144 <title>Option Is Active
</title>
147 <comment>Is this option active?
</comment>
151 <name>component_id
</name>
152 <title>Component ID
</title>
153 <type>int unsigned
</type>
154 <comment>Component that this option value belongs/caters to.
</comment>
157 <table>civicrm_component
</table>
158 <keyColumn>id
</keyColumn>
159 <labelColumn>name
</labelColumn>
163 <label>Component
</label>
167 <name>component_id
</name>
168 <table>civicrm_component
</table>
173 <name>domain_id
</name>
174 <title>Domain ID
</title>
175 <type>int unsigned
</type>
177 <table>civicrm_domain
</table>
178 <keyColumn>id
</keyColumn>
179 <labelColumn>name
</labelColumn>
181 <comment>Which Domain is this option value for
</comment>
183 <label>Domain
</label>
188 <name>domain_id
</name>
189 <table>civicrm_domain
</table>
194 <name>visibility_id
</name>
195 <title>Option Visibility
</title>
196 <type>int unsigned
</type>
197 <default>NULL
</default>
200 <optionGroupName>visibility
</optionGroupName>
208 <default>NULL
</default>
209 <comment>crm-i icon class
</comment>
217 <comment>Hex color value e.g. #ffffff
</comment>
218 <default>NULL
</default>
222 <name>index_option_group_id_value
</name>
223 <fieldName length=
"128">value
</fieldName>
224 <fieldName>option_group_id
</fieldName>
228 <name>index_option_group_id_name
</name>
229 <fieldName length=
"128">name
</fieldName>
230 <fieldName>option_group_id
</fieldName>