DeprecationHelper.php

Go to the documentation of this file.

<?php
trait DeprecationHelper {
 
    protected $deprecatedPublicProperties = [];
 
    protected function deprecatePublicProperty(
        $property, $version, $class = null, $component = null
    ) {
        $this->deprecatedPublicProperties[$property] = [ $version, $class ?: get_class(), $component ];
    }
 
    public function __get( $name ) {
        if ( isset( $this->deprecatedPublicProperties[$name] ) ) {
            list( $version, $class, $component ) = $this->deprecatedPublicProperties[$name];
            $qualifiedName = $class . '::$' . $name;
            wfDeprecated( $qualifiedName, $version, $component, 3 );
            return $this->$name;
        }
 
        $qualifiedName = get_class() . '::$' . $name;
        if ( $this->deprecationHelperGetPropertyOwner( $name ) ) {
            // Someone tried to access a normal non-public property. Try to behave like PHP would.
            trigger_error( "Cannot access non-public property $qualifiedName", E_USER_ERROR );
        } else {
            // Non-existing property. Try to behave like PHP would.
            trigger_error( "Undefined property: $qualifiedName", E_USER_NOTICE );
        }
        return null;
    }
 
    public function __set( $name, $value ) {
        if ( isset( $this->deprecatedPublicProperties[$name] ) ) {
            list( $version, $class, $component ) = $this->deprecatedPublicProperties[$name];
            $qualifiedName = $class . '::$' . $name;
            wfDeprecated( $qualifiedName, $version, $component, 3 );
            $this->$name = $value;
            return;
        }
 
        $qualifiedName = get_class() . '::$' . $name;
        if ( $this->deprecationHelperGetPropertyOwner( $name ) ) {
            // Someone tried to access a normal non-public property. Try to behave like PHP would.
            trigger_error( "Cannot access non-public property $qualifiedName", E_USER_ERROR );
        } else {
            // Non-existing property. Try to behave like PHP would.
            $this->$name = $value;
        }
    }
 
    private function deprecationHelperGetPropertyOwner( $property ) {
        // Easy branch: check for protected property / private property of the current class.
        if ( property_exists( $this, $property ) ) {
            // The class name is not necessarily correct here but getting the correct class
            // name would be expensive, this will work most of the time and getting it
            // wrong is not a big deal.
            return __CLASS__;
        }
        // property_exists() returns false when the property does exist but is private (and not
        // defined by the current class, for some value of "current" that differs slightly
        // between engines).
        // Since PHP triggers an error on public access of non-public properties but happily
        // allows public access to undefined properties, we need to detect this case as well.
        // Reflection is slow so use array cast hack to check for that:
        $obfuscatedProps = array_keys( (array)$this );
        $obfuscatedPropTail = "\0$property";
        foreach ( $obfuscatedProps as $obfuscatedProp ) {
            // private props are in the form \0<classname>\0<propname>
            if ( strpos( $obfuscatedProp, $obfuscatedPropTail, 1 ) !== false ) {
                $classname = substr( $obfuscatedProp, 1, -strlen( $obfuscatedPropTail ) );
                if ( $classname === '*' ) {
                    // sanity; this shouldn't be possible as protected properties were handled earlier
                    $classname = __CLASS__;
                }
                return $classname;
            }
        }
        return false;
    }
 
}