CRM/Activity/Selector/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   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.                                       |
  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 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  +--------------------------------------------------------------------+
  25 */
  26
  27 /**
  28  *
  29  * @package CRM
  30  * @copyright CiviCRM LLC (c) 2004-2014
  31  * $Id$
  32  *
  33  */
  34
  35 /**
  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.
  39  *
  40  */
  41 class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM_Core_Selector_API {
  42
  43   /**
  44    * This defines two actions- View and Edit.
  45    *
  46    * @var array
  47    * @static
  48    */
  49   static $_links = NULL;
  50
  51   /**
  52    * we use desc to remind us what that column is, name is used in the tpl
  53    *
  54    * @var array
  55    * @static
  56    */
  57   static $_columnHeaders;
  58
  59   /**
  60    * Properties of contact we're interested in displaying
  61    * @var array
  62    * @static
  63    */
  64
  65   static $_properties = array(
  66     'contact_id',
  67     'contact_type',
  68     'contact_sub_type',
  69     'sort_name',
  70     'display_name',
  71     'activity_id',
  72     'activity_date_time',
  73     'activity_status_id',
  74     'activity_status',
  75     'activity_subject',
  76     'source_record_id',
  77     'activity_type_id',
  78     'activity_type',
  79     'activity_is_test',
  80     'activity_campaign_id',
  81     'activity_engagement_level',
  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    * what component context are we being invoked from
 110    *
 111    * @access protected
 112    * @var string
 113    */
 114   protected $_compContext = NULL;
 115
 116   /**
 117    * queryParams is the array returned by exportValues called on
 118    * the HTML_QuickForm_Controller for that page.
 119    *
 120    * @var array
 121    * @access protected
 122    */
 123   public $_queryParams;
 124
 125   /**
 126    * represent the type of selector
 127    *
 128    * @var int
 129    * @access protected
 130    */
 131   protected $_action;
 132
 133   /**
 134    * The additional clause that we restrict the search with
 135    *
 136    * @var string
 137    */
 138   protected $_activityClause = NULL;
 139
 140   /**
 141    * The query object
 142    *
 143    * @var string
 144    */
 145   protected $_query;
 146
 147   /**
 148    * Class constructor
 149    *
 150    * @param array $queryParams array of parameters for query
 151    * @param \const|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
 155    *
 156    * @param string $context
 157    * @param null $compContext
 158    *
 159    * @return \CRM_Activity_Selector_Search
 160   @access public
 161    */
 162   function __construct(&$queryParams,
 163     $action         = CRM_Core_Action::NONE,
 164     $activityClause = NULL,
 165     $single         = FALSE,
 166     $limit          = NULL,
 167     $context        = 'search',
 168     $compContext    = NULL
 169   ) {
 170     // submitted form values
 171     $this->_queryParams = &$queryParams;
 172
 173     $this->_single      = $single;
 174     $this->_limit       = $limit;
 175     $this->_context     = $context;
 176     $this->_compContext = $compContext;
 177
 178     $this->_activityClause = $activityClause;
 179
 180     // type of selector
 181     $this->_action = $action;
 182     $this->_query = new CRM_Contact_BAO_Query($this->_queryParams,
 183       CRM_Activity_BAO_Query::defaultReturnProperties(CRM_Contact_BAO_Query::MODE_ACTIVITY,
 184         FALSE
 185       ),
 186       NULL, FALSE, FALSE,
 187       CRM_Contact_BAO_Query::MODE_ACTIVITY
 188     );
 189     $this->_query->_distinctComponentClause = '( civicrm_activity.id )';
 190     $this->_query->_groupByComponentClause = " GROUP BY civicrm_activity.id ";
 191     //CRM_Core_Error::debug( $this->_query ); exit();
 192   }
 193   //end of constructor
 194
 195   /**
 196    * getter for array of the parameters required for creating pager.
 197    *
 198    * @param $action
 199    * @param $params
 200    *
 201    * @internal param $
 202    * @access public
 203    */
 204   function getPagerParams($action, &$params) {
 205     $params['status'] = ts('Activities %%StatusMessage%%');
 206     $params['csvString'] = NULL;
 207     $params['rowCount'] = CRM_Utils_Pager::ROWCOUNT;
 208     $params['buttonTop'] = 'PagerTopButton';
 209     $params['buttonBottom'] = 'PagerBottomButton';
 210   }
 211   //end of function
 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,
 225       FALSE,
 226       $this->_activityClause
 227     );
 228   }
 229
 230   /**
 231    * returns all the rows in the given offset and rowCount
 232    *
 233    * @param enum   $action   the action being performed
 234    * @param int    $offset   the row number to start from
 235    * @param int    $rowCount the number of rows to return
 236    * @param string $sort     the sql string that describes the sort order
 237    * @param enum   $output   what should the result set include (web/email/csv)
 238    *
 239    * @return array  rows in the given offset and rowCount
 240    */
 241   function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
 242     $result = $this->_query->searchQuery(
 243       $offset, $rowCount, $sort,
 244       FALSE, FALSE,
 245       FALSE, FALSE,
 246       FALSE,
 247       $this->_activityClause
 248     );
 249     $rows           = array();
 250     $mailingIDs     = CRM_Mailing_BAO_Mailing::mailingACLIDs();
 251     $accessCiviMail = CRM_Core_Permission::check('access CiviMail');
 252
 253     //get all campaigns.
 254     $allCampaigns = CRM_Campaign_BAO_Campaign::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
 255
 256     $engagementLevels = CRM_Campaign_PseudoConstant::engagementLevel();
 257     $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
 258     $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
 259     $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
 260     $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
 261     //get all activity types
 262     $activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'name', TRUE);
 263
 264     while ($result->fetch()) {
 265       $row = array();
 266
 267       // ignore rows where we dont have an activity id
 268       if (empty($result->activity_id)) {
 269         continue;
 270       }
 271
 272       // the columns we are interested in
 273       foreach (self::$_properties as $property) {
 274         if (isset($result->$property)) {
 275           $row[$property] = $result->$property;
 276         }
 277       }
 278
 279       $contactId = CRM_Utils_Array::value('contact_id', $row);
 280       if (!$contactId) {
 281         $contactId = CRM_Utils_Array::value('source_contact_id', $row);
 282       }
 283
 284       $row['target_contact_name']   = CRM_Activity_BAO_ActivityContact::getNames($row['activity_id'], $targetID);
 285       $row['assignee_contact_name'] = CRM_Activity_BAO_ActivityContact::getNames($row['activity_id'], $assigneeID);
 286       list($row['source_contact_name'], $row['source_contact_id']) = CRM_Activity_BAO_ActivityContact::getNames($row['activity_id'], $sourceID, TRUE);
 287       $row['source_contact_name'] = implode(',', array_values($row['source_contact_name']));
 288       $row['source_contact_id'] = implode(',', $row['source_contact_id']);
 289
 290       if ($this->_context == 'search') {
 291         $row['checkbox'] = CRM_Core_Form::CB_PREFIX . $result->activity_id;
 292       }
 293       $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($result->contact_sub_type ?
 294         $result->contact_sub_type : $result->contact_type, FALSE, $result->contact_id
 295       );
 296       $accessMailingReport = FALSE;
 297       $activityTypeId      = $row['activity_type_id'];
 298       if ($row['activity_is_test']) {
 299         $row['activity_type'] = $row['activity_type'] . " (test)";
 300       }
 301       $bulkActivityTypeID = CRM_Utils_Array::key('Bulk Email', $activityTypes);
 302       $row['mailingId'] = '';
 303       if (
 304         $accessCiviMail &&
 305         ($mailingIDs === TRUE || in_array($result->source_record_id, $mailingIDs)) &&
 306         ($bulkActivityTypeID == $activityTypeId)
 307       ) {
 308         $row['mailingId'] = CRM_Utils_System::url('civicrm/mailing/report',
 309           "mid={$result->source_record_id}&reset=1&cid={$contactId}&context=activitySelector"
 310         );
 311         $row['recipients'] = ts('(recipients)');
 312         $row['target_contact_name'] = '';
 313         $row['assignee_contact_name'] = '';
 314         $accessMailingReport = TRUE;
 315       }
 316       $activityActions = new CRM_Activity_Selector_Activity($result->contact_id, NULL);
 317       $actionLinks = $activityActions->actionLinks($activityTypeId,
 318         CRM_Utils_Array::value('source_record_id', $row),
 319         $accessMailingReport,
 320         CRM_Utils_Array::value('activity_id', $row),
 321         $this->_key,
 322         $this->_compContext
 323       );
 324       $row['action'] = CRM_Core_Action::formLink($actionLinks, NULL,
 325         array(
 326           'id' => $result->activity_id,
 327           'cid' => $contactId,
 328           'cxt' => $this->_context,
 329         ),
 330         ts('more'),
 331         FALSE,
 332         'activity.selector.row',
 333         'Activity',
 334         $result->activity_id
 335       );
 336
 337       //carry campaign to selector.
 338       $row['campaign'] = CRM_Utils_Array::value($result->activity_campaign_id, $allCampaigns);
 339       $row['campaign_id'] = $result->activity_campaign_id;
 340
 341       if ($engagementLevel = CRM_Utils_Array::value('activity_engagement_level', $row)) {
 342         $row['activity_engagement_level'] = CRM_Utils_Array::value($engagementLevel,
 343           $engagementLevels, $engagementLevel
 344         );
 345       }
 346
 347       $rows[] = $row;
 348     }
 349
 350     return $rows;
 351   }
 352
 353   /**
 354    *
 355    * @return array  $qill  which contains an array of strings
 356    * @access public
 357    */
 358   public function getQILL() {
 359     return $this->_query->qill();
 360   }
 361
 362   /**
 363    * returns the column headers as an array of tuples:
 364    * (name, sortName (key to the sort array))
 365    *
 366    * @param string $action the action being performed
 367    * @param enum   $output what should the result set include (web/email/csv)
 368    *
 369    * @return array the column headers that need to be displayed
 370    * @access public
 371    */
 372   public function &getColumnHeaders($action = NULL, $output = NULL) {
 373     if (!isset(self::$_columnHeaders)) {
 374       self::$_columnHeaders = array(
 375         array(
 376           'name' => ts('Type'),
 377           'sort' => 'activity_type_id',
 378           'direction' => CRM_Utils_Sort::DONTCARE,
 379         ),
 380         array(
 381           'name' => ts('Subject'),
 382           'sort' => 'subject',
 383           'direction' => CRM_Utils_Sort::DONTCARE,
 384         ),
 385         array(
 386           'name' => ts('Added By'),
 387           'sort' => 'source_contact',
 388           'direction' => CRM_Utils_Sort::DONTCARE,
 389         ),
 390         array('name' => ts('With')),
 391         array('name' => ts('Assigned')),
 392         array(
 393           'name' => ts('Date'),
 394           'sort' => 'activity_date_time',
 395           'direction' => CRM_Utils_Sort::DESCENDING,
 396         ),
 397         array(
 398           'name' => ts('Status'),
 399           'sort' => 'status_id',
 400           'direction' => CRM_Utils_Sort::DONTCARE,
 401         ),
 402         array(
 403           'desc' => ts('Actions'),
 404         ),
 405       );
 406     }
 407     return self::$_columnHeaders;
 408   }
 409
 410   function alphabetQuery() {
 411     return $this->_query->searchQuery(NULL, NULL, NULL, FALSE, FALSE, TRUE);
 412   }
 413
 414   function &getQuery() {
 415     return $this->_query;
 416   }
 417
 418   /**
 419    * name of export file.
 420    *
 421    * @param string $output type of output
 422    *
 423    * @return string name of the file
 424    */
 425   function getExportFileName($output = 'csv') {
 426     return ts('CiviCRM Activity Search');
 427   }
 428 }
 429 //end of class
 430