mediawiki-extensions-ReplaceText/src/HookHelper.php

<?php
declare( strict_types = 1 );

namespace MediaWiki\Extension\ReplaceText;

use MediaWiki\Extension\ReplaceText\Hooks\HookRunner;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\Title\Title;
use MediaWiki\Title\TitleArrayFromResult;
use Wikimedia\Rdbms\IResultWrapper;

class HookHelper {
	private HookRunner $hookRunner;

	/**
	 * Constructor.
	 * @param HookContainer $hookContainer
	 */
	public function __construct( HookContainer $hookContainer ) {
		$this->hookRunner = new HookRunner( $hookContainer );
	}

	/**
	 * Runs the ReplaceTextFilterPageTitlesForEdit hook and returns titles to be edited
	 * @param IResultWrapper $resultWrapper
	 * @return Title[]
	 */
	public function filterPageTitlesForEdit( IResultWrapper $resultWrapper ): array {
		$titles = new TitleArrayFromResult( $resultWrapper );
		$filteredTitles = iterator_to_array( $titles );
		$this->hookRunner->onReplaceTextFilterPageTitlesForEdit( $filteredTitles );

		return $this->normalizeTitlesToProcess( $filteredTitles, $titles );
	}

	/**
	 * Runs the ReplaceTextFilterPageTitlesForRename hook and returns titles to be edited
	 * @param IResultWrapper $resultWrapper
	 * @return Title[]
	 */
	public function filterPageTitlesForRename( IResultWrapper $resultWrapper ): array {
		$titles = new TitleArrayFromResult( $resultWrapper );
		$filteredTitles = iterator_to_array( $titles );
		$this->hookRunner->onReplaceTextFilterPageTitlesForRename( $filteredTitles );

		return $this->normalizeTitlesToProcess( $filteredTitles, $titles );
	}

	private function normalizeTitlesToProcess( array $filteredTitles, TitleArrayFromResult $titles ): array {
		foreach ( $filteredTitles as $title ) {
			$filteredTitles[ $title->getPrefixedText() ] = $title;
		}

		$titlesToEdit = [];
		foreach ( $titles as $title ) {
			if ( isset( $filteredTitles[ $title->getPrefixedText() ] ) ) {
				$titlesToEdit[ $title->getPrefixedText() ] = $title;
			} else {
				$titlesToEdit[ $title->getPrefixedText() ] = null;
			}
		}

		return $titlesToEdit;
	}
}