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 <labelColumn>name
</labelColumn>
38 <name>option_group_id
</name>
39 <table>civicrm_option_group
</table>
42 <onDelete>CASCADE
</onDelete>
46 <title>Option Label
</title>
48 <required>true
</required>
50 <localizable>true
</localizable>
51 <comment>Option string as displayed to users - e.g. the label in an HTML OPTION tag.
</comment>
56 <title>Option Value
</title>
59 <required>true
</required>
60 <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>
66 <title>Option Name
</title>
70 <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>
75 <title>Option Grouping Name
</title>
78 <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>
83 <type>int unsigned
</type>
84 <comment>Bitwise logic can be used to create subsets of options within an option_group for different uses.
</comment>
88 <name>is_default
</name>
89 <title>Option is Default?
</title>
92 <comment>Is this the default option for the group?
</comment>
98 <type>int unsigned
</type>
99 <required>true
</required>
100 <comment>Controls display sort order.
</comment>
104 <name>description
</name>
105 <title>Option Description
</title>
108 <type>TextArea
</type>
112 <localizable>true
</localizable>
113 <comment>Optional description.
</comment>
117 <name>is_optgroup
</name>
118 <title>Option is Header?
</title>
121 <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>
125 <name>is_reserved
</name>
126 <title>Option Is Reserved?
</title>
129 <comment>Is this a predefined system object?
</comment>
133 <name>is_active
</name>
134 <title>Option Is Active
</title>
137 <comment>Is this option active?
</comment>
141 <name>component_id
</name>
142 <title>Option Component
</title>
143 <type>int unsigned
</type>
144 <comment>Component that this option value belongs/caters to.
</comment>
147 <table>civicrm_component
</table>
148 <keyColumn>id
</keyColumn>
149 <labelColumn>name
</labelColumn>
156 <name>component_id
</name>
157 <table>civicrm_component
</table>
162 <name>domain_id
</name>
163 <title>Option Domain
</title>
164 <type>int unsigned
</type>
166 <table>civicrm_domain
</table>
167 <keyColumn>id
</keyColumn>
168 <labelColumn>name
</labelColumn>
170 <comment>Which Domain is this option value for
</comment>
174 <name>domain_id
</name>
175 <table>civicrm_domain
</table>
180 <name>visibility_id
</name>
181 <title>Option Visibility
</title>
182 <type>int unsigned
</type>
183 <default>NULL
</default>
187 <name>index_option_group_id_value
</name>
188 <fieldName length=
"128">value
</fieldName>
189 <fieldName>option_group_id
</fieldName>
193 <name>index_option_group_id_name
</name>
194 <fieldName length=
"128">name
</fieldName>
195 <fieldName>option_group_id
</fieldName>