BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
Bookshelf Class Reference
Inheritance diagram for Bookshelf:
Collaboration diagram for Bookshelf:

Public Member Functions

 runPreferencePlugin ($sAdapterName, $oVariable)
 
 onBeforePageDisplay ($out)
 
 onSkinTemplateNavigation ($oSkinTemplate, &$links)
 
 onBSUEModulePDFcollectMetaData ($oTitle, $oPageDOM, &$aParams, $oDOMXPath, &$aMeta)
 
 onBSUEModulePDFBeforeCreateWidget ($oUEModulePDFExt, $oSpecialPage, &$aLinks, $aParams)
 
 onBSUEModulePDFgetPage ($oTitle, &$aPage, &$aParams, $oDOMXPath)
 
 onBSUEModulePDFAfterFindFiles ($oSender, $oHtml, &$aFiles, $aParams, $oDOMXPath)
 
 onParserFirstCallInit (&$oParser)
 
 onBSWidgetListHelperInitKeyWords (&$aKeywords, $oTitle)
 
 onWidgetListKeyword ()
 
 onBookshelfTag ($sInput, $aAttributes, $oParser)
 
 onStatebarAddSortBodyVars (&$aSortBodyVars)
 
 onBSInsertMagicAjaxGetData (&$oResponse, $type)
 
 onBookshelfMetaTag ($sContent, $aAttributes, $oParser)
 
 onStateBarBeforeBodyViewAdd ($oStateBar, &$aBodyViews, $oUser, $oTitle)
 
 onBookshelfListTag ($sContent, $aAttributes, $oParser)
 
 onBSUEModulePDFbeforeGetPage (&$aParams)
 
 onBookshelfNodeTag ($sInput, $aAttributes, $oParser)
 
- Public Member Functions inherited from BsExtensionMW
 setCore ($oCore)
 
 getInfo ()
 
 setup ($sExtName="", $aConfig=array())
 
 setHook ($hook, $method=false, $bExecuteFirst=false)
 
 setContext (\IContextSource $context)
 
 setConfig (\Config $config)
 
 getResourcePath ()
 
 getName ()
 
 getExtensionKey ()
 
 getExtensionPath ()
 
 getImagePath ($bResources=false)
 
 getCacheKey ($sSubKey= 'default')
 
 makeTagExtensionDefinitions ()
 
- Public Member Functions inherited from BlueSpice\Extension
 jsonSerialize ()
 
 __construct (array $definition,\IContextSource $context,\Config $config)
 
 getInfo ()
 
 getResourcePath ()
 
 getExtensionPath ()
 
 getName ()
 
 getAuthors ()
 
 getStatus ()
 
 getPackage ()
 
 getUrl ()
 
 getVersion ()
 
 getExtensionKey ()
 
- Public Member Functions inherited from BlueSpice\Context
 __construct (\IContextSource $context,\Config $config)
 
 canUseWikiPage ()
 
 exportSession ()
 
 getConfig ()
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 
 msg ($key)
 

Static Public Member Functions

static onRegistration ()
 
static onUnitTestsList (&$files)
 

Protected Member Functions

 initExt ()
 
 createRunningHeader ($aPage, $aAncestors, $aBookMeta)
 
- Protected Member Functions inherited from BsExtensionMW
 initExt ()
 

Additional Inherited Members

- Protected Attributes inherited from BsExtensionMW
 $mExtensionKey = null
 
 $mExtensionFile = null
 
 $mExtensionType = null
 
 $mInfo = null
 
 $mResourcePath = null
 
 $sName = ''
 
 $sStatus = ''
 
 $sPackage = ''
 
 $mCore = null
 
 $aStandardContext = array( '*', '*', '*' )
 
- Protected Attributes inherited from BlueSpice\Extension
 $extPath = ''
 
 $name = ''
 
 $authors = []
 
 $version = ''
 
 $url = ''
 
 $status = ''
 
 $package = ''
 
- Protected Attributes inherited from BlueSpice\Context
 $context = null
 
 $config = null
 

Member Function Documentation

Bookshelf::onBeforePageDisplay (   $out)
Parameters
OutputPage$out
Returns
boolean
Bookshelf::onBookshelfListTag (   $sContent,
  $aAttributes,
  $oParser 
)
Parameters
string$sInputContent of $lt;booklist /> from MediaWiki Framework
array$aAttributesAttributes of <booklist /> from MediaWiki Framework
Parser$oParserParser object from MediaWiki Framework
Returns
string
Bookshelf::onBookshelfMetaTag (   $sContent,
  $aAttributes,
  $oParser 
)
Parameters
string$sInputContent of $lt;bookmeta /> from MediaWiki Framework
array$aAttributesAttributes of <bookmeta /> from MediaWiki Framework
Parser$oParserParser object from MediaWiki Framework
Returns
string
Bookshelf::onBookshelfNodeTag (   $sInput,
  $aAttributes,
  $oParser 
)

Renders a generic node tag that gets evaluated by ... future code or clientside extensions

Parameters
String$sInput
array$aAttributes
Parser$oParser
Returns
string The HTML to be send to the client
Bookshelf::onBookshelfTag (   $sInput,
  $aAttributes,
  $oParser 
)
Parameters
string$sInputContent of $lt;bs:collectiontoc /> from MediaWiki Framework
array$aAttributesAttributes of <bs:collectiontoc /> from MediaWiki Framework
Parser$oParserParser object from MediaWiki Framework
Returns
string
Bookshelf::onBSUEModulePDFAfterFindFiles (   $oSender,
  $oHtml,
$aFiles,
  $aParams,
  $oDOMXPath 
)

Adds File attachment feature to UEModulePDF

Parameters
object$oSender
DOMDocument$oHtml
array$aFiles
array$aParams
DOMXPath$oDOMXPath
Returns
boolean always true to keep hook running
Bookshelf::onBSUEModulePDFBeforeCreateWidget (   $oUEModulePDFExt,
  $oSpecialPage,
$aLinks,
  $aParams 
)
Parameters
UEModulePDF$oUEModulePDFExt
Title$oSpecialPage
array$aLinks
array$aParams
Returns
boolean Always true to keep hook running
Bookshelf::onBSUEModulePDFbeforeGetPage ( $aParams)

Adapts page titles in PDF Export

Parameters
type$aParams
Returns
boolean
Bookshelf::onBSUEModulePDFcollectMetaData (   $oTitle,
  $oPageDOM,
$aParams,
  $oDOMXPath,
$aMeta 
)
Parameters
Title$oTitle
DOMDocument$oPageDOM
array$aParams
DOMXPath$oDOMXPath
array$aMeta
Returns
boolean Always true to keep hook running
Bookshelf::onBSUEModulePDFgetPage (   $oTitle,
$aPage,
$aParams,
  $oDOMXPath 
)

Modify document for UEModulePDF: Add numbers to headlines, etc.

Parameters
Title$oTitleThe title that gets exported
array&$aPageThe page array from UEModulePDFs PDFPageProvider array &$aParams All given params
DOMXPath$oDOMXPath
Returns
true
Bookshelf::onBSWidgetListHelperInitKeyWords ( $aKeywords,
  $oTitle 
)
Parameters
array$aKeywords
Title$oTitle
Returns
boolean Always true to keep the hook running
Bookshelf::onParserFirstCallInit ( $oParser)

Sets new Parser-Hooks for the <bs:bookshelf /> tag

Parameters
Parser$oParserThe current parser object from MediaWiki Framework
Returns
true
static Bookshelf::onRegistration ( )
static

extension.json callback

Bookshelf::onSkinTemplateNavigation (   $oSkinTemplate,
$links 
)

Adds the "Add to book" menu entry in view mode

Parameters
SkinTemplate$oSkinTemplate
array$links
Returns
boolean Always true to keep hook running
Bookshelf::onStatebarAddSortBodyVars ( $aSortBodyVars)

Hook-Handler for Hook 'BSStatebarAddSortBodyVars'

Parameters
array$aSortBodyVars
Returns
boolean Always true to keep hook running
Bookshelf::onStateBarBeforeBodyViewAdd (   $oStateBar,
$aBodyViews,
  $oUser,
  $oTitle 
)

Hook-Handler for Hook 'BSStateBarBeforeBodyViewAdd'

Parameters
StateBar$oStateBar
array$aBodyViews
Returns
boolean Always true to keep hook running
static Bookshelf::onUnitTestsList ( $files)
static

Register PHP Unit Tests with MediaWiki frameweork

Parameters
array$files
Returns
boolean
Bookshelf::onWidgetListKeyword ( )

Creates a Widget and returns it

Returns
ViewWidget
Bookshelf::runPreferencePlugin (   $sAdapterName,
  $oVariable 
)

Sets parameters for more complex options in preferences

Parameters
string$sAdapterNameName of the adapter, e.g. MW
BsConfig$oVariableInstance of variable
Returns
array Preferences options

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