users

Documentation

Index

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

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 Namespace

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

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

func New

func New(d *deps.Deps) *Namespace

Creates a new users Namespace

func (*Namespace) Find

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

Find

Obtains the user by ID and returns a domain.UserPart type or nil if not found.

Example: {{ user 123 }}

func (*Namespace) List

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

Returns errors.TEMPLATE if the template user params failed to parse.

Example: {{ $result := users (dict "limit" 10) }} {{ with $result.Users }}

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

{{ end }}

type Users

type Users struct {
	Users      domain.UsersParts
	Pagination *pagination.Pagination
}

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