initial commit; version 22.5.12042

libs/Phpfastcache8/Drivers/Couchbasev3/Driver.php

@@ -0,0 +1,202 @@
+<?php
+
+/**
+ *
+ * This file is part of phpFastCache.
+ *
+ * @license MIT License (MIT)
+ *
+ * For full copyright and license information, please see the docs/CREDITS.txt file.
+ *
+ * @author Khoa Bui (khoaofgod)  <khoaofgod@gmail.com> https://www.phpfastcache.com
+ * @author Georges.L (Geolim4)  <contact@geolim4.com>
+ *
+ */
+declare(strict_types=1);
+
+namespace Phpfastcache\Drivers\Couchbasev3;
+
+use Couchbase\{BaseException as CouchbaseException, Cluster, ClusterOptions, Collection, DocumentNotFoundException, Scope, UpsertOptions};
+use Phpfastcache\Config\ConfigurationOption;
+use Phpfastcache\Drivers\Couchbase\Driver as CoubaseV2Driver;
+use Phpfastcache\Drivers\Couchbase\Item;
+use Phpfastcache\Entities\DriverStatistic;
+use Phpfastcache\Exceptions\{PhpfastcacheDriverCheckException, PhpfastcacheInvalidArgumentException, PhpfastcacheLogicException};
+use Psr\Cache\CacheItemInterface;
+
+/**
+ * Class Driver
+ * @package phpFastCache\Drivers
+ * @property Cluster $instance Instance of driver service
+ * @property Config $config Config object
+ * @method Config getConfig() Return the config object
+ */
+class Driver extends CoubaseV2Driver
+{
+    /**
+     * @var Scope
+     */
+    protected $scope;
+
+    /**
+     * @var Collection
+     */
+    protected $collection;
+
+    public function __construct(ConfigurationOption $config, $instanceId)
+    {
+        $this->__baseConstruct($config, $instanceId);
+    }
+
+    /**
+     * @return bool
+     * @throws PhpfastcacheLogicException
+     */
+    protected function driverConnect(): bool
+    {
+        if (!\class_exists(ClusterOptions::class)) {
+            throw new PhpfastcacheDriverCheckException('You are using the Couchbase PHP SDK 2.x so please use driver Couchbasev3');
+        }
+
+        $connectionString = "couchbase://{$this->getConfig()->getHost()}:{$this->getConfig()->getPort()}";
+
+        $options = new ClusterOptions();
+        $options->credentials($this->getConfig()->getUsername(), $this->getConfig()->getPassword());
+        $this->instance = new Cluster($connectionString, $options);
+
+        $this->setBucket($this->instance->bucket($this->getConfig()->getBucketName()));
+        $this->setScope($this->getBucket()->scope($this->getConfig()->getScopeName()));
+        $this->setCollection($this->getScope()->collection($this->getConfig()->getCollectionName()));
+
+        return true;
+    }
+
+    /**
+     * @param CacheItemInterface $item
+     * @return null|array
+     */
+    protected function driverRead(CacheItemInterface $item)
+    {
+        try {
+            /**
+             * CouchbaseBucket::get() returns a GetResult interface
+             */
+            return $this->decodeDocument((array)$this->getCollection()->get($item->getEncodedKey())->content());
+        } catch (DocumentNotFoundException $e) {
+            return null;
+        }
+    }
+
+    /**
+     * @param CacheItemInterface $item
+     * @return bool
+     * @throws PhpfastcacheInvalidArgumentException
+     */
+    protected function driverWrite(CacheItemInterface $item): bool
+    {
+        /**
+         * Check for Cross-Driver type confusion
+         */
+        if ($item instanceof Item) {
+            try {
+                $this->getCollection()->upsert(
+                    $item->getEncodedKey(),
+                    $this->encodeDocument($this->driverPreWrap($item)),
+                    (new UpsertOptions())->expiry($item->getTtl())
+                );
+                return true;
+            } catch (CouchbaseException $e) {
+                return false;
+            }
+        }
+
+        throw new PhpfastcacheInvalidArgumentException('Cross-Driver type confusion detected');
+    }
+
+    /**
+     * @param CacheItemInterface $item
+     * @return bool
+     * @throws PhpfastcacheInvalidArgumentException
+     */
+    protected function driverDelete(CacheItemInterface $item): bool
+    {
+        /**
+         * Check for Cross-Driver type confusion
+         */
+        if ($item instanceof Item) {
+            try {
+                $this->getCollection()->remove($item->getEncodedKey());
+                return true;
+            } catch (DocumentNotFoundException $e) {
+                return true;
+            } catch (CouchbaseException $e) {
+                return false;
+            }
+        }
+
+        throw new PhpfastcacheInvalidArgumentException('Cross-Driver type confusion detected');
+    }
+
+    /**
+     * @return bool
+     */
+    protected function driverClear(): bool
+    {
+        $this->instance->buckets()->flush($this->getConfig()->getBucketName());
+        return true;
+    }
+
+    /**
+     * @return DriverStatistic
+     */
+    public function getStats(): DriverStatistic
+    {
+        /**
+         * Between SDK 2 and 3 we lost a lot of useful information :(
+         * @see https://docs.couchbase.com/java-sdk/current/project-docs/migrating-sdk-code-to-3.n.html#management-apis
+         */
+        $info = $this->getBucket()->diagnostics(\bin2hex(\random_bytes(16)));
+
+        return (new DriverStatistic())
+            ->setSize(0)
+            ->setRawData($info)
+            ->setData(implode(', ', array_keys($this->itemInstances)))
+            ->setInfo( $info['sdk'] . "\n For more information see RawData.");
+    }
+
+    /**
+     * @return Collection
+     */
+    public function getCollection(): Collection
+    {
+        return $this->collection;
+    }
+
+    /**
+     * @param Collection $collection
+     * @return Driver
+     */
+    public function setCollection(Collection $collection): Driver
+    {
+        $this->collection = $collection;
+        return $this;
+    }
+
+    /**
+     * @return Scope
+     */
+    public function getScope(): Scope
+    {
+        return $this->scope;
+    }
+
+    /**
+     * @param Scope $scope
+     * @return Driver
+     */
+    public function setScope(Scope $scope): Driver
+    {
+        $this->scope = $scope;
+        return $this;
+    }
+}