Merge pull request #4696 from colemanw/CRM-15669
[civicrm-core.git] / CRM / Contribute / Form / ContributionPage / ThankYou.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
9 | |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
13 | |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
18 | |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
26 */
27
28 /**
29 *
30 * @package CRM
31 * @copyright CiviCRM LLC (c) 2004-2014
32 * $Id$
33 *
34 */
35
36 /**
37 * form to configure thank-you messages and receipting features for an online contribution page
38 */
39 class CRM_Contribute_Form_ContributionPage_ThankYou extends CRM_Contribute_Form_ContributionPage {
40
41 /**
42 * Set default values for the form. Note that in edit/view mode
43 * the default values are retrieved from the database
44 *
45 *
46 * @return void
47 */
48 public function setDefaultValues() {
49 $title = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage', $this->_id, 'title');
50 CRM_Utils_System::setTitle(ts('Thank-you and Receipting') . " ($title)");
51 return parent::setDefaultValues();
52 }
53
54 /**
55 * Build the form object
56 *
57 * @return void
58 */
59 public function buildQuickForm() {
60 $this->registerRule('emailList', 'callback', 'emailList', 'CRM_Utils_Rule');
61
62 // thank you title and text (html allowed in text)
63 $this->add('text', 'thankyou_title', ts('Thank-you Page Title'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionPage', 'thankyou_title'), TRUE);
64
65 $attributes = CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionPage', 'thankyou_text');
66 $attributes['click_wysiwyg'] = true;
67 $this->addWysiwyg('thankyou_text', ts('Thank-you Message'), $attributes);
68 // FIXME: This hack forces height of editor to 175px. Need to modify QF classes for editors to allow passing
69 // explicit height and width.
70 $footerAttribs = array(
71 'rows' => 2,
72 'cols' => 40,
73 'click_wysiwyg' => true,
74 );
75 $this->addWysiwyg('thankyou_footer', ts('Thank-you Footer'), $footerAttribs);
76
77 $this->addElement('checkbox', 'is_email_receipt', ts('Email Receipt to Contributor?'), NULL, array('onclick' => "showReceipt()"));
78 $this->add('text', 'receipt_from_name', ts('Receipt From Name'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionPage', 'receipt_from_name'));
79 $this->add('text', 'receipt_from_email', ts('Receipt From Email'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionPage', 'receipt_from_email'));
80 $this->add('textarea', 'receipt_text', ts('Receipt Message'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionPage', 'receipt_text'));
81
82 $this->add('text', 'cc_receipt', ts('CC Receipt To'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionPage', 'cc_receipt'));
83 $this->addRule('cc_receipt', ts('Please enter a valid list of comma delimited email addresses'), 'emailList');
84
85 $this->add('text', 'bcc_receipt', ts('BCC Receipt To'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionPage', 'bcc_receipt'));
86 $this->addRule('bcc_receipt', ts('Please enter a valid list of comma delimited email addresses'), 'emailList');
87
88 parent::buildQuickForm();
89 $this->addFormRule(array('CRM_Contribute_Form_ContributionPage_ThankYou', 'formRule'), $this);
90 }
91
92 /**
93 * Global form rule
94 *
95 * @param array $fields the input form values
96 * @param array $files the uploaded files if any
97 * @param array $options additional user data
98 *
99 * @return true if no errors, else array of errors
100 * @static
101 */
102 public static function formRule($fields, $files, $options) {
103 $errors = array();
104
105 // if is_email_receipt is set, the receipt message must be non-empty
106 if (!empty($fields['is_email_receipt'])) {
107 //added for CRM-1348
108 $email = trim(CRM_Utils_Array::value('receipt_from_email', $fields));
109 if (empty($email) || !CRM_Utils_Rule::email($email)) {
110 $errors['receipt_from_email'] = ts('A valid Receipt From Email address must be specified if Email Receipt to Contributor is enabled');
111 }
112 }
113 return $errors;
114 }
115
116 /**
117 * Process the form
118 *
119 * @return void
120 */
121 public function postProcess() {
122 // get the submitted form values.
123 $params = $this->controller->exportValues($this->_name);
124
125 $params['id'] = $this->_id;
126 $params['is_email_receipt'] = CRM_Utils_Array::value('is_email_receipt', $params, FALSE);
127 if (!$params['is_email_receipt']) {
128 $params['receipt_from_name'] = NULL;
129 $params['receipt_from_email'] = NULL;
130 $params['receipt_text'] = NULL;
131 $params['cc_receipt'] = NULL;
132 $params['bcc_receipt'] = NULL;
133 }
134
135 $dao = CRM_Contribute_BAO_ContributionPage::create($params);
136 parent::endPostProcess();
137 }
138
139 /**
140 * Return a descriptive name for the page, used in wizard header
141 *
142 * @return string
143 */
144 public function getTitle() {
145 return ts('Thanks and Receipt');
146 }
147 }