CRM/Activity/Form/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   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-2017
  32  */
  33
  34 /**
  35  * This file is for activity search.
  36  */
  37 class CRM_Activity_Form_Search extends CRM_Core_Form_Search {
  38
  39   /**
  40    * The params that are sent to the query.
  41    *
  42    * @var array
  43    */
  44   protected $_queryParams;
  45
  46   /**
  47    * Are we restricting ourselves to a single contact.
  48    *
  49    * @var boolean
  50    */
  51   protected $_single = FALSE;
  52
  53   /**
  54    * Are we restricting ourselves to a single contact.
  55    *
  56    * @var boolean
  57    */
  58   protected $_limit = NULL;
  59
  60   /**
  61    * Prefix for the controller.
  62    */
  63   protected $_prefix = "activity_";
  64
  65   /**
  66    * The saved search ID retrieved from the GET vars.
  67    *
  68    * @var int
  69    */
  70   protected $_ssID;
  71
  72   /**
  73    * Processing needed for buildForm and later.
  74    */
  75   public function preProcess() {
  76     $this->set('searchFormName', 'Search');
  77
  78     // set the button names
  79     $this->_searchButtonName = $this->getButtonName('refresh');
  80     $this->_actionButtonName = $this->getButtonName('next', 'action');
  81
  82     $this->_done = FALSE;
  83     $this->defaults = array();
  84
  85     // we allow the controller to set force/reset externally, useful when we are being
  86     // driven by the wizard framework
  87     $this->_reset = CRM_Utils_Request::retrieve('reset', 'Boolean');
  88     $this->_force = CRM_Utils_Request::retrieve('force', 'Boolean', $this, FALSE);
  89     $this->_limit = CRM_Utils_Request::retrieve('limit', 'Positive', $this);
  90     $this->_context = CRM_Utils_Request::retrieve('context', 'String', $this, FALSE, 'search');
  91
  92     $this->assign("context", $this->_context);
  93
  94     // get user submitted values
  95     // get it from controller only if form has been submitted, else preProcess has set this
  96     if (!empty($_POST) && !$this->controller->isModal()) {
  97       $this->_formValues = $this->controller->exportValues($this->_name);
  98     }
  99     else {
 100       $this->_formValues = $this->get('formValues');
 101     }
 102
 103     if (empty($this->_formValues)) {
 104       if (isset($this->_ssID)) {
 105         $this->_formValues = CRM_Contact_BAO_SavedSearch::getFormValues($this->_ssID);
 106       }
 107     }
 108
 109     if ($this->_force) {
 110       $this->postProcess();
 111       $this->set('force', 0);
 112     }
 113
 114     $sortID = NULL;
 115     if ($this->get(CRM_Utils_Sort::SORT_ID)) {
 116       $sortID = CRM_Utils_Sort::sortIDValue($this->get(CRM_Utils_Sort::SORT_ID),
 117         $this->get(CRM_Utils_Sort::SORT_DIRECTION)
 118       );
 119     }
 120
 121     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 122     $selector = new CRM_Activity_Selector_Search($this->_queryParams,
 123       $this->_action,
 124       NULL,
 125       $this->_single,
 126       $this->_limit,
 127       $this->_context
 128     );
 129     $prefix = NULL;
 130     if ($this->_context == 'user') {
 131       $prefix = $this->_prefix;
 132     }
 133
 134     $this->assign("{$prefix}limit", $this->_limit);
 135     $this->assign("{$prefix}single", $this->_single);
 136
 137     $controller = new CRM_Core_Selector_Controller($selector,
 138       $this->get(CRM_Utils_Pager::PAGE_ID),
 139       $sortID,
 140       CRM_Core_Action::VIEW,
 141       $this,
 142       CRM_Core_Selector_Controller::TRANSFER,
 143       $prefix
 144     );
 145     $controller->setEmbedded(TRUE);
 146     $controller->moveFromSessionToTemplate();
 147
 148     $this->assign('summary', $this->get('summary'));
 149   }
 150
 151   /**
 152    * Build the form object.
 153    */
 154   public function buildQuickForm() {
 155     parent::buildQuickForm();
 156     $this->addSortNameField();
 157
 158     CRM_Activity_BAO_Query::buildSearchForm($this);
 159
 160     $rows = $this->get('rows');
 161     if (is_array($rows)) {
 162       if (!$this->_single) {
 163         $this->addRowSelectors($rows);
 164       }
 165
 166       $permission = CRM_Core_Permission::getPermission();
 167
 168       $this->addTaskMenu(CRM_Activity_Task::permissionedTaskTitles($permission));
 169     }
 170
 171   }
 172
 173   /**
 174    * The post processing of the form gets done here.
 175    *
 176    * Key things done during post processing are
 177    *      - check for reset or next request. if present, skip post procesing.
 178    *      - now check if user requested running a saved search, if so, then
 179    *        the form values associated with the saved search are used for searching.
 180    *      - if user has done a submit with new values the regular post submissing is
 181    *        done.
 182    *
 183    * The processing consists of using a Selector / Controller framework for getting the
 184    * search results.
 185    */
 186   public function postProcess() {
 187     if ($this->_done) {
 188       return;
 189     }
 190
 191     $this->_done = TRUE;
 192
 193     if (!empty($_POST)) {
 194       $this->_formValues = $this->controller->exportValues($this->_name);
 195       $specialParams = array(
 196         'activity_type_id',
 197         'status_id',
 198         'priority_id',
 199         'activity_text',
 200       );
 201       $changeNames = array(
 202         'status_id' => 'activity_status_id',
 203         'priority_id' => 'activity_priority_id',
 204       );
 205
 206       CRM_Contact_BAO_Query::processSpecialFormValue($this->_formValues, $specialParams, $changeNames);
 207     }
 208
 209     $this->fixFormValues();
 210
 211     if (isset($this->_ssID) && empty($_POST)) {
 212       // if we are editing / running a saved search and the form has not been posted
 213       $this->_formValues = CRM_Contact_BAO_SavedSearch::getFormValues($this->_ssID);
 214     }
 215
 216     // We don't show test records in summaries or dashboards
 217     if (empty($this->_formValues['activity_test']) && $this->_force) {
 218       $this->_formValues["activity_test"] = 0;
 219     }
 220
 221     CRM_Core_BAO_CustomValue::fixCustomFieldValue($this->_formValues);
 222
 223     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 224
 225     $this->set('formValues', $this->_formValues);
 226     $this->set('queryParams', $this->_queryParams);
 227
 228     $buttonName = $this->controller->getButtonName();
 229     if ($buttonName == $this->_actionButtonName) {
 230       // check actionName and if next, then do not repeat a search, since we are going to the next page
 231       // hack, make sure we reset the task values
 232       $stateMachine = $this->controller->getStateMachine();
 233       $formName = $stateMachine->getTaskFormName();
 234       $this->controller->resetPage($formName);
 235       return;
 236     }
 237
 238     $sortID = NULL;
 239     if ($this->get(CRM_Utils_Sort::SORT_ID)) {
 240       $sortID = CRM_Utils_Sort::sortIDValue($this->get(CRM_Utils_Sort::SORT_ID),
 241         $this->get(CRM_Utils_Sort::SORT_DIRECTION)
 242       );
 243     }
 244
 245     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 246
 247     $selector = new CRM_Activity_Selector_Search($this->_queryParams,
 248       $this->_action,
 249       NULL,
 250       $this->_single,
 251       $this->_limit,
 252       $this->_context
 253     );
 254     $selector->setKey($this->controller->_key);
 255
 256     $prefix = NULL;
 257     if ($this->_context == 'basic' || $this->_context == 'user') {
 258       $prefix = $this->_prefix;
 259     }
 260
 261     $controller = new CRM_Core_Selector_Controller($selector,
 262       $this->get(CRM_Utils_Pager::PAGE_ID),
 263       $sortID,
 264       CRM_Core_Action::VIEW,
 265       $this,
 266       CRM_Core_Selector_Controller::SESSION,
 267       $prefix
 268     );
 269     $controller->setEmbedded(TRUE);
 270     $query = &$selector->getQuery();
 271
 272     if ($this->_context == 'user') {
 273       $query->setSkipPermission(TRUE);
 274     }
 275     $controller->run();
 276   }
 277
 278   public function fixFormValues() {
 279     if (!$this->_force) {
 280       return;
 281     }
 282
 283     $status = CRM_Utils_Request::retrieve('status', 'String', $this);
 284     if ($status) {
 285       $this->_formValues['activity_status_id'] = $status;
 286       $this->_defaults['activity_status_id'] = $status;
 287     }
 288
 289     $survey = CRM_Utils_Request::retrieve('survey', 'Positive');
 290
 291     if ($survey) {
 292       $this->_formValues['activity_survey_id'] = $this->_defaults['activity_survey_id'] = $survey;
 293       $sid = CRM_Utils_Array::value('activity_survey_id', $this->_formValues);
 294       $activity_type_id = CRM_Core_DAO::getFieldValue('CRM_Campaign_DAO_Survey', $sid, 'activity_type_id');
 295
 296       // since checkbox are replaced by multiple select option
 297       $this->_formValues['activity_type_id'] = $activity_type_id;
 298       $this->_defaults['activity_type_id'] = $activity_type_id;
 299     }
 300     $cid = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
 301
 302     if ($cid) {
 303       $cid = CRM_Utils_Type::escape($cid, 'Integer');
 304       if ($cid > 0) {
 305         $this->_formValues['contact_id'] = $cid;
 306
 307         $activity_role = CRM_Utils_Request::retrieve('activity_role', 'Positive', $this);
 308
 309         if ($activity_role) {
 310           $this->_formValues['activity_role'] = $activity_role;
 311         }
 312         else {
 313           $this->_defaults['sort_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $cid, 'sort_name');
 314         }
 315         // also assign individual mode to the template
 316         $this->_single = TRUE;
 317       }
 318     }
 319
 320     // Added for membership search
 321
 322     $signupType = CRM_Utils_Request::retrieve('signupType', 'Positive');
 323
 324     if ($signupType) {
 325       $this->_formValues['activity_role'] = 1;
 326       $this->_defaults['activity_role'] = 1;
 327       $activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, FALSE, FALSE, 'name');
 328
 329       $renew = CRM_Utils_Array::key('Membership Renewal', $activityTypes);
 330       $signup = CRM_Utils_Array::key('Membership Signup', $activityTypes);
 331
 332       switch ($signupType) {
 333         case 3: // signups and renewals
 334           $this->_formValues['activity_type_id'][$renew] = 1;
 335           $this->_defaults['activity_type_id'][$renew] = 1;
 336         case 1: // signups only
 337           $this->_formValues['activity_type_id'][$signup] = 1;
 338           $this->_defaults['activity_type_id'][$signup] = 1;
 339           break;
 340
 341         case 2: // renewals only
 342           $this->_formValues['activity_type_id'][$renew] = 1;
 343           $this->_defaults['activity_type_id'][$renew] = 1;
 344           break;
 345       }
 346     }
 347
 348     $dateLow = CRM_Utils_Request::retrieve('dateLow', 'String');
 349
 350     if ($dateLow) {
 351       $dateLow = date('m/d/Y', strtotime($dateLow));
 352       $this->_formValues['activity_date_relative'] = 0;
 353       $this->_defaults['activity_date_relative'] = 0;
 354       $this->_formValues['activity_date_low'] = $dateLow;
 355       $this->_defaults['activity_date_low'] = $dateLow;
 356     }
 357
 358     $dateHigh = CRM_Utils_Request::retrieve('dateHigh', 'String');
 359
 360     if ($dateHigh) {
 361       // Activity date time assumes midnight at the beginning of the date
 362       // This sets it to almost midnight at the end of the date
 363       /*   if ($dateHigh <= 99999999) {
 364       $dateHigh = 1000000 * $dateHigh + 235959;
 365       } */
 366       $dateHigh = date('m/d/Y', strtotime($dateHigh));
 367       $this->_formValues['activity_date_relative'] = 0;
 368       $this->_defaults['activity_date_relative'] = 0;
 369       $this->_formValues['activity_date_high'] = $dateHigh;
 370       $this->_defaults['activity_date_high'] = $dateHigh;
 371     }
 372
 373     // Enable search activity by custom value
 374     $requestParams = CRM_Utils_Request::exportValues();
 375     foreach (array_keys($requestParams) as $key) {
 376       if (substr($key, 0, 7) != 'custom_') {
 377         continue;
 378       }
 379       elseif (empty($requestParams[$key])) {
 380         continue;
 381       }
 382       $customValue = CRM_Utils_Request::retrieve($key, 'String', $this);
 383       if ($customValue) {
 384         $this->_formValues[$key] = $customValue;
 385         $this->_defaults[$key] = $customValue;
 386       }
 387     }
 388
 389     if (!empty($this->_defaults)) {
 390       $this->setDefaults($this->_defaults);
 391     }
 392   }
 393
 394   /**
 395    * @return null
 396    */
 397   public function getFormValues() {
 398     return NULL;
 399   }
 400
 401   /**
 402    * Return a descriptive name for the page, used in wizard header
 403    *
 404    * @return string
 405    */
 406   public function getTitle() {
 407     return ts('Find Activities');
 408   }
 409
 410 }