模板类

Documentation

Overview

包gview实现了基于text/template的模板引擎。

预留的模板变量名： I18nLanguage：将此变量赋值以定义每个页面的国际化语言。 md5:31bd070a7bdcf2a1

Index

• Constants
• func ParseContent(ctx context.Context, content string, params ...X类型_Params) (string, error)
• type X类型_FuncMap
• type X类型_Params
• type X结构_模板
  • func Instance(name ...string) *X结构_模板
  • func New(path ...string) *X结构_模板
  • func (view *X结构_模板) AddPath(path string) error
  • func (view *X结构_模板) Assign(key string, value interface{})
  • func (view *X结构_模板) Assigns(data X类型_Params)
  • func (view *X结构_模板) BindFunc(name string, function interface{})
  • func (view *X结构_模板) BindFuncMap(funcMap X类型_FuncMap)
  • func (view *X结构_模板) GetDefaultFile() string
  • func (view *X结构_模板) Parse(ctx context.Context, file string, params ...X类型_Params) (result string, err error)
  • func (view *X结构_模板) ParseContent(ctx context.Context, content string, params ...X类型_Params) (string, error)
  • func (view *X结构_模板) ParseDefault(ctx context.Context, params ...X类型_Params) (result string, err error)
  • func (view *X结构_模板) ParseOption(ctx context.Context, option X结构_选项) (result string, err error)
  • func (view *X结构_模板) SetAutoEncode(enable bool)
  • func (view *X结构_模板) SetConfig(config X结构_配置) error
  • func (view *X结构_模板) SetConfigWithMap(m map[string]interface{}) error
  • func (view *X结构_模板) SetDefaultFile(file string)
  • func (view *X结构_模板) SetDelimiters(left, right string)
  • func (view *X结构_模板) SetI18n(manager *gi18n.X结构_Manager)
  • func (view *X结构_模板) SetPath(path string) error
• type X结构_选项
• type X结构_配置
  • func DefaultConfig() X结构_配置

Constants

const (
	// X常量_默认组名是实例使用的默认组名。 md5:ca8d8295a8c531f4
	X常量_默认组名 = "default"
)

Functions

func ParseContent

func ParseContent(ctx context.Context, content string, params ...X类型_Params) (string, error)

ParseContent 使用默认的视图对象直接解析模板内容，并返回解析后的内容。 md5:8349c5832e5a90c1

Types

type X类型_FuncMap

type X类型_FuncMap = map[string]interface{} // FuncMap是自定义模板函数的类型。 md5:04d2535f72d33955

type X类型_Params

type X类型_Params = map[string]interface{} // Params 是模板参数的类型。 md5:c3bc270bc0522288

type X结构_模板

type X结构_模板 struct {
	// contains filtered or unexported fields
}

用于模板引擎的视图对象。 md5:d5b31747d89262fc

func Instance

func Instance(name ...string) *X结构_模板

Instance 返回一个具有默认设置的 View 实例。 参数 `name` 是该实例的名称。 md5:7ac19173e044fa8f

func New

func New(path ...string) *X结构_模板

New 返回一个新的视图对象。 参数 `path` 指定加载模板文件的模板目录路径。 md5:b96716da886c0dc3

func (*X结构_模板) AddPath

func (view *X结构_模板) AddPath(path string) error

AddPath 向搜索路径中添加一个绝对或相对路径。 md5:d279479528c86f4e

func (*X结构_模板) Assign

func (view *X结构_模板) Assign(key string, value interface{})

Assign 将全局模板变量绑定到当前视图对象。需要注意的是，它不是线程安全的，这意味着如果在运行时从多个goroutine中调用它，会导致panic。 md5:7043c41fc2b3a0c3

func (*X结构_模板) Assigns

func (view *X结构_模板) Assigns(data X类型_Params)

将多个全局模板变量绑定到当前视图对象。需要注意的是，它不是并发安全的，这意味着如果在运行时从多个goroutine中调用它，会导致panic。 md5:b31929b349e74390

func (*X结构_模板) BindFunc

func (view *X结构_模板) BindFunc(name string, function interface{})

BindFunc 向当前视图对象注册一个名为 `name` 的自定义全局模板函数， 使用提供的 `function` 函数。其中，`name` 是在模板内容中可被调用的函数名。 md5:20f79a4c8d0ba97a

func (*X结构_模板) BindFuncMap

func (view *X结构_模板) BindFuncMap(funcMap X类型_FuncMap)

BindFuncMap 将自定义的全局模板函数通过映射注册到当前视图对象中。 映射的键是模板函数名称， 映射的值是自定义函数的地址。 md5:2fe9bab0463cef27

func (*X结构_模板) GetDefaultFile

func (view *X结构_模板) GetDefaultFile() string

GetDefaultFile 返回默认的模板文件，用于解析。 md5:f72bb2dc04f3d4a4

func (*X结构_模板) Parse

func (view *X结构_模板) Parse(ctx context.Context, file string, params ...X类型_Params) (result string, err error)

Parse 使用给定的模板变量`params`解析给定的模板文件`file`，并返回解析后的模板内容。 md5:4b41bf3f848a2345

func (*X结构_模板) ParseContent

func (view *X结构_模板) ParseContent(ctx context.Context, content string, params ...X类型_Params) (string, error)

ParseContent 使用模板变量 `params` 解析给定的模板内容 `content`，并返回解析后的字节切片。 md5:26fcffe5c26897e5

func (*X结构_模板) ParseDefault

func (view *X结构_模板) ParseDefault(ctx context.Context, params ...X类型_Params) (result string, err error)

ParseDefault 使用params解析默认模板文件。 md5:32a43fbd413f5a4e

func (*X结构_模板) ParseOption

func (view *X结构_模板) ParseOption(ctx context.Context, option X结构_选项) (result string, err error)

ParseOption 使用 Option 实现模板解析。 md5:ffb69e45da51ff4f

func (*X结构_模板) SetAutoEncode

func (view *X结构_模板) SetAutoEncode(enable bool)

SetAutoEncode 启用/禁用自动 HTML 编码功能。 当 AutoEncode 功能启用时，视图引擎会自动编码并提供安全的 HTML 输出，这对于防止 XSS 攻击很有好处。 md5:cd0107f5d2170f4f

func (*X结构_模板) SetConfig

func (view *X结构_模板) SetConfig(config X结构_配置) error

SetConfig 设置视图的配置。 md5:44d304b99e74e865

func (*X结构_模板) SetConfigWithMap

func (view *X结构_模板) SetConfigWithMap(m map[string]interface{}) error

SetConfigWithMap 使用映射为视图设置配置。 md5:1e1d667c3b2ace2b

func (*X结构_模板) SetDefaultFile

func (view *X结构_模板) SetDefaultFile(file string)

SetDefaultFile 为解析设置默认的模板文件。 md5:17f210ece0d189f6

func (*X结构_模板) SetDelimiters

func (view *X结构_模板) SetDelimiters(left, right string)

SetDelimiters 设置模板解析的自定义分隔符。 md5:a09465c3518f1023

func (*X结构_模板) SetI18n

func (view *X结构_模板) SetI18n(manager *gi18n.X结构_Manager)

SetI18n 将i18n管理器绑定到当前视图引擎。 md5:8d1b88bd87c041ba

func (*X结构_模板) SetPath

func (view *X结构_模板) SetPath(path string) error

SetPath 设置模板文件搜索的目录路径。参数 `path` 可以是绝对路径或相对路径，但建议使用绝对路径。 md5:abd751ab819d28b6

type X结构_选项

type X结构_选项 struct {
	File    string     // 模板文件的路径，可以是绝对路径或相对于搜索路径的相对路径。 md5:6be52fee4d922970
	Content string     // 模板内容，如果提供了`Content`，则忽略`File`。 md5:ca0535d67c8790ea
	Orphan  bool       // 如果为真，将`File`视为单个文件解析，不会递归地从其文件夹中解析其他文件。 md5:33ef5ff5d5c82177
	Params  X类型_Params // 模板参数映射。 md5:1ffdb0c9f199a7a3
}

用于模板解析的选项。 md5:cdeffab407011a88

type X结构_配置

type X结构_配置 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.X结构_Manager     `json:"-"`           // 视图的国际化管理器。 md5:7c90b657f5c4c28b
}

X结构_配置是模板引擎的配置对象。 md5:0c7a20a5c1f534d4

func DefaultConfig

func DefaultConfig() X结构_配置

DefaultConfig 创建并返回一个使用默认配置的配置对象。 md5:27f0cf63ebd5dd9e