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

Public Member Functions

 onBeforePageDisplay ($oOutputPage, $oSkinTemplate)
 
 onUserCan ($oTitle, $oUser, $sAction, $bResult)
 
 onGetPreferences ($oUser, &$aPreferences)
 
 onUserPageSettings ($oUser, $oTitle, &$aSettingViews)
 
 getGlobalActionsWidget (User $oUser, $aLinks=array())
 
 onSkinTemplateOutputPageBeforeExec (&$sktemplate, &$tpl)
 
 onEditFormPreloadText (&$text, &$title)
 
- Public Member Functions inherited from BsExtensionMW
 setCore ($oCore)
 
 getInfo ()
 
 getName ()
 
 getExtensionKey ()
 
 setup ($sExtName="", $aConfig=array())
 
 setHook ($hook, $method=false, $bExecuteFirst=false)
 
 getResourcePath ()
 
 getImagePath ($bResources=false)
 
 getCacheKey ($sSubKey= 'default')
 
 makeTagExtensionDefinitions ()
 
- Public Member Functions inherited from ContextSource
 getContext ()
 
 setContext (IContextSource $context)
 
 getConfig ()
 
 getRequest ()
 
 getTitle ()
 
 canUseWikiPage ()
 
 getWikiPage ()
 
 getOutput ()
 
 getUser ()
 
 getLanguage ()
 
 getSkin ()
 
 getTiming ()
 
 getStats ()
 
 msg ()
 
 exportSession ()
 

Static Public Member Functions

static getMediaWikiGlobalActions ($aLinks=array())
 
static onPageContentSaveComplete ($article, $user, $content, $summary, $isMinor, $isWatch, $section, $flags, $revision, $status, $baseRevId)
 
static onUserSaveSettings ($user)
 

Protected Member Functions

 initExt ()
 
- Protected Member Functions inherited from BsExtensionMW
 initExt ()
 

Protected Attributes

 $aKeywords = array()
 
- Protected Attributes inherited from BsExtensionMW
 $mExtensionFile = null
 
 $mExtensionType = null
 
 $mInfo = null
 
 $mExtensionKey = null
 
 $mResourcePath = null
 
 $sName = ''
 
 $sStatus = ''
 
 $sPackage = ''
 
 $mCore = null
 
 $aStandardContext = array( '*', '*', '*' )
 

Member Function Documentation

UserSidebar::getGlobalActionsWidget ( User  $oUser,
  $aLinks = array() 
)

Returns the view for the global actions widget

Parameters
User$oUser
Returns
static UserSidebar::getMediaWikiGlobalActions (   $aLinks = array())
static

Returns the basic mediawiki links for the global actions widget

Parameters
array$aLinks
Returns
array
UserSidebar::initExt ( )
protected

Initialization of UserSidebar extension

UserSidebar::onBeforePageDisplay (   $oOutputPage,
  $oSkinTemplate 
)
Parameters
OutputPage$oOutputPage
SkinTemplate$oSkinTemplate
Returns
boolean
UserSidebar::onEditFormPreloadText ( $text,
$title 
)

Fills default widget list definition into user's config page

Parameters
string$text
Title$title
Returns
boolean Always true to keep hook running
UserSidebar::onGetPreferences (   $oUser,
$aPreferences 
)

Hook-Handler for GetPreferences

Parameters
User$oUserCurrent user object
array$aPreferencesreference of Preferences array
Returns
bool true always true to keep hook alive
static UserSidebar::onPageContentSaveComplete (   $article,
  $user,
  $content,
  $summary,
  $isMinor,
  $isWatch,
  $section,
  $flags,
  $revision,
  $status,
  $baseRevId 
)
static

Invalidates user sidebar cache

Parameters
Article$article
User$user
Content$content
type$summary
type$isMinor
type$isWatch
type$section
type$flags
Revision$revision
Status$status
type$baseRevId
Returns
boolean
UserSidebar::onSkinTemplateOutputPageBeforeExec ( $sktemplate,
$tpl 
)

Adds Focus tab to main navigation

Parameters
SkinTemplate$sktemplate
BaseTemplate$tpl
Returns
boolean Always true to keep hook running
UserSidebar::onUserCan (   $oTitle,
  $oUser,
  $sAction,
  $bResult 
)

Hook-Handler for 'userCan', prevents foreign access to a users sidebar settings

Parameters
Title$oTitleTitle object being checked against
User$oUserCurrent user object
string$sActionAction being checked
bool$bResultPointer to result returned if hook returns false. If null is returned, userCan checks are continued by internal code.
Returns
bool false if the user accesses a UserSidebar Title of another user, true in all other cases.
UserSidebar::onUserPageSettings (   $oUser,
  $oTitle,
$aSettingViews 
)

Hook-handler for 'BS:UserPageSettings'

Parameters
User$oUserThe current MediaWiki User object
Title$oTitleThe current MediaWiki Title object
array$aSettingViewsA list of View objects
Returns
array The SettingsViews array with an andditional View object
static UserSidebar::onUserSaveSettings (   $user)
static

Hook handler for UserSaveSettings - invalidate widget caches

Parameters
User$user
Returns
boolean

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