pagination

Documentation

Index

• type APIDataResult
• type APIMetaPagination
• type APIPaginationResult
• type Count
• type PageMeta
• type Pagination
  • func (p *Pagination) CheckOrSetDefault(params ...int32) *Pagination
  • func (p *Pagination) LimitAndOffset() (uint32, uint32)
  • func (p *Pagination) Offset() int32
  • func (p *Pagination) SetTotalCountAndPage(total int32)

Types

type APIDataResult

type APIDataResult struct {
	Data interface{} `json:"data"`
}

APIDataResult 單存只顯示資料沒有 metadata

type APIMetaPagination

type APIMetaPagination struct {
	Pagination Pagination `json:"pagination" description:"分頁資訊"`
}

APIMetaPagination 分頁資訊

type APIPaginationResult

type APIPaginationResult struct {
	Meta APIMetaPagination `json:"meta"`
	Data interface{}       `json:"data"`
}

APIPaginationResult 用來顯示 meta 和 data

type Count

type Count struct {
	Count int64 `json:"count" description:"sql count result"`
}

Count 用來儲存sql count 結果

type PageMeta

type PageMeta struct {
	Pagination Pagination `json:"pagination"`
}

PageMeta meta with pagination

type Pagination

type Pagination struct {
	Page       int32 `query:"page" form:"page" json:"page" description:"目前頁面"`
	PerPage    int32 `query:"perPage" form:"perPage" json:"perPage" description:"每頁顯示多少筆"`
	TotalCount int32 `query:"totalCount" form:"totalCount" json:"totalCount" description:"總筆數"`
	TotalPage  int32 `query:"totalPage" form:"totalPage" json:"totalPage" description:"總頁數"`
}

Pagination 用來表示分頁

func (*Pagination) CheckOrSetDefault

func (p *Pagination) CheckOrSetDefault(params ...int32) *Pagination

CheckOrSetDefault 檢查Page值若未設置則設置預設值

func (*Pagination) LimitAndOffset

func (p *Pagination) LimitAndOffset() (uint32, uint32)

LimitAndOffset return limit and offset

func (*Pagination) Offset

func (p *Pagination) Offset() int32

Offset 計算 offset 的值

func (*Pagination) SetTotalCountAndPage

func (p *Pagination) SetTotalCountAndPage(total int32)

SetTotalCountAndPage 用來計算總數和分頁