tags

Documentation

Overview

Package tags represents the tag resource

Index

• Constants
• func AllowedParams() []string
• func Published() *query.Query
• func Query() *query.Query
• func Where(format string, args ...interface{}) *query.Query
• type Tag
  • func Find(id int64) (*Tag, error)
  • func FindAll(q *query.Query) ([]*Tag, error)
  • func FindFirst(format string, args ...interface{}) (*Tag, error)
  • func New() *Tag
  • func NewWithColumns(cols map[string]interface{}) *Tag

Constants

const (
	// TableName is the database table for this resource
	TableName = "tags"
	// KeyName is the primary key value for this resource
	KeyName = "id"
	// Order defines the default sort order in sql for this resource
	Order = "name asc, id desc"
)

Functions

func AllowedParams

func AllowedParams() []string

AllowedParams returns an array of allowed param keys for Update and Create.

func Published

func Published() *query.Query

Published returns a query for all tags with status >= published.

func Query

func Query() *query.Query

Query returns a new query for tags with a default order.

func Where

func Where(format string, args ...interface{}) *query.Query

Where returns a new query for tags with the format and arguments supplied.

Types

type Tag

type Tag struct {
	// resource.Base defines behaviour and fields shared between all resources
	resource.Base

	// status.ResourceStatus defines a status field and associated behaviour
	status.ResourceStatus

	DottedIDs string
	Name      string
	ParentID  int64
	Sort      int64
	Summary   string
	URL       string
}

Tag handles saving and retreiving tags from the database

func Find

func Find(id int64) (*Tag, error)

Find fetches a single tag record from the database by id.

func FindAll

func FindAll(q *query.Query) ([]*Tag, error)

FindAll fetches all tag records matching this query from the database.

func FindFirst

func FindFirst(format string, args ...interface{}) (*Tag, error)

FindFirst fetches a single tag record from the database using a where query with the format and args provided.

func New

func New() *Tag

New creates and initialises a new tag instance.

func NewWithColumns

func NewWithColumns(cols map[string]interface{}) *Tag

NewWithColumns creates a new tag instance and fills it with data from the database cols provided.