Merge pull request #21307 from civicrm/5.41
[civicrm-core.git] / 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 <comment>Enter a quantity for this field?</comment>
99 <add>1.8</add>
100 <html>
101 <type>CheckBox</type>
102 </html>
103 </field>
104 <field>
105 <name>help_pre</name>
106 <title>Price Field Pre Text</title>
107 <type>text</type>
108 <localizable>true</localizable>
109 <comment>Description and/or help text to display before this field.</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>help_post</name>
119 <title>Price Field Post Text</title>
120 <type>text</type>
121 <localizable>true</localizable>
122 <comment>Description and/or help text to display after this field.</comment>
123 <html>
124 <type>TextArea</type>
125 <rows>4</rows>
126 <cols>80</cols>
127 </html>
128 <add>1.8</add>
129 </field>
130 <field>
131 <name>weight</name>
132 <title>Order</title>
133 <type>int</type>
134 <default>1</default>
135 <comment>Order in which the fields should appear</comment>
136 <add>1.8</add>
137 <html>
138 <type>Select</type>
139 </html>
140 </field>
141 <field>
142 <name>is_display_amounts</name>
143 <title>Price Field Show Amounts?</title>
144 <type>boolean</type>
145 <default>1</default>
146 <comment>Should the price be displayed next to the label for each option?</comment>
147 <html>
148 <type>CheckBox</type>
149 </html>
150 </field>
151 <field>
152 <name>options_per_line</name>
153 <title>Price Field Options per Row</title>
154 <type>int unsigned</type>
155 <default>1</default>
156 <comment>number of options per line for checkbox and radio</comment>
157 <add>1.8</add>
158 <html>
159 <type>Text</type>
160 </html>
161 </field>
162 <field>
163 <name>is_active</name>
164 <title>Price Field Is Active?</title>
165 <type>boolean</type>
166 <comment>Is this price field active</comment>
167 <default>1</default>
168 <add>1.8</add>
169 <html>
170 <type>CheckBox</type>
171 </html>
172 </field>
173 <field>
174 <name>is_required</name>
175 <title>Price Field is Required?</title>
176 <type>boolean</type>
177 <comment>Is this price field required (value must be > 1)</comment>
178 <default>1</default>
179 <add>1.8</add>
180 <html>
181 <type>CheckBox</type>
182 </html>
183 </field>
184 <field>
185 <name>active_on</name>
186 <title>Price Field Start Date</title>
187 <type>datetime</type>
188 <default>NULL</default>
189 <comment>If non-zero, do not show this field before the date specified</comment>
190 <add>1.8</add>
191 <html>
192 <type>Select Date</type>
193 <formatType>activityDateTime</formatType>
194 </html>
195 </field>
196 <field>
197 <name>expire_on</name>
198 <title>Price Field End Date</title>
199 <type>datetime</type>
200 <default>NULL</default>
201 <comment>If non-zero, do not show this field after the date specified</comment>
202 <add>1.8</add>
203 <html>
204 <type>Select Date</type>
205 <formatType>activityDateTime</formatType>
206 </html>
207 </field>
208 <field>
209 <name>javascript</name>
210 <title>Price Field Javascript</title>
211 <type>varchar</type>
212 <length>255</length>
213 <comment>Optional scripting attributes for field</comment>
214 <add>1.8</add>
215 <html>
216 <type>Text</type>
217 </html>
218 </field>
219 <field>
220 <name>visibility_id</name>
221 <title>Price Field Visibility</title>
222 <type>int unsigned</type>
223 <default>1</default>
224 <comment>Implicit FK to civicrm_option_group with name = 'visibility'</comment>
225 <add>3.2</add>
226 <pseudoconstant>
227 <optionGroupName>visibility</optionGroupName>
228 </pseudoconstant>
229 <html>
230 <type>Select</type>
231 </html>
232 </field>
233 </table>