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
41 * advanced search, extends basic search
43 class CRM_Contribute_Form_Search
extends CRM_Core_Form
{
46 * Are we forced to run a search
54 * name of search button
59 protected $_searchButtonName;
62 * name of action button
67 protected $_actionButtonName;
70 * form values that we will be using
78 * the params that are sent to the query
83 protected $_queryParams;
86 * have we already done this search
94 * are we restricting ourselves to a single contact
99 protected $_single = FALSE;
102 * are we restricting ourselves to a single contact
107 protected $_limit = NULL;
110 * what context are we being invoked from
115 protected $_context = NULL;
117 protected $_defaults;
120 * prefix for the controller
123 protected $_prefix = "contribute_";
126 * processing needed for buildForm and later
130 */ function preProcess() {
131 $this->set('searchFormName', 'Search');
134 * set the button names
136 $this->_searchButtonName
= $this->getButtonName('refresh');
137 $this->_actionButtonName
= $this->getButtonName('next', 'action');
139 $this->_done
= FALSE;
140 $this->defaults
= array();
143 * we allow the controller to set force/reset externally, useful when we are being
144 * driven by the wizard framework
147 $this->_reset
= CRM_Utils_Request
::retrieve('reset', 'Boolean', CRM_Core_DAO
::$_nullObject);
148 $this->_force
= CRM_Utils_Request
::retrieve('force', 'Boolean', $this, FALSE);
149 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive', $this);
150 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this, FALSE, 'search');
152 $this->assign("context", $this->_context
);
154 // get user submitted values
155 // get it from controller only if form has been submitted, else preProcess has set this
156 if (!empty($_POST)) {
157 $this->_formValues
= $this->controller
->exportValues($this->_name
);
160 $this->_formValues
= $this->get('formValues');
164 $memberShipId = CRM_Utils_Request
::retrieve('memberId', 'Positive', $this);
165 if (isset($memberShipId)) {
166 $this->_formValues
['contribution_membership_id'] = $memberShipId;
168 $participantId = CRM_Utils_Request
::retrieve('participantId', 'Positive', $this);
169 if (isset($participantId)) {
170 $this->_formValues
['contribution_participant_id'] = $participantId;
174 $this->postProcess();
175 $this->set('force', 0);
179 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
180 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
181 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
185 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
186 $selector = new CRM_Contribute_Selector_Search($this->_queryParams
,
194 if ($this->_context
== 'user') {
195 $prefix = $this->_prefix
;
198 $this->assign("{$prefix}limit", $this->_limit
);
199 $this->assign("{$prefix}single", $this->_single
);
201 $controller = new CRM_Core_Selector_Controller($selector,
202 $this->get(CRM_Utils_Pager
::PAGE_ID
),
204 CRM_Core_Action
::VIEW
,
206 CRM_Core_Selector_Controller
::TRANSFER
,
210 $controller->setEmbedded(TRUE);
211 $controller->moveFromSessionToTemplate();
213 $this->assign('contributionSummary', $this->get('summary'));
216 function setDefaultValues() {
217 if (empty($this->_defaults
218 ['contribution_status'])) {
219 $this->_defaults
['contribution_status'][1] = 1;
221 return $this->_defaults
;
231 function buildQuickForm() {
232 // text for sort_name
233 $this->addElement('text',
235 ts('Contributor Name or Email'),
236 CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact',
241 $this->_group
= CRM_Core_PseudoConstant
::group();
243 // multiselect for groups
245 $this->add('select', 'group', ts('Groups'), $this->_group
, FALSE,
246 array('id' => 'group', 'multiple' => 'multiple', 'class' => 'crm-select2')
250 // multiselect for tags
251 $contactTags = CRM_Core_BAO_Tag
::getTags();
254 $this->add('select', 'contact_tags', ts('Tags'), $contactTags, FALSE,
255 array('id' => 'contact_tags', 'multiple' => 'multiple', 'class' => 'crm-select2')
259 CRM_Contribute_BAO_Query
::buildSearchForm($this);
262 * add form checkboxes for each row. This is needed out here to conform to QF protocol
263 * of all elements being declared in builQuickForm
266 $rows = $this->get('rows');
267 if (is_array($rows)) {
268 if (!$this->_single
) {
269 $this->addElement('checkbox',
273 array('onclick' => "toggleTaskAction( true );", 'class' => 'select-rows')
275 foreach ($rows as $row) {
276 $this->addElement('checkbox', $row['checkbox'],
278 array('onclick' => "toggleTaskAction( true );", 'class' => 'select-row')
283 $total = $cancel = 0;
285 $permission = CRM_Core_Permission
::getPermission();
287 $queryParams = $this->get('queryParams');
288 $softCreditFiltering = FALSE;
289 if (!empty($queryParams)) {
290 $softCreditFiltering = CRM_Contribute_BAO_Query
::isSoftCreditOptionEnabled($queryParams);
292 $tasks = array('' => ts('- actions -')) + CRM_Contribute_Task
::permissionedTaskTitles($permission, $softCreditFiltering);
293 $this->add('select', 'task', ts('Actions:') . ' ', $tasks);
294 $this->add('submit', $this->_actionButtonName
, ts('Go'),
296 'class' => 'form-submit',
298 'onclick' => "return checkPerformAction('mark_x', '" . $this->getName() . "', 0);",
302 // need to perform tasks on all or selected items ? using radio_ts(task selection) for it
303 $this->addElement('radio', 'radio_ts', NULL, '', 'ts_sel', array('checked' => 'checked'));
304 $this->addElement('radio', 'radio_ts', NULL, '', 'ts_all', array('class' => 'select-rows', 'onclick' => $this->getName() . ".toggleSelect.checked = false; toggleTaskAction( true );"));
308 $this->addButtons(array(
311 'name' => ts('Search'),
319 * The post processing of the form gets done here.
321 * Key things done during post processing are
322 * - check for reset or next request. if present, skip post procesing.
323 * - now check if user requested running a saved search, if so, then
324 * the form values associated with the saved search are used for searching.
325 * - if user has done a submit with new values the regular post submissing is
327 * The processing consists of using a Selector / Controller framework for getting the
335 function postProcess() {
342 if (!empty($_POST)) {
343 $this->_formValues
= $this->controller
->exportValues($this->_name
);
346 $this->fixFormValues();
348 // We don't show test records in summaries or dashboards
349 if (empty($this->_formValues
['contribution_test']) && $this->_force
) {
350 $this->_formValues
["contribution_test"] = 0;
354 'contribution_amount_low', 'contribution_amount_high') as $f) {
355 if (isset($this->_formValues
[$f])) {
356 $this->_formValues
[$f] = CRM_Utils_Rule
::cleanMoney($this->_formValues
[$f]);
360 $config = CRM_Core_Config
::singleton();
362 $financialType = CRM_Utils_Array
::value('financial_type_id', $this->_formValues
);
363 if ($financialType && is_array($financialType)) {
364 unset($this->_formValues
['financial_type_id']);
365 foreach($financialType as $notImportant => $typeID) {
366 $this->_formValues
['financial_type_id'][$typeID] = 1;
370 $tags = CRM_Utils_Array
::value('contact_tags', $this->_formValues
);
371 if ($tags && !is_array($tags)) {
372 unset($this->_formValues
['contact_tags']);
373 $this->_formValues
['contact_tags'][$tags] = 1;
376 if ($tags && is_array($tags)) {
377 unset($this->_formValues
['contact_tags']);
378 foreach($tags as $notImportant => $tagID) {
379 $this->_formValues
['contact_tags'][$tagID] = 1;
384 if (!$config->groupTree
) {
385 $group = CRM_Utils_Array
::value('group', $this->_formValues
);
386 if ($group && !is_array($group)) {
387 unset($this->_formValues
['group']);
388 $this->_formValues
['group'][$group] = 1;
391 if ($group && is_array($group)) {
392 unset($this->_formValues
['group']);
393 foreach($group as $notImportant => $groupID) {
394 $this->_formValues
['group'][$groupID] = 1;
400 CRM_Core_BAO_CustomValue
::fixFieldValueOfTypeMemo($this->_formValues
);
402 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
404 $this->set('formValues', $this->_formValues
);
405 $this->set('queryParams', $this->_queryParams
);
407 $buttonName = $this->controller
->getButtonName();
408 if ($buttonName == $this->_actionButtonName
) {
409 // check actionName and if next, then do not repeat a search, since we are going to the next page
411 // hack, make sure we reset the task values
412 $stateMachine = $this->controller
->getStateMachine();
413 $formName = $stateMachine->getTaskFormName();
414 $this->controller
->resetPage($formName);
420 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
421 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
422 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
426 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
427 $selector = new CRM_Contribute_Selector_Search($this->_queryParams
,
434 $selector->setKey($this->controller
->_key
);
437 if ($this->_context
== 'basic' ||
$this->_context
== 'user') {
438 $prefix = $this->_prefix
;
441 $controller = new CRM_Core_Selector_Controller($selector,
442 $this->get(CRM_Utils_Pager
::PAGE_ID
),
444 CRM_Core_Action
::VIEW
,
446 CRM_Core_Selector_Controller
::SESSION
,
449 $controller->setEmbedded(TRUE);
451 $query = &$selector->getQuery();
452 if ($this->_context
== 'user') {
453 $query->setSkipPermission(TRUE);
455 $summary = &$query->summaryContribution($this->_context
);
456 $this->set('summary', $summary);
457 $this->assign('contributionSummary', $summary);
461 function fixFormValues() {
462 // if this search has been forced
463 // then see if there are any get values, and if so over-ride the post values
464 // note that this means that GET over-rides POST :)
466 if (!$this->_force
) {
470 $status = CRM_Utils_Request
::retrieve('status', 'String',
471 CRM_Core_DAO
::$_nullObject
474 $this->_formValues
['contribution_status_id'] = array($status => 1);
475 $this->_defaults
['contribution_status_id'] = array($status => 1);
478 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
481 $cid = CRM_Utils_Type
::escape($cid, 'Integer');
483 $this->_formValues
['contact_id'] = $cid;
484 list($display, $image) = CRM_Contact_BAO_Contact
::getDisplayAndImage($cid);
485 $this->_defaults
['sort_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid,
488 // also assign individual mode to the template
489 $this->_single
= TRUE;
493 $lowDate = CRM_Utils_Request
::retrieve('start', 'Timestamp',
494 CRM_Core_DAO
::$_nullObject
497 $lowDate = CRM_Utils_Type
::escape($lowDate, 'Timestamp');
498 $date = CRM_Utils_Date
::setDateDefaults($lowDate);
499 $this->_formValues
['contribution_date_low'] = $this->_defaults
['contribution_date_low'] = $date[0];
502 $highDate = CRM_Utils_Request
::retrieve('end', 'Timestamp',
503 CRM_Core_DAO
::$_nullObject
506 $highDate = CRM_Utils_Type
::escape($highDate, 'Timestamp');
507 $date = CRM_Utils_Date
::setDateDefaults($highDate);
508 $this->_formValues
['contribution_date_high'] = $this->_defaults
['contribution_date_high'] = $date[0];
511 if ($highDate ||
$lowDate) {
512 //set the Choose Date Range value
513 $this->_formValues
['contribution_date_relative'] = 0;
516 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive',
520 $test = CRM_Utils_Request
::retrieve('test', 'Boolean',
521 CRM_Core_DAO
::$_nullObject
524 $test = CRM_Utils_Type
::escape($test, 'Boolean');
525 $this->_formValues
['contribution_test'] = $test;
528 $recur = CRM_Utils_Request
::retrieve('recur', 'Positive', $this, FALSE);
530 $this->_formValues
['contribution_recur_id'] = $recur;
531 $this->_formValues
['contribution_recurring'] = 1;
534 //check for contribution page id.
535 $contribPageId = CRM_Utils_Request
::retrieve('pid', 'Positive', $this);
536 if ($contribPageId) {
537 $this->_formValues
['contribution_page_id'] = $contribPageId;
540 //give values to default.
541 $this->_defaults
= $this->_formValues
;
545 * Return a descriptive name for the page, used in wizard header
550 public function getTitle() {
551 return ts('Find Contributions');