ElggCache.php

Go to the documentation of this file.

<?php
abstract class ElggCache implements \ArrayAccess {
    private $variables;

    public function __construct() {
        $this->variables = array();
    }

    // @codingStandardsIgnoreStart
    public function set_variable($variable, $value) {
        elgg_deprecated_notice('\ElggCache::set_variable() is deprecated by \ElggCache::setVariable()', 1.8);
        $this->setVariable($variable, $value);
    }
    // @codingStandardsIgnoreEnd

    public function setVariable($variable, $value) {
        if (!is_array($this->variables)) {
            $this->variables = array();
        }

        $this->variables[$variable] = $value;
    }

    // @codingStandardsIgnoreStart
    public function get_variable($variable) {
        elgg_deprecated_notice('\ElggCache::get_variable() is deprecated by \ElggCache::getVariable()', 1.8);
        return $this->getVariable($variable);
    }
    // @codingStandardsIgnoreEnd

    public function getVariable($variable) {
        if (isset($this->variables[$variable])) {
            return $this->variables[$variable];
        }

        return null;
    }

    public function __get($key) {
        return $this->load($key);
    }

    public function __set($key, $value) {
        $this->save($key, $value);
    }

    public function __isset($key) {
        return (bool)$this->load($key);
    }

    public function __unset($key) {
        return $this->delete($key);
    }

    abstract public function save($key, $data);

    abstract public function load($key, $offset = 0, $limit = null);

    abstract public function delete($key);

    abstract public function clear();

    public function add($key, $data) {
        if (!isset($this[$key])) {
            return $this->save($key, $data);
        }

        return false;
    }

    // ARRAY ACCESS INTERFACE //////////////////////////////////////////////////////////

    public function offsetSet($key, $value) {
        $this->save($key, $value);
    }

    public function offsetGet($key) {
        return $this->load($key);
    }

    public function offsetUnset($key) {
        if (isset($this->$key)) {
            unset($this->$key);
        }
    }

    public function offsetExists($key) {
        return isset($this->$key);
    }
}