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>
36 <name>option_group_id
</name>
37 <table>civicrm_option_group
</table>
40 <onDelete>CASCADE
</onDelete>
44 <title>Option Label
</title>
46 <required>true
</required>
48 <localizable>true
</localizable>
49 <comment>Option string as displayed to users - e.g. the label in an HTML OPTION tag.
</comment>
54 <title>Option Value
</title>
57 <required>true
</required>
58 <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>
64 <title>Option Name
</title>
68 <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>
73 <title>Option Grouping Name
</title>
76 <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>
81 <type>int unsigned
</type>
82 <comment>Bitwise logic can be used to create subsets of options within an option_group for different uses.
</comment>
86 <name>is_default
</name>
89 <comment>Is this the default option for the group?
</comment>
94 <type>int unsigned
</type>
95 <required>true
</required>
96 <comment>Controls display sort order.
</comment>
100 <name>description
</name>
103 <type>TextArea
</type>
107 <localizable>true
</localizable>
108 <comment>Optional description.
</comment>
112 <name>is_optgroup
</name>
115 <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>
119 <name>is_reserved
</name>
122 <comment>Is this a predefined system object?
</comment>
126 <name>is_active
</name>
129 <comment>Is this option active?
</comment>
133 <name>component_id
</name>
134 <type>int unsigned
</type>
135 <comment>Component that this option value belongs/caters to.
</comment>
138 <table>civicrm_component
</table>
139 <keyColumn>id
</keyColumn>
140 <labelColumn>name
</labelColumn>
147 <name>component_id
</name>
148 <table>civicrm_component
</table>
153 <name>domain_id
</name>
154 <type>int unsigned
</type>
156 <table>civicrm_domain
</table>
157 <keyColumn>id
</keyColumn>
158 <labelColumn>name
</labelColumn>
160 <comment>Which Domain is this option value for
</comment>
164 <name>domain_id
</name>
165 <table>civicrm_domain
</table>
170 <name>visibility_id
</name>
171 <type>int unsigned
</type>
172 <default>NULL
</default>
176 <name>index_option_group_id_value
</name>
177 <fieldName length=
"128">value
</fieldName>
178 <fieldName>option_group_id
</fieldName>
182 <name>index_option_group_id_name
</name>
183 <fieldName length=
"128">name
</fieldName>
184 <fieldName>option_group_id
</fieldName>