wikimedia/mediawiki-extensions-Wikibase

<?php

namespace Wikibase\Lib\Formatters;

use DataValues\Geo\Values\GlobeCoordinateValue;
use InvalidArgumentException;
use MediaWiki\Html\Html;
use MediaWiki\Languages\LanguageFactory;
use ValueFormatters\FormatterOptions;
use ValueFormatters\ValueFormatter;

/**
 * Formatter for rendering GlobeCoordinateValue via the Kartographer extensions.
 *
 * @license GPL-2.0-or-later
 * @author Marius Hoch
 */
class GlobeCoordinateKartographerFormatter implements ValueFormatter {

    /**
     * @var ValueFormatter
     */
    private $coordinateFormatter;

    /**
     * @var CachingKartographerEmbeddingHandler
     */
    private $cachingKartographerEmbeddingHandler;

    /**
     * @var bool
     */
    private $emitPreviewHtml;

    /**
     * @var FormatterOptions
     */
    private $options;

    /**
     * @var LanguageFactory
     */
    private $languageFactory;

    /**
     * @param FormatterOptions|null $options
     * @param ValueFormatter $coordinateFormatter
     * @param CachingKartographerEmbeddingHandler $cachingKartographerEmbeddingHandler
     * @param LanguageFactory $languageFactory
     * @param bool $emitPreviewHtml Whether to emit HTML that can be used for live previews
     */
    public function __construct(
        ?FormatterOptions $options,
        ValueFormatter $coordinateFormatter,
        CachingKartographerEmbeddingHandler $cachingKartographerEmbeddingHandler,
        LanguageFactory $languageFactory,
        $emitPreviewHtml
    ) {
        $this->options = $options ?: new FormatterOptions();
        $this->options->defaultOption( ValueFormatter::OPT_LANG, 'en' );

        $this->coordinateFormatter = $coordinateFormatter;
        $this->cachingKartographerEmbeddingHandler = $cachingKartographerEmbeddingHandler;
        $this->languageFactory = $languageFactory;
        $this->emitPreviewHtml = $emitPreviewHtml;
    }

    /**
     * @see ValueFormatter::format
     *
     * Generates HTML representing the details of a GlobeCoordinateValue,
     * as an itemized list.
     *
     * @param GlobeCoordinateValue $value
     *
     * @throws InvalidArgumentException
     * @return string HTML
     */
    public function format( $value ) {
        if ( !( $value instanceof GlobeCoordinateValue ) ) {
            throw new InvalidArgumentException( 'Data value type mismatch. Expected a GlobeCoordinateValue.' );
        }

        $html = '';

        $lang = $this->languageFactory->getLanguage( $this->options->getOption( ValueFormatter::OPT_LANG ) );

        if ( !$this->emitPreviewHtml ) {
            $kartographerHtml = $this->cachingKartographerEmbeddingHandler->getHtml( $value, $lang );
        } else {
            $kartographerHtml = $this->cachingKartographerEmbeddingHandler->getPreviewHtml( $value, $lang );
        }
        if ( $kartographerHtml !== false ) {
            $html = $kartographerHtml;
        }

        $html .= Html::rawElement(
            'div',
            [ 'class' => 'wikibase-kartographer-caption' ],
            $this->coordinateFormatter->format( $value )
        );

        return "<div>$html</div>";
    }

}