predis/lib/Predis/ConnectionFactoryInterface.php

<?php

/*
 * This file is part of the Predis package.
 *
 * (c) Daniele Alessandri <suppakilla@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Predis;

use Predis\Profile\ServerProfileInterface;
use Predis\Connection\ClusterConnectionInterface;
use Predis\Connection\ReplicationConnectionInterface;

/**
 * Interface that must be implemented by classes that provide their own mechanism
 * to create and initialize new instances of Predis\Connection\SingleConnectionInterface.
 *
 * @author Daniele Alessandri <suppakilla@gmail.com>
 */
interface ConnectionFactoryInterface
{
    /**
     * Defines or overrides the connection class identified by a scheme prefix.
     *
     * @param string $scheme URI scheme identifying the connection class.
     * @param mixed $initializer FQN of a connection class or a callable object for lazy initialization.
     */
    public function define($scheme, $initializer);

    /**
     * Undefines the connection identified by a scheme prefix.
     *
     * @param string $scheme Parameters for the connection.
     */
    public function undefine($scheme);

    /**
     * Creates a new connection object.
     *
     * @param mixed $parameters Parameters for the connection.
     * @return Predis\Connection\SingleConnectionInterface
     */
    public function create($parameters, ServerProfileInterface $profile = null);

    /**
     * Prepares a cluster of connection objects.
     *
     * @param ClusterConnectionInterface Instance of a connection cluster class.
     * @param array $parameters List of parameters for each connection object.
     * @return Predis\Connection\ClusterConnectionInterface
     */
    public function createCluster(ClusterConnectionInterface $cluster, $parameters, ServerProfileInterface $profile = null);

    /**
     * Prepares a master / slave replication configuration.
     *
     * @param ReplicationConnectionInterface Instance of a connection cluster class.
     * @param array $parameters List of parameters for each connection object.
     * @return Predis\Connection\ReplicationConnectionInterface
     */
    public function createReplication(ReplicationConnectionInterface $replication, $parameters, ServerProfileInterface $profile = null);
}