3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
35 * This class generates form components for relationship.
37 class CRM_Contribute_Form_Task
extends CRM_Core_Form
{
40 * The task being performed.
47 * The additional clause that we restrict the search with.
51 protected $_componentClause = NULL;
54 * The array that holds all the component ids.
58 protected $_componentIds;
61 * The array that holds all the contribution ids.
65 protected $_contributionIds;
68 * The array that holds all the contact ids.
75 * The array that holds all the mapping contribution and contact ids.
79 protected $_contributionContactIds = array();
82 * The flag to tell if there are soft credits included.
86 public $_includesSoftCredits = FALSE;
89 * Build all the data structures needed to build the form.
91 public function preProcess() {
92 self
::preProcessCommon($this);
96 * @param CRM_Core_Form $form
97 * @param bool $useTable
99 public static function preProcessCommon(&$form, $useTable = FALSE) {
100 $form->_contributionIds
= array();
102 $values = $form->controller
->exportValues($form->get('searchFormName'));
104 $form->_task
= $values['task'];
105 $contributeTasks = CRM_Contribute_Task
::tasks();
106 $form->assign('taskName', $contributeTasks[$form->_task
]);
109 if ($values['radio_ts'] == 'ts_sel') {
110 foreach ($values as $name => $value) {
111 if (substr($name, 0, CRM_Core_Form
::CB_PREFIX_LEN
) == CRM_Core_Form
::CB_PREFIX
) {
112 $ids[] = substr($name, CRM_Core_Form
::CB_PREFIX_LEN
);
117 $queryParams = $form->get('queryParams');
119 if ($form->get(CRM_Utils_Sort
::SORT_ORDER
)) {
120 $sortOrder = $form->get(CRM_Utils_Sort
::SORT_ORDER
);
123 $form->_includesSoftCredits
= CRM_Contribute_BAO_Query
::isSoftCreditOptionEnabled($queryParams);
124 $query = new CRM_Contact_BAO_Query($queryParams, array('contribution_id'), NULL, FALSE, FALSE,
125 CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
127 // @todo the function CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled should handle this
128 // can we remove? if not why not?
129 if ($form->_includesSoftCredits
) {
130 $contactIds = $contributionContactIds = array();
131 $query->_rowCountClause
= " count(civicrm_contribution.id)";
132 $query->_groupByComponentClause
= " GROUP BY contribution_search_scredit_combined.id, contribution_search_scredit_combined.contact_id, contribution_search_scredit_combined.scredit_id ";
135 $query->_distinctComponentClause
= ' civicrm_contribution.id';
136 $query->_groupByComponentClause
= ' GROUP BY civicrm_contribution.id ';
138 $result = $query->searchQuery(0, 0, $sortOrder);
139 while ($result->fetch()) {
140 $ids[] = $result->contribution_id
;
141 if ($form->_includesSoftCredits
) {
142 $contactIds[$result->contact_id
] = $result->contact_id
;
143 $contributionContactIds["{$result->contact_id}-{$result->contribution_id}"] = $result->contribution_id
;
147 $form->assign('totalSelectedContributions', $form->get('rowCount'));
151 $form->_componentClause
= ' civicrm_contribution.id IN ( ' . implode(',', $ids) . ' ) ';
153 $form->assign('totalSelectedContributions', count($ids));
155 if (!empty($form->_includesSoftCredits
) && !empty($contactIds)) {
156 $form->_contactIds
= $contactIds;
157 $form->_contributionContactIds
= $contributionContactIds;
160 $form->_contributionIds
= $form->_componentIds
= $ids;
162 //set the context for redirection for any task actions
163 $session = CRM_Core_Session
::singleton();
165 $qfKey = CRM_Utils_Request
::retrieve('qfKey', 'String', $form);
166 $urlParams = 'force=1';
167 if (CRM_Utils_Rule
::qfKey($qfKey)) {
168 $urlParams .= "&qfKey=$qfKey";
171 $searchFormName = strtolower($form->get('searchFormName'));
172 if ($searchFormName == 'search') {
173 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contribute/search', $urlParams));
176 $session->replaceUserContext(CRM_Utils_System
::url("civicrm/contact/search/$searchFormName",
183 * Given the contribution id, compute the contact id
184 * since its used for things like send email
186 public function setContactIDs() {
187 if (!$this->_includesSoftCredits
) {
188 $this->_contactIds
= &CRM_Core_DAO
::getContactIDsFromComponent(
189 $this->_contributionIds
,
190 'civicrm_contribution'
196 * Simple shell that derived classes can call to add buttons to
197 * the form with a customized title for the main Submit
199 * @param string $title
200 * Title of the main button.
201 * @param string $nextType
202 * Button type for the form after processing.
203 * @param string $backType
204 * @param bool $submitOnce
206 public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
207 $this->addButtons(array(
215 'name' => ts('Cancel'),