CRM/Case/Form/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This file is for Case search
  38  */
  39 class CRM_Case_Form_Search extends CRM_Core_Form_Search {
  40
  41   /**
  42    * The params that are sent to the query
  43    *
  44    * @var array
  45    */
  46   protected $_queryParams;
  47
  48   /**
  49    * Are we restricting ourselves to a single contact
  50    *
  51    * @var boolean
  52    */
  53   protected $_single = FALSE;
  54
  55   /**
  56    * Are we restricting ourselves to a single contact
  57    *
  58    * @var boolean
  59    */
  60   protected $_limit = NULL;
  61
  62   /**
  63    * Prefix for the controller
  64    */
  65   protected $_prefix = 'case_';
  66
  67   protected $_defaults;
  68
  69   /**
  70    * Processing needed for buildForm and later.
  71    *
  72    * @return void
  73    */
  74   public function preProcess() {
  75     $this->set('searchFormName', 'Search');
  76
  77     //check for civicase access.
  78     if (!CRM_Case_BAO_Case::accessCiviCase()) {
  79       CRM_Core_Error::fatal(ts('You are not authorized to access this page.'));
  80     }
  81
  82     //validate case configuration.
  83     $configured = CRM_Case_BAO_Case::isCaseConfigured();
  84     $this->assign('notConfigured', !$configured['configured']);
  85     if (!$configured['configured']) {
  86       return;
  87     }
  88
  89     /**
  90      * set the button names
  91      */
  92     $this->_searchButtonName = $this->getButtonName('refresh');
  93     $this->_actionButtonName = $this->getButtonName('next', 'action');
  94
  95     $this->_done = FALSE;
  96     $this->defaults = array();
  97
  98     /*
  99      * we allow the controller to set force/reset externally, useful when we are being
 100      * driven by the wizard framework
 101      */
 102
 103     $this->_reset = CRM_Utils_Request::retrieve('reset', 'Boolean', CRM_Core_DAO::$_nullObject);
 104     $this->_force = CRM_Utils_Request::retrieve('force', 'Boolean', $this, FALSE);
 105     $this->_limit = CRM_Utils_Request::retrieve('limit', 'Positive', $this);
 106     $this->_context = CRM_Utils_Request::retrieve('context', 'String', $this, FALSE, 'search');
 107
 108     $this->assign('context', $this->_context);
 109
 110     // get user submitted values
 111     // get it from controller only if form has been submitted, else preProcess has set this
 112     if (!empty($_POST) && !$this->controller->isModal()) {
 113       $this->_formValues = $this->controller->exportValues($this->_name);
 114     }
 115     else {
 116       $this->_formValues = $this->get('formValues');
 117     }
 118
 119     if (empty($this->_formValues)) {
 120       if (isset($this->_ssID)) {
 121         $this->_formValues = CRM_Contact_BAO_SavedSearch::getFormValues($this->_ssID);
 122       }
 123     }
 124
 125     if ($this->_force) {
 126       $this->postProcess();
 127       $this->set('force', 0);
 128     }
 129
 130     $sortID = NULL;
 131     if ($this->get(CRM_Utils_Sort::SORT_ID)) {
 132       $sortID = CRM_Utils_Sort::sortIDValue($this->get(CRM_Utils_Sort::SORT_ID),
 133         $this->get(CRM_Utils_Sort::SORT_DIRECTION)
 134       );
 135     }
 136
 137     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 138     $selector = new CRM_Case_Selector_Search($this->_queryParams,
 139       $this->_action,
 140       NULL,
 141       $this->_single,
 142       $this->_limit,
 143       $this->_context
 144     );
 145
 146     $prefix = NULL;
 147     if ($this->_context == 'user') {
 148       $prefix = $this->_prefix;
 149     }
 150
 151     $this->assign("{$prefix}limit", $this->_limit);
 152     $this->assign("{$prefix}single", $this->_single);
 153
 154     $controller = new CRM_Core_Selector_Controller($selector,
 155       $this->get(CRM_Utils_Pager::PAGE_ID),
 156       $sortID,
 157       CRM_Core_Action::VIEW,
 158       $this,
 159       CRM_Core_Selector_Controller::TRANSFER,
 160       $prefix
 161     );
 162     $controller->setEmbedded(TRUE);
 163     $controller->moveFromSessionToTemplate();
 164
 165     $this->assign('summary', $this->get('summary'));
 166   }
 167
 168   /**
 169    * Build the form object.
 170    *
 171    *
 172    * @return void
 173    */
 174   public function buildQuickForm() {
 175     parent::buildQuickForm();
 176     $this->addElement('text',
 177       'sort_name',
 178       ts('Client Name or Email'),
 179       CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'sort_name')
 180     );
 181
 182     CRM_Case_BAO_Query::buildSearchForm($this);
 183
 184     $rows = $this->get('rows');
 185     if (is_array($rows)) {
 186       if (!$this->_single) {
 187         $this->addRowSelectors($rows);
 188       }
 189
 190       $permission = CRM_Core_Permission::getPermission();
 191
 192       $tasks = CRM_Case_Task::permissionedTaskTitles($permission);
 193
 194       if (!empty($this->_formValues['case_deleted'])) {
 195         unset($tasks[1]);
 196       }
 197       else {
 198         unset($tasks[4]);
 199       }
 200
 201       $this->addTaskMenu($tasks);
 202     }
 203
 204   }
 205
 206   /**
 207    * The post processing of the form gets done here.
 208    *
 209    * Key things done during post processing are
 210    *      - check for reset or next request. if present, skip post procesing.
 211    *      - now check if user requested running a saved search, if so, then
 212    *        the form values associated with the saved search are used for searching.
 213    *      - if user has done a submit with new values the regular post submissing is
 214    *        done.
 215    * The processing consists of using a Selector / Controller framework for getting the
 216    * search results.
 217    *
 218    * @param
 219    *
 220    * @return void
 221    */
 222   public function postProcess() {
 223     if ($this->_done) {
 224       return;
 225     }
 226
 227     $this->_done = TRUE;
 228     $this->_formValues = $this->controller->exportValues($this->_name);
 229     $this->fixFormValues();
 230
 231     if (isset($this->_ssID) && empty($_POST)) {
 232       // if we are editing / running a saved search and the form has not been posted
 233       $this->_formValues = CRM_Contact_BAO_SavedSearch::getFormValues($this->_ssID);
 234     }
 235
 236     //search for civicase
 237     if (!$this->_force) {
 238       if (array_key_exists('case_owner', $this->_formValues) && !$this->_formValues['case_owner']) {
 239         $this->_formValues['case_owner'] = 0;
 240       }
 241     }
 242
 243     //only fetch own cases.
 244     if (!CRM_Core_Permission::check('access all cases and activities')) {
 245       $this->_formValues['case_owner'] = 2;
 246     }
 247
 248     if (empty($this->_formValues['case_deleted'])) {
 249       $this->_formValues['case_deleted'] = 0;
 250     }
 251     CRM_Core_BAO_CustomValue::fixFieldValueOfTypeMemo($this->_formValues);
 252
 253     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 254
 255     $this->set('formValues', $this->_formValues);
 256     $this->set('queryParams', $this->_queryParams);
 257
 258     $buttonName = $this->controller->getButtonName();
 259     if ($buttonName == $this->_actionButtonName) {
 260       // check actionName and if next, then do not repeat a search, since we are going to the next page
 261
 262       // hack, make sure we reset the task values
 263       $stateMachine = $this->controller->getStateMachine();
 264       $formName = $stateMachine->getTaskFormName();
 265       $this->controller->resetPage($formName);
 266       return;
 267     }
 268
 269     $sortID = NULL;
 270     if ($this->get(CRM_Utils_Sort::SORT_ID)) {
 271       $sortID = CRM_Utils_Sort::sortIDValue($this->get(CRM_Utils_Sort::SORT_ID),
 272         $this->get(CRM_Utils_Sort::SORT_DIRECTION)
 273       );
 274     }
 275
 276     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 277
 278     $selector = new CRM_Case_Selector_Search($this->_queryParams,
 279       $this->_action,
 280       NULL,
 281       $this->_single,
 282       $this->_limit,
 283       $this->_context
 284     );
 285     $selector->setKey($this->controller->_key);
 286
 287     $prefix = NULL;
 288     if ($this->_context == 'user') {
 289       $prefix = $this->_prefix;
 290     }
 291
 292     $this->assign("{$prefix}limit", $this->_limit);
 293     $this->assign("{$prefix}single", $this->_single);
 294
 295     $controller = new CRM_Core_Selector_Controller($selector,
 296       $this->get(CRM_Utils_Pager::PAGE_ID),
 297       $sortID,
 298       CRM_Core_Action::VIEW,
 299       $this,
 300       CRM_Core_Selector_Controller::SESSION,
 301       $prefix
 302     );
 303     $controller->setEmbedded(TRUE);
 304
 305     $query = &$selector->getQuery();
 306     if ($this->_context == 'user') {
 307       $query->setSkipPermission(TRUE);
 308     }
 309     $controller->run();
 310   }
 311
 312   /**
 313    * add the rules (mainly global rules) for form.
 314    * All local rules are added near the element
 315    *
 316    * @return void
 317    * @see valid_date
 318    */
 319   public function addRules() {
 320     $this->addFormRule(array('CRM_Case_Form_Search', 'formRule'));
 321   }
 322
 323   /**
 324    * Global validation rules for the form.
 325    *
 326    * @param array $fields
 327    *   Posted values of the form.
 328    *
 329    * @return void
 330    */
 331   public static function formRule($fields) {
 332     $errors = array();
 333
 334     if (!empty($errors)) {
 335       return $errors;
 336     }
 337
 338     return TRUE;
 339   }
 340
 341   /**
 342    * Set the default form values.
 343    *
 344    *
 345    * @return array
 346    *   the default array reference
 347    */
 348   public function setDefaultValues() {
 349     $defaults = array();
 350     $defaults = $this->_formValues;
 351     return $defaults;
 352   }
 353
 354   public function fixFormValues() {
 355     if (!$this->_force) {
 356       return;
 357     }
 358
 359     $caseStatus = CRM_Utils_Request::retrieve('status', 'Positive',
 360       CRM_Core_DAO::$_nullObject
 361     );
 362     if ($caseStatus) {
 363       $this->_formValues['case_status_id'] = $caseStatus;
 364       $this->_defaults['case_status_id'] = $caseStatus;
 365     }
 366     $caseType = CRM_Utils_Request::retrieve('type', 'Positive',
 367       CRM_Core_DAO::$_nullObject
 368     );
 369     if ($caseType) {
 370       $this->_formValues['case_type_id'][$caseType] = 1;
 371       $this->_defaults['case_type_id'][$caseType] = 1;
 372     }
 373
 374     $caseFromDate = CRM_Utils_Request::retrieve('pstart', 'Date',
 375       CRM_Core_DAO::$_nullObject
 376     );
 377     if ($caseFromDate) {
 378       list($date) = CRM_Utils_Date::setDateDefaults($caseFromDate);
 379       $this->_formValues['case_start_date_low'] = $date;
 380       $this->_defaults['case_start_date_low'] = $date;
 381     }
 382
 383     $caseToDate = CRM_Utils_Request::retrieve('pend', 'Date',
 384       CRM_Core_DAO::$_nullObject
 385     );
 386     if ($caseToDate) {
 387       list($date) = CRM_Utils_Date::setDateDefaults($caseToDate);
 388       $this->_formValues['case_start_date_high'] = $date;
 389       $this->_defaults['case_start_date_high'] = $date;
 390     }
 391
 392     $cid = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
 393     if ($cid) {
 394       $cid = CRM_Utils_Type::escape($cid, 'Integer');
 395       if ($cid > 0) {
 396         $this->_formValues['contact_id'] = $cid;
 397         list($display, $image) = CRM_Contact_BAO_Contact::getDisplayAndImage($cid);
 398         $this->_defaults['sort_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $cid,
 399           'sort_name'
 400         );
 401         // also assign individual mode to the template
 402         $this->_single = TRUE;
 403       }
 404     }
 405     else {
 406       // First, if "all" is stored in the session, default to all cases, otherwise default to no selection.
 407       $session = CRM_Core_Session::singleton();
 408       if (CRM_Utils_Request::retrieve('all', 'Positive', $session)) {
 409         $this->_formValues['case_owner'] = 1;
 410         $this->_defaults['case_owner'] = 1;
 411       }
 412       else {
 413         $this->_formValues['case_owner'] = 0;
 414         $this->_defaults['case_owner'] = 0;
 415       }
 416
 417       // Now if case_owner is set in the url/post, use that instead.
 418       $caseOwner = CRM_Utils_Request::retrieve('case_owner', 'Positive',
 419         CRM_Core_DAO::$_nullObject
 420       );
 421       if ($caseOwner) {
 422         $this->_formValues['case_owner'] = $caseOwner;
 423         $this->_defaults['case_owner'] = $caseOwner;
 424       }
 425     }
 426   }
 427
 428   /**
 429    * @return null
 430    */
 431   public function getFormValues() {
 432     return NULL;
 433   }
 434
 435   /**
 436    * Return a descriptive name for the page, used in wizard header
 437    *
 438    * @return string
 439    */
 440   public function getTitle() {
 441     return ts('Find Cases');
 442   }
 443
 444 }