MediaWiki REL1_28
Go to the documentation of this file.
37 protected $mRevision = null;
42 protected $mImage = null;
47 protected $mTitle;
52 protected $mText;
57 protected $searchEngine;
63 protected $extensionData;
72 public static function newFromTitle( $title, SearchResultSet $parentSet = null ) {
73 $result = new static();
74 $result->initFromTitle( $title );
75 if ( $parentSet ) {
76 $parentSet->augmentResult( $result );
77 }
78 return $result;
79 }
87 protected function initFromTitle( $title ) {
88 $this->mTitle = $title;
89 if ( !is_null( $this->mTitle ) ) {
90 $id = false;
91 Hooks::run( 'SearchResultInitFromTitle', [ $title, &$id ] );
92 $this->mRevision = Revision::newFromTitle(
93 $this->mTitle, $id, Revision::READ_NORMAL );
94 if ( $this->mTitle->getNamespace() === NS_FILE ) {
95 $this->mImage = wfFindFile( $this->mTitle );
96 }
97 }
98 $this->searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
99 }
106 function isBrokenTitle() {
107 return is_null( $this->mTitle );
108 }
115 function isMissingRevision() {
116 return !$this->mRevision && !$this->mImage;
117 }
122 function getTitle() {
123 return $this->mTitle;
124 }
130 function getFile() {
131 return $this->mImage;
132 }
137 protected function initText() {
138 if ( !isset( $this->mText ) ) {
139 if ( $this->mRevision != null ) {
140 $this->mText = $this->searchEngine->getTextFromContent(
141 $this->mTitle, $this->mRevision->getContent() );
142 } else { // TODO: can we fetch raw wikitext for commons images?
143 $this->mText = '';
144 }
145 }
146 }
152 function getTextSnippet( $terms ) {
154 $this->initText();
156 // TODO: make highliter take a content object. Make ContentHandler a factory for SearchHighliter.
157 list( $contextlines, $contextchars ) = $this->searchEngine->userHighlightPrefs();
159 $h = new SearchHighlighter();
160 if ( count( $terms ) > 0 ) {
162 return $h->highlightText( $this->mText, $terms, $contextlines, $contextchars );
163 } else {
164 return $h->highlightSimple( $this->mText, $terms, $contextlines, $contextchars );
165 }
166 } else {
167 return $h->highlightNone( $this->mText, $contextlines, $contextchars );
168 }
169 }
174 function getTitleSnippet() {
175 return '';
176 }
182 return '';
183 }
188 function getRedirectTitle() {
189 return null;
190 }
195 function getSectionSnippet() {
196 return '';
197 }
203 function getSectionTitle() {
204 return null;
205 }
210 public function getCategorySnippet() {
211 return '';
212 }
217 function getTimestamp() {
218 if ( $this->mRevision ) {
219 return $this->mRevision->getTimestamp();
220 } elseif ( $this->mImage ) {
221 return $this->mImage->getTimestamp();
222 }
223 return '';
224 }
229 function getWordCount() {
230 $this->initText();
231 return str_word_count( $this->mText );
232 }
237 function getByteSize() {
238 $this->initText();
239 return strlen( $this->mText );
240 }
246 return '';
247 }
253 return '';
254 }
260 function isFileMatch() {
261 return false;
262 }
269 public function getExtensionData() {
271 }
280 $this->extensionData = $extensionData;
281 }
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Set to true to have nicer highlighted text in search results, by default off due to execution overhea...
wfFindFile( $title, $options=[])
Find a file.
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition File.php:50
MediaWikiServices is the service locator for the application scope of MediaWiki.
static newFromTitle(LinkTarget $linkTarget, $id=0, $flags=0)
Load either the current, or a specified, revision that's attached to a given link target.
Definition Revision.php:128
Contain a class for special pages.
Highlight bits of wikitext.
Lazy initialization of article text from DB.
Get the extension data as: augmentor name => data.
Revision $mRevision
Check if target page is missing, happens when index is out of date.
Get the file for this page, if one exists.
initFromTitle( $title)
Initialize from a Title and if possible initializes a corresponding Revision and File.
Did this match file contents (eg: PDF/DJVU)?
Check if this is result points to an invalid title.
setExtensionData(array $extensionData)
Set extension data for this result.
static newFromTitle( $title, SearchResultSet $parentSet=null)
Return a new SearchResult and initializes it with a title.
array[] $extensionData
A set of extension data.
getTextSnippet( $terms)
SearchEngine $searchEngine
Represents a title within MediaWiki.
Definition Title.php:36
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition deferred.txt:11
when a variable name is used in a it is silently declared as a new local masking the global
Definition design.txt:95
const NS_FILE
Definition Defines.php:62
the array() calling protocol came about after MediaWiki 1.4rc1.
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. '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 '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:Associative array mapping language codes to prefixed links of the form "language:title". & $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:1937
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:986
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