3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
37 * Page for displaying list of message templates
39 class CRM_Admin_Page_MessageTemplates
extends CRM_Core_Page_Basic
{
42 * The action links that we need to display for the browse screen
47 static $_links = NULL;
49 // ids of templates which diverted from the default ones and can be reverted
50 protected $_revertible = array();
52 // set to the id that we’re reverting at the given moment (if we are)
53 protected $_revertedId;
59 function __construct($title = NULL, $mode = NULL) {
60 parent
::__construct($title, $mode);
62 // fetch the ids of templates which diverted from defaults and can be reverted –
63 // these templates have the same workflow_id as the defaults; defaults are reserved
65 SELECT diverted.id, orig.id orig_id
66 FROM civicrm_msg_template diverted JOIN civicrm_msg_template orig ON (
67 diverted.workflow_id = orig.workflow_id AND
68 orig.is_reserved = 1 AND (
69 diverted.msg_subject != orig.msg_subject OR
70 diverted.msg_text != orig.msg_text OR
71 diverted.msg_html != orig.msg_html
75 $dao = CRM_Core_DAO
::executeQuery($sql);
76 while ($dao->fetch()) {
77 $this->_revertible
[$dao->id
] = $dao->orig_id
;
84 * @return string Classname of BAO.
86 function getBAOName() {
87 return 'CRM_Core_BAO_MessageTemplate';
93 * @return array (reference) of action links
96 if (!(self
::$_links)) {
97 $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'));
98 self
::$_links = array(
99 CRM_Core_Action
::UPDATE
=> array(
100 'name' => ts('Edit'),
101 'url' => 'civicrm/admin/messageTemplates/add',
102 'qs' => 'action=update&id=%%id%%&reset=1',
103 'title' => ts('Edit this message template'),
105 CRM_Core_Action
::DISABLE
=> array(
106 'name' => ts('Disable'),
107 'ref' => 'crm-enable-disable',
108 'title' => ts('Disable this message template'),
110 CRM_Core_Action
::ENABLE
=> array(
111 'name' => ts('Enable'),
112 'ref' => 'crm-enable-disable',
113 'title' => ts('Enable this message template'),
115 CRM_Core_Action
::DELETE
=> array(
116 'name' => ts('Delete'),
117 'url' => 'civicrm/admin/messageTemplates',
118 'qs' => 'action=delete&id=%%id%%',
119 'title' => ts('Delete this message template'),
121 CRM_Core_Action
::REVERT
=> array(
122 'name' => ts('Revert to Default'),
123 'extra' => "onclick = 'return confirm(\"$confirm\");'",
124 'url' => 'civicrm/admin/messageTemplates',
125 'qs' => 'action=revert&id=%%id%%&selectedChild=workflow',
126 'title' => ts('Revert this workflow message template to the system default'),
128 CRM_Core_Action
::VIEW
=> array(
129 'name' => ts('View Default'),
130 'url' => 'civicrm/admin/messageTemplates',
131 'qs' => 'action=view&id=%%orig_id%%&reset=1',
132 'title' => ts('View the system default for this workflow message template'),
136 return self
::$_links;
140 * @param CRM_Core_DAO $object
142 * @param array $values
143 * @param array $links
144 * @param string $permission
145 * @param bool $forceAction
147 function action(&$object, $action, &$values, &$links, $permission, $forceAction = FALSE) {
148 if ($object->workflow_id
) {
149 // do not expose action link for reverting to default if the template did not diverge or we just reverted it now
150 if (!in_array($object->id
, array_keys($this->_revertible
)) or
151 ($this->_action
& CRM_Core_Action
::REVERT
and $object->id
== $this->_revertedId
)
153 $action &= ~CRM_Core_Action
::REVERT
;
154 $action &= ~CRM_Core_Action
::VIEW
;
157 // default workflow templates shouldn’t be deletable
158 // workflow templates shouldn’t have disable/enable actions (at least for CiviCRM 3.1)
159 if ($object->workflow_id
) {
160 $action &= ~CRM_Core_Action
::DISABLE
;
161 $action &= ~CRM_Core_Action
::DELETE
;
164 // rebuild the action links HTML, as we need to handle %%orig_id%% for revertible templates
165 $values['action'] = CRM_Core_Action
::formLink($links, $action, array(
167 'orig_id' => CRM_Utils_Array
::value($object->id
, $this->_revertible
),
171 'messageTemplate.manage.action',
177 $action &= ~CRM_Core_Action
::REVERT
;
178 $action &= ~CRM_Core_Action
::VIEW
;
179 parent
::action($object, $action, $values, $links, $permission);
185 * @param null $pageArgs
190 function run($args = NULL, $pageArgs = NULL, $sort = NULL) {
191 // handle the revert action and offload the rest to parent
192 if (CRM_Utils_Request
::retrieve('action', 'String', $this) & CRM_Core_Action
::REVERT
) {
194 $id = CRM_Utils_Request
::retrieve('id', 'Positive', $this);
195 if (!$this->checkPermission($id, NULL)) {
196 CRM_Core_Error
::fatal(ts('You do not have permission to revert this template.'));
199 $this->_revertedId
= $id;
201 CRM_Core_BAO_MessageTemplate
::revert($id);
204 $this->assign('selectedChild', CRM_Utils_Request
::retrieve('selectedChild', 'String', $this));
206 return parent
::run($args, $pageArgs, $sort);
210 * Get name of edit form
212 * @return string Classname of edit form.
214 function editForm() {
215 return 'CRM_Admin_Form_MessageTemplates';
221 * @return string name of this page.
223 function editName() {
224 return ts('Message Template');
232 * @return string user context.
234 function userContext($mode = NULL) {
235 return 'civicrm/admin/messageTemplates';
239 * browse all entities.
241 * @internal param int $action
247 $action = func_num_args() ?
func_get_arg(0) : NULL;
248 if ($this->_action
& CRM_Core_Action
::ADD
) {
251 $links = $this->links();
252 if ($action == NULL) {
253 if (!empty($links)) {
254 $action = array_sum(array_keys($links));
258 if ($action & CRM_Core_Action
::DISABLE
) {
259 $action -= CRM_Core_Action
::DISABLE
;
262 if ($action & CRM_Core_Action
::ENABLE
) {
263 $action -= CRM_Core_Action
::ENABLE
;
266 $messageTemplate = new CRM_Core_BAO_MessageTemplate();
267 $messageTemplate->orderBy('msg_title' . ' asc');
269 $userTemplates = array();
270 $workflowTemplates = array();
273 $messageTemplate->find();
274 while ($messageTemplate->fetch()) {
275 $values[$messageTemplate->id
] = array();
276 CRM_Core_DAO
::storeValues($messageTemplate, $values[$messageTemplate->id
]);
277 // populate action links
278 $this->action($messageTemplate, $action, $values[$messageTemplate->id
], $links, CRM_Core_Permission
::EDIT
);
280 if (!$messageTemplate->workflow_id
) {
281 $userTemplates[$messageTemplate->id
] = $values[$messageTemplate->id
];
283 elseif (!$messageTemplate->is_reserved
) {
284 $workflowTemplates[$messageTemplate->id
] = $values[$messageTemplate->id
];
289 'userTemplates' => $userTemplates,
290 'workflowTemplates' => $workflowTemplates,
293 $this->assign('rows', $rows);