Overview

Namespaces

  • Composer
    • Autoload
  • Geekwright
    • RegDom
  • League
    • OAuth2
      • Client
        • Provider
  • None
  • Xmf
    • Database
    • Jwt
    • Key
    • Module
      • Helper

Classes

  • ArtObject
  • ArtObjectHandler
  • BloggerApi
  • CGIF
  • CGIFCOLORTABLE
  • CGIFFILEHEADER
  • CGIFIMAGE
  • CGIFIMAGEHEADER
  • CGIFLZW
  • ComposerAutoloaderInit274e5fff219a4f27a346e611b0580d6a
  • Config_File
  • Cookie
  • Criteria
  • CriteriaCompo
  • CriteriaElement
  • Database
  • Db_manager
  • ErrorHandler
  • FormDhtmlTextArea
  • FormTextArea
  • HTMLPurifier
  • MetaWeblogApi
  • ModuleAdmin
  • MovableTypeApi
  • MyTextSanitizer
  • MyTextSanitizerExtended
  • MyTextSanitizerExtension
  • MytsCensor
  • MytsFlash
  • MytsIframe
  • MytsImage
  • MytsLi
  • MytsMms
  • MytsMp3
  • MytsRtsp
  • MytsSoundcloud
  • MytsSyntaxhighlight
  • MytsTextfilter
  • MytsUl
  • MytsWiki
  • MytsWmp
  • MytsYoutube
  • PathStuffController
  • PHPMailer
  • PHPMailerOAuth
  • PHPMailerOAuthGoogle
  • phpthumb
  • phpthumb_bmp
  • phpthumb_filters
  • phpthumb_functions
  • phpthumb_ico
  • phpUnsharpMask
  • PmCorePreload
  • PmMessage
  • PmMessageHandler
  • PmSystemPreload
  • POP3
  • ProfileCategory
  • ProfileCategoryHandler
  • ProfileCorePreload
  • ProfileField
  • ProfileFieldHandler
  • ProfileProfile
  • ProfileProfileHandler
  • ProfileRegstep
  • ProfileRegstepHandler
  • ProfileVisibility
  • ProfileVisibilityHandler
  • Protector
  • Protector_bruteforce_overrun_message
  • Protector_crawler_overrun_message
  • Protector_f5attack_overrun_message
  • Protector_postcommon_post_deny_by_httpbl
  • Protector_postcommon_post_deny_by_rbl
  • Protector_postcommon_post_htmlpurify4everyone
  • Protector_postcommon_post_htmlpurify4guest
  • Protector_postcommon_post_language_match
  • Protector_postcommon_post_need_multibyte
  • Protector_postcommon_post_register_moratorium
  • Protector_postcommon_post_stopforumspam
  • Protector_postcommon_register_insert_js_check
  • Protector_postcommon_register_stopforumspam
  • Protector_precommon_badip_errorlog
  • Protector_precommon_badip_message
  • Protector_precommon_badip_redirection
  • Protector_precommon_bwlimit_errorlog
  • Protector_precommon_bwlimit_message
  • Protector_prepurge_exit_message
  • Protector_spamcheck_overrun_message
  • ProtectorCorePreload
  • ProtectorFilterAbstract
  • ProtectorFilterHandler
  • ProtectorMySQLDatabase
  • ProtectorRegistry
  • ReCaptchaResponse
  • RpcArrayHandler
  • RpcBase64Handler
  • RpcBooleanHandler
  • RpcDateTimeHandler
  • RpcDoubleHandler
  • RpcIntHandler
  • RpcMemberHandler
  • RpcMethodNameHandler
  • RpcNameHandler
  • RpcStringHandler
  • RpcStructHandler
  • RpcValueHandler
  • RssAuthorHandler
  • RssCategoryHandler
  • RssChannelHandler
  • RssCommentsHandler
  • RssCopyrightHandler
  • RssDescriptionHandler
  • RssDocsHandler
  • RssGeneratorHandler
  • RssGuidHandler
  • RssHeightHandler
  • RssImageHandler
  • RssItemHandler
  • RssLanguageHandler
  • RssLastBuildDateHandler
  • RssLinkHandler
  • RssManagingEditorHandler
  • RssNameHandler
  • RssPubDateHandler
  • RssSourceHandler
  • RssTextInputHandler
  • RssTitleHandler
  • RssTtlHandler
  • RssUrlHandler
  • RssWebMasterHandler
  • RssWidthHandler
  • SaxParser
  • Smarty
  • Smarty_Compiler
  • SMTP
  • Snoopy
  • SqlUtility
  • SystemAvatar
  • SystemAvatarHandler
  • SystemBanner
  • SystemBannerclient
  • SystemBannerclientHandler
  • SystemBannerFinish
  • SystemBannerfinishHandler
  • SystemBannerHandler
  • SystemBlock
  • SystemBlockHandler
  • SystemBlockLinkModule
  • SystemBlockLinkModuleHandler
  • SystemBreadcrumb
  • SystemCorePreload
  • SystemFineAvatarUploadHandler
  • SystemFineImUploadHandler
  • SystemFineUploadHandler
  • SystemGroup
  • SystemGroupHandler
  • SystemMaintenance
  • SystemMenuHandler
  • SystemSmilies
  • SystemsmiliesHandler
  • SystemUserrank
  • SystemuserrankHandler
  • SystemUsers
  • SystemUsersHandler
  • Tar
  • ThemeSetAuthorHandler
  • ThemeSetDateCreatedHandler
  • ThemeSetDescriptionHandler
  • ThemeSetEmailHandler
  • ThemeSetFileTypeHandler
  • ThemeSetGeneratorHandler
  • ThemeSetImageHandler
  • ThemeSetLinkHandler
  • ThemeSetModuleHandler
  • ThemeSetNameHandler
  • ThemeSetTagHandler
  • ThemeSetTemplateHandler
  • TinyMCE
  • XmlTagHandler
  • XoopsApi
  • xoopsart
  • XoopsAuth
  • XoopsAuthAds
  • XoopsAuthFactory
  • XoopsAuthLdap
  • XoopsAuthProvisionning
  • XoopsAuthXoops
  • XoopsAvatar
  • XoopsAvatarHandler
  • XoopsBlock
  • XoopsBlockHandler
  • XoopsBlockInstance
  • XoopsBlockInstanceHandler
  • XoopsCache
  • XoopsCacheApc
  • XoopsCacheEngine
  • XoopsCacheFile
  • XoopsCacheMemcache
  • XoopsCacheModel
  • XoopsCacheModelHandler
  • XoopsCacheModelObject
  • XoopsCacheXcache
  • XoopsCaptcha
  • XoopsCaptchaImage
  • XoopsCaptchaImageHandler
  • XoopsCaptchaMethod
  • XoopsCaptchaRecaptcha
  • XoopsCaptchaRecaptcha2
  • XoopsCaptchaText
  • XoopsComment
  • XoopsCommentHandler
  • XoopsCommentRenderer
  • XoopsComments
  • XoopsConfigCategory
  • XoopsConfigCategoryHandler
  • XoopsConfigHandler
  • XoopsConfigItem
  • XoopsConfigItemHandler
  • XoopsConfigOption
  • XoopsConfigOptionHandler
  • XoopsDatabase
  • XoopsDatabaseFactory
  • XoopsDownloader
  • XoopsEditor
  • XoopsEditorHandler
  • XoopsErrorHandler
  • XoopsFile
  • XoopsFileHandler
  • XoopsFilterInput
  • XoopsFolderHandler
  • XoopsForm
  • XoopsFormButton
  • XoopsFormButtonTray
  • XoopsFormCaptcha
  • XoopsFormCheckBox
  • XoopsFormColorPicker
  • XoopsFormDateTime
  • XoopsFormDhtmlTextArea
  • XoopsFormEditor
  • XoopsFormElement
  • XoopsFormElementTray
  • XoopsFormFile
  • XoopsFormHidden
  • XoopsFormHiddenToken
  • XoopsFormLabel
  • XoopsFormPassword
  • XoopsFormRadio
  • XoopsFormRadioYN
  • XoopsFormRenderer
  • XoopsFormRendererBootstrap3
  • XoopsFormRendererLegacy
  • XoopsFormSelect
  • XoopsFormSelectCheckGroup
  • XoopsFormSelectCountry
  • XoopsFormSelectEditor
  • XoopsFormSelectGroup
  • XoopsFormSelectLang
  • XoopsFormSelectMatchOption
  • XoopsFormSelectTheme
  • XoopsFormSelectTimezone
  • XoopsFormSelectUser
  • XoopsFormText
  • XoopsFormTextArea
  • XoopsFormTextDateSelect
  • XoopsFormTinymce
  • XoopsGroup
  • XoopsGroupFormCheckBox
  • XoopsGroupHandler
  • XoopsGroupPerm
  • XoopsGroupPermForm
  • XoopsGroupPermHandler
  • XoopsGTicket
  • XoopsGuestUser
  • XoopsGuiDefault
  • XoopsGuiThadmin
  • XoopsGuiTransition
  • XoopsGuiZetadigme
  • XoopsHandlerRegistry
  • XoopsImage
  • XoopsImagecategory
  • XoopsImagecategoryHandler
  • XoopsImageHandler
  • XoopsImageSet
  • XoopsImagesetHandler
  • XoopsImagesetimg
  • XoopsImagesetimgHandler
  • XoopsInstallWizard
  • XoopsLists
  • XoopsLoad
  • XoopsLocal
  • XoopsLocalAbstract
  • XoopsLocalWrapper
  • XoopsLogger
  • XoopsMailer
  • XoopsMailerLocal
  • XoopsMediaUploader
  • XoopsMemberHandler
  • XoopsMembership
  • XoopsMembershipHandler
  • XoopsModelAbstract
  • XoopsModelFactory
  • XoopsModelJoint
  • XoopsModelRead
  • XoopsModelStats
  • XoopsModelSync
  • XoopsModelWrite
  • XoopsModule
  • XoopsModuleHandler
  • XoopsMultiMailer
  • XoopsMySQLDatabase
  • XoopsMySQLDatabaseProxy
  • XoopsMySQLDatabaseSafe
  • XoopsNotification
  • XoopsNotificationHandler
  • XoopsObject
  • XoopsObjectHandler
  • XoopsObjectTree
  • XoopsOnlineHandler
  • XoopsPageNav
  • XoopsPersistableObjectHandler
  • XoopsPreload
  • XoopsPreloadItem
  • XoopsPrivmessage
  • XoopsPrivmessageHandler
  • XoopsRank
  • XoopsRankHandler
  • XoopsRequest
  • XoopsSecurity
  • XoopsSessionHandler
  • XoopsSimpleForm
  • XoopsStory
  • XoopsSystemCpanel
  • XoopsSystemGui
  • XoopsTableForm
  • XoopsTarDownloader
  • XoopsThemeForm
  • XoopsThemeSetParser
  • XoopsTopic
  • XoopsTpl
  • XoopsTplfile
  • XoopsTplfileHandler
  • XoopsTplset
  • XoopsTplsetHandler
  • XoopsTree
  • XoopsUser
  • XoopsUserHandler
  • XoopsUserUtility
  • XoopsUtility
  • XoopsXmlRpcApi
  • XoopsXmlRpcArray
  • XoopsXmlRpcBase64
  • XoopsXmlRpcBoolean
  • XoopsXmlRpcDatetime
  • XoopsXmlRpcDocument
  • XoopsXmlRpcDouble
  • XoopsXmlRpcFault
  • XoopsXmlRpcInt
  • XoopsXmlRpcParser
  • XoopsXmlRpcRequest
  • XoopsXmlRpcResponse
  • XoopsXmlRpcString
  • XoopsXmlRpcStruct
  • XoopsXmlRpcTag
  • XoopsXmlRss2Parser
  • XoopsZipDownloader
  • xos_kernel_Xoops2
  • xos_logos_PageBuilder
  • xos_opal_AdminThemeFactory
  • xos_opal_Theme
  • xos_opal_ThemeFactory
  • XoUser
  • XoUserHandler
  • Zipfile

Interfaces

  • XoopsFormRendererInterface

Exceptions

  • phpmailerException

Functions

  • __autoload
  • _recaptcha_aes_encrypt
  • _recaptcha_aes_pad
  • _recaptcha_http_post
  • _recaptcha_mailhide_email_parts
  • _recaptcha_mailhide_urlbase64
  • _recaptcha_qsencode
  • _smarty_regex_replace_check
  • _smarty_sort_length
  • admin_refcheck
  • b_system_comments_edit
  • b_system_comments_show
  • b_system_info_edit
  • b_system_info_show
  • b_system_login_show
  • b_system_main_show
  • b_system_newmembers_edit
  • b_system_newmembers_show
  • b_system_notification_show
  • b_system_online_show
  • b_system_search_show
  • b_system_themes_edit
  • b_system_themes_show
  • b_system_topposters_edit
  • b_system_topposters_show
  • b_system_user_show
  • b_system_waiting_show
  • bannerstats
  • change_banner_url_by_client
  • checkEmail
  • clickbanner
  • clientlogin
  • closeTable
  • closeThread
  • CloseWaitBox
  • composerRequire274e5fff219a4f27a346e611b0580d6a
  • createConfigform
  • createThemeform
  • doConditionalGet
  • emailStats
  • exit404BadReq
  • fatalPhpErrorHandler
  • file_get_contents
  • file_put_contents
  • findSharp
  • form_user
  • formatTimestamp
  • formatURL
  • gd_info
  • genPathCheckHtml
  • get_request_method
  • get_writeoks_from_protector
  • getcss
  • getDbCharsets
  • getDbCollations
  • getDirList
  • getMailer
  • getTheme
  • gif_getSize
  • gif_loadFile
  • gif_loadFileToGDimageResource
  • gif_outputAsBmp
  • gif_outputAsJpeg
  • gif_outputAsPng
  • HTMLPurifier
  • imagealphablending
  • imageBrowser
  • imageCreateCorners
  • imageFilenameCheck
  • imagesavealpha
  • install_acceptUser
  • install_finalize
  • is_executable
  • kses
  • langDropdown
  • load_functions
  • load_object
  • load_objectHandler
  • loadModuleAdminMenu
  • make_cblock
  • make_data
  • make_groups
  • make_sidebar
  • mod_clearCacheFile
  • mod_clearConfg
  • mod_clearConfig
  • mod_clearFile
  • mod_clearSmartyCache
  • mod_constant
  • mod_createCacheFile
  • mod_createCacheFile_byGroup
  • mod_createFile
  • mod_DB_prefix
  • mod_fetchConfg
  • mod_fetchConfig
  • mod_generateCacheId
  • mod_generateCacheId_byGroup
  • mod_getDirname
  • mod_getIP
  • mod_getMysqlVersion
  • mod_getUnameFromId
  • mod_getUnameFromIds
  • mod_isModuleAction
  • mod_loadCacheFile
  • mod_loadCacheFile_byGroup
  • mod_loadConfg
  • mod_loadConfig
  • mod_loadFile
  • mod_loadFunctions
  • mod_loadRenderer
  • mod_message
  • modify_chmod
  • myTextForm
  • notificationCategoryInfo
  • notificationCommentCategoryInfo
  • notificationEnabled
  • notificationEventEnabled
  • notificationEventInfo
  • notificationEvents
  • notificationGenerateConfig
  • notificationSubscribableCategoryInfo
  • openTable
  • openThread
  • OpenWaitBox
  • PHPMailerAutoload
  • phpThumbURL
  • preg_quote
  • profile_getFieldForm
  • profile_getRegisterForm
  • profile_getStepForm
  • profile_getUserForm
  • profile_install_addCategory
  • profile_install_addField
  • profile_install_addStep
  • profile_install_initializeProfiles
  • profile_install_setPermissions
  • protector_message_append_oninstall
  • protector_message_append_onuninstall
  • protector_message_append_onupdate
  • protector_notify_base
  • protector_oninstall_base
  • protector_onuninstall_base
  • protector_onupdate_base
  • protector_postcommon
  • protector_prepare
  • recaptcha_check_answer
  • recaptcha_get_html
  • recaptcha_get_signup_url
  • recaptcha_mailhide_html
  • recaptcha_mailhide_url
  • redirect_header
  • RedirectToCachedFile
  • SendSaveAsFileHeaderIfNeeded
  • showbanner
  • showThread
  • smarty_block_textformat
  • smarty_compiler_assign
  • smarty_compiler_foreachq
  • smarty_compiler_includeq
  • smarty_compiler_xoAdminIcons
  • smarty_compiler_xoAdminNav
  • smarty_compiler_xoAppUrl
  • smarty_compiler_xoImgUrl
  • smarty_compiler_xoModuleIcons16
  • smarty_compiler_xoModuleIcons32
  • smarty_compiler_xoModuleIconsBookmarks
  • smarty_core_assemble_plugin_filepath
  • smarty_core_assign_smarty_interface
  • smarty_core_create_dir_structure
  • smarty_core_display_debug_console
  • smarty_core_get_include_path
  • smarty_core_get_microtime
  • smarty_core_get_php_resource
  • smarty_core_is_secure
  • smarty_core_is_trusted
  • smarty_core_load_plugins
  • smarty_core_load_resource_plugin
  • smarty_core_process_cached_inserts
  • smarty_core_process_compiled_include
  • smarty_core_read_cache_file
  • smarty_core_rm_auto
  • smarty_core_rmdir
  • smarty_core_run_insert_handler
  • smarty_core_smarty_include_php
  • smarty_core_write_cache_file
  • smarty_core_write_compiled_include
  • smarty_core_write_compiled_resource
  • smarty_core_write_file
  • smarty_function_assign_debug_info
  • smarty_function_block
  • smarty_function_config_load
  • smarty_function_counter
  • smarty_function_cycle
  • smarty_function_debug
  • smarty_function_escape_special_chars
  • smarty_function_eval
  • smarty_function_fetch
  • smarty_function_html_checkboxes
  • smarty_function_html_checkboxes_output
  • smarty_function_html_image
  • smarty_function_html_options
  • smarty_function_html_options_optgroup
  • smarty_function_html_options_optoutput
  • smarty_function_html_radios
  • smarty_function_html_radios_output
  • smarty_function_html_select_date
  • smarty_function_html_select_time
  • smarty_function_html_table
  • smarty_function_html_table_cycle
  • smarty_function_mailto
  • smarty_function_math
  • smarty_function_popup
  • smarty_function_popup_init
  • smarty_function_securityToken
  • smarty_function_xoInboxCount
  • smarty_function_xoMemberInfo
  • smarty_function_xoops_link
  • smarty_function_xoPageNav
  • smarty_make_timestamp
  • smarty_modifier_capitalize
  • smarty_modifier_capitalize_ucfirst
  • smarty_modifier_cat
  • smarty_modifier_count_characters
  • smarty_modifier_count_paragraphs
  • smarty_modifier_count_sentences
  • smarty_modifier_count_words
  • smarty_modifier_date_format
  • smarty_modifier_debug_print_var
  • smarty_modifier_default
  • smarty_modifier_escape
  • smarty_modifier_indent
  • smarty_modifier_lower
  • smarty_modifier_nl2br
  • smarty_modifier_regex_replace
  • smarty_modifier_replace
  • smarty_modifier_spacify
  • smarty_modifier_string_format
  • smarty_modifier_strip
  • smarty_modifier_strip_tags
  • smarty_modifier_truncate
  • smarty_modifier_upper
  • smarty_modifier_wordwrap
  • smarty_outputfilter_trimwhitespace
  • smarty_outputfilter_trimwhitespace_replace
  • smarty_resource_db_secure
  • smarty_resource_db_source
  • smarty_resource_db_timestamp
  • smarty_resource_db_tplinfo
  • smarty_resource_db_trusted
  • synchronize
  • system_AdminIcons
  • system_adminVersion
  • system_CleanVars
  • system_loadLanguage
  • system_loadTemplate
  • themecenterposts
  • update_system_v211
  • userCheck
  • userTimeToServerTime
  • validateDbCharset
  • writeLicenseKey
  • xoBuildLicenceKey
  • xoDiag
  • xoDiagBoolSetting
  • xoDiagIfWritable
  • xoFormBlockCollation
  • xoFormField
  • xoFormFieldCharset
  • xoFormFieldCollation
  • xoFormSelect
  • xoops_aw_decode
  • xoops_aw_encode
  • xoops_bin2hex
  • xoops_comment_count
  • xoops_comment_delete
  • xoops_confirm
  • xoops_convert_decode
  • xoops_convert_encode
  • xoops_convert_encoding
  • xoops_cp_footer
  • xoops_cp_header
  • xoops_error
  • xoops_footer
  • xoops_getActiveModules
  • xoops_getbanner
  • xoops_getBaseDomain
  • xoops_getConfigOption
  • xoops_getcss
  • xoops_getenv
  • xoops_getHandler
  • xoops_getLinkedUnameFromId
  • xoops_getMailer
  • xoops_getModuleHandler
  • xoops_getModuleOption
  • xoops_getOption
  • xoops_getrank
  • xoops_getUrlDomain
  • xoops_getUserTimestamp
  • xoops_groupperm_deletebymoditem
  • xoops_header
  • xoops_hex2bin
  • xoops_isActiveModule
  • xoops_ishexstr
  • xoops_load
  • xoops_load_lang_file
  • xoops_loadLanguage
  • xoops_local
  • xoops_makepass
  • xoops_message
  • xoops_module_activate
  • xoops_module_change
  • xoops_module_deactivate
  • xoops_module_delayed_clean_cache
  • xoops_module_get_admin_menu
  • xoops_module_gettemplate
  • xoops_module_install
  • xoops_module_install_pm
  • xoops_module_install_profile
  • xoops_module_log_header
  • xoops_module_uninstall
  • xoops_module_update
  • xoops_module_update_pm
  • xoops_module_update_profile
  • xoops_module_update_system
  • xoops_module_write_admin_menu
  • xoops_notification_deletebyitem
  • xoops_notification_deletebymodule
  • xoops_notification_deletebyuser
  • xoops_refcheck
  • xoops_result
  • xoops_setActiveModules
  • xoops_setConfigOption
  • xoops_substr
  • xoops_template_clear_module_cache
  • xoops_template_touch
  • xoops_trim
  • xoops_utf8_encode
  • xoops_write_index_file
  • xoopsCodeTarea
  • xoopseditor_get_rootpath
  • XoopsErrorHandler_HandleError
  • xoopsfwrite
  • xoopsSmilies
  • xoPassField
  • xoPhpVersion
  • xoPutLicenseKey
  • xoStripeKey
  • Overview
  • Namespace
  • Class
  • Tree

Class Smarty

Direct known subclasses

Smarty_Compiler, XoopsTpl
Package: Smarty
Copyright: 2001-2005 New Digital Group, Inc.
Author: Monte Ohrt
Author: Andrei Zmievski andrei@php.net
Located at lass/smarty/Smarty.class.php
Methods summary
public
# __construct( )

The class constructor.

The class constructor.

public
# assign( array|string $tpl_var, mixed $value = null )

assigns values to template variables

assigns values to template variables

Parameters

$tpl_var
the template variable name(s)
$value
the value to assign
public
# assign_by_ref( string $tpl_var, mixed & $value )

assigns values to template variables by reference

assigns values to template variables by reference

Parameters

$tpl_var
the template variable name
$value
the referenced value to assign
public
# append( array|string $tpl_var, mixed $value = null, $merge = false )

appends values to template variables

appends values to template variables

Parameters

$tpl_var
the template variable name(s)
$value
the value to append
$merge
public
# append_by_ref( string $tpl_var, mixed & $value, $merge = false )

appends values to template variables by reference

appends values to template variables by reference

Parameters

$tpl_var
the template variable name
$value
the referenced value to append
$merge
public
# clear_assign( string $tpl_var )

clear the given assigned template variable.

clear the given assigned template variable.

Parameters

$tpl_var
the template variable to clear
public
# register_function( string $function, string $function_impl, $cacheable = true, $cache_attrs = null )

Registers custom function to be used in templates

Registers custom function to be used in templates

Parameters

$function
the name of the template function
$function_impl
the name of the PHP function to register
$cacheable
$cache_attrs
public
# unregister_function( string $function )

Unregisters custom function

Unregisters custom function

Parameters

$function
name of template function
public
# register_object( string $object, object & $object_impl, null|array $allowed = array(), boolean $smarty_args = true, null|array $block_methods = array() )

Registers object to be used in templates

Registers object to be used in templates

Parameters

$object
name of template object
$object_impl
$object_impl the referenced PHP object to register
$allowed
list of allowed methods (empty = all)
$smarty_args
smarty argument format, else traditional
$block_methods
$block_functs list of methods that are block format
public
# unregister_object( string $object )

Unregisters object

Unregisters object

Parameters

$object
name of template object
public
# register_block( string $block, string $block_impl, $cacheable = true, $cache_attrs = null )

Registers block function to be used in templates

Registers block function to be used in templates

Parameters

$block
name of template block
$block_impl
PHP function to register
$cacheable
$cache_attrs
public
# unregister_block( string $block )

Unregisters block function

Unregisters block function

Parameters

$block
name of template function
public
# register_compiler_function( string $function, string $function_impl, $cacheable = true )

Registers compiler function

Registers compiler function

Parameters

$function
name of template function
$function_impl
name of PHP function to register
$cacheable
public
# unregister_compiler_function( string $function )

Unregisters compiler function

Unregisters compiler function

Parameters

$function
name of template function
public
# register_modifier( string $modifier, string $modifier_impl )

Registers modifier to be used in templates

Registers modifier to be used in templates

Parameters

$modifier
name of template modifier
$modifier_impl
name of PHP function to register
public
# unregister_modifier( string $modifier )

Unregisters modifier

Unregisters modifier

Parameters

$modifier
name of template modifier
public
# register_resource( string $type, array $functions )

Registers a resource to fetch a template

Registers a resource to fetch a template

Parameters

$type
name of resource
$functions
array of functions to handle resource
public
# unregister_resource( string $type )

Unregisters a resource

Unregisters a resource

Parameters

$type
name of resource
public
# register_prefilter( callable $function )

Registers a prefilter function to apply to a template before compiling

Registers a prefilter function to apply to a template before compiling

Parameters

$function
public
# unregister_prefilter( callable $function )

Unregisters a prefilter function

Unregisters a prefilter function

Parameters

$function
public
# register_postfilter( callable $function )

Registers a postfilter function to apply to a compiled template after compilation

Registers a postfilter function to apply to a compiled template after compilation

Parameters

$function
public
# unregister_postfilter( callable $function )

Unregisters a postfilter function

Unregisters a postfilter function

Parameters

$function
public
# register_outputfilter( callable $function )

Registers an output filter function to apply to a template output

Registers an output filter function to apply to a template output

Parameters

$function
public
# unregister_outputfilter( callable $function )

Unregisters an outputfilter function

Unregisters an outputfilter function

Parameters

$function
public
# load_filter( string $type, string $name )

load a filter of specified type and name

load a filter of specified type and name

Parameters

$type
filter type
$name
filter name
public boolean
# clear_cache( string $tpl_file = null, string $cache_id = null, string $compile_id = null, string $exp_time = null )

clear cached content for the given template and cache id

clear cached content for the given template and cache id

Parameters

$tpl_file
name of template file
$cache_id
name of cache_id
$compile_id
name of compile_id
$exp_time
expiration time

Returns

boolean
public boolean
# clear_all_cache( string $exp_time = null )

clear the entire contents of cache (all templates)

clear the entire contents of cache (all templates)

Parameters

$exp_time
expire time

Returns

boolean
results of smarty_core_rm_auto()
public string|false
# is_cached( string $tpl_file, string $cache_id = null, string $compile_id = null )

test to see if valid cache exists for this template

test to see if valid cache exists for this template

Parameters

$tpl_file
name of template file
$cache_id
$compile_id

Returns

string|false
results of _read_cache_file()
public
# clear_all_assign( )

clear all the assigned template variables.

clear all the assigned template variables.

public boolean
# clear_compiled_tpl( string $tpl_file = null, string $compile_id = null, string $exp_time = null )

clears compiled version of specified template resource, or all compiled template files if one is not specified. This function is for advanced use only, not normally needed.

clears compiled version of specified template resource, or all compiled template files if one is not specified. This function is for advanced use only, not normally needed.

Parameters

$tpl_file
$compile_id
$exp_time

Returns

boolean
results of smarty_core_rm_auto()
public boolean
# template_exists( string $tpl_file )

Checks whether requested template exists.

Checks whether requested template exists.

Parameters

$tpl_file

Returns

boolean
public array &
# get_template_vars( string $name = null, string $type,… )

Returns an array containing template variables

Returns an array containing template variables

Parameters

$name
$type,…

Returns

array
public array &
# get_config_vars( string $name = null, string $type,… )

Returns an array containing config variables

Returns an array containing config variables

Parameters

$name
$type,…

Returns

array
public
# trigger_error( string $error_msg, integer $error_type = E_USER_WARNING )

trigger Smarty error

trigger Smarty error

Parameters

$error_msg
$error_type
public
# display( string $resource_name, string $cache_id = null, string $compile_id = null )

executes & displays the template results

executes & displays the template results

Parameters

$resource_name
$cache_id
$compile_id
public
# fetch( string $resource_name, string $cache_id = null, string $compile_id = null, boolean $display = false )

executes & returns or displays the template results

executes & returns or displays the template results

Parameters

$resource_name
$cache_id
$compile_id
$display
public
# config_load( string $file, string $section = null, string $scope = 'global' )

load configuration values

load configuration values

Parameters

$file
$section
$scope
public object &
# get_registered_object( string $name )

return a reference to a registered object

return a reference to a registered object

Parameters

$name

Returns

object
public
# clear_config( string $var = null )

clear configuration values

clear configuration values

Parameters

$var
public string|false
# _get_plugin_filepath( string $type, string $name )

get filepath of requested plugin

get filepath of requested plugin

Parameters

$type
$name

Returns

string|false
public boolean
# _is_compiled( string $resource_name, string $compile_path )

test if resource needs compiling

test if resource needs compiling

Parameters

$resource_name
$compile_path

Returns

boolean
public boolean
# _compile_resource( string $resource_name, string $compile_path )

compile the template

compile the template

Parameters

$resource_name
$compile_path

Returns

boolean
public boolean
# _compile_source( string $resource_name, string & $source_content, string & $compiled_content, $cache_include_path = null )

compile the given source

compile the given source

Parameters

$resource_name
$source_content
$compiled_content
$cache_include_path

Returns

boolean
public string
# _get_compile_path( string $resource_name )

Get the compile path for this resource

Get the compile path for this resource

Parameters

$resource_name

Returns

string
results of Smarty::_get_auto_filename()
public boolean
# _fetch_resource_info( string & $params, string $source_content,…, integer $resource_timestamp,…, boolean $get_source,…, boolean $quiet,… )

fetch the template info. Gets timestamp, and source if get_source is true

fetch the template info. Gets timestamp, and source if get_source is true

sets $source_content to the source of the template, and $resource_timestamp to its time stamp

Parameters

$params
$resource_name
$source_content,…
$resource_timestamp,…
$get_source,…
$quiet,…

Returns

boolean
public boolean
# _parse_resource_name( string & $params, string $resource_name,…, string $resource_type,…, string $resource_name,… )

parse out the type and name from the resource

parse out the type and name from the resource

Parameters

$params
$resource_base_path
$resource_name,…
$resource_type,…
$resource_name,…

Returns

boolean
public string
# _run_mod_handler( string|null $modifier_name,…, array|null $map_array,… )

Handle modifiers

Handle modifiers

Parameters

$modifier_name,…
$map_array,…

Returns

string
result of modifiers
public string
# _dequote( string $string )

Remove starting and ending quotes from the string

Remove starting and ending quotes from the string

Parameters

$string

Returns

string
public string
# _read_file( string $filename )

read in a file

read in a file

Parameters

$filename

Returns

string
public string
# _get_auto_filename( string $auto_base, string $auto_source = null, string $auto_id = null )

get a concrete filename for automagically created content

get a concrete filename for automagically created content

Parameters

$auto_base
$auto_source
$auto_id

Returns

string
public
# _unlink( string $resource, integer $exp_time = null )

unlink a file, possibly using expiration time

unlink a file, possibly using expiration time

Parameters

$resource
$exp_time
public string|null
# _get_auto_id( string $cache_id = null, string $compile_id = null )

returns an auto_id for auto-file-functions

returns an auto_id for auto-file-functions

Parameters

$cache_id
$compile_id

Returns

string|null
public
# _trigger_fatal_error( string $error_msg, string $tpl_file = null, integer $tpl_line = null, string $file = null, integer $line = null, integer $error_type = E_USER_ERROR )

trigger Smarty plugin error

trigger Smarty plugin error

Parameters

$error_msg
$tpl_file
$tpl_line
$file
$line
$error_type
public string
# _process_compiled_include_callback( $match )

callback function for preg_replace, to call a non-cacheable block

callback function for preg_replace, to call a non-cacheable block

Returns

string
public
# _smarty_include( $params )
public array &
# _smarty_cache_attrs( $cache_serial, $count )

get or set an array of cached attributes for function that is not cacheable

get or set an array of cached attributes for function that is not cacheable

Returns

array
public mixed
# _include( $filename, $once = false, $params = null )

wrapper for include() retaining $this

wrapper for include() retaining $this

Returns

mixed
public mixed
# _eval( $code, $params = null )

wrapper for eval() retaining $this

wrapper for eval() retaining $this

Returns

mixed
public string
# _get_filter_name( callable $function )

Extracts the filter name from the given callback

Extracts the filter name from the given callback

Parameters

$function

Returns

string
Properties summary
public string $template_dir

The name of the directory where templates are located.

The name of the directory where templates are located.

# 'templates'
public string $compile_dir

The directory where compiled templates are located.

The directory where compiled templates are located.

# 'templates_c'
public string $config_dir

The directory where config files are located.

The directory where config files are located.

# 'configs'
public array $plugins_dir

An array of directories searched for plugins.

An array of directories searched for plugins.

# array('plugins')
public boolean $debugging

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

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

# false
public integer $error_reporting

When set, smarty does uses this value as error_reporting-level.

When set, smarty does uses this value as error_reporting-level.

# null
public string $debug_tpl

This is the path to the debug console template. If not set, the default one will be used.

This is the path to the debug console template. If not set, the default one will be used.

# ''
public string $debugging_ctrl

This determines if debugging is enable-able from the browser.

  • NONE => no debugging control allowed
  • URL => enable debugging when SMARTY_DEBUG is found in the URL.

This determines if debugging is enable-able from the browser.

  • NONE => no debugging control allowed
  • URL => enable debugging when SMARTY_DEBUG is found in the URL.

Link

http://www.foo.dom/index.php?SMARTY_DEBUG
# 'NONE'
public boolean $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. Typically you enable this during development, and disable for production.

This tells Smarty whether to check for recompiling or not. Recompiling does not need to happen unless a template or config file is changed. Typically you enable this during development, and disable for production.

# true
public boolean $force_compile

This forces templates to compile every time. Useful for development or debugging.

This forces templates to compile every time. Useful for development or debugging.

# false
public integer $caching

This enables template caching.

  • 0 = no caching
  • 1 = use class cache_lifetime value
  • 2 = use cache_lifetime in cache file

This enables template caching.

  • 0 = no caching
  • 1 = use class cache_lifetime value
  • 2 = use cache_lifetime in cache file
# 0
public string $cache_dir

The name of the directory for cache files.

The name of the directory for cache files.

# 'cache'
public integer $cache_lifetime

This is the number of seconds cached content will persist.

  • 0 = always regenerate cache
  • -1 = never expires

This is the number of seconds cached content will persist.

  • 0 = always regenerate cache
  • -1 = never expires
# 3600
public boolean $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. This way repeated hits to a cached page do not send the entire page to the client every time.

Only used when $caching is enabled. If true, then If-Modified-Since headers are respected with cached content, and appropriate HTTP headers are sent. This way repeated hits to a cached page do not send the entire page to the client every time.

# false
public integer $php_handling

This determines how Smarty handles "" tags in templates. possible values:

  • SMARTY_PHP_PASSTHRU -> print tags as plain text
  • SMARTY_PHP_QUOTE -> escape tags as entities
  • SMARTY_PHP_REMOVE -> remove php tags
  • SMARTY_PHP_ALLOW -> execute php tags

This determines how Smarty handles "" tags in templates. possible values:

  • SMARTY_PHP_PASSTHRU -> print tags as plain text
  • SMARTY_PHP_QUOTE -> escape tags as entities
  • SMARTY_PHP_REMOVE -> remove php tags
  • SMARTY_PHP_ALLOW -> execute php tags
# SMARTY_PHP_PASSTHRU
public boolean $security

This enables template security. When enabled, many things are restricted in the templates that normally would go unchecked. This is useful when untrusted parties are editing templates and you want a reasonable level of security. (no direct execution of PHP in templates for example)

This enables template security. When enabled, many things are restricted in the templates that normally would go unchecked. This is useful when untrusted parties are editing templates and you want a reasonable level of security. (no direct execution of PHP in templates for example)

# false
public array $secure_dir

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

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

# array()
public array $security_settings

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

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

# array( 'PHP_HANDLING' => false, 'IF_FUNCS' => array('array', 'list', 'isset', 'empty', 'count', 'sizeof', 'in_array', 'is_array', 'true', 'false', 'null'), 'INCLUDE_ANY' => false, 'PHP_TAGS' => false, 'MODIFIER_FUNCS' => array('count'), 'ALLOW_CONSTANTS' => false, 'ALLOW_SUPER_GLOBALS' => true )
public array $trusted_dir

This is an array of directories where trusted php scripts reside. Smarty::$security is disabled during their inclusion/execution.

This is an array of directories where trusted php scripts reside. Smarty::$security is disabled during their inclusion/execution.

# array()
public string $left_delimiter

The left delimiter used for the template tags.

The left delimiter used for the template tags.

# '{'
public string $right_delimiter

The right delimiter used for the template tags.

The right delimiter used for the template tags.

# '}'
public string $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

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

# 'EGPCS'
public boolean $request_use_auto_globals

Indicates wether $HTTP_VARS[] (request_use_auto_globals=false) are uses as request-vars or $[]-vars. note: if request_use_auto_globals is true, then $request_vars_order has no effect, but the php-ini-value "gpc_order"

Indicates wether $HTTP_VARS[] (request_use_auto_globals=false) are uses as request-vars or $[]-vars. note: if request_use_auto_globals is true, then $request_vars_order has no effect, but the php-ini-value "gpc_order"

# true
public string $compile_id

Set this if you want different sets of compiled files for the same templates. This is useful for things like different languages. Instead of creating separate sets of templates per language, you set different compile_ids like 'en' and 'de'.

Set this if you want different sets of compiled files for the same templates. This is useful for things like different languages. Instead of creating separate sets of templates per language, you set different compile_ids like 'en' and 'de'.

# null
public boolean $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.

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.

# false
public array $default_modifiers

This is a list of the modifiers to apply to all template variables. Put each modifier in a separate array element in the order you want them applied. example:

array('escape:"htmlall"');

This is a list of the modifiers to apply to all template variables. Put each modifier in a separate array element in the order you want them applied. example:

array('escape:"htmlall"');
# array()
public array $default_resource_type

This is the resource type to be used when not specified at the beginning of the resource path. examples: $smarty->display('file:index.tpl'); $smarty->display('db:index.tpl'); $smarty->display('index.tpl'); // will use default resource type {include file="file:index.tpl"} {include file="db:index.tpl"} {include file="index.tpl"} {* will use default resource type *}

This is the resource type to be used when not specified at the beginning of the resource path. examples: $smarty->display('file:index.tpl'); $smarty->display('db:index.tpl'); $smarty->display('index.tpl'); // will use default resource type {include file="file:index.tpl"} {include file="db:index.tpl"} {include file="index.tpl"} {* will use default resource type *}

# 'file'
public null|string $cache_handler_func

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

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

# null
public array $autoload_filters

This indicates which filters are automatically loaded into Smarty.

This indicates which filters are automatically loaded into Smarty.

# array()
public boolean $config_overwrite

This tells if config file vars of the same name overwrite each other or not. if disabled, same name variables are accumulated in an array.

This tells if config file vars of the same name overwrite each other or not. if disabled, same name variables are accumulated in an array.

# true
public boolean $config_booleanize

This tells whether or not to automatically booleanize config file variables. If enabled, then the strings "on", "true", and "yes" are treated as boolean true, and "off", "false" and "no" are treated as boolean false.

This tells whether or not to automatically booleanize config file variables. If enabled, then the strings "on", "true", and "yes" are treated as boolean true, and "off", "false" and "no" are treated as boolean false.

# true
public boolean $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.

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.

# false
public boolean $config_fix_newlines

This tells whether or not automatically fix newlines in config files. It basically converts \r (mac) or \r\n (dos) to \n

This tells whether or not automatically fix newlines in config files. It basically converts \r (mac) or \r\n (dos) to \n

# true
public string $default_template_handler_func

If a template cannot be found, this PHP function will be executed. Useful for creating templates on-the-fly or other special action.

If a template cannot be found, this PHP function will be executed. Useful for creating templates on-the-fly or other special action.

# ''
public string $compiler_file

The file that contains the compiler class. This can a full pathname, or relative to the php_include path.

The file that contains the compiler class. This can a full pathname, or relative to the php_include path.

# 'Smarty_Compiler.class.php'
public string $compiler_class

The class used for compiling templates.

The class used for compiling templates.

# 'Smarty_Compiler'
public string $config_class

The class used to load config vars.

The class used to load config vars.

# 'Config_File'
public array $_tpl_vars

where assigned template vars are kept

where assigned template vars are kept

# array()
public null|array $_smarty_vars

stores run-time $smarty.* vars

stores run-time $smarty.* vars

# null
public array $_sections

keeps track of sections

keeps track of sections

# array()
public array $_foreach

keeps track of foreach blocks

keeps track of foreach blocks

# array()
public array $_tag_stack

keeps track of tag hierarchy

keeps track of tag hierarchy

# array()
public Config_file $_conf_obj

configuration object

configuration object

# null
public array $_config

loaded configuration settings

loaded configuration settings

# array(array('vars' => array(), 'files' => array()))
public string $_smarty_md5

md5 checksum of the string 'Smarty'

md5 checksum of the string 'Smarty'

# 'f8d698aea36fcbead2b9d5359ffca76f'
public string $_version

Smarty version number

Smarty version number

# '2.6.30'
public integer $_inclusion_depth

current template inclusion depth

current template inclusion depth

# 0
public string $_compile_id

for different compiled templates

for different compiled templates

# null
public string $_smarty_debug_id

text in URL to enable debug mode

text in URL to enable debug mode

# 'SMARTY_DEBUG'
public array $_smarty_debug_info

debugging information for debug console

debugging information for debug console

# array()
public array $_cache_info

info that makes up a cache file

info that makes up a cache file

# array()
public integer $_file_perms

default file permissions

default file permissions

# 0644
public integer $_dir_perms

default dir permissions

default dir permissions

# 0771
public array $_reg_objects

registered objects

registered objects

# array()
public array $_plugins

table keeping track of plugins

table keeping track of plugins

# array( 'modifier' => array(), 'function' => array(), 'block' => array(), 'compiler' => array(), 'prefilter' => array(), 'postfilter' => array(), 'outputfilter' => array(), 'resource' => array(), 'insert' => array())
public array $_cache_serials

cache serials

cache serials

# array()
public string $_cache_include

name of optional cache include file

name of optional cache include file

# null
public string $_cache_including

indicate if the current code is used in a compiled include

indicate if the current code is used in a compiled include

# false
public array $_filepaths_cache

plugin filepath cache

plugin filepath cache

# array()
API documentation generated by ApiGen