first version

kirby/src/Cache/MemCached.php

@@ -0,0 +1,137 @@
+<?php
+
+namespace Kirby\Cache;
+
+/**
+* Memcached Driver
+*
+* @package   Kirby Cache
+* @author    Bastian Allgeier <bastian@getkirby.com>
+* @link      http://getkirby.com
+* @copyright Bastian Allgeier
+* @license   MIT
+*/
+class MemCached extends Cache
+{
+
+    /**
+     * store for the memache connection
+     * @var Memcached
+     */
+    protected $connection;
+
+    /**
+     * Set all parameters which are needed for the memcache client
+     * see defaults for available parameters
+     *
+     * @param array $params
+     */
+    public function __construct(array $params = [])
+    {
+        $defaults = [
+            'host'    => 'localhost',
+            'port'    => 11211,
+            'prefix'  => null,
+        ];
+
+        parent::__construct(array_merge($defaults, $params));
+
+        $this->connection = new \Memcached();
+        $this->connection->addServer($this->options['host'], $this->options['port']);
+    }
+
+    /**
+     * Write an item to the cache for a given number of minutes.
+     *
+     * <code>
+     *    // Put an item in the cache for 15 minutes
+     *    Cache::set('value', 'my value', 15);
+     * </code>
+     *
+     * @param  string  $key
+     * @param  mixed   $value
+     * @param  int     $minutes
+     * @return void
+     */
+    public function set(string $key, $value, int $minutes = 0)
+    {
+        return $this->connection->set($this->key($key), $this->value($value, $minutes)->toJson(), $this->expiration($minutes));
+    }
+
+    /**
+     * Returns the full keyname
+     * including the prefix (if set)
+     *
+     * @param  string $key
+     * @return string
+     */
+    public function key(string $key): string
+    {
+        return $this->options['prefix'] . $key;
+    }
+
+    /**
+     * Retrieve the CacheValue object from the cache.
+     *
+     * @param  string  $key
+     * @return object  CacheValue
+     */
+    public function retrieve(string $key)
+    {
+        return Value::fromJson($this->connection->get($this->key($key)));
+    }
+
+    /**
+     * Remove an item from the cache
+     *
+     * @param  string  $key
+     * @return boolean
+     */
+    public function remove(string $key): bool
+    {
+        return $this->connection->delete($this->key($key));
+    }
+
+    /**
+     * Checks when an item in the cache expires
+     *
+     * @param  string $key
+     * @return int
+     */
+    public function expires(string $key): int
+    {
+        return parent::expires($this->key($key));
+    }
+
+    /**
+     * Checks if an item in the cache is expired
+     *
+     * @param  string $key
+     * @return boolean
+     */
+    public function expired(string $key): bool
+    {
+        return parent::expired($this->key($key));
+    }
+
+    /**
+     * Checks when the cache has been created
+     *
+     * @param  string $key
+     * @return int
+     */
+    public function created(string $key): int
+    {
+        return parent::created($this->key($key));
+    }
+
+    /**
+     * Flush the entire cache directory
+     *
+     * @return boolean
+     */
+    public function flush(): bool
+    {
+        return $this->connection->flush();
+    }
+}