github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-04-04 23:43:47 +00:00
Code Issues Projects Releases Packages Wiki Activity

hugolib: Add Godoc to pageSort

Browse source
This commit is contained in:
Bjørn Erik Pedersen 2016-03-23 17:11:29 +01:00
parent c20dee9d7f
commit c31fa378c7
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
hugolib/pageSort.go
View file

@ -32,6 +32,7 @@ type PageSorter struct {
// PageBy is a closure used in the Sort.Less method. // PageBy is a closure used in the Sort.Less method.
type PageBy func(p1, p2 *Page) bool type PageBy func(p1, p2 *Page) bool
// Sort stable sorts the pages given the receiver's sort oder.
func (by PageBy) Sort(pages Pages) { func (by PageBy) Sort(pages Pages) {
ps := &PageSorter{ ps := &PageSorter{
pages: pages, pages: pages,
@ -40,6 +41,8 @@ func (by PageBy) Sort(pages Pages) {
sort.Stable(ps) sort.Stable(ps)
} }
// DefaultPageSort is the default sort for pages in Hugo:
// Order by Weight, Date, LinkTitle and then full file path.
var DefaultPageSort = func(p1, p2 *Page) bool { var DefaultPageSort = func(p1, p2 *Page) bool {
if p1.Weight == p2.Weight { if p1.Weight == p2.Weight {
if p1.Date.Unix() == p2.Date.Unix() { if p1.Date.Unix() == p2.Date.Unix() {
@ -59,10 +62,13 @@ func (ps *PageSorter) Swap(i, j int) { ps.pages[i], ps.pages[j] = ps.pages[j], p
// Less is part of sort.Interface. It is implemented by calling the "by" closure in the sorter. // Less is part of sort.Interface. It is implemented by calling the "by" closure in the sorter.
func (ps *PageSorter) Less(i, j int) bool { return ps.by(ps.pages[i], ps.pages[j]) } func (ps *PageSorter) Less(i, j int) bool { return ps.by(ps.pages[i], ps.pages[j]) }
// Sort sorts the pages by the default sort order defined:
// Order by Weight, Date, LinkTitle and then full file path.
func (p Pages) Sort() { func (p Pages) Sort() {
PageBy(DefaultPageSort).Sort(p) PageBy(DefaultPageSort).Sort(p)
} }
// Limit limits the number of pages returned to n.
func (p Pages) Limit(n int) Pages { func (p Pages) Limit(n int) Pages {
if len(p) > n { if len(p) > n {
return p[0:n] return p[0:n]