Class: JspitTemplate

Declaration class JspitTemplate
Datei JspitTemplate.php
Date/Time modify File 2022-07-19 15:55:47
File-Size 14 KByte
MD5 File 9bb187fd7cf4a71f70baf02e04da2ae0
Version 1.5
Date 2022-07-19

Public Methods

Methods and Parameter Description/Comments
public function __construct(string $tplFileName = NULL, bool $flagAsString = false) @param $tplFileName Template-Filename or Template-String
@param $flagAsString true if $tplFileName is a template-string, default false
@throws Exception if Template-File is not readable
public static function create(string $tplFileName) : self create a object JspitTemplate
@param $tplFileName Template-Filename
@return object or throw a exeption if error
public static function createFromString(string $string = "") : self createFromString
create a object JspitTemplate from a Template-String
@param $string a Template
@return object self
public static function renderFromString(string $string = "",array $assign = []) : string renderFromString
render a Template-String
@param $string a Template
@param array $keyValue
@return string HTML
public static function setTemplatePath(string $path = '') : string set default template path
@param string $path, without $path or "" reset template path
@return realpath if $path exists or false if not
public function render(...$par) render template and get html
@param string filename (optional)
@param array $keyValue
@return string HTML
@throw Exception if arguments incorrect
public function getHTML(array $assign = []) : string render code and get HTML
@param array $keyValue
@return string HTML
public function __toString() : string magic function, please refer getHTML
@return string HTML
public function loadFile(string $tplFileName) : self load Template
@param String $tplFileName : Filename
@return $this
@throw Exception if Template-FileName incorrect
public function loadString(string $template) : self load String
@param string Template
@return $this
public function getTemplate() : string get Template
@return string Template
public function save(string $tplFileName) : self save Template
@param string $tplFileName
@return $this object
public function assign($keyValue = NULL) : self assign : Assign content to placeholders
@param $keyValue array, object or null (default)
@return $this object
public function assignOnce($keyValue, bool $insert = false) : self assignOnce : Assign content to placeholders at once
@param $keyValue array or object
@param bool $insert, default false, true insert before the placeholder
@return $this object
public function getPlaceholders(string $name = "") : array getPlaceholders : use internal and for test
@param $name name or "" for all
@return array("format(\"%3d\")",..)
public static function addStaticUserFunction(string $name, $function) : bool add a userfuction (closure)
@param string $name
@param $function : closure
@return true
public function addUserFunction(string $name, $function) : self add a userfuction (closure)
@param string $name
@param $function : closure
@return $this
public static function splitPlaceholder(string $placeholder) split placeholder in komponents name, filter, default
@param $placeholder string e.g.'format(\"%3d\")'
@return array('name' => .., 'filter' => .., 'default' => ..) or false if error
public static function stripQuotes(string $str) : string 'abc' => abc, "abc" => abc, 'abc" => 'abc"