Merge remote-tracking branch 'upstream/4.5' into 4.5-master-2014-12-22-22-01-44
[civicrm-core.git] / CRM / Contribute / Form / ContributionPage / ThankYou.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
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 * @access public
46 *
47 * @return void
48 */
49 function setDefaultValues() {
50 $title = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage', $this->_id, 'title');
51 CRM_Utils_System::setTitle(ts('Thank-you and Receipting') . " ($title)");
52 return parent::setDefaultValues();
53 }
54
55 /**
56 * Build the form object
57 *
58 * @return void
59 * @access public
60 */
61 public function buildQuickForm() {
62 $this->registerRule('emailList', 'callback', 'emailList', 'CRM_Utils_Rule');
63
64 // thank you title and text (html allowed in text)
65 $this->add('text', 'thankyou_title', ts('Thank-you Page Title'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionPage', 'thankyou_title'), TRUE);
66
67 $attributes = CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionPage', 'thankyou_text');
68 $attributes['click_wysiwyg'] = true;
69 $this->addWysiwyg('thankyou_text', ts('Thank-you Message'), $attributes);
70 // FIXME: This hack forces height of editor to 175px. Need to modify QF classes for editors to allow passing
71 // explicit height and width.
72 $footerAttribs = array(
73 'rows' => 2,
74 'cols' => 40,
75 'click_wysiwyg' => true,
76 );
77 $this->addWysiwyg('thankyou_footer', ts('Thank-you Footer'), $footerAttribs);
78
79 $this->addElement('checkbox', 'is_email_receipt', ts('Email Receipt to Contributor?'), NULL, array('onclick' => "showReceipt()"));
80 $this->add('text', 'receipt_from_name', ts('Receipt From Name'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionPage', 'receipt_from_name'));
81 $this->add('text', 'receipt_from_email', ts('Receipt From Email'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionPage', 'receipt_from_email'));
82 $this->add('textarea', 'receipt_text', ts('Receipt Message'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionPage', 'receipt_text'));
83
84 $this->add('text', 'cc_receipt', ts('CC Receipt To'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionPage', 'cc_receipt'));
85 $this->addRule('cc_receipt', ts('Please enter a valid list of comma delimited email addresses'), 'emailList');
86
87 $this->add('text', 'bcc_receipt', ts('BCC Receipt To'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionPage', 'bcc_receipt'));
88 $this->addRule('bcc_receipt', ts('Please enter a valid list of comma delimited email addresses'), 'emailList');
89
90 parent::buildQuickForm();
91 $this->addFormRule(array('CRM_Contribute_Form_ContributionPage_ThankYou', 'formRule'), $this);
92 }
93
94 /**
95 * Global form rule
96 *
97 * @param array $fields the input form values
98 * @param array $files the uploaded files if any
99 * @param array $options additional user data
100 *
101 * @return true if no errors, else array of errors
102 * @access public
103 * @static
104 */
105 static function formRule($fields, $files, $options) {
106 $errors = array();
107
108 // if is_email_receipt is set, the receipt message must be non-empty
109 if (!empty($fields['is_email_receipt'])) {
110 //added for CRM-1348
111 $email = trim(CRM_Utils_Array::value('receipt_from_email', $fields));
112 if (empty($email) || !CRM_Utils_Rule::email($email)) {
113 $errors['receipt_from_email'] = ts('A valid Receipt From Email address must be specified if Email Receipt to Contributor is enabled');
114 }
115 }
116 return $errors;
117 }
118
119 /**
120 * Process the form
121 *
122 * @return void
123 * @access public
124 */
125 public function postProcess() {
126 // get the submitted form values.
127 $params = $this->controller->exportValues($this->_name);
128
129 $params['id'] = $this->_id;
130 $params['is_email_receipt'] = CRM_Utils_Array::value('is_email_receipt', $params, FALSE);
131 if (!$params['is_email_receipt']) {
132 $params['receipt_from_name'] = NULL;
133 $params['receipt_from_email'] = NULL;
134 $params['receipt_text'] = NULL;
135 $params['cc_receipt'] = NULL;
136 $params['bcc_receipt'] = NULL;
137 }
138
139 $dao = CRM_Contribute_BAO_ContributionPage::create($params);
140 parent::endPostProcess();
141 }
142
143 /**
144 * Return a descriptive name for the page, used in wizard header
145 *
146 * @return string
147 * @access public
148 */
149 public function getTitle() {
150 return ts('Thanks and Receipt');
151 }
152 }
153