MediaWiki  1.23.13
TextContent.php
Go to the documentation of this file.
1 <?php
36 
41  public function __construct( $text, $model_id = CONTENT_MODEL_TEXT ) {
42  parent::__construct( $model_id );
43 
44  if ( $text === null || $text === false ) {
45  wfWarn( "TextContent constructed with \$text = " . var_export( $text, true ) . "! "
46  . "This may indicate an error in the caller's scope.", 2 );
47 
48  $text = '';
49  }
50 
51  if ( !is_string( $text ) ) {
52  throw new MWException( "TextContent expects a string in the constructor." );
53  }
54 
55  $this->mText = $text;
56  }
57 
63  public function copy() {
64  return $this; # NOTE: this is ok since TextContent are immutable.
65  }
66 
67  public function getTextForSummary( $maxlength = 250 ) {
69 
70  $text = $this->getNativeData();
71 
72  $truncatedtext = $wgContLang->truncate(
73  preg_replace( "/[\n\r]/", ' ', $text ),
74  max( 0, $maxlength ) );
75 
76  return $truncatedtext;
77  }
78 
84  public function getSize() {
85  $text = $this->getNativeData();
86 
87  return strlen( $text );
88  }
89 
99  public function isCountable( $hasLinks = null ) {
100  global $wgArticleCountMethod;
101 
102  if ( $this->isRedirect() ) {
103  return false;
104  }
105 
106  if ( $wgArticleCountMethod === 'any' ) {
107  return true;
108  }
109 
110  return false;
111  }
112 
118  public function getNativeData() {
119  $text = $this->mText;
120 
121  return $text;
122  }
123 
129  public function getTextForSearchIndex() {
130  return $this->getNativeData();
131  }
132 
141  public function getWikitextForTransclusion() {
142  $wikitext = $this->convert( CONTENT_MODEL_WIKITEXT, 'lossy' );
143 
144  if ( $wikitext ) {
145  return $wikitext->getNativeData();
146  } else {
147  return false;
148  }
149  }
150 
161  public function preSaveTransform( Title $title, User $user, ParserOptions $popts ) {
162  $text = $this->getNativeData();
163  $pst = rtrim( $text );
164 
165  return ( $text === $pst ) ? $this : new static( $pst );
166  }
167 
181  public function diff( Content $that, Language $lang = null ) {
183 
184  $this->checkModelID( $that->getModel() );
185 
186  // @todo could implement this in DifferenceEngine and just delegate here?
187 
188  if ( !$lang ) {
189  $lang = $wgContLang;
190  }
191 
192  $otext = $this->getNativeData();
193  $ntext = $that->getNativeData();
194 
195  # Note: Use native PHP diff, external engines don't give us abstract output
196  $ota = explode( "\n", $lang->segmentForDiff( $otext ) );
197  $nta = explode( "\n", $lang->segmentForDiff( $ntext ) );
198 
199  $diff = new Diff( $ota, $nta );
200 
201  return $diff;
202  }
203 
215  public function getParserOutput( Title $title, $revId = null,
216  ParserOptions $options = null, $generateHtml = true ) {
217  global $wgParser, $wgTextModelsToParse;
218 
219  if ( !$options ) {
220  //NOTE: use canonical options per default to produce cacheable output
221  $options = $this->getContentHandler()->makeParserOptions( 'canonical' );
222  }
223 
224  if ( in_array( $this->getModel(), $wgTextModelsToParse ) ) {
225  // parse just to get links etc into the database
226  $po = $wgParser->parse( $this->getNativeData(), $title, $options, true, true, $revId );
227  } else {
228  $po = new ParserOutput();
229  }
230 
231  if ( $generateHtml ) {
232  $html = $this->getHtml();
233  } else {
234  $html = '';
235  }
236 
237  $po->setText( $html );
238 
239  return $po;
240  }
241 
253  protected function getHtml() {
254  return $this->getHighlightHtml();
255  }
256 
263  protected function getHighlightHtml() {
264  # TODO: make Highlighter interface, use highlighter here, if available
265  return htmlspecialchars( $this->getNativeData() );
266  }
267 
279  public function convert( $toModel, $lossy = '' ) {
280  $converted = parent::convert( $toModel, $lossy );
281 
282  if ( $converted !== false ) {
283  return $converted;
284  }
285 
286  $toHandler = ContentHandler::getForModelID( $toModel );
287 
288  if ( $toHandler instanceof TextContentHandler ) {
289  //NOTE: ignore content serialization format - it's just text anyway.
290  $text = $this->getNativeData();
291  $converted = $toHandler->unserializeContent( $text );
292  }
293 
294  return $converted;
295  }
296 
297 }
TextContent\__construct
__construct( $text, $model_id=CONTENT_MODEL_TEXT)
Definition: TextContent.php:41
ParserOptions
Set options of the Parser.
Definition: ParserOptions.php:31
TextContent\getTextForSearchIndex
getTextForSearchIndex()
Returns the text represented by this Content object, as a string.
Definition: TextContent.php:129
ContentHandler\getForModelID
static getForModelID( $modelId)
Returns the ContentHandler singleton for the given model ID.
Definition: ContentHandler.php:311
ParserOutput
Definition: ParserOutput.php:24
AbstractContent\isRedirect
isRedirect()
Definition: AbstractContent.php:306
TextContent\getWikitextForTransclusion
getWikitextForTransclusion()
Returns attempts to convert this content object to wikitext, and then returns the text string.
Definition: TextContent.php:141
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
$html
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 & $html
Definition: hooks.txt:1530
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
TextContent\getHtml
getHtml()
Generates an HTML version of the content, for display.
Definition: TextContent.php:253
$wgContLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
Definition: design.txt:56
CONTENT_MODEL_WIKITEXT
const CONTENT_MODEL_WIKITEXT
Definition: Defines.php:283
TextContent\getTextForSummary
getTextForSummary( $maxlength=250)
Returns a textual representation of the content suitable for use in edit summaries and log messages.
Definition: TextContent.php:67
MWException
MediaWiki exception.
Definition: MWException.php:26
AbstractContent\checkModelID
checkModelID( $modelId)
Definition: AbstractContent.php:70
AbstractContent\getContentHandler
getContentHandler()
Definition: AbstractContent.php:85
TextContent\getHighlightHtml
getHighlightHtml()
Generates a syntax-highlighted version of the content, as HTML.
Definition: TextContent.php:263
TextContent\getParserOutput
getParserOutput(Title $title, $revId=null, ParserOptions $options=null, $generateHtml=true)
Returns a generic ParserOutput object, wrapping the HTML returned by getHtml().
Definition: TextContent.php:215
TextContent\copy
copy()
Definition: TextContent.php:63
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
TextContent\preSaveTransform
preSaveTransform(Title $title, User $user, ParserOptions $popts)
Returns a Content object with pre-save transformations applied.
Definition: TextContent.php:161
$options
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 & $options
Definition: hooks.txt:1530
$title
presenting them properly to the user as errors is done by the caller $title
Definition: hooks.txt:1324
TextContent\getSize
getSize()
returns the text's size in bytes.
Definition: TextContent.php:84
AbstractContent
Base implementation for content objects.
Definition: AbstractContent.php:34
TextContent\isCountable
isCountable( $hasLinks=null)
Returns true if this content is not a redirect, and $wgArticleCountMethod is "any".
Definition: TextContent.php:99
TextContentHandler
Base content handler implementation for flat text contents.
Definition: TextContentHandler.php:31
Content\getNativeData
getNativeData()
Returns native representation of the data.
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:237
TextContent
Content object implementation for representing flat text.
Definition: TextContent.php:35
Content
Base interface for content objects.
Definition: Content.php:34
AbstractContent\getModel
getModel()
Definition: AbstractContent.php:58
AbstractContent\$model_id
string $model_id
Name of the content model this Content object represents.
Definition: AbstractContent.php:42
Title
Represents a title within MediaWiki.
Definition: Title.php:35
$wgParser
$wgParser
Definition: Setup.php:587
are
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
Content\getModel
getModel()
Returns the ID of the content model used by this Content object.
wfWarn
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
Definition: GlobalFunctions.php:1188
TextContent\diff
diff(Content $that, Language $lang=null)
Diff this content object with another content object.
Definition: TextContent.php:181
CONTENT_MODEL_TEXT
const CONTENT_MODEL_TEXT
Definition: Defines.php:286
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:59
Language
Internationalisation code.
Definition: Language.php:74
TextContent\convert
convert( $toModel, $lossy='')
This implementation provides lossless conversion between content models based on TextContent.
Definition: TextContent.php:279
TextContent\getNativeData
getNativeData()
Returns the text represented by this Content object, as a string.
Definition: TextContent.php:118
Diff
Class representing a 'diff' between two sequences of strings.
Definition: DairikiDiff.php:705