Semantic MediaWiki and related extensions
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SMW\Factbox\Factbox Class Reference

Public Member Functions

 __construct (Store $store, ParserData $parserData)
 
 setFeatureSet ( $featureSet)
 
 setCheckMagicWords (CheckMagicWords $checkMagicWords)
 
 doBuild ()
 
 getTitle ()
 
 getContent ()
 
 setAttachments (array $attachments)
 
 getAttachmentContent ()
 
 isVisible ()
 

Static Public Member Functions

static tabs ( $list, $attachment='', $derived='')
 
static getModules ()
 

Protected Member Functions

 getMagicWords ()
 
 fetchContent ( $showFactbox=SMW_FACTBOX_NONEMPTY)
 
 createTable (SemanticData $semanticData)
 

Protected Attributes

 $isVisible = false
 
 $content = null
 

Detailed Description

Class handling the "Factbox" content rendering

GNU GPL v2+

Since
1.9
Author
mwjames

Constructor & Destructor Documentation

◆ __construct()

SMW\Factbox\Factbox::__construct ( Store  $store,
ParserData  $parserData 
)
Since
1.9
Parameters
Store$store
ParserData$parserData

Member Function Documentation

◆ createTable()

SMW\Factbox\Factbox::createTable ( SemanticData  $semanticData)
protected

Returns a formatted factbox table

Since
1.9
Parameters
SMWSemanticData$semanticData
Returns
string|null

◆ doBuild()

SMW\Factbox\Factbox::doBuild ( )

Builds content suitable for rendering a Factbox and updating the ParserOutput accordingly

Since
1.9
Returns
Factbox

◆ fetchContent()

SMW\Factbox\Factbox::fetchContent (   $showFactbox = SMW_FACTBOX_NONEMPTY)
protected

Returns content found for a given ParserOutput object and if the required custom data was not available then semantic data are retrieved from the store for a given subject.

The method checks whether the given setting of $showfactbox requires displaying the given data at all.

Since
1.9
Returns
integer $showFactbox
string|null

◆ getAttachmentContent()

SMW\Factbox\Factbox::getAttachmentContent ( )
Since
3.1
Returns
string

◆ getContent()

SMW\Factbox\Factbox::getContent ( )
Since
1.9
Returns
string|null

◆ getMagicWords()

SMW\Factbox\Factbox::getMagicWords ( )
protected

Returns magic words attached to the ParserOutput object

Since
1.9
Returns
string|null

◆ getModules()

static SMW\Factbox\Factbox::getModules ( )
static

Returns required resource modules

Since
1.9
Returns
array

◆ getTitle()

SMW\Factbox\Factbox::getTitle ( )

Returns Title object

Since
1.9
Returns
string|null

◆ isVisible()

SMW\Factbox\Factbox::isVisible ( )

Returns if content is visible

Since
1.9
Returns
boolean

◆ setAttachments()

SMW\Factbox\Factbox::setAttachments ( array  $attachments)
Since
3.1
Parameters
array$attachments

◆ setCheckMagicWords()

SMW\Factbox\Factbox::setCheckMagicWords ( CheckMagicWords  $checkMagicWords)
Since
3.1
Parameters
CheckMagicWords$checkMagicWords

◆ setFeatureSet()

SMW\Factbox\Factbox::setFeatureSet (   $featureSet)
Since
3.0
Parameters
integer$featureSet

◆ tabs()

static SMW\Factbox\Factbox::tabs (   $list,
  $attachment = '',
  $derived = '' 
)
static
Since
3.0
Parameters
string$rendered
string$derived
Returns
string

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

About | General disclaimer | Privacy policy