categories

package

v0.0.4 Latest Latest Go to latest Published: Jun 23, 2021 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ainsleyclark/verbis

Documentation ¶

Constants ¶

View Source

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

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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>

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" }}

Source Files ¶

View all Source files

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