filter

Documentation

Index

• Variables
• type Custom
  • func (this Custom) ID() string
  • func (this Custom) InputValues() []string
  • func (this Custom) Inputs() []string
  • func (this Custom) Label() string
  • func (this *Custom) Populate(form url.Values) error
  • func (this Custom) Query(propIndex int) (string, []any)
  • func (this Custom) TableName() string
• type DateFilter
  • func (this *DateFilter) Hydrate(opts DateFilterOpts) error
  • func (this DateFilter) Inputs() []string
  • func (this DateFilter) Period() util.Period
  • func (this *DateFilter) Populate(form url.Values) error
  • func (this DateFilter) Query(propIndex int) (string, []any)
• type DateFilterOpts
• type Filter
• type FilterSet
  • func (this FilterSet) ID() string
  • func (this FilterSet) InputValues() []string
  • func (this FilterSet) Inputs() []string
  • func (this FilterSet) Label() string
  • func (this *FilterSet) Populate(url.Values) error
  • func (this FilterSet) Query(propIndex int) (string, []any)
  • func (this FilterSet) TableName() string
• type Filters
  • func CommonFilters(table string) Filters
  • func (filters Filters) Active(id string) bool
  • func (filters Filters) ByID(id string) Filter
  • func (filters Filters) Except(except ...string) Filters
  • func (filters *Filters) FromForm(form url.Values, availableFilters Filters, customFilters ...Filter) error
  • func (filters Filters) IDMap() map[string]Filter
  • func (filters Filters) Only(except ...string) Filters
  • func (filters Filters) Query(propIndex int) (string, []any)
• type HasProp
  • func (this *HasProp) Hydrate(opts HasPropOpts) error
  • func (this HasProp) ID() string
  • func (this *HasProp) InputValues() []string
  • func (this HasProp) Inputs() []string
  • func (this HasProp) Label() string
  • func (this *HasProp) Populate(url.Values) error
  • func (this HasProp) Query(propIndex int) (string, []any)
  • func (this HasProp) TableName() string
• type HasPropOpts

Variables

var ErrorAlreadyHydrated = fmt.Errorf("Filter already hydrated. This is a once-only operation to reduce the risk of injection attacks.")

Types

type Custom

type Custom struct {
	Col         string
	Values      []string
	CustomID    string
	CustomLabel string
	// contains filtered or unexported fields
}

func (Custom) ID

func (this Custom) ID() string

func (Custom) InputValues

func (this Custom) InputValues() []string

func (Custom) Inputs

func (this Custom) Inputs() []string

func (Custom) Label

func (this Custom) Label() string

func (*Custom) Populate

func (this *Custom) Populate(form url.Values) error

func (Custom) Query

func (this Custom) Query(propIndex int) (string, []any)

func (Custom) TableName

func (this Custom) TableName() string

type DateFilter

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

func (*DateFilter) Hydrate

func (this *DateFilter) Hydrate(opts DateFilterOpts) error

func (DateFilter) Inputs

func (this DateFilter) Inputs() []string

func (DateFilter) Period

func (this DateFilter) Period() util.Period

func (*DateFilter) Populate

func (this *DateFilter) Populate(form url.Values) error

func (DateFilter) Query

func (this DateFilter) Query(propIndex int) (string, []any)

type DateFilterOpts

type DateFilterOpts struct {
	Label  string
	ID     string
	Table  string
	Col    string
	Period util.Period
}

type Filter

type Filter interface {
	Label() string
	Query(int) (string, []any)
	ID() string
	Populate(url.Values) error
	Inputs() []string
	TableName() string
}

type FilterSet

type FilterSet struct {
	Filters     Filters
	CustomID    string
	CustomLabel string
	IsAnd       bool
	Values      []string
	// contains filtered or unexported fields
}

func (FilterSet) ID

func (this FilterSet) ID() string

func (FilterSet) InputValues

func (this FilterSet) InputValues() []string

func (FilterSet) Inputs

func (this FilterSet) Inputs() []string

func (FilterSet) Label

func (this FilterSet) Label() string

func (*FilterSet) Populate

func (this *FilterSet) Populate(url.Values) error

func (FilterSet) Query

func (this FilterSet) Query(propIndex int) (string, []any)

func (FilterSet) TableName

func (this FilterSet) TableName() string

type Filters

type Filters []Filter

func CommonFilters

func CommonFilters(table string) Filters

func (Filters) Active

func (filters Filters) Active(id string) bool

func (Filters) ByID

func (filters Filters) ByID(id string) Filter

func (Filters) Except

func (filters Filters) Except(except ...string) Filters

func (*Filters) FromForm

func (filters *Filters) FromForm(form url.Values, availableFilters Filters, customFilters ...Filter) error

func (Filters) IDMap

func (filters Filters) IDMap() map[string]Filter

func (Filters) Only

func (filters Filters) Only(except ...string) Filters

func (Filters) Query

func (filters Filters) Query(propIndex int) (string, []any)

type HasProp

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

func (*HasProp) Hydrate

func (this *HasProp) Hydrate(opts HasPropOpts) error

func (HasProp) ID

func (this HasProp) ID() string

func (*HasProp) InputValues

func (this *HasProp) InputValues() []string

func (HasProp) Inputs

func (this HasProp) Inputs() []string

func (HasProp) Label

func (this HasProp) Label() string

func (*HasProp) Populate

func (this *HasProp) Populate(url.Values) error

func (HasProp) Query

func (this HasProp) Query(propIndex int) (string, []any)

func (HasProp) TableName

func (this HasProp) TableName() string

type HasPropOpts

type HasPropOpts struct {
	Label string
	ID    string
	Table string
	Col   string
	Value string
}