3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
35 * Base Search / View form for *all* listing of multiple
38 class CRM_Contact_Form_Search
extends CRM_Core_Form_Search
{
41 * list of valid contexts.
45 static $_validContext = NULL;
48 * List of values used when we want to display other objects.
52 static $_modeValues = NULL;
59 protected $_contextMenu;
62 * The groupId retrieved from the GET vars.
69 * The Group ID belonging to Add Member to group ID.
70 * retrieved from the GET vars
77 * The saved search ID retrieved from the GET vars.
89 public $_groupElement;
100 * The params used for search.
107 * The return properties used for search.
111 protected $_returnProperties;
114 * The sort by character.
118 protected $_sortByCharacter;
121 * The profile group id used for display.
125 protected $_ufGroupID;
128 * Csv - common search values
132 static $csv = array('contact_type', 'group', 'tag');
135 * @var string how to display the results. Should we display as
136 * contributons, members, cases etc
138 protected $_componentMode;
141 * @var string what operator should we use, AND or OR
143 protected $_operator;
145 protected $_modeValue;
148 * Declare entity reference fields as they will need to be converted to using 'IN'.
152 protected $entityReferenceFields = array('event_id', 'membership_type_id');
155 * Name of the selector to use.
157 static $_selectorName = 'CRM_Contact_Selector';
158 protected $_customSearchID = NULL;
159 protected $_customSearchClass = NULL;
161 protected $_openedPanes = array();
164 * Explicitly declare the entity api name.
166 public function getDefaultEntity() {
171 * Define the set of valid contexts that the search form operates on.
174 * the valid context set and the titles
176 public static function &validContext() {
177 if (!(self
::$_validContext)) {
178 self
::$_validContext = array(
179 'smog' => 'Show members of group',
180 'amtg' => 'Add members to group',
181 'basic' => 'Basic Search',
182 'search' => 'Search',
183 'builder' => 'Search Builder',
184 'advanced' => 'Advanced Search',
185 'custom' => 'Custom Search',
188 return self
::$_validContext;
196 public static function isSearchContext($context) {
197 $searchContext = CRM_Utils_Array
::value($context, self
::validContext());
198 return $searchContext ?
TRUE : FALSE;
201 public static function setModeValues() {
202 self
::$_modeValues = array(
203 CRM_Contact_BAO_Query
::MODE_CONTACTS
=> array(
204 'selectorName' => self
::$_selectorName,
205 'selectorLabel' => ts('Contacts'),
206 'taskFile' => 'CRM/Contact/Form/Search/ResultTasks.tpl',
207 'taskContext' => NULL,
208 'resultFile' => 'CRM/Contact/Form/Selector.tpl',
209 'resultContext' => NULL,
210 'taskClassName' => 'CRM_Contact_Task',
213 CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
=> array(
214 'selectorName' => 'CRM_Contribute_Selector_Search',
215 'selectorLabel' => ts('Contributions'),
216 'taskFile' => 'CRM/common/searchResultTasks.tpl',
217 'taskContext' => 'Contribution',
218 'resultFile' => 'CRM/Contribute/Form/Selector.tpl',
219 'resultContext' => 'Search',
220 'taskClassName' => 'CRM_Contribute_Task',
221 'component' => 'CiviContribute',
223 CRM_Contact_BAO_Query
::MODE_EVENT
=> array(
224 'selectorName' => 'CRM_Event_Selector_Search',
225 'selectorLabel' => ts('Event Participants'),
226 'taskFile' => 'CRM/common/searchResultTasks.tpl',
227 'taskContext' => NULL,
228 'resultFile' => 'CRM/Event/Form/Selector.tpl',
229 'resultContext' => 'Search',
230 'taskClassName' => 'CRM_Event_Task',
231 'component' => 'CiviEvent',
233 CRM_Contact_BAO_Query
::MODE_ACTIVITY
=> array(
234 'selectorName' => 'CRM_Activity_Selector_Search',
235 'selectorLabel' => ts('Activities'),
236 'taskFile' => 'CRM/common/searchResultTasks.tpl',
237 'taskContext' => NULL,
238 'resultFile' => 'CRM/Activity/Form/Selector.tpl',
239 'resultContext' => 'Search',
240 'taskClassName' => 'CRM_Activity_Task',
241 'component' => 'activity',
243 CRM_Contact_BAO_Query
::MODE_MEMBER
=> array(
244 'selectorName' => 'CRM_Member_Selector_Search',
245 'selectorLabel' => ts('Memberships'),
246 'taskFile' => "CRM/common/searchResultTasks.tpl",
247 'taskContext' => NULL,
248 'resultFile' => 'CRM/Member/Form/Selector.tpl',
249 'resultContext' => 'Search',
250 'taskClassName' => 'CRM_Member_Task',
251 'component' => 'CiviMember',
253 CRM_Contact_BAO_Query
::MODE_CASE
=> array(
254 'selectorName' => 'CRM_Case_Selector_Search',
255 'selectorLabel' => ts('Cases'),
256 'taskFile' => "CRM/common/searchResultTasks.tpl",
257 'taskContext' => NULL,
258 'resultFile' => 'CRM/Case/Form/Selector.tpl',
259 'resultContext' => 'Search',
260 'taskClassName' => 'CRM_Case_Task',
261 'component' => 'CiviCase',
263 CRM_Contact_BAO_Query
::MODE_CONTACTSRELATED
=> array(
264 'selectorName' => self
::$_selectorName,
265 'selectorLabel' => ts('Related Contacts'),
266 'taskFile' => 'CRM/Contact/Form/Search/ResultTasks.tpl',
267 'taskContext' => NULL,
268 'resultFile' => 'CRM/Contact/Form/Selector.tpl',
269 'resultContext' => NULL,
270 'taskClassName' => 'CRM_Contact_Task',
271 'component' => 'related_contact',
273 CRM_Contact_BAO_Query
::MODE_MAILING
=> array(
274 'selectorName' => 'CRM_Mailing_Selector_Search',
275 'selectorLabel' => ts('Mailings'),
276 'taskFile' => "CRM/common/searchResultTasks.tpl",
277 'taskContext' => NULL,
278 'resultFile' => 'CRM/Mailing/Form/Selector.tpl',
279 'resultContext' => 'Search',
280 'taskClassName' => 'CRM_Mailing_Task',
281 'component' => 'CiviMail',
287 * Get the metadata for the query mode (this includes task class names)
292 * @throws \CRM_Core_Exception
294 public static function getModeValue($mode = CRM_Contact_BAO_Query
::MODE_CONTACTS
) {
295 $searchPane = CRM_Utils_Request
::retrieve('searchPane', 'String');
296 if (!empty($searchPane)) {
297 $mode = array_search($searchPane, self
::getModeToComponentMapping());
300 self
::setModeValues();
301 if (!array_key_exists($mode, self
::$_modeValues)) {
302 $mode = CRM_Contact_BAO_Query
::MODE_CONTACTS
;
305 return self
::$_modeValues[$mode];
309 * Get a mapping of modes to components.
311 * This will map the integers to the components. Contact has an empty component
312 * an pseudo-components exist for activity & related_contact.
316 public static function getModeToComponentMapping() {
318 self
::setModeValues();
320 foreach (self
::$_modeValues as $id => $metadata) {
321 $mapping[$id] = $metadata['component'];
329 public static function getModeSelect() {
330 self
::setModeValues();
332 $componentModes = array();
333 foreach (self
::$_modeValues as $id => & $value) {
334 $componentModes[$id] = $value['selectorLabel'];
337 $enabledComponents = CRM_Core_Component
::getEnabledComponents();
339 // unset disabled components
340 if (!array_key_exists('CiviMail', $enabledComponents)) {
341 unset($componentModes[CRM_Contact_BAO_Query
::MODE_MAILING
]);
344 // unset contributions or participants if user does not have permission on them
345 if (!CRM_Core_Permission
::access('CiviContribute')) {
346 unset($componentModes[CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
]);
349 if (!CRM_Core_Permission
::access('CiviEvent')) {
350 unset($componentModes[CRM_Contact_BAO_Query
::MODE_EVENT
]);
353 if (!CRM_Core_Permission
::access('CiviMember')) {
354 unset($componentModes[CRM_Contact_BAO_Query
::MODE_MEMBER
]);
357 if (!CRM_Core_Permission
::check('view all activities')) {
358 unset($componentModes[CRM_Contact_BAO_Query
::MODE_ACTIVITY
]);
361 return $componentModes;
365 * Builds the list of tasks or actions that a searcher can perform on a result set.
369 public function buildTaskList() {
370 // amtg = 'Add members to group'
371 if ($this->_context
!== 'amtg') {
372 $taskParams['deletedContacts'] = FALSE;
373 if ($this->_componentMode
== CRM_Contact_BAO_Query
::MODE_CONTACTS ||
$this->_componentMode
== CRM_Contact_BAO_Query
::MODE_CONTACTSRELATED
) {
374 $taskParams['deletedContacts'] = CRM_Utils_Array
::value('deleted_contacts', $this->_formValues
);
376 $className = $this->_modeValue
['taskClassName'];
377 $taskParams['ssID'] = isset($this->_ssID
) ?
$this->_ssID
: NULL;
378 $this->_taskList +
= $className::permissionedTaskTitles(CRM_Core_Permission
::getPermission(), $taskParams);
381 return $this->_taskList
;
385 * Build the common elements between the search/advanced form.
387 public function buildQuickForm() {
388 parent
::buildQuickForm();
389 CRM_Core_Resources
::singleton()
390 // jsTree is needed for tags popup
391 ->addScriptFile('civicrm', 'packages/jquery/plugins/jstree/jquery.jstree.js', 0, 'html-header', FALSE)
392 ->addStyleFile('civicrm', 'packages/jquery/plugins/jstree/themes/default/style.css', 0, 'html-header');
394 // some tasks.. what do we want to do with the selected contacts ?
395 $this->_taskList
= $this->buildTaskList();
397 if (isset($this->_ssID
)) {
399 = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_SavedSearch', $this->_ssID
, 'search_custom_id');
401 $savedSearchValues = array(
402 'id' => $this->_ssID
,
403 'name' => CRM_Contact_BAO_SavedSearch
::getName($this->_ssID
, 'title'),
404 'search_custom_id' => $search_custom_id,
406 $this->assign_by_ref('savedSearch', $savedSearchValues);
407 $this->assign('ssID', $this->_ssID
);
410 if ($this->_context
=== 'smog') {
411 // CRM-11788, we might want to do this for all of search where force=1
412 $formQFKey = CRM_Utils_Array
::value('qfKey', $this->_formValues
);
413 $getQFKey = CRM_Utils_Array
::value('qfKey', $_GET);
414 $postQFKey = CRM_Utils_Array
::value('qfKey', $_POST);
415 if ($formQFKey && empty($getQFKey) && empty($postQFKey)) {
416 $url = CRM_Utils_System
::makeURL('qfKey') . $formQFKey;
417 CRM_Utils_System
::redirect($url);
419 $permissionForGroup = FALSE;
421 if (!empty($this->_groupID
)) {
422 // check if user has permission to edit members of this group
423 $permission = CRM_Contact_BAO_Group
::checkPermission($this->_groupID
);
424 if ($permission && in_array(CRM_Core_Permission
::EDIT
, $permission)) {
425 $permissionForGroup = TRUE;
428 // check if _groupID exists, it might not if
429 // we are displaying a hidden group
430 if (!isset($this->_group
[$this->_groupID
])) {
431 $this->_group
[$this->_groupID
]
432 = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $this->_groupID
, 'title');
435 // set the group title
436 $groupValues = array('id' => $this->_groupID
, 'title' => $this->_group
[$this->_groupID
]);
437 $this->assign_by_ref('group', $groupValues);
439 // also set ssID if this is a saved search
440 $ssID = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $this->_groupID
, 'saved_search_id');
441 $this->assign('ssID', $ssID);
443 //get the saved search mapping id
445 $this->_ssID
= $ssID;
446 $ssMappingId = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_SavedSearch', $ssID, 'mapping_id');
447 $this->assign('ssMappingID', $ssMappingId);
450 // Set dynamic page title for 'Show Members of Group'
451 CRM_Utils_System
::setTitle(ts('Contacts in Group: %1', array(1 => $this->_group
[$this->_groupID
])));
454 $group_contact_status = array();
455 foreach (CRM_Core_SelectValues
::groupContactStatus() as $k => $v) {
457 $group_contact_status[] = $this->createElement('checkbox', $k, NULL, $v);
460 $this->addGroup($group_contact_status,
461 'group_contact_status', ts('Group Status')
464 $this->assign('permissionedForGroup', $permissionForGroup);
467 // add the go button for the action form, note it is of type 'next' rather than of type 'submit'
468 if ($this->_context
=== 'amtg') {
469 // check if _groupID exists, it might not if
470 // we are displaying a hidden group
471 if (!isset($this->_group
[$this->_amtgID
])) {
472 $this->assign('permissionedForGroup', FALSE);
473 $this->_group
[$this->_amtgID
]
474 = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $this->_amtgID
, 'title');
477 // Set dynamic page title for 'Add Members Group'
478 CRM_Utils_System
::setTitle(ts('Add to Group: %1', array(1 => $this->_group
[$this->_amtgID
])));
479 // also set the group title and freeze the action task with Add Members to Group
480 $groupValues = array('id' => $this->_amtgID
, 'title' => $this->_group
[$this->_amtgID
]);
481 $this->assign_by_ref('group', $groupValues);
482 $this->add('submit', $this->_actionButtonName
, ts('Add Contacts to %1', array(1 => $this->_group
[$this->_amtgID
])),
484 'class' => 'crm-form-submit',
487 $this->add('hidden', 'task', CRM_Contact_Task
::GROUP_ADD
);
488 $selectedRowsRadio = $this->addElement('radio', 'radio_ts', NULL, '', 'ts_sel', array('checked' => 'checked'));
489 $allRowsRadio = $this->addElement('radio', 'radio_ts', NULL, '', 'ts_all');
490 $this->assign('ts_sel_id', $selectedRowsRadio->_attributes
['id']);
491 $this->assign('ts_all_id', $allRowsRadio->_attributes
['id']);
494 $selectedContactIds = array();
495 $qfKeyParam = CRM_Utils_Array
::value('qfKey', $this->_formValues
);
496 // We use ajax to handle selections only if the search results component_mode is set to "contacts"
497 if ($qfKeyParam && ($this->get('component_mode') <= CRM_Contact_BAO_Query
::MODE_CONTACTS ||
$this->get('component_mode') == CRM_Contact_BAO_Query
::MODE_CONTACTSRELATED
)) {
498 $this->addClass('crm-ajax-selection-form');
499 $qfKeyParam = "civicrm search {$qfKeyParam}";
500 $selectedContactIdsArr = Civi
::service('prevnext')->getSelection($qfKeyParam);
501 $selectedContactIds = array_keys($selectedContactIdsArr[$qfKeyParam]);
504 $this->assign_by_ref('selectedContactIds', $selectedContactIds);
506 $rows = $this->get('rows');
508 if (is_array($rows)) {
509 $this->addRowSelectors($rows);
515 * Processing needed for buildForm and later.
517 public function preProcess() {
518 // set the various class variables
520 $this->_group
= CRM_Core_PseudoConstant
::group();
522 $this->_tag
= CRM_Core_BAO_Tag
::getTags();
523 $this->_done
= FALSE;
526 * we allow the controller to set force/reset externally, useful when we are being
527 * driven by the wizard framework
530 $this->_reset
= CRM_Utils_Request
::retrieve('reset', 'Boolean');
532 $this->_force
= CRM_Utils_Request
::retrieve('force', 'Boolean');
533 $this->_groupID
= CRM_Utils_Request
::retrieve('gid', 'Positive', $this);
534 $this->_amtgID
= CRM_Utils_Request
::retrieve('amtgID', 'Positive', $this);
535 $this->_ssID
= CRM_Utils_Request
::retrieve('ssID', 'Positive', $this);
536 $this->_sortByCharacter
= CRM_Utils_Request
::retrieve('sortByCharacter', 'String', $this);
537 $this->_ufGroupID
= CRM_Utils_Request
::retrieve('id', 'Positive', $this);
538 $this->_componentMode
= CRM_Utils_Request
::retrieve('component_mode', 'Positive', $this, FALSE, CRM_Contact_BAO_Query
::MODE_CONTACTS
, $_REQUEST);
539 $this->_operator
= CRM_Utils_Request
::retrieve('operator', 'String', $this, FALSE, CRM_Contact_BAO_Query
::SEARCH_OPERATOR_AND
, 'REQUEST');
542 * set the button names
544 $this->_searchButtonName
= $this->getButtonName('refresh');
545 $this->_actionButtonName
= $this->getButtonName('next', 'action');
547 $this->assign('actionButtonName', $this->_actionButtonName
);
549 // if we dont get this from the url, use default if one exsts
550 $config = CRM_Core_Config
::singleton();
551 if ($this->_ufGroupID
== NULL &&
552 $config->defaultSearchProfileID
!= NULL
554 $this->_ufGroupID
= $config->defaultSearchProfileID
;
557 // assign context to drive the template display, make sure context is valid
558 $this->_context
= CRM_Utils_Request
::retrieve('context', 'Alphanumeric', $this, FALSE, 'search');
559 if (!CRM_Utils_Array
::value($this->_context
, self
::validContext())) {
560 $this->_context
= 'search';
562 $this->set('context', $this->_context
);
563 $this->assign('context', $this->_context
);
565 $this->_modeValue
= self
::getModeValue($this->_componentMode
);
566 $this->assign($this->_modeValue
);
568 $this->set('selectorName', self
::$_selectorName);
570 // get user submitted values
571 // get it from controller only if form has been submitted, else preProcess has set this
572 // $this->controller->isModal( ) returns TRUE if page is
573 // valid, i.e all the validations are TRUE
575 if (!empty($_POST) && !$this->controller
->isModal()) {
576 $this->_formValues
= $this->controller
->exportValues($this->_name
);
578 $this->normalizeFormValues();
579 $this->_params
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
, 0, FALSE, NULL, $this->entityReferenceFields
);
580 $this->_returnProperties
= &$this->returnProperties();
582 // also get the uf group id directly from the post value
583 $this->_ufGroupID
= CRM_Utils_Array
::value('uf_group_id', $_POST, $this->_ufGroupID
);
584 $this->_formValues
['uf_group_id'] = $this->_ufGroupID
;
585 $this->set('id', $this->_ufGroupID
);
587 // also get the object mode directly from the post value
588 $this->_componentMode
= CRM_Utils_Array
::value('component_mode', $_POST, $this->_componentMode
);
590 // also get the operator from the post value if set
591 $this->_operator
= CRM_Utils_Array
::value('operator', $_POST, $this->_operator
);
592 $this->_formValues
['operator'] = $this->_operator
;
593 $this->set('operator', $this->_operator
);
596 $this->_formValues
= $this->get('formValues');
597 $this->_params
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
, 0, FALSE, NULL, $this->entityReferenceFields
);
598 $this->_returnProperties
= &$this->returnProperties();
599 if (!empty($this->_ufGroupID
)) {
600 $this->set('id', $this->_ufGroupID
);
604 if (empty($this->_formValues
)) {
605 //check if group is a smart group (fix for CRM-1255)
606 if ($this->_groupID
) {
607 if ($ssId = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $this->_groupID
, 'saved_search_id')) {
608 $this->_ssID
= $ssId;
613 if (isset($this->_ssID
) && $this->_context
!= 'smog') {
614 // we only retrieve the saved search values if out current values are null
615 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
618 if (CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_SavedSearch', $this->_ssID
, 'mapping_id')) {
619 $this->_params
= CRM_Contact_BAO_SavedSearch
::getSearchParams($this->_ssID
);
622 $this->_params
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
624 $this->_returnProperties
= &$this->returnProperties();
627 if (isset($this->_ufGroupID
)) {
628 // also set the uf group id if not already present
629 $this->_formValues
['uf_group_id'] = $this->_ufGroupID
;
631 if (isset($this->_componentMode
)) {
632 $this->_formValues
['component_mode'] = $this->_componentMode
;
634 if (isset($this->_operator
)) {
635 $this->_formValues
['operator'] = $this->_operator
;
638 // FIXME: we should generalise in a way that components could inject url-filters
639 // just like they build their own form elements
642 'mailing_delivery_status',
643 'mailing_open_status',
644 'mailing_click_status',
645 'mailing_reply_status',
648 'mailing_unsubscribe',
651 ) as $mailingFilter) {
653 if ($mailingFilter == 'mailing_id' &&
654 $filterVal = CRM_Utils_Request
::retrieve('mailing_id', 'Positive', $this)
656 $this->_formValues
[$mailingFilter] = array($filterVal);
658 elseif ($filterVal = CRM_Utils_Request
::retrieve($mailingFilter, $type, $this)) {
659 $this->_formValues
[$mailingFilter] = $filterVal;
662 $this->_openedPanes
['Mailings'] = 1;
663 $this->_formValues
['hidden_CiviMail'] = 1;
669 CRM_Utils_Array
::value('uf_group_id', $this->_formValues
)
671 $operator = CRM_Utils_Array
::value('operator', $this->_formValues
, CRM_Contact_BAO_Query
::SEARCH_OPERATOR_AND
);
672 $this->set('queryOperator', $operator);
673 if ($operator == CRM_Contact_BAO_Query
::SEARCH_OPERATOR_OR
) {
674 $this->assign('operator', ts('OR'));
677 $this->assign('operator', ts('AND'));
680 // show the context menu only when we’re not searching for deleted contacts; CRM-5673
681 if (empty($this->_formValues
['deleted_contacts'])) {
682 $menuItems = CRM_Contact_BAO_Contact
::contextMenu();
683 $primaryActions = CRM_Utils_Array
::value('primaryActions', $menuItems, array());
684 $this->_contextMenu
= CRM_Utils_Array
::value('moreActions', $menuItems, array());
685 $this->assign('contextMenu', $primaryActions +
$this->_contextMenu
);
688 if (!isset($this->_componentMode
)) {
689 $this->_componentMode
= CRM_Contact_BAO_Query
::MODE_CONTACTS
;
691 self
::$_selectorName = $this->_modeValue
['selectorName'];
692 self
::setModeValues();
695 if (strpos(self
::$_selectorName, 'CRM_Contact_Selector') !== FALSE) {
696 $selector = new self
::$_selectorName(
697 $this->_customSearchClass
,
700 $this->_returnProperties
,
709 $selector = new self
::$_selectorName(
717 $selector->setKey($this->controller
->_key
);
719 $controller = new CRM_Contact_Selector_Controller($selector,
720 $this->get(CRM_Utils_Pager
::PAGE_ID
),
721 $this->get(CRM_Utils_Sort
::SORT_ID
),
722 CRM_Core_Action
::VIEW
,
724 CRM_Core_Selector_Controller
::TRANSFER
726 $controller->setEmbedded(TRUE);
727 $controller->setDynamicAction($setDynamic);
731 $this->postProcess();
734 * Note that we repeat this, since the search creates and stores
735 * values that potentially change the controller behavior. i.e. things
736 * like totalCount etc
739 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
740 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
741 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
744 $controller = new CRM_Contact_Selector_Controller($selector,
745 $this->get(CRM_Utils_Pager
::PAGE_ID
),
747 CRM_Core_Action
::VIEW
, $this, CRM_Core_Selector_Controller
::TRANSFER
749 $controller->setEmbedded(TRUE);
750 $controller->setDynamicAction($setDynamic);
753 $controller->moveFromSessionToTemplate();
759 public function &getFormValues() {
760 return $this->_formValues
;
764 * Common post processing.
766 public function postProcess() {
768 * sometime we do a postProcess early on, so we dont need to repeat it
769 * this will most likely introduce some more bugs :(
777 //for prev/next pagination
778 $crmPID = CRM_Utils_Request
::retrieve('crmPID', 'Integer');
780 if (array_key_exists($this->_searchButtonName
, $_POST) ||
781 ($this->_force
&& !$crmPID)
783 //reset the cache table for new search
784 $cacheKey = "civicrm search {$this->controller->_key}";
785 Civi
::service('prevnext')->deleteItem(NULL, $cacheKey);
788 //get the button name
789 $buttonName = $this->controller
->getButtonName();
791 if (isset($this->_ufGroupID
) && empty($this->_formValues
['uf_group_id'])) {
792 $this->_formValues
['uf_group_id'] = $this->_ufGroupID
;
795 if (isset($this->_componentMode
) && empty($this->_formValues
['component_mode'])) {
796 $this->_formValues
['component_mode'] = $this->_componentMode
;
799 if (isset($this->_operator
) && empty($this->_formValues
['operator'])) {
800 $this->_formValues
['operator'] = $this->_operator
;
803 if (empty($this->_formValues
['qfKey'])) {
804 $this->_formValues
['qfKey'] = $this->controller
->_key
;
807 if (!CRM_Core_Permission
::check('access deleted contacts')) {
808 unset($this->_formValues
['deleted_contacts']);
811 $this->set('type', $this->_action
);
812 $this->set('formValues', $this->_formValues
);
813 $this->set('queryParams', $this->_params
);
814 $this->set('returnProperties', $this->_returnProperties
);
816 if ($buttonName == $this->_actionButtonName
) {
817 // check actionName and if next, then do not repeat a search, since we are going to the next page
818 // hack, make sure we reset the task values
819 $stateMachine = $this->controller
->getStateMachine();
820 $formName = $stateMachine->getTaskFormName();
821 $this->controller
->resetPage($formName);
825 $output = CRM_Core_Selector_Controller
::SESSION
;
827 // create the selector, controller and run - store results in session
828 $searchChildGroups = TRUE;
829 if ($this->get('isAdvanced')) {
830 $searchChildGroups = FALSE;
835 if (strpos(self
::$_selectorName, 'CRM_Contact_Selector') !== FALSE) {
836 $selector = new self
::$_selectorName(
837 $this->_customSearchClass
,
840 $this->_returnProperties
,
850 $selector = new self
::$_selectorName(
861 $selector->setKey($this->controller
->_key
);
863 // added the sorting character to the form array
864 $config = CRM_Core_Config
::singleton();
865 // do this only for contact search
866 if ($setDynamic && $config->includeAlphabeticalPager
) {
867 // Don't recompute if we are just paging/sorting
868 if ($this->_reset ||
(empty($_GET['crmPID']) && empty($_GET['crmSID']) && !$this->_sortByCharacter
)) {
869 $aToZBar = CRM_Utils_PagerAToZ
::getAToZBar($selector, $this->_sortByCharacter
);
870 $this->set('AToZBar', $aToZBar);
875 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
876 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
877 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
880 $controller = new CRM_Contact_Selector_Controller($selector,
881 $this->get(CRM_Utils_Pager
::PAGE_ID
),
883 CRM_Core_Action
::VIEW
,
887 $controller->setEmbedded(TRUE);
888 $controller->setDynamicAction($setDynamic);
896 public function &returnProperties() {
897 return CRM_Core_DAO
::$_nullObject;
901 * Return a descriptive name for the page, used in wizard header
905 public function getTitle() {