X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FCore%2FPage.php;h=60bcc3e07c038020c1df9d0f525f330de314695a;hb=4846df9154866b0a33ee8ec7a1f48c65c77b670b;hp=f77dfa0b12d4c5ebbb0de0ca28ce6333071a3dda;hpb=54a633cfdd9b911ac35b4fd8ee4c8685232d093b;p=civicrm-core.git diff --git a/CRM/Core/Page.php b/CRM/Core/Page.php index f77dfa0b12..60bcc3e07c 100644 --- a/CRM/Core/Page.php +++ b/CRM/Core/Page.php @@ -23,7 +23,7 @@ | GNU Affero General Public License or the licensing of CiviCRM, | | see the CiviCRM license FAQ at http://civicrm.org/licensing | +--------------------------------------------------------------------+ -*/ + */ /** * @@ -51,7 +51,7 @@ class CRM_Core_Page { protected $_name; /** - * The title associated with this page + * The title associated with this page. * * @var object */ @@ -85,7 +85,6 @@ class CRM_Core_Page { * Cache the smarty template for efficiency reasons * * @var CRM_Core_Smarty - * @static */ static protected $_template; @@ -93,7 +92,6 @@ class CRM_Core_Page { * Cache the session for efficiency reasons * * @var CRM_Core_Session - * @static */ static protected $_session; @@ -118,17 +116,19 @@ class CRM_Core_Page { public $useLivePageJS; /** - * Class constructor + * 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 */ public function __construct($title = NULL, $mode = NULL) { - $this->_name = CRM_Utils_System::getClassName($this); + $this->_name = CRM_Utils_System::getClassName($this); $this->_title = $title; - $this->_mode = $mode; + $this->_mode = $mode; // let the constructor initialize this, should happen only once if (!isset(self::$_template)) { @@ -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); @@ -182,8 +182,12 @@ class CRM_Core_Page { CRM_Utils_Hook::pageRun($this); if ($this->_print) { - if (in_array( $this->_print, array( CRM_Core_Smarty::PRINT_SNIPPET, - CRM_Core_Smarty::PRINT_PDF, CRM_Core_Smarty::PRINT_NOFORM, CRM_Core_Smarty::PRINT_JSON ))) { + if (in_array($this->_print, array( + CRM_Core_Smarty::PRINT_SNIPPET, + CRM_Core_Smarty::PRINT_PDF, + CRM_Core_Smarty::PRINT_NOFORM, + CRM_Core_Smarty::PRINT_JSON, + ))) { $content = self::$_template->fetch('CRM/common/snippet.tpl'); } else { @@ -220,8 +224,8 @@ class CRM_Core_Page { CRM_Utils_Check::singleton()->showPeriodicAlerts(); if ($this->useLivePageJS && - CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'ajaxPopupsEnabled', NULL, TRUE)) - { + 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', 1, 'html-header'); $this->assign('includeWysiwygEditor', TRUE); } @@ -238,41 +242,39 @@ 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 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. * * * @return void - * */ 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 + * Get the variable from the form scope. * + * @param string $name name of the variable * * @return mixed - * */ public function get($name) { return self::$_session->get($name, $this->_name); } /** - * Assign value to name in template + * Assign value to name in template. * * @param string $var - * @param mixed $value value of varaible + * @param mixed $value + * Value of varaible. * * @return void */ @@ -281,10 +283,11 @@ 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 (reference) value of varaible + * @param mixed $value + * (reference) value of varaible. * * @return void */ @@ -293,24 +296,25 @@ 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 the value to append + * @param mixed $value + * The value to append. * @param bool $merge */ - public function append($tpl_var, $value=NULL, $merge=FALSE) { + public function append($tpl_var, $value = NULL, $merge = FALSE) { self::$_template->append($tpl_var, $value, $merge); } /** - * Returns an array containing template variables + * Returns an array containing template variables. * * @param string $name * * @return array */ - public function get_template_vars($name=null) { + public function get_template_vars($name = NULL) { return self::$_template->get_template_vars($name); } @@ -325,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'; } @@ -357,9 +364,9 @@ class CRM_Core_Page { } /** - * Setter for embedded + * Setter for embedded. * - * @param boolean $embedded + * @param bool $embedded * * @return void */ @@ -368,18 +375,19 @@ class CRM_Core_Page { } /** - * Getter for embedded + * Getter for embedded. * - * @return boolean return the embedded value + * @return bool + * return the embedded value */ public function getEmbedded() { return $this->_embedded; } /** - * Setter for print + * Setter for print. * - * @param boolean $print + * @param bool $print * * @return void */ @@ -388,9 +396,10 @@ class CRM_Core_Page { } /** - * Getter for print + * Getter for print. * - * @return boolean return the print value + * @return bool + * return the print value */ public function getPrint() { return $this->_print; @@ -419,4 +428,5 @@ class CRM_Core_Page { public function setVar($name, $value) { $this->$name = $value; } + }