MediaWiki REL1_31
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
86 public function getNativeData();
87
93 public function getSize();
94
103 public function getModel();
104
115 public function getContentHandler();
116
127 public function getDefaultFormat();
128
139 public function getSupportedFormats();
140
156 public function isSupportedFormat( $format );
157
169 public function serialize( $format = null );
170
178 public function isEmpty();
179
192 public function isValid();
193
217 public function equals( Content $that = null );
218
237 public function copy();
238
252 public function isCountable( $hasLinks = null );
253
275 public function getParserOutput( Title $title, $revId = null,
276 ParserOptions $options = null, $generateHtml = true );
277
278 // TODO: make RenderOutput and RenderOptions base classes
279
312 public function getSecondaryDataUpdates( Title $title, Content $old = null,
313 $recursive = true, ParserOutput $parserOutput = null );
314
325 public function getRedirectChain();
326
337 public function getRedirectTarget();
338
354 public function getUltimateRedirectTarget();
355
364 public function isRedirect();
365
377 public function updateRedirect( Title $target );
378
391 public function getSection( $sectionId );
392
407 public function replaceSection( $sectionId, Content $with, $sectionTitle = '' );
408
421 public function preSaveTransform( Title $title, User $user, ParserOptions $parserOptions );
422
434 public function addSectionHeader( $header );
435
448 public function preloadTransform( Title $title, ParserOptions $parserOptions, $params = [] );
449
476 public function prepareSave( WikiPage $page, $flags, $parentRevId, User $user );
477
493 public function getDeletionUpdates( WikiPage $page,
494 ParserOutput $parserOutput = null );
495
505 public function matchMagicWord( MagicWord $word );
506
519 public function convert( $toModel, $lossy = '' );
520 // @todo ImagePage and CategoryPage interfere with per-content action handlers
521 // @todo nice&sane integration of GeSHi syntax highlighting
522 // [11:59] <vvv> Hooks are ugly; make CodeHighlighter interface and a
523 // config to set the class which handles syntax highlighting
524 // [12:00] <vvv> And default it to a DummyHighlighter
525
526}
This class encapsulates "magic words" such as "#redirect", NOTOC, etc.
Definition MagicWord.php:59
Set options of the Parser.
Represents a title within MediaWiki.
Definition Title.php:39
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:53
Class representing a MediaWiki article and history.
Definition WikiPage.php:37
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:2001
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.
$params
$header