interface/modules/zend_modules/library/Zend/Cache/Storage/Adapter/RedisOptions.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Cache\Storage\Adapter;
  11
  12 use Redis as RedisResource;
  13 use Zend\Cache\Exception;
  14 use Zend\Cache\Storage\Adapter\AdapterOptions;
  15
  16 class RedisOptions extends AdapterOptions
  17 {
  18     /**
  19      * The namespace separator
  20      * @var string
  21      */
  22     protected $namespaceSeparator = ':';
  23
  24     /**
  25      * The redis resource manager
  26      *
  27      * @var null|RedisResourceManager
  28      */
  29     protected $resourceManager;
  30
  31     /**
  32      * The resource id of the resource manager
  33      *
  34      * @var string
  35      */
  36     protected $resourceId = 'default';
  37
  38     /**
  39      * Set namespace.
  40      *
  41      * The option Redis::OPT_PREFIX will be used as the namespace.
  42      * It can't be longer than 128 characters.
  43      *
  44      * @param string $namespace Prefix for each key stored in redis
  45      * @return \Zend\Cache\Storage\Adapter\RedisOptions
  46      *
  47      * @see AdapterOptions::setNamespace()
  48      * @see RedisOptions::setPrefixKey()
  49      */
  50     public function setNamespace($namespace)
  51     {
  52         $namespace = (string) $namespace;
  53
  54         if (128 < strlen($namespace)) {
  55             throw new Exception\InvalidArgumentException(sprintf(
  56                 '%s expects a prefix key of no longer than 128 characters',
  57                 __METHOD__
  58             ));
  59         }
  60
  61         return parent::setNamespace($namespace);
  62     }
  63
  64     /**
  65      * Set namespace separator
  66      *
  67      * @param  string $namespaceSeparator
  68      * @return RedisOptions
  69      */
  70     public function setNamespaceSeparator($namespaceSeparator)
  71     {
  72         $namespaceSeparator = (string) $namespaceSeparator;
  73         if ($this->namespaceSeparator !== $namespaceSeparator) {
  74             $this->triggerOptionEvent('namespace_separator', $namespaceSeparator);
  75             $this->namespaceSeparator = $namespaceSeparator;
  76         }
  77         return $this;
  78     }
  79
  80     /**
  81      * Get namespace separator
  82      *
  83      * @return string
  84      */
  85     public function getNamespaceSeparator()
  86     {
  87         return $this->namespaceSeparator;
  88     }
  89
  90     /**
  91      * Set the redis resource manager to use
  92      *
  93      * @param null|RedisResourceManager $resourceManager
  94      * @return RedisOptions
  95      */
  96     public function setResourceManager(RedisResourceManager $resourceManager = null)
  97     {
  98         if ($this->resourceManager !== $resourceManager) {
  99             $this->triggerOptionEvent('resource_manager', $resourceManager);
 100             $this->resourceManager = $resourceManager;
 101         }
 102         return $this;
 103     }
 104
 105     /**
 106      * Get the redis resource manager
 107      *
 108      * @return RedisResourceManager
 109      */
 110     public function getResourceManager()
 111     {
 112         if (!$this->resourceManager) {
 113             $this->resourceManager = new RedisResourceManager();
 114         }
 115         return $this->resourceManager;
 116     }
 117
 118     /**
 119      * Get the redis resource id
 120      *
 121      * @return string
 122      */
 123     public function getResourceId()
 124     {
 125         return $this->resourceId;
 126     }
 127
 128     /**
 129      * Set the redis resource id
 130      *
 131      * @param string $resourceId
 132      * @return RedisOptions
 133      */
 134     public function setResourceId($resourceId)
 135     {
 136         $resourceId = (string) $resourceId;
 137         if ($this->resourceId !== $resourceId) {
 138             $this->triggerOptionEvent('resource_id', $resourceId);
 139             $this->resourceId = $resourceId;
 140         }
 141         return $this;
 142     }
 143
 144     /**
 145      * Get the persistent id
 146      *
 147      * @return string
 148      */
 149     public function getPersistentId()
 150     {
 151         return $this->getResourceManager()->getPersistentId($this->getResourceId());
 152     }
 153
 154     /**
 155      * Set the persistent id
 156      *
 157      * @param string $persistentId
 158      * @return RedisOptions
 159      */
 160     public function setPersistentId($persistentId)
 161     {
 162         $this->triggerOptionEvent('persistent_id', $persistentId);
 163         $this->getResourceManager()->setPersistentId($this->getResourceId(), $persistentId);
 164         return $this;
 165     }
 166
 167      /**
 168     * Set redis options
 169     *
 170     * @param array $libOptions
 171     * @return RedisOptions
 172     * @link http://github.com/nicolasff/phpredis#setoption
 173     */
 174     public function setLibOptions(array $libOptions)
 175     {
 176         $this->triggerOptionEvent('lib_option', $libOptions);
 177         $this->getResourceManager()->setLibOptions($this->getResourceId(), $libOptions);
 178         return $this;
 179     }
 180
 181     /**
 182      * Get redis options
 183      *
 184      * @return array
 185      * @link http://github.com/nicolasff/phpredis#setoption
 186      */
 187     public function getLibOptions()
 188     {
 189         return $this->getResourceManager()->getLibOptions($this->getResourceId());
 190     }
 191
 192     /**
 193      * Set server
 194      *
 195      * Server can be described as follows:
 196      * - URI:   /path/to/sock.sock
 197      * - Assoc: array('host' => <host>[, 'port' => <port>[, 'timeout' => <timeout>]])
 198      * - List:  array(<host>[, <port>, [, <timeout>]])
 199      *
 200      * @param string|array $server
 201      *
 202      * @return RedisOptions
 203      */
 204     public function setServer($server)
 205     {
 206         $this->getResourceManager()->setServer($this->getResourceId(), $server);
 207         return $this;
 208     }
 209
 210     /**
 211      * Get server
 212      *
 213      * @return array array('host' => <host>[, 'port' => <port>[, 'timeout' => <timeout>]])
 214      */
 215     public function getServer()
 216     {
 217         return $this->getResourceManager()->getServer($this->getResourceId());
 218     }
 219
 220     /**
 221      * Set resource database number
 222      *
 223      * @param int $database Database number
 224      *
 225      * @return RedisOptions
 226      */
 227     public function setDatabase($database)
 228     {
 229         $this->getResourceManager()->setDatabase($this->getResourceId(), $database);
 230         return $this;
 231     }
 232
 233     /**
 234      * Get resource database number
 235      *
 236      * @return int Database number
 237      */
 238     public function getDatabase()
 239     {
 240         return $this->getResourceManager()->getDatabase($this->getResourceId());
 241     }
 242
 243     /**
 244      * Set resource password
 245      *
 246      * @param string $password Password
 247      *
 248      * @return RedisOptions
 249      */
 250     public function setPassword($password)
 251     {
 252         $this->getResourceManager()->setPassword($this->getResourceId(), $password);
 253         return $this;
 254     }
 255
 256     /**
 257      * Get resource password
 258      *
 259      * @return string
 260      */
 261     public function getPassword()
 262     {
 263         return $this->getResourceManager()->getPassword($this->getResourceId());
 264     }
 265 }