wikimedia/mediawiki-extensions-Wikibase

<?php

namespace Wikibase\View;

use Wikibase\DataModel\Entity\EntityId;
use Wikibase\DataModel\Entity\PropertyId;
use Wikibase\DataModel\Statement\Statement;
use Wikibase\View\Template\TemplateFactory;

/**
 * Generates HTML for a section edit link
 *
 * @license GPL-2.0-or-later
 */
class ToolbarEditSectionGenerator implements EditSectionGenerator {

    /**
     * @var SpecialPageLinker
     */
    private $specialPageLinker;

    /**
     * @var TemplateFactory
     */
    private $templateFactory;

    /**
     * @var LocalizedTextProvider
     */
    private $textProvider;

    public function __construct(
        SpecialPageLinker $specialPageLinker,
        TemplateFactory $templateFactory,
        LocalizedTextProvider $textProvider
    ) {
        $this->templateFactory = $templateFactory;
        $this->specialPageLinker = $specialPageLinker;
        $this->textProvider = $textProvider;
    }

    /**
     * @param string $text
     * @param bool $isEditable
     *
     * @return string
     */
    public static function enableSectionEditLinks( $text, $isEditable ) {
        if ( $isEditable ) {
            return str_replace( [ '<wb:sectionedit>', '</wb:sectionedit>' ], '', $text );
        } else {
            return preg_replace( '#<wb:sectionedit>.*?</wb:sectionedit>#s', '', $text );
        }
    }

    public function getSiteLinksEditSection( EntityId $entityId = null ) {
        $specialPageUrlParams = [];

        if ( $entityId !== null ) {
            $specialPageUrlParams[] = $entityId->getSerialization();
        }

        return $this->getHtmlForEditSection( 'SetSiteLink', $specialPageUrlParams );
    }

    /**
     * Returns HTML allowing to edit the section containing label, description and aliases.
     *
     * @param string $languageCode
     * @param EntityId|null $entityId
     *
     * @return string
     */
    public function getLabelDescriptionAliasesEditSection( $languageCode, EntityId $entityId = null ) {
        $specialPageUrlParams = [];

        if ( $entityId !== null ) {
            $specialPageUrlParams[] = $entityId->getSerialization();
            $specialPageUrlParams[] = $languageCode;
        }
        return $this->getHtmlForEditSection( EntityTermsView::TERMS_EDIT_SPECIAL_PAGE, $specialPageUrlParams );
    }

    /**
     * Returns a toolbar with an edit link. In JavaScript, an enhanced toolbar will be initialized
     * on top of the generated HTML.
     *
     * @param string $specialPageName the special page for the button
     * @param string[] $specialPageUrlParams Additional URL params for the special page
     *
     * @return string
     */
    private function getHtmlForEditSection(
        $specialPageName,
        array $specialPageUrlParams
    ) {
        $editUrl = $this->getEditUrl( $specialPageName, $specialPageUrlParams );
        $toolbarButton = $this->getToolbarButton( 'edit', $this->textProvider->get( 'wikibase-edit' ), $editUrl );

        return $this->getToolbarContainer(
            $this->templateFactory->render( 'wikibase-toolbar', '', $toolbarButton )
        );
    }

    private function getToolbarContainer( $content ) {
        return '<wb:sectionedit>'
            . $this->templateFactory->render( 'wikibase-toolbar-container', $content )
            . '</wb:sectionedit>';
    }

    /**
     * Get the Url to an edit special page
     *
     * @param string $specialPageName The special page to link to
     * @param string[] $specialPageUrlParams Additional URL params for the special page
     *
     * @return string|null
     */
    private function getEditUrl( $specialPageName, array $specialPageUrlParams ) {
        if ( !$specialPageUrlParams ) {
            return null;
        }

        return $this->specialPageLinker->getLink( $specialPageName, $specialPageUrlParams );
    }

    /**
     * @param string $cssClassSuffix
     * @param string $buttonLabel the text to show on the toolbar button link
     * @param string|null $editUrl
     *
     * @return string
     */
    private function getToolbarButton( $cssClassSuffix, $buttonLabel, $editUrl = null ) {
        if ( $editUrl === null ) {
            return '';
        }

        return $this->templateFactory->render(
            'wikibase-toolbar-button',
            'wikibase-toolbar-button-' . $cssClassSuffix,
            $editUrl,
            htmlspecialchars( $buttonLabel ),
            '' // Title tooltip
        );
    }

    public function getAddStatementToGroupSection( PropertyId $propertyId, EntityId $entityId = null ) {
        // This is just an empty toolbar wrapper. It's used as a marker to the JavaScript so that it places
        // the toolbar at the right position in the DOM. Without this, the JavaScript would just append the
        // toolbar to the end of the element.
        // TODO: Create special pages, link to them
        return $this->getToolbarContainer( '' );
    }

    public function getStatementEditSection( Statement $statement ) {
        // This is just an empty toolbar wrapper. It's used as a marker to the JavaScript so that it places
        // the toolbar at the right position in the DOM. Without this, the JavaScript would just append the
        // toolbar to the end of the element.
        // TODO: Create special pages, link to them
        return $this->getToolbarContainer( '' );
    }

}