3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
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.
42 class CRM_Campaign_Selector_Search
extends CRM_Core_Selector_Base
implements CRM_Core_Selector_API
{
45 * This defines two actions- View and Edit.
50 static $_links = NULL;
53 * we use desc to remind us what that column is, name is used in the tpl
58 static $_columnHeaders;
61 * Properties of contact we're interested in displaying
65 static $_properties = array(
80 'survey_activity_target_id',
81 'survey_activity_target_contact_id',
85 * are we restricting ourselves to a single contact
90 protected $_single = FALSE;
93 * are we restricting ourselves to a single contact
98 protected $_limit = NULL;
101 * what context are we being invoked from
106 protected $_context = NULL;
109 * queryParams is the array returned by exportValues called on
110 * the HTML_QuickForm_Controller for that page.
115 public $_queryParams;
118 * represent the type of selector
126 * The additional clause that we restrict the search with
130 protected $_surveyClause = NULL;
142 * @param array $queryParams array of parameters for query
143 * @param 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
148 * @return CRM_Contact_Selector
150 */ function __construct(&$queryParams,
151 $action = CRM_Core_Action
::NONE
,
152 $surveyClause = NULL,
157 // submitted form values
158 $this->_queryParams
= &$queryParams;
160 $this->_single
= $single;
161 $this->_limit
= $limit;
162 $this->_context
= $context;
164 $this->_campaignClause
= $surveyClause;
165 $this->_campaignFromClause
= CRM_Utils_Array
::value('fromClause', $surveyClause);
166 $this->_campaignWhereClause
= CRM_Utils_Array
::value('whereClause', $surveyClause);
169 $this->_action
= $action;
171 $this->_query
= new CRM_Contact_BAO_Query($this->_queryParams
,
172 NULL, NULL, FALSE, FALSE,
173 CRM_Contact_BAO_Query
::MODE_CAMPAIGN
,
180 * This method returns the links that are given for each search row.
181 * currently the links added for each row are
192 return self
::$_links = array();
196 * getter for array of the parameters required for creating pager.
201 function getPagerParams($action, &$params) {
202 $params['csvString'] = NULL;
203 $params['status'] = ts('Respondents') . ' %%StatusMessage%%';
204 $params['rowCount'] = ($this->_limit
) ?
$this->_limit
: CRM_Utils_Pager
::ROWCOUNT
;
205 $params['buttonTop'] = 'PagerTopButton';
206 $params['buttonBottom'] = 'PagerBottomButton';
210 * Returns total number of rows for the query.
214 * @return int Total number of rows
217 function getTotalCount($action) {
218 return $this->_query
->searchQuery(0, 0, NULL,
221 $this->_campaignWhereClause
,
223 $this->_campaignFromClause
228 * returns all the rows in the given offset and rowCount
230 * @param enum $action the action being performed
231 * @param int $offset the row number to start from
232 * @param int $rowCount the number of rows to return
233 * @param string $sort the sql string that describes the sort order
234 * @param enum $output what should the result set include (web/email/csv)
236 * @return int the total number of rows for this action
238 function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
239 $result = $this->_query
->searchQuery($offset, $rowCount, $sort,
242 FALSE, $this->_campaignWhereClause
,
244 $this->_campaignFromClause
248 // process the result of the query
251 While ($result->fetch()) {
252 $this->_query
->convertToPseudoNames($result);
254 // the columns we are interested in
255 foreach (self
::$_properties as $property) {
256 if (property_exists($result, $property)) {
257 $row[$property] = $result->$property;
260 $row['checkbox'] = CRM_Core_Form
::CB_PREFIX
. $result->contact_id
;
261 $row['contact_type'] = CRM_Contact_BAO_Contact_Utils
::getImage($result->contact_type
, FALSE, $result->contact_id
);
265 $this->buildPrevNextCache($sort);
270 function buildPrevNextCache($sort) {
271 //for prev/next pagination
272 $crmPID = CRM_Utils_Request
::retrieve('crmPID', 'Integer', CRM_Core_DAO
::$_nullObject);
275 $cacheKey = "civicrm search {$this->_key}";
276 CRM_Core_BAO_PrevNextCache
::deleteItem(NULL, $cacheKey, 'civicrm_contact');
278 $sql = $this->_query
->searchQuery(0, 0, $sort,
281 TRUE, $this->_campaignWhereClause
,
283 $this->_campaignFromClause
285 list($select, $from) = explode(' FROM ', $sql);
287 INSERT INTO civicrm_prevnext_cache ( entity_table, entity_id1, entity_id2, cacheKey, data )
288 SELECT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', contact_a.display_name
291 $errorScope = CRM_Core_TemporaryErrorScope
::ignoreException();
292 $result = CRM_Core_DAO
::executeQuery($insertSQL);
295 if (is_a($result, 'DB_Error')) {
298 // also record an entry in the cache key table, so we can delete it periodically
299 CRM_Core_BAO_Cache
::setItem($cacheKey, 'CiviCRM Search PrevNextCache', $cacheKey);
305 * @return array $qill which contains an array of strings
308 public function getQILL() {
309 return $this->_query
->qill();
313 * returns the column headers as an array of tuples:
314 * (name, sortName (key to the sort array))
316 * @param string $action the action being performed
317 * @param enum $output what should the result set include (web/email/csv)
319 * @return array the column headers that need to be displayed
322 public function &getColumnHeaders($action = NULL, $output = NULL) {
323 self
::$_columnHeaders = array();
325 if (!$this->_single
) {
326 $contactDetails = array(
327 array('name' => ts('Contact Name'),
328 'sort' => 'sort_name',
329 'direction' => CRM_Utils_Sort
::ASCENDING
,
331 array('name' => ts('Street Number'),
332 'sort' => 'street_number',
334 array('name' => ts('Street Name'),
335 'sort' => 'street_name',
337 array('name' => ts('Street Address')),
338 array('name' => ts('City'),
341 array('name' => ts('Postal Code'),
342 'sort' => 'postal_code',
344 array('name' => ts('State'),
345 'sort' => 'state_province_name',
347 array('name' => ts('Country')),
348 array('name' => ts('Email')),
349 array('name' => ts('Phone')),
351 self
::$_columnHeaders = array_merge($contactDetails, self
::$_columnHeaders);
354 return self
::$_columnHeaders;
357 function &getQuery() {
358 return $this->_query
;
362 * name of export file.
364 * @param string $output type of output
366 * @return string name of the file
368 function getExportFileName($output = 'csv') {
369 return ts('CiviCRM Respondent Search');