MediaWiki  1.33.0
LinkRendererTest.php
Go to the documentation of this file.
1 <?php
2 
6 
10 class LinkRendererTest extends MediaWikiLangTestCase {
11 
15  private $factory;
16 
17  public function setUp() {
18  parent::setUp();
19  $this->setMwGlobals( [
20  'wgArticlePath' => '/wiki/$1',
21  'wgServer' => '//example.org',
22  'wgCanonicalServer' => 'http://example.org',
23  'wgScriptPath' => '/w',
24  'wgScript' => '/w/index.php',
25  ] );
26  $this->factory = MediaWikiServices::getInstance()->getLinkRendererFactory();
27  }
28 
29  public function testMergeAttribs() {
30  $target = new TitleValue( NS_SPECIAL, 'Blankpage' );
31  $linkRenderer = $this->factory->create();
32  $link = $linkRenderer->makeBrokenLink( $target, null, [
33  // Appended to class
34  'class' => 'foobar',
35  // Suppresses href attribute
36  'href' => false,
37  // Extra attribute
38  'bar' => 'baz'
39  ] );
40  $this->assertEquals(
41  '<a href="/wiki/Special:BlankPage" class="new foobar" '
42  . 'title="Special:BlankPage (page does not exist)" bar="baz">'
43  . 'Special:BlankPage</a>',
44  $link
45  );
46  }
47 
48  public function testMakeKnownLink() {
49  $target = new TitleValue( NS_MAIN, 'Foobar' );
50  $linkRenderer = $this->factory->create();
51 
52  // Query added
53  $this->assertEquals(
54  '<a href="/w/index.php?title=Foobar&amp;foo=bar" title="Foobar">Foobar</a>',
55  $linkRenderer->makeKnownLink( $target, null, [], [ 'foo' => 'bar' ] )
56  );
57 
58  $linkRenderer->setForceArticlePath( true );
59  $this->assertEquals(
60  '<a href="/wiki/Foobar?foo=bar" title="Foobar">Foobar</a>',
61  $linkRenderer->makeKnownLink( $target, null, [], [ 'foo' => 'bar' ] )
62  );
63 
64  // expand = HTTPS
65  $linkRenderer->setForceArticlePath( false );
66  $linkRenderer->setExpandURLs( PROTO_HTTPS );
67  $this->assertEquals(
68  '<a href="https://example.org/wiki/Foobar" title="Foobar">Foobar</a>',
69  $linkRenderer->makeKnownLink( $target )
70  );
71  }
72 
73  public function testMakeBrokenLink() {
74  $target = new TitleValue( NS_MAIN, 'Foobar' );
75  $special = new TitleValue( NS_SPECIAL, 'Foobar' );
76  $linkRenderer = $this->factory->create();
77 
78  // action=edit&redlink=1 added
79  $this->assertEquals(
80  '<a href="/w/index.php?title=Foobar&amp;action=edit&amp;redlink=1" '
81  . 'class="new" title="Foobar (page does not exist)">Foobar</a>',
82  $linkRenderer->makeBrokenLink( $target )
83  );
84 
85  // action=edit&redlink=1 not added due to action query parameter
86  $this->assertEquals(
87  '<a href="/w/index.php?title=Foobar&amp;action=foobar" class="new" '
88  . 'title="Foobar (page does not exist)">Foobar</a>',
89  $linkRenderer->makeBrokenLink( $target, null, [], [ 'action' => 'foobar' ] )
90  );
91 
92  // action=edit&redlink=1 not added due to NS_SPECIAL
93  $this->assertEquals(
94  '<a href="/wiki/Special:Foobar" class="new" title="Special:Foobar '
95  . '(page does not exist)">Special:Foobar</a>',
96  $linkRenderer->makeBrokenLink( $special )
97  );
98 
99  // fragment stripped
100  $this->assertEquals(
101  '<a href="/w/index.php?title=Foobar&amp;action=edit&amp;redlink=1" '
102  . 'class="new" title="Foobar (page does not exist)">Foobar</a>',
103  $linkRenderer->makeBrokenLink( $target->createFragmentTarget( 'foobar' ) )
104  );
105  }
106 
107  public function testMakeLink() {
108  $linkRenderer = $this->factory->create();
109  $foobar = new TitleValue( NS_SPECIAL, 'Foobar' );
110  $blankpage = new TitleValue( NS_SPECIAL, 'Blankpage' );
111  $this->assertEquals(
112  '<a href="/wiki/Special:Foobar" class="new" title="Special:Foobar '
113  . '(page does not exist)">foo</a>',
114  $linkRenderer->makeLink( $foobar, 'foo' )
115  );
116 
117  $this->assertEquals(
118  '<a href="/wiki/Special:BlankPage" title="Special:BlankPage">blank</a>',
119  $linkRenderer->makeLink( $blankpage, 'blank' )
120  );
121 
122  $this->assertEquals(
123  '<a href="/wiki/Special:Foobar" class="new" title="Special:Foobar '
124  . '(page does not exist)">&lt;script&gt;evil()&lt;/script&gt;</a>',
125  $linkRenderer->makeLink( $foobar, '<script>evil()</script>' )
126  );
127 
128  $this->assertEquals(
129  '<a href="/wiki/Special:Foobar" class="new" title="Special:Foobar '
130  . '(page does not exist)"><script>evil()</script></a>',
131  $linkRenderer->makeLink( $foobar, new HtmlArmor( '<script>evil()</script>' ) )
132  );
133 
134  $this->assertEquals(
135  '<a href="#fragment">fragment</a>',
136  $linkRenderer->makeLink( Title::newFromText( '#fragment' ) )
137  );
138  }
139 
140  public function testGetLinkClasses() {
141  $wanCache = ObjectCache::getMainWANInstance();
142  $titleFormatter = MediaWikiServices::getInstance()->getTitleFormatter();
143  $linkCache = new LinkCache( $titleFormatter, $wanCache );
144  $foobarTitle = new TitleValue( NS_MAIN, 'FooBar' );
145  $redirectTitle = new TitleValue( NS_MAIN, 'Redirect' );
146  $userTitle = new TitleValue( NS_USER, 'Someuser' );
147  $linkCache->addGoodLinkObj(
148  1, // id
149  $foobarTitle,
150  10, // len
151  0 // redir
152  );
153  $linkCache->addGoodLinkObj(
154  2, // id
155  $redirectTitle,
156  10, // len
157  1 // redir
158  );
159 
160  $linkCache->addGoodLinkObj(
161  3, // id
162  $userTitle,
163  10, // len
164  0 // redir
165  );
166 
167  $linkRenderer = new LinkRenderer( $titleFormatter, $linkCache );
168  $linkRenderer->setStubThreshold( 0 );
169  $this->assertEquals(
170  '',
171  $linkRenderer->getLinkClasses( $foobarTitle )
172  );
173 
174  $linkRenderer->setStubThreshold( 20 );
175  $this->assertEquals(
176  'stub',
177  $linkRenderer->getLinkClasses( $foobarTitle )
178  );
179 
180  $linkRenderer->setStubThreshold( 0 );
181  $this->assertEquals(
182  'mw-redirect',
183  $linkRenderer->getLinkClasses( $redirectTitle )
184  );
185 
186  $linkRenderer->setStubThreshold( 20 );
187  $this->assertEquals(
188  '',
189  $linkRenderer->getLinkClasses( $userTitle )
190  );
191  }
192 
193  function tearDown() {
195  parent::tearDown();
196  }
197 }
LinkCache
Cache for article titles (prefixed DB keys) and ids linked from one source.
Definition: LinkCache.php:34
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:306
HtmlArmor
Marks HTML that shouldn't be escaped.
Definition: HtmlArmor.php:28
Title\clearCaches
static clearCaches()
Text form (spaces not underscores) of the main part.
Definition: Title.php:3095
MediaWiki\Linker\LinkRenderer
Class that generates HTML links for pages.
Definition: LinkRenderer.php:41
MediaWiki\Linker\LinkRendererFactory
Factory to create LinkRender objects.
Definition: LinkRendererFactory.php:31
$linkRenderer
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form before processing starts Return false to skip default processing and return $ret $linkRenderer
Definition: hooks.txt:1985
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
NS_MAIN
const NS_MAIN
Definition: Defines.php:64
NS_SPECIAL
const NS_SPECIAL
Definition: Defines.php:53
MediaWikiTestCase\setMwGlobals
setMwGlobals( $pairs, $value=null)
Sets a global, maintaining a stashed version of the previous global to be restored in tearDown.
Definition: MediaWikiTestCase.php:709
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
PROTO_HTTPS
const PROTO_HTTPS
Definition: Defines.php:220
MediaWikiLangTestCase\setUp
setUp()
Definition: MediaWikiLangTestCase.php:9
MediaWikiLangTestCase
Base class that store and restore the Language objects.
Definition: MediaWikiLangTestCase.php:8
ObjectCache\getMainWANInstance
static getMainWANInstance()
Get the main WAN cache object.
Definition: ObjectCache.php:369
NS_USER
const NS_USER
Definition: Defines.php:66
$link
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3053
MediaWikiServices
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
MediaWikiTestCase\tearDown
tearDown()
Definition: MediaWikiTestCase.php:547
TitleValue
Represents a page (or page fragment) title within MediaWiki.
Definition: TitleValue.php:36