MemCachedDriver.php

Go to the documentation of this file.

<?php
 
namespace Ubiquity\cache\system;
 
use Ubiquity\cache\CacheFile;
use Ubiquity\exceptions\CacheException;
 
class MemCachedDriver extends AbstractDataCache {
    private $cacheInstance;
    private const CONTENT = 'content';
    private const TAG = 'tag';
    private const TIME = 'time';
 
    public function __construct($root, $postfix = "", $cacheParams = [ ]) {
        parent::__construct ( $root, $postfix );
        $defaultParams = [ 'servers' => [ [ 'host' => '0.0.0.0','port' => 11211 ] ],'serializer' => \Memcached::SERIALIZER_PHP,'persistent' => true ];
        $cacheParams = \array_merge ( $defaultParams, $cacheParams );
        $this->cacheInstance = new \Memcached ( $cacheParams ['persistent'] ? \crc32 ( $root ) : null );
        if (isset ( $cacheParams ['serializer'] )) {
            $this->cacheInstance->setOption ( \Memcached::OPT_SERIALIZER, $cacheParams ['serializer'] );
        }
        if ($this->cacheInstance->isPristine ()) {
            $this->addServers ( $cacheParams ['servers'] );
        }
    }
 
    public function addServer($host, $port, $weight = null) {
        $this->cacheInstance->addServer ( $host, $port, $weight );
        $statuses = $this->cacheInstance->getStats ();
        if (! isset ( $statuses ["$host:$port"] )) {
            throw new CacheException ( "Connection to the server $host:$port failed!" );
        }
    }
 
    public function addServers(array $servers) {
        foreach ( $servers as $srv ) {
            $this->addServer ( $srv ['host'] ?? '0.0.0.0', $srv ['port'] ?? 11211, $srv ['weight'] ?? null);
        }
    }
 
    public function setSerializer($serializer) {
        $this->cacheInstance->setOption ( \Memcached::OPT_SERIALIZER, $serializer );
    }
 
    public function exists($key) {
        $k = $this->getRealKey ( $key );
        $this->cacheInstance->get ( $k );
        return \Memcached::RES_NOTFOUND !== $this->cacheInstance->getResultCode ();
    }
 
    public function store($key, $content, $tag = null) {
        $this->cacheInstance->set ( $this->getRealKey ( $key ), [ self::CONTENT => $content,self::TAG => $tag,self::TIME => \time () ] );
    }
 
    protected function getRealKey($key) {
        return \crc32 ( $key );
    }
 
    public function fetch($key) {
        $entry = $this->cacheInstance->get ( $this->getRealKey ( $key ) );
        return $entry [self::CONTENT] ?? false;
    }
 
    public function file_get_contents($key) {
        return $this->cacheInstance->get ( $this->getRealKey ( $key ) ) [self::CONTENT];
    }
 
    public function getTimestamp($key) {
        $key = $this->getRealKey ( $key );
        return $this->cacheInstance->get ( $key ) [self::TIME];
    }
 
    public function remove($key) {
        $key = $this->getRealKey ( $key );
        $this->cacheInstance->delete ( $this->getRealKey ( $key ) );
    }
 
    public function clear() {
        $this->cacheInstance->flush ();
    }
 
    public function getCacheFiles($type) {
        $result = [ ];
        $keys = $this->cacheInstance->getAllKeys ();
 
        foreach ( $keys as $key ) {
            $entry = $this->cacheInstance->get ( $key );
            if ($entry [self::TAG] === $type) {
                $result [] = new CacheFile ( \ucfirst ( $type ), $key, $entry [self::TIME], "", $key );
            }
        }
        if (\count ( $result ) === 0)
            $result [] = new CacheFile ( \ucfirst ( $type ), "", "", "" );
        return $result;
    }
 
    public function clearCache($type) {
        $keys = $this->cacheInstance->getAllKeys ();
        foreach ( $keys as $key ) {
            $entry = $this->cacheInstance->get ( $key );
            if ($entry [self::TAG] === $type) {
                $this->cacheInstance->delete ( $key );
            }
        }
    }
 
    public function getCacheInfo() {
        return parent::getCacheInfo () . "<br>Driver name : <b>" . \Memcached::class . "</b>";
    }
 
    public function getEntryKey($key) {
        return $this->getRealKey ( $key );
    }
}