CRM/Mailing/Page/Tab.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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 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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class handle mailing and contact related functions
  38  *
  39  */
  40 class CRM_Mailing_Page_Tab extends CRM_Contact_Page_View {
  41   /**
  42    * The action links that we need to display for the browse screen
  43    *
  44    * @var array
  45    */
  46   static $_links = NULL;
  47   public $_permission = NULL;
  48   public $_contactId = NULL;
  49
  50   /**
  51    * called when action is browse
  52    *
  53    * return null
  54    */
  55   public function browse() {
  56   }
  57
  58   /**
  59    * Build all the data structures needed to build the form
  60    *
  61    * @return void
  62    */
  63   public function preProcess() {
  64     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse');
  65     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
  66
  67     $this->_contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
  68     $displayName = CRM_Contact_BAO_Contact::displayName($this->_contactId);
  69
  70     $this->assign('contactId', $this->_contactId);
  71     $this->assign('displayName', $displayName);
  72
  73     // check logged in url permission
  74     CRM_Contact_Page_View::checkUserPermission($this);
  75
  76     // set page title
  77     CRM_Utils_System::setTitle(ts('Mailings sent to %1', array(1 => $displayName)));
  78   }
  79
  80   /**
  81    * the main function that is called when the page loads,
  82    * it decides the which action has to be taken for the page.
  83    *
  84    * return null
  85    */
  86   public function run() {
  87     $this->preProcess();
  88     $this->browse();
  89
  90     return parent::run();
  91   }
  92 }