e0ea3811c4
When read the code: `pager.AddParam(ctx, "search", "search")`, the question always comes: What is it doing? Where is the value from? Why "search" / "search" ? Now it is clear: `pager.AddParamIfExist("search", ctx.Data["search"])`
57 lines
1.7 KiB
Go
57 lines
1.7 KiB
Go
// Copyright 2019 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package context
|
|
|
|
import (
|
|
"fmt"
|
|
"html/template"
|
|
"net/url"
|
|
"strings"
|
|
|
|
"code.gitea.io/gitea/modules/paginator"
|
|
)
|
|
|
|
// Pagination provides a pagination via paginator.Paginator and additional configurations for the link params used in rendering
|
|
type Pagination struct {
|
|
Paginater *paginator.Paginator
|
|
urlParams []string
|
|
}
|
|
|
|
// NewPagination creates a new instance of the Pagination struct.
|
|
// "pagingNum" is "page size" or "limit", "current" is "page"
|
|
func NewPagination(total, pagingNum, current, numPages int) *Pagination {
|
|
p := &Pagination{}
|
|
p.Paginater = paginator.New(total, pagingNum, current, numPages)
|
|
return p
|
|
}
|
|
|
|
// AddParamIfExist adds a value to the query parameters if the value is not nil
|
|
func (p *Pagination) AddParamIfExist(key string, val any) {
|
|
if val == nil {
|
|
return
|
|
}
|
|
paramData := fmt.Sprint(val)
|
|
urlParam := fmt.Sprintf("%s=%v", url.QueryEscape(key), url.QueryEscape(paramData))
|
|
p.urlParams = append(p.urlParams, urlParam)
|
|
}
|
|
|
|
// AddParamString adds a string parameter directly
|
|
func (p *Pagination) AddParamString(key, value string) {
|
|
urlParam := fmt.Sprintf("%s=%v", url.QueryEscape(key), url.QueryEscape(value))
|
|
p.urlParams = append(p.urlParams, urlParam)
|
|
}
|
|
|
|
// GetParams returns the configured URL params
|
|
func (p *Pagination) GetParams() template.URL {
|
|
return template.URL(strings.Join(p.urlParams, "&"))
|
|
}
|
|
|
|
// SetDefaultParams sets common pagination params that are often used
|
|
func (p *Pagination) SetDefaultParams(ctx *Context) {
|
|
p.AddParamIfExist("sort", ctx.Data["SortType"])
|
|
p.AddParamIfExist("q", ctx.Data["Keyword"])
|
|
// do not add any more uncommon params here!
|
|
p.AddParamIfExist("fuzzy", ctx.Data["IsFuzzy"])
|
|
}
|