MediaWiki REL1_34
Static Public Member Functions | Static Private Member Functions | Static Private Attributes | List of all members
WikiEditorHooks Class Reference

Static Public Member Functions

static doEventLogging ( $action, $article, $data=[])
 Log stuff to EventLogging's Schema:EditAttemptStep - see https://meta.wikimedia.org/wiki/Schema:EditAttemptStep If you don't have EventLogging installed, does nothing.
 
static editPageAttemptSave (EditPage $editPage)
 This is attached to the MediaWiki 'EditPage::attemptSave' hook.
 
static editPageAttemptSaveAfter (EditPage $editPage, Status $status)
 This is attached to the MediaWiki 'EditPage::attemptSave:after' hook.
 
static EditPageBeforeEditToolbar (&$toolbar)
 EditPageBeforeEditToolbar hook.
 
static editPageShowEditFormFields (EditPage $editPage, OutputPage $outputPage)
 EditPage::showEditForm:fields hook.
 
static editPageShowEditFormInitial (EditPage $editPage, OutputPage $outputPage)
 EditPage::showEditForm:initial hook.
 
static getModuleData (ResourceLoaderContext $context, Config $config)
 
static getModuleDataSummary (ResourceLoaderContext $context, Config $config)
 
static getPreferences ( $user, &$defaultPreferences)
 GetPreferences hook.
 

Static Private Member Functions

static getEditingStatsId ()
 Gets a 32 character alphanumeric random string to be used for stats.
 
static getMagicWords ()
 Expose useful magic words which are used by the wikieditor toolbar.
 
static getSignatureMessage (MessageLocalizer $ml, $raw=false)
 

Static Private Attributes

static $statsId = false
 

Detailed Description

Definition at line 11 of file WikiEditorHooks.php.

Member Function Documentation

◆ doEventLogging()

static WikiEditorHooks::doEventLogging ( $action,
$article,
$data = [] )
static

Log stuff to EventLogging's Schema:EditAttemptStep - see https://meta.wikimedia.org/wiki/Schema:EditAttemptStep If you don't have EventLogging installed, does nothing.

Parameters
string$action
Article$articleWhich article (with full context, page, title, etc.)
array$dataData to log for this action
Returns
bool Whether the event was logged or not.

Definition at line 28 of file WikiEditorHooks.php.

References $title, and $wgVersion.

Referenced by editPageAttemptSave(), editPageAttemptSaveAfter(), and editPageShowEditFormInitial().

◆ editPageAttemptSave()

static WikiEditorHooks::editPageAttemptSave ( EditPage $editPage)
static

This is attached to the MediaWiki 'EditPage::attemptSave' hook.

Parameters
EditPage$editPage

Definition at line 261 of file WikiEditorHooks.php.

References doEventLogging(), and EditPage\getArticle().

◆ editPageAttemptSaveAfter()

static WikiEditorHooks::editPageAttemptSaveAfter ( EditPage $editPage,
Status $status )
static

This is attached to the MediaWiki 'EditPage::attemptSave:after' hook.

Parameters
EditPage$editPage
Status$status

Definition at line 279 of file WikiEditorHooks.php.

References EditPage\AS_ARTICLE_WAS_DELETED, EditPage\AS_CONFLICT_DETECTED, doEventLogging(), EditPage\getArticle(), Status\getErrorsArray(), and StatusValue\isOK().

◆ EditPageBeforeEditToolbar()

static WikiEditorHooks::EditPageBeforeEditToolbar ( & $toolbar)
static

EditPageBeforeEditToolbar hook.

Disable the old toolbar if the new one is enabled

Parameters
string&$toolbar
Returns
bool

Definition at line 158 of file WikiEditorHooks.php.

◆ editPageShowEditFormFields()

static WikiEditorHooks::editPageShowEditFormFields ( EditPage $editPage,
OutputPage $outputPage )
static

EditPage::showEditForm:fields hook.

Adds the event fields to the edit form

Parameters
EditPage$editPagethe current EditPage object.
OutputPage$outputPageobject.

Definition at line 126 of file WikiEditorHooks.php.

References OutputPage\addHTML(), CONTENT_MODEL_WIKITEXT, getEditingStatsId(), and ContextSource\getRequest().

◆ editPageShowEditFormInitial()

static WikiEditorHooks::editPageShowEditFormInitial ( EditPage $editPage,
OutputPage $outputPage )
static

EditPage::showEditForm:initial hook.

Adds the modules to the edit form

Parameters
EditPage$editPagethe current EditPage object.
OutputPage$outputPageobject.

Definition at line 78 of file WikiEditorHooks.php.

References OutputPage\addModules(), OutputPage\addModuleStyles(), CONTENT_MODEL_WIKITEXT, doEventLogging(), EditPage\getArticle(), and getEditingStatsId().

◆ getEditingStatsId()

static WikiEditorHooks::getEditingStatsId ( )
staticprivate

Gets a 32 character alphanumeric random string to be used for stats.

Returns
string

Definition at line 249 of file WikiEditorHooks.php.

References $statsId, and MWCryptRand\generateHex().

Referenced by editPageShowEditFormFields(), and editPageShowEditFormInitial().

◆ getMagicWords()

static WikiEditorHooks::getMagicWords ( )
staticprivate

Expose useful magic words which are used by the wikieditor toolbar.

Definition at line 220 of file WikiEditorHooks.php.

References $magicWords, and MagicWord\get().

Referenced by getModuleData(), and getModuleDataSummary().

◆ getModuleData()

static WikiEditorHooks::getModuleData ( ResourceLoaderContext $context,
Config $config )
static
Parameters
ResourceLoaderContext$context
Config$config
Returns
array

Definition at line 192 of file WikiEditorHooks.php.

References $context, getMagicWords(), and getSignatureMessage().

◆ getModuleDataSummary()

static WikiEditorHooks::getModuleDataSummary ( ResourceLoaderContext $context,
Config $config )
static
Parameters
ResourceLoaderContext$context
Config$config
Returns
array

Definition at line 205 of file WikiEditorHooks.php.

References $context, getMagicWords(), and getSignatureMessage().

◆ getPreferences()

static WikiEditorHooks::getPreferences ( $user,
& $defaultPreferences )
static

GetPreferences hook.

Adds WikiEditor-related items to the preferences

Parameters
User$usercurrent user
array&$defaultPreferenceslist of default user preference controls

Definition at line 177 of file WikiEditorHooks.php.

◆ getSignatureMessage()

static WikiEditorHooks::getSignatureMessage ( MessageLocalizer $ml,
$raw = false )
staticprivate

Definition at line 212 of file WikiEditorHooks.php.

References MessageLocalizer\msg().

Referenced by getModuleData(), and getModuleDataSummary().

Member Data Documentation

◆ $statsId

WikiEditorHooks::$statsId = false
staticprivate

Definition at line 14 of file WikiEditorHooks.php.

Referenced by getEditingStatsId().

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