MediaWiki master
MediaWiki\Navigation\CodexPagerNavigationBuilder Class Reference

Inherits MediaWiki\Navigation\PagerNavigationBuilder.

Collaboration diagram for MediaWiki\Navigation\CodexPagerNavigationBuilder:

Public Member Functions

 __construct (IContextSource $context, array $queryValues)
 
 getHiddenFields (array $noResubmit=[])
 Get \<input type="hidden"\> elements for use in a method="get" form.
 
 getHtml ()
 Get the navigation HTML.
 
 getLimitForm ()
 Get a form with the items-per-page select.
 
 getLimitSelect (array $attribs=[])
 Get a "<select>" element which has options for each of the allowed limits.
 
 getLimitSelectList ()
 Get a list of items to show as options in the item-per-page select.
 
 setHideLast (bool $value)
 Set to true to hide the "go to last page" item in the pager navigation.
 
 setNavClass (string $navClass)
 Set custom CSS class for the navigation wrapper.
 
- Public Member Functions inherited from MediaWiki\Navigation\PagerNavigationBuilder
 __construct (MessageLocalizer $messageLocalizer)
 
 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)
 
Stability: stable
to override
Parameters
array | null$query
string | null$class
string$text
string | null$tooltip
string | null$rel
Returns
string HTML

 
- Protected Member Functions inherited from MediaWiki\Navigation\PagerNavigationBuilder
 msg ( $key,... $params)
 

Additional Inherited Members

- Protected Attributes inherited from MediaWiki\Navigation\PagerNavigationBuilder
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

Definition at line 11 of file CodexPagerNavigationBuilder.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Navigation\CodexPagerNavigationBuilder::__construct ( IContextSource $context,
array $queryValues )

Member Function Documentation

◆ getHiddenFields()

MediaWiki\Navigation\CodexPagerNavigationBuilder::getHiddenFields ( array $noResubmit = [])

Get \<input type="hidden"\> elements for use in a method="get" form.

Resubmits all defined elements of the query string, except for a exclusion list, passed in the $noResubmit parameter. Also array values are discarded for security reasons (per WebRequest::getVal)

Parameters
array$noResubmitParameters from the request query which should not be resubmitted
Returns
string HTML fragment

Definition at line 182 of file CodexPagerNavigationBuilder.php.

◆ getHtml()

MediaWiki\Navigation\CodexPagerNavigationBuilder::getHtml ( )

Get the navigation HTML.

Returns
string HTML

Reimplemented from MediaWiki\Navigation\PagerNavigationBuilder.

Definition at line 203 of file CodexPagerNavigationBuilder.php.

◆ getLimitForm()

MediaWiki\Navigation\CodexPagerNavigationBuilder::getLimitForm ( )

Get a form with the items-per-page select.

Returns
string HTML fragment

Definition at line 113 of file CodexPagerNavigationBuilder.php.

◆ getLimitSelect()

MediaWiki\Navigation\CodexPagerNavigationBuilder::getLimitSelect ( array $attribs = [])

Get a "<select>" element which has options for each of the allowed limits.

Parameters
string[]$attribsExtra attributes to set
Returns
string HTML fragment

Definition at line 136 of file CodexPagerNavigationBuilder.php.

◆ getLimitSelectList()

MediaWiki\Navigation\CodexPagerNavigationBuilder::getLimitSelectList ( )

Get a list of items to show as options in the item-per-page select.

Definition at line 148 of file CodexPagerNavigationBuilder.php.

◆ makeLink()

MediaWiki\Navigation\CodexPagerNavigationBuilder::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 from MediaWiki\Navigation\PagerNavigationBuilder.

Definition at line 53 of file CodexPagerNavigationBuilder.php.

◆ setHideLast()

MediaWiki\Navigation\CodexPagerNavigationBuilder::setHideLast ( bool $value)

Set to true to hide the "go to last page" item in the pager navigation.

Parameters
bool$value
Returns
void

Definition at line 46 of file CodexPagerNavigationBuilder.php.

◆ setNavClass()

MediaWiki\Navigation\CodexPagerNavigationBuilder::setNavClass ( string $navClass)

Set custom CSS class for the navigation wrapper.

Parameters
string$navClass
Returns
$this

Definition at line 35 of file CodexPagerNavigationBuilder.php.


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