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

Public Member Functions

 onBeforePageDisplay (&$oOutputPage, &$oSkin)
 
 onGetPreferences ($user, &$preferences)
 
 onUserSaveOptions ($user, &$options)
 
 onUserGetDefaultOptions (&$defaultOptions)
 
- 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 onUserLoadOptions ($user, &$options)
 

Protected Member Functions

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

UserPreferences::onBeforePageDisplay ( $oOutputPage,
$oSkin 
)

Hook-Handler for MediaWiki 'BeforePageDisplay' hook. Sets context if needed.

Parameters
OutputPage$oOutputPage
Skin$oSkin
Returns
bool
UserPreferences::onGetPreferences (   $user,
$preferences 
)

Hook handler for GetPreferences

Parameters
User$userUser whose preferences are being modified.
Array&$preferencesPreferences description array, to be fed to an HTMLForm object
Returns
true always true to keep hook alive
UserPreferences::onUserGetDefaultOptions ( $defaultOptions)

Adds default user settings for users that have not saved their preferences yet. Is only called once at session start!

Parameters
array$defaultOptions
Returns
boolean
static UserPreferences::onUserLoadOptions (   $user,
$options 
)
static

Hook handler for UserLoadOptions

Parameters
User$userUser whose options are being modified.
Array&$optionsOptions array
Returns
true always true to keep hook alive
UserPreferences::onUserSaveOptions (   $user,
$options 
)

Hook handler for UserSaveOptions

Parameters
User$userUser whose options are being modified.
Array&$optionsOptions array
Returns
true always true to keep hook alive

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