mediawiki-extensions-Visual.../includes/VisualEditorHookRunner.php
Umherirrender 4e94b88f99 Remove the VisualEditorHookRunner service
The HookRunner class is a lightweight class and not designed to be a
service, the needed HookContainer should be injected instead and a hook
runner created when needed.
The overhead from the service wiring is the same as using new objects
when needed.
This follows practice from core and the documentation in
core/docs/Hooks.md in the section "Hook runner classes"

Change-Id: Ib42281dfae8a5a260005d82ed3bb7da12e1b645e
2024-01-31 20:02:36 +01:00

87 lines
1.8 KiB
PHP

<?php
namespace MediaWiki\Extension\VisualEditor;
/**
* VisualEditorHookRunner
*
* @file
* @ingroup Extensions
* @copyright 2011-2021 VisualEditor Team and others; see AUTHORS.txt
* @license MIT
*/
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\Page\ProperPageIdentity;
use MediaWiki\User\UserIdentity;
use OutputPage;
use Skin;
class VisualEditorHookRunner implements
VisualEditorApiVisualEditorEditPreSaveHook,
VisualEditorApiVisualEditorEditPostSaveHook,
VisualEditorBeforeEditorHook
{
/** @var HookContainer */
private $hookContainer;
/**
* @param HookContainer $hookContainer
*/
public function __construct( HookContainer $hookContainer ) {
$this->hookContainer = $hookContainer;
}
/** @inheritDoc */
public function onVisualEditorApiVisualEditorEditPreSave(
ProperPageIdentity $page,
UserIdentity $user,
string $wikitext,
array &$params,
array $pluginData,
array &$apiResponse
) {
return $this->hookContainer->run( 'VisualEditorApiVisualEditorEditPreSave', [
$page,
$user,
$wikitext,
&$params,
$pluginData,
&$apiResponse
], [ 'abortable' => true ] );
}
/** @inheritDoc */
public function onVisualEditorApiVisualEditorEditPostSave(
ProperPageIdentity $page,
UserIdentity $user,
string $wikitext,
array $params,
array $pluginData,
array $saveResult,
array &$apiResponse
): void {
$this->hookContainer->run( 'VisualEditorApiVisualEditorEditPostSave', [
$page,
$user,
$wikitext,
$params,
$pluginData,
$saveResult,
&$apiResponse
], [ 'abortable' => false ] );
}
/** @inheritDoc */
public function onVisualEditorBeforeEditor(
OutputPage $output,
Skin $skin
): bool {
return $this->hookContainer->run( 'VisualEditorBeforeEditor', [
$output,
$skin
], [ 'abortable' => true ] );
}
}