__ACTION__
__ACTION__ = __CONTROLLER__ . $depr . (defined('ACTION_ALIAS') ? ACTION_ALIAS : ACTION_NAME)
\
Namespaces
| Acme |
| Aura |
| Behavior |
| Boris |
| Cake |
| Composer |
| f4engine |
| Home |
| Monolog |
| Org |
| Psr |
| Think |
| Zend |
Interfaces
| HproseFilter |
Classes
| _PHPRPC_Client | |
| _smarty_code | Code fragment inside a tag. |
| _smarty_doublequoted | Double quoted string inside a tag. |
| _smarty_dq_content | Raw chars as part of a double quoted string. |
| _smarty_linebreak | template linebreaks |
| _smarty_parsetree | |
| _smarty_tag | A complete smarty tag. |
| _smarty_template_buffer | Template element |
| _smarty_text | template text |
| ComposerAutoloaderInit1ebeb28b74f217172f788faea0311dce | |
| config | |
| DHParams | |
| DumpTest | |
| ETCore | |
| HproseAbstractStream | |
| HproseBaseHttpClient | |
| HproseClassManager | |
| HproseClient | |
| HproseDate | |
| HproseDateTime | |
| HproseException | |
| HproseFileStream | |
| HproseFormatter | |
| HproseHttpClient | |
| HproseHttpServer | |
| HproseProcStream | |
| HproseProxy | |
| HproseRawReader | |
| HproseReader | |
| HproseResultMode | |
| HproseSimpleReader | |
| HproseSimpleWriter | |
| HproseStringStream | |
| HproseTags | |
| HproseTime | |
| HproseWriter | |
| IndentTest | |
| jsonRPCClient | The object of this class are generic jsonRPC 1.0 clients http://json-rpc.org/wiki/specification |
| jsonRPCServer | This class build a json-RPC Server 1.0 http://json-rpc.org/wiki/specification |
| ParseTest | |
| PHPRPC_Client | |
| PHPRPC_Date | |
| PHPRPC_Error | |
| PHPRPC_Server | |
| RoundTripTest | |
| SmartTemplate | SmartTemplate Class |
| SmartTemplateDebugger | SmartTemplateDebugger Class Used by SmartTemplate Class |
| SmartTemplateParser | SmartTemplateParser Class Used by SmartTemplate Class |
| Smarty | This is the main Smarty class |
| Smarty_CacheResource | Cache Handler API |
| Smarty_CacheResource_Custom | Cache Handler API |
| Smarty_CacheResource_KeyValueStore | Smarty Cache Handler Base for Key/Value Storage Implementations |
| Smarty_Config_Source | Smarty Resource Data Object |
| Smarty_Data | class for the Smarty data object |
| Smarty_Internal_CacheResource_File | This class does contain all necessary methods for the HTML cache on file system |
| Smarty_Internal_Compile_Append | Smarty Internal Plugin Compile Append Class |
| Smarty_Internal_Compile_Assign | Smarty Internal Plugin Compile Assign Class |
| Smarty_Internal_Compile_Block | Smarty Internal Plugin Compile Block Class |
| Smarty_Internal_Compile_Blockclose | Smarty Internal Plugin Compile BlockClose Class |
| Smarty_Internal_Compile_Break | Smarty Internal Plugin Compile Break Class |
| Smarty_Internal_Compile_Call | Smarty Internal Plugin Compile Function_Call Class |
| Smarty_Internal_Compile_Capture | Smarty Internal Plugin Compile Capture Class |
| Smarty_Internal_Compile_CaptureClose | Smarty Internal Plugin Compile Captureclose Class |
| Smarty_Internal_Compile_Config_Load | Smarty Internal Plugin Compile Config Load Class |
| Smarty_Internal_Compile_Continue | Smarty Internal Plugin Compile Continue Class |
| Smarty_Internal_Compile_Debug | Smarty Internal Plugin Compile Debug Class |
| Smarty_Internal_Compile_Else | Smarty Internal Plugin Compile Else Class |
| Smarty_Internal_Compile_Elseif | Smarty Internal Plugin Compile ElseIf Class |
| Smarty_Internal_Compile_Eval | Smarty Internal Plugin Compile Eval Class |
| Smarty_Internal_Compile_Extends | Smarty Internal Plugin Compile extend Class |
| Smarty_Internal_Compile_For | Smarty Internal Plugin Compile For Class |
| Smarty_Internal_Compile_Forclose | Smarty Internal Plugin Compile Forclose Class |
| Smarty_Internal_Compile_Foreach | Smarty Internal Plugin Compile Foreach Class |
| Smarty_Internal_Compile_Foreachclose | Smarty Internal Plugin Compile Foreachclose Class |
| Smarty_Internal_Compile_Foreachelse | Smarty Internal Plugin Compile Foreachelse Class |
| Smarty_Internal_Compile_Forelse | Smarty Internal Plugin Compile Forelse Class |
| Smarty_Internal_Compile_Function | Smarty Internal Plugin Compile Function Class |
| Smarty_Internal_Compile_Functionclose | Smarty Internal Plugin Compile Functionclose Class |
| Smarty_Internal_Compile_If | Smarty Internal Plugin Compile If Class |
| Smarty_Internal_Compile_Ifclose | Smarty Internal Plugin Compile Ifclose Class |
| Smarty_Internal_Compile_Include | Smarty Internal Plugin Compile Include Class |
| Smarty_Internal_Compile_Include_Php | Smarty Internal Plugin Compile Insert Class |
| Smarty_Internal_Compile_Insert | Smarty Internal Plugin Compile Insert Class |
| Smarty_Internal_Compile_Ldelim | Smarty Internal Plugin Compile Ldelim Class |
| Smarty_Internal_Compile_Nocache | Smarty Internal Plugin Compile Nocache Classv |
| Smarty_Internal_Compile_Nocacheclose | Smarty Internal Plugin Compile Nocacheclose Class |
| Smarty_Internal_Compile_Private_Block_Plugin | Smarty Internal Plugin Compile Block Plugin Class |
| Smarty_Internal_Compile_Private_Function_Plugin | Smarty Internal Plugin Compile Function Plugin Class |
| Smarty_Internal_Compile_Private_Modifier | Smarty Internal Plugin Compile Modifier Class |
| Smarty_Internal_Compile_Private_Object_Block_Function | Smarty Internal Plugin Compile Object Block Function Class |
| Smarty_Internal_Compile_Private_Object_Function | Smarty Internal Plugin Compile Object Function Class |
| Smarty_Internal_Compile_Private_Print_Expression | Smarty Internal Plugin Compile Print Expression Class |
| Smarty_Internal_Compile_Private_Registered_Block | Smarty Internal Plugin Compile Registered Block Class |
| Smarty_Internal_Compile_Private_Registered_Function | Smarty Internal Plugin Compile Registered Function Class |
| Smarty_Internal_Compile_Private_Special_Variable | Smarty Internal Plugin Compile special Smarty Variable Class |
| Smarty_Internal_Compile_Rdelim | Smarty Internal Plugin Compile Rdelim Class |
| Smarty_Internal_Compile_Section | Smarty Internal Plugin Compile Section Class |
| Smarty_Internal_Compile_Sectionclose | Smarty Internal Plugin Compile Sectionclose Class |
| Smarty_Internal_Compile_Sectionelse | Smarty Internal Plugin Compile Sectionelse Class |
| Smarty_Internal_Compile_Setfilter | Smarty Internal Plugin Compile Setfilter Class |
| Smarty_Internal_Compile_Setfilterclose | Smarty Internal Plugin Compile Setfilterclose Class |
| Smarty_Internal_Compile_While | Smarty Internal Plugin Compile While Class |
| Smarty_Internal_Compile_Whileclose | Smarty Internal Plugin Compile Whileclose Class |
| Smarty_Internal_CompileBase | This class does extend all internal compile plugins |
| Smarty_Internal_Config | Smarty Internal Plugin Config |
| Smarty_Internal_Config_File_Compiler | Main config file compiler class |
| Smarty_Internal_Configfilelexer | Smarty Internal Plugin Configfilelexer |
| Smarty_Internal_Configfileparser | |
| Smarty_Internal_Data | Base class with template and variable methodes |
| Smarty_Internal_Debug | Smarty Internal Plugin Debug Class |
| Smarty_Internal_Filter_Handler | Class for filter processing |
| Smarty_Internal_Function_Call_Handler | This class does call function defined with the {function} tag |
| Smarty_Internal_Get_Include_Path | Smarty Internal Read Include Path Class |
| Smarty_Internal_Nocache_Insert | Smarty Internal Plugin Compile Insert Class |
| Smarty_Internal_Resource_Eval | Smarty Internal Plugin Resource Eval |
| Smarty_Internal_Resource_Extends | Smarty Internal Plugin Resource Extends |
| Smarty_Internal_Resource_File | Smarty Internal Plugin Resource File |
| Smarty_Internal_Resource_PHP | Smarty Internal Plugin Resource PHP |
| Smarty_Internal_Resource_Registered | Smarty Internal Plugin Resource Registered |
| Smarty_Internal_Resource_Stream | Smarty Internal Plugin Resource Stream |
| Smarty_Internal_Resource_String | Smarty Internal Plugin Resource String |
| Smarty_Internal_SmartyTemplateCompiler | Class SmartyTemplateCompiler |
| Smarty_Internal_Template | Main class with template data structures and methods |
| Smarty_Internal_TemplateBase | Class with shared template methodes |
| Smarty_Internal_TemplateCompilerBase | Main abstract compiler class |
| Smarty_Internal_Templatelexer | Smarty Internal Plugin Templatelexer |
| Smarty_Internal_Templateparser | |
| Smarty_Internal_Utility | Utility class |
| Smarty_Internal_Write_File | Smarty Internal Write File Class |
| Smarty_Resource | Smarty Resource Plugin |
| Smarty_Resource_Custom | Smarty Resource Plugin |
| Smarty_Resource_Recompiled | Smarty Resource Plugin |
| Smarty_Resource_Uncompiled | Smarty Resource Plugin |
| Smarty_Security | This class does contain the security settings |
| Smarty_Template_Cached | Smarty Resource Data Object |
| Smarty_Template_Compiled | Smarty Resource Data Object |
| Smarty_Template_Source | Smarty Resource Data Object |
| Smarty_Variable | class for the Smarty variable object |
| SmartyBC | Smarty Backward Compatability Wrapper Class |
| SmartyCompilerException | Smarty compiler exception class |
| SmartyException | Smarty exception class |
| Spyc | The Simple PHP YAML Class. |
| template | |
| Template_Lite | |
| Template_Lite_Compiler | |
| TP_yyStackEntry | |
| TP_yyToken | Smarty Internal Plugin Templateparser |
| TPC_yyStackEntry | |
| TPC_yyToken | Smarty Internal Plugin Configfileparser |
| Undefined_Smarty_Variable | class for undefined variable object |
Constants
Functions
__()
__(string $singular, array $args) : string|null
Returns a translated string if one is found; Otherwise, the submitted message.
Parameters
| string | $singular | Text to translate. |
| array | $args | Array with arguments or multiple arguments in function. |
Returns
string|null —The translated text, or null if invalid.
__d()
__d(string $domain, string $msg, array $args) : string|null
Allows you to override the current domain for a single message lookup.
Parameters
| string | $domain | Domain. |
| string | $msg | String to translate. |
| array | $args | Array with arguments or multiple arguments in function. |
Returns
string|null —Translated string.
__dn()
__dn(string $domain, string $singular, string $plural, integer $count, array $args) : string|null
Allows you to override the current domain for a single plural message lookup.
Returns correct plural form of message identified by $singular and $plural for count $count from domain $domain.
Parameters
| string | $domain | Domain. |
| string | $singular | Singular string to translate. |
| string | $plural | Plural. |
| integer | $count | Count. |
| array | $args | Array with arguments or multiple arguments in function. |
Returns
string|null —Plural form of translated string.
__dx()
__dx(string $domain, string $context, string $msg, array $args) : string|null
Allows you to override the current domain for a single message lookup.
The context is a unique identifier for the translations string that makes it unique within the same domain.
Parameters
| string | $domain | Domain. |
| string | $context | Context of the text. |
| string | $msg | String to translate. |
| array | $args | Array with arguments or multiple arguments in function. |
Returns
string|null —Translated string.
__dxn()
__dxn(string $domain, string $context, string $singular, string $plural, integer $count, array $args) : string|null
Returns correct plural form of message identified by $singular and $plural for count $count.
Allows you to override the current domain for a single message lookup. The context is a unique identifier for the translations string that makes it unique within the same domain.
Parameters
| string | $domain | Domain. |
| string | $context | Context of the text. |
| string | $singular | Singular text to translate. |
| string | $plural | Plural text. |
| integer | $count | Count. |
| array | $args | Array with arguments or multiple arguments in function. |
Returns
string|null —Plural form of translated string.
__n()
__n(string $singular, string $plural, integer $count, array $args) : string|null
Returns correct plural form of message identified by $singular and $plural for count $count.
Some languages have more than one form for plural messages dependent on the count.
Parameters
| string | $singular | Singular text to translate. |
| string | $plural | Plural text. |
| integer | $count | Count. |
| array | $args | Array with arguments or multiple arguments in function. |
Returns
string|null —Plural form of translated string, or null if invalid.
__x()
__x(string $context, string $singular, array $args) : string|null
Returns a translated string if one is found; Otherwise, the submitted message.
The context is a unique identifier for the translations string that makes it unique within the same domain.
Parameters
| string | $context | Context of the text. |
| string | $singular | Text to translate. |
| array | $args | Array with arguments or multiple arguments in function. |
Returns
string|null —Translated string.
__xn()
__xn(string $context, string $singular, string $plural, integer $count, array $args) : string|null
Returns correct plural form of message identified by $singular and $plural for count $count.
Some languages have more than one form for plural messages dependent on the count. The context is a unique identifier for the translations string that makes it unique within the same domain.
Parameters
| string | $context | Context of the text. |
| string | $singular | Singular text to translate. |
| string | $plural | Plural text. |
| integer | $count | Count. |
| array | $args | Array with arguments or multiple arguments in function. |
Returns
string|null —Plural form of translated string.
A()
A(string $name, string $layer = '', integer $level) : \Think\Controller|false
实例化多层控制器 格式：[资源://][模块/]控制器
Parameters
| string | $name | 资源地址 |
| string | $layer | 控制层名称 |
| integer | $level | 控制器层次 |
Returns
\Think\Controller|falseA()
A(string $name, string $layer = '') : \Think\Controller|false
实例化多层控制器 格式：[资源://][模块/]控制器
Parameters
| string | $name | 资源地址 |
| string | $layer | 控制层名称 |
Returns
\Think\Controller|falsecollection()
collection(\Traversable|array $items) : \Cake\Collection\Collection
Returns a new Cake\Collection\Collection object wrapping the passed argument.
Parameters
| \Traversable|array | $items | The items from which the collection will be built. |
Returns
\Cake\Collection\Collectioncontroller()
controller(string $name) : \Think\Controller|false
用于实例化访问控制器
Parameters
| string | $name | 控制器名 |
Returns
\Think\Controller|falsecontroller()
controller(string $name, string $path = '') : \Think\Controller|false
用于实例化访问控制器
Parameters
| string | $name | 控制器名 |
| string | $path | 控制器命名空间（路径） |
Returns
\Think\Controller|falseD()
D(string $name = '', string $layer = '') : \Think\Model
实例化模型类 格式 [资源://][模块/]模型
Parameters
| string | $name | 资源地址 |
| string | $layer | 模型层名称 |
Returns
\Think\ModelD()
D(string $name = '', string $layer = '') : \Think\Model
实例化模型类 格式 [资源://][模块/]模型
Parameters
| string | $name | 资源地址 |
| string | $layer | 模型层名称 |
Returns
\Think\Modeldd()
dd(mixed $var, boolean|null $showHtml = null) : void
Prints out debug information about given variable and dies.
Only runs if debug mode is enabled. It will otherwise just continue code execution and ignore this function.
Parameters
| mixed | $var | Variable to show debug information for. |
| boolean|null | $showHtml | If set to true, the method prints the debug data in a browser-friendly way. |
debug()
debug(mixed $var, boolean|null $showHtml = null, boolean $showFrom = true) : mixed
Prints out debug information about given variable and returns the variable that was passed.
Only runs if debug mode is enabled.
Parameters
| mixed | $var | Variable to show debug information for. |
| boolean|null | $showHtml | If set to true, the method prints the debug data in a browser-friendly way. |
| boolean | $showFrom | If set to true, the method prints from where the function was called. |
Returns
mixed —The same $var that was passed
deprecationWarning()
deprecationWarning(string $message, integer $stackFrame = 1) : void
Helper method for outputting deprecation warnings
Parameters
| string | $message | The message to output as a deprecation warning. |
| integer | $stackFrame | The stack frame to include in the error. Defaults to 1 as that should point to application/plugin code. |
env()
env(string $key, string|null $default = null) : string|boolean|null
Gets an environment variable from available sources, and provides emulation for unsupported or inconsistent environment variables (i.e. DOCUMENT_ROOT on IIS, or SCRIPT_NAME in CGI mode). Also exposes some additional custom environment information.
Parameters
| string | $key | Environment variable name. |
| string|null | $default | Specify a default value in case the environment variable is not defined. |
Returns
string|boolean|null —Environment variable setting.
G()
G(string $start, string $end = '', integer|string $dec = 4) : mixed
记录和统计时间（微秒）和内存使用情况 使用方法: <code> G('begin'); // 记录开始标记位 // .
.. 区间运行代码 G('end'); // 记录结束标签位 echo G('begin','end',6); // 统计区间运行时间 精确到小数后6位 echo G('begin','end','m'); // 统计区间内存使用情况 如果end标记位没有定义，则会自动以当前作为标记位 其中统计内存使用需要 MEMORY_LIMIT_ON 常量为true才有效
Parameters
| string | $start | 开始标签 |
| string | $end | 结束标签 |
| integer|string | $dec | 小数位或者m |
Returns
mixedG()
G(string $start, string $end = '', integer|string $dec = 4) : mixed
记录和统计时间（微秒）和内存使用情况 使用方法: <code> G('begin'); // 记录开始标记位 // .
.. 区间运行代码 G('end'); // 记录结束标签位 echo G('begin','end',6); // 统计区间运行时间 精确到小数后6位 echo G('begin','end','m'); // 统计区间内存使用情况 如果end标记位没有定义，则会自动以当前作为标记位 其中统计内存使用需要 MEMORY_LIMIT_ON 常量为true才有效
Parameters
| string | $start | 开始标签 |
| string | $end | 结束标签 |
| integer|string | $dec | 小数位或者m |
Returns
mixedG()
G(string $start, string $end = '', integer|string $dec = 4) : mixed
记录和统计时间（微秒）和内存使用情况 使用方法: <code> G('begin'); // 记录开始标记位 // .
.. 区间运行代码 G('end'); // 记录结束标签位 echo G('begin','end',6); // 统计区间运行时间 精确到小数后6位 echo G('begin','end','m'); // 统计区间内存使用情况 如果end标记位没有定义，则会自动以当前作为标记位 其中统计内存使用需要 MEMORY_LIMIT_ON 常量为true才有效
Parameters
| string | $start | 开始标签 |
| string | $end | 结束标签 |
| integer|string | $dec | 小数位或者m |
Returns
mixedh()
h(mixed $text, boolean $double = true, string|null $charset = null) : mixed
Convenience method for htmlspecialchars.
Parameters
| mixed | $text | Text to wrap through htmlspecialchars. Also works with arrays, and objects.
Arrays will be mapped and have all their elements escaped. Objects will be string cast if they
implement a |
| boolean | $double | Encode existing html entities. |
| string|null | $charset | Character set to use when escaping. Defaults to config value in |
Returns
mixed —Wrapped text.
I()
I(string $name, mixed $default = '', mixed $filter = null, mixed $datas = null) : mixed
获取输入参数 支持过滤和默认值 使用方法: <code> I('id',0); 获取id参数 自动判断get或者post I('post.name','','htmlspecialchars'); 获取$_POST['name'] I('get.'); 获取$_GET </code>
Parameters
| string | $name | 变量的名称 支持指定类型 |
| mixed | $default | 不存在的时候默认值 |
| mixed | $filter | 参数过滤方法 |
| mixed | $datas | 要获取的额外数据源 |
Returns
mixedI()
I(string $name, mixed $default = '', mixed $filter = null, mixed $datas = null) : mixed
获取输入参数 支持过滤和默认值 使用方法: <code> I('id',0); 获取id参数 自动判断get或者post I('post.name','','htmlspecialchars'); 获取$_POST['name'] I('get.'); 获取$_GET </code>
Parameters
| string | $name | 变量的名称 支持指定类型 |
| mixed | $default | 不存在的时候默认值 |
| mixed | $filter | 参数过滤方法 |
| mixed | $datas | 要获取的额外数据源 |
Returns
mixedI()
I(string $name, mixed $default = '', mixed $filter = null, mixed $datas = null) : mixed
获取输入参数 支持过滤和默认值 使用方法: <code> I('id',0); 获取id参数 自动判断get或者post I('post.name','','htmlspecialchars'); 获取$_POST['name'] I('get.'); 获取$_GET </code>
Parameters
| string | $name | 变量的名称 支持指定类型 |
| mixed | $default | 不存在的时候默认值 |
| mixed | $filter | 参数过滤方法 |
| mixed | $datas | 要获取的额外数据源 |
Returns
mixedM()
M(string $name = '', string $tablePrefix = '', mixed $connection = '') : \Think\Model
实例化一个没有模型文件的Model
Parameters
| string | $name | Model名称 支持指定基础模型 例如 MongoModel:User |
| string | $tablePrefix | 表前缀 |
| mixed | $connection | 数据库连接信息 |
Returns
\Think\ModelM()
M(string $name = '', string $tablePrefix = '', mixed $connection = '') : \Think\Model
实例化一个没有模型文件的Model
Parameters
| string | $name | Model名称 支持指定基础模型 例如 MongoModel:User |
| string | $tablePrefix | 表前缀 |
| mixed | $connection | 数据库连接信息 |
Returns
\Think\ModelnamespaceSplit()
namespaceSplit(string $class) : array
Split the namespace from the classname.
Commonly used like list($namespace, $className) = namespaceSplit($class);.
Parameters
| string | $class | The full class name, ie |
Returns
array —Array with 2 indexes. 0 => namespace, 1 => classname.
pj()
pj(mixed $var) : mixed
json pretty print convenience function.
In terminals this will act similar to using json_encode() with JSON_PRETTY_PRINT directly, when not run on cli will also wrap
tags around the output of given variable. Similar to pr().This function returns the same variable that was passed.
Parameters
| mixed | $var | Variable to print out. |
Returns
mixed —the same $var that was passed to this function
pluginSplit()
pluginSplit(string $name, boolean $dotAppend = false, string|null $plugin = null) : array
Splits a dot syntax plugin name into its plugin and class name.
If $name does not have a dot, then index 0 will be null.
Commonly used like
list($plugin, $name) = pluginSplit($name);Parameters
| string | $name | The name you want to plugin split. |
| boolean | $dotAppend | Set to true if you want the plugin to have a '.' appended to it. |
| string|null | $plugin | Optional default plugin to use if no plugin is found. Defaults to null. |
Returns
array —Array with 2 indexes. 0 => plugin name, 1 => class name.
pr()
pr(mixed $var) : mixed
print_r() convenience function.
In terminals this will act similar to using print_r() directly, when not run on cli print_r() will also wrap
tags around the output of given variable. Similar to debug().This function returns the same variable that was passed.
Parameters
| mixed | $var | Variable to print out. |
Returns
mixed —the same $var that was passed to this function
smarty_block_textformat()
smarty_block_textformat(array $params, string $content, \Smarty_Internal_Template $template, $repeat) : string
Smarty {textformat}{/textformat} block plugin
Type: block function
Name: textformat
Purpose: format text a certain way with preset styles
or custom wrap/indent settings
Params:
- style - string (email)
- indent - integer (0)
- wrap - integer (80)
- wrap_char - string ("\n")
- indent_char - string (" ")
- wrap_boundary - boolean (true)
Parameters
| array | $params | parameters |
| string | $content | contents of the block |
| \Smarty_Internal_Template | $template | template object |
| $repeat |
Returns
string —content re-formatted
smarty_function_counter()
smarty_function_counter(array $params, \Smarty_Internal_Template $template) : string|null
Smarty {counter} function plugin
Type: function
Name: counter
Purpose: print out a counter value
Parameters
| array | $params | parameters |
| \Smarty_Internal_Template | $template | template object |
Returns
string|nullsmarty_function_cycle()
smarty_function_cycle(array $params, \Smarty_Internal_Template $template) : string|null
Smarty {cycle} function plugin
Type: function
Name: cycle
Date: May 3, 2002
Purpose: cycle through given values
Params:
- name - name of cycle (optional)
- values - comma separated list of values to cycle, or an array of values to cycle
(this can be left out for subsequent calls)
- reset - boolean - resets given var to true
- print - boolean - print var or not. default is true
- advance - boolean - whether or not to advance the cycle
- delimiter - the value delimiter, default is ","
- assign - boolean, assigns to template var instead of printed.
Examples:
{cycle values="#eeeeee,#d0d0d0d"}
{cycle name=row values="one,two,three" reset=true}
{cycle name=row}
Parameters
| array | $params | parameters |
| \Smarty_Internal_Template | $template | template object |
Returns
string|nullsmarty_function_escape_special_chars()
smarty_function_escape_special_chars(string $string) : string
escape_special_chars common function
Function: smarty_function_escape_special_chars
Purpose: used by other smarty functions to escape
special chars except for already escaped ones
Parameters
| string | $string | text that should by escaped |
Returns
stringsmarty_function_fetch()
smarty_function_fetch(array $params, \Smarty_Internal_Template $template) : string|null
Smarty {fetch} plugin
Type: function
Name: fetch
Purpose: fetch file, web or ftp data and display results
Parameters
| array | $params | parameters |
| \Smarty_Internal_Template | $template | template object |
Returns
string|null —if the assign parameter is passed, Smarty assigns the result to a template variable
smarty_function_html_checkboxes()
smarty_function_html_checkboxes(array $params, object $template) : string
Smarty {html_checkboxes} function plugin
File: function.html_checkboxes.php
Type: function
Name: html_checkboxes
Date: 24.Feb.2003
Purpose: Prints out a list of checkbox input types
Examples:
{html_checkboxes values=$ids output=$names}
{html_checkboxes values=$ids name='box' separator='
' output=$names}
{html_checkboxes values=$ids checked=$checked separator='
' output=$names}
Params:
- name (optional) - string default "checkbox" - values (required) - array - options (optional) - associative array - checked (optional) - array default not set - separator (optional) - ie
or - output (optional) - the output next to each checkbox - assign (optional) - assign the output as an array to this variable - escape (optional) - escape the content (not value), defaults to true
Parameters
| array | $params | parameters |
| object | $template | template object |
Returns
stringsmarty_function_html_image()
smarty_function_html_image(array $params, \Smarty_Internal_Template $template) : string
Smarty {html_image} function plugin
Type: function
Name: html_image
Date: Feb 24, 2003
Purpose: format HTML tags for the image
Examples: {html_image file="/images/masthead.gif"}
Output: 
Params:
- file - (required) - file (and path) of image - height - (optional) - image height (default actual height) - width - (optional) - image width (default actual width) - basedir - (optional) - base directory for absolute paths, default is environment variable DOCUMENT_ROOT - path_prefix - prefix for path output (optional, default empty)
Parameters
| array | $params | parameters |
| \Smarty_Internal_Template | $template | template object |
Returns
stringsmarty_function_html_options()
smarty_function_html_options(array $params, \Smarty_Internal_Template $template) : string
Smarty {html_options} function plugin
Type: function
Name: html_options
Purpose: Prints the list of
- name (optional) - string default "select" - values (required) - if no options supplied) - array - options (required) - if no values supplied) - associative array - selected (optional) - string default not set - output (required) - if not options supplied) - array - id (optional) - string default not set - class (optional) - string default not set
Parameters
| array | $params | parameters |
| \Smarty_Internal_Template | $template | template object |
Returns
stringsmarty_function_html_radios()
smarty_function_html_radios(array $params, \Smarty_Internal_Template $template) : string
Smarty {html_radios} function plugin
File: function.html_radios.php
Type: function
Name: html_radios
Date: 24.Feb.2003
Purpose: Prints out a list of radio input types
Params:
- name (optional) - string default "radio" - values (required) - array - options (required) - associative array - checked (optional) - array default not set - separator (optional) - ie
or - output (optional) - the output next to each radio button - assign (optional) - assign the output as an array to this variable - escape (optional) - escape the content (not value), defaults to true
Examples:
{html_radios values=$ids output=$names}
{html_radios values=$ids name='box' separator='
' output=$names}
{html_radios values=$ids checked=$checked separator='
' output=$names}
Parameters
| array | $params | parameters |
| \Smarty_Internal_Template | $template | template object |
Returns
stringsmarty_function_html_select_date()
smarty_function_html_select_date(array $params, \Smarty_Internal_Template $template) : string
Smarty {html_select_date} plugin
Type: function
Name: html_select_date
Purpose: Prints the dropdowns for date selection.
ChangeLog:
- 1.0 initial release
- 1.1 added support for +/- N syntax for begin
and end year values. (Monte)
- 1.2 added support for yyyy-mm-dd syntax for
time value. (Jan Rosier)
- 1.3 added support for choosing format for
month values (Gary Loescher)
- 1.3.1 added support for choosing format for
day values (Marcus Bointon)
- 1.3.2 support negative timestamps, force year
dropdown to include given date unless explicitly set (Monte)
- 1.3.4 fix behaviour of 0000-00-00 00:00:00 dates to match that
of 0000-00-00 dates (cybot, boots)
- 2.0 complete rewrite for performance,
added attributes month_names, *_id
Parameters
| array | $params | parameters |
| \Smarty_Internal_Template | $template | template object |
Returns
stringsmarty_function_html_select_time()
smarty_function_html_select_time(array $params, \Smarty_Internal_Template $template) : string
Smarty {html_select_time} function plugin
Type: function
Name: html_select_time
Purpose: Prints the dropdowns for time selection
Parameters
| array | $params | parameters |
| \Smarty_Internal_Template | $template | template object |
Returns
stringsmarty_function_html_table()
smarty_function_html_table(array $params, \Smarty_Internal_Template $template) : string
Smarty {html_table} function plugin
Type: function
Name: html_table
Date: Feb 17, 2003
Purpose: make an html table from an array of data
Params:
- loop - array to loop through
- cols - number of columns, comma separated list of column names
or array of column names
- rows - number of rows
- table_attr - table attributes
- th_attr - table heading attributes (arrays are cycled)
- tr_attr - table row attributes (arrays are cycled)
- td_attr - table cell attributes (arrays are cycled)
- trailpad - value to pad trailing cells with
- caption - text for caption element
- vdir - vertical direction (default: "down", means top-to-bottom)
- hdir - horizontal direction (default: "right", means left-to-right)
- inner - inner loop (default "cols": print $loop line by line,
$loop will be printed column by column otherwise)
Examples:
{table loop=$data}
{table loop=$data cols=4 tr_attr='"bgcolor=red"'}
{table loop=$data cols="first,second,third" tr_attr=$colors}
Parameters
| array | $params | parameters |
| \Smarty_Internal_Template | $template | template object |
Returns
stringsmarty_function_mailto()
smarty_function_mailto(array $params, \Smarty_Internal_Template $template) : string
Smarty {mailto} function plugin
Type: function
Name: mailto
Date: May 21, 2002
Purpose: automate mailto address link creation, and optionally encode them.
Params:
- address - (required) - e-mail address
- text - (optional) - text to display, default is address
- encode - (optional) - can be one of:
* none : no encoding (default)
* javascript : encode with javascript
* javascript_charcode : encode with javascript charcode
* hex : encode with hexidecimal (no javascript)
- cc - (optional) - address(es) to carbon copy
- bcc - (optional) - address(es) to blind carbon copy
- subject - (optional) - e-mail subject
- newsgroups - (optional) - newsgroup(s) to post to
- followupto - (optional) - address(es) to follow up to
- extra - (optional) - extra tags for the href link
Examples:
{mailto address="me@domain.com"}
{mailto address="me@domain.com" encode="javascript"}
{mailto address="me@domain.com" encode="hex"}
{mailto address="me@domain.com" subject="Hello to you!"}
{mailto address="me@domain.com" cc="you@domain.com,they@domain.com"}
{mailto address="me@domain.com" extra='class="mailto"'}
Parameters
| array | $params | parameters |
| \Smarty_Internal_Template | $template | template object |
Returns
stringsmarty_function_math()
smarty_function_math(array $params, \Smarty_Internal_Template $template) : string|null
Smarty {math} function plugin
Type: function
Name: math
Purpose: handle math computations in template
Parameters
| array | $params | parameters |
| \Smarty_Internal_Template | $template | template object |
Returns
string|nullsmarty_literal_compiler_param()
smarty_literal_compiler_param(array $params, integer $index, mixed $default = null) : mixed
evaluate compiler parameter
Parameters
| array | $params | parameter array as given to the compiler function |
| integer | $index | array index of the parameter to convert |
| mixed | $default | value to be returned if the parameter is not present |
Throws
- \SmartyException
if parameter is not a literal (but an expression, variable, …)
Returns
mixed —evaluated value of parameter or $default
smarty_make_timestamp()
smarty_make_timestamp(\DateTime|integer|string $string) : integer
Function: smarty_make_timestamp<br> Purpose: used by other smarty functions to make a timestamp from a string.
Parameters
| \DateTime|integer|string | $string | date object, timestamp or string that can be converted using strtotime() |
Returns
integersmarty_mb_from_unicode()
smarty_mb_from_unicode(integer|array $unicode, string $encoding = null) : string
convert unicodes to the character of given encoding
Parameters
| integer|array | $unicode | single unicode or list of unicodes to convert |
| string | $encoding | encoding of returned string, if null mb_internal_encoding() is used |
Returns
string —unicode as character sequence in given $encoding
smarty_mb_str_replace()
smarty_mb_str_replace(string $search, string $replace, string $subject, $count) : string
Multibyte string replace
Parameters
| string | $search | the string to be searched |
| string | $replace | the replacement string |
| string | $subject | the source string |
| $count |
Returns
string —replaced string
smarty_mb_to_unicode()
smarty_mb_to_unicode(string $string, string $encoding = null) : array
convert characters to their decimal unicode equivalents
Parameters
| string | $string | characters to calculate unicode of |
| string | $encoding | encoding of $string, if null mb_internal_encoding() is used |
Returns
array —sequence of unicodes
smarty_mb_wordwrap()
smarty_mb_wordwrap(string $str, integer $width = 75, string $break = "\n", boolean $cut = false) : string
Wrap a string to a given number of characters
Parameters
| string | $str | the string to wrap |
| integer | $width | the width of the output |
| string | $break | the character used to break the line |
| boolean | $cut | ignored parameter, just for the sake of |
Returns
string —wrapped string
smarty_modifier_capitalize()
smarty_modifier_capitalize(string $string, boolean $uc_digits = false, boolean $lc_rest = false) : string
Smarty capitalize modifier plugin
Type: modifier
Name: capitalize
Purpose: capitalize words in the string
Parameters
| string | $string | string to capitalize |
| boolean | $uc_digits | also capitalize "x123" to "X123" |
| boolean | $lc_rest | capitalize first letters, lowercase all following letters "aAa" to "Aaa" |
Returns
string —capitalized string
smarty_modifier_date_format()
smarty_modifier_date_format(string $string, string $format = SMARTY_RESOURCE_DATE_FORMAT, string $default_date = '', string $formatter = 'auto') : string
Smarty date_format modifier plugin
Type: modifier
Name: date_format
Purpose: format datestamps via strftime
Input:
- string: input date string
- format: strftime format for output
- default_date: default date if $string is empty
Parameters
| string | $string | input date string |
| string | $format | strftime format for output |
| string | $default_date | default date if $string is empty |
| string | $formatter | either 'strftime' or 'auto' |
Returns
string —|void
smarty_modifier_debug_print_var()
smarty_modifier_debug_print_var(array|object $var, integer $depth, integer $length = 40) : string
Smarty debug_print_var modifier plugin
Type: modifier
Name: debug_print_var
Purpose: formats variable contents for display in the console
Parameters
| array|object | $var | variable to be formatted |
| integer | $depth | maximum recursion depth if $var is an array |
| integer | $length | maximum string length if $var is a string |
Returns
stringsmarty_modifier_escape()
smarty_modifier_escape(string $string, string $esc_type = 'html', string $char_set = null, boolean $double_encode = true) : string
Smarty escape modifier plugin
Type: modifier
Name: escape
Purpose: escape string for output
Parameters
| string | $string | input string |
| string | $esc_type | escape type |
| string | $char_set | character set, used for htmlspecialchars() or htmlentities() |
| boolean | $double_encode | encode already encoded entitites again, used for htmlspecialchars() or htmlentities() |
Returns
string —escaped input string
smarty_modifier_regex_replace()
smarty_modifier_regex_replace(string $string, string|array $search, string|array $replace) : string
Smarty regex_replace modifier plugin
Type: modifier
Name: regex_replace
Purpose: regular expression search/replace
Parameters
| string | $string | input string |
| string|array | $search | regular expression(s) to search for |
| string|array | $replace | string(s) that should be replaced |
Returns
stringsmarty_modifier_replace()
smarty_modifier_replace(string $string, string $search, string $replace) : string
Smarty replace modifier plugin
Type: modifier
Name: replace
Purpose: simple search/replace
Parameters
| string | $string | input string |
| string | $search | text to search for |
| string | $replace | replacement text |
Returns
stringsmarty_modifier_spacify()
smarty_modifier_spacify(string $string, string $spacify_char = ' ') : string
Smarty spacify modifier plugin
Type: modifier
Name: spacify
Purpose: add spaces between characters in a string
Parameters
| string | $string | input string |
| string | $spacify_char | string to insert between characters. |
Returns
stringsmarty_modifier_truncate()
smarty_modifier_truncate(string $string, integer $length = 80, string $etc = '...', boolean $break_words = false, boolean $middle = false) : string
Smarty truncate modifier plugin
Type: modifier
Name: truncate
Purpose: Truncate a string to a certain length if necessary,
optionally splitting in the middle of a word, and
appending the $etc string or inserting $etc into the middle.
Parameters
| string | $string | input string |
| integer | $length | length of truncated text |
| string | $etc | end string |
| boolean | $break_words | truncate at word boundary |
| boolean | $middle | truncate in the middle of text |
Returns
string —truncated string
smarty_modifiercompiler_cat()
smarty_modifiercompiler_cat(array $params, $compiler) : string
Smarty cat modifier plugin
Type: modifier
Name: cat
Date: Feb 24, 2003
Purpose: catenate a value to a variable
Input: string to catenate
Example: {$var|cat:"foo"}
Parameters
| array | $params | parameters |
| $compiler |
Returns
string —with compiled code
smarty_modifiercompiler_count_characters()
smarty_modifiercompiler_count_characters(array $params, $compiler) : string
Smarty count_characters modifier plugin
Type: modifier
Name: count_characteres
Purpose: count the number of characters in a text
Parameters
| array | $params | parameters |
| $compiler |
Returns
string —with compiled code
smarty_modifiercompiler_count_paragraphs()
smarty_modifiercompiler_count_paragraphs(array $params, $compiler) : string
Smarty count_paragraphs modifier plugin
Type: modifier
Name: count_paragraphs
Purpose: count the number of paragraphs in a text
Parameters
| array | $params | parameters |
| $compiler |
Returns
string —with compiled code
smarty_modifiercompiler_count_sentences()
smarty_modifiercompiler_count_sentences(array $params, $compiler) : string
Smarty count_sentences modifier plugin
Type: modifier
Name: count_sentences
Purpose: count the number of sentences in a text
Parameters
| array | $params | parameters |
| $compiler |
Returns
string —with compiled code
smarty_modifiercompiler_count_words()
smarty_modifiercompiler_count_words(array $params, $compiler) : string
Smarty count_words modifier plugin
Type: modifier
Name: count_words
Purpose: count the number of words in a text
Parameters
| array | $params | parameters |
| $compiler |
Returns
string —with compiled code
smarty_modifiercompiler_from_charset()
smarty_modifiercompiler_from_charset(array $params, $compiler) : string
Smarty from_charset modifier plugin
Type: modifier
Name: from_charset
Purpose: convert character encoding from $charset to internal encoding
Parameters
| array | $params | parameters |
| $compiler |
Returns
string —with compiled code
smarty_modifiercompiler_string_format()
smarty_modifiercompiler_string_format(array $params, $compiler) : string
Smarty string_format modifier plugin
Type: modifier
Name: string_format
Purpose: format strings via sprintf
Parameters
| array | $params | parameters |
| $compiler |
Returns
string —with compiled code
smarty_modifiercompiler_strip()
smarty_modifiercompiler_strip(array $params, $compiler) : string
Smarty strip modifier plugin
Type: modifier
Name: strip
Purpose: Replace all repeated spaces, newlines, tabs
with a single space or supplied replacement string.
Example: {$var|strip} {$var|strip:" "}
Date: September 25th, 2002
Parameters
| array | $params | parameters |
| $compiler |
Returns
string —with compiled code
smarty_modifiercompiler_to_charset()
smarty_modifiercompiler_to_charset(array $params, $compiler) : string
Smarty to_charset modifier plugin
Type: modifier
Name: to_charset
Purpose: convert character encoding from internal encoding to $charset
Parameters
| array | $params | parameters |
| $compiler |
Returns
string —with compiled code
smarty_outputfilter_trimwhitespace()
smarty_outputfilter_trimwhitespace(string $source, \Smarty_Internal_Template $smarty) : string
Smarty trimwhitespace outputfilter plugin
Trim unnecessary whitespace from HTML markup.
Parameters
| string | $source | input string |
| \Smarty_Internal_Template | $smarty | Smarty object |
Returns
string —filtered output
smarty_variablefilter_htmlspecialchars()
smarty_variablefilter_htmlspecialchars(string $source, \Smarty_Internal_Template $smarty) : string
Smarty htmlspecialchars variablefilter plugin
Parameters
| string | $source | input string |
| \Smarty_Internal_Template | $smarty | Smarty object |
Returns
string —filtered output
stackTrace()
stackTrace(array $options = array()) : mixed
Outputs a stack trace based on the supplied options.
Options
depth- The number of stack frames to return. Defaults to 999args- Should arguments for functions be shown? If true, the arguments for each method call will be displayed.start- The stack frame to start generating a trace from. Defaults to 1
Parameters
| array | $options | Format for outputting stack trace |
Returns
mixed —Formatted stack trace
template_fetch_compile_include()
template_fetch_compile_include( $_templatelite_include_file, $_templatelite_include_vars, $object)
Template Lite template_fetch_compile_include template internal module
Type: template Name: template_fetch_compile_include
Parameters
| $_templatelite_include_file | ||
| $_templatelite_include_vars | ||
| $object |
U()
U(string $url = '', string|array $vars = '', string|boolean $suffix = true, boolean $domain = false) : string
URL组装 支持不同URL模式
Parameters
| string | $url | URL表达式，格式：'[模块/控制器/操作#锚点@域名]?参数1=值1&参数2=值2...' |
| string|array | $vars | 传入的参数，支持数组和字符串 |
| string|boolean | $suffix | 伪静态后缀，默认为true表示获取配置值 |
| boolean | $domain | 是否显示域名 |
Returns
stringU()
U(string $url = '', string|array $vars = '', string|boolean $suffix = true, boolean $domain = false) : string
URL组装 支持不同URL模式
Parameters
| string | $url | URL表达式，格式：'[模块/控制器/操作#锚点@域名]?参数1=值1&参数2=值2...' |
| string|array | $vars | 传入的参数，支持数组和字符串 |
| string|boolean | $suffix | 伪静态后缀，默认为true表示获取配置值 |
| boolean | $domain | 是否显示域名 |
Returns
stringxml_encode()
xml_encode(mixed $data, string $root = 'think', string $item = 'item', string $attr = '', string $id = 'id', string $encoding = 'utf-8') : string
XML编码
Parameters
| mixed | $data | 数据 |
| string | $root | 根节点名 |
| string | $item | 数字索引的子节点名 |
| string | $attr | 根节点属性 |
| string | $id | 数字索引子节点key转换的属性名 |
| string | $encoding | 数据编码 |
Returns
stringxml_encode()
xml_encode(mixed $data, string $root = 'think', string $item = 'item', string $attr = '', string $id = 'id', string $encoding = 'utf-8') : string
XML编码
Parameters
| mixed | $data | 数据 |
| string | $root | 根节点名 |
| string | $item | 数字索引的子节点名 |
| string | $attr | 根节点属性 |
| string | $id | 数字索引子节点key转换的属性名 |
| string | $encoding | 数据编码 |