SemanticMediaWiki / SemanticImageCaption

src/Hooks.php

<?php

namespace SMW\ImageCaption;

use SMW\ApplicationFactory;
use SMW\Schema\SchemaTypes;

/**
 * @license GNU GPL v2+
 * @since 1.0
 *
 * @author mwjames
 */
class Hooks {

	/**
	 * @since  1.0
	 */
	public function register() {

		if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
			return;
		}

		$handlers = [
			'SMW::Schema::RegisterSchemaTypes' => [ $this, 'onRegisterSchemaTypes' ],
			'ImageBeforeProduceHTML' => [ $this, 'onImageBeforeProduceHTML' ]
		];

		foreach ( $handlers as $name => $callback ) {

			if (
				!class_exists( '\MediaWiki\MediaWikiServices' ) ||
				!method_exists( \MediaWiki\MediaWikiServices::getInstance(), 'getHookContainer' ) ) {
				\Hooks::register( $name, $callback );
			} else {
				\MediaWiki\MediaWikiServices::getInstance()->getHookContainer()->register( $name, $callback );
			}
		}
	}

	/**
	 * @see https://www.semantic-mediawiki.org/wiki/Hooks#SMW::Schema::RegisterSchemaTypes
	 *
	 * @since 1.0
	 *
	 * @param SchemaTypes $schemaTypes
	 */
	public static function onRegisterSchemaTypes( SchemaTypes $schemaTypes ) {

		$params = [
			'group' => 'schema/group/imagecaption',
			'validation_schema' => __DIR__ . '/../data/schema/imagecaption-rule-schema.v1.json',
			'type_description' => 'semantic-imagecaption-rule-schema-description'
		];

		$schemaTypes->registerSchemaType( ImageCaption::SCHEMA_TYPE, $params );

		return true;
	}

	/**
	 * Hook: Called before producing the HTML created by a wiki image insertion
	 *
	 * @see https://www.mediawiki.org/wiki/Manual:Hooks/ImageBeforeProduceHTML
	 *
	 * @param DummyLinker &$linker
	 * @param Title &$title
	 * @param &$file
	 * @param array &$frameParams
	 * @param array &$handlerParams
	 * @param &$time
	 * @param &$res
	 * @param Parser $parser
	 * @param string &$query
	 * @param &$widthOption
	 *
	 * @return bool
	 */
	public static function onImageBeforeProduceHTML( &$dummy, &$title, &$file, &$frameParams, &$handlerParams, &$time, &$res, $parser, &$query, &$widthOption ) {

The parameter $query is not used and could be removed.

The parameter $widthOption is not used and could be removed.

		$applicationFactory = ApplicationFactory::getInstance();
		$schemaFactory = $applicationFactory->singleton( 'SchemaFactory' );

		$ruleFinder = new RuleFinder(
			$schemaFactory->newSchemaFinder(),
			$schemaFactory->newSchemaFilterFactory()
		);

		$imageCaption = new ImageCaption(
			$applicationFactory->getStore(),
			$ruleFinder
		);

		$target = $parser->getTitle();
		$languageCode = $parser->getOptions()->getUserLang();

		$imageCaption->modifyCaption( $target, $file, $frameParams['caption'], $languageCode );

		return true;
	}

}