3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * Form to configure thank-you messages and receipting features for an online contribution page.
21 class CRM_Contribute_Form_ContributionPage_ThankYou
extends CRM_Contribute_Form_ContributionPage
{
24 * Set variables up before form is built.
26 public function preProcess() {
28 $this->setSelectedChild('thankyou');
32 * Set default values for the form.
34 * Note that in edit/view mode the default values are retrieved from the database.
36 public function setDefaultValues() {
37 return parent
::setDefaultValues();
41 * Build the form object.
43 public function buildQuickForm() {
44 $this->registerRule('emailList', 'callback', 'emailList', 'CRM_Utils_Rule');
46 // thank you title and text (html allowed in text)
47 $this->add('text', 'thankyou_title', ts('Thank-you Page Title'), CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_ContributionPage', 'thankyou_title'), TRUE);
49 $attributes = CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_ContributionPage', 'thankyou_text') +
['class' => 'collapsed'];
50 $this->add('wysiwyg', 'thankyou_text', ts('Thank-you Message'), $attributes);
51 $this->add('wysiwyg', 'thankyou_footer', ts('Thank-you Footer'), $attributes);
53 $this->addElement('checkbox', 'is_email_receipt', ts('Email Receipt to Contributor?'), NULL, ['onclick' => "showReceipt()"]);
54 $this->add('text', 'receipt_from_name', ts('Receipt From Name'), CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_ContributionPage', 'receipt_from_name'));
55 $this->add('text', 'receipt_from_email', ts('Receipt From Email'), CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_ContributionPage', 'receipt_from_email'));
56 $this->add('textarea', 'receipt_text', ts('Receipt Message'), CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_ContributionPage', 'receipt_text'));
58 $this->add('text', 'cc_receipt', ts('CC Receipt To'), CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_ContributionPage', 'cc_receipt'));
59 $this->addRule('cc_receipt', ts('Please enter a valid list of comma delimited email addresses'), 'emailList');
61 $this->add('text', 'bcc_receipt', ts('BCC Receipt To'), CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_ContributionPage', 'bcc_receipt'));
62 $this->addRule('bcc_receipt', ts('Please enter a valid list of comma delimited email addresses'), 'emailList');
64 parent
::buildQuickForm();
65 $this->addFormRule(['CRM_Contribute_Form_ContributionPage_ThankYou', 'formRule'], $this);
71 * @param array $fields
72 * The input form values.
74 * The uploaded files if any.
75 * @param array $options
76 * Additional user data.
79 * true if no errors, else array of errors
81 public static function formRule($fields, $files, $options) {
84 // if is_email_receipt is set, the receipt message must be non-empty
85 if (!empty($fields['is_email_receipt'])) {
87 $email = trim(CRM_Utils_Array
::value('receipt_from_email', $fields));
88 if (empty($email) ||
!CRM_Utils_Rule
::email($email)) {
89 $errors['receipt_from_email'] = ts('A valid Receipt From Email address must be specified if Email Receipt to Contributor is enabled');
98 public function postProcess() {
99 // get the submitted form values.
100 $params = $this->controller
->exportValues($this->_name
);
102 $params['id'] = $this->_id
;
103 $params['is_email_receipt'] = CRM_Utils_Array
::value('is_email_receipt', $params, FALSE);
104 if (!$params['is_email_receipt']) {
105 $params['receipt_from_name'] = NULL;
106 $params['receipt_from_email'] = NULL;
107 $params['receipt_text'] = NULL;
108 $params['cc_receipt'] = NULL;
109 $params['bcc_receipt'] = NULL;
112 $dao = CRM_Contribute_BAO_ContributionPage
::create($params);
113 parent
::endPostProcess();
117 * Return a descriptive name for the page, used in wizard header
121 public function getTitle() {
122 return ts('Thanks and Receipt');