Semantic MediaWiki and related extensions
Public Member Functions | Protected Attributes | List of all members
SMW\Query\Excerpts Class Reference
Inheritance diagram for SMW\Query\Excerpts:
Inheritance graph
[legend]

Public Member Functions

 noHighlight ()
 
 addExcerpt ( $hash, $excerpt)
 
 getExcerpt ( $hash)
 
 getExcerpts ()
 
 hasHighlight ()
 

Protected Attributes

 $excerpts = []
 
 $noHighlight = false
 
 $hasHighlight = false
 
 $stripTags = true
 

Detailed Description

Record excerpts for query results that support an excerpt retrieval function.

GNU GPL v2+

Since
3.0
Author
mwjames

Member Function Documentation

◆ addExcerpt()

SMW\Query\Excerpts::addExcerpt (   $hash,
  $excerpt 
)
Note
The hash is expected to be equivalent to DIWikiPage::getHash to easily match result subjects available in an QueryResult instance.
Since
3.0
Parameters
DIWikiPage | string$hash
string | integer$score

◆ getExcerpt()

SMW\Query\Excerpts::getExcerpt (   $hash)
Since
3.0
Parameters
DIWikiPage | string$hash
Returns
string|integer|false

◆ getExcerpts()

SMW\Query\Excerpts::getExcerpts ( )
Since
3.0
Returns
[]

◆ hasHighlight()

SMW\Query\Excerpts::hasHighlight ( )
Since
3.0
Returns
boolean

◆ noHighlight()

SMW\Query\Excerpts::noHighlight ( )
Since
3.0

The documentation for this class was generated from the following file:

About | General disclaimer | Privacy policy