Predis to v2.2.2

plugins/cache-redis/Predis/Configuration/Option/Replication.php

@@ -0,0 +1,126 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2023 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Configuration\Option;
+
+use InvalidArgumentException;
+use Predis\Configuration\OptionsInterface;
+use Predis\Connection\AggregateConnectionInterface;
+use Predis\Connection\Replication\MasterSlaveReplication;
+use Predis\Connection\Replication\SentinelReplication;
+
+/**
+ * Configures an aggregate connection used for master/slave replication among
+ * multiple Redis nodes.
+ */
+class Replication extends Aggregate
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function filter(OptionsInterface $options, $value)
+    {
+        if (is_string($value)) {
+            $value = $this->getConnectionInitializerByString($options, $value);
+        }
+
+        if (is_callable($value)) {
+            return $this->getConnectionInitializer($options, $value);
+        } else {
+            throw new InvalidArgumentException(sprintf(
+                '%s expects either a string or a callable value, %s given',
+                static::class,
+                is_object($value) ? get_class($value) : gettype($value)
+            ));
+        }
+    }
+
+    /**
+     * Returns a connection initializer (callable) from a descriptive string.
+     *
+     * Each connection initializer is specialized for the specified replication
+     * backend so that all the necessary steps for the configuration of the new
+     * aggregate connection are performed inside the initializer and the client
+     * receives a ready-to-use connection.
+     *
+     * Supported configuration values are:
+     *
+     * - `predis` for unmanaged replication setups
+     * - `redis-sentinel` for replication setups managed by redis-sentinel
+     * - `sentinel` is an alias of `redis-sentinel`
+     *
+     * @param OptionsInterface $options     Client options
+     * @param string           $description Identifier of a replication backend
+     *
+     * @return callable
+     */
+    protected function getConnectionInitializerByString(OptionsInterface $options, string $description)
+    {
+        switch ($description) {
+            case 'sentinel':
+            case 'redis-sentinel':
+                return function ($parameters, $options) {
+                    return new SentinelReplication($options->service, $parameters, $options->connections);
+                };
+
+            case 'predis':
+                return $this->getDefaultConnectionInitializer();
+
+            default:
+                throw new InvalidArgumentException(sprintf(
+                    '%s expects either `predis`, `sentinel` or `redis-sentinel` as valid string values, `%s` given',
+                    static::class,
+                    $description
+                ));
+        }
+    }
+
+    /**
+     * Returns the default connection initializer.
+     *
+     * @return callable
+     */
+    protected function getDefaultConnectionInitializer()
+    {
+        return function ($parameters, $options) {
+            $connection = new MasterSlaveReplication();
+
+            if ($options->autodiscovery) {
+                $connection->setConnectionFactory($options->connections);
+                $connection->setAutoDiscovery(true);
+            }
+
+            return $connection;
+        };
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public static function aggregate(OptionsInterface $options, AggregateConnectionInterface $connection, array $nodes)
+    {
+        if (!$connection instanceof SentinelReplication) {
+            parent::aggregate($options, $connection, $nodes);
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getDefault(OptionsInterface $options)
+    {
+        return $this->getConnectionInitializer(
+            $options,
+            $this->getDefaultConnectionInitializer()
+        );
+    }
+}