MediaWiki  1.23.12
Modern.php
Go to the documentation of this file.
1 <?php
25 if ( !defined( 'MEDIAWIKI' ) ) {
26  die( -1 );
27 }
28
34 class SkinModern extends SkinTemplate {
35  var $skinname = 'modern',$stylename = 'modern',
36  $template = 'ModernTemplate',$useHeadElement = true;
37
42  parent::setupSkinUserCss( $out ); 43$out->addModuleStyles( 'skins.modern' );
44  }
45 }
46
52
61  function execute() {
62  // Suppress warnings to prevent notices about missing indexes in $this->data 64 65$this->html( 'headelement' );
66 ?>
67
70  $this->data['pageLanguage'] =$this->getSkin()->getTitle()->getPageViewLanguage()->getHtmlCode();
71  $this->text( 'pageLanguage' ); 72 ?>"><span dir="auto"><?php$this->html( 'title' ) ?></span></h1></div>
73
74  <div id="mw_main">
75  <div id="mw_contentwrapper">
77 <?php $this->cactions(); ?> 78 79 <!-- content --> 80 <div id="mw_content" role="main"> 81 <!-- contentholder does nothing by default, but it allows users to style the text inside 82 the content area without affecting the meaning of 'em' in #mw_content, which is used 83 for the margins --> 84 <div id="mw_contentholder" class="mw-body"> 85 <div class='mw-topboxes'> 86 <div id="mw-js-message" style="display:none;"<?php$this->html( 'userlangattributes' ) ?>></div>
87  <div class="mw-topbox" id="siteSub"><?php $this->msg( 'tagline' ) ?></div> 88 <?php if ($this->data['newtalk'] ) {
89  ?><div class="usermessage mw-topbox"><?php $this->html( 'newtalk' ) ?></div> 90 <?php } ?> 91 <?php if ($this->data['sitenotice'] ) {
92  ?><div class="mw-topbox" id="siteNotice"><?php $this->html( 'sitenotice' ) ?></div> 93 <?php } ?> 94 </div> 95 96 <div id="contentSub"<?php$this->html( 'userlangattributes' ) ?>><?php $this->html( 'subtitle' ) ?></div> 97 98 <?php if ($this->data['undelete'] ) { ?><div id="contentSub2"><?php $this->html( 'undelete' ) ?></div><?php } ?> 99 <div id="jump-to-nav"><?php$this->msg( 'jumpto' ) ?> <a href="#mw_portlets"><?php $this->msg( 'jumptonavigation' ) ?></a><?php$this->msg( 'comma-separator' ) ?><a href="#searchInput"><?php $this->msg( 'jumptosearch' ) ?></a></div> 100 101 <?php$this->html( 'bodytext' ) ?>
102  <div class='mw_clear'></div>
103  <?php if ( $this->data['catlinks'] ) {$this->html( 'catlinks' ); } ?>
104  <?php $this->html( 'dataAfterContent' ) ?> 105 </div><!-- mw_contentholder --> 106 </div><!-- mw_content --> 107 </div><!-- mw_contentwrapper --> 108 109 <div id="mw_portlets"<?php$this->html( "userlangattributes" ) ?>>
110  <h2><?php $this->msg( 'navigation-heading' ) ?></h2> 111 112 <!-- portlets --> 113 <?php$this->renderPortals( $this->data['sidebar'] ); ?> 114 115 </div><!-- mw_portlets --> 116 117 118 </div><!-- main --> 119 120 <div class="mw_clear"></div> 121 122 <!-- personal portlet --> 123 <div class="portlet" id="p-personal" role="navigation"> 124 <h3><?php$this->msg( 'personaltools' ) ?></h3>
125  <div class="pBody">
126  <ul>
127 <?php foreach ( $this->getPersonalTools() as$key => $item ) { ?> 128 <?php echo$this->makeListItem( $key,$item ); ?>
129
130 <?php } ?>
131  </ul>
132  </div>
133  </div>
134
135
136  <!-- footer -->
137  <div id="footer" role="contentinfo"<?php $this->html( 'userlangattributes' ) ?>> 138 <ul id="f-list"> 139 <?php 140 foreach ($this->getFooterLinks( "flat" ) as $aLink ) { 141 if ( isset($this->data[$aLink] ) &&$this->data[$aLink] ) { 142 ?> <li id="<?php echo$aLink ?>"><?php $this->html($aLink ) ?></li>
143 <?php }
144  }
145 ?>
146  </ul>
147 <?php
148  foreach ( $this->getFooterIcons( "nocopyright" ) as$blockName => $footerIcons ) { ?> 149 <div id="mw_<?php echo htmlspecialchars($blockName ); ?>">
150 <?php
151  foreach ( $footerIcons as$icon ) { ?>
152  <?php echo $this->getSkin()->makeFooterIcon($icon, 'withoutImage' ); ?>
153
154 <?php
155  } ?>
156  </div>
157 <?php
158  }
159 ?>
160  </div>
161
162  <?php $this->printTrail(); ?> 163 </body></html> 164 <?php 166 } // end of execute() method 167 } // end of class 168 169 SkinModern\$stylename
$stylename Definition: Modern.php:35 BaseTemplate\getPersonalTools getPersonalTools() Create an array of personal tools items from the data in the quicktemplate stored by SkinTemplate. Definition: SkinTemplate.php:1610 BaseTemplate\getFooterLinks getFooterLinks($option=null)
Returns an array of footerlinks trimmed down to only those footer links that are valid.
Definition: SkinTemplate.php:2009
BaseTemplate\msg
msg( $str) Definition: SkinTemplate.php:1524 data 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 of 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 php skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php Definition: skin.txt:62 BaseTemplate\makeListItem makeListItem($key, $item,$options=array())
Generates a list item for a navigation, portlet, portal, sidebar...
Definition: SkinTemplate.php:1905
content
per default it will return the text for text based content
Definition: contenthandler.txt:107
is
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 SkinModern\$template
$template Definition: Modern.php:36 SkinModern Inherit main code from SkinTemplate, set the CSS and template filter. Definition: Modern.php:34 SkinModern\$useHeadElement
$useHeadElement Definition: Modern.php:36 wfSuppressWarnings wfSuppressWarnings($end=false)
Reference-counted warning suppression.
Definition: GlobalFunctions.php:2434
QuickTemplate\getSkin
getSkin()
Get the Skin object related to this object.
Definition: SkinTemplate.php:1488
SkinModern\setupSkinUserCss
setupSkinUserCss(OutputPage $out) Definition: Modern.php:41$out
$out Definition: UtfNormalGenerate.php:167 wfRestoreWarnings wfRestoreWarnings() Restore error level to previous value. Definition: GlobalFunctions.php:2464 MonoBookTemplate\renderPortals renderPortals($sidebar)
Definition: MonoBook.php:177
ModernTemplate
Definition: Modern.php:51
BaseTemplate\printTrail
printTrail()
Output the basic end-page trail including bottomscripts, reporttime, and debug stuff.
Definition: SkinTemplate.php:2082
ModernTemplate\execute
execute()
Template filter callback for Modern skin.
Definition: Modern.php:61
OutputPage
This class should be covered by a general architecture document which does not exist as of January 20...
Definition: OutputPage.php:38
SkinModern\$skinname$skinname
Definition: Modern.php:35
MonoBookTemplate\text
$this text( 'searchtitle') Definition: MonoBook.php:212 cssjanus.main def main(argv) Definition: cssjanus.py:554 MonoBookTemplate\html foreach($validFooterIcons as $blockName=>$footerIcons) foreach( $footerIcons as$icon) if(count( $validFooterLinks) > 0)$this html( $aLink) Definition: MonoBook.php:155 MonoBookTemplate Definition: MonoBook.php:61 MonoBookTemplate\cactions cactions() Prints the cactions bar. Definition: MonoBook.php:235 it =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() and Revisions::getRawText() 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:107 in Prior to maintenance scripts were a hodgepodge of code that had no cohesion or formal method of action Beginning in Definition: maintenance.txt:1 used you don t have to do a grep find to see where the$wgReverseTitle variable is used
Definition: hooks.txt:117
as
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
BaseTemplate\getFooterIcons
getFooterIcons( \$option=null)
Returns an array of footer icons filtered down by options relevant to how the skin wishes to display ...
Definition: SkinTemplate.php:2048
href
shown</td >< td > a href
Definition: All_system_messages.txt:2674
SkinTemplate
Template-filler skin base class Formerly generic PHPTal (http://phptal.sourceforge....
Definition: SkinTemplate.php:70