CRM/Case/Form/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This file is for Case search
  38  */
  39 class CRM_Case_Form_Search extends CRM_Core_Form {
  40
  41   /**
  42    * Are we forced to run a search
  43    *
  44    * @var int
  45    * @access protected
  46    */
  47   protected $_force;
  48
  49   /**
  50    * name of search button
  51    *
  52    * @var string
  53    * @access protected
  54    */
  55   protected $_searchButtonName;
  56
  57   /**
  58    * name of action button
  59    *
  60    * @var string
  61    * @access protected
  62    */
  63   protected $_actionButtonName;
  64
  65   /**
  66    * form values that we will be using
  67    *
  68    * @var array
  69    * @access protected
  70    */
  71   public $_formValues;
  72
  73   /**
  74    * the params that are sent to the query
  75    *
  76    * @var array
  77    * @access protected
  78    */
  79   protected $_queryParams;
  80
  81   /**
  82    * have we already done this search
  83    *
  84    * @access protected
  85    * @var boolean
  86    */
  87   protected $_done;
  88
  89   /**
  90    * are we restricting ourselves to a single contact
  91    *
  92    * @access protected
  93    * @var boolean
  94    */
  95   protected $_single = FALSE;
  96
  97   /**
  98    * are we restricting ourselves to a single contact
  99    *
 100    * @access protected
 101    * @var boolean
 102    */
 103   protected $_limit = NULL;
 104
 105   /**
 106    * what context are we being invoked from
 107    *
 108    * @access protected
 109    * @var string
 110    */
 111   protected $_context = NULL;
 112
 113   /**
 114    * prefix for the controller
 115    *
 116    */
 117   protected $_prefix = 'case_';
 118
 119   protected $_defaults;
 120
 121   /**
 122    * processing needed for buildForm and later
 123    *
 124    * @return void
 125    * @access public
 126    */
 127   function preProcess() {
 128     $this->set('searchFormName', 'Search');
 129
 130     // js for changing activity status
 131     CRM_Core_Resources::singleton()->addScriptFile('civicrm', 'templates/CRM/Case/Form/ActivityChangeStatus.js');
 132
 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.'));
 136     }
 137
 138     //validate case configuration.
 139     $configured = CRM_Case_BAO_Case::isCaseConfigured();
 140     $this->assign('notConfigured', !$configured['configured']);
 141     if (!$configured['configured']) {
 142       return;
 143     }
 144
 145     /**
 146      * set the button names
 147      */
 148     $this->_searchButtonName = $this->getButtonName('refresh');
 149     $this->_actionButtonName = $this->getButtonName('next', 'action');
 150
 151     $this->_done = FALSE;
 152     $this->defaults = array();
 153
 154     /*
 155          * we allow the controller to set force/reset externally, useful when we are being
 156          * driven by the wizard framework
 157          */
 158
 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');
 163
 164     $this->assign('context', $this->_context);
 165
 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);
 170     }
 171     else {
 172       $this->_formValues = $this->get('formValues');
 173     }
 174
 175     if (empty($this->_formValues)) {
 176       if (isset($this->_ssID)) {
 177         $this->_formValues = CRM_Contact_BAO_SavedSearch::getFormValues($this->_ssID);
 178       }
 179     }
 180
 181     if ($this->_force) {
 182       $this->postProcess();
 183       $this->set('force', 0);
 184     }
 185
 186     $sortID = NULL;
 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)
 190       );
 191     }
 192
 193
 194     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 195     $selector = new CRM_Case_Selector_Search($this->_queryParams,
 196       $this->_action,
 197       NULL,
 198       $this->_single,
 199       $this->_limit,
 200       $this->_context
 201     );
 202
 203     $prefix = NULL;
 204     if ($this->_context == 'user') {
 205       $prefix = $this->_prefix;
 206     }
 207
 208     $this->assign("{$prefix}limit", $this->_limit);
 209     $this->assign("{$prefix}single", $this->_single);
 210
 211     $controller = new CRM_Core_Selector_Controller($selector,
 212       $this->get(CRM_Utils_Pager::PAGE_ID),
 213       $sortID,
 214       CRM_Core_Action::VIEW,
 215       $this,
 216       CRM_Core_Selector_Controller::TRANSFER,
 217       $prefix
 218     );
 219     $controller->setEmbedded(TRUE);
 220     $controller->moveFromSessionToTemplate();
 221
 222     $this->assign('summary', $this->get('summary'));
 223   }
 224
 225   /**
 226    * Build the form
 227    *
 228    * @access public
 229    *
 230    * @return void
 231    */
 232   function buildQuickForm() {
 233     $this->addElement('text',
 234       'sort_name',
 235       ts('Client Name or Email'),
 236       CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'sort_name')
 237     );
 238
 239     CRM_Case_BAO_Query::buildSearchForm($this);
 240
 241     /*
 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
 244      */
 245     $rows = $this->get('rows');
 246     if (is_array($rows)) {
 247       CRM_Core_Resources::singleton()->addScriptFile('civicrm', 'js/crm.livePage.js');
 248       CRM_Core_Resources::singleton()->addScriptFile('civicrm', 'js/crm.searchForm.js');
 249       if (!$this->_single) {
 250         $this->addElement('checkbox',
 251           'toggleSelect',
 252           NULL,
 253           NULL,
 254           array('onclick' => "toggleTaskAction( true );", 'class' => 'select-rows')
 255         );
 256
 257         foreach ($rows as $row) {
 258           $this->addElement('checkbox', $row['checkbox'],
 259             NULL, NULL,
 260             array('onclick' => "toggleTaskAction( true );", 'class' => 'select-row')
 261           );
 262         }
 263       }
 264
 265       $total = $cancel = 0;
 266
 267       $permission = CRM_Core_Permission::getPermission();
 268
 269       $tasks = array('' => ts('- actions -')) + CRM_Case_Task::permissionedTaskTitles($permission);
 270
 271       if (!empty($this->_formValues['case_deleted'])) {
 272         unset($tasks[1]);
 273       }
 274       else {
 275         unset($tasks[4]);
 276       }
 277
 278       $this->add('select', 'task', ts('Actions:') . ' ', $tasks);
 279       $this->add('submit', $this->_actionButtonName, ts('Go'),
 280         array(
 281           'class' => 'form-submit',
 282           'id' => 'Go',
 283           'onclick' => "return checkPerformAction('mark_x', '" . $this->getName() . "', 0);",
 284         )
 285       );
 286
 287       // need to perform tasks on all or selected items ? using radio_ts(task selection) for it
 288       $this->addElement('radio', 'radio_ts', NULL, '', 'ts_sel', array('checked' => 'checked'));
 289       $this->addElement('radio', 'radio_ts', NULL, '', 'ts_all', array('class' => 'select-rows', 'onclick' => $this->getName() . ".toggleSelect.checked = false; toggleTaskAction( true );"));
 290     }
 291
 292     // add buttons
 293     $this->addButtons(array(
 294         array(
 295           'type' => 'refresh',
 296           'name' => ts('Search'),
 297           'isDefault' => TRUE,
 298         ),
 299       ));
 300   }
 301
 302   /**
 303    * The post processing of the form gets done here.
 304    *
 305    * Key things done during post processing are
 306    *      - check for reset or next request. if present, skip post procesing.
 307    *      - now check if user requested running a saved search, if so, then
 308    *        the form values associated with the saved search are used for searching.
 309    *      - if user has done a submit with new values the regular post submissing is
 310    *        done.
 311    * The processing consists of using a Selector / Controller framework for getting the
 312    * search results.
 313    *
 314    * @param
 315    *
 316    * @return void
 317    * @access public
 318    */
 319   function postProcess() {
 320     if ($this->_done) {
 321       return;
 322     }
 323
 324     $this->_done = TRUE;
 325     $this->_formValues = $this->controller->exportValues($this->_name);
 326     $this->fixFormValues();
 327
 328     if (isset($this->_ssID) && empty($_POST)) {
 329       // if we are editing / running a saved search and the form has not been posted
 330       $this->_formValues = CRM_Contact_BAO_SavedSearch::getFormValues($this->_ssID);
 331     }
 332
 333     //search for civicase
 334     if (!$this->_force) {
 335       if (array_key_exists('case_owner', $this->_formValues) && !$this->_formValues['case_owner']) {
 336         $this->_formValues['case_owner'] = 0;
 337       }
 338     }
 339
 340     //only fetch own cases.
 341     if (!CRM_Core_Permission::check('access all cases and activities')) {
 342       $this->_formValues['case_owner'] = 2;
 343     }
 344
 345     if (empty($this->_formValues['case_deleted'])) {
 346       $this->_formValues['case_deleted'] = 0;
 347     }
 348     CRM_Core_BAO_CustomValue::fixFieldValueOfTypeMemo($this->_formValues);
 349
 350     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 351
 352     $this->set('formValues', $this->_formValues);
 353     $this->set('queryParams', $this->_queryParams);
 354
 355     $buttonName = $this->controller->getButtonName();
 356     if ($buttonName == $this->_actionButtonName) {
 357       // check actionName and if next, then do not repeat a search, since we are going to the next page
 358
 359       // hack, make sure we reset the task values
 360       $stateMachine = $this->controller->getStateMachine();
 361       $formName = $stateMachine->getTaskFormName();
 362       $this->controller->resetPage($formName);
 363       return;
 364     }
 365
 366     $sortID = NULL;
 367     if ($this->get(CRM_Utils_Sort::SORT_ID)) {
 368       $sortID = CRM_Utils_Sort::sortIDValue($this->get(CRM_Utils_Sort::SORT_ID),
 369         $this->get(CRM_Utils_Sort::SORT_DIRECTION)
 370       );
 371     }
 372
 373     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 374
 375     $selector = new CRM_Case_Selector_Search($this->_queryParams,
 376       $this->_action,
 377       NULL,
 378       $this->_single,
 379       $this->_limit,
 380       $this->_context
 381     );
 382     $selector->setKey($this->controller->_key);
 383
 384     $prefix = NULL;
 385     if ($this->_context == 'user') {
 386       $prefix = $this->_prefix;
 387     }
 388
 389     $this->assign("{$prefix}limit", $this->_limit);
 390     $this->assign("{$prefix}single", $this->_single);
 391
 392     $controller = new CRM_Core_Selector_Controller($selector,
 393       $this->get(CRM_Utils_Pager::PAGE_ID),
 394       $sortID,
 395       CRM_Core_Action::VIEW,
 396       $this,
 397       CRM_Core_Selector_Controller::SESSION,
 398       $prefix
 399     );
 400     $controller->setEmbedded(TRUE);
 401
 402     $query = &$selector->getQuery();
 403     if ($this->_context == 'user') {
 404       $query->setSkipPermission(TRUE);
 405     }
 406     $controller->run();
 407   }
 408
 409   /**
 410    * This function is used to add the rules (mainly global rules) for form.
 411    * All local rules are added near the element
 412    *
 413    * @return void
 414    * @access public
 415    * @see valid_date
 416    */
 417   function addRules() {
 418     $this->addFormRule(array('CRM_Case_Form_Search', 'formRule'));
 419   }
 420
 421   /**
 422    * global validation rules for the form
 423    *
 424    * @param array $fields posted values of the form
 425    * @param array $errors list of errors to be posted back to the form
 426    *
 427    * @return void
 428    * @static
 429    * @access public
 430    */
 431   static function formRule($fields) {
 432     $errors = array();
 433
 434     if (!empty($errors)) {
 435       return $errors;
 436     }
 437
 438     return TRUE;
 439   }
 440
 441   /**
 442    * Set the default form values
 443    *
 444    * @access protected
 445    *
 446    * @return array the default array reference
 447    */
 448   function setDefaultValues() {
 449     $defaults = array();
 450     $defaults = $this->_formValues;
 451     return $defaults;
 452   }
 453
 454   function fixFormValues() {
 455     if (!$this->_force) {
 456       return;
 457     }
 458
 459     $caseStatus = CRM_Utils_Request::retrieve('status', 'Positive',
 460       CRM_Core_DAO::$_nullObject
 461     );
 462     if ($caseStatus) {
 463       $this->_formValues['case_status_id'] = $caseStatus;
 464       $this->_defaults['case_status_id'] = $caseStatus;
 465     }
 466     $caseType = CRM_Utils_Request::retrieve('type', 'Positive',
 467       CRM_Core_DAO::$_nullObject
 468     );
 469     if ($caseType) {
 470       $this->_formValues['case_type_id'][$caseType] = 1;
 471       $this->_defaults['case_type_id'][$caseType] = 1;
 472     }
 473
 474     $caseFromDate = CRM_Utils_Request::retrieve('pstart', 'Date',
 475       CRM_Core_DAO::$_nullObject
 476     );
 477     if ($caseFromDate) {
 478       list($date) = CRM_Utils_Date::setDateDefaults($caseFromDate);
 479       $this->_formValues['case_start_date_low'] = $date;
 480       $this->_defaults['case_start_date_low'] = $date;
 481     }
 482
 483     $caseToDate = CRM_Utils_Request::retrieve('pend', 'Date',
 484       CRM_Core_DAO::$_nullObject
 485     );
 486     if ($caseToDate) {
 487       list($date) = CRM_Utils_Date::setDateDefaults($caseToDate);
 488       $this->_formValues['case_start_date_high'] = $date;
 489       $this->_defaults['case_start_date_high'] = $date;
 490     }
 491
 492     $cid = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
 493     if ($cid) {
 494       $cid = CRM_Utils_Type::escape($cid, 'Integer');
 495       if ($cid > 0) {
 496         $this->_formValues['contact_id'] = $cid;
 497         list($display, $image) = CRM_Contact_BAO_Contact::getDisplayAndImage($cid);
 498         $this->_defaults['sort_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $cid,
 499           'sort_name'
 500         );
 501         // also assign individual mode to the template
 502         $this->_single = TRUE;
 503       }
 504     }
 505     else {
 506         // First, if "all" is stored in the session, default to all cases, otherwise default to no selection.
 507       $session = CRM_Core_Session::singleton();
 508       if (CRM_Utils_Request::retrieve('all', 'Positive', $session)) {
 509         $this->_formValues['case_owner'] = 1;
 510         $this->_defaults['case_owner'] = 1;
 511       }
 512       else {
 513         $this->_formValues['case_owner'] = 0;
 514         $this->_defaults['case_owner'] = 0;
 515       }
 516
 517       // Now if case_owner is set in the url/post, use that instead.
 518       $caseOwner = CRM_Utils_Request::retrieve('case_owner', 'Positive',
 519         CRM_Core_DAO::$_nullObject
 520       );
 521       if ($caseOwner) {
 522         $this->_formValues['case_owner'] = $caseOwner;
 523         $this->_defaults['case_owner'] = $caseOwner;
 524       }
 525     }
 526   }
 527
 528   function getFormValues() {
 529     return NULL;
 530   }
 531
 532   /**
 533    * Return a descriptive name for the page, used in wizard header
 534    *
 535    * @return string
 536    * @access public
 537    */
 538   public function getTitle() {
 539     return ts('Find Cases');
 540   }
 541 }
 542