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 * This file is for civievent search
43 class CRM_Event_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;
126 * prefix for the controller
129 protected $_prefix = "event_";
131 protected $_defaults;
134 * the saved search ID retrieved from the GET vars
142 * processing needed for buildForm and later
147 function preProcess() {
148 $this->set('searchFormName', 'Search');
151 * set the button names
153 $this->_searchButtonName
= $this->getButtonName('refresh');
154 $this->_printButtonName
= $this->getButtonName('next', 'print');
155 $this->_actionButtonName
= $this->getButtonName('next', 'action');
157 $this->_done
= FALSE;
158 $this->defaults
= array();
161 * we allow the controller to set force/reset externally, useful when we are being
162 * driven by the wizard framework
164 $this->_reset
= CRM_Utils_Request
::retrieve('reset', 'Boolean', CRM_Core_DAO
::$_nullObject);
165 $this->_force
= CRM_Utils_Request
::retrieve('force', 'Boolean', $this, FALSE);
166 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive', $this);
167 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this, FALSE, 'search');
168 $this->_ssID
= CRM_Utils_Request
::retrieve('ssID', 'Positive', $this);
169 $this->assign("context", $this->_context
);
171 // get user submitted values
172 // get it from controller only if form has been submitted, else preProcess has set this
173 if (!empty($_POST) && !$this->controller
->isModal()) {
174 $this->_formValues
= $this->controller
->exportValues($this->_name
);
177 $this->_formValues
= $this->get('formValues');
180 if (empty($this->_formValues
)) {
181 if (isset($this->_ssID
)) {
182 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
187 $this->postProcess();
188 $this->set('force', 0);
192 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
193 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
194 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
198 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
199 $selector = new CRM_Event_Selector_Search($this->_queryParams
,
207 if ($this->_context
== 'user') {
208 $prefix = $this->_prefix
;
211 $this->assign("{$prefix}limit", $this->_limit
);
212 $this->assign("{$prefix}single", $this->_single
);
214 $controller = new CRM_Core_Selector_Controller($selector,
215 $this->get(CRM_Utils_Pager
::PAGE_ID
),
217 CRM_Core_Action
::VIEW
,
219 CRM_Core_Selector_Controller
::TRANSFER
,
222 $controller->setEmbedded(TRUE);
223 $controller->moveFromSessionToTemplate();
225 $this->assign('summary', $this->get('summary'));
235 function buildQuickForm() {
236 $this->addElement('text', 'sort_name', ts('Participant Name or Email'), CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact', 'sort_name'));
238 CRM_Event_BAO_Query
::buildSearchForm($this);
241 * add form checkboxes for each row. This is needed out here to conform to QF protocol
242 * of all elements being declared in builQuickForm
244 $rows = $this->get('rows');
245 if (is_array($rows)) {
246 $lineItems = $eventIds = array();
247 if (!$this->_single
) {
248 $this->addElement('checkbox',
252 array('onclick' => "toggleTaskAction( true ); return toggleCheckboxVals('mark_x_',this);")
255 foreach ($rows as $row) {
256 $eventIds[$row['event_id']] = $row['event_id'];
257 if (!$this->_single
) {
258 $this->addElement('checkbox', $row['checkbox'],
260 array('onclick' => "toggleTaskAction( true ); return checkSelectedBox('" . $row['checkbox'] . "');")
263 if (CRM_Event_BAO_Event
::usesPriceSet($row['event_id'])) {
264 // add line item details if applicable
265 $lineItems[$row['participant_id']] = CRM_Price_BAO_LineItem
::getLineItems($row['participant_id']);
269 //get actual count only when we are dealing w/ single event.
270 $participantCount = 0;
271 if (count($eventIds) == 1) {
272 //convert form values to clause.
273 $seatClause = array();
274 // Filter on is_test if specified in search form
275 if (CRM_Utils_Array
::value('participant_test', $this->_formValues
) == '1' || CRM_Utils_Array
::value('participant_test', $this->_formValues
) == '0' ) {
276 $seatClause[] = "( participant.is_test = {$this->_formValues['participant_test']} )";
278 if (CRM_Utils_Array
::value('participant_status_id', $this->_formValues
)) {
279 $statuses = array_keys($this->_formValues
['participant_status_id']);
280 $seatClause[] = '( participant.status_id IN ( ' . implode(' , ', $statuses) . ' ) )';
282 if (CRM_Utils_Array
::value('participant_role_id', $this->_formValues
)) {
283 $roles = array_keys($this->_formValues
['participant_role_id']);
284 $seatClause[] = '( participant.role_id IN ( ' . implode(' , ', $roles) . ' ) )';
287 if (!empty($seatClause)) {
288 $clause = implode(' AND ', $seatClause);
291 $participantCount = CRM_Event_BAO_Event
::eventTotalSeats(array_pop($eventIds), $clause);
293 $this->assign('participantCount', $participantCount);
294 $this->assign('lineItems', $lineItems);
296 $total = $cancel = 0;
298 $permission = CRM_Core_Permission
::getPermission();
300 $tasks = array('' => ts('- actions -')) + CRM_Event_Task
::permissionedTaskTitles($permission);
301 if (isset($this->_ssID
)) {
302 if ($permission == CRM_Core_Permission
::EDIT
) {
303 $tasks = $tasks + CRM_Event_Task
::optionalTaskTitle();
306 $savedSearchValues = array(
307 'id' => $this->_ssID
,
308 'name' => CRM_Contact_BAO_SavedSearch
::getName($this->_ssID
, 'title'),
310 $this->assign_by_ref('savedSearch', $savedSearchValues);
311 $this->assign('ssID', $this->_ssID
);
314 $this->add('select', 'task', ts('Actions:') . ' ', $tasks);
315 $this->add('submit', $this->_actionButtonName
, ts('Go'),
317 'class' => 'form-submit',
319 'onclick' => "return checkPerformAction('mark_x', '" . $this->getName() . "', 0);",
323 $this->add('submit', $this->_printButtonName
, ts('Print'),
325 'class' => 'form-submit',
326 'onclick' => "return checkPerformAction('mark_x', '" . $this->getName() . "', 1);",
330 // need to perform tasks on all or selected items ? using radio_ts(task selection) for it
331 $this->addElement('radio', 'radio_ts', NULL, '', 'ts_sel',
332 array('checked' => 'checked')
334 $this->addElement('radio', 'radio_ts', NULL, '', 'ts_all',
335 array('onclick' => $this->getName() . ".toggleSelect.checked = false; toggleCheckboxVals('mark_x_',this); toggleTaskAction( true );")
340 $this->addButtons(array(
343 'name' => ts('Search'),
350 * The post processing of the form gets done here.
352 * Key things done during post processing are
353 * - check for reset or next request. if present, skip post procesing.
354 * - now check if user requested running a saved search, if so, then
355 * the form values associated with the saved search are used for searching.
356 * - if user has done a submit with new values the regular post submissing is
358 * The processing consists of using a Selector / Controller framework for getting the
366 function postProcess() {
373 if (!empty($_POST)) {
374 $this->_formValues
= $this->controller
->exportValues($this->_name
);
377 if (empty($this->_formValues
)) {
378 $this->_formValues
= $this->controller
->exportValues($this->_name
);
381 $this->fixFormValues();
383 if (isset($this->_ssID
) && empty($_POST)) {
384 // if we are editing / running a saved search and the form has not been posted
385 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
388 // We don't show test records in summaries or dashboards
389 if (empty($this->_formValues
['participant_test']) && $this->_force
) {
390 $this->_formValues
["participant_test"] = 0;
393 CRM_Core_BAO_CustomValue
::fixFieldValueOfTypeMemo($this->_formValues
);
395 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
397 $this->set('formValues', $this->_formValues
);
398 $this->set('queryParams', $this->_queryParams
);
400 $buttonName = $this->controller
->getButtonName();
401 if ($buttonName == $this->_actionButtonName ||
$buttonName == $this->_printButtonName
) {
402 // check actionName and if next, then do not repeat a search, since we are going to the next page
404 // hack, make sure we reset the task values
405 $stateMachine = $this->controller
->getStateMachine();
406 $formName = $stateMachine->getTaskFormName();
407 $this->controller
->resetPage($formName);
412 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
413 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
414 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
418 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
420 $selector = new CRM_Event_Selector_Search($this->_queryParams
,
428 $selector->setKey($this->controller
->_key
);
431 if ($this->_context
== 'user') {
432 $prefix = $this->_prefix
;
435 $this->assign("{$prefix}limit", $this->_limit
);
436 $this->assign("{$prefix}single", $this->_single
);
438 $controller = new CRM_Core_Selector_Controller($selector,
439 $this->get(CRM_Utils_Pager
::PAGE_ID
),
441 CRM_Core_Action
::VIEW
,
443 CRM_Core_Selector_Controller
::SESSION
,
446 $controller->setEmbedded(TRUE);
448 $query = $selector->getQuery();
449 if ($this->_context
== 'user') {
450 $query->setSkipPermission(TRUE);
456 * This function is used to add the rules (mainly global rules) for form.
457 * All local rules are added near the element
463 function addRules() {
464 $this->addFormRule(array('CRM_Event_Form_Search', 'formRule'));
468 * global validation rules for the form
470 * @param array $fields posted values of the form
471 * @param array $errors list of errors to be posted back to the form
477 static function formRule($fields) {
480 if ($fields['event_name'] && !is_numeric($fields['event_id'])) {
481 $errors['event_id'] = ts('Please select valid event.');
484 if ($fields['event_type'] && !is_numeric($fields['event_type_id'])) {
485 $errors['event_type'] = ts('Please select valid event type.');
487 if (!empty($errors)) {
495 * Set the default form values
499 * @return array the default array reference
501 function setDefaultValues() {
503 $defaults = $this->_formValues
;
507 function fixFormValues() {
508 // if this search has been forced
509 // then see if there are any get values, and if so over-ride the post values
510 // note that this means that GET over-rides POST :)
511 $event = CRM_Utils_Request
::retrieve('event', 'Positive',
512 CRM_Core_DAO
::$_nullObject
515 $this->_formValues
['event_id'] = $event;
516 $this->_formValues
['event_name'] = CRM_Event_PseudoConstant
::event($event, TRUE);
519 $status = CRM_Utils_Request
::retrieve('status', 'String',
520 CRM_Core_DAO
::$_nullObject
523 if (isset($status)) {
524 if ($status === 'true') {
525 $statusTypes = CRM_Event_PseudoConstant
::participantStatus(NULL, "is_counted = 1");
527 elseif ($status === 'false') {
528 $statusTypes = CRM_Event_PseudoConstant
::participantStatus(NULL, "is_counted = 0");
530 elseif (is_numeric($status)) {
531 $status = (int) $status;
532 $statusTypes = array($status => CRM_Event_PseudoConstant
::participantStatus($status));
535 foreach ($statusTypes as $key => $value) {
538 $this->_formValues
['participant_status_id'] = $status;
541 $role = CRM_Utils_Request
::retrieve('role', 'String',
542 CRM_Core_DAO
::$_nullObject
546 if ($role === 'true') {
547 $roleTypes = CRM_Event_PseudoConstant
::participantRole(NULL, "filter = 1");
549 elseif ($role === 'false') {
550 $roleTypes = CRM_Event_PseudoConstant
::participantRole(NULL, "filter = 0");
552 elseif (is_numeric($role)) {
554 $roleTypes = array($role => CRM_Event_PseudoConstant
::participantRole($role));
557 foreach ($roleTypes as $key => $value) {
560 $this->_formValues
['participant_role_id'] = $role;
563 $type = CRM_Utils_Request
::retrieve('type', 'Positive',
564 CRM_Core_DAO
::$_nullObject
567 $this->_formValues
['event_type'] = $type;
570 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
573 $cid = CRM_Utils_Type
::escape($cid, 'Integer');
575 $this->_formValues
['contact_id'] = $cid;
577 // also assign individual mode to the template
578 $this->_single
= TRUE;
583 function getFormValues() {
588 * Return a descriptive name for the page, used in wizard header
593 public function getTitle() {
594 return ts('Find Participants');