3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2015
37 * This class generates form components for Message templates
38 * used by membership, contributions, event registrations, etc.
41 class CRM_Admin_Form_MessageTemplates
extends CRM_Admin_Form
{
42 // which (and whether) mailing workflow this template belongs to
43 protected $_workflow_id = NULL;
45 public function preProcess() {
46 $this->_id
= CRM_Utils_Request
::retrieve('id', 'Positive', $this);
47 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String',
50 $this->assign('action', $this->_action
);
52 $this->_BAOName
= 'CRM_Core_BAO_MessageTemplate';
53 $this->set('BAOName', $this->_BAOName
);
58 * Set default values for the form.
59 * The default values are retrieved from the database.
64 public function setDefaultValues() {
65 $defaults = $this->_values
;
67 if (empty($defaults['pdf_format_id'])) {
68 $defaults['pdf_format_id'] = 'null';
71 $this->_workflow_id
= CRM_Utils_Array
::value('workflow_id', $defaults);
72 $this->assign('workflow_id', $this->_workflow_id
);
73 if ($this->_action
& CRM_Core_Action
::ADD
) {
74 $defaults['is_active'] = 1;
75 //set the context for redirection after form submit or cancel
76 $session = CRM_Core_Session
::singleton();
77 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/admin/messageTemplates',
78 'selectedChild=user&reset=1'
82 // FIXME: we need to fix the Cancel button here as we don’t know whether it’s a workflow template in buildQuickForm()
83 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
84 if ($this->_workflow_id
) {
85 $selectedChild = 'workflow';
88 $selectedChild = 'user';
90 $cancelURL = CRM_Utils_System
::url('civicrm/admin/messageTemplates', "selectedChild={$selectedChild}&reset=1");
91 $cancelURL = str_replace('&', '&', $cancelURL);
101 'name' => ts('Cancel'),
102 'js' => array('onclick' => "location.href='{$cancelURL}'; return false;"),
112 * Build the form object.
116 public function buildQuickForm() {
118 // For VIEW we only want Done button
119 if ($this->_action
& CRM_Core_Action
::VIEW
) {
120 // currently, the above action is used solely for previewing default workflow templates
121 $cancelURL = CRM_Utils_System
::url('civicrm/admin/messageTemplates', 'selectedChild=workflow&reset=1');
122 $cancelURL = str_replace('&', '&', $cancelURL);
123 $this->addButtons(array(
126 'name' => ts('Done'),
127 'js' => array('onclick' => "location.href='{$cancelURL}'; return false;"),
134 parent
::buildQuickForm();
137 if ($this->_action
& CRM_Core_Action
::DELETE
) {
143 'title' => ts('Message Templates'),
144 'url' => CRM_Utils_System
::url('civicrm/admin/messageTemplates',
145 'action=browse&reset=1'
149 CRM_Utils_System
::appendBreadCrumb($breadCrumb);
151 $this->applyFilter('__ALL__', 'trim');
152 $this->add('text', 'msg_title', ts('Message Title'), CRM_Core_DAO
::getAttribute('CRM_Core_DAO_MessageTemplate', 'msg_title'), TRUE);
154 $this->add('text', 'msg_subject',
155 ts('Message Subject'),
156 CRM_Core_DAO
::getAttribute('CRM_Core_DAO_MessageTemplate', 'msg_subject')
160 $tokens = CRM_Core_SelectValues
::contactTokens();
162 $this->assign('tokens', CRM_Utils_Token
::formatTokensForDisplay($tokens));
164 // if not a system message use a wysiwyg editor, CRM-5971
166 CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_MessageTemplate',
171 $this->add('textarea', 'msg_html', ts('HTML Message'),
176 $this->add('wysiwyg', 'msg_html', ts('HTML Message'),
180 'onkeyup' => "return verify(this)",
185 $this->add('textarea', 'msg_text', ts('Text Message'),
189 $this->add('select', 'pdf_format_id', ts('PDF Page Format'),
191 'null' => ts('- default -'),
192 ) + CRM_Core_BAO_PdfFormat
::getList(TRUE), FALSE
195 $this->add('checkbox', 'is_active', ts('Enabled?'));
197 if ($this->_action
& CRM_Core_Action
::VIEW
) {
199 CRM_Utils_System
::setTitle(ts('View System Default Message Template'));
204 * Process the form submission.
209 public function postProcess() {
210 if ($this->_action
& CRM_Core_Action
::DELETE
) {
211 CRM_Core_BAO_MessageTemplate
::del($this->_id
);
213 elseif ($this->_action
& CRM_Core_Action
::VIEW
) {
214 // currently, the above action is used solely for previewing default workflow templates
215 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/admin/messageTemplates', 'selectedChild=workflow&reset=1'));
220 // store the submitted values in an array
221 $params = $this->exportValues();
223 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
224 $params['id'] = $this->_id
;
227 if ($this->_workflow_id
) {
228 $params['workflow_id'] = $this->_workflow_id
;
229 $params['is_active'] = TRUE;
232 $messageTemplate = CRM_Core_BAO_MessageTemplate
::add($params);
233 CRM_Core_Session
::setStatus(ts('The Message Template \'%1\' has been saved.', array(1 => $messageTemplate->msg_title
)), ts('Saved'), 'success');
235 if ($this->_workflow_id
) {
236 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/admin/messageTemplates', 'selectedChild=workflow&reset=1'));
239 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/admin/messageTemplates', 'selectedChild=user&reset=1'));