Documentation

CRM_Core_SmartyCompatibility extends Smarty
in package

Table of Contents

Methods

assign_by_ref()  : mixed
Generally Civi mis-uses this for perceived php4 conformance, avoid.
clear_assign()  : mixed|null|void
Generally Civi mis-uses this for perceived php4 conformance, avoid.
get_template_vars()  : array<string|int, mixed>
Returns an array containing template variables
load_filter()  : mixed
register_function()  : mixed
Registers custom function to be used in templates
register_modifier()  : mixed
Registers modifier to be used in templates
register_resource()  : mixed
Registers a resource to fetch a template
template_exists()  : bool
Checks whether requested template exists.

Methods

assign_by_ref()

Generally Civi mis-uses this for perceived php4 conformance, avoid.

public assign_by_ref(string $tpl_var, mixed &$value) : mixed
Parameters
$tpl_var : string
$value : mixed

clear_assign()

Generally Civi mis-uses this for perceived php4 conformance, avoid.

public clear_assign(string $tpl_var) : mixed|null|void
Parameters
$tpl_var : string
Return values
mixed|null|void

get_template_vars()

Returns an array containing template variables

public & get_template_vars([string $name = NULL ]) : array<string|int, mixed>

since 5.69 will be removed around 5.79

Parameters
$name : string = NULL
Return values
array<string|int, mixed>

load_filter()

public load_filter(string $type, string $name) : mixed
Parameters
$type : string
$name : string
Tags
throws
SmartyException

register_function()

Registers custom function to be used in templates

public register_function(string $function, string $function_impl[, bool $cacheable = TRUE ][, null $cache_attrs = NULL ]) : mixed
Parameters
$function : string

the name of the template function

$function_impl : string

the name of the PHP function to register

$cacheable : bool = TRUE
$cache_attrs : null = NULL
Tags
throws
SmartyException

register_modifier()

Registers modifier to be used in templates

public register_modifier(string $modifier, string $modifier_impl) : mixed
Parameters
$modifier : string

name of template modifier

$modifier_impl : string

name of PHP function to register

register_resource()

Registers a resource to fetch a template

public register_resource(string $type, array<string|int, mixed> $functions) : mixed
Parameters
$type : string

name of resource

$functions : array<string|int, mixed>

array of functions to handle resource

template_exists()

Checks whether requested template exists.

public template_exists(string $tpl_file) : bool
Parameters
$tpl_file : string
Tags
throws
SmartyException
Return values
bool

        
On this page

Search results