Archives final readonly class

Minn\Front\Archives · public/minn/src/Minn/Front/Archives.php · 63 lines

The archive periods wp_get_archives lists: months, years, days and weeks that hold a published post of a type, newest first, each with its post count and archive URL, plus the post-by-post and alphabetical listings. Labels come from the caller's date formatter so the site's locale and week start apply; the week label joins the week's first and last day.

Uses 1

Content\Posts

Constants and properties

private	`readonly Minn\Content\Posts $posts`	Promoted from the constructor.
private	`readonly Closure $date`	Promoted from the constructor.
private	`readonly Closure $dateLink`	Promoted from the constructor.
private	`readonly Closure $week`	Promoted from the constructor.

Public

new

__construct(Minn\Content\Posts $posts, Closure $date, Closure $dateLink, Closure $week)#

`$date`	`Closure(string, string): string`	formats a MySQL datetime with a PHP date format
`$dateLink`	`Closure(int, ?int, ?int): string`	the year, month, or day archive URL
`$week`	`Closure(string): array{start: int, end: int}`	the week's first and last second around a datetime

method

periods(string $granularity, string $type, string $order, int $limit, Closure $weekLink, string $where = '', string $join = ''): array

The periods of one granularity: monthly, yearly, daily, or weekly; a WHERE and JOIN given are the query's (Posts::archiveBuckets).

@return list<array{period: array{year: int, month: int, day: int, week: int}, url: string, text: string, count: int}>

method

posts(string $type, string $orderBy, string $order, int $limit, Closure $title, Closure $link, string $where = '', string $join = ''): array

The posts themselves, by date or by title.

`$title`	`Closure(int, string): string`	the post's title as displayed (or its id when empty)
`$link`	`Closure(int): string`

@return list<array{url: string, text: string, count: int, id: int}>

Internals 1

Private and protected methods: how the class does its work. Not a contract; they change whenever the code is tidied.

private

weekPeriod(array $bucket, Closure $weekLink): array#

$bucket array{year: int, week: int, first: string, count: int}

@return array{url: string, text: string, count: int}