TextboxBuilder.php

Go to the documentation of this file.

<?php
namespace MediaWiki\EditPage;
 
use MediaWiki\Html\Html;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Parser\Sanitizer;
use MediaWiki\Permissions\PermissionManager;
use MediaWiki\Permissions\RestrictionStore;
use MediaWiki\Title\Title;
use MediaWiki\User\Options\UserOptionsLookup;
use MediaWiki\User\UserIdentity;
 
class TextboxBuilder {
 
    private readonly PermissionManager $permissionManager;
    private readonly RestrictionStore $restrictionStore;
    private readonly UserOptionsLookup $userOptionsLookup;
 
    public function __construct(
        ?PermissionManager $permissionManager = null,
        ?RestrictionStore $restrictionStore = null,
        ?UserOptionsLookup $userOptionsLookup = null,
    ) {
        $this->permissionManager = $permissionManager ?? MediaWikiServices::getInstance()->getPermissionManager();
        $this->restrictionStore = $restrictionStore ?? MediaWikiServices::getInstance()->getRestrictionStore();
        $this->userOptionsLookup = $userOptionsLookup ?? MediaWikiServices::getInstance()->getUserOptionsLookup();
    }
 
    public function addNewLineAtEnd( $wikitext ) {
        if ( strval( $wikitext ) !== '' ) {
            // Ensure there's a newline at the end, otherwise adding lines
            // is awkward.
            // But don't add a newline if the text is empty, or Firefox in XHTML
            // mode will show an extra newline. A bit annoying.
            return $wikitext . "\n";
        }
        return $wikitext;
    }
 
    public function mergeClassesIntoAttributes( array $classes, array $attribs ) {
        if ( $classes === [] ) {
            return $attribs;
        }
 
        return Sanitizer::mergeAttributes(
            $attribs,
            [ 'class' => implode( ' ', $classes ) ]
        );
    }
 
    public function getTextboxProtectionCSSClasses( PageIdentity $page ) {
        $classes = []; // Textarea CSS
        if ( $this->restrictionStore->isProtected( $page, 'edit' ) &&
            $this->permissionManager->getNamespaceRestrictionLevels( $page->getNamespace() ) !== [ '' ]
        ) {
            # Is the title semi-protected?
            if ( $this->restrictionStore->isSemiProtected( $page ) ) {
                $classes[] = 'mw-textarea-sprotected';
            } else {
                # Then it must be protected based on static groups (regular)
                $classes[] = 'mw-textarea-protected';
            }
            # Is the title cascade-protected?
            if ( $this->restrictionStore->isCascadeProtected( $page ) ) {
                $classes[] = 'mw-textarea-cprotected';
            }
        }
 
        return $classes;
    }
 
    public function buildTextboxAttribs(
        $name, array $customAttribs, UserIdentity $user, PageIdentity $page
    ) {
        $attribs = $customAttribs + [
            'accesskey' => ',',
            'id' => $name,
            'cols' => 80,
            'rows' => 25,
        ];
 
        // The following classes can be used here:
        // * mw-editfont-monospace
        // * mw-editfont-sans-serif
        // * mw-editfont-serif
        $class = 'mw-editfont-' . $this->userOptionsLookup->getOption( $user, 'editfont' );
        Html::addClass( $attribs['class'], $class );
 
        $title = Title::newFromPageIdentity( $page );
        $pageLang = $title->getPageLanguage();
        $attribs['lang'] = $pageLang->getHtmlCode();
        $attribs['dir'] = $pageLang->getDir();
 
        return $attribs;
    }
 
}