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	getPreferences ( $user, &$defaultPreferences)
	GetPreferences hook.
static	resourceLoaderGetConfigVars (&$vars)

Static Private Member Functions
static	getEditingStatsId ()
	Gets a 32 character alphanumeric random string to be used for stats.
static	getMagicWords (&$vars)
	Expose useful magic words which are used by the wikieditor toolbar.

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	$article	Which article (with full context, page, title, etc.)
array	$data	Data to log for this action

Returns

bool Whether the event was logged or not.

Definition at line 28 of file WikiEditorHooks.php.

References $article, $data, $wgVersion, and(), and ExtensionRegistry\getInstance().

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 242 of file WikiEditorHooks.php.

References $article, $request, and doEventLogging().

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 260 of file WikiEditorHooks.php.

References $article, $data, $request, and(), EditPage\AS_ARTICLE_WAS_DELETED, EditPage\AS_CONFLICT_DETECTED, and doEventLogging().

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.

References and().

editPageShowEditFormFields()

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

static

EditPage::showEditForm:fields hook.

Adds the event fields to the edit form

Parameters

EditPage	$editPage	the current EditPage object.
OutputPage	$outputPage	object.

Definition at line 126 of file WikiEditorHooks.php.

References $req, CONTENT_MODEL_WIKITEXT, and getEditingStatsId().

editPageShowEditFormInitial()

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

static

EditPage::showEditForm:initial hook.

Adds the modules to the edit form

Parameters

EditPage	$editPage	the current EditPage object.
OutputPage	$outputPage	object.

Definition at line 78 of file WikiEditorHooks.php.

References $article, $data, $request, CONTENT_MODEL_WIKITEXT, doEventLogging(), getEditingStatsId(), and ExtensionRegistry\getInstance().

getEditingStatsId()

static WikiEditorHooks::getEditingStatsId ( )

staticprivate

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

Returns

string

Definition at line 230 of file WikiEditorHooks.php.

References $statsId, and MWCryptRand\generateHex().

Referenced by editPageShowEditFormFields(), and editPageShowEditFormInitial().

getMagicWords()

static WikiEditorHooks::getMagicWords ( & $vars )

staticprivate

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

Parameters

array

&$vars

Definition at line 201 of file WikiEditorHooks.php.

References $magicWords, $name, $vars, and(), and MagicWord\get().

Referenced by resourceLoaderGetConfigVars().

getPreferences()

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

static

GetPreferences hook.

Adds WikiEditor-related items to the preferences

Parameters

User	$user	current user
array	&$defaultPreferences	list of default user preference controls

Definition at line 177 of file WikiEditorHooks.php.

resourceLoaderGetConfigVars()

static WikiEditorHooks::resourceLoaderGetConfigVars ( & $vars )

static

Parameters

array

&$vars

Definition at line 190 of file WikiEditorHooks.php.

References $vars, getMagicWords(), and wfMessage().

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:

• extensions/WikiEditor/includes/WikiEditorHooks.php