3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
35 * Page for displaying list of message templates.
37 class CRM_Admin_Page_MessageTemplates
extends CRM_Core_Page_Basic
{
40 * The action links that we need to display for the browse screen.
44 static $_links = NULL;
46 // ids of templates which diverted from the default ones and can be reverted
47 protected $_revertible = array();
49 // set to the id that we’re reverting at the given moment (if we are)
50 protected $_revertedId;
56 public function __construct($title = NULL, $mode = NULL) {
57 parent
::__construct($title, $mode);
59 // fetch the ids of templates which diverted from defaults and can be reverted –
60 // these templates have the same workflow_id as the defaults; defaults are reserved
62 SELECT diverted.id, orig.id orig_id
63 FROM civicrm_msg_template diverted JOIN civicrm_msg_template orig ON (
64 diverted.workflow_id = orig.workflow_id AND
65 orig.is_reserved = 1 AND (
66 diverted.msg_subject != orig.msg_subject OR
67 diverted.msg_text != orig.msg_text OR
68 diverted.msg_html != orig.msg_html
72 $dao = CRM_Core_DAO
::executeQuery($sql);
73 while ($dao->fetch()) {
74 $this->_revertible
[$dao->id
] = $dao->orig_id
;
84 public function getBAOName() {
85 return 'CRM_Core_BAO_MessageTemplate';
92 * (reference) of action links
94 public function &links() {
95 if (!(self
::$_links)) {
96 $confirm = ts('Are you sure you want to revert this template to the default for this workflow? You will lose any customizations you have made.', array('escape' => 'js')) . '\n\n' . ts('We recommend that you save a copy of the your customized Text and HTML message content to a text file before reverting so you can combine your changes with the system default messages as needed.', array('escape' => 'js'));
97 self
::$_links = array(
98 CRM_Core_Action
::UPDATE
=> array(
100 'url' => 'civicrm/admin/messageTemplates/add',
101 'qs' => 'action=update&id=%%id%%&reset=1',
102 'title' => ts('Edit this message template'),
104 CRM_Core_Action
::DISABLE
=> array(
105 'name' => ts('Disable'),
106 'ref' => 'crm-enable-disable',
107 'title' => ts('Disable this message template'),
109 CRM_Core_Action
::ENABLE
=> array(
110 'name' => ts('Enable'),
111 'ref' => 'crm-enable-disable',
112 'title' => ts('Enable this message template'),
114 CRM_Core_Action
::DELETE
=> array(
115 'name' => ts('Delete'),
116 'url' => 'civicrm/admin/messageTemplates',
117 'qs' => 'action=delete&id=%%id%%',
118 'title' => ts('Delete this message template'),
120 CRM_Core_Action
::REVERT
=> array(
121 'name' => ts('Revert to Default'),
122 'extra' => "onclick = 'return confirm(\"$confirm\");'",
123 'url' => 'civicrm/admin/messageTemplates',
124 'qs' => 'action=revert&id=%%id%%&selectedChild=workflow',
125 'title' => ts('Revert this workflow message template to the system default'),
127 CRM_Core_Action
::VIEW
=> array(
128 'name' => ts('View Default'),
129 'url' => 'civicrm/admin/messageTemplates',
130 'qs' => 'action=view&id=%%orig_id%%&reset=1',
131 'title' => ts('View the system default for this workflow message template'),
135 return self
::$_links;
139 * @param CRM_Core_DAO $object
141 * @param array $values
142 * @param array $links
143 * @param string $permission
144 * @param bool $forceAction
146 public function action(&$object, $action, &$values, &$links, $permission, $forceAction = FALSE) {
147 if ($object->workflow_id
) {
148 // do not expose action link for reverting to default if the template did not diverge or we just reverted it now
149 if (!in_array($object->id
, array_keys($this->_revertible
)) or
150 ($this->_action
& CRM_Core_Action
::REVERT
and $object->id
== $this->_revertedId
)
152 $action &= ~CRM_Core_Action
::REVERT
;
153 $action &= ~CRM_Core_Action
::VIEW
;
156 // default workflow templates shouldn’t be deletable
157 // workflow templates shouldn’t have disable/enable actions (at least for CiviCRM 3.1)
158 if ($object->workflow_id
) {
159 $action &= ~CRM_Core_Action
::DISABLE
;
160 $action &= ~CRM_Core_Action
::DELETE
;
163 // rebuild the action links HTML, as we need to handle %%orig_id%% for revertible templates
164 $values['action'] = CRM_Core_Action
::formLink($links, $action, array(
166 'orig_id' => CRM_Utils_Array
::value($object->id
, $this->_revertible
),
170 'messageTemplate.manage.action',
176 $action &= ~CRM_Core_Action
::REVERT
;
177 $action &= ~CRM_Core_Action
::VIEW
;
178 parent
::action($object, $action, $values, $links, $permission);
184 * @param null $pageArgs
189 public function run($args = NULL, $pageArgs = NULL, $sort = NULL) {
190 // handle the revert action and offload the rest to parent
191 if (CRM_Utils_Request
::retrieve('action', 'String', $this) & CRM_Core_Action
::REVERT
) {
193 $id = CRM_Utils_Request
::retrieve('id', 'Positive', $this);
194 if (!$this->checkPermission($id, NULL)) {
195 CRM_Core_Error
::fatal(ts('You do not have permission to revert this template.'));
198 $this->_revertedId
= $id;
200 CRM_Core_BAO_MessageTemplate
::revert($id);
202 $selectedChild = CRM_Utils_Request
::retrieve('selectedChild', 'String', $this);
203 if (in_array($selectedChild, array('user', 'workflow'))) {
204 $this->assign('selectedChild', $selectedChild);
206 return parent
::run($args, $pageArgs, $sort);
210 * Get name of edit form.
213 * Classname of edit form.
215 public function editForm() {
216 return 'CRM_Admin_Form_MessageTemplates';
220 * Get edit form name.
225 public function editName() {
226 return ts('Message Template');
237 public function userContext($mode = NULL) {
238 return 'civicrm/admin/messageTemplates';
242 * Browse all entities.
244 public function browse() {
245 $action = func_num_args() ?
func_get_arg(0) : NULL;
246 if ($this->_action
& CRM_Core_Action
::ADD
) {
249 $links = $this->links();
250 if ($action == NULL) {
251 if (!empty($links)) {
252 $action = array_sum(array_keys($links));
256 if ($action & CRM_Core_Action
::DISABLE
) {
257 $action -= CRM_Core_Action
::DISABLE
;
260 if ($action & CRM_Core_Action
::ENABLE
) {
261 $action -= CRM_Core_Action
::ENABLE
;
264 $messageTemplate = new CRM_Core_BAO_MessageTemplate();
265 $messageTemplate->orderBy('msg_title' . ' asc');
267 $userTemplates = array();
268 $workflowTemplates = array();
271 $messageTemplate->find();
272 while ($messageTemplate->fetch()) {
273 $values[$messageTemplate->id
] = array();
274 CRM_Core_DAO
::storeValues($messageTemplate, $values[$messageTemplate->id
]);
275 // populate action links
276 $this->action($messageTemplate, $action, $values[$messageTemplate->id
], $links, CRM_Core_Permission
::EDIT
);
278 if (!$messageTemplate->workflow_id
) {
279 $userTemplates[$messageTemplate->id
] = $values[$messageTemplate->id
];
281 elseif (!$messageTemplate->is_reserved
) {
282 $workflowTemplates[$messageTemplate->id
] = $values[$messageTemplate->id
];
287 'userTemplates' => $userTemplates,
288 'workflowTemplates' => $workflowTemplates,
291 $this->assign('rows', $rows);