filter

Documentation

Overview

Package filter - Content managed by Project Forge, see [projectforge.md] for details.

Package filter - Content managed by Project Forge, see [projectforge.md] for details.

Package filter - Content managed by Project Forge, see [projectforge.md] for details.

Index

• Constants
• Variables
• type Options
• type OptionsMap
  • func (m OptionsMap) Get(key string) *Options
• type Ordering
  • func (o Ordering) String() string
• type Orderings
• type ParamSet
  • func (s ParamSet) Get(key string, allowed []string, logger util.Logger) *Params
  • func (s ParamSet) Specifies(key string) bool
  • func (s ParamSet) String() string
• type Params
  • func ParamsWithDefaultOrdering(key string, params *Params, orderings ...*Ordering) *Params
  • func (p *Params) CloneLimit(limit int) *Params
  • func (p *Params) CloneOrdering(orderings ...*Ordering) *Params
  • func (p *Params) Filtered(available []string, logger util.Logger) *Params
  • func (p *Params) GetOrdering(col string) *Ordering
  • func (p *Params) HasNextPage(count int) bool
  • func (p *Params) HasPreviousPage() bool
  • func (p *Params) IsDefault() bool
  • func (p *Params) NextPage() *Params
  • func (p *Params) OrderByString() string
  • func (p *Params) PreviousPage() *Params
  • func (p *Params) Sanitize(key string, defaultOrderings ...*Ordering) *Params
  • func (p *Params) String() string
  • func (p *Params) ToQueryString(u *fasthttp.URI) string
  • func (p *Params) WithLimit(n int) *Params

Constants

const (
	PageSize = 100
	MaxRows  = 10000
)

Variables

var AllowedColumns = map[string][]string{}

var OrderingFieldDescs = util.FieldDescs{
	{Key: "column", Title: "Column", Description: "The name of the column to sort by"},
	{Key: "asc", Title: "Ascending", Description: "Determines if this ordering is applied ascending or descending"},
}

Types

type Options

type Options struct {
	Sort   []string `json:"sort,omitempty"`
	Filter []string `json:"filter,omitempty"`
	Group  []string `json:"group,omitempty"`
	Search string   `json:"search,omitempty"`
	Params *Params  `json:"params,omitempty"`
}

type OptionsMap

type OptionsMap map[string]*Options

func (OptionsMap) Get

func (m OptionsMap) Get(key string) *Options

type Ordering

type Ordering struct {
	Column string `json:"column"`
	Asc    bool   `json:"asc"`
}

func (Ordering) String

func (o Ordering) String() string

type Orderings

type Orderings []*Ordering

type ParamSet

type ParamSet map[string]*Params

func (ParamSet) Get

func (s ParamSet) Get(key string, allowed []string, logger util.Logger) *Params

func (ParamSet) Specifies

func (s ParamSet) Specifies(key string) bool

func (ParamSet) String

func (s ParamSet) String() string

type Params

type Params struct {
	Key       string    `json:"key"`
	Orderings Orderings `json:"orderings,omitempty"`
	Limit     int       `json:"limit,omitempty"`
	Offset    int       `json:"offset,omitempty"`
}

func ParamsWithDefaultOrdering

func ParamsWithDefaultOrdering(key string, params *Params, orderings ...*Ordering) *Params

func (*Params) CloneLimit

func (p *Params) CloneLimit(limit int) *Params

func (*Params) CloneOrdering

func (p *Params) CloneOrdering(orderings ...*Ordering) *Params

func (*Params) Filtered

func (p *Params) Filtered(available []string, logger util.Logger) *Params

func (*Params) GetOrdering

func (p *Params) GetOrdering(col string) *Ordering

func (*Params) HasNextPage

func (p *Params) HasNextPage(count int) bool

func (*Params) HasPreviousPage

func (p *Params) HasPreviousPage() bool

func (*Params) IsDefault

func (p *Params) IsDefault() bool

func (*Params) NextPage

func (p *Params) NextPage() *Params

func (*Params) OrderByString

func (p *Params) OrderByString() string

func (*Params) PreviousPage

func (p *Params) PreviousPage() *Params

func (*Params) Sanitize

func (p *Params) Sanitize(key string, defaultOrderings ...*Ordering) *Params

func (*Params) String

func (p *Params) String() string

func (*Params) ToQueryString

func (p *Params) ToQueryString(u *fasthttp.URI) string

func (*Params) WithLimit

func (p *Params) WithLimit(n int) *Params