mirror of
https://github.com/predis/predis.git
synced 2026-08-20 06:51:50 +00:00
Daniele Alessandri
b1ebc8df2f
This commit is a complete rewrite of the classes previously contained
in the Predis\Option namespace aimed at lowering the initialization
overhead while bringing in more consistency. The overall idea is still
the same with a mini DI container, Predis\Configuration\Options, which
carries options with values that can be initialized lazily.
The first difference with our previous implementation is that now even
user-defined options can be initialized lazily, everything needed is
an object responding to the __invoke() magic method such as a closure.
Other kind of callable arguments (strings, arrays) will be treated as
plain values. The only drawback is that we cannot pass any instance of
classes implementing __invoke() as an option value, but considered the
limited scope of our use case we can say it's more of an acceptable
compromise. Callbacks used for lazy initialization will receive two
arguments upon invokation:
- The current instance of Predis\Configuration\Option ($options)
- A string containing the name of the option ($option)
This is an example in actual code:
$options = new Predis\Configuration\Options([
'exceptions' => true,
'profile' => '2.8',
'distributor' => function () {
return new Predis\Cluster\Distribution\KetamaPureRing();
},
'cluster' => function ($options) {
$distr = $options->distributor;
$strategy = new Predis\Cluster\PredisClusterHashStrategy($distr);
$cluster = new Predis\Connection\PredisCluster();
return $cluster;
},
'connections' => function ($options, $option) {
$factory = $options->getDefault($option);
$factory->define('tcp', 'Predis\Connection\PhpiredisConnection');
return $factory;
},
]);
As you can see there's very little difference compared to before in
the actual usage as most changes are under the hood. Some options such
as "exceptions" and "replication" can now correctly parse bool values
from strings (so the string "false" is not evaluated as boolean true).
While options were initially conceived to configure the client and its
behavior, the concept has matured and it's perfectly fine to consider
the use of Predis\Configuration\Options to propagate configurations to
inner parts of the library.
67 lines
1.6 KiB
PHP
67 lines
1.6 KiB
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\Configuration\OptionsInterface;
|
|
use Predis\Connection\ConnectionInterface;
|
|
use Predis\Profile\ServerProfileInterface;
|
|
|
|
/**
|
|
* Interface defining the most important parts needed to create an
|
|
* high-level Redis client object that can interact with other
|
|
* building blocks of Predis.
|
|
*
|
|
* @author Daniele Alessandri <suppakilla@gmail.com>
|
|
*/
|
|
interface ClientInterface extends BasicClientInterface
|
|
{
|
|
/**
|
|
* Returns the server profile used by the client.
|
|
*
|
|
* @return ServerProfileInterface
|
|
*/
|
|
public function getProfile();
|
|
|
|
/**
|
|
* Returns the client options specified upon initialization.
|
|
*
|
|
* @return OptionsInterface
|
|
*/
|
|
public function getOptions();
|
|
|
|
/**
|
|
* Opens the connection to the server.
|
|
*/
|
|
public function connect();
|
|
|
|
/**
|
|
* Disconnects from the server.
|
|
*/
|
|
public function disconnect();
|
|
|
|
/**
|
|
* Returns the underlying connection instance.
|
|
*
|
|
* @return ConnectionInterface
|
|
*/
|
|
public function getConnection();
|
|
|
|
/**
|
|
* Creates a new instance of the specified Redis command.
|
|
*
|
|
* @param string $method The name of a Redis command.
|
|
* @param array $arguments The arguments for the command.
|
|
* @return Command\CommandInterface
|
|
*/
|
|
public function createCommand($method, $arguments = array());
|
|
}
|