X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FCore%2FPage.php;h=0dd6d871420d942888f896d756681ce9cac5c3be;hb=94e6918c3f16db13cfcb8261ad846a80e9604eb3;hp=521cd824d9f21ac99e52c000cc6f03c40a1193ad;hpb=ad314df7cc28a13a58caee38ccf30750572c5f11;p=civicrm-core.git

diff --git a/CRM/Core/Page.php b/CRM/Core/Page.php
index 521cd824d9..0dd6d87142 100644
--- a/CRM/Core/Page.php
+++ b/CRM/Core/Page.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,12 +23,12 @@
  | 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
+ * @copyright CiviCRM LLC (c) 2004-2015
  * $Id$
  *
  */
@@ -51,7 +51,7 @@ class CRM_Core_Page {
   protected $_name;
 
   /**
-   * The title associated with this page
+   * The title associated with this page.
    *
    * @var object
    */
@@ -116,7 +116,7 @@ class CRM_Core_Page {
   public $useLivePageJS;
 
   /**
-   * Class constructor
+   * Class constructor.
    *
    * @param string $title
    *   Title of the page.
@@ -162,15 +162,15 @@ class CRM_Core_Page {
 
   /**
    * This function takes care of all the things common to all
-   * pages. This typically involves assigning the appropriate
-   * smarty variable :)
+   * pages. This typically involves assigning the appropriate smarty
+   * variable :)
    *
-   * @return string
+   * @return void|string
    *   The content generated by running this page
    */
   public function run() {
     if ($this->_embedded) {
-      return;
+      return NULL;
     }
 
     self::$_template->assign('mode', $this->_mode);
@@ -186,7 +186,7 @@ class CRM_Core_Page {
         CRM_Core_Smarty::PRINT_SNIPPET,
         CRM_Core_Smarty::PRINT_PDF,
         CRM_Core_Smarty::PRINT_NOFORM,
-        CRM_Core_Smarty::PRINT_JSON
+        CRM_Core_Smarty::PRINT_JSON,
       ))) {
         $content = self::$_template->fetch('CRM/common/snippet.tpl');
       }
@@ -242,11 +242,10 @@ class CRM_Core_Page {
     CRM_Utils_Hook::alterContent($content, 'page', $pageTemplateFile, $this);
 
     echo CRM_Utils_System::theme($content, $this->_print);
-    return;
   }
 
   /**
-   * Store the variable with the value in the form scope
+   * 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
@@ -260,10 +259,9 @@ class CRM_Core_Page {
   }
 
   /**
-   * Get the variable from the form scope
-   *
-   * @param string name : name of the variable
+   * Get the variable from the form scope.
    *
+   * @param string $name name of the variable
    *
    * @return mixed
    */
@@ -272,7 +270,7 @@ class CRM_Core_Page {
   }
 
   /**
-   * Assign value to name in template
+   * Assign value to name in template.
    *
    * @param string $var
    * @param mixed $value
@@ -285,7 +283,7 @@ class CRM_Core_Page {
   }
 
   /**
-   * Assign value to name in template by reference
+   * Assign value to name in template by reference.
    *
    * @param string $var
    * @param mixed $value
@@ -298,7 +296,7 @@ class CRM_Core_Page {
   }
 
   /**
-   * Appends values to template variables
+   * Appends values to template variables.
    *
    * @param array|string $tpl_var the template variable name(s)
    * @param mixed $value
@@ -310,7 +308,7 @@ class CRM_Core_Page {
   }
 
   /**
-   * Returns an array containing template variables
+   * Returns an array containing template variables.
    *
    * @param string $name
    *
@@ -331,14 +329,17 @@ class CRM_Core_Page {
   }
 
   /**
-   * Use the form name to create the tpl file name
+   * Use the form name to create the tpl file name.
    *
    * @return string
    */
   public function getTemplateFileName() {
-    return str_replace('_',
-      DIRECTORY_SEPARATOR,
-      CRM_Utils_System::getClassName($this)
+    return strtr(
+      CRM_Utils_System::getClassName($this),
+      array(
+        '_' => DIRECTORY_SEPARATOR,
+        '\\' => DIRECTORY_SEPARATOR,
+      )
     ) . '.tpl';
   }
 
@@ -363,7 +364,7 @@ class CRM_Core_Page {
   }
 
   /**
-   * Setter for embedded
+   * Setter for embedded.
    *
    * @param bool $embedded
    *
@@ -374,9 +375,9 @@ class CRM_Core_Page {
   }
 
   /**
-   * Getter for embedded
+   * Getter for embedded.
    *
-   * @return boolean
+   * @return bool
    *   return the embedded value
    */
   public function getEmbedded() {
@@ -384,7 +385,7 @@ class CRM_Core_Page {
   }
 
   /**
-   * Setter for print
+   * Setter for print.
    *
    * @param bool $print
    *
@@ -395,9 +396,9 @@ class CRM_Core_Page {
   }
 
   /**
-   * Getter for print
+   * Getter for print.
    *
-   * @return boolean
+   * @return bool
    *   return the print value
    */
   public function getPrint() {
@@ -427,4 +428,5 @@ class CRM_Core_Page {
   public function setVar($name, $value) {
     $this->$name = $value;
   }
+
 }