categories

Documentation

Index

• Constants
• type Categories
• type Namespace
  • func New(d *deps.Deps) *Namespace
  • func (ns *Namespace) ByName(name interface{}) interface{}
  • func (ns *Namespace) Find(id interface{}) interface{}
  • func (ns *Namespace) List(query params.Query) (interface{}, error)
  • func (ns *Namespace) Parent(id interface{}) interface{}

Constants

const (
	// The default order by field for the list function.
	OrderBy = "created_at"
	// The default order direction field for the list function.
	OrderDirection = "desc"
)

Types

type Categories

type Categories struct {
	Categories domain.Categories
	Pagination *pagination.Pagination
}

Categories defines the struct for returning categories and pagination back to the template.

type Namespace

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

Namespace defines the methods for categories to be used as template functions.

func New

func New(d *deps.Deps) *Namespace

Creates a new categories Namespace

func (*Namespace) ByName

func (ns *Namespace) ByName(name interface{}) interface{}

ByName

Obtains the category by name and returns a domain.Category type or nil if not found.

Example: {{ categoryByName "sports" }}

func (*Namespace) Find

func (ns *Namespace) Find(id interface{}) interface{}

Find

Obtains the category by ID and returns a domain.Category type or nil if not found.

Example: {{ category 123 }}

func (*Namespace) List

func (ns *Namespace) List(query params.Query) (interface{}, error)

Returns errors.TEMPLATE if the template post category failed to parse.

Example: {{ $result := categories (dict "limit" 10) }} {{ with $result.Categories }}

{{ range $category := . }}
    <h2>{{ $category.Name }}</h2>
{{ end }}
{{ else }}
    <h4>No categories found</h4>

{{ end }}

func (*Namespace) Parent

func (ns *Namespace) Parent(id interface{}) interface{}

ByParent

Obtains the category by parent and returns a domain.Category type or nil if not found.

Example: {{ categoryByParent "sports" }}