structure

Documentation

Index

• type Blog
• type Helper
• type Post
• type RequestData
• type Tag
• type User

Types

type Blog

type Blog struct {
	Url          []byte
	Title        []byte
	Description  []byte
	Logo         []byte
	Cover        []byte
	AssetPath    []byte
	PostCount    int64
	PostsPerPage int64
	ActiveTheme  string
}

Blog: settings that are used for template execution

type Helper

type Helper struct {
	Name       string
	Arguments  []Helper
	Unescaped  bool
	Position   int
	Block      []byte
	Children   []Helper
	Function   func(*Helper, *RequestData) []byte
	BodyHelper *Helper
}

Helpers are created during parsing of the theme (template files). Helpers should never be altered during template execution (Helpers are shared across all requests).

type Post

type Post struct {
	Id          int64
	Uuid        []byte
	Title       []byte
	Slug        string
	Markdown    []byte
	Html        []byte
	IsFeatured  bool
	IsPage      bool
	IsPublished bool
	Date        *time.Time
	Tags        []Tag
	Author      *User
	Image       []byte
}

type RequestData

type RequestData struct {
	PluginVMs            map[string]*lua.LState
	Posts                []Post
	Blog                 *Blog
	CurrentTag           *Tag
	CurrentIndexPage     int
	CurrentPostIndex     int
	CurrentTagIndex      int
	CurrentHelperContext int // 0 = index, 1 = post, 2 = tag, 3 = author - used by block helpers
	CurrentTemplate      int // 0 = index, 1 = post, 2 = tag, 3 = author - never changes during execution. Used by funcs like body_classFunc etc to output the correct class
}

RequestData: used for template/helper execution. Contains data specific to the incoming request.

type Tag

type Tag struct {
	Id   int64
	Name []byte
	Slug string
}

type User

type User struct {
	Id       int64
	Name     []byte
	Slug     string
	Email    []byte
	Image    []byte
	Cover    []byte
	Bio      []byte
	Website  []byte
	Location []byte
	Role     int //1 = Administrator, 2 = Editor, 3 = Author, 4 = Owner
}