Class Smarty_Compiler

(line 48)

Description

Smarty
   |
   --Smarty_Compiler

Located in File: /phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php

Template compiling class


Class Variables

Summary:

Class Constants

Summary:

Method Detail

Summary:
Smarty_Compiler Smarty_Compiler ()
void _add_plugin (string $type, string $name, [boolean? $delayed_loading = null])
void _compile_arg_list ( $type,  $name,  $attrs,  &$cache_code)
boolean _compile_block_tag (string $tag_command, string $tag_args, string $tag_modifier,  &$output, string $output)
string _compile_capture_tag (boolean $start, [string $tag_args = ''])
boolean _compile_compiler_tag (string $tag_command, string $tag_args,  &$output, string $output)
string _compile_custom_tag (string $tag_command, string $tag_args, string $tag_modifier)
true _compile_file (string $resource_name, string $source_content,  &$compiled_content, string $compiled_content)
string _compile_foreach_start (string $tag_args)
string _compile_if_tag (string $tag_args, [boolean $elseif = false])
string _compile_include_php_tag (string $tag_args)
string _compile_include_tag (string $tag_args)
string _compile_insert_tag (string $tag_args)
string _compile_plugin_call (string $type, string $name)
string _compile_registered_object_tag (string $tag_command, array $attrs, string $tag_modifier)
string _compile_section_start (string $tag_args)
string _compile_smarty_ref ( &$indexes, string $indexes)
string _compile_tag (string $template_tag)
string _expand_quoted_text (string $var_expr)
void _load_filters ()
array _parse_attrs (string $tag_args)
void _parse_conf_var (string $conf_var_expr)
array _parse_is_expr (string $is_arg, array $tokens)
void _parse_modifiers ( &$output, string $modifier_string, string $output)
string _parse_parenth_args (string $parenth_args)
string _parse_section_prop (string $section_prop_expr)
string _parse_var (string $var_expr, string $output)
void _parse_vars_props ( &$tokens, array $tokens)
string _parse_var_props (string $val, string $tag_attrs)
string _pop_cacheable_state ( $type,  $name)
string _push_cacheable_state ( $type,  $name)
string _quote_replace (string $string)
void _syntax_error (string $error_msg, [integer $error_type = E_USER_ERROR], [string $file = null], [integer $line = null])

Constructor Smarty_Compiler (line 95)

Smarty_Compiler Smarty_Compiler( )

The class constructor.

Info

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:

Info

Method _compile_arg_list (line 1306)

void _compile_arg_list( $type, $name, $attrs, &$cache_code)

Parameters

  • $type:
  • $name:
  • $attrs:
  • &$cache_code:

Info

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:

Info

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:

Info

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:

Info

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:

Info

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:

Info

Method _compile_foreach_start (line 1050)

string _compile_foreach_start( string $tag_args)

Compile {foreach ...} tag.

Parameters

  • string $tag_args:

Info

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

Info

Method _compile_include_php_tag (line 914)

string _compile_include_php_tag( string $tag_args)

Compile {include ...} tag

Parameters

  • string $tag_args:

Info

Method _compile_include_tag (line 861)

string _compile_include_tag( string $tag_args)

Compile {include ...} tag

Parameters

  • string $tag_args:

Info

Method _compile_insert_tag (line 827)

string _compile_insert_tag( string $tag_args)

Compile {insert ...} tag

Parameters

  • string $tag_args:

Info

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:

Info

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:

Info

Method _compile_section_start (line 945)

string _compile_section_start( string $tag_args)

Compile {section ...} tag

Parameters

  • string $tag_args:

Info

Method _compile_smarty_ref (line 1875)

string _compile_smarty_ref( &$indexes, string $indexes)

Compiles references of type $smarty.foo

Parameters

  • string $indexes:
  • &$indexes:

Info

Method _compile_tag (line 406)

string _compile_tag( string $template_tag)

Compile a template tag

Parameters

  • string $template_tag:

Info

Method _expand_quoted_text (line 1556)

string _expand_quoted_text( string $var_expr)

expand quoted text with embedded variables

Parameters

  • string $var_expr:

Info

Method _load_filters (line 2010)

void _load_filters( )

load pre- and post-filters

Info

Method _parse_attrs (line 1407)

array _parse_attrs( string $tag_args)

Parse attribute string

Parameters

  • string $tag_args:

Info

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:

Info

Method _parse_is_expr (line 1346)

array _parse_is_expr( string $is_arg, array $tokens)

Parse is expression

Parameters

  • string $is_arg:
  • array $tokens:

Info

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:

Info

Method _parse_parenth_args (line 1725)

string _parse_parenth_args( string $parenth_args)

parse arguments in function call parenthesis

Parameters

  • string $parenth_args:

Info

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:

Info

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:

Info

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:

Info

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:

Info

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:

Info

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:

Info

Method _quote_replace (line 2041)

string _quote_replace( string $string)

Quote subpattern references

Parameters

  • string $string:

Info

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:

Info

Inherited Variables

Inherited Class Variable Summary

Inherited From Class Smarty

Smarty::$autoload_filters - This indicates which filters are automatically loaded into Smarty.

Smarty::$cache_dir - The name of the directory for cache files.

Smarty::$cache_handler_func - The function used for cache file handling. If not set, built-in caching is used.

Smarty::$cache_lifetime - This is the number of seconds cached content will persist.

Smarty::$cache_modified_check - Only used when $caching is enabled. If true, then If-Modified-Since headers are respected with cached content, and appropriate HTTP headers are sent.

Smarty::$caching - This enables template caching.

Smarty::$compiler_class - The class used for compiling templates.

Smarty::$compiler_file - The file that contains the compiler class. This can a full pathname, or relative to the php_include path.

Smarty::$compile_check - This tells Smarty whether to check for recompiling or not. Recompiling does not need to happen unless a template or config file is changed.

Smarty::$compile_dir - The directory where compiled templates are located.

Smarty::$compile_id - Set this if you want different sets of compiled files for the same templates. This is useful for things like different languages.

Smarty::$config_booleanize - This tells whether or not to automatically booleanize config file variables.

Smarty::$config_class - The class used to load config vars.

Smarty::$config_dir - The directory where config files are located.

Smarty::$config_fix_newlines - This tells whether or not automatically fix newlines in config files.

Smarty::$config_overwrite - This tells if config file vars of the same name overwrite each other or not.

Smarty::$config_read_hidden - This tells whether hidden sections [.foobar] are readable from the tempalates or not. Normally you would never allow this since that is the point behind hidden sections: the application can access them, but the templates cannot.

Smarty::$debugging - If debugging is enabled, a debug console window will display when the page loads (make sure your browser allows unrequested popup windows)

Smarty::$debugging_ctrl - This determines if debugging is enable-able from the browser.

Smarty::$debug_tpl - This is the path to the debug console template. If not set, the default one will be used.

Smarty::$default_modifiers - This is a list of the modifiers to apply to all template variables.

Smarty::$default_resource_type - This is the resource type to be used when not specified

Smarty::$default_template_handler_func - If a template cannot be found, this PHP function will be executed.

Smarty::$force_compile - This forces templates to compile every time. Useful for development or debugging.

Smarty::$global_assign - These are the variables from the globals array that are assigned to all templates automatically. This isn't really necessary any more, you can use the $smarty var to access them directly.

Smarty::$left_delimiter - The left delimiter used for the template tags.

Smarty::$php_handling - This determines how Smarty handles "<?php ... ?>" tags in templates.

Smarty::$plugins_dir - An array of directories searched for plugins.

Smarty::$request_use_auto_globals - Indicates wether $HTTP_*_VARS[] (request_use_auto_globals=false)

Smarty::$request_vars_order - The order in which request variables are registered, similar to variables_order in php.ini E = Environment, G = GET, P = POST, C = Cookies, S = Server

Smarty::$right_delimiter - The right delimiter used for the template tags.

Smarty::$secure_dir - This is the list of template directories that are considered secure. This is used only if $security is enabled. One directory per array element. $template_dir is in this list implicitly.

Smarty::$security - This enables template security. When enabled, many things are restricted

Smarty::$security_settings - These are the security settings for Smarty. They are used only when $security is enabled.

Smarty::$template_dir - The name of the directory where templates are located.

Smarty::$trusted_dir - This is an array of directories where trusted php scripts reside.

Smarty::$undefined - The value of "undefined". Leave it alone :-)

Smarty::$use_sub_dirs - This tells Smarty whether or not to use sub dirs in the cache/ and templates_c/ directories. sub directories better organized, but may not work well with PHP safe mode enabled.

Inherited Methods

Inherited Method Summary

Inherited From 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



Documentation generated on Sat, 05 Sep 2009 16:23:09 -0500 by phpDocumentor 1.4.3