phpDocumentor

WithdrawalThemeContentView extends ThemeContentView
in package
Uses AntiSpamUtilityTrait

Class ThemeContentView

Table of Contents

$content_array  : mixed
$deprecated_array  : mixed
$v_cache_id_elements_array  : mixed
$v_caching_enabled  : mixed
$v_compile_check_enabled  : mixed
$v_content_template  : mixed
$v_coo_smarty  : bool|GXSmarty
$v_env_get_array  : mixed
$v_env_post_array  : mixed
$v_flat_assigns  : mixed
$v_min_deprecation_level  : mixed
$v_session_id_placeholder  : mixed
$v_template_dir  : mixed
$build_html  : mixed
$escape_html  : mixed
__construct()  : mixed
add_cache_id_elements()  : mixed
before_build_html()  : mixed
build_html()  : mixed
clear_cache_id_elements()  : mixed
get_cache_id()  : mixed
get_content_array()  : mixed
get_content_template()  : mixed
get_default_template()  : string
get the first template from folder
get_flat_assigns()  : mixed
get_html()  : mixed
get_merged_deprecated_array()  : mixed
get_session_id_placeholder()  : mixed
init_smarty()  : mixed
is_cached()  : mixed
is_caching_enabled()  : mixed
is_compile_check_enabled()  : mixed
prepare_data()  : mixed
replace_session_id_placeholder()  : mixed
search_deprecated_keys()  : mixed
set_caching_enabled()  : mixed
set_compile_check_enabled()  : mixed
set_content_data()  : void
Inject the content data to the template file that they are accessible in template with variables.
set_content_template()  : void
Sets the content template file.
set_content_template_from_string()  : mixed
Smarty can render templates from a string by using the string: or eval: resource.
set_download_template()  : mixed
set_escape_html()  : mixed
Set whether HTML must be escaped automatically.
set_flat_assigns()  : mixed
set_template_dir()  : void
Sets the template directory path.
set_withdrawal_pdf_form_template()  : mixed
set_withdrawal_web_form_template()  : mixed
is_admin_file()  : bool
is_extension_file()  : bool
set_deprecated_array()  : mixed
add_secret_anti_spam_token()  : void
generateSecretAntiSpamToken()  : string
will generate random id and timestamp when the form is allowed to be processed value will be stored in session, under key "sast" (Secret Anti Spam Token), so it can be validated by "sendAntiSpamInputIsValid" upon sending
sendAntiSpamInputIsValid()  : bool
Validates if transmitted Secret Anti Spam Token is the stored one and if enough time has passed since originally generating it

Properties

$v_session_id_placeholder

public mixed $v_session_id_placeholder = '[#%_SESSION_ID_PLACEHOLDER_%#]'

Methods

__construct()

public __construct([mixed $p_get_array = false ][, mixed $p_post_array = false ]) : mixed
Parameters
$p_get_array : mixed = false
$p_post_array : mixed = false
Return values
mixed —

add_cache_id_elements()

public add_cache_id_elements(mixed $p_elements_array) : mixed
Parameters
$p_elements_array : mixed
Return values
mixed —

build_html()

public build_html([mixed $p_content_data_array = false ][, mixed $p_template_file = false ]) : mixed
Parameters
$p_content_data_array : mixed = false
$p_template_file : mixed = false
Return values
mixed —

clear_cache_id_elements()

public clear_cache_id_elements() : mixed
Return values
mixed —

get_content_array()

public get_content_array([mixed $p_max_deprecation_level = false ]) : mixed
Parameters
$p_max_deprecation_level : mixed = false
Return values
mixed —

get_default_template()

get the first template from folder

public get_default_template(string $filePath, string $prefix[, string $template = 'default' ]) : string

this function gets the first template from the folder, if the given filepath not an file

Parameters
$filePath : string

Path to the templates

$prefix : string

prefix of the type of template

$template : string = 'default'

Name of the template

Return values
string —

Template basename

get_merged_deprecated_array()

public get_merged_deprecated_array([mixed $p_max_deprecation_level = false ]) : mixed
Parameters
$p_max_deprecation_level : mixed = false
Return values
mixed —

get_session_id_placeholder()

public get_session_id_placeholder() : mixed
Return values
mixed —

is_compile_check_enabled()

public is_compile_check_enabled() : mixed
Return values
mixed —

replace_session_id_placeholder()

public replace_session_id_placeholder(mixed $p_content) : mixed
Parameters
$p_content : mixed
Return values
mixed —

search_deprecated_keys()

public search_deprecated_keys(mixed $p_key_array, mixed &$p_array) : mixed
Parameters
$p_key_array : mixed
$p_array : mixed
Return values
mixed —

set_caching_enabled()

public set_caching_enabled(mixed $p_status) : mixed
Parameters
$p_status : mixed
Return values
mixed —

set_compile_check_enabled()

public set_compile_check_enabled(mixed $p_status) : mixed
Parameters
$p_status : mixed
Return values
mixed —

set_content_data()

Inject the content data to the template file that they are accessible in template with variables.

public set_content_data(mixed $p_content_name, mixed $p_content_item, mixed $p_deprecation_level) : void
Parameters
$p_content_name : mixed
$p_content_item : mixed
$p_deprecation_level : mixed
Return values
void —

set_content_template()

Sets the content template file.

public set_content_template(mixed $p_filepath) : void
Parameters
$p_filepath : mixed
Return values
void —

set_content_template_from_string()

Smarty can render templates from a string by using the string: or eval: resource.

public set_content_template_from_string(string $p_template[, bool $storeCompiledTemplate = true ]) : mixed
Parameters
$p_template : string
$storeCompiledTemplate : bool = true

If set on "true", each unique template string will create a new compiled template file. If your template strings are accessed frequently, this is a good choice. If you have frequently changing template strings (or strings with low reuse value), "false" may be a better choice, as it doesn't save compiled templates to disk.

Return values
mixed —

set_flat_assigns()

public set_flat_assigns(mixed $p_status) : mixed
Parameters
$p_status : mixed
Return values
mixed —

set_template_dir()

Sets the template directory path.

public set_template_dir(mixed $p_dir_path) : void
Parameters
$p_dir_path : mixed
Return values
void —

is_admin_file()

protected is_admin_file(mixed $p_full_template_path) : bool
Parameters
$p_full_template_path : mixed
Return values
bool —

is_extension_file()

protected is_extension_file(string $filename) : bool
Parameters
$filename : string
Return values
bool —

set_deprecated_array()

protected set_deprecated_array() : mixed
Return values
mixed —

generateSecretAntiSpamToken()

will generate random id and timestamp when the form is allowed to be processed value will be stored in session, under key "sast" (Secret Anti Spam Token), so it can be validated by "sendAntiSpamInputIsValid" upon sending

private generateSecretAntiSpamToken() : string
Tags
throws
Exception
Return values
string —

sendAntiSpamInputIsValid()

Validates if transmitted Secret Anti Spam Token is the stored one and if enough time has passed since originally generating it

private sendAntiSpamInputIsValid(string $value) : bool
Parameters
$value : string

transmitted value of input named "ae6b85682663ab4570bd10c67b83d21fe77cdf97"

Return values
bool —

Search results