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 $tasks = array('' => ts('- actions -')) + CRM_Contribute_Task
::permissionedTaskTitles($permission);
288 $this->add('select', 'task', ts('Actions:') . ' ', $tasks);
289 $this->add('submit', $this->_actionButtonName
, ts('Go'),
291 'class' => 'form-submit',
293 'onclick' => "return checkPerformAction('mark_x', '" . $this->getName() . "', 0);",
297 // need to perform tasks on all or selected items ? using radio_ts(task selection) for it
298 $this->addElement('radio', 'radio_ts', NULL, '', 'ts_sel', array('checked' => 'checked'));
299 $this->addElement('radio', 'radio_ts', NULL, '', 'ts_all', array('class' => 'select-rows', 'onclick' => $this->getName() . ".toggleSelect.checked = false; toggleTaskAction( true );"));
303 $this->addButtons(array(
306 'name' => ts('Search'),
314 * The post processing of the form gets done here.
316 * Key things done during post processing are
317 * - check for reset or next request. if present, skip post procesing.
318 * - now check if user requested running a saved search, if so, then
319 * the form values associated with the saved search are used for searching.
320 * - if user has done a submit with new values the regular post submissing is
322 * The processing consists of using a Selector / Controller framework for getting the
330 function postProcess() {
337 if (!empty($_POST)) {
338 $this->_formValues
= $this->controller
->exportValues($this->_name
);
341 $this->fixFormValues();
343 // We don't show test records in summaries or dashboards
344 if (empty($this->_formValues
['contribution_test']) && $this->_force
) {
345 $this->_formValues
["contribution_test"] = 0;
349 'contribution_amount_low', 'contribution_amount_high') as $f) {
350 if (isset($this->_formValues
[$f])) {
351 $this->_formValues
[$f] = CRM_Utils_Rule
::cleanMoney($this->_formValues
[$f]);
355 $config = CRM_Core_Config
::singleton();
357 $financialType = CRM_Utils_Array
::value('financial_type_id', $this->_formValues
);
358 if ($financialType && is_array($financialType)) {
359 unset($this->_formValues
['financial_type_id']);
360 foreach($financialType as $notImportant => $typeID) {
361 $this->_formValues
['financial_type_id'][$typeID] = 1;
365 $tags = CRM_Utils_Array
::value('contact_tags', $this->_formValues
);
366 if ($tags && !is_array($tags)) {
367 unset($this->_formValues
['contact_tags']);
368 $this->_formValues
['contact_tags'][$tags] = 1;
371 if ($tags && is_array($tags)) {
372 unset($this->_formValues
['contact_tags']);
373 foreach($tags as $notImportant => $tagID) {
374 $this->_formValues
['contact_tags'][$tagID] = 1;
379 if (!$config->groupTree
) {
380 $group = CRM_Utils_Array
::value('group', $this->_formValues
);
381 if ($group && !is_array($group)) {
382 unset($this->_formValues
['group']);
383 $this->_formValues
['group'][$group] = 1;
386 if ($group && is_array($group)) {
387 unset($this->_formValues
['group']);
388 foreach($group as $notImportant => $groupID) {
389 $this->_formValues
['group'][$groupID] = 1;
395 CRM_Core_BAO_CustomValue
::fixFieldValueOfTypeMemo($this->_formValues
);
397 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
399 $this->set('formValues', $this->_formValues
);
400 $this->set('queryParams', $this->_queryParams
);
402 $buttonName = $this->controller
->getButtonName();
403 if ($buttonName == $this->_actionButtonName
) {
404 // check actionName and if next, then do not repeat a search, since we are going to the next page
406 // hack, make sure we reset the task values
407 $stateMachine = $this->controller
->getStateMachine();
408 $formName = $stateMachine->getTaskFormName();
409 $this->controller
->resetPage($formName);
415 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
416 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
417 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
421 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
422 $selector = new CRM_Contribute_Selector_Search($this->_queryParams
,
429 $selector->setKey($this->controller
->_key
);
432 if ($this->_context
== 'basic' ||
$this->_context
== 'user') {
433 $prefix = $this->_prefix
;
436 $controller = new CRM_Core_Selector_Controller($selector,
437 $this->get(CRM_Utils_Pager
::PAGE_ID
),
439 CRM_Core_Action
::VIEW
,
441 CRM_Core_Selector_Controller
::SESSION
,
444 $controller->setEmbedded(TRUE);
446 $query = &$selector->getQuery();
447 if ($this->_context
== 'user') {
448 $query->setSkipPermission(TRUE);
450 $summary = &$query->summaryContribution($this->_context
);
451 $this->set('summary', $summary);
452 $this->assign('contributionSummary', $summary);
456 function fixFormValues() {
457 // if this search has been forced
458 // then see if there are any get values, and if so over-ride the post values
459 // note that this means that GET over-rides POST :)
461 if (!$this->_force
) {
465 $status = CRM_Utils_Request
::retrieve('status', 'String',
466 CRM_Core_DAO
::$_nullObject
469 $this->_formValues
['contribution_status_id'] = array($status => 1);
470 $this->_defaults
['contribution_status_id'] = array($status => 1);
473 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
476 $cid = CRM_Utils_Type
::escape($cid, 'Integer');
478 $this->_formValues
['contact_id'] = $cid;
479 list($display, $image) = CRM_Contact_BAO_Contact
::getDisplayAndImage($cid);
480 $this->_defaults
['sort_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid,
483 // also assign individual mode to the template
484 $this->_single
= TRUE;
488 $lowDate = CRM_Utils_Request
::retrieve('start', 'Timestamp',
489 CRM_Core_DAO
::$_nullObject
492 $lowDate = CRM_Utils_Type
::escape($lowDate, 'Timestamp');
493 $date = CRM_Utils_Date
::setDateDefaults($lowDate);
494 $this->_formValues
['contribution_date_low'] = $this->_defaults
['contribution_date_low'] = $date[0];
497 $highDate = CRM_Utils_Request
::retrieve('end', 'Timestamp',
498 CRM_Core_DAO
::$_nullObject
501 $highDate = CRM_Utils_Type
::escape($highDate, 'Timestamp');
502 $date = CRM_Utils_Date
::setDateDefaults($highDate);
503 $this->_formValues
['contribution_date_high'] = $this->_defaults
['contribution_date_high'] = $date[0];
506 if ($highDate ||
$lowDate) {
507 //set the Choose Date Range value
508 $this->_formValues
['contribution_date_relative'] = 0;
511 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive',
515 $test = CRM_Utils_Request
::retrieve('test', 'Boolean',
516 CRM_Core_DAO
::$_nullObject
519 $test = CRM_Utils_Type
::escape($test, 'Boolean');
520 $this->_formValues
['contribution_test'] = $test;
523 $recur = CRM_Utils_Request
::retrieve('recur', 'Positive', $this, FALSE);
525 $this->_formValues
['contribution_recur_id'] = $recur;
526 $this->_formValues
['contribution_recurring'] = 1;
529 //check for contribution page id.
530 $contribPageId = CRM_Utils_Request
::retrieve('pid', 'Positive', $this);
531 if ($contribPageId) {
532 $this->_formValues
['contribution_page_id'] = $contribPageId;
535 //give values to default.
536 $this->_defaults
= $this->_formValues
;
540 * Return a descriptive name for the page, used in wizard header
545 public function getTitle() {
546 return ts('Find Contributions');