MediaWiki  1.33.0
Go to the documentation of this file.
1 <?php
12  private $skin;
14  private $messages;
17  private function initMessagesHref() {
18  # List of default messages for the sidebar. The sidebar doesn't care at
19  # all whether they are full URLs, interwiki links or local titles.
20  $URL_messages = [
21  'mainpage',
22  'portal-url',
23  'currentevents-url',
24  'recentchanges-url',
25  'randompage-url',
26  'helppage',
27  ];
29  # We're assuming that isValidURI works as advertised: it's also
30  # tested separately, in tests/phpunit/includes/HttpTest.php.
31  foreach ( $URL_messages as $m ) {
32  $titleName = MessageCache::singleton()->get( $m );
33  if ( Http::isValidURI( $titleName ) ) {
34  $this->messages[$m]['href'] = $titleName;
35  } else {
36  $title = Title::newFromText( $titleName );
37  $this->messages[$m]['href'] = $title->getLocalURL();
38  }
39  }
40  }
42  protected function setUp() {
43  parent::setUp();
44  $this->initMessagesHref();
45  $this->skin = new SkinTemplate();
46  $this->skin->getContext()->setLanguage( Language::factory( 'en' ) );
47  }
56  private function assertSideBar( $expected, $text, $message = '' ) {
57  $bar = [];
58  $this->skin->addToSidebarPlain( $bar, $text );
59  $this->assertEquals( $expected, $bar, $message );
60  }
65  public function testSidebarWithOnlyTwoTitles() {
66  $this->assertSideBar(
67  [
68  'Title1' => [],
69  'Title2' => [],
70  ],
71  '* Title1
72 * Title2
73 '
74  );
75  }
80  public function testExpandMessages() {
81  $this->assertSideBar(
82  [ 'Title' => [
83  [
84  'text' => 'Help',
85  'href' => $this->messages['helppage']['href'],
86  'id' => 'n-help',
87  'active' => null
88  ]
89  ] ],
90  '* Title
91 ** helppage|help
92 '
93  );
94  }
100  $this->setMwGlobals( [
101  'wgNoFollowLinks' => true,
102  'wgNoFollowDomainExceptions' => [],
103  'wgNoFollowNsExceptions' => [],
104  ] );
105  $this->assertSideBar(
106  [ 'Title' => [
107  # **| Home
108  [
109  'text' => 'Home',
110  'href' => '',
111  'id' => 'n-Home',
112  'active' => null,
113  'rel' => 'nofollow',
114  ],
115  # **
116  # ... skipped since it is missing a pipe with a description
117  ] ],
118  '* Title
119 **| Home
120 **
121 '
122  );
123  }
130  public function testTrickyPipe() {
131  $this->assertSideBar(
132  [ 'Title' => [
133  # The first 2 are skipped
134  # Doesn't really test the url properly
135  # because it will vary with $wgArticlePath et al.
136  # ** Baz|Fred
137  [
138  'text' => 'Fred',
139  'href' => Title::newFromText( 'Baz' )->getLocalURL(),
140  'id' => 'n-Fred',
141  'active' => null,
142  ],
143  [
144  'text' => 'title-to-display',
145  'href' => Title::newFromText( 'page-to-go-to' )->getLocalURL(),
146  'id' => 'n-title-to-display',
147  'active' => null,
148  ],
149  ] ],
150  '* Title
151 ** {{PAGENAME|Foo}}
152 ** Bar
153 ** Baz|Fred
154 ** {{PLURAL:1|page-to-go-to{{int:pipe-separator/en}}title-to-display|branch not taken}}
155 '
156  );
157  }
159  #### Attributes for external links ##########################
160  private function getAttribs() {
161  # Sidebar text we will use everytime
162  $text = '* Title
163 **| Home';
165  $bar = [];
166  $this->skin->addToSidebarPlain( $bar, $text );
168  return $bar['Title'][0];
169  }
176  $this->setMwGlobals( [
177  'wgNoFollowLinks' => true,
178  'wgNoFollowDomainExceptions' => [],
179  'wgNoFollowNsExceptions' => [],
180  'wgExternalLinkTarget' => false,
181  ] );
182  $attribs = $this->getAttribs();
184  $this->assertArrayHasKey( 'rel', $attribs );
185  $this->assertEquals( 'nofollow', $attribs['rel'] );
187  $this->assertArrayNotHasKey( 'target', $attribs );
188  }
194  public function testRespectWgnofollowlinks() {
195  $this->setMwGlobals( 'wgNoFollowLinks', false );
197  $attribs = $this->getAttribs();
198  $this->assertArrayNotHasKey( 'rel', $attribs,
199  'External URL in sidebar do not have rel=nofollow when $wgNoFollowLinks = false'
200  );
201  }
208  public function testRespectExternallinktarget( $externalLinkTarget ) {
209  $this->setMwGlobals( 'wgExternalLinkTarget', $externalLinkTarget );
211  $attribs = $this->getAttribs();
212  $this->assertArrayHasKey( 'target', $attribs );
213  $this->assertEquals( $attribs['target'], $externalLinkTarget );
214  }
216  public static function dataRespectExternallinktarget() {
217  return [
218  [ '_blank' ],
219  [ '_self' ],
220  ];
221  }
222 }
static dataRespectExternallinktarget()
Definition: SideBarTest.php:216
Build $this->messages array.
Definition: SideBarTest.php:17
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
T35321 - Make sure there's a | after transforming.
Definition: SideBarTest.php:130
Definition: SideBarTest.php:42
@covers SkinTemplate::addToSidebarPlain
Definition: SideBarTest.php:99
testRespectExternallinktarget( $externalLinkTarget)
Test $wgExternaLinkTarget in sidebar dataRespectExternallinktarget Skin::addToSidebarPlain.
Definition: SideBarTest.php:208
SkinTemplate $skin
A skin template, reinitialized before each test.
Definition: SideBarTest.php:12
while(( $__line=Maintenance::readconsole()) !==false) print n
Definition: eval.php:64
@covers SkinTemplate::addToSidebarPlain
Definition: SideBarTest.php:65
=Architecture==Two class hierarchies are used to provide the functionality associated with the different content models:*Content interface(and AbstractContent base class) define functionality that acts on the concrete content of a page, and *ContentHandler base class provides functionality specific to a content model, but not acting on concrete content. The most important function of ContentHandler is to act as a factory for the appropriate implementation of Content. These Content objects are to be used by MediaWiki everywhere, instead of passing page content around as text. All manipulation and analysis of page content must be done via the appropriate methods of the Content object. For each content model, a subclass of ContentHandler has to be registered with $wgContentHandlers. The ContentHandler object for a given content model can be obtained using ContentHandler::getForModelID($id). Also Title, WikiPage and Revision now have getContentHandler() methods for convenience. ContentHandler objects are singletons that provide functionality specific to the content type, but not directly acting on the content of some page. ContentHandler::makeEmptyContent() and ContentHandler::unserializeContent() can be used to create a Content object of the appropriate type. However, it is recommended to instead use WikiPage::getContent() resp. Revision::getContent() to get a page 's content as a Content object. These two methods should be the ONLY way in which page content is accessed. Another important function of ContentHandler objects is to define custom action handlers for a content model, see ContentHandler::getActionOverrides(). This is similar to what WikiPage::getActionOverrides() was already doing.==Serialization==With the ContentHandler facility, page content no longer has to be text based. Objects implementing the Content interface are used to represent and handle the content internally. For storage and data exchange, each content model supports at least one serialization format via ContentHandler::serializeContent($content). The list of supported formats for a given content model can be accessed using ContentHandler::getSupportedFormats(). Content serialization formats are identified using MIME type like strings. The following formats are built in:*text/x-wiki - wikitext *text/javascript - for js pages *text/css - for css pages *text/plain - for future use, e.g. with plain text messages. *text/html - for future use, e.g. with plain html messages. *application/vnd.php.serialized - for future use with the api and for extensions *application/json - for future use with the api, and for use by extensions *application/xml - for future use with the api, and for use by extensions In PHP, use the corresponding CONTENT_FORMAT_XXX constant. Note that when using the API to access page content, especially action=edit, action=parse and action=query &prop=revisions, the model and format of the content should always be handled explicitly. Without that information, interpretation of the provided content is not reliable. The same applies to XML dumps generated via maintenance/dumpBackup.php or Special:Export. Also note that the API will provide encapsulated, serialized content - so if the API was called with format=json, and contentformat is also json(or rather, application/json), the page content is represented as a string containing an escaped json structure. Extensions that use JSON to serialize some types of page content may provide specialized API modules that allow access to that content in a more natural form.==Compatibility==The ContentHandler facility is introduced in a way that should allow all existing code to keep functioning at least for pages that contain wikitext or other text based content. However, a number of functions and hooks have been deprecated in favor of new versions that are aware of the page 's content model, and will now generate warnings when used. Most importantly, the following functions have been deprecated:*Revisions::getText() is deprecated in favor Revisions::getContent() *WikiPage::getText() is deprecated in favor WikiPage::getContent() Also, the old Article::getContent()(which returns text) is superceded by Article::getContentObject(). However, both methods should be avoided since they do not provide clean access to the page 's actual content. For instance, they may return a system message for non-existing pages. Use WikiPage::getContent() instead. Code that relies on a textual representation of the page content should eventually be rewritten. However, ContentHandler::getContentText() provides a stop-gap that can be used to get text for a page. Its behavior is controlled by $wgContentHandlerTextFallback it
Definition: contenthandler.txt:104
Further assume MyExt::onFoo needs service Bar
Definition: injection.txt:214
</source > ! result< div class="mw-highlight mw-content-ltr" dir="ltr">< pre >< span ></span >< span class="kd"> var</span >< span class="nx"> a</span >< span class="p"></span ></pre ></div > ! end ! test Multiline< source/> in lists !input *< source > a b</source > *foo< source > a b</source > ! html< ul >< li >< div class="mw-highlight mw-content-ltr" dir="ltr">< pre > a b</pre ></div ></li ></ul >< ul >< li > foo< div class="mw-highlight mw-content-ltr" dir="ltr">< pre > a b</pre ></div ></li ></ul > ! html tidy< ul >< li >< div class="mw-highlight mw-content-ltr" dir="ltr">< pre > a b</pre ></div ></li ></ul >< ul >< li > foo< div class="mw-highlight mw-content-ltr" dir="ltr">< pre > a b</pre ></div ></li ></ul > ! end ! test Custom attributes !input< source lang="javascript" id="foo" class="bar" dir="rtl" style="font-size: larger;"> var a
Definition: parserTests.txt:85
target page
Definition: All_system_messages.txt:1267
Apache License January http
Definition: APACHE-LICENSE-2.0.txt:3
This document provides an overview of the usage of PageUpdater and that is
Definition: pageupdater.txt:3
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
scripts txt MediaWiki primary scripts are in the root directory of the software Users should only use these scripts to access the wiki There are also some php that aren t primary scripts but helper files and won t work if they are accessed directly by the web Primary see https
Definition: scripts.txt:21
Local cache for sidebar messages.
Definition: SideBarTest.php:14
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
Simple test to verify our helper assertAttribs() is functional @coversNothing.
Definition: SideBarTest.php:175
setMwGlobals( $pairs, $value=null)
Sets a global, maintaining a stashed version of the previous global to be restored in tearDown.
Definition: MediaWikiTestCase.php:709
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 & $attribs
Definition: hooks.txt:1985
if not
Definition: COPYING.txt:307
static singleton()
Get the signleton instance of this class.
Definition: MessageCache.php:114
Definition: SideBarTest.php:160
assertSideBar( $expected, $text, $message='')
Internal helper to test the sidebar.
Definition: SideBarTest.php:56
@covers SkinTemplate::addToSidebarPlain
Definition: SideBarTest.php:80
Definition: parserTests.txt:245
Base class that store and restore the Language objects.
Definition: MediaWikiLangTestCase.php:8
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the whether in Source or Object that is based or other modifications as a an original work of authorship For the purposes of this Derivative Works shall not include works that remain separable or merely the Work and Derivative Works thereof Contribution shall mean any work of including the original version of the Work and any modifications or additions to that Work or Derivative Works that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner For the purposes of this submitted means any form of or written communication sent to the Licensor or its including but not limited to communication on electronic mailing source code control and issue tracking systems that are managed or on behalf the Licensor for the purpose of discussing and improving the but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as Not a Contribution Contributor shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work Grant of Copyright License Subject to the terms and conditions of this each Contributor hereby grants to You a non no royalty irrevocable copyright license to prepare Derivative Works publicly display
Definition: APACHE-LICENSE-2.0.txt:49
Definition: SideBarTest.php:6
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
Definition: All_system_messages.txt:1267
Represents a title within MediaWiki.
Definition: Title.php:40
The ContentHandler facility adds support for arbitrary content types on wiki instead of relying on wikitext for everything It was introduced in MediaWiki Each kind of and so on Built in content types are
Definition: contenthandler.txt:5
Test $wgNoFollowLinks in sidebar Skin::addToSidebarPlain.
Definition: SideBarTest.php:194
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
passed in as a query string parameter to the various URLs constructed here(i.e. $prevlink) $ldel you ll need to handle error messages
Definition: hooks.txt:1290
static isValidURI( $uri)
Check that the given URI is a valid one.
Definition: Http.php:149
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:215
shown</td >< td > a href
Definition: All_system_messages.txt:2667
Base class for template-based skins.
Definition: SkinTemplate.php:38