1 <?xml version=
"1.0" encoding=
"iso-8859-1" ?>
5 <class>OptionValue
</class>
6 <name>civicrm_option_value
</name>
11 <type>int unsigned
</type>
12 <required>true
</required>
13 <comment>Option ID
</comment>
18 <autoincrement>true
</autoincrement>
21 <name>option_group_id
</name>
22 <type>int unsigned
</type>
23 <required>true
</required>
24 <comment>Group which this option belongs to.
</comment>
27 <table>civicrm_option_group
</table>
28 <keyColumn>id
</keyColumn>
29 <labelColumn>name
</labelColumn>
33 <name>option_group_id
</name>
34 <table>civicrm_option_group
</table>
37 <onDelete>CASCADE
</onDelete>
41 <title>Option Label
</title>
43 <required>true
</required>
45 <localizable>true
</localizable>
46 <comment>Option string as displayed to users - e.g. the label in an HTML OPTION tag.
</comment>
51 <title>Option Value
</title>
54 <required>true
</required>
55 <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>
61 <title>Option Name
</title>
65 <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>
70 <title>Option Grouping Name
</title>
73 <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>
78 <type>int unsigned
</type>
79 <comment>Bitwise logic can be used to create subsets of options within an option_group for different uses.
</comment>
83 <name>is_default
</name>
86 <comment>Is this the default option for the group?
</comment>
91 <type>int unsigned
</type>
92 <required>true
</required>
93 <comment>Controls display sort order.
</comment>
97 <name>description
</name>
99 <htmlType>textarea
</htmlType>
102 <localizable>true
</localizable>
103 <comment>Optional description.
</comment>
107 <name>is_optgroup
</name>
110 <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>
114 <name>is_reserved
</name>
117 <comment>Is this a predefined system object?
</comment>
121 <name>is_active
</name>
124 <comment>Is this option active?
</comment>
128 <name>component_id
</name>
129 <type>int unsigned
</type>
130 <comment>Component that this option value belongs/caters to.
</comment>
133 <table>civicrm_component
</table>
134 <keyColumn>id
</keyColumn>
135 <labelColumn>name
</labelColumn>
139 <name>component_id
</name>
140 <table>civicrm_component
</table>
145 <name>domain_id
</name>
146 <type>int unsigned
</type>
147 <comment>Which Domain is this option value for
</comment>
151 <name>domain_id
</name>
152 <table>civicrm_domain
</table>
157 <name>visibility_id
</name>
158 <type>int unsigned
</type>
159 <default>NULL
</default>
163 <name>index_option_group_id_value
</name>
164 <fieldName length=
"128">value
</fieldName>
165 <fieldName>option_group_id
</fieldName>
169 <name>index_option_group_id_name
</name>
170 <fieldName length=
"128">name
</fieldName>
171 <fieldName>option_group_id
</fieldName>