wikimedia/mediawiki-extensions-VisualEditor
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor synced 2024-11-30 17:14:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

ParsoidHelper: Make VisualEditorParsoidClientFactory required

Browse source 
In order to make this interface cleaner and not promote the
use of optional parameters when not needed, make the factory
required so that callers should worry about it and not overwork
the helper.

In this case, DiscussionTools extension is already using this
interface and has the factory injected appropriately.

Depends-On: If682af406c0fc7a9eca106eb3ebd95e6c14baddd
Change-Id: I836c0ad73687d8b99d1e067a5c3a3e512b4bd37a
This commit is contained in:
Derick Alangi 2022-09-06 21:16:21 +01:00
parent 8c458e78b4
commit 8bfe88b8b1
1 changed files with 3 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
includes/ParsoidHelper.php
View file

@ -13,7 +13,6 @@
namespace MediaWiki\Extension\VisualEditor; namespace MediaWiki\Extension\VisualEditor;
use Language; use Language;
use MediaWiki\MediaWikiServices;
use MediaWiki\Revision\RevisionRecord; use MediaWiki\Revision\RevisionRecord;
use Psr\Log\LoggerInterface; use Psr\Log\LoggerInterface;
use StatusValue; use StatusValue;
@ -33,20 +32,16 @@ class ParsoidHelper {
/** /**
* @param LoggerInterface $logger * @param LoggerInterface $logger
* @param string|false $forwardCookies * @param string|false $forwardCookies
* @param VisualEditorParsoidClientFactory|null $clientFactory * @param VisualEditorParsoidClientFactory $clientFactory
*/ */
public function __construct( public function __construct(
LoggerInterface $logger, LoggerInterface $logger,
$forwardCookies, $forwardCookies,
?VisualEditorParsoidClientFactory $clientFactory = null VisualEditorParsoidClientFactory $clientFactory
) { ) {
$this->logger = $logger; $this->logger = $logger;
$this->forwardCookies = $forwardCookies; $this->forwardCookies = $forwardCookies;
// XXX: Extension:DiscussionTools is already instantiating this helper, so, we $this->veParsoidClientFactory = $clientFactory;
// need to carter for backwards compatibility, so just fall back to creating
// from service locator.
$this->veParsoidClientFactory = $clientFactory ?? MediaWikiServices::getInstance()
->getService( VisualEditorParsoidClientFactory::SERVICE_NAME );
} }
/** /**