MediaWiki  REL1_31
WikitextContentHandler.php
Go to the documentation of this file.
1 <?php
32 
33  public function __construct( $modelId = CONTENT_MODEL_WIKITEXT ) {
34  parent::__construct( $modelId, [ CONTENT_FORMAT_WIKITEXT ] );
35  }
36 
37  protected function getContentClass() {
39  }
40 
51  public function makeRedirectContent( Title $destination, $text = '' ) {
52  $optionalColon = '';
53 
54  if ( $destination->getNamespace() == NS_CATEGORY ) {
55  $optionalColon = ':';
56  } else {
57  $iw = $destination->getInterwiki();
58  if ( $iw && Language::fetchLanguageName( $iw, null, 'mw' ) ) {
59  $optionalColon = ':';
60  }
61  }
62 
63  $mwRedir = MagicWord::get( 'redirect' );
64  $redirectText = $mwRedir->getSynonym( 0 ) .
65  ' [[' . $optionalColon . $destination->getFullText() . ']]';
66 
67  if ( $text != '' ) {
68  $redirectText .= "\n" . $text;
69  }
70 
71  $class = $this->getContentClass();
72  return new $class( $redirectText );
73  }
74 
82  public function supportsRedirects() {
83  return true;
84  }
85 
93  public function supportsSections() {
94  return true;
95  }
96 
107  public function isParserCacheSupported() {
108  return true;
109  }
110 
115  protected function getFileHandler() {
116  return new FileContentHandler();
117  }
118 
120  $fields = parent::getFieldsForSearchIndex( $engine );
121 
122  $fields['heading'] =
123  $engine->makeSearchFieldMapping( 'heading', SearchIndexField::INDEX_TYPE_TEXT );
124  $fields['heading']->setFlag( SearchIndexField::FLAG_SCORING );
125 
126  $fields['auxiliary_text'] =
127  $engine->makeSearchFieldMapping( 'auxiliary_text', SearchIndexField::INDEX_TYPE_TEXT );
128 
129  $fields['opening_text'] =
130  $engine->makeSearchFieldMapping( 'opening_text', SearchIndexField::INDEX_TYPE_TEXT );
131  $fields['opening_text']->setFlag(
133  );
134  // Until we have full first-class content handler for files, we invoke it explicitly here
135  $fields = array_merge( $fields, $this->getFileHandler()->getFieldsForSearchIndex( $engine ) );
136 
137  return $fields;
138  }
139 
140  public function getDataForSearchIndex(
141  WikiPage $page,
142  ParserOutput $parserOutput,
144  ) {
145  $fields = parent::getDataForSearchIndex( $page, $parserOutput, $engine );
146 
147  $structure = new WikiTextStructure( $parserOutput );
148  $fields['heading'] = $structure->headings();
149  // text fields
150  $fields['opening_text'] = $structure->getOpeningText();
151  $fields['text'] = $structure->getMainText(); // overwrites one from ContentHandler
152  $fields['auxiliary_text'] = $structure->getAuxiliaryText();
153  $fields['defaultsort'] = $structure->getDefaultSort();
154 
155  // Until we have full first-class content handler for files, we invoke it explicitly here
156  if ( NS_FILE == $page->getTitle()->getNamespace() ) {
157  $fields = array_merge( $fields,
158  $this->getFileHandler()->getDataForSearchIndex( $page, $parserOutput, $engine ) );
159  }
160  return $fields;
161  }
162 
163 }
ParserOutput
Definition: ParserOutput.php:25
SearchIndexField\FLAG_SCORING
const FLAG_SCORING
This field contains secondary information, which is already present in other fields,...
Definition: SearchIndexField.php:39
WikitextContentHandler\getFileHandler
getFileHandler()
Get file handler.
Definition: WikitextContentHandler.php:115
WikiPage
Class representing a MediaWiki article and history.
Definition: WikiPage.php:37
MagicWord\get
static & get( $id)
Factory: creates an object representing an ID.
Definition: MagicWord.php:277
NS_FILE
const NS_FILE
Definition: Defines.php:80
WikitextContentHandler\getFieldsForSearchIndex
getFieldsForSearchIndex(SearchEngine $engine)
Get fields definition for search index.
Definition: WikitextContentHandler.php:119
CONTENT_MODEL_WIKITEXT
const CONTENT_MODEL_WIKITEXT
Definition: Defines.php:245
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
WikitextContentHandler\getDataForSearchIndex
getDataForSearchIndex(WikiPage $page, ParserOutput $parserOutput, SearchEngine $engine)
Return fields to be indexed by search engine as representation of this document.
Definition: WikitextContentHandler.php:140
Title\getNamespace
getNamespace()
Get the namespace index, i.e.
Definition: Title.php:970
Title\getInterwiki
getInterwiki()
Get the interwiki prefix.
Definition: Title.php:857
WikiPage\getTitle
getTitle()
Get the title object of the article.
Definition: WikiPage.php:236
Title\getFullText
getFullText()
Get the prefixed title with spaces, plus any fragment (part beginning with '#')
Definition: Title.php:1649
NS_CATEGORY
const NS_CATEGORY
Definition: Defines.php:88
CONTENT_FORMAT_WIKITEXT
const CONTENT_FORMAT_WIKITEXT
Definition: Defines.php:260
SearchIndexField\FLAG_NO_HIGHLIGHT
const FLAG_NO_HIGHLIGHT
This field does not need highlight handling.
Definition: SearchIndexField.php:44
WikitextContentHandler
Content handler for wiki text pages.
Definition: WikitextContentHandler.php:31
WikitextContentHandler\isParserCacheSupported
isParserCacheSupported()
Returns true, because wikitext supports caching using the ParserCache mechanism.
Definition: WikitextContentHandler.php:107
WikitextContentHandler\__construct
__construct( $modelId=CONTENT_MODEL_WIKITEXT)
Definition: WikitextContentHandler.php:33
FileContentHandler
Content handler for File: files TODO: this handler s not used directly now, but instead manually call...
Definition: FileContentHandler.php:9
TextContentHandler
Base content handler implementation for flat text contents.
Definition: TextContentHandler.php:31
$engine
the value to return A Title object or null for latest all implement SearchIndexField $engine
Definition: hooks.txt:2881
Language\fetchLanguageName
static fetchLanguageName( $code, $inLanguage=null, $include='all')
Definition: Language.php:896
SearchEngine
Contain a class for special pages.
Definition: SearchEngine.php:34
Title
Represents a title within MediaWiki.
Definition: Title.php:39
WikitextContentHandler\supportsRedirects
supportsRedirects()
Returns true because wikitext supports redirects.
Definition: WikitextContentHandler.php:82
WikiTextStructure
Class allowing to explore structure of parsed wikitext.
Definition: WikiTextStructure.php:8
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
WikitextContentHandler\supportsSections
supportsSections()
Returns true because wikitext supports sections.
Definition: WikitextContentHandler.php:93
WikitextContentHandler\makeRedirectContent
makeRedirectContent(Title $destination, $text='')
Returns a WikitextContent object representing a redirect to the given destination page.
Definition: WikitextContentHandler.php:51
WikitextContentHandler\getContentClass
getContentClass()
Returns the name of the associated Content class, to be used when creating new objects.
Definition: WikitextContentHandler.php:37
SearchIndexField\INDEX_TYPE_TEXT
const INDEX_TYPE_TEXT
Field types.
Definition: SearchIndexField.php:10