MediaWiki  1.30.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  // forcearticlepath
59  $linkRenderer->setForceArticlePath( true );
60  $this->assertEquals(
61  '<a href="/wiki/Foobar?foo=bar" title="Foobar">Foobar</a>',
62  $linkRenderer->makeKnownLink( $target, null, [], [ 'foo' => 'bar' ] )
63  );
64 
65  // expand = HTTPS
66  $linkRenderer->setForceArticlePath( false );
67  $linkRenderer->setExpandURLs( PROTO_HTTPS );
68  $this->assertEquals(
69  '<a href="https://example.org/wiki/Foobar" title="Foobar">Foobar</a>',
70  $linkRenderer->makeKnownLink( $target )
71  );
72  }
73 
74  public function testMakeBrokenLink() {
75  $target = new TitleValue( NS_MAIN, 'Foobar' );
76  $special = new TitleValue( NS_SPECIAL, 'Foobar' );
77  $linkRenderer = $this->factory->create();
78 
79  // action=edit&redlink=1 added
80  $this->assertEquals(
81  '<a href="/w/index.php?title=Foobar&amp;action=edit&amp;redlink=1" '
82  . 'class="new" title="Foobar (page does not exist)">Foobar</a>',
83  $linkRenderer->makeBrokenLink( $target )
84  );
85 
86  // action=edit&redlink=1 not added due to action query parameter
87  $this->assertEquals(
88  '<a href="/w/index.php?title=Foobar&amp;action=foobar" class="new" '
89  . 'title="Foobar (page does not exist)">Foobar</a>',
90  $linkRenderer->makeBrokenLink( $target, null, [], [ 'action' => 'foobar' ] )
91  );
92 
93  // action=edit&redlink=1 not added due to NS_SPECIAL
94  $this->assertEquals(
95  '<a href="/wiki/Special:Foobar" class="new" title="Special:Foobar '
96  . '(page does not exist)">Special:Foobar</a>',
97  $linkRenderer->makeBrokenLink( $special )
98  );
99 
100  // fragment stripped
101  $this->assertEquals(
102  '<a href="/w/index.php?title=Foobar&amp;action=edit&amp;redlink=1" '
103  . 'class="new" title="Foobar (page does not exist)">Foobar</a>',
104  $linkRenderer->makeBrokenLink( $target->createFragmentTarget( 'foobar' ) )
105  );
106  }
107 
108  public function testMakeLink() {
109  $linkRenderer = $this->factory->create();
110  $foobar = new TitleValue( NS_SPECIAL, 'Foobar' );
111  $blankpage = new TitleValue( NS_SPECIAL, 'Blankpage' );
112  $this->assertEquals(
113  '<a href="/wiki/Special:Foobar" class="new" title="Special:Foobar '
114  . '(page does not exist)">foo</a>',
115  $linkRenderer->makeLink( $foobar, 'foo' )
116  );
117 
118  $this->assertEquals(
119  '<a href="/wiki/Special:BlankPage" title="Special:BlankPage">blank</a>',
120  $linkRenderer->makeLink( $blankpage, 'blank' )
121  );
122 
123  $this->assertEquals(
124  '<a href="/wiki/Special:Foobar" class="new" title="Special:Foobar '
125  . '(page does not exist)">&lt;script&gt;evil()&lt;/script&gt;</a>',
126  $linkRenderer->makeLink( $foobar, '<script>evil()</script>' )
127  );
128 
129  $this->assertEquals(
130  '<a href="/wiki/Special:Foobar" class="new" title="Special:Foobar '
131  . '(page does not exist)"><script>evil()</script></a>',
132  $linkRenderer->makeLink( $foobar, new HtmlArmor( '<script>evil()</script>' ) )
133  );
134  }
135 
136  public function testGetLinkClasses() {
137  $wanCache = ObjectCache::getMainWANInstance();
138  $titleFormatter = MediaWikiServices::getInstance()->getTitleFormatter();
139  $linkCache = new LinkCache( $titleFormatter, $wanCache );
140  $foobarTitle = new TitleValue( NS_MAIN, 'FooBar' );
141  $redirectTitle = new TitleValue( NS_MAIN, 'Redirect' );
142  $userTitle = new TitleValue( NS_USER, 'Someuser' );
143  $linkCache->addGoodLinkObj(
144  1, // id
145  $foobarTitle,
146  10, // len
147  0 // redir
148  );
149  $linkCache->addGoodLinkObj(
150  2, // id
151  $redirectTitle,
152  10, // len
153  1 // redir
154  );
155 
156  $linkCache->addGoodLinkObj(
157  3, // id
158  $userTitle,
159  10, // len
160  0 // redir
161  );
162 
163  $linkRenderer = new LinkRenderer( $titleFormatter, $linkCache );
164  $linkRenderer->setStubThreshold( 0 );
165  $this->assertEquals(
166  '',
167  $linkRenderer->getLinkClasses( $foobarTitle )
168  );
169 
170  $linkRenderer->setStubThreshold( 20 );
171  $this->assertEquals(
172  'stub',
173  $linkRenderer->getLinkClasses( $foobarTitle )
174  );
175 
176  $linkRenderer->setStubThreshold( 0 );
177  $this->assertEquals(
178  'mw-redirect',
179  $linkRenderer->getLinkClasses( $redirectTitle )
180  );
181 
182  $linkRenderer->setStubThreshold( 20 );
183  $this->assertEquals(
184  '',
185  $linkRenderer->getLinkClasses( $userTitle )
186  );
187  }
188 
189 }
LinkCache
Cache for article titles (prefixed DB keys) and ids linked from one source.
Definition: LinkCache.php:34
HtmlArmor
Marks HTML that shouldn't be escaped.
Definition: HtmlArmor.php:28
MediaWiki\Linker\LinkRenderer
Class that generates HTML links for pages.
Definition: LinkRenderer.php:42
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
MediaWiki\Linker\LinkRendererFactory
Factory to create LinkRender objects.
Definition: LinkRendererFactory.php:32
$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:1965
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:65
NS_SPECIAL
const NS_SPECIAL
Definition: Defines.php:54
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:672
PROTO_HTTPS
const PROTO_HTTPS
Definition: Defines.php:221
MediaWikiLangTestCase\setUp
setUp()
Definition: MediaWikiLangTestCase.php:7
MediaWikiLangTestCase
Base class that store and restore the Language objects.
Definition: MediaWikiLangTestCase.php:6
$special
this hook is for auditing only RecentChangesLinked and Watchlist $special
Definition: hooks.txt:988
ObjectCache\getMainWANInstance
static getMainWANInstance()
Get the main WAN cache object.
Definition: ObjectCache.php:370
NS_USER
const NS_USER
Definition: Defines.php:67
$link
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:2981
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
TitleValue
Represents a page (or page fragment) title within MediaWiki.
Definition: TitleValue.php:36