StubGlobalUser.php

Go to the documentation of this file.

<?php
namespace MediaWiki\StubObject;
 
use InvalidArgumentException;
use MediaWiki\User\User;
 
class StubGlobalUser extends StubObject {
 
    public static $destructorDeprecationDisarmed = false;
 
    public $realUser;
 
    public function __construct( User $realUser ) {
        parent::__construct( 'wgUser' );
        $this->realUser = $realUser;
    }
 
    // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore
    public function _newObject() {
        // Based on MediaWiki\StubObject\DeprecatedGlobal::_newObject
        /*
         * Put the caller offset for wfDeprecated as 6, as
         * that gives the function that uses this object, since:
         *
         * 1 = this function ( _newObject )
         * 2 = MediaWiki\StubObject\StubGlobalUser::_unstub
         * 3 = MediaWiki\StubObject\StubObject::_call
         * 4 = MediaWiki\StubObject\StubObject::__call
         * 5 = MediaWiki\StubObject\StubGlobalUser::<method of global called>
         * 6 = Actual function using the global.
         * (the same applies to _get/__get or _set/__set instead of _call/__call)
         *
         * Of course its theoretically possible to have other call
         * sequences for this method, but that seems to be
         * rather unlikely.
         */
        // Officially deprecated since 1.35
        wfDeprecated( '$wgUser', '1.35', false, 6 );
        return $this->realUser;
    }
 
    public static function setUser( $user ) {
        // This is intended to be interacting with the deprecated global
        // phpcs:ignore MediaWiki.Usage.DeprecatedGlobalVariables.Deprecated$wgUser
        global $wgUser;
 
        self::$destructorDeprecationDisarmed = true;
        // Supports MediaWiki\StubObject\StubGlobalUser parameter in case something fetched the existing value of
        // $wgUser, set it to something else, and now is trying to restore it
        $realUser = self::getRealUser( $user );
        $wgUser = new self( $realUser );
        self::$destructorDeprecationDisarmed = false;
    }
 
    public static function getRealUser( $globalUser ): User {
        if ( $globalUser instanceof StubGlobalUser ) {
            return $globalUser->realUser;
        } elseif ( $globalUser instanceof User ) {
            return $globalUser;
        } else {
            throw new InvalidArgumentException(
                '$globalUser must be a User (or MediaWiki\StubObject\StubGlobalUser), got ' .
                get_debug_type( $globalUser )
            );
        }
    }
 
    // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore
    public function _unstub( $name = '_unstub', $level = 2 ) {
        if ( !$GLOBALS[$this->global] instanceof self ) {
            return $GLOBALS[$this->global]; // already unstubbed.
        }
 
        $caller = wfGetCaller( $level );
        wfDebug( "Unstubbing \${$this->global} on call of "
            . "\${$this->global}::$name from $caller" );
        $GLOBALS[$this->global] = $this->_newObject();
        return $GLOBALS[$this->global];
    }
 
    public function __destruct() {
        if ( !self::$destructorDeprecationDisarmed ) {
            wfDeprecatedMsg( '$wgUser reassignment detected', '1.37', false, 3 );
        }
    }
}