CRM/Activity/Form/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2016                                |
   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-2016
  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         'activity_subject',
 199       );
 200       $changeNames = array('status_id' => 'activity_status_id');
 201       CRM_Contact_BAO_Query::processSpecialFormValue($this->_formValues, $specialParams, $changeNames);
 202     }
 203
 204     $this->fixFormValues();
 205
 206     if (isset($this->_ssID) && empty($_POST)) {
 207       // if we are editing / running a saved search and the form has not been posted
 208       $this->_formValues = CRM_Contact_BAO_SavedSearch::getFormValues($this->_ssID);
 209     }
 210
 211     // We don't show test records in summaries or dashboards
 212     if (empty($this->_formValues['activity_test']) && $this->_force) {
 213       $this->_formValues["activity_test"] = 0;
 214     }
 215
 216     CRM_Core_BAO_CustomValue::fixCustomFieldValue($this->_formValues);
 217
 218     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 219
 220     $this->set('formValues', $this->_formValues);
 221     $this->set('queryParams', $this->_queryParams);
 222
 223     $buttonName = $this->controller->getButtonName();
 224     if ($buttonName == $this->_actionButtonName) {
 225       // check actionName and if next, then do not repeat a search, since we are going to the next page
 226       // hack, make sure we reset the task values
 227       $stateMachine = $this->controller->getStateMachine();
 228       $formName = $stateMachine->getTaskFormName();
 229       $this->controller->resetPage($formName);
 230       return;
 231     }
 232
 233     $sortID = NULL;
 234     if ($this->get(CRM_Utils_Sort::SORT_ID)) {
 235       $sortID = CRM_Utils_Sort::sortIDValue($this->get(CRM_Utils_Sort::SORT_ID),
 236         $this->get(CRM_Utils_Sort::SORT_DIRECTION)
 237       );
 238     }
 239
 240     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 241
 242     $selector = new CRM_Activity_Selector_Search($this->_queryParams,
 243       $this->_action,
 244       NULL,
 245       $this->_single,
 246       $this->_limit,
 247       $this->_context
 248     );
 249     $selector->setKey($this->controller->_key);
 250
 251     $prefix = NULL;
 252     if ($this->_context == 'basic' || $this->_context == 'user') {
 253       $prefix = $this->_prefix;
 254     }
 255
 256     $controller = new CRM_Core_Selector_Controller($selector,
 257       $this->get(CRM_Utils_Pager::PAGE_ID),
 258       $sortID,
 259       CRM_Core_Action::VIEW,
 260       $this,
 261       CRM_Core_Selector_Controller::SESSION,
 262       $prefix
 263     );
 264     $controller->setEmbedded(TRUE);
 265     $query = &$selector->getQuery();
 266
 267     if ($this->_context == 'user') {
 268       $query->setSkipPermission(TRUE);
 269     }
 270     $controller->run();
 271   }
 272
 273   public function fixFormValues() {
 274     if (!$this->_force) {
 275       return;
 276     }
 277
 278     $status = CRM_Utils_Request::retrieve('status', 'String', $this);
 279     if ($status) {
 280       $this->_formValues['activity_status_id'] = $status;
 281       $this->_defaults['activity_status_id'] = $status;
 282     }
 283
 284     $survey = CRM_Utils_Request::retrieve('survey', 'Positive');
 285
 286     if ($survey) {
 287       $this->_formValues['activity_survey_id'] = $this->_defaults['activity_survey_id'] = $survey;
 288       $sid = CRM_Utils_Array::value('activity_survey_id', $this->_formValues);
 289       $activity_type_id = CRM_Core_DAO::getFieldValue('CRM_Campaign_DAO_Survey', $sid, 'activity_type_id');
 290
 291       // since checkbox are replaced by multiple select option
 292       $this->_formValues['activity_type_id'] = $activity_type_id;
 293       $this->_defaults['activity_type_id'] = $activity_type_id;
 294     }
 295     $cid = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
 296
 297     if ($cid) {
 298       $cid = CRM_Utils_Type::escape($cid, 'Integer');
 299       if ($cid > 0) {
 300         $this->_formValues['contact_id'] = $cid;
 301
 302         $activity_role = CRM_Utils_Request::retrieve('activity_role', 'Positive', $this);
 303
 304         if ($activity_role) {
 305           $this->_formValues['activity_role'] = $activity_role;
 306         }
 307         else {
 308           $this->_defaults['sort_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $cid, 'sort_name');
 309         }
 310         // also assign individual mode to the template
 311         $this->_single = TRUE;
 312       }
 313     }
 314
 315     // Added for membership search
 316
 317     $signupType = CRM_Utils_Request::retrieve('signupType', 'Positive',
 318       CRM_Core_DAO::$_nullObject
 319     );
 320
 321     if ($signupType) {
 322       $this->_formValues['activity_role'] = 1;
 323       $this->_defaults['activity_role'] = 1;
 324       $activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, FALSE, FALSE, 'name');
 325
 326       $renew = CRM_Utils_Array::key('Membership Renewal', $activityTypes);
 327       $signup = CRM_Utils_Array::key('Membership Signup', $activityTypes);
 328
 329       switch ($signupType) {
 330         case 3: // signups and renewals
 331           $this->_formValues['activity_type_id'][$renew] = 1;
 332           $this->_defaults['activity_type_id'][$renew] = 1;
 333         case 1: // signups only
 334           $this->_formValues['activity_type_id'][$signup] = 1;
 335           $this->_defaults['activity_type_id'][$signup] = 1;
 336           break;
 337
 338         case 2: // renewals only
 339           $this->_formValues['activity_type_id'][$renew] = 1;
 340           $this->_defaults['activity_type_id'][$renew] = 1;
 341           break;
 342       }
 343     }
 344
 345     $dateLow = CRM_Utils_Request::retrieve('dateLow', 'String',
 346       CRM_Core_DAO::$_nullObject
 347     );
 348
 349     if ($dateLow) {
 350       $dateLow = date('m/d/Y', strtotime($dateLow));
 351       $this->_formValues['activity_date_relative'] = 0;
 352       $this->_defaults['activity_date_relative'] = 0;
 353       $this->_formValues['activity_date_low'] = $dateLow;
 354       $this->_defaults['activity_date_low'] = $dateLow;
 355     }
 356
 357     $dateHigh = CRM_Utils_Request::retrieve('dateHigh', 'String',
 358       CRM_Core_DAO::$_nullObject
 359     );
 360
 361     if ($dateHigh) {
 362       // Activity date time assumes midnight at the beginning of the date
 363       // This sets it to almost midnight at the end of the date
 364       /*   if ($dateHigh <= 99999999) {
 365       $dateHigh = 1000000 * $dateHigh + 235959;
 366       } */
 367       $dateHigh = date('m/d/Y', strtotime($dateHigh));
 368       $this->_formValues['activity_date_relative'] = 0;
 369       $this->_defaults['activity_date_relative'] = 0;
 370       $this->_formValues['activity_date_high'] = $dateHigh;
 371       $this->_defaults['activity_date_high'] = $dateHigh;
 372     }
 373
 374     // Enable search activity by custom value
 375     $requestParams = CRM_Utils_Request::exportValues();
 376     foreach (array_keys($requestParams) as $key) {
 377       if (substr($key, 0, 7) != 'custom_') {
 378         continue;
 379       }
 380       elseif (empty($requestParams[$key])) {
 381         continue;
 382       }
 383       $customValue = CRM_Utils_Request::retrieve($key, 'String', $this);
 384       if ($customValue) {
 385         $this->_formValues[$key] = $customValue;
 386         $this->_defaults[$key] = $customValue;
 387       }
 388     }
 389
 390     if (!empty($this->_defaults)) {
 391       $this->setDefaults($this->_defaults);
 392     }
 393   }
 394
 395   /**
 396    * @return null
 397    */
 398   public function getFormValues() {
 399     return NULL;
 400   }
 401
 402   /**
 403    * Return a descriptive name for the page, used in wizard header
 404    *
 405    * @return string
 406    */
 407   public function getTitle() {
 408     return ts('Find Activities');
 409   }
 410
 411 }