pagination

Documentation

Index

• Constants
• Variables
• type CombinedFilter
• type Filter
• type Pagination
  • func NewPagination(urlParams *url.Values) *Pagination
  • func NewPaginationWithFilter(column string, releation string, op string, values []string) *Pagination
  • func (p *Pagination) AddFilter(f Filter)
  • func (p *Pagination) Fetch(db *gorm.DB, dest interface{}) (*database.Paginator, *gorm.DB)
  • func (p *Pagination) GetFilter(key string) *Filter
  • func (p *Pagination) GetFilters() []Filter
  • func (p *Pagination) GetLimit() int
  • func (p *Pagination) GetOffset() int
  • func (p *Pagination) GetPage() int
  • func (p *Pagination) GetSortColumn() string
  • func (p *Pagination) GetSortOrder() string
  • func (p *Pagination) MakePaginationRequest()
  • func (p *Pagination) Response(ctx context.Context) (out domain.PaginationResponse, err error)

Constants

const COMBINED_FILTER = "combinedFilter" // deprecated

const FILTER = "filter"

const FILTER_ARRAY = "filter[]"

const OR = "or"

const OR_ARRAY = "or[]"

const PAGE_NUMBER = "pageNumber"

const PAGE_SIZE = "pageSize"

const SORT_COLUMN = "sortColumn"

const SORT_ORDER = "sortOrder"

Variables

var DEFAULT_LIMIT = 10000

Types

type CombinedFilter

type CombinedFilter struct {
	Columns []string
	Value   string
}

type Filter

type Filter struct {
	Or       bool
	Relation string
	Column   string
	Operator string
	Values   []string
}

type Pagination

type Pagination struct {
	Limit          int
	Page           int
	SortColumn     string
	SortOrder      string
	Filters        []Filter
	CombinedFilter CombinedFilter // deprecated
	TotalRows      int64
	TotalPages     int

	PaginationRequest *goyave.Request
	Paginator         *database.Paginator
}

func NewPagination

func NewPagination(urlParams *url.Values) *Pagination

func NewPaginationWithFilter

func NewPaginationWithFilter(column string, releation string, op string, values []string) *Pagination

func (*Pagination) AddFilter

func (p *Pagination) AddFilter(f Filter)

func (*Pagination) Fetch

func (p *Pagination) Fetch(db *gorm.DB, dest interface{}) (*database.Paginator, *gorm.DB)

func (*Pagination) GetFilter

func (p *Pagination) GetFilter(key string) *Filter

func (*Pagination) GetFilters

func (p *Pagination) GetFilters() []Filter

func (*Pagination) GetLimit

func (p *Pagination) GetLimit() int

func (*Pagination) GetOffset

func (p *Pagination) GetOffset() int

func (*Pagination) GetPage

func (p *Pagination) GetPage() int

func (*Pagination) GetSortColumn

func (p *Pagination) GetSortColumn() string

func (*Pagination) GetSortOrder

func (p *Pagination) GetSortOrder() string

func (*Pagination) MakePaginationRequest

func (p *Pagination) MakePaginationRequest()

func (*Pagination) Response

func (p *Pagination) Response(ctx context.Context) (out domain.PaginationResponse, err error)