X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FCore%2FPage.php;h=f77dfa0b12d4c5ebbb0de0ca28ce6333071a3dda;hb=4bf0b605aee4f59a5f7dbfb42f316ae8f0d1fec7;hp=291c7d6297c437ab19086144b540f92bd20ad435;hpb=4014394ebf74035cc7cc8bee5b37e8057f2c96b2;p=civicrm-core.git

diff --git a/CRM/Core/Page.php b/CRM/Core/Page.php
index 291c7d6297..f77dfa0b12 100644
--- 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,15 +47,13 @@ class CRM_Core_Page {
    * The name of the page (auto generated from class name)
    *
    * @var string
-   * @access protected
    */
   protected $_name;
 
   /**
-   * the title associated with this 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,24 +78,21 @@ class CRM_Core_Page {
    * functionality to do a minimal display :)
    *
    * @var boolean
-   * @access protected
    */
   protected $_print = FALSE;
 
   /**
-   * cache the smarty template for efficiency reasons
+   * Cache the smarty template for efficiency reasons
    *
    * @var CRM_Core_Smarty
-   * @access protected
    * @static
    */
   static protected $_template;
 
   /**
-   * cache the session for efficiency reasons
+   * Cache the session for efficiency reasons
    *
    * @var CRM_Core_Session
-   * @access protected
    * @static
    */
   static protected $_session;
@@ -125,14 +118,14 @@ class CRM_Core_Page {
   public $useLivePageJS;
 
   /**
-   * class constructor
+   * Class constructor
    *
    * @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 +165,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;
     }
@@ -228,7 +222,7 @@ class CRM_Core_Page {
     if ($this->useLivePageJS &&
       CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'ajaxPopupsEnabled', NULL, TRUE))
     {
-      CRM_Core_Resources::singleton()->addScriptFile('civicrm', 'js/crm.livePage.js');
+      CRM_Core_Resources::singleton()->addScriptFile('civicrm', 'js/crm.livePage.js', 1, 'html-header');
       $this->assign('includeWysiwygEditor', TRUE);
     }
 
@@ -253,12 +247,11 @@ class CRM_Core_Page {
    * @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);
   }
 
@@ -267,51 +260,46 @@ class CRM_Core_Page {
    *
    * @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);
   }
 
   /**
-   * assign value to name in template
+   * Assign value to name in template
    *
-   * @param $var
+   * @param string $var
    * @param mixed $value value of varaible
    *
-   * @internal param array|string $name name  of variable
    * @return void
-   * @access public
    */
-  function assign($var, $value = NULL) {
+  public function assign($var, $value = NULL) {
     self::$_template->assign($var, $value);
   }
 
   /**
-   * assign value to name in template by reference
+   * Assign value to name in template by reference
    *
-   * @param $var
+   * @param string $var
    * @param mixed $value (reference) value of varaible
    *
-   * @internal param array|string $name name  of variable
    * @return void
-   * @access public
    */
-  function assign_by_ref($var, &$value) {
+  public function assign_by_ref($var, &$value) {
     self::$_template->assign_by_ref($var, $value);
   }
 
   /**
-   * appends values to template variables
+   * Appends values to template variables
    *
    * @param array|string $tpl_var the template variable name(s)
    * @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,21 +308,19 @@ class CRM_Core_Page {
    *
    * @param string $name
    *
-   * @internal param string $type
    * @return array
    */
-  function get_template_vars($name=null) {
+  public function get_template_vars($name=null) {
     return self::$_template->get_template_vars($name);
   }
 
   /**
-   * function to destroy all the session state of this page.
+   * Destroy all the session state of this page.
    *
-   * @access public
    *
    * @return void
    */
-  function reset() {
+  public function reset() {
     self::$_session->resetScope($this->_name);
   }
 
@@ -342,9 +328,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)
@@ -355,7 +340,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;
@@ -366,78 +351,72 @@ class CRM_Core_Page {
    * i.e. we dont override
    *
    * @return string
-   * @access public
    */
-  function overrideExtraTemplateFileName() {
+  public function overrideExtraTemplateFileName() {
     return NULL;
   }
 
   /**
-   * setter for embedded
+   * Setter for embedded
    *
    * @param boolean $embedded
    *
    * @return void
-   * @access public
    */
-  function setEmbedded($embedded) {
+  public function setEmbedded($embedded) {
     $this->_embedded = $embedded;
   }
 
   /**
-   * getter for embedded
+   * Getter for embedded
    *
    * @return boolean return the embedded value
-   * @access public
    */
-  function getEmbedded() {
+  public function getEmbedded() {
     return $this->_embedded;
   }
 
   /**
-   * setter for print
+   * Setter for print
    *
    * @param boolean $print
    *
    * @return void
-   * @access public
    */
-  function setPrint($print) {
+  public function setPrint($print) {
     $this->_print = $print;
   }
 
   /**
-   * getter for print
+   * 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;
   }
 
   /**
-   * @param $name
+   * @param string $name
    *
    * @return null
    */
-  function getVar($name) {
+  public function getVar($name) {
     return isset($this->$name) ? $this->$name : NULL;
   }
 
   /**
-   * @param $name
+   * @param string $name
    * @param $value
    */
-  function setVar($name, $value) {
+  public function setVar($name, $value) {
     $this->$name = $value;
   }
 }
-