StubObject.php

Go to the documentation of this file.

<?php
 
// phpcs:disable MediaWiki.Commenting.FunctionComment.ObjectTypeHintReturn
// phpcs:disable MediaWiki.Commenting.FunctionComment.ObjectTypeHintParam
 
namespace MediaWiki\StubObject;
 
use LogicException;
use Wikimedia\ObjectFactory\ObjectFactory;
 
class StubObject {
    protected $global;
 
    protected $class;
 
    protected $factory;
 
    protected $params;
 
    public function __construct( $global = null, $class = null, $params = [] ) {
        $this->global = $global;
        if ( is_callable( $class ) ) {
            $this->factory = $class;
        } else {
            $this->class = $class;
        }
        $this->params = $params;
    }
 
    public static function isRealObject( $obj ) {
        return is_object( $obj ) && !$obj instanceof self;
    }
 
    public static function unstub( &$obj ) {
        if ( $obj instanceof self ) {
            $obj = $obj->_unstub( 'unstub', 3 );
        }
    }
 
    // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore
    public function _call( $name, $args ) {
        $this->_unstub( $name, 5 );
        return call_user_func_array( [ $GLOBALS[$this->global], $name ], $args );
    }
 
    // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore
    public function _newObject() {
        $params = $this->factory
            ? [ 'factory' => $this->factory ]
            : [ 'class' => $this->class ];
 
        // ObjectFactory::getObjectFromSpec accepts an array, not just a callable (phan bug)
        // @phan-suppress-next-line PhanTypeInvalidCallableArraySize
        return ObjectFactory::getObjectFromSpec( $params + [
                'args' => $this->params,
                'closure_expansion' => false,
            ] );
    }
 
    public function __call( $name, $args ) {
        return $this->_call( $name, $args );
    }
 
    // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore
    public function _get( $name ) {
        $this->_unstub( "__get($name)", 5 );
        return $GLOBALS[$this->global]->$name;
    }
 
    public function __get( $name ) {
        return $this->_get( $name );
    }
 
    // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore
    public function _set( $name, $value ) {
        $this->_unstub( "__set($name)", 5 );
        $GLOBALS[$this->global]->$name = $value;
    }
 
    public function __set( $name, $value ) {
        $this->_set( $name, $value );
    }
 
    // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore
    public function _unstub( $name = '_unstub', $level = 2 ) {
        static $recursionLevel = 0;
 
        if ( !$GLOBALS[$this->global] instanceof self ) {
            return $GLOBALS[$this->global]; // already unstubbed.
        }
 
        if ( get_class( $GLOBALS[$this->global] ) != $this->class ) {
            $caller = wfGetCaller( $level );
            if ( ++$recursionLevel > 2 ) {
                throw new LogicException( "Unstub loop detected on call of "
                    . "\${$this->global}->$name from $caller\n" );
            }
            wfDebug( "Unstubbing \${$this->global} on call of "
                . "\${$this->global}::$name from $caller" );
            $GLOBALS[$this->global] = $this->_newObject();
            --$recursionLevel;
            return $GLOBALS[$this->global];
        }
    }
}
 
class_alias( StubObject::class, 'StubObject' );