3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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_Mailing_Selector_Event
extends CRM_Core_Selector_Base
implements CRM_Core_Selector_API
{
45 * Array of supported links, currenly null
49 static $_links = NULL;
52 * What event type are we browsing?
57 * Should we only count distinct contacts?
59 private $_is_distinct;
62 * Which mailing are we browsing events from?
67 * Do we want events tied to a specific job?
72 * For click-through events, do we only want those from a specific url?
77 * We use desc to remind us what that column is, name is used in the tpl
81 public $_columnHeaders;
86 * @param string $event
87 * The event type (queue/delivered/open...).
88 * @param bool $distinct
89 * Count only distinct contact events?.
91 * ID of the mailing to query.
93 * ID of the job to query. If null, all jobs from $mailing are queried.
95 * If the event type is a click-through, do we want only those from a specific url?.
97 * @return \CRM_Mailing_Selector_Event
99 public function __construct($event, $distinct, $mailing, $job = NULL, $url = NULL) {
100 $this->_event_type
= $event;
101 $this->_is_distinct
= $distinct;
102 $this->_mailing_id
= $mailing;
103 $this->_job_id
= $job;
104 $this->_url_id
= $url;
108 * This method returns the links that are given for each search row.
112 public static function &links() {
113 return self
::$_links;
117 * Getter for array of the parameters required for creating pager.
120 * @param array $params
122 public function getPagerParams($action, &$params) {
123 $params['csvString'] = NULL;
124 $params['rowCount'] = CRM_Utils_Pager
::ROWCOUNT
;
125 $params['status'] = ts('%1 %%StatusMessage%%', array(1 => $this->eventToTitle()));
126 $params['buttonTop'] = 'PagerTopButton';
127 $params['buttonBottom'] = 'PagerBottomButton';
131 * Returns the column headers as an array of tuples:
132 * (name, sortName (key to the sort array))
134 * @param string $action
135 * The action being performed.
136 * @param string $output
137 * What should the result set include (web/email/csv).
140 * the column headers that need to be displayed
142 public function &getColumnHeaders($action = NULL, $output = NULL) {
143 $mailing = CRM_Mailing_BAO_Mailing
::getTableName();
145 $contact = CRM_Contact_BAO_Contact
::getTableName();
147 $email = CRM_Core_BAO_Email
::getTableName();
149 $job = CRM_Mailing_BAO_MailingJob
::getTableName();
150 if (!isset($this->_columnHeaders
)) {
152 $this->_columnHeaders
= array(
154 'name' => ts('Contact'),
155 'sort' => $contact . '.sort_name',
156 'direction' => CRM_Utils_Sort
::ASCENDING
,
159 'name' => ts('Email Address'),
160 'sort' => $email . '.email',
161 'direction' => CRM_Utils_Sort
::DONTCARE
,
165 switch ($this->_event_type
) {
167 $dateSort = $job . '.start_date';
171 $dateSort = CRM_Mailing_Event_BAO_Delivered
::getTableName() . '.time_stamp';
175 $dateSort = CRM_Mailing_Event_BAO_Opened
::getTableName() . '.time_stamp';
179 $dateSort = CRM_Mailing_Event_BAO_Bounce
::getTableName() . '.time_stamp';
180 $this->_columnHeaders
= array_merge($this->_columnHeaders
,
183 'name' => ts('Bounce Type'),
186 'name' => ts('Bounce Reason'),
193 $dateSort = CRM_Mailing_Event_BAO_Forward
::getTableName() . '.time_stamp';
195 $this->_columnHeaders
= array_merge($this->_columnHeaders
,
198 'name' => ts('Forwarded Email'),
205 $dateSort = CRM_Mailing_Event_BAO_Reply
::getTableName() . '.time_stamp';
209 $dateSort = CRM_Mailing_Event_BAO_Unsubscribe
::getTableName() . '.time_stamp';
210 $this->_columnHeaders
= array_merge($this->_columnHeaders
, array(
212 'name' => ts('Unsubscribe'),
218 $dateSort = CRM_Mailing_Event_BAO_Unsubscribe
::getTableName() . '.time_stamp';
219 $this->_columnHeaders
= array_merge($this->_columnHeaders
, array(
221 'name' => ts('Opt-Out'),
227 $dateSort = CRM_Mailing_Event_BAO_TrackableURLOpen
::getTableName() . '.time_stamp';
228 $this->_columnHeaders
= array_merge($this->_columnHeaders
, array(
239 $this->_columnHeaders
= array_merge($this->_columnHeaders
,
242 'name' => ts('Date'),
244 'direction' => CRM_Utils_Sort
::DESCENDING
,
249 return $this->_columnHeaders
;
253 * Returns total number of rows for the query.
258 * Total number of rows
260 public function getTotalCount($action) {
261 switch ($this->_event_type
) {
263 $event = new CRM_Mailing_Event_BAO_Queue();
264 $result = $event->getTotalCount($this->_mailing_id
,
270 $event = new CRM_Mailing_Event_BAO_Delivered();
271 $result = $event->getTotalCount($this->_mailing_id
,
278 $event = new CRM_Mailing_Event_BAO_Opened();
279 $result = $event->getTotalCount($this->_mailing_id
,
286 $event = new CRM_Mailing_Event_BAO_Bounce();
287 $result = $event->getTotalCount($this->_mailing_id
,
294 $event = new CRM_Mailing_Event_BAO_Forward();
295 $result = $event->getTotalCount($this->_mailing_id
,
302 $event = new CRM_Mailing_Event_BAO_Reply();
303 $result = $event->getTotalCount($this->_mailing_id
,
310 $event = new CRM_Mailing_Event_BAO_Unsubscribe();
311 $result = $event->getTotalCount($this->_mailing_id
,
318 $event = new CRM_Mailing_Event_BAO_Unsubscribe();
319 $result = $event->getTotalCount($this->_mailing_id
,
327 $event = new CRM_Mailing_Event_BAO_TrackableURLOpen();
328 $result = $event->getTotalCount($this->_mailing_id
,
341 * Returns all the rows in the given offset and rowCount
343 * @param string $action
344 * The action being performed.
346 * The row number to start from.
347 * @param int $rowCount
348 * The number of rows to return.
349 * @param string $sort
350 * The sql string that describes the sort order.
351 * @param string $output
352 * What should the result set include (web/email/csv).
355 * the total number of rows for this action
357 public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
358 switch ($this->_event_type
) {
360 $rows = CRM_Mailing_Event_BAO_Queue
::getRows($this->_mailing_id
,
361 $this->_job_id
, $offset, $rowCount, $sort
366 $rows = CRM_Mailing_Event_BAO_Delivered
::getRows($this->_mailing_id
,
367 $this->_job_id
, $this->_is_distinct
,
368 $offset, $rowCount, $sort
373 $rows = CRM_Mailing_Event_BAO_Opened
::getRows($this->_mailing_id
,
374 $this->_job_id
, $this->_is_distinct
,
375 $offset, $rowCount, $sort
380 $rows = CRM_Mailing_Event_BAO_Bounce
::getRows($this->_mailing_id
,
381 $this->_job_id
, $this->_is_distinct
,
382 $offset, $rowCount, $sort
387 $rows = CRM_Mailing_Event_BAO_Forward
::getRows($this->_mailing_id
,
388 $this->_job_id
, $this->_is_distinct
,
389 $offset, $rowCount, $sort
394 $rows = CRM_Mailing_Event_BAO_Reply
::getRows($this->_mailing_id
,
395 $this->_job_id
, $this->_is_distinct
,
396 $offset, $rowCount, $sort
401 $rows = CRM_Mailing_Event_BAO_Unsubscribe
::getRows($this->_mailing_id
,
402 $this->_job_id
, $this->_is_distinct
,
403 $offset, $rowCount, $sort, TRUE
408 $rows = CRM_Mailing_Event_BAO_Unsubscribe
::getRows($this->_mailing_id
,
409 $this->_job_id
, $this->_is_distinct
,
410 $offset, $rowCount, $sort, FALSE
415 $rows = CRM_Mailing_Event_BAO_TrackableURLOpen
::getRows(
416 $this->_mailing_id
, $this->_job_id
,
417 $this->_is_distinct
, $this->_url_id
,
418 $offset, $rowCount, $sort
428 * Name of export file.
430 * @param string $output
433 * @return string|NULL
436 public function getExportFileName($output = 'csv') {
440 public function eventToTitle() {
441 static $events = NULL;
443 if (empty($events)) {
445 'queue' => ts('Intended Recipients'),
446 'delivered' => ts('Successful Deliveries'),
447 'bounce' => ts('Bounces'),
448 'forward' => ts('Forwards'),
449 'reply' => $this->_is_distinct ?
ts('Unique Replies') : ts('Replies'),
450 'unsubscribe' => ts('Unsubscribe Requests'),
451 'optout' => ts('Opt-out Requests'),
452 'click' => $this->_is_distinct ?
ts('Unique Click-throughs') : ts('Click-throughs'),
453 'opened' => $this->_is_distinct ?
ts('Unique Tracked Opens') : ts('Tracked Opens'),
456 return $events[$this->_event_type
];
459 public function getTitle() {
460 return $this->eventToTitle();