filter

package

v0.4.3 Latest Latest Go to latest Published: Apr 7, 2024 License: MIT Imports: 5 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/kyleu/admini

Links

Open Source Insights

Documentation ¶

Overview ¶

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
type Params
- func ParamsWithDefaultOrdering(key string, params *Params, orderings ...*Ordering) *Params

Constants ¶

View Source

const (
	PageSize = 100
	MaxRows  = 10000

	SuffixOrder      = ".o"
	SuffixLimit      = ".l"
	SuffixOffset     = ".x"
	SuffixDescending = ".d"
)

Variables ¶

View Source

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

View Source

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

Functions ¶

This section is empty.

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,omitempty"`
}

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) Sanitized ¶ added in v0.4.3

func (s ParamSet) Sanitized(key string, logger util.Logger, defaultOrderings ...*Ordering) *Params

func (ParamSet) Specifies ¶ added in v0.3.9

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 ¶ added in v0.3.9

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 *url.URL) string

func (*Params) WithLimit ¶ added in v0.2.12

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

Source Files ¶

View all Source files

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