MediaWiki  1.29.1
Go to the documentation of this file.
1 <?php
25 if ( !defined( 'MEDIAWIKI' ) ) {
26  die( -1 );
27 }
34 class SkinModern extends SkinTemplate {
35  public $skinname = 'modern';
36  public $template = 'ModernTemplate';
42  parent::setupSkinUserCss( $out );
43  $out->addModuleStyles( 'skins.modern' );
44  }
45 }
59  function execute() {
60  $this->html( 'headelement' );
61  ?>
63  <!-- heading -->
64  <div id="mw_header">
65  <?php echo $this->getIndicators(); ?>
66  <h1 id="firstHeading" lang="<?php
67  $this->data['pageLanguage'] = $this->getSkin()->getTitle()->getPageViewLanguage()->getHtmlCode();
68  $this->text( 'pageLanguage' );
69  ?>"><?php $this->html( 'title' ) ?></h1>
70  </div>
72  <div id="mw_main">
73  <div id="mw_contentwrapper">
74  <!-- navigation portlet -->
75  <?php $this->cactions(); ?>
77  <!-- content -->
78  <div id="mw_content" role="main">
79  <!-- contentholder does nothing by default, but it allows users to style the text inside
80  the content area without affecting the meaning of 'em' in #mw_content, which is used
81  for the margins -->
82  <div id="mw_contentholder" class="mw-body">
83  <div class='mw-topboxes'>
84  <div id="mw-js-message"
85  style="display:none;"<?php $this->html( 'userlangattributes' ) ?>></div>
86  <div class="mw-topbox" id="siteSub"><?php $this->msg( 'tagline' ) ?></div>
87  <?php
88  if ( $this->data['newtalk'] ) {
89  ?>
90  <div class="usermessage mw-topbox"><?php $this->html( 'newtalk' ) ?></div>
91  <?php
92  }
93  ?>
94  <?php
95  if ( $this->data['sitenotice'] ) {
96  ?>
97  <div class="mw-topbox" id="siteNotice"><?php $this->html( 'sitenotice' ) ?></div>
98  <?php
99  }
100  ?>
101  </div>
103  <div id="contentSub"<?php
104  $this->html( 'userlangattributes' )
105  ?>><?php
106  $this->html( 'subtitle' )
107  ?></div>
109  <?php
110  if ( $this->data['undelete'] ) {
111  ?>
112  <div id="contentSub2"><?php $this->html( 'undelete' ) ?></div><?php
113  }
114  ?>
115  <div id="jump-to-nav"><?php $this->msg( 'jumpto' ) ?>
116  <a href="#mw_portlets"><?php
117  $this->msg( 'jumptonavigation' ) ?></a><?php $this->msg( 'comma-separator' )
118  ?>
119  <a href="#searchInput"><?php $this->msg( 'jumptosearch' ) ?></a>
120  </div>
122  <?php $this->html( 'bodytext' ) ?>
123  <div class='mw_clear'></div>
124  <?php
125  if ( $this->data['catlinks'] ) {
126  $this->html( 'catlinks' );
127  }
128  ?>
129  <?php $this->html( 'dataAfterContent' ) ?>
130  </div><!-- mw_contentholder -->
131  </div><!-- mw_content -->
132  </div><!-- mw_contentwrapper -->
134  <div id="mw_portlets"<?php $this->html( "userlangattributes" ) ?>>
135  <h2><?php $this->msg( 'navigation-heading' ) ?></h2>
137  <!-- portlets -->
138  <?php $this->renderPortals( $this->data['sidebar'] ); ?>
140  </div><!-- mw_portlets -->
143  </div><!-- main -->
145  <div class="mw_clear"></div>
147  <!-- personal portlet -->
148  <div class="portlet" id="p-personal" role="navigation">
149  <h3><?php $this->msg( 'personaltools' ) ?></h3>
151  <div class="pBody">
152  <ul>
153  <?php
154  foreach ( $this->getPersonalTools() as $key => $item ) {
155  ?>
156  <?php echo $this->makeListItem( $key, $item ); ?>
158  <?php
159  }
160  ?>
161  </ul>
162  </div>
163  </div>
166  <!-- footer -->
167  <div id="footer" role="contentinfo"<?php $this->html( 'userlangattributes' ) ?>>
168  <ul id="f-list">
169  <?php
170  foreach ( $this->getFooterLinks( "flat" ) as $aLink ) {
171  if ( isset( $this->data[$aLink] ) && $this->data[$aLink] ) {
172  ?>
173  <li id="<?php echo $aLink ?>"><?php $this->html( $aLink ) ?></li>
174  <?php
175  }
176  }
177  ?>
178  </ul>
179  <?php
180  foreach ( $this->getFooterIcons( "nocopyright" ) as $blockName => $footerIcons ) {
181  ?>
182  <div id="mw_<?php echo htmlspecialchars( $blockName ); ?>">
183  <?php
184  foreach ( $footerIcons as $icon ) {
185  ?>
186  <?php echo $this->getSkin()->makeFooterIcon( $icon, 'withoutImage' ); ?>
188  <?php
189  } ?>
190  </div>
191  <?php
192  }
193  ?>
194  </div>
196  <?php $this->printTrail(); ?>
198  </body>
199 </html>
200  <?php
201  } // end of execute() method
202 } // end of class
Create an array of personal tools items from the data in the quicktemplate stored by SkinTemplate.
Definition: BaseTemplate.php:131
getFooterLinks( $option=null)
Returns an array of footerlinks trimmed down to only those footer links that are valid.
Definition: BaseTemplate.php:585
msg( $str)
Definition: BaseTemplate.php:39
per default it will return the text for text based content
Definition: contenthandler.txt:104
We use the convention $dbr for read and $dbw for write to help you keep track of whether the database object is a the world will explode Or to be a subsequent write query which succeeded on the master may fail when replicated to the slave due to a unique key collision Replication on the slave will stop and it may take hours to repair the database and get it back online Setting read_only in my cnf on the slave will avoid this but given the dire we prefer to have as many checks as possible We provide a but the wrapper functions like please read the documentation for except in special pages derived from QueryPage It s a common pitfall for new developers to submit code containing SQL queries which examine huge numbers of rows Remember that COUNT * is(N), counting rows in atable is like counting beans in a bucket.------------------------------------------------------------------------ Replication------------------------------------------------------------------------The largest installation of MediaWiki, Wikimedia, uses a large set ofslave MySQL servers replicating writes made to a master MySQL server. Itis important to understand the issues associated with this setup if youwant to write code destined for Wikipedia.It 's often the case that the best algorithm to use for a given taskdepends on whether or not replication is in use. Due to our unabashedWikipedia-centrism, we often just use the replication-friendly version, but if you like, you can use wfGetLB() ->getServerCount() > 1 tocheck to see if replication is in use.===Lag===Lag primarily occurs when large write queries are sent to the master.Writes on the master are executed in parallel, but they are executed inserial when they are replicated to the slaves. The master writes thequery to the binlog when the transaction is committed. The slaves pollthe binlog and start executing the query as soon as it appears. They canservice reads while they are performing a write query, but will not readanything more from the binlog and thus will perform no more writes. Thismeans that if the write query runs for a long time, the slaves will lagbehind the master for the time it takes for the write query to complete.Lag can be exacerbated by high read load. MediaWiki 's load balancer willstop sending reads to a slave when it is lagged by more than 30 seconds.If the load ratios are set incorrectly, or if there is too much loadgenerally, this may lead to a slave permanently hovering around 30seconds lag.If all slaves are lagged by more than 30 seconds, MediaWiki will stopwriting to the database. All edits and other write operations will berefused, with an error returned to the user. This gives the slaves achance to catch up. Before we had this mechanism, the slaves wouldregularly lag by several minutes, making review of recent editsdifficult.In addition to this, MediaWiki attempts to ensure that the user seesevents occurring on the wiki in chronological order. A few seconds of lagcan be tolerated, as long as the user sees a consistent picture fromsubsequent requests. This is done by saving the master binlog positionin the session, and then at the start of each request, waiting for theslave to catch up to that position before doing any reads from it. Ifthis wait times out, reads are allowed anyway, but the request isconsidered to be in "lagged slave mode". Lagged slave mode can bechecked by calling wfGetLB() ->getLaggedSlaveMode(). The onlypractical consequence at present is a warning displayed in the pagefooter.===Lag avoidance===To avoid excessive lag, queries which write large numbers of rows shouldbe split up, generally to write one row at a time. Multi-row INSERT ...SELECT queries are the worst offenders should be avoided altogether.Instead do the select first and then the insert.===Working with lag===Despite our best efforts, it 's not practical to guarantee a low-lagenvironment. Lag will usually be less than one second, but mayoccasionally be up to 30 seconds. For scalability, it 's very importantto keep load on the master low, so simply sending all your queries tothe master is not the answer. So when you have a genuine need forup-to-date data, the following approach is advised:1) Do a quick query to the master for a sequence number or timestamp 2) Run the full query on the slave and check if it matches the data you gotfrom the master 3) If it doesn 't, run the full query on the masterTo avoid swamping the master every time the slaves lag, use of thisapproach should be kept to a minimum. In most cases you should just readfrom the slave and let the user deal with the delay.------------------------------------------------------------------------ Lock contention------------------------------------------------------------------------Due to the high write rate on Wikipedia(and some other wikis), MediaWiki developers need to be very careful to structure their writesto avoid long-lasting locks. By default, MediaWiki opens a transactionat the first query, and commits it before the output is sent. Locks willbe held from the time when the query is done until the commit. So youcan reduce lock time by doing as much processing as possible before youdo your write queries.Often this approach is not good enough, and it becomes necessary toenclose small groups of queries in their own transaction. Use thefollowing syntax:$dbw=wfGetDB(DB_MASTER
Definition: SkinModern.php:36
Inherit main code from SkinTemplate, set the CSS and template filter.
Definition: SkinModern.php:34
=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
This document describes the XML format used to represent information about external sites known to a MediaWiki installation This information about external sites is used to allow inter wiki cross language navigation
Definition: sitelist.txt:3
Get the Skin object related to this object.
Definition: QuickTemplate.php:173
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
setupSkinUserCss(OutputPage $out)
Definition: SkinModern.php:41
def main()
you don t have to do a grep find to see where the $wgReverseTitle variable is used
Definition: hooks.txt:117
</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:89
renderPortals( $sidebar)
Definition: MonoBookTemplate.php:214
null for the wiki Added in
Definition: hooks.txt:1572
Definition: SkinModern.php:51
Output getTrail.
Definition: BaseTemplate.php:751
makeListItem( $key, $item, $options=[])
Generates a list item for a navigation, portlet, portal, sidebar...
Definition: BaseTemplate.php:474
Definition: parserTests.txt:6533
Template filter callback for Modern skin.
Definition: SkinModern.php:59
Get the suggested HTML for page status indicators: icons (or short text snippets) usually displayed i...
Definition: BaseTemplate.php:732
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 by
Definition: APACHE-LICENSE-2.0.txt:49
This class should be covered by a general architecture document which does not exist as of January 20...
Definition: OutputPage.php:44
Definition: SkinModern.php:35
$this text( 'searchtitle')
Definition: MonoBookTemplate.php:252
foreach( $validFooterIcons as $blockName=> $footerIcons) foreach( $footerIcons as $icon) if(count( $validFooterLinks) > 0) $this html( $aLink)
Definition: MonoBookTemplate.php:190
Definition: MonoBookTemplate.php:30
Prints the content actions (cactions) bar.
Definition: MonoBookTemplate.php:287
Bar style
Definition: parserTests.txt:184
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
globals txt Globals are evil The original MediaWiki code relied on globals for processing context far too often MediaWiki development since then has been a story of slowly moving context out of global variables and into objects Storing processing context in object member variables allows those objects to be reused in a much more flexible way Consider the elegance of
Definition: globals.txt:10
getFooterIcons( $option=null)
Returns an array of footer icons filtered down by options relevant to how the skin wishes to display ...
Definition: BaseTemplate.php:625
shown</td >< td > a href
Definition: All_system_messages.txt:2667
Base class for template-based skins.
Definition: SkinTemplate.php:38
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of data
Definition: hooks.txt:6
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:783