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 \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
148 * @param string $context
150 * @return \CRM_Campaign_Selector_Search
153 function __construct(&$queryParams,
154 $action = CRM_Core_Action
::NONE
,
155 $surveyClause = NULL,
160 // submitted form values
161 $this->_queryParams
= &$queryParams;
163 $this->_single
= $single;
164 $this->_limit
= $limit;
165 $this->_context
= $context;
167 $this->_campaignClause
= $surveyClause;
168 $this->_campaignFromClause
= CRM_Utils_Array
::value('fromClause', $surveyClause);
169 $this->_campaignWhereClause
= CRM_Utils_Array
::value('whereClause', $surveyClause);
172 $this->_action
= $action;
174 $this->_query
= new CRM_Contact_BAO_Query($this->_queryParams
,
175 NULL, NULL, FALSE, FALSE,
176 CRM_Contact_BAO_Query
::MODE_CAMPAIGN
,
183 * This method returns the links that are given for each search row.
184 * currently the links added for each row are
195 return self
::$_links = array();
199 * getter for array of the parameters required for creating pager.
207 function getPagerParams($action, &$params) {
208 $params['csvString'] = NULL;
209 $params['status'] = ts('Respondents') . ' %%StatusMessage%%';
210 $params['rowCount'] = ($this->_limit
) ?
$this->_limit
: CRM_Utils_Pager
::ROWCOUNT
;
211 $params['buttonTop'] = 'PagerTopButton';
212 $params['buttonBottom'] = 'PagerBottomButton';
216 * Returns total number of rows for the query.
220 * @return int Total number of rows
223 function getTotalCount($action) {
224 return $this->_query
->searchQuery(0, 0, NULL,
227 $this->_campaignWhereClause
,
229 $this->_campaignFromClause
234 * returns all the rows in the given offset and rowCount
236 * @param enum $action the action being performed
237 * @param int $offset the row number to start from
238 * @param int $rowCount the number of rows to return
239 * @param string $sort the sql string that describes the sort order
240 * @param enum $output what should the result set include (web/email/csv)
242 * @return int the total number of rows for this action
244 function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
245 $result = $this->_query
->searchQuery($offset, $rowCount, $sort,
248 FALSE, $this->_campaignWhereClause
,
250 $this->_campaignFromClause
254 // process the result of the query
257 While ($result->fetch()) {
258 $this->_query
->convertToPseudoNames($result);
260 // the columns we are interested in
261 foreach (self
::$_properties as $property) {
262 if (property_exists($result, $property)) {
263 $row[$property] = $result->$property;
266 $row['checkbox'] = CRM_Core_Form
::CB_PREFIX
. $result->contact_id
;
267 $row['contact_type'] = CRM_Contact_BAO_Contact_Utils
::getImage($result->contact_type
, FALSE, $result->contact_id
);
271 $this->buildPrevNextCache($sort);
279 function buildPrevNextCache($sort) {
280 //for prev/next pagination
281 $crmPID = CRM_Utils_Request
::retrieve('crmPID', 'Integer', CRM_Core_DAO
::$_nullObject);
284 $cacheKey = "civicrm search {$this->_key}";
285 CRM_Core_BAO_PrevNextCache
::deleteItem(NULL, $cacheKey, 'civicrm_contact');
287 $sql = $this->_query
->searchQuery(0, 0, $sort,
290 TRUE, $this->_campaignWhereClause
,
292 $this->_campaignFromClause
294 list($select, $from) = explode(' FROM ', $sql);
296 INSERT INTO civicrm_prevnext_cache ( entity_table, entity_id1, entity_id2, cacheKey, data )
297 SELECT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', contact_a.display_name
300 $errorScope = CRM_Core_TemporaryErrorScope
::ignoreException();
301 $result = CRM_Core_DAO
::executeQuery($insertSQL);
304 if (is_a($result, 'DB_Error')) {
307 // also record an entry in the cache key table, so we can delete it periodically
308 CRM_Core_BAO_Cache
::setItem($cacheKey, 'CiviCRM Search PrevNextCache', $cacheKey);
314 * @return array $qill which contains an array of strings
317 public function getQILL() {
318 return $this->_query
->qill();
322 * returns the column headers as an array of tuples:
323 * (name, sortName (key to the sort array))
325 * @param string $action the action being performed
326 * @param enum $output what should the result set include (web/email/csv)
328 * @return array the column headers that need to be displayed
331 public function &getColumnHeaders($action = NULL, $output = NULL) {
332 self
::$_columnHeaders = array();
334 if (!$this->_single
) {
335 $contactDetails = array(
336 array('name' => ts('Contact Name'),
337 'sort' => 'sort_name',
338 'direction' => CRM_Utils_Sort
::ASCENDING
,
340 array('name' => ts('Street Number'),
341 'sort' => 'street_number',
343 array('name' => ts('Street Name'),
344 'sort' => 'street_name',
346 array('name' => ts('Street Address')),
347 array('name' => ts('City'),
350 array('name' => ts('Postal Code'),
351 'sort' => 'postal_code',
353 array('name' => ts('State'),
354 'sort' => 'state_province_name',
356 array('name' => ts('Country')),
357 array('name' => ts('Email')),
358 array('name' => ts('Phone')),
360 self
::$_columnHeaders = array_merge($contactDetails, self
::$_columnHeaders);
363 return self
::$_columnHeaders;
369 function &getQuery() {
370 return $this->_query
;
374 * name of export file.
376 * @param string $output type of output
378 * @return string name of the file
380 function getExportFileName($output = 'csv') {
381 return ts('CiviCRM Respondent Search');