Smarty Extended add method documentation

This commit is contained in:
Clemens Schwaighofer
2019-11-15 14:47:40 +09:00
parent 5195212fae
commit f5bfd6c84b

View File

@@ -143,9 +143,12 @@ class SmartyExtend extends SmartyBC
} }
public function setSmartyPaths() /**
* sets all internal paths and names that need to be passed on to the smarty template
* @return void
*/
public function setSmartyPaths(): void
{ {
global $AJAX_PAGE;
// master template // master template
if (!isset($this->MASTER_TEMPLATE_NAME)) { if (!isset($this->MASTER_TEMPLATE_NAME)) {
$this->MASTER_TEMPLATE_NAME = MASTER_TEMPLATE_NAME; $this->MASTER_TEMPLATE_NAME = MASTER_TEMPLATE_NAME;
@@ -178,8 +181,6 @@ class SmartyExtend extends SmartyBC
) { ) {
include($this->INCLUDES.$this->INC_TEMPLATE_NAME); include($this->INCLUDES.$this->INC_TEMPLATE_NAME);
} }
// only CSS/JS/etc include stuff if we have non AJAX page
if (isset($AJAX_PAGE) && !$AJAX_PAGE) {
// check for template include // check for template include
if ($this->USE_INCLUDE_TEMPLATE === true && if ($this->USE_INCLUDE_TEMPLATE === true &&
!$this->TEMPLATE_NAME !$this->TEMPLATE_NAME
@@ -248,19 +249,32 @@ class SmartyExtend extends SmartyBC
$this->TEMPLATE_TRANSLATE = null; $this->TEMPLATE_TRANSLATE = null;
} }
} }
}
public function setSmartyVarsFrontend() /**
* wrapper call for setSmartyVars
* this is for frontend type and will not set any only admin needed variables
* @return void
*/
public function setSmartyVarsFrontend(): void
{ {
$this->setSmartyVars(); $this->setSmartyVars();
} }
public function setSmartyVarsAdmin() /**
* wrapper call for setSmartyVars
* this is only for admin interface and will set additional variables
*/
public function setSmartyVarsAdmin(): void
{ {
$this->setSmartyVars(true); $this->setSmartyVars(true);
} }
private function setSmartyVars($admin_call = false) /**
* set smarty pass on variables, sub template names and finally calls the smarty parser
* @param boolean $admin_call default false, will set admin only variables
* @return void
*/
private function setSmartyVars($admin_call = false): void
{ {
global $cms; global $cms;
// array merge HEADER, DATA, DEBUG DATA // array merge HEADER, DATA, DEBUG DATA