SemanticResultFormats.utils.php

<?php

/**
 * Common libray of independent functions that are shared among different printers
 * @license GPL-2.0-or-later
 *
 * @since 1.8
 *
 * @author mwjames
 */
final class SRFUtils {

	/**
	 * Helper function that generates a html element, representing a
	 * processing/loading image as long as jquery is inactive
	 *
	 * @param bool $isHtml
	 *
	 * @since 1.8
	 */
	public static function htmlProcessingElement( $isHtml = true ) {
		SMWOutputs::requireResource( 'ext.smw.styles' );

		return Html::rawElement(
			'div',
			[ 'class' => 'srf-loading-dots' ]
		);
	}

	/**
	 * Add JavaScript variables to the output
	 *
	 * @since 1.8
	 */
	public static function addGlobalJSVariables() {
		$options = [
			'srfgScriptPath' => $GLOBALS['srfgScriptPath'],
			'srfVersion' => SRF_VERSION
		];

		$requireHeadItem = [ 'srf.options' => $options ];
		SMWOutputs::requireHeadItem( 'srf.options', self::makeVariablesScript( $requireHeadItem ) );
	}

	/**
	 * Returns semantic search link for the current query
	 *
	 * Generate a link to access the current ask query
	 *
	 * @since 1.8
	 *
	 * @param string $link
	 *
	 * @return $link
	 */
	public static function htmlQueryResultLink( $link ) {
		// Get linker instance
		$linker = class_exists( 'DummyLinker' ) ? new DummyLinker : new Linker;

		// Set caption
		$link->setCaption( '[+]' );

		// Set parameters
		$link->setParameter( '', 'class' );
		$link->setParameter( '', 'searchlabel' );
		return $link->getText( SMW_OUTPUT_HTML, $linker );
	}

	/**
	 * @since 3.2.0
	 *
	 * @param array $data
	 *
	 * @param string|null|bool $nonce
	 *
	 * @return string|WrappedString HTML
	 */
	public static function makeVariablesScript( $data, $nonce = null ) {
		$script = ResourceLoader::makeConfigSetScript( $data );
		if ( $nonce === null ) {
			$nonce = RequestContext::getMain()->getOutput()->getCSP()->getNonce();
		}

		return ResourceLoader::makeInlineScript( $script, $nonce );
	}

}