CRM/Mailing/Page/Report.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2016                                |
   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 and the CiviCRM Licensing Exception.   |
  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 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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2016
  32  */
  33
  34 /**
  35  * Page to display / edit the header / footer of a mailing.
  36  */
  37 class CRM_Mailing_Page_Report extends CRM_Core_Page_Basic {
  38   public $_mailing_id;
  39
  40   /**
  41    * Get BAO Name.
  42    *
  43    * @return string
  44    *   Classname of BAO
  45    */
  46   public function getBAOName() {
  47     return 'CRM_Mailing_BAO_Mailing';
  48   }
  49
  50   /**
  51    * @return null
  52    */
  53   public function &links() {
  54     return CRM_Core_DAO::$_nullObject;
  55   }
  56
  57   /**
  58    * @return null
  59    */
  60   public function editForm() {
  61     return NULL;
  62   }
  63
  64   /**
  65    * @return string
  66    */
  67   public function editName() {
  68     return 'CiviMail Report';
  69   }
  70
  71   /**
  72    * Get user context.
  73    *
  74    * @param null $mode
  75    *
  76    * @return string
  77    *   user context.
  78    */
  79   public function userContext($mode = NULL) {
  80     return 'civicrm/mailing/report';
  81   }
  82
  83   /**
  84    * @param null $mode
  85    *
  86    * @return string
  87    */
  88   public function userContextParams($mode = NULL) {
  89     return 'reset=1&mid=' . $this->_mailing_id;
  90   }
  91
  92   /**
  93    * @return string
  94    */
  95   public function run() {
  96     $this->_mailing_id = CRM_Utils_Request::retrieve('mid', 'Positive', $this);
  97     //CRM-15979 - check if abtest exist for mailing then redirect accordingly
  98     $abtest = CRM_Mailing_BAO_MailingAB::getABTest($this->_mailing_id);
  99     if (!empty($abtest) && !empty($abtest->id)) {
 100       CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/a/', NULL, TRUE, '/abtest/' . $abtest->id));
 101     }
 102     // check that the user has permission to access mailing id
 103     CRM_Mailing_BAO_Mailing::checkPermission($this->_mailing_id);
 104
 105     $report = CRM_Mailing_BAO_Mailing::report($this->_mailing_id);
 106
 107     // get contents of mailing
 108     CRM_Mailing_BAO_Mailing::getMailingContent($report, $this);
 109
 110     // assign backurl
 111     $context = CRM_Utils_Request::retrieve('context', 'String', $this);
 112     $cid = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
 113
 114     if ($context == 'activitySelector') {
 115       $backUrl = CRM_Utils_System::url('civicrm/contact/view', "reset=1&cid={$cid}&selectedChild=activity");
 116       $backUrlTitle = ts('Back to Activities');
 117     }
 118     elseif ($context == 'activity') {
 119       $atype = CRM_Utils_Request::retrieve('atype', 'Positive', $this);
 120       $aid = CRM_Utils_Request::retrieve('aid', 'Positive', $this);
 121
 122       $backUrl = CRM_Utils_System::url('civicrm/activity/view',
 123         "atype={$atype}&action=view&reset=1&id={$aid}&cid={$cid}&context=activity"
 124       );
 125       $backUrlTitle = ts('Back to Activity');
 126     }
 127     elseif ($context == 'mailing') {
 128       $backUrl = CRM_Utils_System::url('civicrm/contact/view', "reset=1&cid={$cid}&selectedChild=mailing");
 129       $backUrlTitle = ts('Back to Mailing');
 130     }
 131     else {
 132       $backUrl = CRM_Utils_System::url('civicrm/mailing', 'reset=1');
 133       $backUrlTitle = ts('Back to CiviMail');
 134     }
 135     $this->assign('backUrl', $backUrl);
 136     $this->assign('backUrlTitle', $backUrlTitle);
 137
 138     $this->assign('report', $report);
 139     CRM_Utils_System::setTitle(ts('CiviMail Report: %1',
 140       array(1 => $report['mailing']['name'])
 141     ));
 142
 143     return CRM_Core_Page::run();
 144   }
 145
 146 }