MediaWiki  master
SearchResult.php
Go to the documentation of this file.
1 <?php
25 
32 class SearchResult {
33 
37  protected $mRevision = null;
38 
42  protected $mImage = null;
43 
47  protected $mTitle;
48 
52  protected $mText;
53 
57  protected $searchEngine;
58 
63  protected $extensionData;
64 
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  }
80 
87  protected function initFromTitle( $title ) {
88  $this->mTitle = $title;
89  $services = MediaWikiServices::getInstance();
90  if ( !is_null( $this->mTitle ) ) {
91  $id = false;
92  Hooks::run( 'SearchResultInitFromTitle', [ $title, &$id ] );
93  $this->mRevision = Revision::newFromTitle(
94  $this->mTitle, $id, Revision::READ_NORMAL );
95  if ( $this->mTitle->getNamespace() === NS_FILE ) {
96  $this->mImage = $services->getRepoGroup()->findFile( $this->mTitle );
97  }
98  }
99  $this->searchEngine = $services->newSearchEngine();
100  }
101 
107  function isBrokenTitle() {
108  return is_null( $this->mTitle );
109  }
110 
116  function isMissingRevision() {
117  return !$this->mRevision && !$this->mImage;
118  }
119 
123  function getTitle() {
124  return $this->mTitle;
125  }
126 
131  function getFile() {
132  return $this->mImage;
133  }
134 
138  protected function initText() {
139  if ( !isset( $this->mText ) ) {
140  if ( $this->mRevision != null ) {
141  $this->mText = $this->searchEngine->getTextFromContent(
142  $this->mTitle, $this->mRevision->getContent() );
143  } else { // TODO: can we fetch raw wikitext for commons images?
144  $this->mText = '';
145  }
146  }
147  }
148 
153  function getTextSnippet( $terms = [] ) {
154  return '';
155  }
156 
160  function getTitleSnippet() {
161  return '';
162  }
163 
167  function getRedirectSnippet() {
168  return '';
169  }
170 
174  function getRedirectTitle() {
175  return null;
176  }
177 
181  function getSectionSnippet() {
182  return '';
183  }
184 
189  function getSectionTitle() {
190  return null;
191  }
192 
196  public function getCategorySnippet() {
197  return '';
198  }
199 
203  function getTimestamp() {
204  if ( $this->mRevision ) {
205  return $this->mRevision->getTimestamp();
206  } elseif ( $this->mImage ) {
207  return $this->mImage->getTimestamp();
208  }
209  return '';
210  }
211 
215  function getWordCount() {
216  $this->initText();
217  return str_word_count( $this->mText );
218  }
219 
223  function getByteSize() {
224  $this->initText();
225  return strlen( $this->mText );
226  }
227 
231  function getInterwikiPrefix() {
232  return '';
233  }
234 
239  return '';
240  }
241 
246  function isFileMatch() {
247  return false;
248  }
249 
255  public function getExtensionData() {
256  if ( $this->extensionData ) {
257  return call_user_func( $this->extensionData );
258  } else {
259  return [];
260  }
261  }
262 
270  public function setExtensionData( $extensionData ) {
271  if ( $extensionData instanceof Closure ) {
272  $this->extensionData = $extensionData;
273  } elseif ( is_array( $extensionData ) ) {
274  wfDeprecated( __METHOD__ . ' with array argument', '1.32' );
275  $this->extensionData = function () use ( $extensionData ) {
276  return $extensionData;
277  };
278  } else {
279  $type = is_object( $extensionData )
280  ? get_class( $extensionData )
281  : gettype( $extensionData );
282  throw new \InvalidArgumentException(
283  __METHOD__ . " must be called with Closure|array, but received $type" );
284  }
285  }
286 }
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getFile()
Get the file for this page, if one exists.
initText()
Lazy initialization of article text from DB.
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 MediaWikiServices
Definition: injection.txt:23
static newFromTitle(LinkTarget $linkTarget, $id=0, $flags=0)
Load either the current, or a specified, revision that&#39;s attached to a given link target...
Definition: Revision.php:137
getInterwikiNamespaceText()
static newFromTitle( $title, SearchResultSet $parentSet=null)
Return a new SearchResult and initializes it with a title.
getExtensionData()
Get the extension data as: augmentor name => data.
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 '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:1961
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 or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
Definition: hooks.txt:2198
getTextSnippet( $terms=[])
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:767
isBrokenTitle()
Check if this is result points to an invalid title.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
const NS_FILE
Definition: Defines.php:66
initFromTitle( $title)
Initialize from a Title and if possible initializes a corresponding Revision and File.
isFileMatch()
Did this match file contents (eg: PDF/DJVU)?
SearchEngine $searchEngine
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
setExtensionData( $extensionData)
Set extension data for this result.
Closure null $extensionData
A function returning a set of extension data.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
Revision $mRevision
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
isMissingRevision()
Check if target page is missing, happens when index is out of date.