3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * Class for mailing form task actions.
20 * FIXME: This needs refactoring to properly inherit from CRM_Core_Form_Task and share more functions.
22 class CRM_Mailing_Form_Task
extends CRM_Core_Form_Task
{
25 * Build all the data structures needed to build the form.
27 public function preProcess() {
28 self
::preProcessCommon($this);
32 * @param \CRM_Core_Form_Task $form
34 * @throws \CRM_Core_Exception
36 public static function preProcessCommon(&$form) {
37 $values = $form->getSearchFormValues();
39 $form->_task
= $values['task'] ??
NULL;
40 $mailingTasks = CRM_Mailing_Task
::tasks();
41 $form->assign('taskName', CRM_Utils_Array
::value('task', $values));
43 // ids are mailing event queue ids
45 if ($values['radio_ts'] == 'ts_sel') {
46 foreach ($values as $name => $value) {
47 if (substr($name, 0, CRM_Core_Form
::CB_PREFIX_LEN
) == CRM_Core_Form
::CB_PREFIX
) {
48 $ids[] = substr($name, CRM_Core_Form
::CB_PREFIX_LEN
);
53 $queryParams = $form->get('queryParams');
55 if ($form->get(CRM_Utils_Sort
::SORT_ORDER
)) {
56 $sortOrder = $form->get(CRM_Utils_Sort
::SORT_ORDER
);
59 $query = new CRM_Contact_BAO_Query($queryParams, NULL, NULL, FALSE, FALSE,
60 CRM_Contact_BAO_Query
::MODE_MAILING
63 $result = $query->searchQuery(0, 0, $sortOrder);
64 while ($result->fetch()) {
65 $ids[] = $result->mailing_recipients_id
;
67 $form->assign('totalSelectedMailingRecipients', $form->get('rowCount'));
71 $form->_componentClause
= ' civicrm_mailing_recipients.id IN ( ' . implode(',', $ids) . ' ) ';
74 // set the context for redirection for any task actions
75 $session = CRM_Core_Session
::singleton();
78 if ($form->_action
== CRM_Core_Action
::ADVANCED
) {
79 $fragment .= '/advanced';
82 $qfKey = CRM_Utils_Request
::retrieve('qfKey', 'String', $form);
83 $urlParams = 'force=1';
84 if (CRM_Utils_Rule
::qfKey($qfKey)) {
85 $urlParams .= "&qfKey=$qfKey";
88 $url = CRM_Utils_System
::url('civicrm/contact/' . $fragment, $urlParams);
89 $session = CRM_Core_Session
::singleton();
90 $session->replaceUserContext($url);
94 * Simple shell that derived classes can call to add buttons to
95 * the form with a customized title for the main Submit
97 * @param string $title
98 * Title of the main button.
99 * @param string $nextType
100 * @param string $backType
101 * @param bool $submitOnce
103 public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
112 'name' => ts('Cancel'),