1 <?xml version=
"1.0" encoding=
"iso-8859-1" ?>
4 <base>CRM/Contribute
</base>
5 <class>ContributionPage
</class>
6 <name>civicrm_contribution_page
</name>
7 <comment>A Contribution object store meta information about a single customized contribution page
</comment>
12 <type>int unsigned
</type>
13 <required>true
</required>
14 <comment>Contribution Id
</comment>
19 <autoincrement>true
</autoincrement>
25 <localizable>true
</localizable>
26 <comment>Contribution Page title. For top of page display
</comment>
30 <name>intro_text
</name>
32 <htmlType>textarea
</htmlType>
35 <localizable>true
</localizable>
36 <comment>Text and html allowed. Displayed below title.
</comment>
40 <name>contribution_type_id
</name>
41 <type>int unsigned
</type>
42 <required>true
</required>
43 <comment>default Contribution type assigned to contributions submitted via this page, e.g. Contribution, Campaign Contribution
</comment>
48 <name>contribution_type_id
</name>
49 <table>civicrm_contribution_type
</table>
54 <name>financial_type_id
</name>
55 <type>int unsigned
</type>
56 <comment>default financial type assigned to contributions submitted via this page, e.g. Contribution, Campaign Contribution
</comment>
58 <table>civicrm_financial_type
</table>
59 <keyColumn>id
</keyColumn>
60 <labelColumn>name
</labelColumn>
65 <name>financial_type_id
</name>
66 <table>civicrm_financial_type
</table>
71 <name>payment_processor
</name>
74 <comment>Payment Processors configured for this contribution Page
</comment>
76 <table>civicrm_payment_processor
</table>
77 <keyColumn>id
</keyColumn>
78 <labelColumn>name
</labelColumn>
83 <name>is_credit_card_only
</name>
85 <comment>if true - processing logic must reject transaction at confirmation stage if pay method != credit card
</comment>
90 <name>is_monetary
</name>
93 <comment>if true - allows real-time monetary transactions otherwise non-monetary transactions
</comment>
100 <comment>if true - allows recurring contributions, valid only for PayPal_Standard
</comment>
104 <name>is_confirm_enabled
</name>
107 <comment>if false, the confirm page in contribution pages gets skipped
</comment>
111 <name>recur_frequency_unit
</name>
114 <comment>Supported recurring frequency units.
</comment>
118 <name>is_recur_interval
</name>
121 <comment>if true - supports recurring intervals
</comment>
125 <name>is_recur_installments
</name>
128 <comment>if true - asks user for recurring installments
</comment>
132 <name>is_pay_later
</name>
135 <comment>if true - allows the user to send payment directly to the org later
</comment>
139 <name>pay_later_text
</name>
141 <localizable>true
</localizable>
142 <comment>The text displayed to the user in the main form
</comment>
146 <name>pay_later_receipt
</name>
148 <localizable>true
</localizable>
149 <comment>The receipt sent to the user instead of the normal receipt text
</comment>
153 <name>is_partial_payment
</name>
156 <comment>is partial payment enabled for this online contribution page
</comment>
160 <name>initial_amount_label
</name>
163 <localizable>true
</localizable>
164 <comment>Initial amount label for partial payment
</comment>
168 <name>initial_amount_help_text
</name>
170 <localizable>true
</localizable>
171 <comment>Initial amount help text for partial payment
</comment>
175 <name>min_initial_amount
</name>
177 <comment>Minimum initial amount for partial payment
</comment>
181 <name>is_allow_other_amount
</name>
183 <comment>if true, page will include an input text field where user can enter their own amount
</comment>
188 <name>default_amount_id
</name>
189 <type>int unsigned
</type>
190 <comment>FK to civicrm_option_value.
</comment>
194 <name>min_amount
</name>
196 <comment>if other amounts allowed, user can configure minimum allowed.
</comment>
200 <name>max_amount
</name>
202 <comment>if other amounts allowed, user can configure maximum allowed.
</comment>
206 <name>goal_amount
</name>
208 <comment>The target goal for this page, allows people to build a goal meter
</comment>
212 <name>thankyou_title
</name>
213 <title>Thank-you Title
</title>
216 <localizable>true
</localizable>
217 <comment>Title for Thank-you page (header title tag, and display at the top of the page).
</comment>
221 <name>thankyou_text
</name>
222 <title>Thank-you Text
</title>
224 <htmlType>textarea
</htmlType>
227 <localizable>true
</localizable>
228 <comment>text and html allowed. displayed above result on success page
</comment>
232 <name>thankyou_footer
</name>
233 <title>Thank-you Footer
</title>
235 <htmlType>textarea
</htmlType>
238 <localizable>true
</localizable>
239 <comment>Text and html allowed. displayed at the bottom of the success page. Common usage is to include link(s) to other pages such as tell-a-friend, etc.
</comment>
243 <name>is_for_organization
</name>
245 <comment>if true, signup is done on behalf of an organization
</comment>
250 <name>for_organization
</name>
251 <title>On Behalf Of Organization
</title>
253 <htmlType>textarea
</htmlType>
256 <localizable>true
</localizable>
257 <comment>This text field is shown when is_for_organization is checked. For example - I am contributing on behalf on an organization.
</comment>
261 <name>is_email_receipt
</name>
263 <comment>if true, receipt is automatically emailed to contact on success
</comment>
268 <name>receipt_from_name
</name>
271 <localizable>true
</localizable>
272 <comment>FROM email name used for receipts generated by contributions to this contribution page.
</comment>
276 <name>receipt_from_email
</name>
279 <comment>FROM email address used for receipts generated by contributions to this contribution page.
</comment>
283 <name>cc_receipt
</name>
286 <comment>comma-separated list of email addresses to cc each time a receipt is sent
</comment>
290 <name>bcc_receipt
</name>
293 <comment>comma-separated list of email addresses to bcc each time a receipt is sent
</comment>
297 <name>receipt_text
</name>
299 <htmlType>textarea
</htmlType>
302 <localizable>true
</localizable>
303 <comment>text to include above standard receipt info on receipt email. emails are text-only, so do not allow html for now
</comment>
307 <name>is_active
</name>
309 <comment>Is this property active?
</comment>
313 <name>footer_text
</name>
315 <htmlType>textarea
</htmlType>
318 <localizable>true
</localizable>
319 <comment>Text and html allowed. Displayed at the bottom of the first page of the contribution wizard.
</comment>
323 <name>amount_block_is_active
</name>
325 <comment>Is this property active?
</comment>
330 <name>honor_block_is_active
</name>
332 <comment>Should this contribution have the honor block enabled?
</comment>
336 <name>honor_block_title
</name>
339 <localizable>true
</localizable>
340 <comment>Title for honor block.
</comment>
344 <name>honor_block_text
</name>
346 <htmlType>textarea
</htmlType>
349 <localizable>true
</localizable>
350 <comment>text for honor block.
</comment>
354 <name>start_date
</name>
355 <type>datetime
</type>
356 <title>Contribution Page Start Date
</title>
357 <comment>Date and time that this page starts.
</comment>
361 <name>end_date
</name>
362 <type>datetime
</type>
363 <title>Contribution Page End Date
</title>
364 <comment>Date and time that this page ends. May be NULL if no defined end date/time
</comment>
368 <name>created_id
</name>
369 <type>int unsigned
</type>
370 <comment>FK to civicrm_contact, who created this contribution page
</comment>
374 <name>created_id
</name>
375 <table>civicrm_contact
</table>
378 <onDelete>SET NULL
</onDelete>
381 <name>created_date
</name>
382 <type>datetime
</type>
383 <title>Contribution Page Created Date
</title>
384 <comment>Date and time that contribution page was created.
</comment>
388 <name>currency
</name>
391 <default>NULL
</default>
392 <headerPattern>/cur(rency)?/i
</headerPattern>
393 <dataPattern>/^[A-Z]{
3}$/i
</dataPattern>
394 <comment>3 character string, value from config setting or input via user.
</comment>
397 <table>civicrm_currency
</table>
398 <keyColumn>name
</keyColumn>
399 <labelColumn>full_name
</labelColumn>
400 <nameColumn>numeric_code
</nameColumn>
404 <name>campaign_id
</name>
405 <type>int unsigned
</type>
406 <comment>The campaign for which we are collecting contributions with this page.
</comment>
410 <name>campaign_id
</name>
411 <table>civicrm_campaign
</table>
413 <onDelete>SET NULL
</onDelete>
416 <name>is_share
</name>
419 <comment>Can people share the contribution page through social media?
</comment>