CRM/Member/Form/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   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  * Files required
  38  */
  39
  40 /**
  41  * This file is for civimember search
  42  */
  43 class CRM_Member_Form_Search extends CRM_Core_Form {
  44
  45   /**
  46    * Are we forced to run a search
  47    *
  48    * @var int
  49    * @access protected
  50    */
  51   protected $_force;
  52
  53   /**
  54    * name of search button
  55    *
  56    * @var string
  57    * @access protected
  58    */
  59   protected $_searchButtonName;
  60
  61   /**
  62    * name of print button
  63    *
  64    * @var string
  65    * @access protected
  66    */
  67   protected $_printButtonName;
  68
  69   /**
  70    * name of action button
  71    *
  72    * @var string
  73    * @access protected
  74    */
  75   protected $_actionButtonName;
  76
  77   /**
  78    * form values that we will be using
  79    *
  80    * @var array
  81    * @access protected
  82    */
  83   protected $_formValues;
  84
  85   /**
  86    * the params that are sent to the query
  87    *
  88    * @var array
  89    * @access protected
  90    */
  91   protected $_queryParams;
  92
  93   /**
  94    * have we already done this search
  95    *
  96    * @access protected
  97    * @var boolean
  98    */
  99   protected $_done;
 100
 101   /**
 102    * are we restricting ourselves to a single contact
 103    *
 104    * @access protected
 105    * @var boolean
 106    */
 107   protected $_single = FALSE;
 108
 109   /**
 110    * are we restricting ourselves to a single contact
 111    *
 112    * @access protected
 113    * @var boolean
 114    */
 115   protected $_limit = NULL;
 116
 117   /**
 118    * what context are we being invoked from
 119    *
 120    * @access protected
 121    * @var string
 122    */
 123   protected $_context = NULL;
 124
 125   protected $_defaults;
 126
 127   /**
 128    * prefix for the controller
 129    *
 130    */
 131   protected $_prefix = "member_";
 132
 133   /**
 134    * processing needed for buildForm and later
 135    *
 136    * @return void
 137    * @access public
 138    */
 139   function preProcess() {
 140     $this->set('searchFormName', 'Search');
 141
 142     /**
 143      * set the button names
 144      */
 145     $this->_searchButtonName = $this->getButtonName('refresh');
 146     $this->_printButtonName = $this->getButtonName('next', 'print');
 147     $this->_actionButtonName = $this->getButtonName('next', 'action');
 148
 149     $this->_done = FALSE;
 150
 151     $this->defaults = array();
 152
 153     /*
 154          * we allow the controller to set force/reset externally, useful when we are being
 155          * driven by the wizard framework
 156          */
 157
 158     $this->_reset   = CRM_Utils_Request::retrieve('reset', 'Boolean', CRM_Core_DAO::$_nullObject);
 159     $this->_force   = CRM_Utils_Request::retrieve('force', 'Boolean', $this, FALSE);
 160     $this->_limit   = CRM_Utils_Request::retrieve('limit', 'Positive', $this);
 161     $this->_context = CRM_Utils_Request::retrieve('context', 'String', $this, FALSE, 'search');
 162
 163     $this->assign("context", $this->_context);
 164
 165     // get user submitted values
 166     // get it from controller only if form has been submitted, else preProcess has set this
 167     if (!empty($_POST)) {
 168       $this->_formValues = $this->controller->exportValues($this->_name);
 169     }
 170     else {
 171       $this->_formValues = $this->get('formValues');
 172     }
 173
 174     if ($this->_force) {
 175       $this->postProcess();
 176       $this->set('force', 0);
 177     }
 178
 179     $sortID = NULL;
 180     if ($this->get(CRM_Utils_Sort::SORT_ID)) {
 181       $sortID = CRM_Utils_Sort::sortIDValue($this->get(CRM_Utils_Sort::SORT_ID),
 182         $this->get(CRM_Utils_Sort::SORT_DIRECTION)
 183       );
 184     }
 185
 186     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 187     $selector = new CRM_Member_Selector_Search($this->_queryParams,
 188       $this->_action,
 189       NULL,
 190       $this->_single,
 191       $this->_limit,
 192       $this->_context
 193     );
 194     $prefix = NULL;
 195     if ($this->_context == 'basic') {
 196       $prefix = $this->_prefix;
 197     }
 198
 199     $this->assign("{$prefix}limit", $this->_limit);
 200     $this->assign("{$prefix}single", $this->_single);
 201
 202     $controller = new CRM_Core_Selector_Controller($selector,
 203       $this->get(CRM_Utils_Pager::PAGE_ID),
 204       $sortID,
 205       CRM_Core_Action::VIEW,
 206       $this,
 207       CRM_Core_Selector_Controller::TRANSFER,
 208       $prefix
 209     );
 210
 211     $controller->setEmbedded(TRUE);
 212     $controller->moveFromSessionToTemplate();
 213
 214     $this->assign('summary', $this->get('summary'));
 215   }
 216
 217   /**
 218    * Build the form
 219    *
 220    * @access public
 221    *
 222    * @return void
 223    */
 224   function buildQuickForm() {
 225     $this->addElement('text', 'sort_name', ts('Member Name or Email'), CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'sort_name'));
 226
 227     CRM_Member_BAO_Query::buildSearchForm($this);
 228
 229     /*
 230          * add form checkboxes for each row. This is needed out here to conform to QF protocol
 231          * of all elements being declared in builQuickForm
 232          */
 233
 234     $rows = $this->get('rows');
 235     if (is_array($rows)) {
 236       if (!$this->_single) {
 237         $this->addElement('checkbox', 'toggleSelect', NULL, NULL, array('onclick' => "toggleTaskAction( true ); return toggleCheckboxVals('mark_x_',this);"));
 238         foreach ($rows as $row) {
 239           $this->addElement('checkbox', $row['checkbox'],
 240             NULL, NULL,
 241             array('onclick' => "toggleTaskAction( true ); return checkSelectedBox('" . $row['checkbox'] . "');")
 242           );
 243         }
 244       }
 245
 246       $total = $cancel = 0;
 247
 248       $permission = CRM_Core_Permission::getPermission();
 249
 250       $tasks = array('' => ts('- actions -')) + CRM_Member_Task::permissionedTaskTitles($permission);
 251       $this->add('select', 'task', ts('Actions:') . ' ', $tasks);
 252       $this->add('submit', $this->_actionButtonName, ts('Go'),
 253         array(
 254           'class' => 'form-submit',
 255           'id' => 'Go',
 256           'onclick' => "return checkPerformAction('mark_x', '" . $this->getName() . "', 0);",
 257         )
 258       );
 259
 260       $this->add('submit', $this->_printButtonName, ts('Print'),
 261         array(
 262           'class' => 'form-submit',
 263           'onclick' => "return checkPerformAction('mark_x', '" . $this->getName() . "', 1);",
 264         )
 265       );
 266
 267
 268       // need to perform tasks on all or selected items ? using radio_ts(task selection) for it
 269       $this->addElement('radio', 'radio_ts', NULL, '', 'ts_sel', array('checked' => 'checked'));
 270       $this->addElement('radio', 'radio_ts', NULL, '', 'ts_all', array('onclick' => $this->getName() . ".toggleSelect.checked = false; toggleCheckboxVals('mark_x_',this); toggleTaskAction( true );"));
 271     }
 272
 273
 274     // add buttons
 275     $this->addButtons(array(
 276         array(
 277           'type' => 'refresh',
 278           'name' => ts('Search'),
 279           'isDefault' => TRUE,
 280         ),
 281       ));
 282   }
 283
 284   /**
 285    * The post processing of the form gets done here.
 286    *
 287    * Key things done during post processing are
 288    *      - check for reset or next request. if present, skip post procesing.
 289    *      - now check if user requested running a saved search, if so, then
 290    *        the form values associated with the saved search are used for searching.
 291    *      - if user has done a submit with new values the regular post submissing is
 292    *        done.
 293    * The processing consists of using a Selector / Controller framework for getting the
 294    * search results.
 295    *
 296    * @param
 297    *
 298    * @return void
 299    * @access public
 300    */
 301   function postProcess() {
 302     if ($this->_done) {
 303       return;
 304     }
 305
 306     $this->_done = TRUE;
 307
 308     $this->_formValues = $this->controller->exportValues($this->_name);
 309
 310     $this->fixFormValues();
 311
 312     // we don't show test memberships in Contact Summary / User Dashboard
 313     // in Search mode by default we hide test memberships
 314     if (!CRM_Utils_Array::value('member_test',
 315         $this->_formValues
 316       )) {
 317       $this->_formValues["member_test"] = 0;
 318     }
 319
 320     CRM_Core_BAO_CustomValue::fixFieldValueOfTypeMemo($this->_formValues);
 321
 322     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 323
 324     $this->set('formValues', $this->_formValues);
 325     $this->set('queryParams', $this->_queryParams);
 326
 327     $buttonName = $this->controller->getButtonName();
 328     if ($buttonName == $this->_actionButtonName || $buttonName == $this->_printButtonName) {
 329       // check actionName and if next, then do not repeat a search, since we are going to the next page
 330
 331       // hack, make sure we reset the task values
 332       $stateMachine = &$this->controller->getStateMachine();
 333       $formName = $stateMachine->getTaskFormName();
 334       $this->controller->resetPage($formName);
 335       return;
 336     }
 337
 338     $sortID = NULL;
 339     if ($this->get(CRM_Utils_Sort::SORT_ID)) {
 340       $sortID = CRM_Utils_Sort::sortIDValue($this->get(CRM_Utils_Sort::SORT_ID),
 341         $this->get(CRM_Utils_Sort::SORT_DIRECTION)
 342       );
 343     }
 344
 345     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 346
 347     $selector = new CRM_Member_Selector_Search($this->_queryParams,
 348       $this->_action,
 349       NULL,
 350       $this->_single,
 351       $this->_limit,
 352       $this->_context
 353     );
 354     $selector->setKey($this->controller->_key);
 355
 356     $prefix = NULL;
 357     if ($this->_context == 'basic') {
 358       $prefix = $this->_prefix;
 359     }
 360
 361     $controller = new CRM_Core_Selector_Controller($selector,
 362       $this->get(CRM_Utils_Pager::PAGE_ID),
 363       $sortID,
 364       CRM_Core_Action::VIEW,
 365       $this,
 366       CRM_Core_Selector_Controller::SESSION,
 367       $prefix
 368     );
 369     $controller->setEmbedded(TRUE);
 370
 371     $query = &$selector->getQuery();
 372     $controller->run();
 373   }
 374
 375   function setDefaultValues() {
 376     return $this->_defaults;
 377   }
 378
 379   function fixFormValues() {
 380     // if this search has been forced
 381     // then see if there are any get values, and if so over-ride the post values
 382     // note that this means that GET over-rides POST :)
 383
 384     if (!$this->_force) {
 385       return;
 386     }
 387
 388     $status = CRM_Utils_Request::retrieve('status', 'String',
 389       CRM_Core_DAO::$_nullObject
 390     );
 391     if ($status) {
 392       $status = explode(',', $status);
 393       $tempStatus = array();
 394       foreach ($status as $value) {
 395         $tempStatus[$value] = 1;
 396       }
 397       $this->_formValues['member_status_id'] = $tempStatus;
 398       $this->_defaults['member_status_id'] = $tempStatus;
 399     }
 400
 401     $membershipType = CRM_Utils_Request::retrieve('type', 'String',
 402       CRM_Core_DAO::$_nullObject
 403     );
 404
 405     if ($membershipType) {
 406       $this->_formValues['member_membership_type_id'] = array($membershipType => 1);
 407       $this->_defaults['member_membership_type_id'] = array($membershipType => 1);
 408     }
 409
 410
 411     $cid = CRM_Utils_Request::retrieve('cid', 'Positive',
 412       CRM_Core_DAO::$_nullObject
 413     );
 414
 415     if ($cid) {
 416       $cid = CRM_Utils_Type::escape($cid, 'Integer');
 417       if ($cid > 0) {
 418         $this->_formValues['contact_id'] = $cid;
 419         list($display, $image) = CRM_Contact_BAO_Contact::getDisplayAndImage($cid);
 420         $this->_defaults['sort_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $cid,
 421           'sort_name'
 422         );
 423         // also assign individual mode to the template
 424         $this->_single = TRUE;
 425       }
 426     }
 427
 428     $fromDate = CRM_Utils_Request::retrieve('start', 'Date',
 429       CRM_Core_DAO::$_nullObject
 430     );
 431     if ($fromDate) {
 432       list($date) = CRM_Utils_Date::setDateDefaults($fromDate);
 433       $this->_formValues['member_start_date_low'] = $this->_defaults['member_start_date_low'] = $date;
 434     }
 435
 436     $toDate = CRM_Utils_Request::retrieve('end', 'Date',
 437       CRM_Core_DAO::$_nullObject
 438     );
 439     if ($toDate) {
 440       list($date) = CRM_Utils_Date::setDateDefaults($toDate);
 441       $this->_formValues['member_start_date_high'] = $this->_defaults['member_start_date_high'] = $date;
 442     }
 443     $joinDate = CRM_Utils_Request::retrieve('join', 'Date',
 444       CRM_Core_DAO::$_nullObject
 445     );
 446     if ($joinDate) {
 447       list($date) = CRM_Utils_Date::setDateDefaults($joinDate);
 448       $this->_formValues['member_join_date_low'] = $this->_defaults['member_join_date_low'] = $date;
 449     }
 450
 451     $joinEndDate = CRM_Utils_Request::retrieve('joinEnd', 'Date',
 452       CRM_Core_DAO::$_nullObject
 453     );
 454     if ($joinEndDate) {
 455       list($date) = CRM_Utils_Date::setDateDefaults($joinEndDate);
 456       $this->_formValues['member_join_date_high'] = $this->_defaults['member_join_date_high'] = $date;
 457     }
 458
 459     $this->_limit = CRM_Utils_Request::retrieve('limit', 'Positive',
 460       $this
 461     );
 462
 463     //LCD also allow restrictions to membership owner via GET
 464     $owner = CRM_Utils_Request::retrieve('owner', 'String', CRM_Core_DAO::$_nullObject);
 465     if ($owner) {
 466       $this->_formValues['member_is_primary'] = $this->_defaults['member_is_primary'] = 2;
 467     }
 468   }
 469
 470   /**
 471    * Return a descriptive name for the page, used in wizard header
 472    *
 473    * @return string
 474    * @access public
 475    */
 476   public function getTitle() {
 477     return ts('Find Memberships');
 478   }
 479 }
 480