CRM/Activity/Form/Search.php

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