ytake / Laravel-Couchbase

src/CouchbaseServiceProvider.php

<?php
declare(strict_types=1);

/**
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

namespace Ytake\LaravelCouchbase;

use Illuminate\Cache\Repository;
use Illuminate\Database\DatabaseManager;
use Illuminate\Queue\QueueManager;
use Illuminate\Session\CacheBasedSessionHandler;
use Illuminate\Support\ServiceProvider;
use Ytake\LaravelCouchbase\Cache\CouchbaseStore;
use Ytake\LaravelCouchbase\Cache\MemcachedBucketStore;
use Ytake\LaravelCouchbase\Database\Connectable;
use Ytake\LaravelCouchbase\Database\CouchbaseConnection;
use Ytake\LaravelCouchbase\Database\CouchbaseConnector;
use Ytake\LaravelCouchbase\Queue\CouchbaseConnector as QueueConnector;

/**
 * Class CouchbaseServiceProvider.
 *
 * @codeCoverageIgnore
 *
 * @author Yuuki Takezawa<yuuki.takezawa@comnect.jp.net>
 */
class CouchbaseServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap  application services.
     */
    public function boot()
    {
        $this->registerCouchbaseBucketCacheDriver();
        $this->registerMemcachedBucketCacheDriver();
        $this->registerCouchbaseQueueDriver();
    }

    /**
     * {@inheritdoc}
     */
    public function register()
    {
        $configPath = __DIR__ . '/config/couchbase.php';
        $this->mergeConfigFrom($configPath, 'couchbase');
        $this->publishes([$configPath => config_path('couchbase.php')], 'couchbase');
        $this->registerCouchbaseComponent();
    }

    protected function registerCouchbaseComponent()
    {
        $this->app->singleton(Connectable::class, function () {
            return new CouchbaseConnector();
        });

        $this->app->singleton('couchbase.memcached.connector', function () {
            return new MemcachedConnector();
        });

        // add couchbase session driver
        $this->app['session']->extend('couchbase', function ($app) {
            $minutes = $app['config']['session.lifetime'];

            return new CacheBasedSessionHandler(clone $this->app['cache']->driver('couchbase'), $minutes);
        });

        // add couchbase session driver
        $this->app['session']->extend('couchbase-memcached', function ($app) {
            $minutes = $app['config']['session.lifetime'];

            return new CacheBasedSessionHandler(clone $this->app['cache']->driver('couchbase-memcached'), $minutes);
        });

        // add couchbase extension
        $this->app['db']->extend('couchbase', function (array $config, $name) {
            /* @var \Couchbase\Cluster $cluster */
            return new CouchbaseConnection($config, $name);
        });
    }

    /**
     * register 'couchbase' cache driver.
     * for bucket type couchbase.
     */
    protected function registerCouchbaseBucketCacheDriver(): void
    {
        $this->app['cache']->extend('couchbase', function ($app, $config) {
            /** @var \Couchbase\Cluster $cluster */
            $cluster = $app['db']->connection($config['driver'])->getCouchbase();
            $password = (isset($config['bucket_password'])) ? $config['bucket_password'] : '';

            return new Repository(
                new CouchbaseStore(
                    $cluster,
                    $config['bucket'],
                    $password,
                    $app['config']->get('cache.prefix')
                )
            );
        });
    }

    /**
     * register 'couchbase' cache driver.
     * for bucket type memcached.
     */
    protected function registerMemcachedBucketCacheDriver(): void
    {
        $this->app['cache']->extend('couchbase-memcached', function ($app, $config) {
            $prefix = $app['config']['cache.prefix'];
            $credential = $config['sasl'] ?? [];
            $memcachedBucket = $this->app['couchbase.memcached.connector']
                ->connect($config['servers']);

            return new Repository(
                new MemcachedBucketStore(

The class Ytake\LaravelCouchbase\Cache\MemcachedBucketStore has been deprecated.

                    $memcachedBucket,
                    strval($prefix),
                    $config['servers'],
                    $credential
                )
            );
        });
    }

    /**
     * register custom queue 'couchbase' driver
     */
    protected function registerCouchbaseQueueDriver(): void
    {
        /** @var QueueManager $queueManager */
        $queueManager = $this->app['queue'];
        $queueManager->addConnector('couchbase', function () {
            /** @var DatabaseManager $databaseManager */
            $databaseManager = $this->app['db'];

            return new QueueConnector($databaseManager);
        });
    }
}