MediaWiki  master
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 
202  public function equals( Content $that = null ) {
203  if ( is_null( $that ) ) {
204  return false;
205  }
206 
207  if ( $that === $this ) {
208  return true;
209  }
210 
211  if ( $that->getModel() !== $this->getModel() ) {
212  return false;
213  }
214 
215  // For type safety. Needed for odd cases like MessageContent using CONTENT_MODEL_WIKITEXT
216  if ( get_class( $that ) !== get_class( $this ) ) {
217  return false;
218  }
219 
220  return $this->equalsInternal( $that );
221  }
222 
241  protected function equalsInternal( Content $that ) {
242  return $this->serialize() === $that->serialize();
243  }
244 
268  public function getSecondaryDataUpdates( Title $title, Content $old = null,
269  $recursive = true, ParserOutput $parserOutput = null
270  ) {
271  if ( $parserOutput === null ) {
272  $parserOutput = $this->getParserOutput( $title, null, null, false );
273  }
274 
275  $updates = [
276  new LinksUpdate( $title, $parserOutput, $recursive )
277  ];
278 
279  Hooks::run( 'SecondaryDataUpdates', [ $title, $old, $recursive, $parserOutput, &$updates ] );
280 
281  return $updates;
282  }
283 
291  public function getRedirectChain() {
292  global $wgMaxRedirects;
293  $title = $this->getRedirectTarget();
294  if ( is_null( $title ) ) {
295  return null;
296  }
297  // recursive check to follow double redirects
298  $recurse = $wgMaxRedirects;
299  $titles = [ $title ];
300  while ( --$recurse > 0 ) {
301  if ( $title->isRedirect() ) {
302  $page = WikiPage::factory( $title );
303  $newtitle = $page->getRedirectTarget();
304  } else {
305  break;
306  }
307  // Redirects to some special pages are not permitted
308  if ( $newtitle instanceof Title && $newtitle->isValidRedirectTarget() ) {
309  // The new title passes the checks, so make that our current
310  // title so that further recursion can be checked
311  $title = $newtitle;
312  $titles[] = $newtitle;
313  } else {
314  break;
315  }
316  }
317 
318  return $titles;
319  }
320 
330  public function getRedirectTarget() {
331  return null;
332  }
333 
343  public function getUltimateRedirectTarget() {
344  $titles = $this->getRedirectChain();
345 
346  return $titles ? array_pop( $titles ) : null;
347  }
348 
356  public function isRedirect() {
357  return $this->getRedirectTarget() !== null;
358  }
359 
372  public function updateRedirect( Title $target ) {
373  return $this;
374  }
375 
384  public function getSection( $sectionId ) {
385  return null;
386  }
387 
398  public function replaceSection( $sectionId, Content $with, $sectionTitle = '' ) {
399  return null;
400  }
401 
412  public function preSaveTransform( Title $title, User $user, ParserOptions $popts ) {
413  return $this;
414  }
415 
424  public function addSectionHeader( $header ) {
425  return $this;
426  }
427 
438  public function preloadTransform( Title $title, ParserOptions $popts, $params = [] ) {
439  return $this;
440  }
441 
453  public function prepareSave( WikiPage $page, $flags, $parentRevId, User $user ) {
454  if ( $this->isValid() ) {
455  return Status::newGood();
456  } else {
457  return Status::newFatal( "invalid-content-data" );
458  }
459  }
460 
471  public function getDeletionUpdates( WikiPage $page, ParserOutput $parserOutput = null ) {
472  return [
473  new LinksDeletionUpdate( $page ),
474  ];
475  }
476 
489  public function matchMagicWord( MagicWord $word ) {
490  return false;
491  }
492 
504  public function convert( $toModel, $lossy = '' ) {
505  if ( $this->getModel() === $toModel ) {
506  // nothing to do, shorten out.
507  return $this;
508  }
509 
510  $lossy = ( $lossy === 'lossy' ); // string flag, convert to boolean for convenience
511  $result = false;
512 
513  Hooks::run( 'ConvertContent', [ $this, $toModel, $lossy, &$result ] );
514 
515  return $result;
516  }
517 
538  public function getParserOutput( Title $title, $revId = null,
539  ParserOptions $options = null, $generateHtml = true
540  ) {
541  if ( $options === null ) {
542  $options = ParserOptions::newCanonical( 'canonical' );
543  }
544 
545  $po = new ParserOutput();
546  $options->registerWatcher( [ $po, 'recordOption' ] );
547 
548  if ( Hooks::run( 'ContentGetParserOutput',
549  [ $this, $title, $revId, $options, $generateHtml, &$po ] )
550  ) {
551  // Save and restore the old value, just in case something is reusing
552  // the ParserOptions object in some weird way.
553  $oldRedir = $options->getRedirectTarget();
554  $options->setRedirectTarget( $this->getRedirectTarget() );
555  $this->fillParserOutput( $title, $revId, $options, $generateHtml, $po );
556  $options->setRedirectTarget( $oldRedir );
557  }
558 
559  Hooks::run( 'ContentAlterParserOutput', [ $this, $title, $po ] );
560  $options->registerWatcher( null );
561 
562  return $po;
563  }
564 
586  protected function fillParserOutput( Title $title, $revId,
587  ParserOptions $options, $generateHtml, ParserOutput &$output
588  ) {
589  // Don't make abstract, so subclasses that override getParserOutput() directly don't fail.
590  throw new MWException( 'Subclasses of AbstractContent must override fillParserOutput!' );
591  }
592 }
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:138
isValid()
Subclasses may override this to implement (light weight) validation.
preSaveTransform(Title $title, User $user, ParserOptions $popts)
isSupportedFormat( $format)
$model_id
Name of the content model this Content object represents.
getDeletionUpdates(WikiPage $page, ParserOutput $parserOutput=null)
__construct( $modelId=null)
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2216
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=(\*-\*)") 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. '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 '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 since 1.28! 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:1981
static newCanonical( $context=null, $userLang=null)
Creates a "canonical" ParserOptions object.
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:51
getSize()
Returns the content&#39;s nominal size in "bogo-bytes".
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
equalsInternal(Content $that)
Checks whether $that is logically equal to this Content object.
preloadTransform(Title $title, ParserOptions $popts, $params=[])
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...
$wgMaxRedirects
Max number of redirects to follow when resolving redirects.
updateRedirect(Title $target)
This default implementation always returns $this.
static getForContent(Content $content)
Returns the appropriate ContentHandler singleton for the given Content object.
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
equals(Content $that=null)
Decides whether two Content objects are equal.
Base implementation for content objects.
$params
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:1983
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:773
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:918
replaceSection( $sectionId, Content $with, $sectionTitle='')
$header
checkModelID( $modelId)
addSectionHeader( $header)
prepareSave(WikiPage $page, $flags, $parentRevId, User $user)
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:35
serialize( $format=null)
getSection( $sectionId)
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
fillParserOutput(Title $title, $revId, ParserOptions $options, $generateHtml, ParserOutput &$output)
Fills the provided ParserOutput with information derived from the content.
getParserOutput(Title $title, $revId=null, ParserOptions $options=null, $generateHtml=true)
Returns a ParserOutput object containing information derived from this content.
convert( $toModel, $lossy='')
This base implementation calls the hook ConvertContent to enable custom conversions.
matchMagicWord(MagicWord $word)
This default implementation always returns false.
getRedirectTarget()
Subclasses that implement redirects should override this.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1460
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
This class encapsulates "magic words" such as "#redirect", NOTOC, etc.
Definition: MagicWord.php:57
serialize( $format=null)
Convenience method for serializing this Content object.