Skip to content

Smarty_Internal_Resource_Php

Smarty Internal Plugin Resource PHP Implements the file system as resource for PHP templates

Properties

uncompiled

Flag that it's an uncompiled resource

public bool $uncompiled

hasCompiledHandler

Resource does implement populateCompiledFilepath() method

public bool $hasCompiledHandler

short_open_tag

container for short_open_tag directive's value before executing PHP templates

protected string $short_open_tag

Methods

__construct

Create a new PHP Resource

public __construct(): mixed

getContent

Load template's source from file 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


populateCompiledFilepath

populate compiled object with compiled filepath

public populateCompiledFilepath(\Smarty_Template_Compiled $compiled, \Smarty_Internal_Template $_template): mixed

Parameters:

Parameter Type Description
$compiled \Smarty_Template_Compiled compiled object
$_template \Smarty_Internal_Template template object (is ignored)

renderUncompiled

Render and output the template (without using the compiler)

public renderUncompiled(\Smarty_Template_Source $source, \Smarty_Internal_Template $_template): void

Parameters:

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

Throws:

if template cannot be loaded or allow_php_templates is disabled


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:


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:


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:


getContent

Load template's source from file 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


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

Throws:


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

buildFilepath

build template filepath by traversing the template_dir array

protected buildFilepath(\Smarty_Template_Source $source, \Smarty_Internal_Template $_template = null): string

Parameters:

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

Return Value:

fully qualified filepath

Throws:



Automatically generated on 2025-03-18