3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
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 * This file is for Case search.
37 class CRM_Case_Form_Search
extends CRM_Core_Form_Search
{
40 * The params that are sent to the query
44 protected $_queryParams;
47 * Are we restricting ourselves to a single contact
51 protected $_single = FALSE;
54 * Are we restricting ourselves to a single contact
58 protected $_limit = NULL;
61 * Prefix for the controller
63 protected $_prefix = 'case_';
66 * Processing needed for buildForm and later.
68 public function preProcess() {
69 $this->set('searchFormName', 'Search');
71 //check for civicase access.
72 if (!CRM_Case_BAO_Case
::accessCiviCase()) {
73 CRM_Core_Error
::fatal(ts('You are not authorized to access this page.'));
76 //validate case configuration.
77 $configured = CRM_Case_BAO_Case
::isCaseConfigured();
78 $this->assign('notConfigured', !$configured['configured']);
79 if (!$configured['configured']) {
84 * set the button names
86 $this->_searchButtonName
= $this->getButtonName('refresh');
87 $this->_actionButtonName
= $this->getButtonName('next', 'action');
90 $this->defaults
= array();
93 * we allow the controller to set force/reset externally, useful when we are being
94 * driven by the wizard framework
97 $this->_reset
= CRM_Utils_Request
::retrieve('reset', 'Boolean');
98 $this->_force
= CRM_Utils_Request
::retrieve('force', 'Boolean', $this, FALSE);
99 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive', $this);
100 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this, FALSE, 'search');
102 $this->assign('context', $this->_context
);
104 // get user submitted values
105 // get it from controller only if form has been submitted, else preProcess has set this
106 if (!empty($_POST) && !$this->controller
->isModal()) {
107 $this->_formValues
= $this->controller
->exportValues($this->_name
);
110 $this->_formValues
= $this->get('formValues');
113 if (empty($this->_formValues
)) {
114 if (isset($this->_ssID
)) {
115 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
120 $this->postProcess();
121 $this->set('force', 0);
125 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
126 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
127 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
131 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
132 $selector = new CRM_Case_Selector_Search($this->_queryParams
,
141 if ($this->_context
== 'user') {
142 $prefix = $this->_prefix
;
145 $this->assign("{$prefix}limit", $this->_limit
);
146 $this->assign("{$prefix}single", $this->_single
);
148 $controller = new CRM_Core_Selector_Controller($selector,
149 $this->get(CRM_Utils_Pager
::PAGE_ID
),
151 CRM_Core_Action
::VIEW
,
153 CRM_Core_Selector_Controller
::TRANSFER
,
156 $controller->setEmbedded(TRUE);
157 $controller->moveFromSessionToTemplate();
159 $this->assign('summary', $this->get('summary'));
163 * Build the form object.
165 public function buildQuickForm() {
166 parent
::buildQuickForm();
167 $this->addSortNameField();
169 CRM_Case_BAO_Query
::buildSearchForm($this);
171 $rows = $this->get('rows');
172 if (is_array($rows)) {
173 if (!$this->_single
) {
174 $this->addRowSelectors($rows);
177 $tasks = CRM_Case_Task
::permissionedTaskTitles(CRM_Core_Permission
::getPermission());
179 if (!empty($this->_formValues
['case_deleted'])) {
180 unset($tasks[CRM_Case_Task
::DELETE
]);
183 unset($tasks[CRM_Case_Task
::RESTORE_CASES
]);
186 $this->addTaskMenu($tasks);
192 * Get the label for the sortName field if email searching is on.
194 * (email searching is a setting under search preferences).
198 protected function getSortNameLabelWithEmail() {
199 return ts('Client Name or Email');
203 * Get the label for the sortName field if email searching is off.
205 * (email searching is a setting under search preferences).
209 protected function getSortNameLabelWithOutEmail() {
210 return ts('Client Name');
214 * The post processing of the form gets done here.
216 * Key things done during post processing are
217 * - check for reset or next request. if present, skip post procesing.
218 * - now check if user requested running a saved search, if so, then
219 * the form values associated with the saved search are used for searching.
220 * - if user has done a submit with new values the regular post submissing is
222 * The processing consists of using a Selector / Controller framework for getting the
225 public function postProcess() {
231 $this->_formValues
= $this->controller
->exportValues($this->_name
);
232 $this->fixFormValues();
234 if (isset($this->_ssID
) && empty($_POST)) {
235 // if we are editing / running a saved search and the form has not been posted
236 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
239 //search for civicase
240 if (!$this->_force
) {
241 if (array_key_exists('case_owner', $this->_formValues
) && !$this->_formValues
['case_owner']) {
242 $this->_formValues
['case_owner'] = 0;
246 if (empty($this->_formValues
['case_deleted'])) {
247 $this->_formValues
['case_deleted'] = 0;
249 CRM_Core_BAO_CustomValue
::fixCustomFieldValue($this->_formValues
);
251 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
253 $this->set('formValues', $this->_formValues
);
254 $this->set('queryParams', $this->_queryParams
);
256 $buttonName = $this->controller
->getButtonName();
257 if ($buttonName == $this->_actionButtonName
) {
258 // check actionName and if next, then do not repeat a search, since we are going to the next page
260 // hack, make sure we reset the task values
261 $stateMachine = $this->controller
->getStateMachine();
262 $formName = $stateMachine->getTaskFormName();
263 $this->controller
->resetPage($formName);
268 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
269 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
270 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
274 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
276 $selector = new CRM_Case_Selector_Search($this->_queryParams
,
283 $selector->setKey($this->controller
->_key
);
286 if ($this->_context
== 'user') {
287 $prefix = $this->_prefix
;
290 $this->assign("{$prefix}limit", $this->_limit
);
291 $this->assign("{$prefix}single", $this->_single
);
293 $controller = new CRM_Core_Selector_Controller($selector,
294 $this->get(CRM_Utils_Pager
::PAGE_ID
),
296 CRM_Core_Action
::VIEW
,
298 CRM_Core_Selector_Controller
::SESSION
,
301 $controller->setEmbedded(TRUE);
303 $query = &$selector->getQuery();
304 if ($this->_context
== 'user') {
305 $query->setSkipPermission(TRUE);
311 * Add the rules (mainly global rules) for form.
313 * All local rules are added near the element
317 public function addRules() {
318 $this->addFormRule(array('CRM_Case_Form_Search', 'formRule'));
322 * Global validation rules for the form.
324 * @param array $fields
325 * Posted values of the form.
329 public static function formRule($fields) {
332 if (!empty($errors)) {
340 * Set the default form values.
344 * the default array reference
346 public function setDefaultValues() {
348 $defaults = $this->_formValues
;
352 public function fixFormValues() {
353 if (!$this->_force
) {
357 $caseStatus = CRM_Utils_Request
::retrieve('status', 'Positive');
359 $this->_formValues
['case_status_id'] = $caseStatus;
360 $this->_defaults
['case_status_id'] = $caseStatus;
362 $caseType = CRM_Utils_Request
::retrieve('type', 'Positive');
364 $this->_formValues
['case_type_id'] = (array) $caseType;
365 $this->_defaults
['case_type_id'] = (array) $caseType;
368 $caseFromDate = CRM_Utils_Request
::retrieve('pstart', 'Date');
370 list($date) = CRM_Utils_Date
::setDateDefaults($caseFromDate);
371 $this->_formValues
['case_start_date_low'] = $date;
372 $this->_defaults
['case_start_date_low'] = $date;
375 $caseToDate = CRM_Utils_Request
::retrieve('pend', 'Date');
377 list($date) = CRM_Utils_Date
::setDateDefaults($caseToDate);
378 $this->_formValues
['case_start_date_high'] = $date;
379 $this->_defaults
['case_start_date_high'] = $date;
382 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
384 $cid = CRM_Utils_Type
::escape($cid, 'Integer');
386 $this->_formValues
['contact_id'] = $cid;
387 list($display, $image) = CRM_Contact_BAO_Contact
::getDisplayAndImage($cid);
388 $this->_defaults
['sort_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid,
391 // also assign individual mode to the template
392 $this->_single
= TRUE;
396 // First, if "all" is stored in the session, default to all cases, otherwise default to no selection.
397 $session = CRM_Core_Session
::singleton();
398 if (CRM_Utils_Request
::retrieve('all', 'Positive', $session)) {
399 $this->_formValues
['case_owner'] = 1;
400 $this->_defaults
['case_owner'] = 1;
403 $this->_formValues
['case_owner'] = 0;
404 $this->_defaults
['case_owner'] = 0;
407 // Now if case_owner is set in the url/post, use that instead.
408 $caseOwner = CRM_Utils_Request
::retrieve('case_owner', 'Positive');
410 $this->_formValues
['case_owner'] = $caseOwner;
411 $this->_defaults
['case_owner'] = $caseOwner;
419 public function getFormValues() {
424 * Return a descriptive name for the page, used in wizard header
428 public function getTitle() {
429 return ts('Find Cases');