Files
predis/lib/Predis/Options/ClientCluster.php
T
Daniele Alessandri 4e6ed3f26d [phpdoc] Add API documentation.
This is a starting point to add a documentation of the whole set of APIs and
classes of Predis. The next step will be to actually improve and extend it.
2011-10-21 12:54:24 +02:00

81 lines
1.9 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\Options;
use Predis\Network\IConnectionCluster;
use Predis\Network\PredisCluster;
/**
* Option class that returns a connection cluster to be used by a client.
*
* @author Daniele Alessandri <suppakilla@gmail.com>
*/
class ClientCluster extends Option
{
/**
* Checks if the specified value is a valid instance of IConnectionCluster.
*
* @param IConnectionCluster $cluster Instance of a connection cluster.
* @return IConnectionCluster
*/
protected function checkInstance($cluster)
{
if (!$cluster instanceof IConnectionCluster) {
throw new \InvalidArgumentException(
'Instance of Predis\Network\IConnectionCluster expected'
);
}
return $cluster;
}
/**
* {@inheritdoc}
*/
public function validate($value)
{
if (is_callable($value)) {
return $this->checkInstance(call_user_func($value));
}
$initializer = $this->getInitializer($value);
return $this->checkInstance($initializer());
}
/**
* Returns an initializer for the specified FQN or type.
*
* @param string $fqnOrType Type of cluster of FQN of a class implementing IConnectionCluster
* @return \Closure
*/
protected function getInitializer($fqnOrType)
{
switch ($fqnOrType) {
case 'predis':
return function() { return new PredisCluster(); };
default:
return function() use($fqnOrType) {
return new $fqnOrType();
};
}
}
/**
* {@inheritdoc}
*/
public function getDefault()
{
return new PredisCluster();
}
}