Overview

Packages

  • akismet
  • None
  • PHP
  • Smarty
    • Cacher
    • Compiler
    • Config
    • Debug
    • plugins
    • PluginsBlock
    • PluginsFilter
    • PluginsFunction
    • PluginsInternal
    • PluginsModifier
    • PluginsModifierCompiler
    • PluginsShared
    • Security
    • Template
    • TemplateResources
  • Swift
    • ByteStream
    • CharacterStream
    • Encoder
    • Events
    • KeyCache
    • Mailer
    • Mime
    • Plugins
    • Signatures
    • Signed
    • Transport
  • wa-apps
    • blog
      • actions
        • backend
        • blog
        • comment
        • cron
        • design
        • frontend
        • page
        • plugin
        • post
      • api
        • v1
      • cli
      • layout
      • model
      • plugin
        • aksimet
        • category
        • emailsubscription
        • favorite
        • gravatar
        • import
        • markdown
        • myposts
        • tag
        • troll
      • settings
    • checklists
      • backend
      • json
    • contacts
      • backend
    • developer
    • dummy
    • guestbook
    • guestbook2
    • photos
      • album
      • api
        • v1
      • backend
      • design
      • dialog
      • frontend
      • page
      • photo
      • plugin
        • comment
        • imageeffects
        • import
        • publicgallery
        • watermark
      • search
      • settings
      • stack
      • tag
      • upload
    • site
      • backend
      • blocks
      • config
      • design
      • domains
      • files
      • frontend
      • helper
      • layout
      • pages
      • routing
      • setting
    • stickies
      • api
        • v1
      • sheet
      • stiky
  • wa-plugin
    • payment
    • shipping
    • sms
  • wa-plugins
    • shipping
      • usps
  • wa-system
    • API
    • Auth
      • Adapters
    • Autoload
    • Cache
      • Adapter
    • Captcha
    • Config
    • Contact
    • controller
    • currency
    • database
    • datetime
    • design
    • event
    • exception
    • files
    • image
    • layout
    • locale
    • log
    • mail
    • page
      • action
      • model
    • payment
    • plugin
    • request
    • response
    • routing
    • shipping
    • sms
    • storage
    • user
    • util
    • validator
    • view
    • webasyst
      • api
      • backend
      • cli
      • config
      • layout
      • login
      • model
      • password
      • payment
      • profile
      • settings
      • shipment
    • widget
    • workflow
  • waPlugins
    • Payment
  • webasyst
    • wa-system
      • helper

Classes

  • Smarty_Data
  • Smarty_Internal_Data
  • Smarty_Internal_Template
  • Smarty_Internal_TemplateBase
  • Smarty_Variable
  • Undefined_Smarty_Variable
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class Smarty_Internal_Data

Base class with template and variable methodes

Direct known subclasses

Smarty_Data, Smarty_Internal_Debug, Smarty_Internal_TemplateBase

Indirect known subclasses

Smarty, Smarty_Internal_Template
Package: Smarty\Template
Author: Uwe Tews
Located at wa-system/vendors/smarty3/sysplugins/smarty_internal_data.php
Methods summary
public Smarty_Internal_Data
# assign( array|string $tpl_var, mixed $value = null, boolean $nocache = false )

assigns a Smarty variable

assigns a Smarty variable

Parameters

$tpl_var
array|string
$tpl_var the template variable name(s)
$value
mixed
$value the value to assign
$nocache
boolean
$nocache if true any output of this variable will be not cached

Returns

Smarty_Internal_Data
current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining
public Smarty_Internal_Data
# assignGlobal( string $varname, mixed $value = null, boolean $nocache = false )

assigns a global Smarty variable

assigns a global Smarty variable

Parameters

$varname
string
$varname the global variable name
$value
mixed
$value the value to assign
$nocache
boolean
$nocache if true any output of this variable will be not cached

Returns

Smarty_Internal_Data
current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining
public Smarty_Internal_Data
# assignByRef( string $tpl_var, mixed & $value, boolean $nocache = false )

assigns values to template variables by reference

assigns values to template variables by reference

Parameters

$tpl_var
string
$tpl_var the template variable name
$value
mixed
$ &$value the referenced value to assign
$nocache
boolean
$nocache if true any output of this variable will be not cached

Returns

Smarty_Internal_Data
current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining
public Smarty_Internal_Data
# append( array|string $tpl_var, mixed $value = null, boolean $merge = false, boolean $nocache = false )

appends values to template variables

appends values to template variables

Parameters

$tpl_var
array|string
$tpl_var the template variable name(s)
$value
mixed
$value the value to append
$merge
boolean
$merge flag if array elements shall be merged
$nocache
boolean
$nocache if true any output of this variable will be not cached

Returns

Smarty_Internal_Data
current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining
public Smarty_Internal_Data
# appendByRef( string $tpl_var, mixed & $value, boolean $merge = false )

appends values to template variables by reference

appends values to template variables by reference

Parameters

$tpl_var
string
$tpl_var the template variable name
$value
mixed
&$value the referenced value to append
$merge
boolean
$merge flag if array elements shall be merged

Returns

Smarty_Internal_Data
current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining
public string
# getTemplateVars( string $varname = null, string $_ptr = null, boolean $search_parents = true )

Returns a single or all template variables

Returns a single or all template variables

Parameters

$varname
string
$varname variable name or null
$_ptr
string
$_ptr optional pointer to data object
$search_parents
boolean
$search_parents include parent templates?

Returns

string
variable value or or array of variables
public Smarty_Internal_Data
# clearAssign( string|array $tpl_var )

clear the given assigned template variable.

clear the given assigned template variable.

Parameters

$tpl_var
string|array
$tpl_var the template variable(s) to clear

Returns

Smarty_Internal_Data
current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining
public Smarty_Internal_Data
# clearAllAssign( )

clear all the assigned template variables.

clear all the assigned template variables.

Returns

Smarty_Internal_Data
current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining
public Smarty_Internal_Data
# configLoad( string $config_file, mixed $sections = null )

load a config file, optionally load just selected sections

load a config file, optionally load just selected sections

Parameters

$config_file
string
$config_file filename
$sections
mixed
$sections array of section names, single section or null

Returns

Smarty_Internal_Data
current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining
public object
# getVariable( string $variable, object $_ptr = null, boolean $search_parents = true, mixed $error_enable = true )

gets the object of a Smarty variable

gets the object of a Smarty variable

Parameters

$variable
string
$variable the name of the Smarty variable
$_ptr
object
$_ptr optional pointer to data object
$search_parents
boolean
$search_parents search also in parent data
$error_enable

Returns

object
the object of the variable
public mixed
# getConfigVariable( string $variable, mixed $error_enable = true )

gets a config variable

gets a config variable

Parameters

$variable
string
$variable the name of the config variable
$error_enable

Returns

mixed
the value of the config variable
public mixed
# getStreamVariable( string $variable )

gets a stream variable

gets a stream variable

Parameters

$variable
string
$variable the stream of the variable

Returns

mixed
the value of the stream variable
public string
# getConfigVars( string $varname = null, mixed $search_parents = true )

Returns a single or all config variables

Returns a single or all config variables

Parameters

$varname
string
$varname variable name or null
$search_parents

Returns

string
variable value or or array of variables
public Smarty_Internal_Data
# clearConfig( string $varname = null )

Deassigns a single or all config variables

Deassigns a single or all config variables

Parameters

$varname
string
$varname variable name or null

Returns

Smarty_Internal_Data
current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining
Properties summary
public string $template_class 'Smarty_Internal_Template'
#

name of class used for templates

name of class used for templates

public array $tpl_vars array()
#

template variables

template variables

public Smarty_Internal_Template $parent null
#

parent template (if any)

parent template (if any)

public array $config_vars array()
#

configuration settings

configuration settings

My fork of Webasyst Framework API documentation generated by ApiGen 2.8.0