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>
60 <name>financial_type_id
</name>
61 <table>civicrm_financial_type
</table>
66 <name>payment_processor
</name>
69 <comment>Payment Processors configured for this contribution Page
</comment>
73 <name>is_credit_card_only
</name>
75 <comment>if true - processing logic must reject transaction at confirmation stage if pay method != credit card
</comment>
80 <name>is_monetary
</name>
83 <comment>if true - allows real-time monetary transactions otherwise non-monetary transactions
</comment>
90 <comment>if true - allows recurring contributions, valid only for PayPal_Standard
</comment>
94 <name>is_confirm_enabled
</name>
97 <comment>if false, the confirm page in contribution pages gets skipped
</comment>
101 <name>recur_frequency_unit
</name>
104 <comment>Supported recurring frequency units.
</comment>
108 <name>is_recur_interval
</name>
111 <comment>if true - supports recurring intervals
</comment>
115 <name>is_recur_installments
</name>
118 <comment>if true - asks user for recurring installments
</comment>
122 <name>is_pay_later
</name>
125 <comment>if true - allows the user to send payment directly to the org later
</comment>
129 <name>pay_later_text
</name>
131 <localizable>true
</localizable>
132 <comment>The text displayed to the user in the main form
</comment>
136 <name>pay_later_receipt
</name>
138 <localizable>true
</localizable>
139 <comment>The receipt sent to the user instead of the normal receipt text
</comment>
143 <name>is_partial_payment
</name>
146 <comment>is partial payment enabled for this online contribution page
</comment>
150 <name>initial_amount_label
</name>
153 <localizable>true
</localizable>
154 <comment>Initial amount label for partial payment
</comment>
158 <name>initial_amount_help_text
</name>
160 <localizable>true
</localizable>
161 <comment>Initial amount help text for partial payment
</comment>
165 <name>min_initial_amount
</name>
167 <comment>Minimum initial amount for partial payment
</comment>
171 <name>is_allow_other_amount
</name>
173 <comment>if true, page will include an input text field where user can enter their own amount
</comment>
178 <name>default_amount_id
</name>
179 <type>int unsigned
</type>
180 <comment>FK to civicrm_option_value.
</comment>
184 <name>min_amount
</name>
186 <comment>if other amounts allowed, user can configure minimum allowed.
</comment>
190 <name>max_amount
</name>
192 <comment>if other amounts allowed, user can configure maximum allowed.
</comment>
196 <name>goal_amount
</name>
198 <comment>The target goal for this page, allows people to build a goal meter
</comment>
202 <name>thankyou_title
</name>
203 <title>Thank-you Title
</title>
206 <localizable>true
</localizable>
207 <comment>Title for Thank-you page (header title tag, and display at the top of the page).
</comment>
211 <name>thankyou_text
</name>
212 <title>Thank-you Text
</title>
214 <htmlType>textarea
</htmlType>
217 <localizable>true
</localizable>
218 <comment>text and html allowed. displayed above result on success page
</comment>
222 <name>thankyou_footer
</name>
223 <title>Thank-you Footer
</title>
225 <htmlType>textarea
</htmlType>
228 <localizable>true
</localizable>
229 <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>
233 <name>is_for_organization
</name>
235 <comment>if true, signup is done on behalf of an organization
</comment>
240 <name>for_organization
</name>
241 <title>On Behalf Of Organization
</title>
243 <htmlType>textarea
</htmlType>
246 <localizable>true
</localizable>
247 <comment>This text field is shown when is_for_organization is checked. For example - I am contributing on behalf on an organization.
</comment>
251 <name>is_email_receipt
</name>
253 <comment>if true, receipt is automatically emailed to contact on success
</comment>
258 <name>receipt_from_name
</name>
261 <localizable>true
</localizable>
262 <comment>FROM email name used for receipts generated by contributions to this contribution page.
</comment>
266 <name>receipt_from_email
</name>
269 <comment>FROM email address used for receipts generated by contributions to this contribution page.
</comment>
273 <name>cc_receipt
</name>
276 <comment>comma-separated list of email addresses to cc each time a receipt is sent
</comment>
280 <name>bcc_receipt
</name>
283 <comment>comma-separated list of email addresses to bcc each time a receipt is sent
</comment>
287 <name>receipt_text
</name>
289 <htmlType>textarea
</htmlType>
292 <localizable>true
</localizable>
293 <comment>text to include above standard receipt info on receipt email. emails are text-only, so do not allow html for now
</comment>
297 <name>is_active
</name>
299 <comment>Is this property active?
</comment>
303 <name>footer_text
</name>
305 <htmlType>textarea
</htmlType>
308 <localizable>true
</localizable>
309 <comment>Text and html allowed. Displayed at the bottom of the first page of the contribution wizard.
</comment>
313 <name>amount_block_is_active
</name>
315 <comment>Is this property active?
</comment>
320 <name>honor_block_is_active
</name>
322 <comment>Should this contribution have the honor block enabled?
</comment>
326 <name>honor_block_title
</name>
329 <localizable>true
</localizable>
330 <comment>Title for honor block.
</comment>
334 <name>honor_block_text
</name>
336 <htmlType>textarea
</htmlType>
339 <localizable>true
</localizable>
340 <comment>text for honor block.
</comment>
344 <name>start_date
</name>
345 <type>datetime
</type>
346 <title>Contribution Page Start Date
</title>
347 <comment>Date and time that this page starts.
</comment>
351 <name>end_date
</name>
352 <type>datetime
</type>
353 <title>Contribution Page End Date
</title>
354 <comment>Date and time that this page ends. May be NULL if no defined end date/time
</comment>
358 <name>created_id
</name>
359 <type>int unsigned
</type>
360 <comment>FK to civicrm_contact, who created this contribution page
</comment>
364 <name>created_id
</name>
365 <table>civicrm_contact
</table>
368 <onDelete>SET NULL
</onDelete>
371 <name>created_date
</name>
372 <type>datetime
</type>
373 <title>Contribution Page Created Date
</title>
374 <comment>Date and time that contribution page was created.
</comment>
378 <name>currency
</name>
381 <default>NULL
</default>
382 <headerPattern>/cur(rency)?/i
</headerPattern>
383 <dataPattern>/^[A-Z]{
3}$/i
</dataPattern>
384 <comment>3 character string, value from config setting or input via user.
</comment>
388 <name>campaign_id
</name>
389 <type>int unsigned
</type>
390 <comment>The campaign for which we are collecting contributions with this page.
</comment>
394 <name>campaign_id
</name>
395 <table>civicrm_campaign
</table>
397 <onDelete>SET NULL
</onDelete>
400 <name>is_share
</name>
403 <comment>Can people share the contribution page through social media?
</comment>