templater

package
v1.9.14 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 22, 2024 License: MIT Imports: 11 Imported by: 0

README

Шаблонизатор.

Компонент основан на пакете https://github.com/foolin/goview.

Объект конфигурации.
type Config struct {
	TemplateRootDirectory string
	Extension             string
	IndexLayoutPath       string
	UseCache              bool
}

Описание полей:

Поле Описание Значение по умолчанию
TemplateRootDirectory Путь до директории с шаблонами, этот параметр может быть передан одним из 3-х методов:
- флаг командной строки --templater.directory.root
- переменная окружения TEMPLATER_DIRECTORY_ROOT
- значение в конфиг файле templater.directory.root
template
Extension Расширение файлов шаблонов, этот параметр может быть передан одним из 3-х методов:
- флаг командной строки --templater.extension
- переменная окружения templater.extension
- значение в конфиг файле templater.extension
.html
IndexLayoutPath Путь, относительно директории с шаблонами, мастер шаблона, этот параметр может быть передан одним из 3-х методов:
- флаг командной строки --templater.layout.index
- переменная окружения templater.layout.index
- значение в конфиг файле templater.layout.index
layouts/master
UseCache Флаг кэширования шаблонов, если true шаблон будут кэшироваться, этот параметр может быть передан одним из 3-х методов:
- флаг командной строки --templater.cache
- переменная окружения templater.cache
- значение в конфиг файле templater.cache
false

Documentation

Index

Constants

View Source
const (
	TemplateRootDirectoryFieldName = "templater.directory.root"
	ExtensionFieldName             = "templater.extension"
	IndexLayoutPathFieldName       = "templater.layout.index"
	UseCacheFieldName              = "templater.cache"

	TemplateRootDirectoryDefault = "template"
	ExtensionDefault             = ".html"
	IndexLayoutPathDefault       = "layouts/master"
	UseCacheDefault              = false
)

Variables

View Source
var Component = &app.Component{
	Dependencies: app.Components{
		logger.Component,
		configurator.Component,
		reConfiguration.Component,
	},
	Constructor: app.Constructor(func(container container.Container) error {
		return container.Provides(
			NewConfig,
			NewReConfigurationWithConfigurator,
			func(templater *ReConfiguration) Templater { return templater },
		)
	}),
	BindFlags: app.BindFlags(func(flagSet *pflag.FlagSet, container container.Container) error {
		return container.Invoke(func(config *Config) {
			flagSet.StringVar(
				&config.TemplateRootDirectory,
				TemplateRootDirectoryFieldName,
				TemplateRootDirectoryDefault,
				"path to templates directory",
			)
			flagSet.StringVar(&config.Extension, ExtensionFieldName, ExtensionDefault, "template file extension")
			flagSet.StringVar(&config.IndexLayoutPath, IndexLayoutPathFieldName, IndexLayoutPathDefault, "main template file name")
			flagSet.BoolVar(&config.UseCache, UseCacheFieldName, UseCacheDefault, "if true, cache templating results")
		})
	}),
	Run: app.Run(func(container container.Container) error {
		return container.Invoke(func(
			templater *ReConfiguration,
			reConfiguration reConfiguration.ReConfiguration,
			informer logger.Informer,
			config *Config,
		) {
			reConfiguration.Registration(templater)
			informer.Info("templater: registration in the reConfigurator")
		})
	}),
}

Functions

func New

func New(config *Config, informer logger.Informer) *goview.ViewEngine

func NewWithConfigurator

func NewWithConfigurator(config *Config, configurator configurator.Configurator, informer logger.Informer) *goview.ViewEngine

Types

type Config

type Config struct {
	TemplateRootDirectory string
	Extension             string
	IndexLayoutPath       string
	UseCache              bool
}

func Configuration

func Configuration(config *Config, configurator configurator.Configurator) *Config

func NewConfig

func NewConfig() *Config

type ReConfiguration

type ReConfiguration struct {
	// contains filtered or unexported fields
}

func NewReConfiguration

func NewReConfiguration(templater Templater, informer logger.Informer, config *Config) *ReConfiguration

func NewReConfigurationWithConfigurator

func NewReConfigurationWithConfigurator(config *Config, configurator configurator.Configurator, informer logger.Informer) *ReConfiguration

func (*ReConfiguration) ReConfiguration

func (reConfiguration *ReConfiguration) ReConfiguration(configurator configurator.Configurator) error

func (*ReConfiguration) Render

func (reConfiguration *ReConfiguration) Render(w http.ResponseWriter, statusCode int, name string, data interface{}) error

func (*ReConfiguration) RenderWriter

func (reConfiguration *ReConfiguration) RenderWriter(w io.Writer, name string, data interface{}) error

type Templater

type Templater interface {
	Render(w http.ResponseWriter, statusCode int, name string, data interface{}) error
	RenderWriter(w io.Writer, name string, data interface{}) error
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL