mediawiki-extensions-Cite/src/ResourceLoader/CiteVisualEditorModule.php

<?php

namespace Cite\ResourceLoader;

use MediaWiki\ResourceLoader as RL;

/**
 * File module with extra data generated by the server.
 *
 * Temporary hack since 2015 for T93800.
 *
 * @copyright 2011-2018 VisualEditor Team's Cite sub-team and others; see AUTHORS.txt
 * @license MIT
 */
class CiteVisualEditorModule extends RL\FileModule {

	/** @inheritDoc */
	public function getScript( RL\Context $context ) {
		return $this->makePrependedScript( $context ) . parent::getScript( $context );
	}

	/** @inheritDoc */
	public function supportsURLLoading() {
		// URL loading (in legacy debug mode) doesn't work correctly because of the prepended script (T309697)
		return false;
	}

	/**
	 * @internal
	 * @param RL\Context $context
	 * @return string JavaScript code
	 */
	public function makePrependedScript( RL\Context $context ) {
		$citationDefinition = json_decode(
			$context->msg( 'cite-tool-definition.json' )
				->inContentLanguage()
				->plain()
		);

		if ( $citationDefinition === null ) {
			$citationDefinition = json_decode(
				$context->msg( 'visualeditor-cite-tool-definition.json' )
					->inContentLanguage()
					->plain()
			);
		}

		$citationTools = [];
		if ( is_array( $citationDefinition ) ) {
			foreach ( $citationDefinition as $tool ) {
				if ( !isset( $tool->title ) ) {
					$tool->title = $context->msg( 'visualeditor-cite-tool-name-' . $tool->name )
						->text();
				}
				$citationTools[] = $tool;
			}
		}

		// TODO: When this custom module is converted to adopt packageFiles, this data
		// can be exported via a callback as a virtual "tools.json" file. Then the JS
		// in MWReference.init.js can do `ve.ui.mwCitationTools = require( "./tools.json" )`

		// Limit and expose
		$limit = 5;
		$citationTools = array_slice( $citationTools, 0, $limit );
		return 've.ui.mwCitationTools = ' . $context->encodeJson( $citationTools ) . ';';
	}

	/** @inheritDoc */
	public function getDefinitionSummary( RL\Context $context ) {
		$summary = parent::getDefinitionSummary( $context );
		$summary[] = [
			'script' => $this->makePrependedScript( $context ),
		];
		return $summary;
	}

}