CRM/Campaign/Selector/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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 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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class is used to retrieve and display a range of
  38  * contacts that match the given criteria (specifically for
  39  * results of advanced search options.
  40  *
  41  */
  42 class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM_Core_Selector_API {
  43
  44   /**
  45    * This defines two actions- View and Edit.
  46    *
  47    * @var array
  48    * @static
  49    */
  50   static $_links = NULL;
  51
  52   /**
  53    * We use desc to remind us what that column is, name is used in the tpl
  54    *
  55    * @var array
  56    * @static
  57    */
  58   static $_columnHeaders;
  59
  60   /**
  61    * Properties of contact we're interested in displaying
  62    * @var array
  63    * @static
  64    */
  65   static $_properties = array(
  66     'contact_id',
  67     'sort_name',
  68     'street_unit',
  69     'street_name',
  70     'street_number',
  71     'street_address',
  72     'city',
  73     'postal_code',
  74     'state_province',
  75     'country',
  76     'email',
  77     'phone',
  78     'campaign_id',
  79     'survey_activity_id',
  80     'survey_activity_target_id',
  81     'survey_activity_target_contact_id',
  82   );
  83
  84   /**
  85    * Are we restricting ourselves to a single contact
  86    *
  87    * @access protected
  88    * @var boolean
  89    */
  90   protected $_single = FALSE;
  91
  92   /**
  93    * Are we restricting ourselves to a single contact
  94    *
  95    * @access protected
  96    * @var boolean
  97    */
  98   protected $_limit = NULL;
  99
 100   /**
 101    * What context are we being invoked from
 102    *
 103    * @access protected
 104    * @var string
 105    */
 106   protected $_context = NULL;
 107
 108   /**
 109    * QueryParams is the array returned by exportValues called on
 110    * the HTML_QuickForm_Controller for that page.
 111    *
 112    * @var array
 113    * @access protected
 114    */
 115   public $_queryParams;
 116
 117   /**
 118    * Represent the type of selector
 119    *
 120    * @var int
 121    * @access protected
 122    */
 123   protected $_action;
 124
 125   /**
 126    * The additional clause that we restrict the search with
 127    *
 128    * @var string
 129    */
 130   protected $_surveyClause = NULL;
 131
 132   /**
 133    * The query object
 134    *
 135    * @var string
 136    */
 137   protected $_query;
 138
 139   /**
 140    * Class constructor
 141    *
 142    * @param array $queryParams array of parameters for query
 143    * @param \const|int $action - action of search basic or advanced.
 144    * @param string $surveyClause if the caller wants to further restrict the search.
 145    * @param boolean $single are we dealing only with one contact?
 146    * @param int $limit how many voters do we want returned
 147    *
 148    * @param string $context
 149    *
 150    * @return \CRM_Campaign_Selector_Search
 151   @access public
 152    */
 153   function __construct(&$queryParams,
 154     $action       = CRM_Core_Action::NONE,
 155     $surveyClause = NULL,
 156     $single       = FALSE,
 157     $limit        = NULL,
 158     $context      = 'search'
 159   ) {
 160     // submitted form values
 161     $this->_queryParams = &$queryParams;
 162
 163     $this->_single  = $single;
 164     $this->_limit   = $limit;
 165     $this->_context = $context;
 166
 167     $this->_campaignClause = $surveyClause;
 168     $this->_campaignFromClause = CRM_Utils_Array::value('fromClause', $surveyClause);
 169     $this->_campaignWhereClause = CRM_Utils_Array::value('whereClause', $surveyClause);
 170
 171     // type of selector
 172     $this->_action = $action;
 173
 174     $this->_query = new CRM_Contact_BAO_Query($this->_queryParams,
 175       NULL, NULL, FALSE, FALSE,
 176       CRM_Contact_BAO_Query::MODE_CAMPAIGN,
 177       TRUE
 178     );
 179   }
 180
 181   /**
 182    * This method returns the links that are given for each search row.
 183    * currently the links added for each row are
 184    *
 185    * - View
 186    * - Edit
 187    *
 188    * @return array
 189    * @access public
 190    *
 191    */
 192   static
 193   function &links() {
 194     return self::$_links = array();
 195   }
 196
 197   /**
 198    * Getter for array of the parameters required for creating pager.
 199    *
 200    * @param $action
 201    * @param array $params
 202    *
 203    * @access public
 204    */
 205   function getPagerParams($action, &$params) {
 206     $params['csvString'] = NULL;
 207     $params['status'] = ts('Respondents') . ' %%StatusMessage%%';
 208     $params['rowCount'] = ($this->_limit) ? $this->_limit : CRM_Utils_Pager::ROWCOUNT;
 209     $params['buttonTop'] = 'PagerTopButton';
 210     $params['buttonBottom'] = 'PagerBottomButton';
 211   }
 212
 213   /**
 214    * Returns total number of rows for the query.
 215    *
 216    * @param
 217    *
 218    * @return int Total number of rows
 219    * @access public
 220    */
 221   function getTotalCount($action) {
 222     return $this->_query->searchQuery(0, 0, NULL,
 223       TRUE, FALSE,
 224       FALSE, FALSE, FALSE,
 225       $this->_campaignWhereClause,
 226       NULL,
 227       $this->_campaignFromClause
 228     );
 229   }
 230
 231   /**
 232    * Returns all the rows in the given offset and rowCount
 233    *
 234    * @param enum   $action   the action being performed
 235    * @param int    $offset   the row number to start from
 236    * @param int    $rowCount the number of rows to return
 237    * @param string $sort     the sql string that describes the sort order
 238    * @param enum   $output   what should the result set include (web/email/csv)
 239    *
 240    * @return int   the total number of rows for this action
 241    */
 242   function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
 243     $result = $this->_query->searchQuery($offset, $rowCount, $sort,
 244       FALSE, FALSE,
 245       FALSE, FALSE,
 246       FALSE, $this->_campaignWhereClause,
 247       NULL,
 248       $this->_campaignFromClause
 249     );
 250
 251
 252     // process the result of the query
 253     $rows = array();
 254
 255     While ($result->fetch()) {
 256       $this->_query->convertToPseudoNames($result);
 257       $row = array();
 258       // the columns we are interested in
 259       foreach (self::$_properties as $property) {
 260         if (property_exists($result, $property)) {
 261           $row[$property] = $result->$property;
 262         }
 263       }
 264       $row['checkbox'] = CRM_Core_Form::CB_PREFIX . $result->contact_id;
 265       $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($result->contact_type, FALSE, $result->contact_id);
 266
 267       $rows[] = $row;
 268     }
 269     $this->buildPrevNextCache($sort);
 270
 271     return $rows;
 272   }
 273
 274   /**
 275    * @param $sort
 276    */
 277   function buildPrevNextCache($sort) {
 278     //for prev/next pagination
 279     $crmPID = CRM_Utils_Request::retrieve('crmPID', 'Integer', CRM_Core_DAO::$_nullObject);
 280
 281     if (!$crmPID) {
 282       $cacheKey = "civicrm search {$this->_key}";
 283       CRM_Core_BAO_PrevNextCache::deleteItem(NULL, $cacheKey, 'civicrm_contact');
 284
 285       $sql = $this->_query->searchQuery(0, 0, $sort,
 286         FALSE, FALSE,
 287         FALSE, FALSE,
 288         TRUE, $this->_campaignWhereClause,
 289         NULL,
 290         $this->_campaignFromClause
 291       );
 292       list($select, $from) = explode(' FROM ', $sql);
 293       $insertSQL = "
 294 INSERT INTO civicrm_prevnext_cache ( entity_table, entity_id1, entity_id2, cacheKey, data )
 295 SELECT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', contact_a.display_name
 296 FROM {$from}
 297 ";
 298       $errorScope = CRM_Core_TemporaryErrorScope::ignoreException();
 299       $result = CRM_Core_DAO::executeQuery($insertSQL);
 300       unset($errorScope);
 301
 302       if (is_a($result, 'DB_Error')) {
 303         return;
 304       }
 305       // also record an entry in the cache key table, so we can delete it periodically
 306       CRM_Core_BAO_Cache::setItem($cacheKey, 'CiviCRM Search PrevNextCache', $cacheKey);
 307     }
 308   }
 309
 310   /**
 311    * @return array   $qill which contains an array of strings
 312    * @access public
 313    **/
 314   public function getQILL() {
 315     return $this->_query->qill();
 316   }
 317
 318   /**
 319    * Returns the column headers as an array of tuples:
 320    * (name, sortName (key to the sort array))
 321    *
 322    * @param string $action the action being performed
 323    * @param enum   $output what should the result set include (web/email/csv)
 324    *
 325    * @return array the column headers that need to be displayed
 326    * @access public
 327    */
 328   public function &getColumnHeaders($action = NULL, $output = NULL) {
 329     self::$_columnHeaders = array();
 330
 331     if (!$this->_single) {
 332       $contactDetails = array(
 333         array('name' => ts('Contact Name'),
 334           'sort' => 'sort_name',
 335           'direction' => CRM_Utils_Sort::ASCENDING,
 336         ),
 337         array('name' => ts('Street Number'),
 338           'sort' => 'street_number',
 339         ),
 340         array('name' => ts('Street Name'),
 341           'sort' => 'street_name',
 342         ),
 343         array('name' => ts('Street Address')),
 344         array('name' => ts('City'),
 345           'sort' => 'city',
 346         ),
 347         array('name' => ts('Postal Code'),
 348           'sort' => 'postal_code',
 349         ),
 350         array('name' => ts('State'),
 351           'sort' => 'state_province_name',
 352         ),
 353         array('name' => ts('Country')),
 354         array('name' => ts('Email')),
 355         array('name' => ts('Phone')),
 356       );
 357       self::$_columnHeaders = array_merge($contactDetails, self::$_columnHeaders);
 358     }
 359
 360     return self::$_columnHeaders;
 361   }
 362
 363   /**
 364    * @return string
 365    */
 366   function &getQuery() {
 367     return $this->_query;
 368   }
 369
 370   /**
 371    * Name of export file.
 372    *
 373    * @param string $output type of output
 374    *
 375    * @return string name of the file
 376    */
 377   function getExportFileName($output = 'csv') {
 378     return ts('CiviCRM Respondent Search');
 379   }
 380 }
 381