MediaWiki  1.29.1
MediaWiki\Linker\LinkTarget Interface Reference
Inheritance diagram for MediaWiki\Linker\LinkTarget:

Public Member Functions

 createFragmentTarget ( $fragment)
 Creates a new LinkTarget for a different fragment of the same page. More...
 
 getDBkey ()
 Get the main part with underscores. More...
 
 getFragment ()
 Get the link fragment (i.e. More...
 
 getInterwiki ()
 The interwiki component of this LinkTarget. More...
 
 getNamespace ()
 Get the namespace index. More...
 
 getText ()
 Returns the link in text form, without namespace prefix or fragment. More...
 
 hasFragment ()
 Whether the link target has a fragment. More...
 
 inNamespace ( $ns)
 Convenience function to test if it is in the namespace. More...
 
 isExternal ()
 Whether this LinkTarget has an interwiki component. More...
 

Detailed Description

Since
1.27

Definition at line 27 of file LinkTarget.php.

Member Function Documentation

◆ createFragmentTarget()

MediaWiki\Linker\LinkTarget::createFragmentTarget (   $fragment)

Creates a new LinkTarget for a different fragment of the same page.

It is expected that the same type of object will be returned, but the only requirement is that it is a LinkTarget.

Since
1.27
Parameters
string$fragmentThe fragment name, or "" for the entire page.
Returns
LinkTarget

Implemented in Title, and TitleValue.

Referenced by MediaWiki\Linker\LinkRenderer\makeBrokenLink().

◆ getDBkey()

◆ getFragment()

MediaWiki\Linker\LinkTarget::getFragment ( )

Get the link fragment (i.e.

the bit after the #) in text form.

Since
1.27
Returns
string link fragment

Implemented in Title, and TitleValue.

Referenced by MediaWiki\Linker\LinkRenderer\getLinkText(), Title\newFromLinkTarget(), Linker\normaliseSpecialPage(), and WatchedItemUnitTest\testConstruction().

◆ getInterwiki()

MediaWiki\Linker\LinkTarget::getInterwiki ( )

The interwiki component of this LinkTarget.

Since
1.27
Returns
string

Implemented in Title, and TitleValue.

Referenced by MediaWikiTitleCodec\getPrefixedDBkey(), and Title\newFromLinkTarget().

◆ getNamespace()

◆ getText()

MediaWiki\Linker\LinkTarget::getText ( )

Returns the link in text form, without namespace prefix or fragment.

This is computed from the DB key by replacing any underscores with spaces.

Since
1.27
Returns
string

Implemented in Title, and TitleValue.

Referenced by Title\compare(), MediaWikiTitleCodec\getPrefixedDBkey(), MediaWikiTitleCodec\getText(), Title\newFromLinkTarget(), and WatchedItemUnitTest\testConstruction().

◆ hasFragment()

MediaWiki\Linker\LinkTarget::hasFragment ( )

Whether the link target has a fragment.

Since
1.27
Returns
bool

Implemented in Title, and TitleValue.

Referenced by MediaWiki\Linker\LinkRenderer\getLinkText(), and MediaWiki\Linker\LinkRenderer\makeBrokenLink().

◆ inNamespace()

MediaWiki\Linker\LinkTarget::inNamespace (   $ns)

Convenience function to test if it is in the namespace.

Since
1.27
Parameters
int$ns
Returns
bool

Implemented in Title, and TitleValue.

Referenced by LinkCache\addLinkObj().

◆ isExternal()

MediaWiki\Linker\LinkTarget::isExternal ( )

Whether this LinkTarget has an interwiki component.

Since
1.27
Returns
bool

Implemented in Title, and TitleValue.

Referenced by LinkCache\addLinkObj(), MediaWikiTitleCodec\getPrefixedDBkey(), MediaWiki\Linker\LinkRenderer\makeKnownLink(), and Linker\normaliseSpecialPage().


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