MediaWiki 1.40.4
Content.php
Go to the documentation of this file.
1<?php
23
37interface Content {
38
49 public function getTextForSearchIndex();
50
63 public function getWikitextForTransclusion();
64
76 public function getTextForSummary( $maxLength = 250 );
77
93 public function getNativeData();
94
100 public function getSize();
101
110 public function getModel();
111
122 public function getContentHandler();
123
134 public function getDefaultFormat();
135
146 public function getSupportedFormats();
147
163 public function isSupportedFormat( $format );
164
176 public function serialize( $format = null );
177
185 public function isEmpty();
186
199 public function isValid();
200
226 public function equals( Content $that = null );
227
246 public function copy();
247
263 public function isCountable( $hasLinks = null );
264
288 public function getParserOutput( Title $title, $revId = null,
289 ParserOptions $options = null, $generateHtml = true );
290
291 // TODO: make RenderOutput and RenderOptions base classes
292
301 public function getRedirectTarget();
302
313 public function isRedirect();
314
326 public function updateRedirect( Title $target );
327
340 public function getSection( $sectionId );
341
356 public function replaceSection( $sectionId, Content $with, $sectionTitle = '' );
357
371 public function preSaveTransform( Title $title, User $user, ParserOptions $parserOptions );
372
384 public function addSectionHeader( $header );
385
399 public function preloadTransform( Title $title, ParserOptions $parserOptions, $params = [] );
400
428 public function prepareSave( WikiPage $page, $flags, $parentRevId, User $user );
429
439 public function matchMagicWord( MagicWord $word );
440
453 public function convert( $toModel, $lossy = '' );
454
455 // @todo ImagePage and CategoryPage interfere with per-content action handlers
456 // @todo nice integration of GeSHi syntax highlighting
457 // [11:59] <vvv> Hooks are ugly; make CodeHighlighter interface and a
458 // config to set the class which handles syntax highlighting
459 // [12:00] <vvv> And default it to a DummyHighlighter
460
461}
This class encapsulates "magic words" such as "#redirect", NOTOC, etc.
Definition MagicWord.php:65
Represents a title within MediaWiki.
Definition Title.php:82
Set options of the Parser.
internal since 1.36
Definition User.php:71
Base representation for an editable wiki page.
Definition WikiPage.php:75
Base interface for representing page content.
Definition Content.php:37
getRedirectTarget()
Construct the redirect destination from this content and return a Title, or null if this content does...
isCountable( $hasLinks=null)
Returns true if this content is countable as a "real" wiki page, provided that it's also in a countab...
convert( $toModel, $lossy='')
Converts this content object into another content object with the given content model,...
getContentHandler()
Convenience method that returns the ContentHandler singleton for handling the content model that this...
getTextForSummary( $maxLength=250)
Returns a textual representation of the content suitable for use in edit summaries and log messages.
getSection( $sectionId)
Returns the section with the given ID.
getNativeData()
Returns native representation of the data.
getModel()
Returns the ID of the content model used by this Content object.
copy()
Return a copy of this Content object.
getTextForSearchIndex()
preSaveTransform(Title $title, User $user, ParserOptions $parserOptions)
Returns a Content object with pre-save transformations applied (or this object if no transformations ...
getSize()
Returns the content's nominal size in "bogo-bytes".
serialize( $format=null)
Convenience method for serializing this Content object.
getDefaultFormat()
Convenience method that returns the default serialization format for the content model that this Cont...
getSupportedFormats()
Convenience method that returns the list of serialization formats supported for the content model tha...
preloadTransform(Title $title, ParserOptions $parserOptions, $params=[])
Returns a Content object with preload transformations applied (or this object if no transformations a...
isSupportedFormat( $format)
Returns true if $format is a supported serialization format for this Content object,...
matchMagicWord(MagicWord $word)
Returns true if this Content object matches the given magic word.
addSectionHeader( $header)
Returns a new WikitextContent object with the given section heading prepended, if supported.
isRedirect()
Returns whether this Content represents a redirect.
isEmpty()
Returns true if this Content object represents empty content.
getParserOutput(Title $title, $revId=null, ParserOptions $options=null, $generateHtml=true)
Parse the Content object and generate a ParserOutput from the result.
replaceSection( $sectionId, Content $with, $sectionTitle='')
Replaces a section of the content and returns a Content object with the section replaced.
equals(Content $that=null)
Returns true if this Content objects is conceptually equivalent to the given Content object.
getWikitextForTransclusion()
isValid()
Returns whether the content is valid.
updateRedirect(Title $target)
If this Content object is a redirect, this method updates the redirect target.
prepareSave(WikiPage $page, $flags, $parentRevId, User $user)
Prepare Content for saving.
$header