MCI_Footnotes_Template
Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).
Loads a template file, replaces all Placeholders and returns the replaced file content.
Tags
Table of Contents
- C_STR_DASHBOARD = "dashboard"
- Directory name for dashboard templates.
- C_STR_PUBLIC = "public"
- Directory name for public templates.
- $plugin_directory : string
- Plugin Directory
- $a_str_OriginalContent : string
- Contains the content of the template after initialize.
- $a_str_ReplacedContent : string
- Contains the content of the template after initialize with replaced place holders.
- __construct() : mixed
- Class Constructor. Reads and loads the template file without replace any placeholder.
- get_template() : mixed
- Get the template
- getContent() : string
- Returns the content of the template file with replaced placeholders.
- process_template() : void
- Process template file
- reload() : mixed
- Reloads the original content of the template file.
- replace() : bool
- Replace all placeholders specified in array.
Constants
C_STR_DASHBOARD
Directory name for dashboard templates.
public
string
C_STR_DASHBOARD
= "dashboard"
Tags
C_STR_PUBLIC
Directory name for public templates.
public
string
C_STR_PUBLIC
= "public"
Tags
Properties
$plugin_directory
Plugin Directory
public
string
$plugin_directory
Tags
$a_str_OriginalContent
Contains the content of the template after initialize.
private
string
$a_str_OriginalContent
= ""
Tags
$a_str_ReplacedContent
Contains the content of the template after initialize with replaced place holders.
private
string
$a_str_ReplacedContent
= ""
Tags
Methods
__construct()
Class Constructor. Reads and loads the template file without replace any placeholder.
public
__construct(string $p_str_FileType, string $p_str_FileName[, string $p_str_Extension = "html" ]) : mixed
Parameters
- $p_str_FileType : string
-
Template file type (take a look on the Class constants).
- $p_str_FileName : string
-
Template file name inside the Template directory without the file extension.
- $p_str_Extension : string = "html"
-
Optional Template file extension (default: html)
Tags
Return values
mixed —get_template()
Get the template
public
get_template(string $p_str_FileType, string $p_str_FileName[, string $p_str_Extension = "html" ]) : mixed
Parameters
- $p_str_FileType : string
- $p_str_FileName : string
- $p_str_Extension : string = "html"
Tags
Return values
mixed —false | template path
getContent()
Returns the content of the template file with replaced placeholders.
public
getContent() : string
Tags
Return values
string —Template content with replaced placeholders.
process_template()
Process template file
public
process_template(string $template) : void
Parameters
- $template : string
Tags
Return values
void —reload()
Reloads the original content of the template file.
public
reload() : mixed
Tags
Return values
mixed —replace()
Replace all placeholders specified in array.
public
replace(array<string|int, mixed> $p_arr_Placeholders) : bool
Parameters
- $p_arr_Placeholders : array<string|int, mixed>
-
Placeholders (key = placeholder, value = value).
Tags
Return values
bool —True on Success, False if Placeholders invalid.