3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
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 print button
67 protected $_printButtonName;
70 * name of action button
75 protected $_actionButtonName;
78 * form values that we will be using
83 protected $_formValues;
86 * the params that are sent to the query
91 protected $_queryParams;
94 * have we already done this search
102 * are we restricting ourselves to a single contact
107 protected $_single = FALSE;
110 * are we restricting ourselves to a single contact
115 protected $_limit = NULL;
118 * what context are we being invoked from
123 protected $_context = NULL;
125 protected $_defaults;
128 * prefix for the controller
131 protected $_prefix = "contribute_";
134 * processing needed for buildForm and later
138 */ function preProcess() {
139 $this->set('searchFormName', 'Search');
142 * set the button names
144 $this->_searchButtonName
= $this->getButtonName('refresh');
145 $this->_printButtonName
= $this->getButtonName('next', 'print');
146 $this->_actionButtonName
= $this->getButtonName('next', 'action');
148 $this->_done
= FALSE;
149 $this->defaults
= array();
152 * we allow the controller to set force/reset externally, useful when we are being
153 * driven by the wizard framework
156 $this->_reset
= CRM_Utils_Request
::retrieve('reset', 'Boolean', CRM_Core_DAO
::$_nullObject);
157 $this->_force
= CRM_Utils_Request
::retrieve('force', 'Boolean', $this, FALSE);
158 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive', $this);
159 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this, FALSE, 'search');
161 $this->assign("context", $this->_context
);
163 // get user submitted values
164 // get it from controller only if form has been submitted, else preProcess has set this
165 if (!empty($_POST)) {
166 $this->_formValues
= $this->controller
->exportValues($this->_name
);
169 $this->_formValues
= $this->get('formValues');
173 $memberShipId = CRM_Utils_Request
::retrieve('memberId', 'Positive', $this);
174 if (isset($memberShipId)) {
175 $this->_formValues
['contribution_membership_id'] = $memberShipId;
177 $participantId = CRM_Utils_Request
::retrieve('participantId', 'Positive', $this);
178 if (isset($participantId)) {
179 $this->_formValues
['contribution_participant_id'] = $participantId;
183 $this->postProcess();
184 $this->set('force', 0);
188 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
189 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
190 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
194 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
195 $selector = new CRM_Contribute_Selector_Search($this->_queryParams
,
203 if ($this->_context
== 'user') {
204 $prefix = $this->_prefix
;
207 $this->assign("{$prefix}limit", $this->_limit
);
208 $this->assign("{$prefix}single", $this->_single
);
210 $controller = new CRM_Core_Selector_Controller($selector,
211 $this->get(CRM_Utils_Pager
::PAGE_ID
),
213 CRM_Core_Action
::VIEW
,
215 CRM_Core_Selector_Controller
::TRANSFER
,
219 $controller->setEmbedded(TRUE);
220 $controller->moveFromSessionToTemplate();
222 $this->assign('contributionSummary', $this->get('summary'));
225 function setDefaultValues() {
226 if (!CRM_Utils_Array
::value('contribution_status',
229 $this->_defaults
['contribution_status'][1] = 1;
231 return $this->_defaults
;
241 function buildQuickForm() {
242 // text for sort_name
243 $this->addElement('text',
245 ts('Contributor Name or Email'),
246 CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact',
251 $this->_group
= CRM_Core_PseudoConstant
::group();
253 // multiselect for groups
255 $this->add('select', 'group', ts('Groups'), $this->_group
, FALSE,
256 array('id' => 'group', 'multiple' => 'multiple', 'title' => ts('- select -'))
260 // multiselect for tags
261 require_once 'CRM/Core/BAO/Tag.php';
262 $contactTags = CRM_Core_BAO_Tag
::getTags();
265 $this->add('select', 'contact_tags', ts('Tags'), $contactTags, FALSE,
266 array('id' => 'contact_tags', 'multiple' => 'multiple', 'title' => ts('- select -'))
270 CRM_Contribute_BAO_Query
::buildSearchForm($this);
273 * add form checkboxes for each row. This is needed out here to conform to QF protocol
274 * of all elements being declared in builQuickForm
277 $rows = $this->get('rows');
278 if (is_array($rows)) {
279 if (!$this->_single
) {
280 $this->addElement('checkbox',
284 array('onclick' => "toggleTaskAction( true ); return toggleCheckboxVals('mark_x_',this);")
286 foreach ($rows as $row) {
287 $this->addElement('checkbox', $row['checkbox'],
289 array('onclick' => "toggleTaskAction( true ); return checkSelectedBox('" . $row['checkbox'] . "');")
294 $total = $cancel = 0;
296 $permission = CRM_Core_Permission
::getPermission();
298 $tasks = array('' => ts('- actions -')) + CRM_Contribute_Task
::permissionedTaskTitles($permission);
299 $this->add('select', 'task', ts('Actions:') . ' ', $tasks);
300 $this->add('submit', $this->_actionButtonName
, ts('Go'),
302 'class' => 'form-submit',
304 'onclick' => "return checkPerformAction('mark_x', '" . $this->getName() . "', 0);",
308 $this->add('submit', $this->_printButtonName
, ts('Print'),
310 'class' => 'form-submit',
311 'onclick' => "return checkPerformAction('mark_x', '" . $this->getName() . "', 1);",
315 // need to perform tasks on all or selected items ? using radio_ts(task selection) for it
316 $this->addElement('radio', 'radio_ts', NULL, '', 'ts_sel', array('checked' => 'checked'));
317 $this->addElement('radio', 'radio_ts', NULL, '', 'ts_all', array('onclick' => $this->getName() . ".toggleSelect.checked = false; toggleCheckboxVals('mark_x_',this); toggleTaskAction( true );"));
321 $this->addButtons(array(
324 'name' => ts('Search'),
332 * The post processing of the form gets done here.
334 * Key things done during post processing are
335 * - check for reset or next request. if present, skip post procesing.
336 * - now check if user requested running a saved search, if so, then
337 * the form values associated with the saved search are used for searching.
338 * - if user has done a submit with new values the regular post submissing is
340 * The processing consists of using a Selector / Controller framework for getting the
348 function postProcess() {
355 if (!empty($_POST)) {
356 $this->_formValues
= $this->controller
->exportValues($this->_name
);
359 $this->fixFormValues();
361 // We don't show test records in summaries or dashboards
362 if (empty($this->_formValues
['contribution_test']) && $this->_force
) {
363 $this->_formValues
["contribution_test"] = 0;
367 'contribution_amount_low', 'contribution_amount_high') as $f) {
368 if (isset($this->_formValues
[$f])) {
369 $this->_formValues
[$f] = CRM_Utils_Rule
::cleanMoney($this->_formValues
[$f]);
373 $config = CRM_Core_Config
::singleton();
374 $tags = CRM_Utils_Array
::value('contact_tags', $this->_formValues
);
375 if ($tags && !is_array($tags)) {
376 unset($this->_formValues
['contact_tags']);
377 $this->_formValues
['contact_tags'][$tags] = 1;
380 if ($tags && is_array($tags)) {
381 unset($this->_formValues
['contact_tags']);
382 foreach($tags as $notImportant => $tagID) {
383 $this->_formValues
['contact_tags'][$tagID] = 1;
388 if (!$config->groupTree
) {
389 $group = CRM_Utils_Array
::value('group', $this->_formValues
);
390 if ($group && !is_array($group)) {
391 unset($this->_formValues
['group']);
392 $this->_formValues
['group'][$group] = 1;
395 if ($group && is_array($group)) {
396 unset($this->_formValues
['group']);
397 foreach($group as $notImportant => $groupID) {
398 $this->_formValues
['group'][$groupID] = 1;
404 CRM_Core_BAO_CustomValue
::fixFieldValueOfTypeMemo($this->_formValues
);
406 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
408 $this->set('formValues', $this->_formValues
);
409 $this->set('queryParams', $this->_queryParams
);
411 $buttonName = $this->controller
->getButtonName();
412 if ($buttonName == $this->_actionButtonName ||
$buttonName == $this->_printButtonName
) {
413 // check actionName and if next, then do not repeat a search, since we are going to the next page
415 // hack, make sure we reset the task values
416 $stateMachine = $this->controller
->getStateMachine();
417 $formName = $stateMachine->getTaskFormName();
418 $this->controller
->resetPage($formName);
424 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
425 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
426 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
430 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
431 $selector = new CRM_Contribute_Selector_Search($this->_queryParams
,
438 $selector->setKey($this->controller
->_key
);
441 if ($this->_context
== 'basic' ||
$this->_context
== 'user') {
442 $prefix = $this->_prefix
;
445 $controller = new CRM_Core_Selector_Controller($selector,
446 $this->get(CRM_Utils_Pager
::PAGE_ID
),
448 CRM_Core_Action
::VIEW
,
450 CRM_Core_Selector_Controller
::SESSION
,
453 $controller->setEmbedded(TRUE);
455 $query = &$selector->getQuery();
456 if ($this->_context
== 'user') {
457 $query->setSkipPermission(TRUE);
459 $summary = &$query->summaryContribution($this->_context
);
460 $this->set('summary', $summary);
461 $this->assign('contributionSummary', $summary);
465 function fixFormValues() {
466 // if this search has been forced
467 // then see if there are any get values, and if so over-ride the post values
468 // note that this means that GET over-rides POST :)
470 if (!$this->_force
) {
474 $status = CRM_Utils_Request
::retrieve('status', 'String',
475 CRM_Core_DAO
::$_nullObject
478 $this->_formValues
['contribution_status_id'] = array($status => 1);
479 $this->_defaults
['contribution_status_id'] = array($status => 1);
482 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
485 $cid = CRM_Utils_Type
::escape($cid, 'Integer');
487 $this->_formValues
['contact_id'] = $cid;
488 list($display, $image) = CRM_Contact_BAO_Contact
::getDisplayAndImage($cid);
489 $this->_defaults
['sort_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid,
492 // also assign individual mode to the template
493 $this->_single
= TRUE;
497 $lowDate = CRM_Utils_Request
::retrieve('start', 'Timestamp',
498 CRM_Core_DAO
::$_nullObject
501 $lowDate = CRM_Utils_Type
::escape($lowDate, 'Timestamp');
502 $date = CRM_Utils_Date
::setDateDefaults($lowDate);
503 $this->_formValues
['contribution_date_low'] = $this->_defaults
['contribution_date_low'] = $date[0];
506 $highDate = CRM_Utils_Request
::retrieve('end', 'Timestamp',
507 CRM_Core_DAO
::$_nullObject
510 $highDate = CRM_Utils_Type
::escape($highDate, 'Timestamp');
511 $date = CRM_Utils_Date
::setDateDefaults($highDate);
512 $this->_formValues
['contribution_date_high'] = $this->_defaults
['contribution_date_high'] = $date[0];
515 if ($highDate ||
$lowDate) {
516 //set the Choose Date Range value
517 $this->_formValues
['contribution_date_relative'] = 0;
520 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive',
524 $test = CRM_Utils_Request
::retrieve('test', 'Boolean',
525 CRM_Core_DAO
::$_nullObject
528 $test = CRM_Utils_Type
::escape($test, 'Boolean');
529 $this->_formValues
['contribution_test'] = $test;
532 $recur = CRM_Utils_Request
::retrieve('recur', 'Positive', $this, FALSE);
534 $this->_formValues
['contribution_recur_id'] = $recur;
535 $this->_formValues
['contribution_recurring'] = 1;
538 //check for contribution page id.
539 $contribPageId = CRM_Utils_Request
::retrieve('pid', 'Positive', $this);
540 if ($contribPageId) {
541 $this->_formValues
['contribution_page_id'] = $contribPageId;
544 //give values to default.
545 $this->_defaults
= $this->_formValues
;
549 * Return a descriptive name for the page, used in wizard header
554 public function getTitle() {
555 return ts('Find Contributions');