DeprecationWrapper.php

Go to the documentation of this file.

<?php
class Elgg_DeprecationWrapper implements ArrayAccess {
    protected $object;

    protected $string;

    protected $message;

    protected $version;

    protected $reporter;

    public function __construct($object, $message, $version, $reporter = 'elgg_deprecated_notice') {
        if (is_object($object)) {
            $this->object = $object;
        } else {
            $this->string = $object;
        }
        $this->message = $message;
        $this->version = $version;
        $this->reporter = $reporter;
    }

    public function __get($name) {
        $this->displayWarning();
        return $this->object->$name;
    }

    public function __set($name, $value) {
        $this->displayWarning();
        $this->object->$name = $value;
    }

    public function __call($name, $arguments) {
        $this->displayWarning();
        return call_user_func_array(array($this->object, $name), $arguments);
    }

    public function __toString() {
        $this->displayWarning();
        if (isset($this->string)) {
            return $this->string;
        } else {
            return (string) $this->object;
        }
    }

    protected function displayWarning() {
        // display 3 levels in the function stack to get back to original use
        // 1 for __get/__call/__toString()
        // 1 for displayWarning()
        // 1 for call_user_func()
        call_user_func($this->reporter, $this->message, $this->version, 3);
    }

    public function offsetSet($key, $value) {
        $this->displayWarning();
        if (is_object($this->object) && !$this->object instanceof ArrayAccess) {
            $this->object->$key = $value;
        } else {
            if ($key === null) {
                // Yes this is necessary. Otherwise $key will be interpreted as empty string
                $this->object[] = $value;
            } else {
                $this->object[$key] = $value;
            }
        }
    }

    public function offsetGet($key) {
        $this->displayWarning();
        if (is_object($this->object) && !$this->object instanceof ArrayAccess) {
            return $this->object->$key;
        } else {
            return $this->object[$key];
        }
    }

    public function offsetUnset($key) {
        $this->displayWarning();
        if (is_object($this->object) && !$this->object instanceof ArrayAccess) {
            unset($this->object->$key);
        } else {
            unset($this->object[$key]);
        }
    }

    public function offsetExists($offset) {
        $this->displayWarning();
        if (is_object($this->object) && !$this->object instanceof ArrayAccess) {
            return isset($this->object->$offset);
        } else {
            return array_key_exists($offset, $this->object);
        }
    }
}