MediaWiki  REL1_31
AbstractContent.php
Go to the documentation of this file.
1 <?php
34 abstract class AbstractContent implements Content {
43  protected $model_id;
44 
50  public function __construct( $modelId = null ) {
51  $this->model_id = $modelId;
52  }
53 
60  public function getModel() {
61  return $this->model_id;
62  }
63 
72  protected function checkModelID( $modelId ) {
73  if ( $modelId !== $this->model_id ) {
74  throw new MWException(
75  "Bad content model: " .
76  "expected {$this->model_id} " .
77  "but got $modelId."
78  );
79  }
80  }
81 
88  public function getContentHandler() {
89  return ContentHandler::getForContent( $this );
90  }
91 
98  public function getDefaultFormat() {
99  return $this->getContentHandler()->getDefaultFormat();
100  }
101 
108  public function getSupportedFormats() {
109  return $this->getContentHandler()->getSupportedFormats();
110  }
111 
121  public function isSupportedFormat( $format ) {
122  if ( !$format ) {
123  return true; // this means "use the default"
124  }
125 
126  return $this->getContentHandler()->isSupportedFormat( $format );
127  }
128 
136  protected function checkFormat( $format ) {
137  if ( !$this->isSupportedFormat( $format ) ) {
138  throw new MWException(
139  "Format $format is not supported for content model " .
140  $this->getModel()
141  );
142  }
143  }
144 
154  public function serialize( $format = null ) {
155  return $this->getContentHandler()->serializeContent( $this, $format );
156  }
157 
165  public function isEmpty() {
166  return $this->getSize() === 0;
167  }
168 
178  public function isValid() {
179  return true;
180  }
181 
191  public function equals( Content $that = null ) {
192  if ( is_null( $that ) ) {
193  return false;
194  }
195 
196  if ( $that === $this ) {
197  return true;
198  }
199 
200  if ( $that->getModel() !== $this->getModel() ) {
201  return false;
202  }
203 
204  return $this->getNativeData() === $that->getNativeData();
205  }
206 
230  public function getSecondaryDataUpdates( Title $title, Content $old = null,
231  $recursive = true, ParserOutput $parserOutput = null
232  ) {
233  if ( $parserOutput === null ) {
234  $parserOutput = $this->getParserOutput( $title, null, null, false );
235  }
236 
237  $updates = [
238  new LinksUpdate( $title, $parserOutput, $recursive )
239  ];
240 
241  Hooks::run( 'SecondaryDataUpdates', [ $title, $old, $recursive, $parserOutput, &$updates ] );
242 
243  return $updates;
244  }
245 
253  public function getRedirectChain() {
255  $title = $this->getRedirectTarget();
256  if ( is_null( $title ) ) {
257  return null;
258  }
259  // recursive check to follow double redirects
260  $recurse = $wgMaxRedirects;
261  $titles = [ $title ];
262  while ( --$recurse > 0 ) {
263  if ( $title->isRedirect() ) {
264  $page = WikiPage::factory( $title );
265  $newtitle = $page->getRedirectTarget();
266  } else {
267  break;
268  }
269  // Redirects to some special pages are not permitted
270  if ( $newtitle instanceof Title && $newtitle->isValidRedirectTarget() ) {
271  // The new title passes the checks, so make that our current
272  // title so that further recursion can be checked
273  $title = $newtitle;
274  $titles[] = $newtitle;
275  } else {
276  break;
277  }
278  }
279 
280  return $titles;
281  }
282 
292  public function getRedirectTarget() {
293  return null;
294  }
295 
305  public function getUltimateRedirectTarget() {
306  $titles = $this->getRedirectChain();
307 
308  return $titles ? array_pop( $titles ) : null;
309  }
310 
318  public function isRedirect() {
319  return $this->getRedirectTarget() !== null;
320  }
321 
334  public function updateRedirect( Title $target ) {
335  return $this;
336  }
337 
346  public function getSection( $sectionId ) {
347  return null;
348  }
349 
360  public function replaceSection( $sectionId, Content $with, $sectionTitle = '' ) {
361  return null;
362  }
363 
374  public function preSaveTransform( Title $title, User $user, ParserOptions $popts ) {
375  return $this;
376  }
377 
386  public function addSectionHeader( $header ) {
387  return $this;
388  }
389 
400  public function preloadTransform( Title $title, ParserOptions $popts, $params = [] ) {
401  return $this;
402  }
403 
415  public function prepareSave( WikiPage $page, $flags, $parentRevId, User $user ) {
416  if ( $this->isValid() ) {
417  return Status::newGood();
418  } else {
419  return Status::newFatal( "invalid-content-data" );
420  }
421  }
422 
433  public function getDeletionUpdates( WikiPage $page, ParserOutput $parserOutput = null ) {
434  return [
435  new LinksDeletionUpdate( $page ),
436  ];
437  }
438 
451  public function matchMagicWord( MagicWord $word ) {
452  return false;
453  }
454 
466  public function convert( $toModel, $lossy = '' ) {
467  if ( $this->getModel() === $toModel ) {
468  // nothing to do, shorten out.
469  return $this;
470  }
471 
472  $lossy = ( $lossy === 'lossy' ); // string flag, convert to boolean for convenience
473  $result = false;
474 
475  Hooks::run( 'ConvertContent', [ $this, $toModel, $lossy, &$result ] );
476 
477  return $result;
478  }
479 
500  public function getParserOutput( Title $title, $revId = null,
501  ParserOptions $options = null, $generateHtml = true
502  ) {
503  if ( $options === null ) {
504  $options = $this->getContentHandler()->makeParserOptions( 'canonical' );
505  }
506 
507  $po = new ParserOutput();
508 
509  if ( Hooks::run( 'ContentGetParserOutput',
510  [ $this, $title, $revId, $options, $generateHtml, &$po ] )
511  ) {
512  // Save and restore the old value, just in case something is reusing
513  // the ParserOptions object in some weird way.
514  $oldRedir = $options->getRedirectTarget();
515  $options->setRedirectTarget( $this->getRedirectTarget() );
516  $this->fillParserOutput( $title, $revId, $options, $generateHtml, $po );
517  $options->setRedirectTarget( $oldRedir );
518  }
519 
520  Hooks::run( 'ContentAlterParserOutput', [ $this, $title, $po ] );
521 
522  return $po;
523  }
524 
545  protected function fillParserOutput( Title $title, $revId,
546  ParserOptions $options, $generateHtml, ParserOutput &$output
547  ) {
548  // Don't make abstract, so subclasses that override getParserOutput() directly don't fail.
549  throw new MWException( 'Subclasses of AbstractContent must override fillParserOutput!' );
550  }
551 }
AbstractContent\getSecondaryDataUpdates
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...
Definition: AbstractContent.php:230
$user
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 account $user
Definition: hooks.txt:247
ParserOptions
Set options of the Parser.
Definition: ParserOptions.php:40
AbstractContent\addSectionHeader
addSectionHeader( $header)
Definition: AbstractContent.php:386
ParserOutput
Definition: ParserOutput.php:25
AbstractContent\isRedirect
isRedirect()
Definition: AbstractContent.php:318
AbstractContent\fillParserOutput
fillParserOutput(Title $title, $revId, ParserOptions $options, $generateHtml, ParserOutput &$output)
Fills the provided ParserOutput with information derived from the content.
Definition: AbstractContent.php:545
AbstractContent\convert
convert( $toModel, $lossy='')
This base implementation calls the hook ConvertContent to enable custom conversions.
Definition: AbstractContent.php:466
$output
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2255
AbstractContent\replaceSection
replaceSection( $sectionId, Content $with, $sectionTitle='')
Definition: AbstractContent.php:360
AbstractContent\checkFormat
checkFormat( $format)
Definition: AbstractContent.php:136
AbstractContent\getParserOutput
getParserOutput(Title $title, $revId=null, ParserOptions $options=null, $generateHtml=true)
Returns a ParserOutput object containing information derived from this content.
Definition: AbstractContent.php:500
AbstractContent\getRedirectTarget
getRedirectTarget()
Subclasses that implement redirects should override this.
Definition: AbstractContent.php:292
AbstractContent\updateRedirect
updateRedirect(Title $target)
This default implementation always returns $this.
Definition: AbstractContent.php:334
WikiPage
Class representing a MediaWiki article and history.
Definition: WikiPage.php:37
LinksUpdate
Class the manages updates of *_link tables as well as similar extension-managed tables.
Definition: LinksUpdate.php:34
StatusValue\newFatal
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
$params
$params
Definition: styleTest.css.php:40
AbstractContent\getRedirectChain
getRedirectChain()
Definition: AbstractContent.php:253
AbstractContent\equals
equals(Content $that=null)
Definition: AbstractContent.php:191
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1993
AbstractContent\isEmpty
isEmpty()
Definition: AbstractContent.php:165
AbstractContent\getUltimateRedirectTarget
getUltimateRedirectTarget()
Definition: AbstractContent.php:305
Content\getSize
getSize()
Returns the content's nominal size in "bogo-bytes".
php
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:37
AbstractContent\matchMagicWord
matchMagicWord(MagicWord $word)
This default implementation always returns false.
Definition: AbstractContent.php:451
AbstractContent\preSaveTransform
preSaveTransform(Title $title, User $user, ParserOptions $popts)
Definition: AbstractContent.php:374
AbstractContent\getDefaultFormat
getDefaultFormat()
Definition: AbstractContent.php:98
MWException
MediaWiki exception.
Definition: MWException.php:26
AbstractContent\checkModelID
checkModelID( $modelId)
Definition: AbstractContent.php:72
AbstractContent\getContentHandler
getContentHandler()
Definition: AbstractContent.php:88
WikiPage\factory
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:115
$titles
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition: linkcache.txt:17
AbstractContent\isSupportedFormat
isSupportedFormat( $format)
Definition: AbstractContent.php:121
AbstractContent\serialize
serialize( $format=null)
Definition: AbstractContent.php:154
Title\isValidRedirectTarget
isValidRedirectTarget()
Check if this Title is a valid redirect target.
Definition: Title.php:4863
AbstractContent\prepareSave
prepareSave(WikiPage $page, $flags, $parentRevId, User $user)
Definition: AbstractContent.php:415
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
AbstractContent\__construct
__construct( $modelId=null)
Definition: AbstractContent.php:50
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
MagicWord
This class encapsulates "magic words" such as "#redirect", NOTOC, etc.
Definition: MagicWord.php:59
$options
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
AbstractContent\preloadTransform
preloadTransform(Title $title, ParserOptions $popts, $params=[])
Definition: AbstractContent.php:400
$header
$header
Definition: updateCredits.php:35
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
AbstractContent
Base implementation for content objects.
Definition: AbstractContent.php:34
AbstractContent\getSection
getSection( $sectionId)
Definition: AbstractContent.php:346
LinksDeletionUpdate
Update object handling the cleanup of links tables after a page was deleted.
Definition: LinksDeletionUpdate.php:29
Content\getNativeData
getNativeData()
Returns native representation of the data.
AbstractContent\getDeletionUpdates
getDeletionUpdates(WikiPage $page, ParserOutput $parserOutput=null)
Definition: AbstractContent.php:433
Content
Base interface for content objects.
Definition: Content.php:34
AbstractContent\getModel
getModel()
Definition: AbstractContent.php:60
AbstractContent\$model_id
$model_id
Name of the content model this Content object represents.
Definition: AbstractContent.php:43
Title
Represents a title within MediaWiki.
Definition: Title.php:39
$wgMaxRedirects
$wgMaxRedirects
Max number of redirects to follow when resolving redirects.
Definition: DefaultSettings.php:4127
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:53
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
ContentHandler\getForContent
static getForContent(Content $content)
Returns the appropriate ContentHandler singleton for the given Content object.
Definition: ContentHandler.php:256
AbstractContent\getSupportedFormats
getSupportedFormats()
Definition: AbstractContent.php:108
AbstractContent\isValid
isValid()
Subclasses may override this to implement (light weight) validation.
Definition: AbstractContent.php:178