view

package
v0.0.0-...-20f3002 Latest Latest
Warning

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

Go to latest
Published: Jun 16, 2017 License: BSD-3-Clause, BSD-3-Clause, MIT Imports: 15 Imported by: 0

Documentation

Index

Constants

View Source
const NoLayout = "iris.nolayout"

NoLayout disables the configuration's layout for a specific execution.

Variables

This section is empty.

Functions

This section is empty.

Types

type AmberEngine

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

AmberEngine contains the amber view engine structure.

func Amber

func Amber(directory, extension string) *AmberEngine

Amber creates and returns a new amber view engine.

func (*AmberEngine) AddFunc

func (s *AmberEngine) AddFunc(funcName string, funcBody interface{})

AddFunc adds the function to the template's function map. It is legal to overwrite elements of the default actions: - url func(routeName string, args ...string) string - urlpath func(routeName string, args ...string) string - render func(fullPartialName string) (template.HTML, error).

func (*AmberEngine) Binary

func (s *AmberEngine) Binary(assetFn func(name string) ([]byte, error), namesFn func() []string) *AmberEngine

Binary optionally, use it when template files are distributed inside the app executable (.go generated files).

The assetFn and namesFn can come from the go-bindata library.

func (*AmberEngine) ExecuteWriter

func (s *AmberEngine) ExecuteWriter(w io.Writer, filename string, layout string, bindingData interface{}) error

ExecuteWriter executes a template and writes its result to the w writer. layout here is useless.

func (*AmberEngine) Ext

func (s *AmberEngine) Ext() string

Ext returns the file extension which this view engine is responsible to render.

func (*AmberEngine) Load

func (s *AmberEngine) Load() error

Load parses the templates to the engine. It's alos responsible to add the necessary global functions.

Returns an error if something bad happens, user is responsible to catch it.

func (*AmberEngine) Reload

func (s *AmberEngine) Reload(developmentMode bool) *AmberEngine

Reload if setted to true the templates are reloading on each render, use it when you're in development and you're boring of restarting the whole app when you edit a template file.

type DjangoEngine

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

DjangoEngine contains the amber view engine structure.

func Django

func Django(directory, extension string) *DjangoEngine

Django creates and returns a new amber view engine.

func (*DjangoEngine) AddFilter

func (s *DjangoEngine) AddFilter(filterName string, filterBody FilterFunction) *DjangoEngine

AddFilter adds a filter to the template.

func (*DjangoEngine) AddFunc

func (s *DjangoEngine) AddFunc(funcName string, funcBody interface{})

AddFunc adds the function to the template's Globals. It is legal to overwrite elements of the default actions: - url func(routeName string, args ...string) string - urlpath func(routeName string, args ...string) string - render func(fullPartialName string) (template.HTML, error).

func (*DjangoEngine) Binary

func (s *DjangoEngine) Binary(assetFn func(name string) ([]byte, error), namesFn func() []string) *DjangoEngine

Binary optionally, use it when template files are distributed inside the app executable (.go generated files).

The assetFn and namesFn can come from the go-bindata library.

func (*DjangoEngine) ExecuteWriter

func (s *DjangoEngine) ExecuteWriter(w io.Writer, filename string, layout string, bindingData interface{}) error

ExecuteWriter executes a templates and write its results to the w writer layout here is useless.

func (*DjangoEngine) Ext

func (s *DjangoEngine) Ext() string

Ext returns the file extension which this view engine is responsible to render.

func (*DjangoEngine) Load

func (s *DjangoEngine) Load() error

Load parses the templates to the engine. It's alos responsible to add the necessary global functions.

Returns an error if something bad happens, user is responsible to catch it.

func (*DjangoEngine) Reload

func (s *DjangoEngine) Reload(developmentMode bool) *DjangoEngine

Reload if setted to true the templates are reloading on each render, use it when you're in development and you're boring of restarting the whole app when you edit a template file.

type Engine

type Engine interface {
	// Load should load the templates from a directory of by binary(assets/go-bindata).
	Load() error
	// ExecuteWriter should execute a template by its filename with an optional layout and bindingData.
	ExecuteWriter(w io.Writer, filename string, layout string, bindingData interface{}) error
	// Ext should return the final file extension which this view engine is responsible to render.
	Ext() string
}

Engine is the interface which all viwe engines should be implemented in order to be adapted inside Iris.

type EngineFuncer

type EngineFuncer interface {
	// AddFunc should adds a function to the template's function map.
	AddFunc(funcName string, funcBody interface{})
}

EngineFuncer is an addition of a view engine, if a view engine implements that interface then iris can add some closed-relative iris functions like {{ urlpath }} and {{ urlpath }}.

type Error

type Error pongo2.Error

Error conversion for pongo2.Error

type FilterFunction

type FilterFunction func(in *Value, param *Value) (out *Value, err *Error)

FilterFunction conversion for pongo2.FilterFunction

type HTMLEngine

type HTMLEngine struct {
	Templates *template.Template
	// contains filtered or unexported fields
}

HTMLEngine contains the html view engine structure.

func HTML

func HTML(directory, extension string) *HTMLEngine

HTML creates and returns a new html view engine. The html engine used like the "html/template" standard go package but with a lot of extra features.

func Pug

func Pug(directory, extension string) *HTMLEngine

Pug (or Jade) returns a new pug view engine. It shares the same exactly logic with the html view engine, it uses the same exactly configuration. It has got some features and a lot of functions which will make your life easier. Read more about the Jade Go Template: https://github.com/Joker/jade

func (*HTMLEngine) AddFunc

func (s *HTMLEngine) AddFunc(funcName string, funcBody interface{})

AddFunc adds the function to the template's function map. It is legal to overwrite elements of the default actions: - url func(routeName string, args ...string) string - urlpath func(routeName string, args ...string) string - render func(fullPartialName string) (template.HTML, error).

func (*HTMLEngine) AddLayoutFunc

func (s *HTMLEngine) AddLayoutFunc(funcName string, funcBody interface{}) *HTMLEngine

AddLayoutFunc adds the function to the template's layout-only function map. It is legal to overwrite elements of the default layout actions: - yield func() (template.HTML, error) - current func() (string, error) - partial func(partialName string) (template.HTML, error) - partial_r func(partialName string) (template.HTML, error) - render func(fullPartialName string) (template.HTML, error).

func (*HTMLEngine) Binary

func (s *HTMLEngine) Binary(assetFn func(name string) ([]byte, error), namesFn func() []string) *HTMLEngine

Binary optionally, use it when template files are distributed inside the app executable (.go generated files).

The assetFn and namesFn can come from the go-bindata library.

func (*HTMLEngine) Delims

func (s *HTMLEngine) Delims(left, right string) *HTMLEngine

Delims sets the action delimiters to the specified strings, to be used in subsequent calls to Parse, ParseFiles, or ParseGlob. Nested template definitions will inherit the settings. An empty delimiter stands for the corresponding default: {{ or }}.

func (*HTMLEngine) ExecuteWriter

func (s *HTMLEngine) ExecuteWriter(w io.Writer, name string, layout string, bindingData interface{}) error

ExecuteWriter executes a template and writes its result to the w writer.

func (*HTMLEngine) Ext

func (s *HTMLEngine) Ext() string

Ext returns the file extension which this view engine is responsible to render.

func (*HTMLEngine) Layout

func (s *HTMLEngine) Layout(layoutFile string) *HTMLEngine

Layout sets the layout template file which inside should use the {{ yield }} func to yield the main template file and optionally {{partial/partial_r/render}} to render other template files like headers and footers

The 'tmplLayoutFile' is a relative path of the templates base directory, for the template file with its extension.

Example: HTML("./templates", ".html").Layout("layouts/mainLayout.html")

// mainLayout.html is inside: "./templates/layouts/".

Note: Layout can be changed for a specific call action with the option: "layout" on the Iris' context.Render function.

func (*HTMLEngine) Load

func (s *HTMLEngine) Load() error

Load parses the templates to the engine. It's alos responsible to add the necessary global functions.

Returns an error if something bad happens, user is responsible to catch it.

func (*HTMLEngine) Reload

func (s *HTMLEngine) Reload(developmentMode bool) *HTMLEngine

Reload if setted to true the templates are reloading on each render, use it when you're in development and you're boring of restarting the whole app when you edit a template file.

type HandlebarsEngine

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

HandlebarsEngine contains the handlebars view engine structure.

func Handlebars

func Handlebars(directory, extension string) *HandlebarsEngine

Handlebars creates and returns a new handlebars view engine.

func (*HandlebarsEngine) AddFunc

func (s *HandlebarsEngine) AddFunc(funcName string, funcBody interface{})

AddFunc adds the function to the template's function map. It is legal to overwrite elements of the default actions: - url func(routeName string, args ...string) string - urlpath func(routeName string, args ...string) string - render func(fullPartialName string) (raymond.HTML, error).

func (*HandlebarsEngine) Binary

func (s *HandlebarsEngine) Binary(assetFn func(name string) ([]byte, error), namesFn func() []string) *HandlebarsEngine

Binary optionally, use it when template files are distributed inside the app executable (.go generated files).

The assetFn and namesFn can come from the go-bindata library.

func (*HandlebarsEngine) ExecuteWriter

func (s *HandlebarsEngine) ExecuteWriter(w io.Writer, filename string, layout string, bindingData interface{}) error

ExecuteWriter executes a template and writes its result to the w writer.

func (*HandlebarsEngine) Ext

func (s *HandlebarsEngine) Ext() string

Ext returns the file extension which this view engine is responsible to render.

func (*HandlebarsEngine) Layout

func (s *HandlebarsEngine) Layout(layoutFile string) *HandlebarsEngine

Layout sets the layout template file which should use the {{ yield }} func to yield the main template file and optionally {{partial/partial_r/render}} to render other template files like headers and footers.

func (*HandlebarsEngine) Load

func (s *HandlebarsEngine) Load() error

Load parses the templates to the engine. It's alos responsible to add the necessary global functions.

Returns an error if something bad happens, user is responsible to catch it.

func (*HandlebarsEngine) Reload

func (s *HandlebarsEngine) Reload(developmentMode bool) *HandlebarsEngine

Reload if setted to true the templates are reloading on each render, use it when you're in development and you're boring of restarting the whole app when you edit a template file.

type Options

type Options interface {
	// the per-execute layout,
	// most view engines will have a static configuration field for that too.
	GetLayout() string
	// should returns the dynamic binding data, which will be used inside the template file
	GetData() interface{}

} // this Options interface is implemented inside context, in order to use one import path for all context's methods.

Options should contains the dynamic options for the engine's ExecuteWriter.

type Value

type Value pongo2.Value

Value conversion for pongo2.Value

type View

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

View is responsible to load the correct templates for each of the registered view engines.

func (*View) AddFunc

func (v *View) AddFunc(funcName string, funcBody interface{})

AddFunc adds a function to all registered engines. Each template engine that supports functions has its own AddFunc too.

func (*View) ExecuteWriter

func (v *View) ExecuteWriter(w io.Writer, filename string, layout string, bindingData interface{}) error

ExecuteWriter calls the correct view Engine's ExecuteWriter func

func (*View) Find

func (v *View) Find(filename string) Engine

Find receives a filename, gets its extension and returns the view engine responsible for that file extension

func (*View) Len

func (v *View) Len() int

Len returns the length of view engines registered so far.

func (*View) Load

func (v *View) Load() error

Load compiles all the registered engines.

func (*View) Register

func (v *View) Register(e Engine) error

Register loads all the view engines' template files or embedded assets.

Jump to

Keyboard shortcuts

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