MediaWiki  1.28.0
WikitextContent.php
Go to the documentation of this file.
1 <?php
34  private $redirectTargetAndText = null;
35 
36  public function __construct( $text ) {
37  parent::__construct( $text, CONTENT_MODEL_WIKITEXT );
38  }
39 
47  public function getSection( $sectionId ) {
49 
50  $text = $this->getNativeData();
51  $sect = $wgParser->getSection( $text, $sectionId, false );
52 
53  if ( $sect === false ) {
54  return false;
55  } else {
56  return new static( $sect );
57  }
58  }
59 
70  public function replaceSection( $sectionId, Content $with, $sectionTitle = '' ) {
71 
72  $myModelId = $this->getModel();
73  $sectionModelId = $with->getModel();
74 
75  if ( $sectionModelId != $myModelId ) {
76  throw new MWException( "Incompatible content model for section: " .
77  "document uses $myModelId but " .
78  "section uses $sectionModelId." );
79  }
80 
81  $oldtext = $this->getNativeData();
82  $text = $with->getNativeData();
83 
84  if ( strval( $sectionId ) === '' ) {
85  return $with; # XXX: copy first?
86  }
87 
88  if ( $sectionId === 'new' ) {
89  # Inserting a new section
90  $subject = $sectionTitle ? wfMessage( 'newsectionheaderdefaultlevel' )
91  ->rawParams( $sectionTitle )->inContentLanguage()->text() . "\n\n" : '';
92  if ( Hooks::run( 'PlaceNewSection', [ $this, $oldtext, $subject, &$text ] ) ) {
93  $text = strlen( trim( $oldtext ) ) > 0
94  ? "{$oldtext}\n\n{$subject}{$text}"
95  : "{$subject}{$text}";
96  }
97  } else {
98  # Replacing an existing section; roll out the big guns
100 
101  $text = $wgParser->replaceSection( $oldtext, $sectionId, $text );
102  }
103 
104  $newContent = new static( $text );
105 
106  return $newContent;
107  }
108 
117  public function addSectionHeader( $header ) {
118  $text = wfMessage( 'newsectionheaderdefaultlevel' )
119  ->rawParams( $header )->inContentLanguage()->text();
120  $text .= "\n\n";
121  $text .= $this->getNativeData();
122 
123  return new static( $text );
124  }
125 
136  public function preSaveTransform( Title $title, User $user, ParserOptions $popts ) {
138 
139  $text = $this->getNativeData();
140  $pst = $wgParser->preSaveTransform( $text, $title, $user, $popts );
141 
142  return ( $text === $pst ) ? $this : new static( $pst );
143  }
144 
155  public function preloadTransform( Title $title, ParserOptions $popts, $params = [] ) {
157 
158  $text = $this->getNativeData();
159  $plt = $wgParser->getPreloadText( $text, $title, $popts, $params );
160 
161  return new static( $plt );
162  }
163 
173  protected function getRedirectTargetAndText() {
174  global $wgMaxRedirects;
175 
176  if ( $this->redirectTargetAndText !== null ) {
178  }
179 
180  if ( $wgMaxRedirects < 1 ) {
181  // redirects are disabled, so quit early
182  $this->redirectTargetAndText = [ null, $this->getNativeData() ];
184  }
185 
186  $redir = MagicWord::get( 'redirect' );
187  $text = ltrim( $this->getNativeData() );
188  if ( $redir->matchStartAndRemove( $text ) ) {
189  // Extract the first link and see if it's usable
190  // Ensure that it really does come directly after #REDIRECT
191  // Some older redirects included a colon, so don't freak about that!
192  $m = [];
193  if ( preg_match( '!^\s*:?\s*\[{2}(.*?)(?:\|.*?)?\]{2}\s*!', $text, $m ) ) {
194  // Strip preceding colon used to "escape" categories, etc.
195  // and URL-decode links
196  if ( strpos( $m[1], '%' ) !== false ) {
197  // Match behavior of inline link parsing here;
198  $m[1] = rawurldecode( ltrim( $m[1], ':' ) );
199  }
200  $title = Title::newFromText( $m[1] );
201  // If the title is a redirect to bad special pages or is invalid, return null
202  if ( !$title instanceof Title || !$title->isValidRedirectTarget() ) {
203  $this->redirectTargetAndText = [ null, $this->getNativeData() ];
205  }
206 
207  $this->redirectTargetAndText = [ $title, substr( $text, strlen( $m[0] ) ) ];
209  }
210  }
211 
212  $this->redirectTargetAndText = [ null, $this->getNativeData() ];
214  }
215 
223  public function getRedirectTarget() {
224  list( $title, ) = $this->getRedirectTargetAndText();
225 
226  return $title;
227  }
228 
241  public function updateRedirect( Title $target ) {
242  if ( !$this->isRedirect() ) {
243  return $this;
244  }
245 
246  # Fix the text
247  # Remember that redirect pages can have categories, templates, etc.,
248  # so the regex has to be fairly general
249  $newText = preg_replace( '/ \[ \[ [^\]]* \] \] /x',
250  '[[' . $target->getFullText() . ']]',
251  $this->getNativeData(), 1 );
252 
253  return new static( $newText );
254  }
255 
267  public function isCountable( $hasLinks = null, Title $title = null ) {
268  global $wgArticleCountMethod;
269 
270  if ( $this->isRedirect() ) {
271  return false;
272  }
273 
274  switch ( $wgArticleCountMethod ) {
275  case 'any':
276  return true;
277  case 'comma':
278  $text = $this->getNativeData();
279  return strpos( $text, ',' ) !== false;
280  case 'link':
281  if ( $hasLinks === null ) { # not known, find out
282  if ( !$title ) {
284  $title = $context->getTitle();
285  }
286 
287  $po = $this->getParserOutput( $title, null, null, false );
288  $links = $po->getLinks();
289  $hasLinks = !empty( $links );
290  }
291 
292  return $hasLinks;
293  }
294 
295  return false;
296  }
297 
302  public function getTextForSummary( $maxlength = 250 ) {
303  $truncatedtext = parent::getTextForSummary( $maxlength );
304 
305  # clean up unfinished links
306  # XXX: make this optional? wasn't there in autosummary, but required for
307  # deletion summary.
308  $truncatedtext = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $truncatedtext );
309 
310  return $truncatedtext;
311  }
312 
324  protected function fillParserOutput( Title $title, $revId,
326  ) {
328 
329  list( $redir, $text ) = $this->getRedirectTargetAndText();
330  $output = $wgParser->parse( $text, $title, $options, true, true, $revId );
331 
332  // Add redirect indicator at the top
333  if ( $redir ) {
334  // Make sure to include the redirect link in pagelinks
335  $output->addLink( $redir );
336  if ( $generateHtml ) {
337  $chain = $this->getRedirectChain();
338  $output->setText(
340  $output->getRawText()
341  );
342  $output->addModuleStyles( 'mediawiki.action.view.redirectPage' );
343  }
344  }
345  }
346 
350  protected function getHtml() {
351  throw new MWException(
352  "getHtml() not implemented for wikitext. "
353  . "Use getParserOutput()->getText()."
354  );
355  }
356 
366  public function matchMagicWord( MagicWord $word ) {
367  return $word->match( $this->getNativeData() );
368  }
369 
370 }
getNativeData()
Returns the text represented by this Content object, as a string.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
replaceSection($sectionId, Content $with, $sectionTitle= '')
const CONTENT_MODEL_WIKITEXT
Definition: Defines.php:239
$context
Definition: load.php:50
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:189
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state $generateHtml
Definition: hooks.txt:1046
getRedirectTargetAndText()
Extract the redirect target and the remaining text on the page.
Set options of the Parser.
$wgParser
Definition: Setup.php:821
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context $revId
Definition: hooks.txt:1046
addModuleStyles($modules)
match($text)
Returns true if the text contains the word.
Definition: MagicWord.php:458
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:262
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
updateRedirect(Title $target)
This implementation replaces the first link on the page with the given new target if this Content obj...
getRedirectTarget()
Implement redirect extraction for wikitext.
preloadTransform(Title $title, ParserOptions $popts, $params=[])
Returns a Content object with preload transformations applied (or this object if no transformations a...
Content object implementation for representing flat text.
Definition: TextContent.php:35
static getMain()
Static methods.
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock()-offset Set to overwrite offset parameter in $wgRequest set to ''to unsetoffset-wrap String Wrap the message in html(usually something like"&lt
addSectionHeader($header)
Returns a new WikitextContent object with the given section heading prepended.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1046
getSection($sectionId)
static getRedirectHeaderHtml(Language $lang, $target, $forceKnown=false)
Return the HTML for the top of a redirect page.
Definition: Article.php:1553
Base interface for content objects.
Definition: Content.php:34
$params
matchMagicWord(MagicWord $word)
This implementation calls $word->match() on the this TextContent object's text.
getFullText()
Get the prefixed title with spaces, plus any fragment (part beginning with '#')
Definition: Title.php:1479
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
$header
Content object for wiki text pages.
getRawText()
Get the cacheable text with markers still in it.
static & get($id)
Factory: creates an object representing an ID.
Definition: MagicWord.php:257
getTextForSummary($maxlength=250)
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 local account $user
Definition: hooks.txt:242
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive false for true for descending in case the handler function wants to provide a converted Content object Note that $result getContentModel() must return $toModel. 'CustomEditor'$rcid is used in generating this variable which contains information about the new such as the revision s whether the revision was marked as a minor edit or not
Definition: hooks.txt:1156
getNativeData()
Returns native representation of the data.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object & $output
Definition: hooks.txt:1046
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
preSaveTransform(Title $title, User $user, ParserOptions $popts)
Returns a Content object with pre-save transformations applied using Parser::preSaveTransform().
isCountable($hasLinks=null, Title $title=null)
Returns true if this content is not a redirect, and this content's text is countable according to the...
getPageLanguage()
Get the language in which the content of this page is written in wikitext.
Definition: Title.php:4664
addLink(Title $title, $id=null)
Record a local or interwiki inline link for saving in future link tables.
getModel()
Returns the ID of the content model used by this Content object.
getParserOutput(Title $title, $revId=null, ParserOptions $options=null, $generateHtml=true)
Returns a ParserOutput object containing information derived from this content.
fillParserOutput(Title $title, $revId, ParserOptions $options, $generateHtml, ParserOutput &$output)
Returns a ParserOutput object resulting from parsing the content's text using $wgParser.
This class encapsulates "magic words" such as "#redirect", NOTOC, etc.
Definition: MagicWord.php:59