MediaWiki REL1_34
Content.php
Go to the documentation of this file.
1<?php
34interface Content {
35
46 public function getTextForSearchIndex();
47
60 public function getWikitextForTransclusion();
61
72 public function getTextForSummary( $maxLength = 250 );
73
89 public function getNativeData();
90
96 public function getSize();
97
106 public function getModel();
107
118 public function getContentHandler();
119
130 public function getDefaultFormat();
131
142 public function getSupportedFormats();
143
159 public function isSupportedFormat( $format );
160
172 public function serialize( $format = null );
173
181 public function isEmpty();
182
195 public function isValid();
196
222 public function equals( Content $that = null );
223
242 public function copy();
243
259 public function isCountable( $hasLinks = null );
260
283 public function getParserOutput( Title $title, $revId = null,
284 ParserOptions $options = null, $generateHtml = true );
285
286 // TODO: make RenderOutput and RenderOptions base classes
287
315 public function getSecondaryDataUpdates( Title $title, Content $old = null,
316 $recursive = true, ParserOutput $parserOutput = null );
317
328 public function getRedirectChain();
329
340 public function getRedirectTarget();
341
357 public function getUltimateRedirectTarget();
358
369 public function isRedirect();
370
382 public function updateRedirect( Title $target );
383
396 public function getSection( $sectionId );
397
412 public function replaceSection( $sectionId, Content $with, $sectionTitle = '' );
413
426 public function preSaveTransform( Title $title, User $user, ParserOptions $parserOptions );
427
439 public function addSectionHeader( $header );
440
453 public function preloadTransform( Title $title, ParserOptions $parserOptions, $params = [] );
454
481 public function prepareSave( WikiPage $page, $flags, $parentRevId, User $user );
482
500 public function getDeletionUpdates( WikiPage $page,
501 ParserOutput $parserOutput = null );
502
512 public function matchMagicWord( MagicWord $word );
513
526 public function convert( $toModel, $lossy = '' );
527 // @todo ImagePage and CategoryPage interfere with per-content action handlers
528 // @todo nice&sane integration of GeSHi syntax highlighting
529 // [11:59] <vvv> Hooks are ugly; make CodeHighlighter interface and a
530 // config to set the class which handles syntax highlighting
531 // [12:00] <vvv> And default it to a DummyHighlighter
532
533}
This class encapsulates "magic words" such as "#redirect", NOTOC, etc.
Definition MagicWord.php:57
Set options of the Parser.
Represents a title within MediaWiki.
Definition Title.php:42
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:51
Class representing a MediaWiki article and history.
Definition WikiPage.php:47
Base interface for content objects.
Definition Content.php:34
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.
getRedirectChain()
Construct the redirect destination from this content and return an array of Titles,...
getDefaultFormat()
Convenience method that returns the default serialization format for the content model that this Cont...
getDeletionUpdates(WikiPage $page, ParserOutput $parserOutput=null)
Returns a list of updates to perform when this content is deleted.
getSecondaryDataUpdates(Title $title, Content $old=null, $recursive=true, ParserOutput $parserOutput=null)
Returns a list of DataUpdate objects for recording information about this Content in some secondary d...
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.
getUltimateRedirectTarget()
Construct the redirect destination from this content and return the Title, or null if this content do...
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