xml/schema/Price/PriceField.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2
   3 <table>
   4   <base>CRM/Price</base>
   5   <class>PriceField</class>
   6   <name>civicrm_price_field</name>
   7   <add>1.8</add>
   8   <log>true</log>
   9   <component>CiviContribute</component>
  10   <field>
  11     <name>id</name>
  12     <title>Price Field ID</title>
  13     <type>int unsigned</type>
  14     <required>true</required>
  15     <comment>Price Field</comment>
  16     <html>
  17       <type>Number</type>
  18     </html>
  19     <add>1.8</add>
  20   </field>
  21   <primaryKey>
  22     <name>id</name>
  23     <autoincrement>true</autoincrement>
  24   </primaryKey>
  25   <field>
  26     <name>price_set_id</name>
  27     <title>Price Set ID</title>
  28     <type>int unsigned</type>
  29     <required>true</required>
  30     <comment>FK to civicrm_price_set</comment>
  31     <pseudoconstant>
  32       <table>civicrm_price_set</table>
  33       <keyColumn>id</keyColumn>
  34       <nameColumn>name</nameColumn>
  35       <labelColumn>title</labelColumn>
  36     </pseudoconstant>
  37     <html>
  38       <type>Select</type>
  39       <label>Price Set</label>
  40     </html>
  41     <add>1.8</add>
  42   </field>
  43   <foreignKey>
  44     <name>price_set_id</name>
  45     <table>civicrm_price_set</table>
  46     <key>id</key>
  47     <add>1.8</add>
  48   </foreignKey>
  49   <field>
  50     <name>name</name>
  51     <type>varchar</type>
  52     <title>Name</title>
  53     <length>255</length>
  54     <required>true</required>
  55     <comment>Variable name/programmatic handle for this field.</comment>
  56     <add>1.8</add>
  57     <html>
  58       <type>Text</type>
  59     </html>
  60   </field>
  61   <index>
  62     <name>index_name</name>
  63     <fieldName>name</fieldName>
  64     <add>1.8</add>
  65   </index>
  66   <field>
  67     <name>label</name>
  68     <type>varchar</type>
  69     <title>Label</title>
  70     <length>255</length>
  71     <required>true</required>
  72     <localizable>true</localizable>
  73     <comment>Text for form field label (also friendly name for administering this field).</comment>
  74     <html>
  75       <type>Text</type>
  76     </html>
  77     <add>1.8</add>
  78   </field>
  79   <field>
  80     <name>html_type</name>
  81     <type>varchar</type>
  82     <length>12</length>
  83     <required>true</required>
  84     <pseudoconstant>
  85       <callback>CRM_Price_BAO_PriceField::htmlTypes</callback>
  86     </pseudoconstant>
  87     <add>1.8</add>
  88     <html>
  89       <type>Select</type>
  90       <label>Html Type</label>
  91     </html>
  92   </field>
  93   <field>
  94     <name>is_enter_qty</name>
  95     <title>Price Field Quantity Required?</title>
  96     <type>boolean</type>
  97     <default>0</default>
  98     <required>true</required>
  99     <comment>Enter a quantity for this field?</comment>
 100     <add>1.8</add>
 101     <html>
 102       <type>CheckBox</type>
 103     </html>
 104   </field>
 105   <field>
 106     <name>help_pre</name>
 107     <title>Price Field Pre Text</title>
 108     <type>text</type>
 109     <localizable>true</localizable>
 110     <comment>Description and/or help text to display before this field.</comment>
 111     <html>
 112       <type>TextArea</type>
 113       <rows>4</rows>
 114       <cols>80</cols>
 115     </html>
 116     <add>1.8</add>
 117   </field>
 118   <field>
 119     <name>help_post</name>
 120     <title>Price Field Post Text</title>
 121     <type>text</type>
 122     <localizable>true</localizable>
 123     <comment>Description and/or help text to display after this field.</comment>
 124     <html>
 125       <type>TextArea</type>
 126       <rows>4</rows>
 127       <cols>80</cols>
 128     </html>
 129     <add>1.8</add>
 130   </field>
 131   <field>
 132     <name>weight</name>
 133     <title>Order</title>
 134     <type>int</type>
 135     <default>1</default>
 136     <comment>Order in which the fields should appear</comment>
 137     <add>1.8</add>
 138     <html>
 139       <type>Select</type>
 140     </html>
 141   </field>
 142   <field>
 143     <name>is_display_amounts</name>
 144     <title>Price Field Show Amounts?</title>
 145     <type>boolean</type>
 146     <default>1</default>
 147     <required>true</required>
 148     <comment>Should the price be displayed next to the label for each option?</comment>
 149     <html>
 150       <type>CheckBox</type>
 151     </html>
 152   </field>
 153   <field>
 154     <name>options_per_line</name>
 155     <title>Price Field Options per Row</title>
 156     <type>int unsigned</type>
 157     <default>1</default>
 158     <comment>number of options per line for checkbox and radio</comment>
 159     <add>1.8</add>
 160     <html>
 161       <type>Text</type>
 162     </html>
 163   </field>
 164   <field>
 165     <name>is_active</name>
 166     <title>Price Field Is Active?</title>
 167     <type>boolean</type>
 168     <comment>Is this price field active</comment>
 169     <default>1</default>
 170     <required>true</required>
 171     <add>1.8</add>
 172     <html>
 173       <type>CheckBox</type>
 174     </html>
 175   </field>
 176   <field>
 177     <name>is_required</name>
 178     <title>Price Field is Required?</title>
 179     <type>boolean</type>
 180     <comment>Is this price field required (value must be > 1)</comment>
 181     <default>1</default>
 182     <required>true</required>
 183     <add>1.8</add>
 184     <html>
 185       <type>CheckBox</type>
 186     </html>
 187   </field>
 188   <field>
 189     <name>active_on</name>
 190     <title>Price Field Start Date</title>
 191     <type>datetime</type>
 192     <default>NULL</default>
 193     <comment>If non-zero, do not show this field before the date specified</comment>
 194     <add>1.8</add>
 195     <html>
 196       <type>Select Date</type>
 197       <formatType>activityDateTime</formatType>
 198     </html>
 199   </field>
 200   <field>
 201     <name>expire_on</name>
 202     <title>Price Field End Date</title>
 203     <type>datetime</type>
 204     <default>NULL</default>
 205     <comment>If non-zero, do not show this field after the date specified</comment>
 206     <add>1.8</add>
 207     <html>
 208       <type>Select Date</type>
 209       <formatType>activityDateTime</formatType>
 210     </html>
 211   </field>
 212   <field>
 213     <name>javascript</name>
 214     <title>Price Field Javascript</title>
 215     <type>varchar</type>
 216     <length>255</length>
 217     <comment>Optional scripting attributes for field</comment>
 218     <add>1.8</add>
 219     <html>
 220       <type>Text</type>
 221     </html>
 222   </field>
 223   <field>
 224     <name>visibility_id</name>
 225     <title>Price Field Visibility</title>
 226     <type>int unsigned</type>
 227     <default>1</default>
 228     <comment>Implicit FK to civicrm_option_group with name = 'visibility'</comment>
 229     <add>3.2</add>
 230     <pseudoconstant>
 231       <optionGroupName>visibility</optionGroupName>
 232     </pseudoconstant>
 233     <html>
 234       <type>Select</type>
 235     </html>
 236   </field>
 237 </table>