MediaWiki REL1_33
WikitextContentHandler.php
Go to the documentation of this file.
1<?php
27
34
35 public function __construct( $modelId = CONTENT_MODEL_WIKITEXT ) {
36 parent::__construct( $modelId, [ CONTENT_FORMAT_WIKITEXT ] );
37 }
38
39 protected function getContentClass() {
40 return WikitextContent::class;
41 }
42
53 public function makeRedirectContent( Title $destination, $text = '' ) {
54 $optionalColon = '';
55
56 if ( $destination->getNamespace() == NS_CATEGORY ) {
57 $optionalColon = ':';
58 } else {
59 $iw = $destination->getInterwiki();
60 if ( $iw && Language::fetchLanguageName( $iw, null, 'mw' ) ) {
61 $optionalColon = ':';
62 }
63 }
64
65 $mwRedir = MediaWikiServices::getInstance()->getMagicWordFactory()->get( 'redirect' );
66 $redirectText = $mwRedir->getSynonym( 0 ) .
67 ' [[' . $optionalColon . $destination->getFullText() . ']]';
68
69 if ( $text != '' ) {
70 $redirectText .= "\n" . $text;
71 }
72
73 $class = $this->getContentClass();
74 return new $class( $redirectText );
75 }
76
84 public function supportsRedirects() {
85 return true;
86 }
87
95 public function supportsSections() {
96 return true;
97 }
98
109 public function isParserCacheSupported() {
110 return true;
111 }
112
117 protected function getFileHandler() {
118 return new FileContentHandler();
119 }
120
122 $fields = parent::getFieldsForSearchIndex( $engine );
123
124 $fields['heading'] =
125 $engine->makeSearchFieldMapping( 'heading', SearchIndexField::INDEX_TYPE_TEXT );
126 $fields['heading']->setFlag( SearchIndexField::FLAG_SCORING );
127
128 $fields['auxiliary_text'] =
129 $engine->makeSearchFieldMapping( 'auxiliary_text', SearchIndexField::INDEX_TYPE_TEXT );
130
131 $fields['opening_text'] =
132 $engine->makeSearchFieldMapping( 'opening_text', SearchIndexField::INDEX_TYPE_TEXT );
133 $fields['opening_text']->setFlag(
135 );
136 // Until we have full first-class content handler for files, we invoke it explicitly here
137 $fields = array_merge( $fields, $this->getFileHandler()->getFieldsForSearchIndex( $engine ) );
138
139 return $fields;
140 }
141
142 public function getDataForSearchIndex(
143 WikiPage $page,
144 ParserOutput $parserOutput,
146 ) {
147 $fields = parent::getDataForSearchIndex( $page, $parserOutput, $engine );
148
149 $structure = new WikiTextStructure( $parserOutput );
150 $fields['heading'] = $structure->headings();
151 // text fields
152 $fields['opening_text'] = $structure->getOpeningText();
153 $fields['text'] = $structure->getMainText(); // overwrites one from ContentHandler
154 $fields['auxiliary_text'] = $structure->getAuxiliaryText();
155 $fields['defaultsort'] = $structure->getDefaultSort();
156
157 // Until we have full first-class content handler for files, we invoke it explicitly here
158 if ( NS_FILE == $page->getTitle()->getNamespace() ) {
159 $fields = array_merge( $fields,
160 $this->getFileHandler()->getDataForSearchIndex( $page, $parserOutput, $engine ) );
161 }
162 return $fields;
163 }
164
173 public function serializeContent( Content $content, $format = null ) {
174 $this->checkFormat( $format );
175
176 // NOTE: MessageContent also uses CONTENT_MODEL_WIKITEXT, but it's not a TextContent!
177 // Perhaps MessageContent should use a separate ContentHandler instead.
178 if ( $content instanceof MessageContent ) {
179 return $content->getMessage()->plain();
180 }
181
182 return parent::serializeContent( $content, $format );
183 }
184
185}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
checkFormat( $format)
Convenient for checking whether a format provided as a parameter is actually supported.
Content handler for File: files TODO: this handler s not used directly now, but instead manually call...
MediaWikiServices is the service locator for the application scope of MediaWiki.
Wrapper allowing us to handle a system message as a Content object.
Contain a class for special pages.
Base content handler implementation for flat text contents.
Represents a title within MediaWiki.
Definition Title.php:40
getNamespace()
Get the namespace index, i.e.
Definition Title.php:994
getFullText()
Get the prefixed title with spaces, plus any fragment (part beginning with '#')
Definition Title.php:1684
getInterwiki()
Get the interwiki prefix.
Definition Title.php:880
Class representing a MediaWiki article and history.
Definition WikiPage.php:45
getTitle()
Get the title object of the article.
Definition WikiPage.php:294
Class allowing to explore structure of parsed wikitext.
Content handler for wiki text pages.
getContentClass()
Returns the name of the associated Content class, to be used when creating new objects.
supportsRedirects()
Returns true because wikitext supports redirects.
getFieldsForSearchIndex(SearchEngine $engine)
Get fields definition for search index.
makeRedirectContent(Title $destination, $text='')
Returns a WikitextContent object representing a redirect to the given destination page.
isParserCacheSupported()
Returns true, because wikitext supports caching using the ParserCache mechanism.
__construct( $modelId=CONTENT_MODEL_WIKITEXT)
serializeContent(Content $content, $format=null)
Returns the content's text as-is.
supportsSections()
Returns true because wikitext supports sections.
getDataForSearchIndex(WikiPage $page, ParserOutput $parserOutput, SearchEngine $engine)
Return fields to be indexed by search engine as representation of this document.
const NS_FILE
Definition Defines.php:79
const CONTENT_MODEL_WIKITEXT
Definition Defines.php:244
const CONTENT_FORMAT_WIKITEXT
Definition Defines.php:259
const NS_CATEGORY
Definition Defines.php:87
the value to return A Title object or null for latest all implement SearchIndexField $engine
Definition hooks.txt:2925
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
Base interface for content objects.
Definition Content.php:34
const FLAG_SCORING
This field contains secondary information, which is already present in other fields,...
const INDEX_TYPE_TEXT
TEXT fields are suitable for natural language and may be subject to analysis such as stemming.
const FLAG_NO_HIGHLIGHT
This field does not need highlight handling.
$content