xml/schema/Core/OptionValue.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2
   3 <table>
   4   <base>CRM/Core</base>
   5   <class>OptionValue</class>
   6   <name>civicrm_option_value</name>
   7   <add>1.5</add>
   8   <log>true</log>
   9   <field>
  10       <name>id</name>
  11     <title>Option Value ID</title>
  12       <type>int unsigned</type>
  13       <required>true</required>
  14       <comment>Option ID</comment>
  15        <add>1.5</add>
  16   </field>
  17   <primaryKey>
  18        <name>id</name>
  19        <autoincrement>true</autoincrement>
  20   </primaryKey>
  21   <field>
  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>
  27        <add>1.5</add>
  28       <pseudoconstant>
  29         <table>civicrm_option_group</table>
  30         <keyColumn>id</keyColumn>
  31         <labelColumn>name</labelColumn>
  32       </pseudoconstant>
  33       <html>
  34         <type>Select</type>
  35       </html>
  36   </field>
  37   <foreignKey>
  38        <name>option_group_id</name>
  39        <table>civicrm_option_group</table>
  40        <key>id</key>
  41        <add>1.5</add>
  42        <onDelete>CASCADE</onDelete>
  43   </foreignKey>
  44   <field>
  45        <name>label</name>
  46        <title>Option Label</title>
  47        <type>varchar</type>
  48        <required>true</required>
  49        <length>255</length>
  50        <localizable>true</localizable>
  51        <comment>Option string as displayed to users - e.g. the label in an HTML OPTION tag.</comment>
  52        <add>1.5</add>
  53   </field>
  54   <field>
  55       <name>value</name>
  56       <title>Option Value</title>
  57       <type>varchar</type>
  58       <length>512</length>
  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>
  61        <add>1.5</add>
  62        <change>3.3</change>
  63   </field>
  64   <field>
  65        <name>name</name>
  66        <title>Option Name</title>
  67        <type>varchar</type>
  68        <length>255</length>
  69        <import>true</import>
  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>
  71        <add>1.5</add>
  72    </field>
  73   <field>
  74        <name>grouping</name>
  75        <title>Option Grouping Name</title>
  76        <type>varchar</type>
  77        <length>255</length>
  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>
  79        <add>1.5</add>
  80   </field>
  81   <field>
  82       <name>filter</name>
  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>
  85       <add>1.5</add>
  86   </field>
  87   <field>
  88        <name>is_default</name>
  89        <type>boolean</type>
  90        <default>0</default>
  91        <comment>Is this the default option for the group?</comment>
  92        <add>1.5</add>
  93   </field>
  94   <field>
  95       <name>weight</name>
  96       <type>int unsigned</type>
  97       <required>true</required>
  98       <comment>Controls display sort order.</comment>
  99        <add>1.5</add>
 100   </field>
 101   <field>
 102        <name>description</name>
 103        <type>text</type>
 104        <html>
 105          <type>TextArea</type>
 106          <rows>8</rows>
 107          <cols>60</cols>
 108        </html>
 109        <localizable>true</localizable>
 110        <comment>Optional description.</comment>
 111        <add>1.5</add>
 112   </field>
 113   <field>
 114        <name>is_optgroup</name>
 115        <type>boolean</type>
 116        <default>0</default>
 117        <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>
 118        <add>1.5</add>
 119   </field>
 120   <field>
 121        <name>is_reserved</name>
 122        <type>boolean</type>
 123        <default>0</default>
 124        <comment>Is this a predefined system object?</comment>
 125        <add>1.5</add>
 126   </field>
 127   <field>
 128        <name>is_active</name>
 129     <title>Option Is Active</title>
 130        <type>boolean</type>
 131        <default>1</default>
 132        <comment>Is this option active?</comment>
 133        <add>1.5</add>
 134   </field>
 135   <field>
 136       <name>component_id</name>
 137       <type>int unsigned</type>
 138       <comment>Component that this option value belongs/caters to.</comment>
 139       <add>2.0</add>
 140       <pseudoconstant>
 141         <table>civicrm_component</table>
 142         <keyColumn>id</keyColumn>
 143         <labelColumn>name</labelColumn>
 144       </pseudoconstant>
 145       <html>
 146         <type>Select</type>
 147       </html>
 148   </field>
 149   <foreignKey>
 150        <name>component_id</name>
 151        <table>civicrm_component</table>
 152        <key>id</key>
 153        <add>2.0</add>
 154   </foreignKey>
 155   <field>
 156       <name>domain_id</name>
 157       <type>int unsigned</type>
 158       <pseudoconstant>
 159           <table>civicrm_domain</table>
 160           <keyColumn>id</keyColumn>
 161           <labelColumn>name</labelColumn>
 162       </pseudoconstant>
 163       <comment>Which Domain is this option value for</comment>
 164       <add>3.1</add>
 165   </field>
 166   <foreignKey>
 167        <name>domain_id</name>
 168        <table>civicrm_domain</table>
 169        <key>id</key>
 170        <add>3.1</add>
 171   </foreignKey>
 172   <field>
 173        <name>visibility_id</name>
 174        <type>int unsigned</type>
 175        <default>NULL</default>
 176        <add>2.2</add>
 177   </field>
 178   <index>
 179        <name>index_option_group_id_value</name>
 180        <fieldName length="128">value</fieldName>
 181        <fieldName>option_group_id</fieldName>
 182        <add>1.5</add>
 183   </index>
 184   <index>
 185     <name>index_option_group_id_name</name>
 186     <fieldName length="128">name</fieldName>
 187     <fieldName>option_group_id</fieldName>
 188     <add>2.2</add>
 189   </index>
 190 </table>