Documentation ¶
Overview ¶
包gview实现了基于text/template的模板引擎。
预留的模板变量名: I18nLanguage:将此变量赋值以定义每个页面的国际化语言。 md5:31bd070a7bdcf2a1
Index ¶
- Constants
- func ParseContent(ctx context.Context, content string, params ...Params) (string, error)
- type Config
- type FuncMap
- type Option
- type Params
- type View
- func (view *View) AddPath(path string) error
- func (view *View) Assign(key string, value interface{})
- func (view *View) Assigns(data Params)
- func (view *View) BindFunc(name string, function interface{})
- func (view *View) BindFuncMap(funcMap FuncMap)
- func (view *View) GetDefaultFile() string
- func (view *View) Parse(ctx context.Context, file string, params ...Params) (result string, err error)
- func (view *View) ParseContent(ctx context.Context, content string, params ...Params) (string, error)
- func (view *View) ParseDefault(ctx context.Context, params ...Params) (result string, err error)
- func (view *View) ParseOption(ctx context.Context, option Option) (result string, err error)
- func (view *View) SetAutoEncode(enable bool)
- func (view *View) SetConfig(config Config) error
- func (view *View) SetConfigWithMap(m map[string]interface{}) error
- func (view *View) SetDefaultFile(file string)
- func (view *View) SetDelimiters(left, right string)
- func (view *View) SetI18n(manager *gi18n.Manager)
- func (view *View) SetPath(path string) error
Constants ¶
const (
// DefaultName是实例使用的默认组名。 md5:ca8d8295a8c531f4
DefaultName = "default"
)
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Config ¶
type Config struct { Paths []string `json:"paths"` // 在数组中搜索路径,为了性能原因,非并发安全。 md5:536357ec68a07213 Data map[string]interface{} `json:"data"` // 全局模板变量,包括配置信息。 md5:5f96c7a35c11b4b2 DefaultFile string `json:"defaultFile"` // 默认的模板文件用于解析。 md5:41607c84f42fcf9d Delimiters []string `json:"delimiters"` // 自定义模板分隔符。 md5:0a97ca0eda8842d4 AutoEncode bool `json:"autoEncode"` // 自动进行编码并提供安全的HTML输出,这对于防止XSS攻击很有帮助。 md5:ec33e2ef01aaf3d3 I18nManager *gi18n.Manager `json:"-"` // 视图的国际化管理器。 md5:7c90b657f5c4c28b }
Config是模板引擎的配置对象。 md5:0c7a20a5c1f534d4
func DefaultConfig ¶
func DefaultConfig() Config
DefaultConfig 创建并返回一个使用默认配置的配置对象。 md5:27f0cf63ebd5dd9e
type Option ¶
type Option struct { File string // 模板文件的路径,可以是绝对路径或相对于搜索路径的相对路径。 md5:6be52fee4d922970 Content string // 模板内容,如果提供了`Content`,则忽略`File`。 md5:ca0535d67c8790ea Orphan bool // 如果为真,将`File`视为单个文件解析,不会递归地从其文件夹中解析其他文件。 md5:33ef5ff5d5c82177 Params Params // 模板参数映射。 md5:1ffdb0c9f199a7a3 }
用于模板解析的选项。 md5:cdeffab407011a88
type View ¶
type View struct {
// contains filtered or unexported fields
}
用于模板引擎的视图对象。 md5:d5b31747d89262fc
func (*View) Assign ¶
Assign 将全局模板变量绑定到当前视图对象。需要注意的是,它不是线程安全的,这意味着如果在运行时从多个goroutine中调用它,会导致panic。 md5:7043c41fc2b3a0c3
func (*View) Assigns ¶
将多个全局模板变量绑定到当前视图对象。需要注意的是,它不是并发安全的,这意味着如果在运行时从多个goroutine中调用它,会导致panic。 md5:b31929b349e74390
func (*View) BindFunc ¶
BindFunc 向当前视图对象注册一个名为 `name` 的自定义全局模板函数, 使用提供的 `function` 函数。其中,`name` 是在模板内容中可被调用的函数名。 md5:20f79a4c8d0ba97a
func (*View) BindFuncMap ¶
BindFuncMap 将自定义的全局模板函数通过映射注册到当前视图对象中。 映射的键是模板函数名称, 映射的值是自定义函数的地址。 md5:2fe9bab0463cef27
func (*View) GetDefaultFile ¶
GetDefaultFile 返回默认的模板文件,用于解析。 md5:f72bb2dc04f3d4a4
func (*View) Parse ¶
func (view *View) Parse(ctx context.Context, file string, params ...Params) (result string, err error)
Parse 使用给定的模板变量`params`解析给定的模板文件`file`,并返回解析后的模板内容。 md5:4b41bf3f848a2345
func (*View) ParseContent ¶
func (view *View) ParseContent(ctx context.Context, content string, params ...Params) (string, error)
ParseContent 使用模板变量 `params` 解析给定的模板内容 `content`,并返回解析后的字节切片。 md5:26fcffe5c26897e5
func (*View) ParseDefault ¶
ParseDefault 使用params解析默认模板文件。 md5:32a43fbd413f5a4e
func (*View) ParseOption ¶
ParseOption 使用 Option 实现模板解析。 md5:ffb69e45da51ff4f
func (*View) SetAutoEncode ¶
SetAutoEncode 启用/禁用自动 HTML 编码功能。 当 AutoEncode 功能启用时,视图引擎会自动编码并提供安全的 HTML 输出,这对于防止 XSS 攻击很有好处。 md5:cd0107f5d2170f4f
func (*View) SetConfigWithMap ¶
SetConfigWithMap 使用映射为视图设置配置。 md5:1e1d667c3b2ace2b
func (*View) SetDefaultFile ¶
SetDefaultFile 为解析设置默认的模板文件。 md5:17f210ece0d189f6
func (*View) SetDelimiters ¶
SetDelimiters 设置模板解析的自定义分隔符。 md5:a09465c3518f1023