MediaWiki master
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MediaWiki\Navigation\PagerNavigationBuilder Class Reference

Build the navigation for a pager, with links to prev/next page, links to change limits, and optionally links to first/last page. More...

Inherited by MediaWiki\Navigation\CodexPagerNavigationBuilder.

Collaboration diagram for MediaWiki\Navigation\PagerNavigationBuilder:
Collaboration graph
[legend]

Public Member Functions

 __construct (MessageLocalizer $messageLocalizer)
 
 getHtml ()
 Get the navigation HTML.
 
 setCurrentLimit (int $currentLimit)
 
 setFirstLinkQuery (?array $firstLinkQuery)
 
 setFirstMsg (?string $firstMsg)
 
 setFirstTooltipMsg (?string $firstTooltipMsg)
 
 setLastLinkQuery (?array $lastLinkQuery)
 
 setLastMsg (?string $lastMsg)
 
 setLastTooltipMsg (?string $lastTooltipMsg)
 
 setLimitLinkQueryParam (string $limitLinkQueryParam)
 
 setLimits (array $limits)
 
 setLimitTooltipMsg (?string $limitTooltipMsg)
 
 setLinkQuery (array $linkQuery)
 
 setNextLinkQuery (?array $nextLinkQuery)
 
 setNextMsg (string $nextMsg)
 
 setNextTooltipMsg (?string $nextTooltipMsg)
 
 setPage (PageReference $page)
 
 setPrevLinkQuery (?array $prevLinkQuery)
 
 setPrevMsg (string $prevMsg)
 
 setPrevTooltipMsg (?string $prevTooltipMsg)
 

Protected Member Functions

 makeLink (?array $query, ?string $class, string $text, ?string $tooltip, ?string $rel=null)
 
 msg ( $key,... $params)
 

Protected Attributes

int $currentLimit = 50
 
array< string, string|int|null > null $firstLinkQuery = null
 
string null $firstMsg = null
 
string null $firstTooltipMsg = null
 
array< string, string|int|null > null $lastLinkQuery = null
 
string null $lastMsg = null
 
string null $lastTooltipMsg = null
 
string $limitLinkQueryParam = 'limit'
 
int[] $limits = [ 20, 50, 100, 250, 500 ]
 
string null $limitTooltipMsg = null
 
array< string, string|int|null > $linkQuery = []
 
MessageLocalizer $messageLocalizer
 
array< string, string|int|null > null $nextLinkQuery = null
 
string $nextMsg = 'nextn'
 
string null $nextTooltipMsg = null
 
PageReference null $page
 
array< string, string|int|null > null $prevLinkQuery = null
 
string $prevMsg = 'prevn'
 
string null $prevTooltipMsg = null
 

Detailed Description

Build the navigation for a pager, with links to prev/next page, links to change limits, and optionally links to first/last page.

Since
1.39

Definition at line 22 of file PagerNavigationBuilder.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Navigation\PagerNavigationBuilder::__construct ( MessageLocalizer $messageLocalizer)

Definition at line 68 of file PagerNavigationBuilder.php.

References MediaWiki\Navigation\PagerNavigationBuilder\$messageLocalizer.

Member Function Documentation

◆ getHtml()

MediaWiki\Navigation\PagerNavigationBuilder::getHtml ( )

Get the navigation HTML.

Returns
string HTML

Reimplemented in MediaWiki\Navigation\CodexPagerNavigationBuilder.

Definition at line 287 of file PagerNavigationBuilder.php.

◆ makeLink()

MediaWiki\Navigation\PagerNavigationBuilder::makeLink ( ?array $query,
?string $class,
string $text,
?string $tooltip,
?string $rel = null )
protected
Stability: stable
to override
Parameters
array | null$query
string | null$class
string$text
string | null$tooltip
string | null$rel
Returns
string HTML

Reimplemented in MediaWiki\Navigation\CodexPagerNavigationBuilder.

Definition at line 257 of file PagerNavigationBuilder.php.

◆ msg()

MediaWiki\Navigation\PagerNavigationBuilder::msg ( $key,
$params )
protected
Parameters
string | string[] | MessageSpecifier$keyMessage key, or array of keys, or a MessageSpecifier.
MessageParam|MessageSpecifier|string|int|float|list<MessageParam|MessageSpecifier|string|int|float>...$params See Message::params()
Returns
Message

Definition at line 242 of file PagerNavigationBuilder.php.

◆ setCurrentLimit()

MediaWiki\Navigation\PagerNavigationBuilder::setCurrentLimit ( int $currentLimit)
Parameters
int$currentLimit
Returns
$this

Definition at line 202 of file PagerNavigationBuilder.php.

◆ setFirstLinkQuery()

MediaWiki\Navigation\PagerNavigationBuilder::setFirstLinkQuery ( ?array $firstLinkQuery)
Parameters
array<string,string|int|null>|null$firstLinkQuery
Returns
$this

Definition at line 148 of file PagerNavigationBuilder.php.

◆ setFirstMsg()

MediaWiki\Navigation\PagerNavigationBuilder::setFirstMsg ( ?string $firstMsg)
Parameters
string | null$firstMsg
Returns
$this

Definition at line 157 of file PagerNavigationBuilder.php.

◆ setFirstTooltipMsg()

MediaWiki\Navigation\PagerNavigationBuilder::setFirstTooltipMsg ( ?string $firstTooltipMsg)
Parameters
string | null$firstTooltipMsg
Returns
$this

Definition at line 166 of file PagerNavigationBuilder.php.

◆ setLastLinkQuery()

MediaWiki\Navigation\PagerNavigationBuilder::setLastLinkQuery ( ?array $lastLinkQuery)
Parameters
array<string,string|int|null>|null$lastLinkQuery
Returns
$this

Definition at line 175 of file PagerNavigationBuilder.php.

◆ setLastMsg()

MediaWiki\Navigation\PagerNavigationBuilder::setLastMsg ( ?string $lastMsg)
Parameters
string | null$lastMsg
Returns
$this

Definition at line 184 of file PagerNavigationBuilder.php.

◆ setLastTooltipMsg()

MediaWiki\Navigation\PagerNavigationBuilder::setLastTooltipMsg ( ?string $lastTooltipMsg)
Parameters
string | null$lastTooltipMsg
Returns
$this

Definition at line 193 of file PagerNavigationBuilder.php.

◆ setLimitLinkQueryParam()

MediaWiki\Navigation\PagerNavigationBuilder::setLimitLinkQueryParam ( string $limitLinkQueryParam)
Parameters
string$limitLinkQueryParam
Returns
$this

Definition at line 220 of file PagerNavigationBuilder.php.

◆ setLimits()

MediaWiki\Navigation\PagerNavigationBuilder::setLimits ( array $limits)
Parameters
int[]$limits
Returns
$this

Definition at line 211 of file PagerNavigationBuilder.php.

◆ setLimitTooltipMsg()

MediaWiki\Navigation\PagerNavigationBuilder::setLimitTooltipMsg ( ?string $limitTooltipMsg)
Parameters
string | null$limitTooltipMsg
Returns
$this

Definition at line 229 of file PagerNavigationBuilder.php.

◆ setLinkQuery()

MediaWiki\Navigation\PagerNavigationBuilder::setLinkQuery ( array $linkQuery)
Parameters
array<string,string|int|null>$linkQuery
Returns
$this

Definition at line 85 of file PagerNavigationBuilder.php.

◆ setNextLinkQuery()

MediaWiki\Navigation\PagerNavigationBuilder::setNextLinkQuery ( ?array $nextLinkQuery)
Parameters
array<string,string|int|null>|null$nextLinkQuery
Returns
$this

Definition at line 121 of file PagerNavigationBuilder.php.

◆ setNextMsg()

MediaWiki\Navigation\PagerNavigationBuilder::setNextMsg ( string $nextMsg)
Parameters
string$nextMsg
Returns
$this

Definition at line 130 of file PagerNavigationBuilder.php.

◆ setNextTooltipMsg()

MediaWiki\Navigation\PagerNavigationBuilder::setNextTooltipMsg ( ?string $nextTooltipMsg)
Parameters
string | null$nextTooltipMsg
Returns
$this

Definition at line 139 of file PagerNavigationBuilder.php.

◆ setPage()

MediaWiki\Navigation\PagerNavigationBuilder::setPage ( PageReference $page)
Parameters
PageReference$page
Returns
$this

Definition at line 76 of file PagerNavigationBuilder.php.

◆ setPrevLinkQuery()

MediaWiki\Navigation\PagerNavigationBuilder::setPrevLinkQuery ( ?array $prevLinkQuery)
Parameters
array<string,string|int|null>|null$prevLinkQuery
Returns
$this

Definition at line 94 of file PagerNavigationBuilder.php.

◆ setPrevMsg()

MediaWiki\Navigation\PagerNavigationBuilder::setPrevMsg ( string $prevMsg)
Parameters
string$prevMsg
Returns
$this

Definition at line 103 of file PagerNavigationBuilder.php.

◆ setPrevTooltipMsg()

MediaWiki\Navigation\PagerNavigationBuilder::setPrevTooltipMsg ( ?string $prevTooltipMsg)
Parameters
string | null$prevTooltipMsg
Returns
$this

Definition at line 112 of file PagerNavigationBuilder.php.

Member Data Documentation

◆ $currentLimit

int MediaWiki\Navigation\PagerNavigationBuilder::$currentLimit = 50
protected

Definition at line 60 of file PagerNavigationBuilder.php.

◆ $firstLinkQuery

array<string,string|int|null> null MediaWiki\Navigation\PagerNavigationBuilder::$firstLinkQuery = null
protected

Definition at line 46 of file PagerNavigationBuilder.php.

◆ $firstMsg

string null MediaWiki\Navigation\PagerNavigationBuilder::$firstMsg = null
protected

Definition at line 48 of file PagerNavigationBuilder.php.

◆ $firstTooltipMsg

string null MediaWiki\Navigation\PagerNavigationBuilder::$firstTooltipMsg = null
protected

Definition at line 50 of file PagerNavigationBuilder.php.

◆ $lastLinkQuery

array<string,string|int|null> null MediaWiki\Navigation\PagerNavigationBuilder::$lastLinkQuery = null
protected

Definition at line 53 of file PagerNavigationBuilder.php.

◆ $lastMsg

string null MediaWiki\Navigation\PagerNavigationBuilder::$lastMsg = null
protected

Definition at line 55 of file PagerNavigationBuilder.php.

◆ $lastTooltipMsg

string null MediaWiki\Navigation\PagerNavigationBuilder::$lastTooltipMsg = null
protected

Definition at line 57 of file PagerNavigationBuilder.php.

◆ $limitLinkQueryParam

string MediaWiki\Navigation\PagerNavigationBuilder::$limitLinkQueryParam = 'limit'
protected

Definition at line 64 of file PagerNavigationBuilder.php.

◆ $limits

int [] MediaWiki\Navigation\PagerNavigationBuilder::$limits = [ 20, 50, 100, 250, 500 ]
protected

Definition at line 62 of file PagerNavigationBuilder.php.

◆ $limitTooltipMsg

string null MediaWiki\Navigation\PagerNavigationBuilder::$limitTooltipMsg = null
protected

Definition at line 66 of file PagerNavigationBuilder.php.

◆ $linkQuery

array<string,string|int|null> MediaWiki\Navigation\PagerNavigationBuilder::$linkQuery = []
protected

Definition at line 29 of file PagerNavigationBuilder.php.

◆ $messageLocalizer

MessageLocalizer MediaWiki\Navigation\PagerNavigationBuilder::$messageLocalizer
protected

Definition at line 24 of file PagerNavigationBuilder.php.

Referenced by MediaWiki\Navigation\PagerNavigationBuilder\__construct().

◆ $nextLinkQuery

array<string,string|int|null> null MediaWiki\Navigation\PagerNavigationBuilder::$nextLinkQuery = null
protected

Definition at line 39 of file PagerNavigationBuilder.php.

◆ $nextMsg

string MediaWiki\Navigation\PagerNavigationBuilder::$nextMsg = 'nextn'
protected

Definition at line 41 of file PagerNavigationBuilder.php.

◆ $nextTooltipMsg

string null MediaWiki\Navigation\PagerNavigationBuilder::$nextTooltipMsg = null
protected

Definition at line 43 of file PagerNavigationBuilder.php.

◆ $page

PageReference null MediaWiki\Navigation\PagerNavigationBuilder::$page
protected

Definition at line 27 of file PagerNavigationBuilder.php.

◆ $prevLinkQuery

array<string,string|int|null> null MediaWiki\Navigation\PagerNavigationBuilder::$prevLinkQuery = null
protected

Definition at line 32 of file PagerNavigationBuilder.php.

◆ $prevMsg

string MediaWiki\Navigation\PagerNavigationBuilder::$prevMsg = 'prevn'
protected

Definition at line 34 of file PagerNavigationBuilder.php.

◆ $prevTooltipMsg

string null MediaWiki\Navigation\PagerNavigationBuilder::$prevTooltipMsg = null
protected

Definition at line 36 of file PagerNavigationBuilder.php.

The documentation for this class was generated from the following file: