Smarty_Resource_Custom

Smarty Resource Plugin Wrapper Implementation for custom resource plugins

• Full name: \Smarty_Resource_Custom
• Parent class: \Smarty_Resource
• This class is an Abstract class

Methods

fetch

fetch template and its modification time from data source

protected fetch(string $name, string& $source, int& $mtime): mixed

• This method is abstract.

Parameters:

Parameter	Type	Description
$name	string	template name
$source	string	template source
$mtime	int	template modification timestamp (epoch)

---

fetchTimestamp

Fetch template's modification timestamp from data source {@internal implementing this method is optional.

protected fetchTimestamp(string $name): int|bool

Only implement it if modification times can be accessed faster than loading the complete template source.}}

Parameters:

Parameter	Type	Description
$name	string	template name

Return Value:

timestamp (epoch) the template was modified, or false if not found

---

populate

populate Source Object with meta data from Resource

public populate(\Smarty_Template_Source $source, \Smarty_Internal_Template $_template = null): mixed

Parameters:

Parameter	Type	Description
$source	\Smarty_Template_Source	source object
$_template	\Smarty_Internal_Template	template object

---

getContent

Load template's source into current template object

public getContent(\Smarty_Template_Source $source): string

Parameters:

Parameter	Type	Description
$source	\Smarty_Template_Source	source object

Return Value:

template source

Throws:

if source cannot be loaded

• SmartyException

---

getBasename

Determine basename for compiled filename

public getBasename(\Smarty_Template_Source $source): string

Parameters:

Parameter	Type	Description
$source	\Smarty_Template_Source	source object

Return Value:

resource's basename

---

generateSafeName

Removes special characters from $name and limits its length to 127 characters.

private generateSafeName(mixed $name): string

Parameters:

Parameter	Type	Description
$name	mixed

---

Inherited methods

load

Load Resource Handler

public static load(\Smarty $smarty, string $type): \Smarty_Resource

• This method is static.

Parameters:

Parameter	Type	Description
$smarty	\Smarty	smarty object
$type	string	name of the resource

Return Value:

Resource Handler

Throws:

• SmartyException

---

parseResourceName

extract resource_type and resource_name from template_resource and config_resource

public static parseResourceName(string $resource_name, string $default_resource): array

• This method is static.

Parameters:

Parameter	Type	Description
$resource_name	string	template_resource or config_resource to parse
$default_resource	string	the default resource_type defined in $smarty

Return Value:

with parsed resource name and type

---

getUniqueTemplateName

modify template_resource according to resource handlers specifications

public static getUniqueTemplateName(\Smarty_Internal_Template|\Smarty $obj, string $template_resource): string

• This method is static.

Parameters:

Parameter	Type	Description
$obj	\Smarty_Internal_Template|\Smarty	Smarty instance
$template_resource	string	template_resource to extract resource handler and name of

Return Value:

unique resource name

Throws:

• SmartyException

---

source

initialize Source Object for given resource wrapper for backward compatibility to versions < 3.1.22 Either [$_template] or [$smarty, $template_resource] must be specified

public static source(\Smarty_Internal_Template $_template = null, \Smarty $smarty = null, string $template_resource = null): \Smarty_Template_Source

• This method is static.

Parameters:

Parameter	Type	Description
$_template	\Smarty_Internal_Template	template object
$smarty	\Smarty	smarty object
$template_resource	string	resource identifier

Return Value:

Source Object

Throws:

• SmartyException

---

getContent

Load template's source into current template object

public getContent(\Smarty_Template_Source $source): string

• This method is abstract.

Parameters:

Parameter	Type	Description
$source	\Smarty_Template_Source	source object

Return Value:

template source

Throws:

if source cannot be loaded

• SmartyException

---

populate

populate Source Object with meta data from Resource

public populate(\Smarty_Template_Source $source, \Smarty_Internal_Template $_template = null): mixed

• This method is abstract.

Parameters:

Parameter	Type	Description
$source	\Smarty_Template_Source	source object
$_template	\Smarty_Internal_Template	template object

---

populateTimestamp

populate Source Object with timestamp and exists from Resource

public populateTimestamp(\Smarty_Template_Source $source): mixed

Parameters:

Parameter	Type	Description
$source	\Smarty_Template_Source	source object

---

buildUniqueResourceName

modify resource_name according to resource handlers specifications

public buildUniqueResourceName(\Smarty $smarty, string $resource_name, bool $isConfig = false): string

Parameters:

Parameter	Type	Description
$smarty	\Smarty	Smarty instance
$resource_name	string	resource_name to make unique
$isConfig	bool	flag for config resource

Return Value:

unique resource name

---

getBasename

Determine basename for compiled filename

public getBasename(\Smarty_Template_Source $source): string

Parameters:

Parameter	Type	Description
$source	\Smarty_Template_Source	source object

Return Value:

resource's basename

---

checkTimestamps

public checkTimestamps(): bool

---

---

Automatically generated on 2025-03-18