wikimedia/mediawiki-extensions-TemplateData
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/TemplateData synced 2024-11-27 17:20:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use HookHandlers for core hooks

Browse source 
The use of "HookHandlers" attribute in extension.json makes it possible
to inject services into hook handler classes in a future patch.

Bug: T271031
Depends-On: Ic2d188d2c332ab8afeb5454fb5a956c8ba5670ae
Change-Id: Idf4cf94a0e4fae31a5c1f6c3dbf319c0d6913cd7
This commit is contained in:
Umherirrender 2023-08-14 19:41:06 +02:00
parent 2a6708bfa0
commit 8bd3dbc58c
2 changed files with 41 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
extension.json
View file

@ -24,13 +24,18 @@
"MediaWiki\\Extension\\TemplateData\\": "includes/"
},
"Hooks": {
"EditPage::showEditForm:fields": "MediaWiki\\Extension\\TemplateData\\Hooks::onEditPageShowEditFormFields",
"ParserFirstCallInit": "MediaWiki\\Extension\\TemplateData\\Hooks::onParserFirstCallInit",
"MultiContentSave": "MediaWiki\\Extension\\TemplateData\\Hooks::onMultiContentSave",
"ResourceLoaderRegisterModules": "MediaWiki\\Extension\\TemplateData\\Hooks::onResourceLoaderRegisterModules",
"EditPage::showEditForm:initial": "MediaWiki\\Extension\\TemplateData\\Hooks::onEditPage",
"ParserFetchTemplateData": "MediaWiki\\Extension\\TemplateData\\Hooks::onParserFetchTemplateData",
"OutputPageBeforeHTML": "MediaWiki\\Extension\\TemplateData\\Hooks::onOutputPageBeforeHTML"
"EditPage::showEditForm:fields": "main",
"ParserFirstCallInit": "main",
"MultiContentSave": "main",
"ResourceLoaderRegisterModules": "main",
"EditPage::showEditForm:initial": "main",
"ParserFetchTemplateData": "main",
"OutputPageBeforeHTML": "main"
},
"HookHandlers": {
"main": {
"class": "MediaWiki\\Extension\\TemplateData\\Hooks"
}
},
"MessagesDirs": {
"TemplateData": [

39
includes/Hooks.php
View file

@ -1,5 +1,7 @@
<?php
// phpcs:disable MediaWiki.NamingConventions.LowerCamelFunctionsName.FunctionName
namespace MediaWiki\Extension\TemplateData;
use CommentStoreComment;
@ -7,10 +9,17 @@ use ExtensionRegistry;
use Html;
use MediaWiki\EditPage\EditPage;
use MediaWiki\Extension\EventLogging\EventLogging;
use MediaWiki\Hook\EditPage__showEditForm_fieldsHook;
use MediaWiki\Hook\EditPage__showEditForm_initialHook;
use MediaWiki\Hook\OutputPageBeforeHTMLHook;
use MediaWiki\Hook\ParserFetchTemplateDataHook;
use MediaWiki\Hook\ParserFirstCallInitHook;
use MediaWiki\MediaWikiServices;
use MediaWiki\ResourceLoader\Hook\ResourceLoaderRegisterModulesHook;
use MediaWiki\Revision\RenderedRevision;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Revision\SlotRecord;
use MediaWiki\Storage\Hook\MultiContentSaveHook;
use MediaWiki\User\UserIdentity;
use OutputPage;
use Parser;
@ -27,13 +36,21 @@ use Title;
* @ingroup Extensions
*/
class Hooks {
class Hooks implements
EditPage__showEditForm_fieldsHook,
ParserFirstCallInitHook,
MultiContentSaveHook,
ResourceLoaderRegisterModulesHook,
EditPage__showEditForm_initialHook,
ParserFetchTemplateDataHook,
OutputPageBeforeHTMLHook
{
/**
* @param EditPage $editPage
* @param OutputPage $out
*/
public static function onEditPageShowEditFormFields( EditPage $editPage, OutputPage $out ) {
public function onEditPage__showEditForm_fields( $editPage, $out ) {
// TODO: Remove when not needed any more, see T267926
if ( $out->getRequest()->getBool( 'TemplateDataGeneratorUsed' ) ) {
// Recreate the dynamically created field after the user clicked "preview"
@ -45,7 +62,7 @@ class Hooks {
* Register parser hooks
* @param Parser $parser
*/
public static function onParserFirstCallInit( Parser $parser ) {
public function onParserFirstCallInit( $parser ) {
$parser->setHook( 'templatedata', [ __CLASS__, 'render' ] );
}
@ -53,9 +70,9 @@ class Hooks {
* Conditionally register the jquery.uls.data module, in case they've already been
* registered by the UniversalLanguageSelector extension or the VisualEditor extension.
*
* @param ResourceLoader &$resourceLoader
* @param ResourceLoader $resourceLoader
*/
public static function onResourceLoaderRegisterModules( ResourceLoader &$resourceLoader ) {
public function onResourceLoaderRegisterModules( ResourceLoader $resourceLoader ): void {
$resourceModules = $resourceLoader->getConfig()->get( 'ResourceModules' );
$name = 'jquery.uls.data';
if ( !isset( $resourceModules[$name] ) && !$resourceLoader->isModuleRegistered( $name ) ) {
@ -81,8 +98,8 @@ class Hooks {
* @param Status $hookStatus
* @return bool
*/
public static function onMultiContentSave(
RenderedRevision $renderedRevision, UserIdentity $user, CommentStoreComment $summary, $flags, Status $hookStatus
public function onMultiContentSave(
$renderedRevision, $user, $summary, $flags, $hookStatus
) {
$revisionRecord = $renderedRevision->getRevision();
$contentModel = $revisionRecord
@ -163,7 +180,7 @@ class Hooks {
* @param EditPage $editPage
* @param OutputPage $output
*/
public static function onEditPage( EditPage $editPage, OutputPage $output ) {
public function onEditPage__showEditForm_initial( $editPage, $output ) {
global $wgTemplateDataUseGUI;
if ( $wgTemplateDataUseGUI ) {
if ( $output->getTitle()->inNamespace( NS_TEMPLATE ) ) {
@ -234,7 +251,7 @@ class Hooks {
* @param OutputPage $output
* @param string &$text
*/
public static function onOutputPageBeforeHTML( $output, &$text ) {
public function onOutputPageBeforeHTML( $output, &$text ) {
$services = MediaWikiServices::getInstance();
$props = $services->getPageProps()->getProperties( $output->getTitle(), 'templatedata' );
if ( !empty( $props ) ) {
@ -260,8 +277,9 @@ class Hooks {
*
* @param array $tplTitles
* @param \stdClass[] &$tplData
* @return bool
*/
public static function onParserFetchTemplateData( array $tplTitles, array &$tplData ): void {
public function onParserFetchTemplateData( array $tplTitles, array &$tplData ): bool {
$tplData = [];
$pageProps = MediaWikiServices::getInstance()->getPageProps();
@ -318,6 +336,7 @@ class Hooks {
$tplData[$tplTitle] = $tdb->getData();
}
return true;
}
}