CRM/Case/Form/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * This file is for Case search.
  20  */
  21 class CRM_Case_Form_Search extends CRM_Core_Form_Search {
  22
  23   /**
  24    * The params that are sent to the query
  25    *
  26    * @var array
  27    */
  28   protected $_queryParams;
  29
  30   /**
  31    * Are we restricting ourselves to a single contact
  32    *
  33    * @var bool
  34    */
  35   protected $_single = FALSE;
  36
  37   /**
  38    * Are we restricting ourselves to a single contact
  39    *
  40    * @var bool
  41    */
  42   protected $_limit = NULL;
  43
  44   /**
  45    * Prefix for the controller
  46    * @var string
  47    */
  48   protected $_prefix = 'case_';
  49
  50   /**
  51    * @return string
  52    */
  53   public function getDefaultEntity() {
  54     return 'Case';
  55   }
  56
  57   /**
  58    * Processing needed for buildForm and later.
  59    */
  60   public function preProcess() {
  61     // SearchFormName is deprecated & to be removed - the replacement is for the task to
  62     // call $this->form->getSearchFormValues()
  63     // A couple of extensions use it.
  64     $this->set('searchFormName', 'Search');
  65
  66     //check for civicase access.
  67     if (!CRM_Case_BAO_Case::accessCiviCase()) {
  68       CRM_Core_Error::statusBounce(ts('You are not authorized to access this page.'));
  69     }
  70
  71     //validate case configuration.
  72     $configured = CRM_Case_BAO_Case::isCaseConfigured();
  73     $this->assign('notConfigured', !$configured['configured']);
  74     if (!$configured['configured']) {
  75       return;
  76     }
  77
  78     /**
  79      * set the button names
  80      */
  81     $this->_actionButtonName = $this->getButtonName('next', 'action');
  82
  83     $this->_done = FALSE;
  84     $this->sortNameOnly = TRUE;
  85
  86     parent::preProcess();
  87
  88     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
  89     $selector = new CRM_Case_Selector_Search($this->_queryParams,
  90       $this->_action,
  91       NULL,
  92       $this->_single,
  93       $this->_limit,
  94       $this->_context
  95     );
  96
  97     $prefix = NULL;
  98     if ($this->_context == 'user') {
  99       $prefix = $this->_prefix;
 100     }
 101
 102     $this->assign("{$prefix}limit", $this->_limit);
 103     $this->assign("{$prefix}single", $this->_single);
 104
 105     $controller = new CRM_Core_Selector_Controller($selector,
 106       $this->get(CRM_Utils_Pager::PAGE_ID),
 107       $this->getSortID(),
 108       CRM_Core_Action::VIEW,
 109       $this,
 110       CRM_Core_Selector_Controller::TRANSFER,
 111       $prefix
 112     );
 113     $controller->setEmbedded(TRUE);
 114     $controller->moveFromSessionToTemplate();
 115
 116     $this->assign('summary', $this->get('summary'));
 117   }
 118
 119   /**
 120    * Build the form object.
 121    */
 122   public function buildQuickForm() {
 123     parent::buildQuickForm();
 124     $this->addSortNameField();
 125
 126     CRM_Case_BAO_Query::buildSearchForm($this);
 127
 128     $rows = $this->get('rows');
 129     if (is_array($rows)) {
 130       if (!$this->_single) {
 131         $this->addRowSelectors($rows);
 132       }
 133
 134       $tasks = CRM_Case_Task::permissionedTaskTitles(CRM_Core_Permission::getPermission());
 135
 136       if (!empty($this->_formValues['case_deleted'])) {
 137         unset($tasks[CRM_Case_Task::TASK_DELETE]);
 138       }
 139       else {
 140         unset($tasks[CRM_Case_Task::RESTORE_CASES]);
 141       }
 142
 143       $this->addTaskMenu($tasks);
 144     }
 145
 146   }
 147
 148   /**
 149    * Get the label for the sortName field if email searching is on.
 150    *
 151    * (email searching is a setting under search preferences).
 152    *
 153    * @return string
 154    */
 155   protected function getSortNameLabelWithEmail() {
 156     return ts('Client Name or Email');
 157   }
 158
 159   /**
 160    * Get the label for the sortName field if email searching is off.
 161    *
 162    * (email searching is a setting under search preferences).
 163    *
 164    * @return string
 165    */
 166   protected function getSortNameLabelWithOutEmail() {
 167     return ts('Client Name');
 168   }
 169
 170   /**
 171    * The post processing of the form gets done here.
 172    *
 173    * Key things done during post processing are
 174    *      - check for reset or next request. if present, skip post procesing.
 175    *      - now check if user requested running a saved search, if so, then
 176    *        the form values associated with the saved search are used for searching.
 177    *      - if user has done a submit with new values the regular post submissing is
 178    *        done.
 179    * The processing consists of using a Selector / Controller framework for getting the
 180    * search results.
 181    */
 182   public function postProcess() {
 183     if ($this->_done) {
 184       return;
 185     }
 186
 187     $this->_done = TRUE;
 188     $this->setFormValues();
 189     // @todo - stop changing formValues - respect submitted form values, change a working array.
 190     $this->fixFormValues();
 191     if (isset($this->_ssID) && empty($_POST)) {
 192       // if we are editing / running a saved search and the form has not been posted
 193       $this->_formValues = CRM_Contact_BAO_SavedSearch::getFormValues($this->_ssID);
 194     }
 195
 196     //search for civicase
 197     if (!$this->_force) {
 198       // @todo - stop changing formValues - respect submitted form values, change a working array.
 199       if (array_key_exists('case_owner', $this->_formValues) && !$this->_formValues['case_owner']) {
 200         $this->_formValues['case_owner'] = 0;
 201       }
 202     }
 203
 204     // @todo - stop changing formValues - respect submitted form values, change a working array.
 205     if (empty($this->_formValues['case_deleted'])) {
 206       $this->_formValues['case_deleted'] = 0;
 207     }
 208
 209     // @todo - stop changing formValues - respect submitted form values, change a working array.
 210     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 211
 212     $this->set('queryParams', $this->_queryParams);
 213
 214     $buttonName = $this->controller->getButtonName();
 215     if ($buttonName == $this->_actionButtonName) {
 216       // check actionName and if next, then do not repeat a search, since we are going to the next page
 217
 218       // hack, make sure we reset the task values
 219       $stateMachine = $this->controller->getStateMachine();
 220       $formName = $stateMachine->getTaskFormName();
 221       $this->controller->resetPage($formName);
 222       return;
 223     }
 224
 225     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 226
 227     $selector = new CRM_Case_Selector_Search($this->_queryParams,
 228       $this->_action,
 229       NULL,
 230       $this->_single,
 231       $this->_limit,
 232       $this->_context
 233     );
 234     $selector->setKey($this->controller->_key);
 235
 236     $prefix = NULL;
 237     if ($this->_context == 'user') {
 238       $prefix = $this->_prefix;
 239     }
 240
 241     $this->assign("{$prefix}limit", $this->_limit);
 242     $this->assign("{$prefix}single", $this->_single);
 243
 244     $controller = new CRM_Core_Selector_Controller($selector,
 245       $this->get(CRM_Utils_Pager::PAGE_ID),
 246       $this->getSortID(),
 247       CRM_Core_Action::VIEW,
 248       $this,
 249       CRM_Core_Selector_Controller::SESSION,
 250       $prefix
 251     );
 252     $controller->setEmbedded(TRUE);
 253
 254     $query = &$selector->getQuery();
 255     if ($this->_context == 'user') {
 256       $query->setSkipPermission(TRUE);
 257     }
 258     $controller->run();
 259   }
 260
 261   public function fixFormValues() {
 262     if (!$this->_force) {
 263       return;
 264     }
 265
 266     $caseStatus = CRM_Utils_Request::retrieve('status', 'Positive');
 267     if ($caseStatus) {
 268       $this->_formValues['case_status_id'] = $caseStatus;
 269       $this->_defaults['case_status_id'] = $caseStatus;
 270     }
 271     $caseType = CRM_Utils_Request::retrieve('type', 'Positive');
 272     if ($caseType) {
 273       $this->_formValues['case_type_id'] = (array) $caseType;
 274       $this->_defaults['case_type_id'] = (array) $caseType;
 275     }
 276
 277     $caseFromDate = CRM_Utils_Request::retrieve('pstart', 'Date');
 278     if ($caseFromDate) {
 279       list($date) = CRM_Utils_Date::setDateDefaults($caseFromDate);
 280       $this->_formValues['case_start_date_low'] = $date;
 281       $this->_defaults['case_start_date_low'] = $date;
 282     }
 283
 284     $caseToDate = CRM_Utils_Request::retrieve('pend', 'Date');
 285     if ($caseToDate) {
 286       list($date) = CRM_Utils_Date::setDateDefaults($caseToDate);
 287       $this->_formValues['case_start_date_high'] = $date;
 288       $this->_defaults['case_start_date_high'] = $date;
 289     }
 290
 291     $cid = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
 292     if ($cid) {
 293       $cid = CRM_Utils_Type::escape($cid, 'Integer');
 294       if ($cid > 0) {
 295         $this->_formValues['contact_id'] = $cid;
 296         list($display, $image) = CRM_Contact_BAO_Contact::getDisplayAndImage($cid);
 297         $this->_defaults['sort_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $cid,
 298           'sort_name'
 299         );
 300         // also assign individual mode to the template
 301         $this->_single = TRUE;
 302       }
 303     }
 304     else {
 305       // First, if "all" is stored in the session, default to all cases, otherwise default to no selection.
 306       $session = CRM_Core_Session::singleton();
 307       if (CRM_Utils_Request::retrieve('all', 'Positive', $session)) {
 308         $this->_formValues['case_owner'] = 1;
 309         $this->_defaults['case_owner'] = 1;
 310       }
 311       else {
 312         $this->_formValues['case_owner'] = 0;
 313         $this->_defaults['case_owner'] = 0;
 314       }
 315
 316       // Now if case_owner is set in the url/post, use that instead.
 317       $caseOwner = CRM_Utils_Request::retrieve('case_owner', 'Positive');
 318       if ($caseOwner) {
 319         $this->_formValues['case_owner'] = $caseOwner;
 320         $this->_defaults['case_owner'] = $caseOwner;
 321       }
 322     }
 323   }
 324
 325   /**
 326    * Return a descriptive name for the page, used in wizard header
 327    *
 328    * @return string
 329    */
 330   public function getTitle() {
 331     return ts('Find Cases');
 332   }
 333
 334   /**
 335    * Set the metadata for the form.
 336    *
 337    * @throws \CiviCRM_API3_Exception
 338    */
 339   protected function setSearchMetadata() {
 340     $this->addSearchFieldMetadata(['Case' => CRM_Case_BAO_Query::getSearchFieldMetadata()]);
 341   }
 342
 343 }