MediaWiki  master
Content.php
Go to the documentation of this file.
1 <?php
25 
39 interface Content {
40 
51  public function getTextForSearchIndex();
52 
65  public function getWikitextForTransclusion();
66 
78  public function getTextForSummary( $maxLength = 250 );
79 
95  public function getNativeData();
96 
102  public function getSize();
103 
112  public function getModel();
113 
124  public function getContentHandler();
125 
136  public function getDefaultFormat();
137 
148  public function getSupportedFormats();
149 
165  public function isSupportedFormat( $format );
166 
178  public function serialize( $format = null );
179 
187  public function isEmpty();
188 
201  public function isValid();
202 
228  public function equals( Content $that = null );
229 
248  public function copy();
249 
265  public function isCountable( $hasLinks = null );
266 
290  public function getParserOutput( Title $title, $revId = null,
291  ParserOptions $options = null, $generateHtml = true );
292 
293  // TODO: make RenderOutput and RenderOptions base classes
294 
303  public function getRedirectTarget();
304 
315  public function isRedirect();
316 
328  public function updateRedirect( Title $target );
329 
342  public function getSection( $sectionId );
343 
358  public function replaceSection( $sectionId, Content $with, $sectionTitle = '' );
359 
373  public function preSaveTransform( Title $title, User $user, ParserOptions $parserOptions );
374 
386  public function addSectionHeader( $header );
387 
401  public function preloadTransform( Title $title, ParserOptions $parserOptions, $params = [] );
402 
430  public function prepareSave( WikiPage $page, $flags, $parentRevId, User $user );
431 
441  public function matchMagicWord( MagicWord $word );
442 
455  public function convert( $toModel, $lossy = '' );
456 
457  // @todo ImagePage and CategoryPage interfere with per-content action handlers
458  // @todo nice integration of GeSHi syntax highlighting
459  // [11:59] <vvv> Hooks are ugly; make CodeHighlighter interface and a
460  // config to set the class which handles syntax highlighting
461  // [12:00] <vvv> And default it to a DummyHighlighter
462 
463 }
This class encapsulates "magic words" such as "#redirect", NOTOC, etc.
Definition: MagicWord.php:65
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:58
Represents a title within MediaWiki.
Definition: Title.php:76
internal since 1.36
Definition: User.php:98
Set options of the Parser.
Base representation for an editable wiki page.
Definition: WikiPage.php:77
Base interface for representing page content.
Definition: Content.php:39
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