3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
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
64 protected $_prefix = 'case_';
67 * Processing needed for buildForm and later.
69 public function preProcess() {
70 $this->set('searchFormName', 'Search');
72 //check for civicase access.
73 if (!CRM_Case_BAO_Case
::accessCiviCase()) {
74 CRM_Core_Error
::fatal(ts('You are not authorized to access this page.'));
77 //validate case configuration.
78 $configured = CRM_Case_BAO_Case
::isCaseConfigured();
79 $this->assign('notConfigured', !$configured['configured']);
80 if (!$configured['configured']) {
85 * set the button names
87 $this->_searchButtonName
= $this->getButtonName('refresh');
88 $this->_actionButtonName
= $this->getButtonName('next', 'action');
92 $this->loadStandardSearchOptionsFromUrl();
93 $this->loadFormValues();
97 $this->set('force', 0);
101 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
102 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
103 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
107 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
108 $selector = new CRM_Case_Selector_Search($this->_queryParams
,
117 if ($this->_context
== 'user') {
118 $prefix = $this->_prefix
;
121 $this->assign("{$prefix}limit", $this->_limit
);
122 $this->assign("{$prefix}single", $this->_single
);
124 $controller = new CRM_Core_Selector_Controller($selector,
125 $this->get(CRM_Utils_Pager
::PAGE_ID
),
127 CRM_Core_Action
::VIEW
,
129 CRM_Core_Selector_Controller
::TRANSFER
,
132 $controller->setEmbedded(TRUE);
133 $controller->moveFromSessionToTemplate();
135 $this->assign('summary', $this->get('summary'));
139 * Build the form object.
141 public function buildQuickForm() {
142 parent
::buildQuickForm();
143 $this->addSortNameField();
145 CRM_Case_BAO_Query
::buildSearchForm($this);
147 $rows = $this->get('rows');
148 if (is_array($rows)) {
149 if (!$this->_single
) {
150 $this->addRowSelectors($rows);
153 $tasks = CRM_Case_Task
::permissionedTaskTitles(CRM_Core_Permission
::getPermission());
155 if (!empty($this->_formValues
['case_deleted'])) {
156 unset($tasks[CRM_Case_Task
::TASK_DELETE
]);
159 unset($tasks[CRM_Case_Task
::RESTORE_CASES
]);
162 $this->addTaskMenu($tasks);
168 * Get the label for the sortName field if email searching is on.
170 * (email searching is a setting under search preferences).
174 protected function getSortNameLabelWithEmail() {
175 return ts('Client Name or Email');
179 * Get the label for the sortName field if email searching is off.
181 * (email searching is a setting under search preferences).
185 protected function getSortNameLabelWithOutEmail() {
186 return ts('Client Name');
190 * The post processing of the form gets done here.
192 * Key things done during post processing are
193 * - check for reset or next request. if present, skip post procesing.
194 * - now check if user requested running a saved search, if so, then
195 * the form values associated with the saved search are used for searching.
196 * - if user has done a submit with new values the regular post submissing is
198 * The processing consists of using a Selector / Controller framework for getting the
201 public function postProcess() {
207 $this->_formValues
= $this->controller
->exportValues($this->_name
);
208 $this->fixFormValues();
210 if (isset($this->_ssID
) && empty($_POST)) {
211 // if we are editing / running a saved search and the form has not been posted
212 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
215 //search for civicase
216 if (!$this->_force
) {
217 if (array_key_exists('case_owner', $this->_formValues
) && !$this->_formValues
['case_owner']) {
218 $this->_formValues
['case_owner'] = 0;
222 if (empty($this->_formValues
['case_deleted'])) {
223 $this->_formValues
['case_deleted'] = 0;
225 CRM_Core_BAO_CustomValue
::fixCustomFieldValue($this->_formValues
);
227 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
229 $this->set('formValues', $this->_formValues
);
230 $this->set('queryParams', $this->_queryParams
);
232 $buttonName = $this->controller
->getButtonName();
233 if ($buttonName == $this->_actionButtonName
) {
234 // check actionName and if next, then do not repeat a search, since we are going to the next page
236 // hack, make sure we reset the task values
237 $stateMachine = $this->controller
->getStateMachine();
238 $formName = $stateMachine->getTaskFormName();
239 $this->controller
->resetPage($formName);
244 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
245 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
246 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
250 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
252 $selector = new CRM_Case_Selector_Search($this->_queryParams
,
259 $selector->setKey($this->controller
->_key
);
262 if ($this->_context
== 'user') {
263 $prefix = $this->_prefix
;
266 $this->assign("{$prefix}limit", $this->_limit
);
267 $this->assign("{$prefix}single", $this->_single
);
269 $controller = new CRM_Core_Selector_Controller($selector,
270 $this->get(CRM_Utils_Pager
::PAGE_ID
),
272 CRM_Core_Action
::VIEW
,
274 CRM_Core_Selector_Controller
::SESSION
,
277 $controller->setEmbedded(TRUE);
279 $query = &$selector->getQuery();
280 if ($this->_context
== 'user') {
281 $query->setSkipPermission(TRUE);
287 * Add the rules (mainly global rules) for form.
289 * All local rules are added near the element
293 public function addRules() {
294 $this->addFormRule(['CRM_Case_Form_Search', 'formRule']);
298 * Global validation rules for the form.
300 * @param array $fields
301 * Posted values of the form.
302 * @param array $files
303 * @param object $form
307 public static function formRule($fields, $files, $form) {
310 if (!empty($errors)) {
318 * Set the default form values.
322 * the default array reference
324 public function setDefaultValues() {
326 $defaults = $this->_formValues
;
330 public function fixFormValues() {
331 if (!$this->_force
) {
335 $caseStatus = CRM_Utils_Request
::retrieve('status', 'Positive');
337 $this->_formValues
['case_status_id'] = $caseStatus;
338 $this->_defaults
['case_status_id'] = $caseStatus;
340 $caseType = CRM_Utils_Request
::retrieve('type', 'Positive');
342 $this->_formValues
['case_type_id'] = (array) $caseType;
343 $this->_defaults
['case_type_id'] = (array) $caseType;
346 $caseFromDate = CRM_Utils_Request
::retrieve('pstart', 'Date');
348 list($date) = CRM_Utils_Date
::setDateDefaults($caseFromDate);
349 $this->_formValues
['case_start_date_low'] = $date;
350 $this->_defaults
['case_start_date_low'] = $date;
353 $caseToDate = CRM_Utils_Request
::retrieve('pend', 'Date');
355 list($date) = CRM_Utils_Date
::setDateDefaults($caseToDate);
356 $this->_formValues
['case_start_date_high'] = $date;
357 $this->_defaults
['case_start_date_high'] = $date;
360 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
362 $cid = CRM_Utils_Type
::escape($cid, 'Integer');
364 $this->_formValues
['contact_id'] = $cid;
365 list($display, $image) = CRM_Contact_BAO_Contact
::getDisplayAndImage($cid);
366 $this->_defaults
['sort_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid,
369 // also assign individual mode to the template
370 $this->_single
= TRUE;
374 // First, if "all" is stored in the session, default to all cases, otherwise default to no selection.
375 $session = CRM_Core_Session
::singleton();
376 if (CRM_Utils_Request
::retrieve('all', 'Positive', $session)) {
377 $this->_formValues
['case_owner'] = 1;
378 $this->_defaults
['case_owner'] = 1;
381 $this->_formValues
['case_owner'] = 0;
382 $this->_defaults
['case_owner'] = 0;
385 // Now if case_owner is set in the url/post, use that instead.
386 $caseOwner = CRM_Utils_Request
::retrieve('case_owner', 'Positive');
388 $this->_formValues
['case_owner'] = $caseOwner;
389 $this->_defaults
['case_owner'] = $caseOwner;
397 public function getFormValues() {
402 * Return a descriptive name for the page, used in wizard header
406 public function getTitle() {
407 return ts('Find Cases');