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