vendor/predis/predis/src/Profile/RedisProfile.php line 83

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Predis package.
  5.  *
  6.  * (c) Daniele Alessandri <suppakilla@gmail.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Predis\Profile;
  14. use Predis\ClientException;
  15. use Predis\Command\Processor\ProcessorInterface;
  17. /**
  18.  * Base class implementing common functionalities for Redis server profiles.
  19.  *
  20.  * @author Daniele Alessandri <suppakilla@gmail.com>
  21.  */
  22. abstract class RedisProfile implements ProfileInterface
  23. {
  24.     private $commands;
  25.     private $processor;
  27.     /**
  28.      *
  29.      */
  30.     public function __construct()
  31.     {
  32.         $this->commands = $this->getSupportedCommands();
  33.     }
  35.     /**
  36.      * Returns a map of all the commands supported by the profile and their
  37.      * actual PHP classes.
  38.      *
  39.      * @return array
  40.      */
  41.     abstract protected function getSupportedCommands();
  43.     /**
  44.      * {@inheritdoc}
  45.      */
  46.     public function supportsCommand($commandID)
  47.     {
  48.         return isset($this->commands[strtoupper($commandID)]);
  49.     }
  51.     /**
  52.      * {@inheritdoc}
  53.      */
  54.     public function supportsCommands(array $commandIDs)
  55.     {
  56.         foreach ($commandIDs as $commandID) {
  57.             if (!$this->supportsCommand($commandID)) {
  58.                 return false;
  59.             }
  60.         }
  62.         return true;
  63.     }
  65.     /**
  66.      * Returns the fully-qualified name of a class representing the specified
  67.      * command ID registered in the current server profile.
  68.      *
  69.      * @param string $commandID Command ID.
  70.      *
  71.      * @return string|null
  72.      */
  73.     public function getCommandClass($commandID)
  74.     {
  75.         if (isset($this->commands[$commandID = strtoupper($commandID)])) {
  76.             return $this->commands[$commandID];
  77.         }
  78.     }
  80.     /**
  81.      * {@inheritdoc}
  82.      */
  83.     public function createCommand($commandID, array $arguments = array())
  84.     {
  85.         $commandID = strtoupper($commandID);
  87.         if (!isset($this->commands[$commandID])) {
  88.             throw new ClientException("Command '$commandID' is not a registered Redis command.");
  89.         }
  91.         $commandClass = $this->commands[$commandID];
  92.         $command = new $commandClass();
  93.         $command->setArguments($arguments);
  95.         if (isset($this->processor)) {
  96.             $this->processor->process($command);
  97.         }
  99.         return $command;
  100.     }
  102.     /**
  103.      * Defines a new command in the server profile.
  104.      *
  105.      * @param string $commandID Command ID.
  106.      * @param string $class     Fully-qualified name of a Predis\Command\CommandInterface.
  107.      *
  108.      * @throws \InvalidArgumentException
  109.      */
  110.     public function defineCommand($commandID, $class)
  111.     {
  112.         $reflection = new \ReflectionClass($class);
  114.         if (!$reflection->isSubclassOf('Predis\Command\CommandInterface')) {
  115.             throw new \InvalidArgumentException("The class '$class' is not a valid command class.");
  116.         }
  118.         $this->commands[strtoupper($commandID)] = $class;
  119.     }
  121.     /**
  122.      * {@inheritdoc}
  123.      */
  124.     public function setProcessor(ProcessorInterface $processor = null)
  125.     {
  126.         $this->processor = $processor;
  127.     }
  129.     /**
  130.      * {@inheritdoc}
  131.      */
  132.     public function getProcessor()
  133.     {
  134.         return $this->processor;
  135.     }
  137.     /**
  138.      * Returns the version of server profile as its string representation.
  139.      *
  140.      * @return string
  141.      */
  142.     public function __toString()
  143.     {
  144.         return $this->getVersion();
  145.     }
  146. }