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