3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
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
37 * This file is for Case search
39 class CRM_Case_Form_Search
extends CRM_Core_Form
{
42 * Are we forced to run a search
50 * name of search button
55 protected $_searchButtonName;
58 * name of action button
63 protected $_actionButtonName;
66 * form values that we will be using
74 * the params that are sent to the query
79 protected $_queryParams;
82 * have we already done this search
90 * are we restricting ourselves to a single contact
95 protected $_single = FALSE;
98 * are we restricting ourselves to a single contact
103 protected $_limit = NULL;
106 * what context are we being invoked from
111 protected $_context = NULL;
114 * prefix for the controller
117 protected $_prefix = 'case_';
119 protected $_defaults;
122 * processing needed for buildForm and later
127 function preProcess() {
128 $this->set('searchFormName', 'Search');
130 // js for changing activity status
131 CRM_Core_Resources
::singleton()->addScriptFile('civicrm', 'templates/CRM/Case/Form/ActivityChangeStatus.js');
133 //check for civicase access.
134 if (!CRM_Case_BAO_Case
::accessCiviCase()) {
135 CRM_Core_Error
::fatal(ts('You are not authorized to access this page.'));
138 //validate case configuration.
139 $configured = CRM_Case_BAO_Case
::isCaseConfigured();
140 $this->assign('notConfigured', !$configured['configured']);
141 if (!$configured['configured']) {
146 * set the button names
148 $this->_searchButtonName
= $this->getButtonName('refresh');
149 $this->_actionButtonName
= $this->getButtonName('next', 'action');
151 $this->_done
= FALSE;
152 $this->defaults
= array();
155 * we allow the controller to set force/reset externally, useful when we are being
156 * driven by the wizard framework
159 $this->_reset
= CRM_Utils_Request
::retrieve('reset', 'Boolean', CRM_Core_DAO
::$_nullObject);
160 $this->_force
= CRM_Utils_Request
::retrieve('force', 'Boolean', $this, FALSE);
161 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive', $this);
162 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this, FALSE, 'search');
164 $this->assign('context', $this->_context
);
166 // get user submitted values
167 // get it from controller only if form has been submitted, else preProcess has set this
168 if (!empty($_POST) && !$this->controller
->isModal()) {
169 $this->_formValues
= $this->controller
->exportValues($this->_name
);
172 $this->_formValues
= $this->get('formValues');
175 if (empty($this->_formValues
)) {
176 if (isset($this->_ssID
)) {
177 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
182 $this->postProcess();
183 $this->set('force', 0);
187 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
188 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
189 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
194 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
195 $selector = new CRM_Case_Selector_Search($this->_queryParams
,
204 if ($this->_context
== 'user') {
205 $prefix = $this->_prefix
;
208 $this->assign("{$prefix}limit", $this->_limit
);
209 $this->assign("{$prefix}single", $this->_single
);
211 $controller = new CRM_Core_Selector_Controller($selector,
212 $this->get(CRM_Utils_Pager
::PAGE_ID
),
214 CRM_Core_Action
::VIEW
,
216 CRM_Core_Selector_Controller
::TRANSFER
,
219 $controller->setEmbedded(TRUE);
220 $controller->moveFromSessionToTemplate();
222 $this->assign('summary', $this->get('summary'));
232 function buildQuickForm() {
233 $this->addElement('text',
235 ts('Client Name or Email'),
236 CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact', 'sort_name')
239 CRM_Case_BAO_Query
::buildSearchForm($this);
242 * add form checkboxes for each row. This is needed out here to conform to QF protocol
243 * of all elements being declared in builQuickForm
245 $rows = $this->get('rows');
246 if (is_array($rows)) {
247 CRM_Core_Resources
::singleton()->addScriptFile('civicrm', 'js/crm.searchForm.js');
248 if (!$this->_single
) {
249 $this->addElement('checkbox',
253 array('onclick' => "toggleTaskAction( true );", 'class' => 'select-rows')
256 foreach ($rows as $row) {
257 $this->addElement('checkbox', $row['checkbox'],
259 array('onclick' => "toggleTaskAction( true );", 'class' => 'select-row')
264 $total = $cancel = 0;
266 $permission = CRM_Core_Permission
::getPermission();
268 $tasks = array('' => ts('- actions -')) + CRM_Case_Task
::permissionedTaskTitles($permission);
270 if (!empty($this->_formValues
['case_deleted'])) {
277 $this->add('select', 'task', ts('Actions:') . ' ', $tasks);
278 $this->add('submit', $this->_actionButtonName
, ts('Go'),
280 'class' => 'form-submit',
282 'onclick' => "return checkPerformAction('mark_x', '" . $this->getName() . "', 0);",
286 // need to perform tasks on all or selected items ? using radio_ts(task selection) for it
287 $this->addElement('radio', 'radio_ts', NULL, '', 'ts_sel', array('checked' => 'checked'));
288 $this->addElement('radio', 'radio_ts', NULL, '', 'ts_all', array('class' => 'select-rows', 'onclick' => $this->getName() . ".toggleSelect.checked = false; toggleTaskAction( true );"));
292 $this->addButtons(array(
295 'name' => ts('Search'),
302 * The post processing of the form gets done here.
304 * Key things done during post processing are
305 * - check for reset or next request. if present, skip post procesing.
306 * - now check if user requested running a saved search, if so, then
307 * the form values associated with the saved search are used for searching.
308 * - if user has done a submit with new values the regular post submissing is
310 * The processing consists of using a Selector / Controller framework for getting the
318 function postProcess() {
324 $this->_formValues
= $this->controller
->exportValues($this->_name
);
325 $this->fixFormValues();
327 if (isset($this->_ssID
) && empty($_POST)) {
328 // if we are editing / running a saved search and the form has not been posted
329 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
332 //search for civicase
333 if (!$this->_force
) {
334 if (array_key_exists('case_owner', $this->_formValues
) && !$this->_formValues
['case_owner']) {
335 $this->_formValues
['case_owner'] = 0;
339 //only fetch own cases.
340 if (!CRM_Core_Permission
::check('access all cases and activities')) {
341 $this->_formValues
['case_owner'] = 2;
344 if (empty($this->_formValues
['case_deleted'])) {
345 $this->_formValues
['case_deleted'] = 0;
347 CRM_Core_BAO_CustomValue
::fixFieldValueOfTypeMemo($this->_formValues
);
349 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
351 $this->set('formValues', $this->_formValues
);
352 $this->set('queryParams', $this->_queryParams
);
354 $buttonName = $this->controller
->getButtonName();
355 if ($buttonName == $this->_actionButtonName
) {
356 // check actionName and if next, then do not repeat a search, since we are going to the next page
358 // hack, make sure we reset the task values
359 $stateMachine = $this->controller
->getStateMachine();
360 $formName = $stateMachine->getTaskFormName();
361 $this->controller
->resetPage($formName);
366 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
367 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
368 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
372 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
374 $selector = new CRM_Case_Selector_Search($this->_queryParams
,
381 $selector->setKey($this->controller
->_key
);
384 if ($this->_context
== 'user') {
385 $prefix = $this->_prefix
;
388 $this->assign("{$prefix}limit", $this->_limit
);
389 $this->assign("{$prefix}single", $this->_single
);
391 $controller = new CRM_Core_Selector_Controller($selector,
392 $this->get(CRM_Utils_Pager
::PAGE_ID
),
394 CRM_Core_Action
::VIEW
,
396 CRM_Core_Selector_Controller
::SESSION
,
399 $controller->setEmbedded(TRUE);
401 $query = &$selector->getQuery();
402 if ($this->_context
== 'user') {
403 $query->setSkipPermission(TRUE);
409 * This function is used to add the rules (mainly global rules) for form.
410 * All local rules are added near the element
416 function addRules() {
417 $this->addFormRule(array('CRM_Case_Form_Search', 'formRule'));
421 * global validation rules for the form
423 * @param array $fields posted values of the form
424 * @param array $errors list of errors to be posted back to the form
430 static function formRule($fields) {
433 if (!empty($errors)) {
441 * Set the default form values
445 * @return array the default array reference
447 function setDefaultValues() {
449 $defaults = $this->_formValues
;
453 function fixFormValues() {
454 if (!$this->_force
) {
458 $caseStatus = CRM_Utils_Request
::retrieve('status', 'Positive',
459 CRM_Core_DAO
::$_nullObject
462 $this->_formValues
['case_status_id'] = $caseStatus;
463 $this->_defaults
['case_status_id'] = $caseStatus;
465 $caseType = CRM_Utils_Request
::retrieve('type', 'Positive',
466 CRM_Core_DAO
::$_nullObject
469 $this->_formValues
['case_type_id'][$caseType] = 1;
470 $this->_defaults
['case_type_id'][$caseType] = 1;
473 $caseFromDate = CRM_Utils_Request
::retrieve('pstart', 'Date',
474 CRM_Core_DAO
::$_nullObject
477 list($date) = CRM_Utils_Date
::setDateDefaults($caseFromDate);
478 $this->_formValues
['case_start_date_low'] = $date;
479 $this->_defaults
['case_start_date_low'] = $date;
482 $caseToDate = CRM_Utils_Request
::retrieve('pend', 'Date',
483 CRM_Core_DAO
::$_nullObject
486 list($date) = CRM_Utils_Date
::setDateDefaults($caseToDate);
487 $this->_formValues
['case_start_date_high'] = $date;
488 $this->_defaults
['case_start_date_high'] = $date;
491 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
493 $cid = CRM_Utils_Type
::escape($cid, 'Integer');
495 $this->_formValues
['contact_id'] = $cid;
496 list($display, $image) = CRM_Contact_BAO_Contact
::getDisplayAndImage($cid);
497 $this->_defaults
['sort_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid,
500 // also assign individual mode to the template
501 $this->_single
= TRUE;
505 // First, if "all" is stored in the session, default to all cases, otherwise default to no selection.
506 $session = CRM_Core_Session
::singleton();
507 if (CRM_Utils_Request
::retrieve('all', 'Positive', $session)) {
508 $this->_formValues
['case_owner'] = 1;
509 $this->_defaults
['case_owner'] = 1;
512 $this->_formValues
['case_owner'] = 0;
513 $this->_defaults
['case_owner'] = 0;
516 // Now if case_owner is set in the url/post, use that instead.
517 $caseOwner = CRM_Utils_Request
::retrieve('case_owner', 'Positive',
518 CRM_Core_DAO
::$_nullObject
521 $this->_formValues
['case_owner'] = $caseOwner;
522 $this->_defaults
['case_owner'] = $caseOwner;
527 function getFormValues() {
532 * Return a descriptive name for the page, used in wizard header
537 public function getTitle() {
538 return ts('Find Cases');