wikimedia/mediawiki-extensions-Wikibase

<?php

namespace Wikibase\Client\Hooks;

use MediaWiki\Output\OutputPage;
use MediaWiki\Parser\ParserOutput;
use MediaWiki\Title\Title;
use Wikibase\DataModel\SiteLink;

/**
 * Provides access to the badges of the current page's sitelinks
 * and adds some properties to the HTML output to display them.
 *
 * @license GPL-2.0-or-later
 * @author Bene* < benestar.wikimedia@gmail.com >
 * @author Daniel Kinzler
 */
class LanguageLinkBadgeDisplay {

    /**
     * @var SidebarLinkBadgeDisplay
     */
    protected $sidebarLinkBadgeDisplay;

    public function __construct( SidebarLinkBadgeDisplay $sidebarLinkBadgeDisplay ) {
        $this->sidebarLinkBadgeDisplay = $sidebarLinkBadgeDisplay;
    }

    /**
     * Attaches info about link badges in the given OutputPage, for later retrieval
     * and processing by applyBadges().
     *
     * This is typically called in the context of parsing a wiki page.
     *
     * @param SiteLink[] $langLinks Site links indexed by local interwiki prefix.
     * @param ParserOutput $parserOutput The output page to set the wikibase_badges property on.
     */
    public function attachBadgesToOutput( array $langLinks, ParserOutput $parserOutput ) {
        $badgeInfoForAllLinks = [];

        foreach ( $langLinks as $key => $link ) {
            $badges = $link->getBadges();

            if ( $badges ) {
                $badgeInfoForAllLinks[$key] = $this->sidebarLinkBadgeDisplay->getBadgeInfo(
                    $badges
                );
            }
        }

        $parserOutput->setExtensionData( 'wikibase_badges', $badgeInfoForAllLinks );
    }

    /**
     * Applies the badges described in the wikibase_badges property of $output to
     * the language link to $languageLinkTitle. The badge info for this linked is
     * looked up in the wikibase_badges data using the key returned by
     * $languageLinkTitle->getInterwiki().
     *
     * This is generally called in the context of generating skin output.
     *
     * @param array &$languageLink
     * @param Title $languageLinkTitle
     * @param OutputPage $outputPage The output page to take the wikibase_badges property from.
     */
    public function applyBadges( array &$languageLink, Title $languageLinkTitle, OutputPage $outputPage ) {
        $badges = $outputPage->getProperty( 'wikibase_badges' );

        if ( !$badges ) {
            return;
        }

        $navId = $languageLinkTitle->getInterwiki();
        if ( !isset( $badges[$navId] ) ) {
            return;
        }

        $this->sidebarLinkBadgeDisplay->applyBadgeToLink( $languageLink, $badges[$navId] );
    }

}