scope

Documentation

Index

• Constants
• Variables
• func NewSearch(r *http.Request) string
• type Filter
• type Filters
  • func NewFilters(r *http.Request) Filters
• type Pagination
  • func NewPagination(r *http.Request) *Pagination
• type Scope
  • func New(sq string, p *Pagination, f Filters, s *Sorting) *Scope
• type Sorting
  • func NewSorting(r *http.Request) *Sorting

Constants

const (
	FilterKeyBrand = "brand"
	FilterKeyPrice = "price"
)

const (
	FilterOperatorEqual            = "eq"
	FilterOperatorGreaterThanEqual = "gte"
	FilterOperatorLowerThanEqual   = "lte"
)

const (
	PaginationOffsetDefault = 0
	PaginationLimitDefault  = 10
	RequestParameterOffset  = "offset"
	RequestParameterLimit   = "limit"
)

const (
	SortingFieldDefault = "price"
	SortingOrderDefault = "asc"
)

const RequestParameterQuery = "q"

const RequestParameterSorting = "sort"

const SearchTitle = "title"

Variables

var AvailableFilterKeys = []string{
	FilterKeyBrand,
	FilterKeyPrice,
}

var SearchFields = []string{SearchTitle}

Functions

func NewSearch

func NewSearch(r *http.Request) string

Types

type Filter

type Filter struct {
	Key      string
	Value    interface{}
	Operator string
}

type Filters

type Filters []*Filter

func NewFilters

func NewFilters(r *http.Request) Filters

type Pagination

type Pagination struct {
	Offset int
	Limit  int
}

func NewPagination

func NewPagination(r *http.Request) *Pagination

type Scope

type Scope struct {
	SearchQuery string
	Pagination  *Pagination
	Filters     Filters
	Sorting     *Sorting
}

func New

func New(sq string, p *Pagination, f Filters, s *Sorting) *Scope

type Sorting

type Sorting struct {
	Field string
	Order string
}

func NewSorting

func NewSorting(r *http.Request) *Sorting