SRFUtils

Complexity

Total Complexity

5

Size/Duplication

Total Lines	79
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

73.91%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	addGlobalJSVariables()	0	9	1
A	htmlQueryResultLink()	0	12	2
A	htmlProcessingElement()	0	13	1
A	makeVariablesScript()	0	5	1

<?php

/**
 * Common libray of independent functions that are shared among different printers
 * @licence GNU GPL v2 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 boolean $isHtml
	 *
	 * @since 1.8
	 */
	public static function htmlProcessingElement( $isHtml = true ) {

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

		SMWOutputs::requireResource( 'ext.srf' );

		return Html::rawElement(
			'div',
			[ 'class' => 'srf-spinner mw-small-spinner' ],
			Html::element(
				'span',
				[ 'class' => 'srf-processing-text' ],
				wfMessage( 'srf-module-loading' )->inContentLanguage()->text()
			)
		);
	}

	/**
	 * 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, false ) );
	}

	/**
	 * @brief 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

The doc-type $link could not be parsed: Unknown type name "$link" at position 0. (view supported doc-types)

	 */
	public static function htmlQueryResultLink( $link ) {
		// Get linker instance
		$linker = class_exists( 'DummyLinker' ) ? new DummyLinker : new Linker;

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

The method setCaption cannot be called on $link (of type string).

		// Set parameters
		$link->setParameter( '' , 'class' );

The method setParameter cannot be called on $link (of type string).

		$link->setParameter( '' , 'searchlabel' );

The method setParameter cannot be called on $link (of type string).

		return $link->getText( SMW_OUTPUT_HTML, $linker );

The method getText cannot be called on $link (of type string).

	}

	/**
	 * @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 );

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

}