SkinComponentUtils.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Skin;
 
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\MediaWikiServices;
use MediaWiki\Permissions\Authority;
use MediaWiki\Request\WebRequest;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\Title\Title;
 
class SkinComponentUtils {
    public static function addClassToClassList( $class, string $newClass ) {
        if ( is_array( $class ) ) {
            $class[] = $newClass;
        } else {
            $class .= ' ' . $newClass;
            $class = trim( $class );
        }
        return $class;
    }
 
    public static function getReturnToParam( $title, $request, $authority ) {
        // T379295/T381216: Preserve authentication query params so they don't get lost
        // during switching between Login/Logout or CreateAccount pages where we need them.
        // See AuthManagerSpecialPage/LoginSignupSpecialPage::getPreservedParams().
        // This special case also avoids "nesting" returnto values on these pages.
        if (
            $title->isSpecial( 'Userlogin' )
            || $title->isSpecial( 'CreateAccount' )
            || $title->isSpecial( 'Userlogout' )
        ) {
            $params = [
                'uselang' => $request->getVal( 'uselang' ),
                'variant' => $request->getVal( 'variant' ),
                'display' => $request->getVal( 'display' ),
                'returnto' => $request->getVal( 'returnto' ),
                'returntoquery' => $request->getVal( 'returntoquery' ),
                'returntoanchor' => $request->getVal( 'returntoanchor' ),
            ];
            ( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) )
                ->onAuthPreserveQueryParams( $params, [ 'reset' => true ] );
            return array_filter( $params, fn ( $val ) => $val !== null );
        }
 
        # Due to T34276, if a user does not have read permissions,
        # $this->getTitle() will just give Special:Badtitle, which is
        # not especially useful as a returnto parameter. Use the title
        # from the request instead, if there was one.
        if ( $authority->isAllowed( 'read' ) ) {
            $page = $title;
        } else {
            $page = Title::newFromText( $request->getVal( 'title', '' ) );
        }
 
        $query = [];
        if ( !$request->wasPosted() ) {
            $query = $request->getQueryValues();
            unset( $query['title'] );
        }
 
        $params = [];
        if ( $page ) {
            $params['returnto'] = $page->getPrefixedText();
            if ( $query ) {
                $params['returntoquery'] = wfArrayToCgi( $query );
            }
        }
 
        return $params;
    }
 
    public static function makeSpecialUrl( $name, $urlaction = '', $proto = null ) {
        $title = SpecialPage::getSafeTitleFor( $name );
        if ( $proto === null ) {
            return $title->getLocalURL( $urlaction );
        } else {
            return $title->getFullURL( $urlaction, false, $proto );
        }
    }
 
    public static function makeSpecialUrlSubpage( $name, $subpage, $urlaction = '' ) {
        $title = SpecialPage::getSafeTitleFor( $name, $subpage );
        return $title->getLocalURL( $urlaction );
    }
}