INFRA-132 - CRM/Contribute - Misc

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

diff --git a/CRM/Core/Page.php b/CRM/Core/Page.php
index 1f6f844e935db8e76f8f150930737d67a51b4604..561cb3dac2cef69d09253bf3f20b5e4ab800c312 100644 (file)
--- a/CRM/Core/Page.php
+++ b/CRM/Core/Page.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -47,7 +47,6 @@ class CRM_Core_Page {
    * The name of the page (auto generated from class name)
    *
    * @var string
-   * @access protected
    */
   protected $_name;
 
@@ -55,7 +54,6 @@ class CRM_Core_Page {
    * The title associated with this page
    *
    * @var object
-   * @access protected
    */
   protected $_title;
 
@@ -63,7 +61,6 @@ class CRM_Core_Page {
    * A page can have multiple modes. (i.e. displays
    * a different set of data based on the input
    * @var int
-   * @access protected
    */
   protected $_mode;
 
@@ -73,7 +70,6 @@ class CRM_Core_Page {
    * parent object takes care of the display)
    *
    * @var boolean
-   * @access protected
    */
   protected $_embedded = FALSE;
 
@@ -82,7 +78,6 @@ class CRM_Core_Page {
    * functionality to do a minimal display :)
    *
    * @var boolean
-   * @access protected
    */
   protected $_print = FALSE;
 
@@ -90,7 +85,6 @@ class CRM_Core_Page {
    * Cache the smarty template for efficiency reasons
    *
    * @var CRM_Core_Smarty
-   * @access protected
    * @static
    */
   static protected $_template;
@@ -99,7 +93,6 @@ class CRM_Core_Page {
    * Cache the session for efficiency reasons
    *
    * @var CRM_Core_Session
-   * @access protected
    * @static
    */
   static protected $_session;
@@ -127,12 +120,14 @@ class CRM_Core_Page {
   /**
    * Class constructor
    *
-   * @param string $title title of the page
-   * @param int    $mode  mode of the page
+   * @param string $title
+   *   Title of the page.
+   * @param int $mode
+   *   Mode of the page.
    *
    * @return CRM_Core_Page
    */
-  function __construct($title = NULL, $mode = NULL) {
+  public function __construct($title = NULL, $mode = NULL) {
     $this->_name  = CRM_Utils_System::getClassName($this);
     $this->_title = $title;
     $this->_mode  = $mode;
@@ -172,9 +167,10 @@ class CRM_Core_Page {
    * pages. This typically involves assigning the appropriate
    * smarty variable :)
    *
-   * @return string The content generated by running this page
+   * @return string
+   *   The content generated by running this page
    */
-  function run() {
+  public function run() {
     if ($this->_embedded) {
       return;
     }
@@ -250,29 +246,28 @@ class CRM_Core_Page {
   /**
    * Store the variable with the value in the form scope
    *
-   * @param  string|array $name  name  of the variable or an assoc array of name/value pairs
-   * @param  mixed        $value value of the variable if string
+   * @param string|array $name name of the variable or an assoc array of name/value pairs
+   * @param mixed $value
+   *   Value of the variable if string.
    *
-   * @access public
    *
    * @return void
    *
    */
-  function set($name, $value = NULL) {
+  public function set($name, $value = NULL) {
     self::$_session->set($name, $value, $this->_name);
   }
 
   /**
    * Get the variable from the form scope
    *
-   * @param  string name  : name  of the variable
+   * @param string name : name of the variable
    *
-   * @access public
    *
    * @return mixed
    *
    */
-  function get($name) {
+  public function get($name) {
     return self::$_session->get($name, $this->_name);
   }
 
@@ -280,12 +275,12 @@ class CRM_Core_Page {
    * Assign value to name in template
    *
    * @param string $var
-   * @param mixed $value value of varaible
+   * @param mixed $value
+   *   Value of varaible.
    *
    * @return void
-   * @access public
    */
-  function assign($var, $value = NULL) {
+  public function assign($var, $value = NULL) {
     self::$_template->assign($var, $value);
   }
 
@@ -293,12 +288,12 @@ class CRM_Core_Page {
    * Assign value to name in template by reference
    *
    * @param string $var
-   * @param mixed $value (reference) value of varaible
+   * @param mixed $value
+   *   (reference) value of varaible.
    *
    * @return void
-   * @access public
    */
-  function assign_by_ref($var, &$value) {
+  public function assign_by_ref($var, &$value) {
     self::$_template->assign_by_ref($var, $value);
   }
 
@@ -306,10 +301,11 @@ class CRM_Core_Page {
    * Appends values to template variables
    *
    * @param array|string $tpl_var the template variable name(s)
-   * @param mixed $value the value to append
+   * @param mixed $value
+   *   The value to append.
    * @param bool $merge
    */
-  function append($tpl_var, $value=NULL, $merge=FALSE) {
+  public function append($tpl_var, $value = NULL, $merge = FALSE) {
     self::$_template->append($tpl_var, $value, $merge);
   }
 
@@ -320,18 +316,17 @@ class CRM_Core_Page {
    *
    * @return array
    */
-  function get_template_vars($name=null) {
+  public function get_template_vars($name = NULL) {
     return self::$_template->get_template_vars($name);
   }
 
   /**
    * Destroy all the session state of this page.
    *
-   * @access public
    *
    * @return void
    */
-  function reset() {
+  public function reset() {
     self::$_session->resetScope($this->_name);
   }
 
@@ -339,9 +334,8 @@ class CRM_Core_Page {
    * Use the form name to create the tpl file name
    *
    * @return string
-   * @access public
    */
-  function getTemplateFileName() {
+  public function getTemplateFileName() {
     return str_replace('_',
       DIRECTORY_SEPARATOR,
       CRM_Utils_System::getClassName($this)
@@ -352,7 +346,7 @@ class CRM_Core_Page {
    * A wrapper for getTemplateFileName that includes calling the hook to
    * prevent us from having to copy & paste the logic of calling the hook
    */
-  function getHookedTemplateFileName() {
+  public function getHookedTemplateFileName() {
     $pageTemplateFile = $this->getTemplateFileName();
     CRM_Utils_Hook::alterTemplateFile(get_class($this), $this, 'page', $pageTemplateFile);
     return $pageTemplateFile;
@@ -363,21 +357,19 @@ class CRM_Core_Page {
    * i.e. we dont override
    *
    * @return string
-   * @access public
    */
-  function overrideExtraTemplateFileName() {
+  public function overrideExtraTemplateFileName() {
     return NULL;
   }
 
   /**
    * Setter for embedded
    *
-   * @param boolean $embedded
+   * @param bool $embedded
    *
    * @return void
-   * @access public
    */
-  function setEmbedded($embedded) {
+  public function setEmbedded($embedded) {
     $this->_embedded = $embedded;
   }
 
@@ -385,21 +377,19 @@ class CRM_Core_Page {
    * Getter for embedded
    *
    * @return boolean return the embedded value
-   * @access public
    */
-  function getEmbedded() {
+  public function getEmbedded() {
     return $this->_embedded;
   }
 
   /**
    * Setter for print
    *
-   * @param boolean $print
+   * @param bool $print
    *
    * @return void
-   * @access public
    */
-  function setPrint($print) {
+  public function setPrint($print) {
     $this->_print = $print;
   }
 
@@ -407,16 +397,15 @@ class CRM_Core_Page {
    * Getter for print
    *
    * @return boolean return the print value
-   * @access public
    */
-  function getPrint() {
+  public function getPrint() {
     return $this->_print;
   }
 
   /**
    * @return CRM_Core_Smarty
    */
-  static function &getTemplate() {
+  public static function &getTemplate() {
     return self::$_template;
   }
 
@@ -425,7 +414,7 @@ class CRM_Core_Page {
    *
    * @return null
    */
-  function getVar($name) {
+  public function getVar($name) {
     return isset($this->$name) ? $this->$name : NULL;
   }
 
@@ -433,8 +422,7 @@ class CRM_Core_Page {
    * @param string $name
    * @param $value
    */
-  function setVar($name, $value) {
+  public function setVar($name, $value) {
     $this->$name = $value;
   }
 }
-