posts

package

v1.5.5 Latest Latest Go to latest Published: Aug 3, 2018 License: MIT Imports: 6 Imported by: 3

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/fragmenta/fragmenta-cms

Links

Open Source Insights

Documentation ¶

Overview ¶

Package posts represents the post resource

Index ¶

Constants
func AllowedParams() []string
func Published() *query.Query
func Query() *query.Query
func Where(format string, args ...interface{}) *query.Query
type Post

Constants ¶

View Source

const (
	// TableName is the database table for this resource
	TableName = "posts"
	// 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"
)

Variables ¶

This section is empty.

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 posts with status >= published.

func Query ¶

func Query() *query.Query

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

func Where ¶

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

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

Types ¶

type Post ¶

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

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

	AuthorID int64
	Keywords string
	Name     string
	Summary  string
	Template string
	Text     string
}

Post handles saving and retreiving posts from the database

func Find ¶

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

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

func FindAll ¶

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

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

func FindFirst ¶

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

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

func New ¶

func New() *Post

New creates and initialises a new post instance.

func NewWithColumns ¶

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

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

func (*Post) ShowTemplate ¶

func (p *Post) ShowTemplate() string

ShowTemplate returns the default template if none is set, or the template selected

func (*Post) ShowURL ¶

func (p *Post) ShowURL() string

ShowURL returns our canonical url for showing the post, including slug

func (*Post) TemplateOptions ¶

func (p *Post) TemplateOptions() []helpers.Selectable

TemplateOptions provides a set of options for the templates menu ids are indexes into the templates array above

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
actions

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