wiki.techinc.nl/includes/preferences/SignatureValidatorFactory.php
Tim Starling f270881ca2 Deprecate Parser::getFreshParser()
Following up on the comment I made at Ibbc1423166f4804a5122, make Parser
instance management a ParserFactory responsibility. It is weird for
Parser to have a ParserFactory proxy aspect.

* Add ParserFactory::getMainInstance(), which is equivalent to the old
  MediaWikiServices::getParser() and $wgParser.
* Add ParserFactory::getInstance(), which is equivalent to
  $wgParser->getFreshInstance(), returning the main instance if it is
  free, or a new instance otherwise. The naming is supposed to encourage
  it as the default way to get a parser, which will help with the linked
  bug.
* Deprecate Parser::getFreshParser() and migrate all core callers.

I left the entry in ServiceWiring.php so that it's not immediately
necessary to migrate ObjectFactory specs that ask for Parser.

Bug: T310948
Change-Id: I762b191e978c2d1bbc9f332c9cfa047888ce2e67
2022-07-05 14:09:36 +10:00

90 lines
2.6 KiB
PHP

<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @author Derick Alangi
*/
namespace MediaWiki\Preferences;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\SpecialPage\SpecialPageFactory;
use MediaWiki\User\UserIdentity;
use MessageLocalizer;
use ParserOptions;
use TitleFactory;
/**
* @since 1.38
*/
class SignatureValidatorFactory {
/** @var ServiceOptions */
private $serviceOptions;
/** @var callable */
private $parserFactoryClosure;
/** @var SpecialPageFactory */
private $specialPageFactory;
/** @var TitleFactory */
private $titleFactory;
/**
* @param ServiceOptions $options
* @param callable $parserFactoryClosure A function which returns a ParserFactory.
* We use this instead of an actual ParserFactory to avoid a circular dependency,
* since Parser also needs a SignatureValidatorFactory for signature formatting.
* @param SpecialPageFactory $specialPageFactory
* @param TitleFactory $titleFactory
*/
public function __construct(
ServiceOptions $options,
callable $parserFactoryClosure,
SpecialPageFactory $specialPageFactory,
TitleFactory $titleFactory
) {
// Configuration
$this->serviceOptions = $options;
$this->serviceOptions->assertRequiredOptions( SignatureValidator::CONSTRUCTOR_OPTIONS );
$this->parserFactoryClosure = $parserFactoryClosure;
$this->specialPageFactory = $specialPageFactory;
$this->titleFactory = $titleFactory;
}
/**
* @param UserIdentity $user
* @param MessageLocalizer|null $localizer
* @param ParserOptions $popts
* @return SignatureValidator
*/
public function newSignatureValidator(
UserIdentity $user,
?MessageLocalizer $localizer,
ParserOptions $popts
): SignatureValidator {
return new SignatureValidator(
$this->serviceOptions,
$user,
$localizer,
$popts,
( $this->parserFactoryClosure )(),
$this->specialPageFactory,
$this->titleFactory
);
}
}