BaseCache.php

Go to the documentation of this file.

<?php

namespace Elgg\Cache;

abstract class BaseCache implements \ArrayAccess {

    private array $variables = [];

    protected bool $disabled = false;
    
    public function setVariable(string $variable, $value): void {
        $this->variables[$variable] = $value;
    }

    public function getVariable(string $variable) {
        return $this->variables[$variable] ?? null;
    }

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

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

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

    public function __unset(string $key): void {
        $this->delete($key);
    }

    abstract public function save($key, $data, $expire_after = null);

    abstract public function load($key);

    abstract public function delete($key);

    abstract public function clear();
    
    abstract public function invalidate();
    
    abstract public function purge();

    public function disable(): void {
        $this->disabled = true;
    }

    public function enable(): void {
        $this->disabled = false;
    }

    public function populate(array $values, ?int $expires_after = null): void {
        $this->clear();
        foreach ($values as $key => $value) {
            $this->save($key, $value, $expires_after);
        }
    }

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

        return false;
    }

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

    #[\ReturnTypeWillChange]
    public function offsetSet($offset, $value) {
        $this->save($offset, $value);
    }

    #[\ReturnTypeWillChange]
    public function offsetGet($offset) {
        return $this->load($offset);
    }

    #[\ReturnTypeWillChange]
    public function offsetUnset($offset) {
        if (isset($this->$offset)) {
            unset($this->$offset);
        }
    }

    #[\ReturnTypeWillChange]
    public function offsetExists($offset) {
        return isset($this->$offset);
    }
}