Merge pull request #6637 from eileenmcnaughton/comments-3

[civicrm-core.git] / CRM / Core / Page / Basic.php

diff --git a/CRM/Core/Page/Basic.php b/CRM/Core/Page/Basic.php
index 62fea0f40c2bc1fcbe1dbfecb2e6c700a6cf2fc9..2560d5fee5ca193b43c5949b706a4cd114b69fe6 100644 (file)
--- a/CRM/Core/Page/Basic.php
+++ b/CRM/Core/Page/Basic.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.6                                                |
+ | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,32 +23,30 @@
  | 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$
- *
+ * @copyright CiviCRM LLC (c) 2004-2015
  */
 abstract class CRM_Core_Page_Basic extends CRM_Core_Page {
 
   protected $_action;
 
   /**
-   * Define all the abstract functions here
+   * Define all the abstract functions here.
    */
 
   /**
-   * Name of the BAO to perform various DB manipulations
+   * Name of the BAO to perform various DB manipulations.
    *
    * @return string
    */
   abstract protected function getBAOName();
 
   /**
-   * An array of action links
+   * An array of action links.
    *
    * @return array
    *   (reference)
@@ -56,21 +54,21 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page {
   abstract protected function &links();
 
   /**
-   * Name of the edit form class
+   * Name of the edit form class.
    *
    * @return string
    */
   abstract protected function editForm();
 
   /**
-   * Name of the form
+   * Name of the form.
    *
    * @return string
    */
   abstract protected function editName();
 
   /**
-   * UserContext to pop back to
+   * UserContext to pop back to.
    *
    * @param int $mode
    *   Mode that we are in.
@@ -80,7 +78,7 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page {
   abstract protected function userContext($mode = NULL);
 
   /**
-   * Get userContext params
+   * Get userContext params.
    *
    * @param int $mode
    *   Mode that we are in.
@@ -92,7 +90,7 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page {
   }
 
   /**
-   * Allow objects to be added based on permission
+   * Allow objects to be added based on permission.
    *
    * @param int $id
    *   The id of the object.
@@ -112,14 +110,12 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page {
    *
    * @param CRM_Core_Controller $controller
    *   The controller object.
-   *
-   * @return void
    */
   public function addValues($controller) {
   }
 
   /**
-   * Class constructor
+   * Class constructor.
    *
    * @param string $title
    *   Title of the page.
@@ -134,12 +130,10 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page {
 
   /**
    * Run the basic page (run essentially starts execution for that page).
-   *
-   * @return void
    */
   public function run() {
     // CRM-9034
-    // dont see args or pageArgs being used, so we should
+    // do not see args or pageArgs being used, so we should
     // consider eliminating them in a future version
     $n = func_num_args();
     $args = ($n > 0) ? func_get_arg(0) : NULL;
@@ -190,8 +184,6 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page {
 
   /**
    * Browse all entities.
-   *
-   * @return void
    */
   public function browse() {
     $n = func_num_args();
@@ -288,8 +280,6 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page {
    *   The permission assigned to this object.
    *
    * @param bool $forceAction
-   *
-   * @return void
    */
   public function action(&$object, $action, &$values, &$links, $permission, $forceAction = FALSE) {
     $values['class'] = '';
@@ -370,8 +360,6 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page {
    *
    * @param bool $imageUpload
    * @param bool $pushUserContext
-   *
-   * @return void
    */
   public function edit($mode, $id = NULL, $imageUpload = FALSE, $pushUserContext = TRUE) {
     $controller = new CRM_Core_Controller_Simple($this->editForm(),
@@ -394,4 +382,5 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page {
     $controller->process();
     $controller->run();
   }
+
 }