Merge pull request #5035 from TeNNoX/master
[civicrm-core.git] / CRM / Mailing / Page / Tab.php
index 08fafb425dd5c2a0830d22bb9ca81c43af815942..4dffe4a5d6ee97a8b1548b31d83f1fbcf027a309 100644 (file)
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
- *
  */
 
 /**
  * This class handle mailing and contact related functions
- *
  */
 class CRM_Mailing_Page_Tab extends CRM_Contact_Page_View {
   /**
-   * The action links that we need to display for the browse screen
+   * The action links that we need to display for the browse screen.
    *
    * @var array
-   * @static
    */
   static $_links = NULL;
   public $_permission = NULL;
   public $_contactId = NULL;
 
   /**
-   * This function is called when action is browse
-   *
-   * return null
+   * Called when action is browse.
    */
   public function browse() {
   }
 
   /**
-   * Build all the data structures needed to build the form
-   *
-   * @return void
+   * Build all the data structures needed to build the form.
    */
   public function preProcess() {
     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse');
-    $this->_id     = CRM_Utils_Request::retrieve('id', 'Positive', $this);
+    $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
 
     $this->_contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
     $displayName = CRM_Contact_BAO_Contact::displayName($this->_contactId);
@@ -71,23 +64,21 @@ class CRM_Mailing_Page_Tab extends CRM_Contact_Page_View {
     $this->assign('contactId', $this->_contactId);
     $this->assign('displayName', $displayName);
 
-    // check logged in url permission
+    // Check logged in url permission.
     CRM_Contact_Page_View::checkUserPermission($this);
 
-    // set page title
     CRM_Utils_System::setTitle(ts('Mailings sent to %1', array(1 => $displayName)));
   }
 
   /**
-   * This function is the main function that is called when the page loads,
-   * it decides the which action has to be taken for the page.
+   * The main function that is called when the page loads.
    *
-   * return null
+   * It decides the which action has to be taken for the page.
    */
   public function run() {
     $this->preProcess();
     $this->browse();
-
-    return parent::run();
+    parent::run();
   }
+
 }