3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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. |
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 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 +--------------------------------------------------------------------+
30 * @copyright CiviCRM LLC (c) 2004-2013
36 * This class is used to retrieve and display a range of
37 * contacts that match the given criteria (specifically for
38 * results of advanced search options.
41 class CRM_Activity_Selector_Search
extends CRM_Core_Selector_Base
implements CRM_Core_Selector_API
{
44 * This defines two actions- View and Edit.
49 static $_links = NULL;
52 * we use desc to remind us what that column is, name is used in the tpl
57 static $_columnHeaders;
60 * Properties of contact we're interested in displaying
65 static $_properties = array(
80 'activity_campaign_id',
81 'activity_engagement_level',
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 * what component context are we being invoked from
114 protected $_compContext = NULL;
117 * queryParams is the array returned by exportValues called on
118 * the HTML_QuickForm_Controller for that page.
123 public $_queryParams;
126 * represent the type of selector
134 * The additional clause that we restrict the search with
138 protected $_activityClause = NULL;
150 * @param array $queryParams array of parameters for query
151 * @param int $action - action of search basic or advanced.
152 * @param string $activityClause if the caller wants to further restrict the search (used in activities)
153 * @param boolean $single are we dealing only with one contact?
154 * @param int $limit how many activities do we want returned
156 * @return CRM_Contact_Selector
159 function __construct(&$queryParams,
160 $action = CRM_Core_Action
::NONE
,
161 $activityClause = NULL,
167 // submitted form values
168 $this->_queryParams
= &$queryParams;
170 $this->_single
= $single;
171 $this->_limit
= $limit;
172 $this->_context
= $context;
173 $this->_compContext
= $compContext;
175 $this->_activityClause
= $activityClause;
178 $this->_action
= $action;
179 $this->_query
= new CRM_Contact_BAO_Query($this->_queryParams
,
180 CRM_Activity_BAO_Query
::defaultReturnProperties(CRM_Contact_BAO_Query
::MODE_ACTIVITY
,
184 CRM_Contact_BAO_Query
::MODE_ACTIVITY
186 $this->_query
->_distinctComponentClause
= '( civicrm_activity.id )';
187 $this->_query
->_groupByComponentClause
= " GROUP BY civicrm_activity.id ";
188 //CRM_Core_Error::debug( $this->_query ); exit();
193 * getter for array of the parameters required for creating pager.
198 function getPagerParams($action, &$params) {
199 $params['status'] = ts('Activities %%StatusMessage%%');
200 $params['csvString'] = NULL;
201 $params['rowCount'] = CRM_Utils_Pager
::ROWCOUNT
;
202 $params['buttonTop'] = 'PagerTopButton';
203 $params['buttonBottom'] = 'PagerBottomButton';
208 * Returns total number of rows for the query.
212 * @return int Total number of rows
215 function getTotalCount($action) {
216 return $this->_query
->searchQuery(0, 0, NULL,
220 $this->_activityClause
225 * returns all the rows in the given offset and rowCount
227 * @param enum $action the action being performed
228 * @param int $offset the row number to start from
229 * @param int $rowCount the number of rows to return
230 * @param string $sort the sql string that describes the sort order
231 * @param enum $output what should the result set include (web/email/csv)
233 * @return array rows in the given offset and rowCount
235 function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
237 $result = $this->_query
->searchQuery(
238 $offset, $rowCount, $sort,
242 $this->_activityClause
245 $mailingIDs = CRM_Mailing_BAO_Mailing
::mailingACLIDs();
246 $accessCiviMail = CRM_Core_Permission
::check('access CiviMail');
249 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
251 $engagementLevels = CRM_Campaign_PseudoConstant
::engagementLevel();
252 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
253 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
254 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
255 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
257 while ($result->fetch()) {
260 // ignore rows where we dont have an activity id
261 if (empty($result->activity_id
)) {
265 // the columns we are interested in
266 foreach (self
::$_properties as $property) {
267 if (isset($result->$property)) {
268 $row[$property] = $result->$property;
272 $contactId = CRM_Utils_Array
::value('contact_id', $row);
274 $contactId = CRM_Utils_Array
::value('source_contact_id', $row);
277 $row['target_contact_name'] = CRM_Activity_BAO_ActivityContact
::getNames($row['activity_id'], $targetID);
278 $row['assignee_contact_name'] = CRM_Activity_BAO_ActivityContact
::getNames($row['activity_id'], $assigneeID);
279 list($row['source_contact_name'], $row['source_contact_id']) = CRM_Activity_BAO_ActivityContact
::getNames($row['activity_id'], $sourceID, TRUE);
280 $row['source_contact_name'] = implode(',', array_values($row['source_contact_name']));
281 $row['source_contact_id'] = implode(',', $row['source_contact_id']);
283 if ($this->_context
== 'search') {
284 $row['checkbox'] = CRM_Core_Form
::CB_PREFIX
. $result->activity_id
;
286 $row['contact_type'] = CRM_Contact_BAO_Contact_Utils
::getImage($result->contact_sub_type ?
287 $result->contact_sub_type
: $result->contact_type
, FALSE, $result->contact_id
289 $accessMailingReport = FALSE;
290 $activityType = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE, FALSE, 'name', TRUE);
291 $activityTypeId = CRM_Utils_Array
::key($row['activity_type'], $activityType);
292 if ($row['activity_is_test']) {
293 $row['activity_type'] = $row['activity_type'] . " (test)";
295 $bulkActivityTypeID = CRM_Utils_Array
::key('Bulk Email', $activityType);
296 $row['mailingId'] = '';
299 ($mailingIDs === TRUE ||
in_array($result->source_record_id
, $mailingIDs)) &&
300 ($bulkActivityTypeID == $activityTypeId)
302 $row['mailingId'] = CRM_Utils_System
::url('civicrm/mailing/report',
303 "mid={$result->source_record_id}&reset=1&cid={$contactId}&context=activitySelector"
305 $row['recipients'] = ts('(recipients)');
306 $row['target_contact_name'] = '';
307 $row['assignee_contact_name'] = '';
308 $accessMailingReport = TRUE;
310 $activityActions = new CRM_Activity_Selector_Activity($result->contact_id
, NULL);
311 $actionLinks = $activityActions->actionLinks($activityTypeId,
312 CRM_Utils_Array
::value('source_record_id', $row),
313 $accessMailingReport,
314 CRM_Utils_Array
::value('activity_id', $row),
318 $row['action'] = CRM_Core_Action
::formLink($actionLinks, NULL,
320 'id' => $result->activity_id
,
322 'cxt' => $this->_context
,
326 //carry campaign to selector.
327 $row['campaign'] = CRM_Utils_Array
::value($result->activity_campaign_id
, $allCampaigns);
328 $row['campaign_id'] = $result->activity_campaign_id
;
330 if ($engagementLevel = CRM_Utils_Array
::value('activity_engagement_level', $row)) {
331 $row['activity_engagement_level'] = CRM_Utils_Array
::value($engagementLevel,
332 $engagementLevels, $engagementLevel
344 * @return array $qill which contains an array of strings
347 public function getQILL() {
348 return $this->_query
->qill();
352 * returns the column headers as an array of tuples:
353 * (name, sortName (key to the sort array))
355 * @param string $action the action being performed
356 * @param enum $output what should the result set include (web/email/csv)
358 * @return array the column headers that need to be displayed
361 public function &getColumnHeaders($action = NULL, $output = NULL) {
362 if (!isset(self
::$_columnHeaders)) {
363 self
::$_columnHeaders = array(
365 'name' => ts('Type'),
366 'sort' => 'activity_type_id',
367 'direction' => CRM_Utils_Sort
::DONTCARE
,
370 'name' => ts('Subject'),
372 'direction' => CRM_Utils_Sort
::DONTCARE
,
375 'name' => ts('Added By'),
376 'sort' => 'sort_name',
377 'direction' => CRM_Utils_Sort
::DONTCARE
,
379 array('name' => ts('With')),
380 array('name' => ts('Assigned')),
382 'name' => ts('Date'),
383 'sort' => 'activity_date_time',
384 'direction' => CRM_Utils_Sort
::DESCENDING
,
387 'name' => ts('Status'),
388 'sort' => 'status_id',
389 'direction' => CRM_Utils_Sort
::DONTCARE
,
392 'desc' => ts('Actions'),
396 return self
::$_columnHeaders;
399 function alphabetQuery() {
400 return $this->_query
->searchQuery(NULL, NULL, NULL, FALSE, FALSE, TRUE);
403 function &getQuery() {
404 return $this->_query
;
408 * name of export file.
410 * @param string $output type of output
412 * @return string name of the file
414 function getExportFileName($output = 'csv') {
415 return ts('CiviCRM Activity Search');