3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
37 * Page for displaying list of message templates
39 class CRM_Admin_Page_MessageTemplates
extends CRM_Core_Page_Basic
{
41 public $useLivePageJS = TRUE;
44 * The action links that we need to display for the browse screen
49 static $_links = NULL;
51 // ids of templates which diverted from the default ones and can be reverted
52 protected $_revertible = array();
54 // set to the id that we’re reverting at the given moment (if we are)
55 protected $_revertedId;
57 function __construct($title = NULL, $mode = NULL) {
58 parent
::__construct($title, $mode);
60 // fetch the ids of templates which diverted from defaults and can be reverted –
61 // these templates have the same workflow_id as the defaults; defaults are reserved
63 SELECT diverted.id, orig.id orig_id
64 FROM civicrm_msg_template diverted JOIN civicrm_msg_template orig ON (
65 diverted.workflow_id = orig.workflow_id AND
66 orig.is_reserved = 1 AND (
67 diverted.msg_subject != orig.msg_subject OR
68 diverted.msg_text != orig.msg_text OR
69 diverted.msg_html != orig.msg_html
73 $dao = CRM_Core_DAO
::executeQuery($sql);
74 while ($dao->fetch()) {
75 $this->_revertible
[$dao->id
] = $dao->orig_id
;
82 * @return string Classname of BAO.
84 function getBAOName() {
85 return 'CRM_Core_BAO_MessageTemplate';
91 * @return array (reference) of action links
94 if (!(self
::$_links)) {
95 $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'));
96 self
::$_links = array(
97 CRM_Core_Action
::UPDATE
=> array(
99 'url' => 'civicrm/admin/messageTemplates/add',
100 'qs' => 'action=update&id=%%id%%&reset=1',
101 'title' => ts('Edit this message template'),
103 CRM_Core_Action
::DISABLE
=> array(
104 'name' => ts('Disable'),
105 'ref' => 'crm-enable-disable',
106 'title' => ts('Disable this message template'),
108 CRM_Core_Action
::ENABLE
=> array(
109 'name' => ts('Enable'),
110 'ref' => 'crm-enable-disable',
111 'title' => ts('Enable this message template'),
113 CRM_Core_Action
::DELETE
=> array(
114 'name' => ts('Delete'),
115 'url' => 'civicrm/admin/messageTemplates',
116 'qs' => 'action=delete&id=%%id%%',
117 'title' => ts('Delete this message template'),
119 CRM_Core_Action
::REVERT
=> array(
120 'name' => ts('Revert to Default'),
121 'extra' => "onclick = 'return confirm(\"$confirm\");'",
122 'url' => 'civicrm/admin/messageTemplates',
123 'qs' => 'action=revert&id=%%id%%&selectedChild=workflow',
124 'title' => ts('Revert this workflow message template to the system default'),
126 CRM_Core_Action
::VIEW
=> array(
127 'name' => ts('View Default'),
128 'url' => 'civicrm/admin/messageTemplates',
129 'qs' => 'action=view&id=%%orig_id%%&reset=1',
130 'title' => ts('View the system default for this workflow message template'),
134 return self
::$_links;
137 function action(&$object, $action, &$values, &$links, $permission, $forceAction = FALSE) {
138 if ($object->workflow_id
) {
139 // do not expose action link for reverting to default if the template did not diverge or we just reverted it now
140 if (!in_array($object->id
, array_keys($this->_revertible
)) or
141 ($this->_action
& CRM_Core_Action
::REVERT
and $object->id
== $this->_revertedId
)
143 $action &= ~CRM_Core_Action
::REVERT
;
144 $action &= ~CRM_Core_Action
::VIEW
;
147 // default workflow templates shouldn’t be deletable
148 // workflow templates shouldn’t have disable/enable actions (at least for CiviCRM 3.1)
149 if ($object->workflow_id
) {
150 $action &= ~CRM_Core_Action
::DISABLE
;
151 $action &= ~CRM_Core_Action
::DELETE
;
154 // rebuild the action links HTML, as we need to handle %%orig_id%% for revertible templates
155 $values['action'] = CRM_Core_Action
::formLink($links, $action, array(
157 'orig_id' => CRM_Utils_Array
::value($object->id
, $this->_revertible
),
161 'messageTemplate.manage.action',
167 $action &= ~CRM_Core_Action
::REVERT
;
168 $action &= ~CRM_Core_Action
::VIEW
;
169 parent
::action($object, $action, $values, $links, $permission);
173 function run($args = NULL, $pageArgs = NULL, $sort = NULL) {
174 // handle the revert action and offload the rest to parent
175 if (CRM_Utils_Request
::retrieve('action', 'String', $this) & CRM_Core_Action
::REVERT
) {
177 $id = CRM_Utils_Request
::retrieve('id', 'Positive', $this);
178 if (!$this->checkPermission($id, NULL)) {
179 CRM_Core_Error
::fatal(ts('You do not have permission to revert this template.'));
182 $this->_revertedId
= $id;
184 CRM_Core_BAO_MessageTemplate
::revert($id);
187 $this->assign('selectedChild', CRM_Utils_Request
::retrieve('selectedChild', 'String', $this));
189 return parent
::run($args, $pageArgs, $sort);
193 * Get name of edit form
195 * @return string Classname of edit form.
197 function editForm() {
198 return 'CRM_Admin_Form_MessageTemplates';
204 * @return string name of this page.
206 function editName() {
207 return ts('Message Template');
213 * @return string user context.
215 function userContext($mode = NULL) {
216 return 'civicrm/admin/messageTemplates';
220 * browse all entities.
228 $action = func_num_args() ?
func_get_arg(0) : NULL;
229 if ($this->_action
& CRM_Core_Action
::ADD
) {
232 $links = $this->links();
233 if ($action == NULL) {
234 if (!empty($links)) {
235 $action = array_sum(array_keys($links));
239 if ($action & CRM_Core_Action
::DISABLE
) {
240 $action -= CRM_Core_Action
::DISABLE
;
243 if ($action & CRM_Core_Action
::ENABLE
) {
244 $action -= CRM_Core_Action
::ENABLE
;
247 $messageTemplate = new CRM_Core_BAO_MessageTemplate();
248 $messageTemplate->orderBy('msg_title' . ' asc');
250 $userTemplates = array();
251 $workflowTemplates = array();
254 $messageTemplate->find();
255 while ($messageTemplate->fetch()) {
256 $values[$messageTemplate->id
] = array();
257 CRM_Core_DAO
::storeValues($messageTemplate, $values[$messageTemplate->id
]);
258 // populate action links
259 $this->action($messageTemplate, $action, $values[$messageTemplate->id
], $links, CRM_Core_Permission
::EDIT
);
261 if (!$messageTemplate->workflow_id
) {
262 $userTemplates[$messageTemplate->id
] = $values[$messageTemplate->id
];
264 elseif (!$messageTemplate->is_reserved
) {
265 $workflowTemplates[$messageTemplate->id
] = $values[$messageTemplate->id
];
270 'userTemplates' => $userTemplates,
271 'workflowTemplates' => $workflowTemplates,
274 $this->assign('rows', $rows);