3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
35 * Class for contribute form task actions.
36 * FIXME: This needs refactoring to properly inherit from CRM_Core_Form_Task and share more functions.
38 class CRM_Contribute_Form_Task
extends CRM_Core_Form_Task
{
41 * The array that holds all the contribution ids.
45 protected $_contributionIds;
48 * The array that holds all the mapping contribution and contact ids.
52 protected $_contributionContactIds = [];
55 * The flag to tell if there are soft credits included.
59 public $_includesSoftCredits = FALSE;
62 * Build all the data structures needed to build the form.
64 public function preProcess() {
65 self
::preProcessCommon($this);
69 * @param CRM_Core_Form $form
71 public static function preProcessCommon(&$form) {
72 $form->_contributionIds
= [];
74 $values = $form->controller
->exportValues($form->get('searchFormName'));
76 $form->_task
= CRM_Utils_Array
::value('task', $values);
77 $contributeTasks = CRM_Contribute_Task
::tasks();
78 $form->assign('taskName', CRM_Utils_Array
::value($form->_task
, $contributeTasks));
81 if (isset($values['radio_ts']) && $values['radio_ts'] == 'ts_sel') {
82 foreach ($values as $name => $value) {
83 if (substr($name, 0, CRM_Core_Form
::CB_PREFIX_LEN
) == CRM_Core_Form
::CB_PREFIX
) {
84 $ids[] = substr($name, CRM_Core_Form
::CB_PREFIX_LEN
);
89 $queryParams = $form->get('queryParams');
91 if (is_array($queryParams)) {
92 foreach ($queryParams as $fields) {
93 if ($fields[0] == 'contribution_test') {
108 $returnProperties = ['contribution_id' => 1];
109 $sortOrder = $sortCol = NULL;
110 if ($form->get(CRM_Utils_Sort
::SORT_ORDER
)) {
111 $sortOrder = $form->get(CRM_Utils_Sort
::SORT_ORDER
);
112 //Include sort column in select clause.
113 $sortCol = trim(str_replace(['`', 'asc', 'desc'], '', $sortOrder));
114 $returnProperties[$sortCol] = 1;
117 $form->_includesSoftCredits
= CRM_Contribute_BAO_Query
::isSoftCreditOptionEnabled($queryParams);
118 $query = new CRM_Contact_BAO_Query($queryParams, $returnProperties, NULL, FALSE, FALSE,
119 CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
121 // @todo the function CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled should handle this
122 // can we remove? if not why not?
123 if ($form->_includesSoftCredits
) {
124 $contactIds = $contributionContactIds = [];
125 $query->_rowCountClause
= " count(civicrm_contribution.id)";
126 $query->_groupByComponentClause
= " GROUP BY contribution_search_scredit_combined.id, contribution_search_scredit_combined.contact_id, contribution_search_scredit_combined.scredit_id ";
129 $query->_distinctComponentClause
= ' civicrm_contribution.id';
130 $query->_groupByComponentClause
= ' GROUP BY civicrm_contribution.id ';
132 $result = $query->searchQuery(0, 0, $sortOrder);
133 while ($result->fetch()) {
134 $ids[] = $result->contribution_id
;
135 if ($form->_includesSoftCredits
) {
136 $contactIds[$result->contact_id
] = $result->contact_id
;
137 $contributionContactIds["{$result->contact_id}-{$result->contribution_id}"] = $result->contribution_id
;
140 $form->assign('totalSelectedContributions', $form->get('rowCount'));
144 $form->_componentClause
= ' civicrm_contribution.id IN ( ' . implode(',', $ids) . ' ) ';
146 $form->assign('totalSelectedContributions', count($ids));
148 if (!empty($form->_includesSoftCredits
) && !empty($contactIds)) {
149 $form->_contactIds
= $contactIds;
150 $form->_contributionContactIds
= $contributionContactIds;
153 $form->_contributionIds
= $form->_componentIds
= $ids;
154 $form->set('contributionIds', $form->_contributionIds
);
156 //set the context for redirection for any task actions
157 $session = CRM_Core_Session
::singleton();
159 $qfKey = CRM_Utils_Request
::retrieve('qfKey', 'String', $form);
160 $urlParams = 'force=1';
161 if (CRM_Utils_Rule
::qfKey($qfKey)) {
162 $urlParams .= "&qfKey=$qfKey";
165 $searchFormName = strtolower($form->get('searchFormName'));
166 if ($searchFormName == 'search') {
167 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contribute/search', $urlParams));
170 $session->replaceUserContext(CRM_Utils_System
::url("civicrm/contact/search/$searchFormName",
177 * Sets contribution Ids for unit test.
179 * @param array $contributionIds
181 public function setContributionIds($contributionIds) {
182 $this->_contributionIds
= $contributionIds;
186 * Given the contribution id, compute the contact id
187 * since its used for things like send email
189 public function setContactIDs() {
190 if (!$this->_includesSoftCredits
) {
191 $this->_contactIds
= CRM_Core_DAO
::getContactIDsFromComponent(
192 $this->_contributionIds
,
193 'civicrm_contribution'
199 * Simple shell that derived classes can call to add buttons to
200 * the form with a customized title for the main Submit
202 * @param string $title
203 * Title of the main button.
204 * @param string $nextType
205 * Button type for the form after processing.
206 * @param string $backType
207 * @param bool $submitOnce
209 public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
218 'name' => ts('Cancel'),