xml/schema/Price/PriceSet.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2
   3 <table>
   4   <base>CRM/Price</base>
   5   <class>PriceSet</class>
   6   <name>civicrm_price_set</name>
   7   <add>1.8</add>
   8   <log>true</log>
   9   <component>CiviContribute</component>
  10   <field>
  11     <name>id</name>
  12     <title>Price Set</title>
  13     <type>int unsigned</type>
  14     <required>true</required>
  15     <comment>Price Set</comment>
  16     <html>
  17       <type>Number</type>
  18       <label>ID</label>
  19     </html>
  20     <add>1.8</add>
  21   </field>
  22   <primaryKey>
  23     <name>id</name>
  24     <autoincrement>true</autoincrement>
  25   </primaryKey>
  26   <field>
  27     <name>domain_id</name>
  28     <title>Domain ID</title>
  29     <type>int unsigned</type>
  30     <pseudoconstant>
  31       <table>civicrm_domain</table>
  32       <keyColumn>id</keyColumn>
  33       <labelColumn>name</labelColumn>
  34     </pseudoconstant>
  35     <comment>Which Domain is this price-set for</comment>
  36     <add>3.1</add>
  37     <html>
  38       <type>Text</type>
  39       <label>Domain</label>
  40     </html>
  41   </field>
  42   <foreignKey>
  43     <name>domain_id</name>
  44     <table>civicrm_domain</table>
  45     <key>id</key>
  46     <add>3.1</add>
  47   </foreignKey>
  48   <field>
  49     <name>name</name>
  50     <type>varchar</type>
  51     <length>255</length>
  52     <required>true</required>
  53     <comment>Variable name/programmatic handle for this set of price fields.</comment>
  54     <add>1.8</add>
  55     <html>
  56       <type>Text</type>
  57       <label>Name</label>
  58     </html>
  59   </field>
  60   <index>
  61     <name>UI_name</name>
  62     <fieldName>name</fieldName>
  63     <unique>true</unique>
  64     <add>1.8</add>
  65   </index>
  66   <field>
  67     <name>title</name>
  68     <title>Price Set Title</title>
  69     <type>varchar</type>
  70     <length>255</length>
  71     <required>true</required>
  72     <localizable>true</localizable>
  73     <comment>Displayed title for the Price Set.</comment>
  74     <add>1.8</add>
  75     <html>
  76       <type>Text</type>
  77     </html>
  78   </field>
  79   <field>
  80     <name>is_active</name>
  81     <title>Price Set Is Active?</title>
  82     <type>boolean</type>
  83     <default>1</default>
  84     <required>true</required>
  85     <comment>Is this price set active</comment>
  86     <add>1.8</add>
  87     <html>
  88       <type>CheckBox</type>
  89     </html>
  90   </field>
  91   <field>
  92     <name>help_pre</name>
  93     <title>Price Set Pre Help</title>
  94     <type>text</type>
  95     <localizable>true</localizable>
  96     <comment>Description and/or help text to display before fields in form.</comment>
  97     <html>
  98       <type>TextArea</type>
  99       <rows>4</rows>
 100       <cols>80</cols>
 101     </html>
 102     <add>1.8</add>
 103   </field>
 104   <field>
 105     <name>help_post</name>
 106     <title>Price Set Post Help</title>
 107     <type>text</type>
 108     <localizable>true</localizable>
 109     <comment>Description and/or help text to display after fields in form.</comment>
 110     <html>
 111       <type>TextArea</type>
 112       <rows>4</rows>
 113       <cols>80</cols>
 114     </html>
 115     <add>1.8</add>
 116   </field>
 117   <field>
 118     <name>javascript</name>
 119     <title>Price Set Javascript</title>
 120     <type>varchar</type>
 121     <length>64</length>
 122     <comment>Optional Javascript script function(s) included on the form with this price_set. Can be used for conditional</comment>
 123     <add>1.8</add>
 124     <html>
 125       <type>Text</type>
 126     </html>
 127   </field>
 128   <field>
 129     <name>extends</name>
 130     <title>Price Set Extends</title>
 131     <type>varchar</type>
 132     <length>255</length>
 133     <required>true</required>
 134     <comment>What components are using this price set?</comment>
 135     <pseudoconstant>
 136       <table>civicrm_component</table>
 137       <keyColumn>id</keyColumn>
 138       <labelColumn>name</labelColumn>
 139     </pseudoconstant>
 140     <add>3.1</add>
 141     <html>
 142       <type>Text</type>
 143     </html>
 144   </field>
 145   <field>
 146     <name>financial_type_id</name>
 147     <title>Financial Type ID</title>
 148     <type>int unsigned</type>
 149     <default>NULL</default>
 150     <comment>FK to Financial Type(for membership price sets only).</comment>
 151     <add>4.3</add>
 152     <pseudoconstant>
 153       <table>civicrm_financial_type</table>
 154       <keyColumn>id</keyColumn>
 155       <labelColumn>name</labelColumn>
 156     </pseudoconstant>
 157     <html>
 158       <type>Select</type>
 159       <label>Financial Type</label>
 160     </html>
 161   </field>
 162   <foreignKey>
 163     <name>financial_type_id</name>
 164     <table>civicrm_financial_type</table>
 165     <key>id</key>
 166     <add>4.3</add>
 167     <onDelete>SET NULL</onDelete>
 168   </foreignKey>
 169   <field>
 170     <name>is_quick_config</name>
 171     <title>Is Price Set Quick Config?</title>
 172     <type>boolean</type>
 173     <default>0</default>
 174     <required>true</required>
 175     <comment>Is set if edited on Contribution or Event Page rather than through Manage Price Sets</comment>
 176     <html>
 177       <type>CheckBox</type>
 178     </html>
 179     <add>4.1</add>
 180   </field>
 181   <field>
 182     <name>is_reserved</name>
 183     <title>Price Set Is Reserved</title>
 184     <type>boolean</type>
 185     <default>0</default>
 186     <required>true</required>
 187     <comment>Is this a predefined system price set  (i.e. it can not be deleted, edited)?</comment>
 188     <add>4.2</add>
 189     <html>
 190       <type>CheckBox</type>
 191     </html>
 192   </field>
 193   <field>
 194     <name>min_amount</name>
 195     <title>Minimum Amount</title>
 196     <type>decimal</type>
 197     <default>0.0</default>
 198     <comment>Minimum Amount required for this set.</comment>
 199     <add>4.7</add>
 200     <html>
 201       <type>Text</type>
 202     </html>
 203   </field>
 204 </table>