Smarty_Internal_Config Class Reference

Public Member Functions
	__construct ($config_resource, $smarty, $data=null)
	Constructor of config file object. More...
	getCompiledFilepath ()
	Returns the compiled filepath. More...
	buildCompiledFilepath ()
	Get file path. More...
	getCompiledTimestamp ()
	Returns the timpestamp of the compiled file. More...
	mustCompile ()
	Returns if the current config file must be compiled. More...
	getCompiledConfig ()
	Returns the compiled config file. More...
	compileConfigSource ()
	Compiles the config files. More...
	loadConfigVars ($sections=null, $scope= 'local')
	load config variables More...
	__set ($property_name, $value)
	set Smarty property in template context More...
	__get ($property_name)
	get Smarty property in template context More...

Data Fields
	$smarty = null
	$data = null
	$config_resource = null
	$compiled_config = null
	$compiled_filepath = null
	$compiled_timestamp = null
	$mustCompile = null
	$compiler_object = null

Detailed Description

Definition at line 22 of file smarty_internal_config.php.

Constructor & Destructor Documentation

__construct	(		$config_resource,
			$smarty,
			$data = null
	)

Constructor of config file object.

Parameters

string	$config_resource	config file resource name
Smarty	$smarty	Smarty instance
object	$data	object for config vars storage

Definition at line 78 of file smarty_internal_config.php.

Member Function Documentation

__get

(

$property_name

)

get Smarty property in template context

Parameters

string

$property_name

property name

Exceptions

SmartyException

if $property_name is not valid

Definition at line 282 of file smarty_internal_config.php.

__set	(		$property_name,
			$value
	)

set Smarty property in template context

Parameters

string	$property_name	property name
mixed	$value	value

Exceptions

SmartyException

if $property_name is not valid

Definition at line 264 of file smarty_internal_config.php.

buildCompiledFilepath

(

)

Get file path.

Returns

string

Definition at line 102 of file smarty_internal_config.php.

compileConfigSource

(

)

Compiles the config files.

Exceptions

Exception

Definition at line 174 of file smarty_internal_config.php.

getCompiledConfig

(

)

Returns the compiled config file.

It checks if the config file must be compiled or just read the compiled version

Returns

string the compiled config file

Definition at line 156 of file smarty_internal_config.php.

getCompiledFilepath

(

)

Returns the compiled filepath.

Returns

string the compiled filepath

Definition at line 90 of file smarty_internal_config.php.

getCompiledTimestamp

(

)

Returns the timpestamp of the compiled file.

Returns

integer the file timestamp

Definition at line 128 of file smarty_internal_config.php.

loadConfigVars	(		$sections = null,
			$scope = 'local'
	)

load config variables

Parameters

mixed	$sections	array of section names, single section or null
object	$scope	global,parent or local

Definition at line 208 of file smarty_internal_config.php.

mustCompile

(

)

Returns if the current config file must be compiled.

It does compare the timestamps of config source and the compiled config and checks the force compile configuration

Returns

boolean true if the file must be compiled

Definition at line 142 of file smarty_internal_config.php.

Field Documentation

$compiled_config = null

Definition at line 46 of file smarty_internal_config.php.

$compiled_filepath = null

Definition at line 52 of file smarty_internal_config.php.

$compiled_timestamp = null

Definition at line 58 of file smarty_internal_config.php.

$compiler_object = null

Definition at line 69 of file smarty_internal_config.php.

$config_resource = null

Definition at line 40 of file smarty_internal_config.php.

$data = null

Definition at line 35 of file smarty_internal_config.php.

$mustCompile = null

Definition at line 63 of file smarty_internal_config.php.

$smarty = null

Definition at line 29 of file smarty_internal_config.php.

---

The documentation for this class was generated from the following file:

• lib/templateEngines/smarty/sysplugins/smarty_internal_config.php