gplx/mediawiki/extensions/SemanticMediaWiki/tests/phpunit/Utils/MwHooksHandler.php

<?php

namespace SMW\Tests\Utils;

use MediaWiki\MediaWikiServices;
use RuntimeException;
use SMW\MediaWiki\Hooks;

/**
 * @license GPL-2.0-or-later
 * @since   1.9
 *
 * @author mwjames
 */
class MwHooksHandler {

	/**
	 * @var HookRegistry
	 */
	private $hookRegistry = null;
	private $hookContainer = null;

	private $wgHooks = [];
	private $inTestRegisteredHooks = [];

	private $listOfSmwHooks = [
		'SMWStore::updateDataBefore',
		'SMW::Store::BeforeDataUpdateComplete',
		'SMWStore::updateDataAfter',
		'SMW::Store::AfterDataUpdateComplete',

		// Those shoudl not be disabled so that extension used
		// by a test will run the registration in case an instance
		// is cleared
		//	'smwInitDatatypes',
		//	'SMW::DataType::initTypes',

		'SMW::Settings::BeforeInitializationComplete',
		'SMW::Setup::AfterInitializationComplete',
		'SMW::GroupPermissions::BeforeInitializationComplete',

		'smwInitProperties',
		'SMW::Property::initProperties',
		'SMW::Constraint::initConstraints',
		'SMW::Factbox::BeforeContentGeneration',
		'SMW::SQLStore::updatePropertyTableDefinitions',
		'SMW::Store::BeforeQueryResultLookupComplete',
		'SMW::Store::AfterQueryResultLookupComplete',
		'SMW::SQLStore::BeforeChangeTitleComplete',
		'SMW::SQLStore::BeforeDeleteSubjectComplete',
		'SMW::SQLStore::AfterDeleteSubjectComplete',
		'SMW::Parser::BeforeMagicWordsFinder',
		'SMW::SQLStore::BeforeDataRebuildJobInsert',
		'SMW::SQLStore::AddCustomFixedPropertyTables',
		'SMW::SQLStore::AfterDataUpdateComplete',
		'SMW::Browse::AfterIncomingPropertiesLookupComplete',
		'SMW::Browse::BeforeIncomingPropertyValuesFurtherLinkCreate',

		'SMW::Listener::ChangeListener::RegisterPropertyChangeListeners',
		'SMW::Admin::RegisterTaskHandlers',
		'SMW::Schema::RegisterSchemaTypes',

		'SMW::GetPreferences',
		'SMW::Parser::AfterLinksProcessingComplete',
		'SMW::Parser::ParserAfterTidyPropertyAnnotationComplete',

		'SMW::Maintenance::AfterUpdateEntityCollationComplete',

		'SMW::Indicator::EntityExaminer::RegisterIndicatorProviders',
		'SMW::Indicator::EntityExaminer::RegisterDeferrableIndicatorProviders',

		'SMW::RevisionGuard::IsApprovedRevision',
		'SMW::RevisionGuard::ChangeRevisionID',
		'SMW::RevisionGuard::ChangeFile',
		'SMW::RevisionGuard::ChangeRevision',

		'SMWSQLStore3::updateDataBefore',
		'SMW::SQLStore::BeforeDataUpdateComplete',

		'SMW::SQLStore::Installer::BeforeCreateTablesComplete',
		'SMW::SQLStore::Installer::AfterCreateTablesComplete',
		'SMW::SQLStore::Installer::AfterDropTablesComplete'
	];

	public function __construct() {
		$this->hookContainer = MediaWikiServices::getInstance()->getHookContainer();
	}

	/**
	 * @since  2.0
	 *
	 * @return MwHooksHandler
	 */
	public function deregisterListedHooks() {
		$listOfHooks = array_merge(
			$this->listOfSmwHooks,
			$this->getHookRegistry()->getHandlerList()
		);

		foreach ( $listOfHooks as $hook ) {
			if ( $this->hookContainer->isRegistered( $hook ) ) {
				$this->hookContainer->clear( $hook );
			}
		}

		return $this;
	}

	/**
	 * @since  2.0
	 *
	 * @return MwHooksHandler
	 */
	public function restoreListedHooks() {
		foreach ( $this->inTestRegisteredHooks as $hook ) {
			$this->hookContainer->clear( $hook );
		}

		foreach ( $this->wgHooks as $hook => $definition ) {
			$this->hookContainer->register( $hook, $definition );
			unset( $this->wgHooks[$hook] );
		}

		return $this;
	}

	/**
	 * @since  2.1
	 *
	 * @return MwHooksHandler
	 */
	public function register( $name, callable $callback ) {
		$listOfHooks = array_merge(
			$this->listOfSmwHooks,
			$this->getHookRegistry()->getHandlerList()
		);

		if ( !in_array( $name, $listOfHooks ) ) {
			throw new RuntimeException( "$name is not listed as registrable hook" );
		}

		$this->inTestRegisteredHooks[] = $name;
		$this->hookContainer->register( $name, $callback );

		return $this;
	}

	public function invokeHooksFromRegistry() {
		$this->getHookRegistry()->register();
		return $this;
	}

	/**
	 * @since  2.1
	 *
	 * @return Hooks
	 */
	public function getHookRegistry(): Hooks {
		if ( $this->hookRegistry === null ) {
			 $this->hookRegistry = new Hooks();
		}

		return $this->hookRegistry;
	}

}