Class: Smarty_Compiler

Source Location: /PEAR/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php

Class Overview

Smarty
   |
   --Smarty_Compiler

Template compiling class

Methods

Inherited Variables

Class: Smarty

Smarty::$autoload_filters
Smarty::$cache_dir
Smarty::$cache_handler_func
Smarty::$cache_lifetime
Smarty::$cache_modified_check
Smarty::$caching
Smarty::$compiler_class
Smarty::$compiler_file
Smarty::$compile_check
Smarty::$compile_dir
Smarty::$compile_id
Smarty::$config_booleanize
Smarty::$config_class
Smarty::$config_dir
Smarty::$config_fix_newlines
Smarty::$config_overwrite
Smarty::$config_read_hidden
Smarty::$debugging
Smarty::$debugging_ctrl
Smarty::$debug_tpl
Smarty::$default_modifiers
Smarty::$default_resource_type
Smarty::$default_template_handler_func
Smarty::$force_compile
Smarty::$global_assign
Smarty::$left_delimiter
Smarty::$php_handling
Smarty::$plugins_dir
Smarty::$request_use_auto_globals
Smarty::$request_vars_order
Smarty::$right_delimiter
Smarty::$secure_dir
Smarty::$security
Smarty::$security_settings
Smarty::$template_dir
Smarty::$trusted_dir
Smarty::$undefined
Smarty::$use_sub_dirs

Inherited Methods

Class: Smarty

Smarty::Smarty(): The class constructor.
Smarty::append(): appends values to template variables
Smarty::append_by_ref(): appends values to template variables by reference
Smarty::assign(): assigns values to template variables
Smarty::assign_by_ref(): assigns values to template variables by reference
Smarty::clear_all_assign(): clear all the assigned template variables.
Smarty::clear_all_cache(): clear the entire contents of cache (all templates)
Smarty::clear_assign(): clear the given assigned template variable.
Smarty::clear_cache(): clear cached content for the given template and cache id
Smarty::clear_compiled_tpl(): clears compiled version of specified template resource, or all compiled template files if one is not specified.
Smarty::clear_config(): clear configuration values
Smarty::config_load(): load configuration values
Smarty::display(): executes & displays the template results
Smarty::fetch(): executes & returns or displays the template results
Smarty::get_config_vars(): Returns an array containing config variables
Smarty::get_registered_object(): return a reference to a registered object
Smarty::get_template_vars(): Returns an array containing template variables
Smarty::is_cached(): test to see if valid cache exists for this template
Smarty::load_filter(): load a filter of specified type and name
Smarty::register_block(): Registers block function to be used in templates
Smarty::register_compiler_function(): Registers compiler function
Smarty::register_function(): Registers custom function to be used in templates
Smarty::register_modifier(): Registers modifier to be used in templates
Smarty::register_object(): Registers object to be used in templates
Smarty::register_outputfilter(): Registers an output filter function to apply to a template output
Smarty::register_postfilter(): Registers a postfilter function to apply to a compiled template after compilation
Smarty::register_prefilter(): Registers a prefilter function to apply to a template before compiling
Smarty::register_resource(): Registers a resource to fetch a template
Smarty::template_exists(): Checks whether requested template exists.
Smarty::trigger_error(): trigger Smarty error
Smarty::unregister_block(): Unregisters block function
Smarty::unregister_compiler_function(): Unregisters compiler function
Smarty::unregister_function(): Unregisters custom function
Smarty::unregister_modifier(): Unregisters modifier
Smarty::unregister_object(): Unregisters object
Smarty::unregister_outputfilter(): Unregisters an outputfilter function
Smarty::unregister_postfilter(): Unregisters a postfilter function
Smarty::unregister_prefilter(): Unregisters a prefilter function
Smarty::unregister_resource(): Unregisters a resource
Smarty::_compile_resource(): compile the template
Smarty::_compile_source(): compile the given source
Smarty::_dequote(): Remove starting and ending quotes from the string
Smarty::_eval(): wrapper for eval() retaining $this
Smarty::_fetch_resource_info(): fetch the template info. Gets timestamp, and source if get_source is true
Smarty::_get_auto_filename(): get a concrete filename for automagically created content
Smarty::_get_auto_id(): returns an auto_id for auto-file-functions
Smarty::_get_compile_path(): Get the compile path for this resource
Smarty::_get_plugin_filepath(): get filepath of requested plugin
Smarty::_include(): wrapper for include() retaining $this
Smarty::_is_compiled(): test if resource needs compiling
Smarty::_parse_resource_name(): parse out the type and name from the resource
Smarty::_process_compiled_include_callback(): callback function for preg_replace, to call a non-cacheable block
Smarty::_read_file(): read in a file from line $start for $lines.
Smarty::_run_mod_handler(): Handle modifiers
Smarty::_smarty_cache_attrs(): get or set an array of cached attributes for function that is
Smarty::_smarty_include(): called for included templates
Smarty::_trigger_fatal_error(): trigger Smarty plugin error
Smarty::_unlink(): unlink a file, possibly using expiration time

Class Details

[line 48]
Template compiling class

[ Top ]

Class Methods

constructor Smarty_Compiler [line 95]

Smarty_Compiler Smarty_Compiler(
)

The class constructor.

[ Top ]

method _add_plugin [line 1856]

void _add_plugin(
string
$type, string
$name, [boolean?
$delayed_loading = null])

add plugin

Parameters:

string	$type
string	$name
boolean?	$delayed_loading

[ Top ]

method _compile_arg_list [line 1306]

void _compile_arg_list(

$type, 
$name, 
$attrs, 
&$cache_code)

Parameters:

	$type
	$name
	$attrs
	&$cache_code

[ Top ]

method _compile_block_tag [line 621]

boolean _compile_block_tag(
string
$tag_command, string
$tag_args, string
$tag_modifier, 
&$output, string
$output)

compile block function tag

sets $output to compiled block function tag

Parameters:

string	$tag_command
string	$tag_args
string	$tag_modifier
string	$output
	&$output

[ Top ]

method _compile_capture_tag [line 1116]

string _compile_capture_tag(
boolean
$start, [string
$tag_args = ''])

Compile {capture} .. {/capture} tags

Parameters:

boolean	$start	true if this is the {capture} tag
string	$tag_args

[ Top ]

method _compile_compiler_tag [line 552]

boolean _compile_compiler_tag(
string
$tag_command, string
$tag_args, 
&$output, string
$output)

compile the custom compiler tag

sets $output to the compiled custom compiler tag

Parameters:

string	$tag_command
string	$tag_args
string	$output
	&$output

[ Top ]

method _compile_custom_tag [line 706]

string _compile_custom_tag(
string
$tag_command, string
$tag_args, string
$tag_modifier)

compile custom function tag

Parameters:

string	$tag_command
string	$tag_args
string	$tag_modifier

[ Top ]

method _compile_file [line 227]

true _compile_file(
string
$resource_name, string
$source_content, 
&$compiled_content, string
$compiled_content)

compile a resource

sets $compiled_content to the compiled source

Parameters:

string	$resource_name
string	$source_content
string	$compiled_content
	&$compiled_content

[ Top ]

method _compile_foreach_start [line 1050]

string _compile_foreach_start(
string
$tag_args)

Compile {foreach ...} tag.

Parameters:

string

$tag_args

[ Top ]

method _compile_if_tag [line 1151]

string _compile_if_tag(
string
$tag_args, [boolean
$elseif = false])

Compile {if ...} tag

Parameters:

string	$tag_args
boolean	$elseif	if true, uses elseif instead of if

[ Top ]

method _compile_include_php_tag [line 914]

string _compile_include_php_tag(
string
$tag_args)

Compile {include ...} tag

Parameters:

string

$tag_args

[ Top ]

method _compile_include_tag [line 861]

string _compile_include_tag(
string
$tag_args)

Compile {include ...} tag

Parameters:

string

$tag_args

[ Top ]

method _compile_insert_tag [line 827]

string _compile_insert_tag(
string
$tag_args)

Compile {insert ...} tag

Parameters:

string

$tag_args

[ Top ]

method _compile_plugin_call [line 1986]

string _compile_plugin_call(
string
$type, string
$name)

compiles call to plugin of type $type with name $name

returns a string containing the function-name or method call without the paramter-list that would have follow to make the call valid php-syntax

Parameters:

string	$type
string	$name

[ Top ]

method _compile_registered_object_tag [line 735]

string _compile_registered_object_tag(
string
$tag_command, array
$attrs, string
$tag_modifier)

compile a registered object tag

Parameters:

string	$tag_command
array	$attrs
string	$tag_modifier

[ Top ]

method _compile_section_start [line 945]

string _compile_section_start(
string
$tag_args)

Compile {section ...} tag

Parameters:

string

$tag_args

[ Top ]

method _compile_smarty_ref [line 1875]

string _compile_smarty_ref(

&$indexes, string
$indexes)

Compiles references of type $smarty.foo

Parameters:

string	$indexes
	&$indexes

[ Top ]

method _compile_tag [line 406]

string _compile_tag(
string
$template_tag)

Compile a template tag

Parameters:

string

$template_tag

[ Top ]

method _expand_quoted_text [line 1556]

string _expand_quoted_text(
string
$var_expr)

expand quoted text with embedded variables

Parameters:

string

$var_expr

[ Top ]

method _load_filters [line 2010]

void _load_filters(
)

load pre- and post-filters

[ Top ]

method _parse_attrs [line 1407]

array _parse_attrs(
string
$tag_args)

Parse attribute string

Parameters:

string

$tag_args

[ Top ]

method _parse_conf_var [line 1741]

void _parse_conf_var(
string
$conf_var_expr)

parse configuration variable expression into PHP code

Parameters:

string

$conf_var_expr

[ Top ]

method _parse_is_expr [line 1346]

array _parse_is_expr(
string
$is_arg, array
$tokens)

Parse is expression

Parameters:

string	$is_arg
array	$tokens

[ Top ]

method _parse_modifiers [line 1787]

void _parse_modifiers(

&$output, string
$modifier_string, string
$output)

parse modifier chain into PHP code

sets $output to parsed modified chain

Parameters:

string	$output
string	$modifier_string
	&$output

[ Top ]

method _parse_parenth_args [line 1725]

string _parse_parenth_args(
string
$parenth_args)

parse arguments in function call parenthesis

Parameters:

string

$parenth_args

[ Top ]

method _parse_section_prop [line 1762]

string _parse_section_prop(
string
$section_prop_expr)

parse section property expression into PHP code

Parameters:

string

$section_prop_expr

[ Top ]

method _parse_var [line 1582]

string _parse_var(
string
$var_expr, string
$output)

parse variable expression into PHP code

Parameters:

string	$var_expr
string	$output

[ Top ]

method _parse_vars_props [line 1491]

void _parse_vars_props(

&$tokens, array
$tokens)

compile multiple variables and section properties tokens into PHP code

Parameters:

array	$tokens
	&$tokens

[ Top ]

method _parse_var_props [line 1506]

string _parse_var_props(
string
$val, string
$tag_attrs)

compile single variable and section properties token into PHP code

Parameters:

string	$val
string	$tag_attrs

[ Top ]

method _pop_cacheable_state [line 2090]

string _pop_cacheable_state(

$type, 
$name)

check if the compilation changes from non-cacheable to cacheable state with the end of the current plugin return php-code to reflect the transition.

Parameters:

	$type
	$name

[ Top ]

method _push_cacheable_state [line 2072]

string _push_cacheable_state(

$type, 
$name)

check if the compilation changes from cacheable to non-cacheable state with the beginning of the current plugin. return php-code to reflect the transition.

Parameters:

	$type
	$name

[ Top ]

method _quote_replace [line 2041]

string _quote_replace(
string
$string)

Quote subpattern references

Parameters:

string

$string

[ Top ]

method _syntax_error [line 2054]

void _syntax_error(
string
$error_msg, [integer
$error_type = E_USER_ERROR], [string
$file = null], [integer
$line = null])

display Smarty syntax error

Parameters:

string	$error_msg
integer	$error_type
string	$file
integer	$line

[ Top ]

Documentation generated on Sun, 30 Mar 2008 23:07:07 -0500 by phpDocumentor 1.4.2