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

Public Member Functions

 runPreferencePlugin ($sAdapterName, $oVariable)
 
 onMessagesPreLoad ($sKey, &$sMessage)
 
 onParserFirstCallInit (&$parser)
 
 onTagPageTemplates ($input, $args, $parser)
 
 onLinkBegin ($oLinker, $oTarget, &$sHtml, &$aCustomAttribs, &$aQuery, &$aOptions, &$sRet)
 
- 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 getSchemaUpdates ($updater)
 
static onBSUsageTrackerRegisterCollectors (&$aCollectorsConfig)
 
static onUnitTestsList (&$paths)
 

Protected Member Functions

 initExt ()
 
 renderPageTemplates ()
 
- 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

static PageTemplates::getSchemaUpdates (   $updater)
static

Hook-Handler for Hook 'LoadExtensionSchemaUpdates'

Parameters
object┬župdater Updater
Returns
boolean Always true
PageTemplates::initExt ( )
protected

Initialization of PageTemplates extension

static PageTemplates::onBSUsageTrackerRegisterCollectors ( $aCollectorsConfig)
static

Register tag with UsageTracker extension

Parameters
array$aCollectorsConfig
Returns
Always true to keep hook running
PageTemplates::onLinkBegin (   $oLinker,
  $oTarget,
$sHtml,
$aCustomAttribs,
$aQuery,
$aOptions,
$sRet 
)

Hook handler for LinkBegin

Parameters
Linker$oLinker
Title$oTarget
string$sHtml
array$aCustomAttribs
array$aQuery
array$aOptions
string$sRet
Returns
boolean Always true to keep hook running
PageTemplates::onMessagesPreLoad (   $sKey,
$sMessage 
)

Automatically modifies "noarticletext" message. Otherwise, you would have to modify MediaWiki:noarticletext in the wiki, wich causes installation overhead.

Parameters
string$sKeyThe message key. Note that it comes ucfirst and can be an i18n version (e.g. Noarticletext/de-formal)
string$sMessageThis variable is called by reference and modified.
Returns
bool Success marker for MediaWiki Hooks. The message itself is returned in referenced variable $sMessage. Note that it cannot contain pure HTML.
Exceptions
PermissionsError
PageTemplates::onParserFirstCallInit ( $parser)

Registers the pagetemplate tag with the parser

Parameters
Parser$parserThe parser object of MediaWiki
Returns
bool allow other hooked methods to be executed. Always true.
PageTemplates::onTagPageTemplates (   $input,
  $args,
  $parser 
)

Callback function that is triggered when the parser encounters a pagetemplate tag

Parameters
string$inputinnerHTML of the tag
array$argstag attributes
Parser$parserthe parser object of MediaWiki
Returns
string replacement HTML for the tag
static PageTemplates::onUnitTestsList ( $paths)
static

Register PHP Unit Tests with MediaWiki framework

Parameters
array$paths
Returns
boolean
PageTemplates::renderPageTemplates ( )
protected

Renders the pagetemplates form which is displayed when creating a new article

Parameters
bool$bReturnHTMLIf set, the form is returned as HTML, otherwise as wiki code.
Returns
string The rendered output

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