[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/search/ -> SearchResult.php (summary)

Search engine result This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

File Size: 237 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

SearchResult:: (19 methods):
  newFromTitle()
  initFromTitle()
  isBrokenTitle()
  isMissingRevision()
  getTitle()
  getFile()
  initText()
  getTextSnippet()
  getTitleSnippet()
  getRedirectSnippet()
  getRedirectTitle()
  getSectionSnippet()
  getSectionTitle()
  getTimestamp()
  getWordCount()
  getByteSize()
  getInterwikiPrefix()
  getInterwikiNamespaceText()
  isFileMatch()


Class: SearchResult  - X-Ref


newFromTitle( $title )   X-Ref
Return a new SearchResult and initializes it with a title.

param: Title $title
return: SearchResult

initFromTitle( $title )   X-Ref
Initialize from a Title and if possible initializes a corresponding
Revision and File.

param: Title $title

isBrokenTitle()   X-Ref
Check if this is result points to an invalid title

return: bool

isMissingRevision()   X-Ref
Check if target page is missing, happens when index is out of date

return: bool

getTitle()   X-Ref

return: Title

getFile()   X-Ref
Get the file for this page, if one exists

return: File|null

initText()   X-Ref
Lazy initialization of article text from DB


getTextSnippet( $terms )   X-Ref

param: array $terms Terms to highlight
return: string Highlighted text snippet, null (and not '') if not supported

getTitleSnippet()   X-Ref

return: string Highlighted title, '' if not supported

getRedirectSnippet()   X-Ref

return: string Highlighted redirect name (redirect to this page), '' if none or not supported

getRedirectTitle()   X-Ref

return: Title Title object for the redirect to this page, null if none or not supported

getSectionSnippet()   X-Ref

return: string Highlighted relevant section name, null if none or not supported

getSectionTitle()   X-Ref

return: Title Title object (pagename+fragment) for the section, null if none or not supported

getTimestamp()   X-Ref

return: string Timestamp

getWordCount()   X-Ref

return: int Number of words

getByteSize()   X-Ref

return: int Size in bytes

getInterwikiPrefix()   X-Ref

return: string Interwiki prefix of the title (return iw even if title is broken)

getInterwikiNamespaceText()   X-Ref

return: string Interwiki namespace of the title (since we likely can't resolve it locally)

isFileMatch()   X-Ref
Did this match file contents (eg: PDF/DJVU)?

return: bool



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1