vendor/zendframework/zend-cache/src/Storage/Adapter/MemcachedOptions.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-2016 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 Memcached as MemcachedResource;
  13 use Zend\Cache\Exception;
  14
  15 /**
  16  * These are options specific to the Memcached adapter
  17  */
  18 class MemcachedOptions extends AdapterOptions
  19 {
  20     // @codingStandardsIgnoreStart
  21     /**
  22      * Prioritized properties ordered by prio to be set first
  23      * in case a bulk of options sets set at once
  24      *
  25      * @var string[]
  26      */
  27     protected $__prioritizedProperties__ = ['resource_manager', 'resource_id'];
  28     // @codingStandardsIgnoreEnd
  29
  30     /**
  31      * The namespace separator
  32      * @var string
  33      */
  34     protected $namespaceSeparator = ':';
  35
  36     /**
  37      * The memcached resource manager
  38      *
  39      * @var null|MemcachedResourceManager
  40      */
  41     protected $resourceManager;
  42
  43     /**
  44      * The resource id of the resource manager
  45      *
  46      * @var string
  47      */
  48     protected $resourceId = 'default';
  49
  50     /**
  51      * Set namespace.
  52      *
  53      * The option Memcached::OPT_PREFIX_KEY will be used as the namespace.
  54      * It can't be longer than 128 characters.
  55      *
  56      * @see AdapterOptions::setNamespace()
  57      * @see MemcachedOptions::setPrefixKey()
  58      */
  59     public function setNamespace($namespace)
  60     {
  61         $namespace = (string) $namespace;
  62
  63         if (128 < strlen($namespace)) {
  64             throw new Exception\InvalidArgumentException(sprintf(
  65                 '%s expects a prefix key of no longer than 128 characters',
  66                 __METHOD__
  67             ));
  68         }
  69
  70         return parent::setNamespace($namespace);
  71     }
  72
  73     /**
  74      * Set namespace separator
  75      *
  76      * @param  string $namespaceSeparator
  77      * @return MemcachedOptions
  78      */
  79     public function setNamespaceSeparator($namespaceSeparator)
  80     {
  81         $namespaceSeparator = (string) $namespaceSeparator;
  82         if ($this->namespaceSeparator !== $namespaceSeparator) {
  83             $this->triggerOptionEvent('namespace_separator', $namespaceSeparator);
  84             $this->namespaceSeparator = $namespaceSeparator;
  85         }
  86         return $this;
  87     }
  88
  89     /**
  90      * Get namespace separator
  91      *
  92      * @return string
  93      */
  94     public function getNamespaceSeparator()
  95     {
  96         return $this->namespaceSeparator;
  97     }
  98
  99     /**
 100      * A memcached resource to share
 101      *
 102      * @param null|MemcachedResource $memcachedResource
 103      * @return MemcachedOptions
 104      * @deprecated Please use the resource manager instead
 105      */
 106     public function setMemcachedResource(MemcachedResource $memcachedResource = null)
 107     {
 108         trigger_error(
 109             'This method is deprecated and will be removed in the feature'
 110             . ', please use the resource manager instead',
 111             E_USER_DEPRECATED
 112         );
 113
 114         if ($memcachedResource !== null) {
 115             $this->triggerOptionEvent('memcached_resource', $memcachedResource);
 116             $resourceManager = $this->getResourceManager();
 117             $resourceId      = $this->getResourceId();
 118             $resourceManager->setResource($resourceId, $memcachedResource);
 119         }
 120         return $this;
 121     }
 122
 123     /**
 124      * Get memcached resource to share
 125      *
 126      * @return MemcachedResource
 127      * @deprecated Please use the resource manager instead
 128      */
 129     public function getMemcachedResource()
 130     {
 131         trigger_error(
 132             'This method is deprecated and will be removed in the feature'
 133             . ', please use the resource manager instead',
 134             E_USER_DEPRECATED
 135         );
 136
 137         return $this->resourceManager->getResource($this->getResourceId());
 138     }
 139
 140     /**
 141      * Set the memcached resource manager to use
 142      *
 143      * @param null|MemcachedResourceManager $resourceManager
 144      * @return MemcachedOptions
 145      */
 146     public function setResourceManager(MemcachedResourceManager $resourceManager = null)
 147     {
 148         if ($this->resourceManager !== $resourceManager) {
 149             $this->triggerOptionEvent('resource_manager', $resourceManager);
 150             $this->resourceManager = $resourceManager;
 151         }
 152         return $this;
 153     }
 154
 155     /**
 156      * Get the memcached resource manager
 157      *
 158      * @return MemcachedResourceManager
 159      */
 160     public function getResourceManager()
 161     {
 162         if (! $this->resourceManager) {
 163             $this->resourceManager = new MemcachedResourceManager();
 164         }
 165         return $this->resourceManager;
 166     }
 167
 168     /**
 169      * Get the memcached resource id
 170      *
 171      * @return string
 172      */
 173     public function getResourceId()
 174     {
 175         return $this->resourceId;
 176     }
 177
 178     /**
 179      * Set the memcached resource id
 180      *
 181      * @param string $resourceId
 182      * @return MemcachedOptions
 183      */
 184     public function setResourceId($resourceId)
 185     {
 186         $resourceId = (string) $resourceId;
 187         if ($this->resourceId !== $resourceId) {
 188             $this->triggerOptionEvent('resource_id', $resourceId);
 189             $this->resourceId = $resourceId;
 190         }
 191         return $this;
 192     }
 193
 194     /**
 195      * Get the persistent id
 196      *
 197      * @return string
 198      */
 199     public function getPersistentId()
 200     {
 201         return $this->getResourceManager()->getPersistentId($this->getResourceId());
 202     }
 203
 204     /**
 205      * Set the persistent id
 206      *
 207      * @param string $persistentId
 208      * @return MemcachedOptions
 209      */
 210     public function setPersistentId($persistentId)
 211     {
 212         $this->triggerOptionEvent('persistent_id', $persistentId);
 213         $this->getResourceManager()->setPersistentId($this->getResourceId(), $persistentId);
 214         return $this;
 215     }
 216
 217     /**
 218      * Add a server to the list
 219      *
 220      * @param string $host
 221      * @param int $port
 222      * @param int $weight
 223      * @return MemcachedOptions
 224      * @deprecated Please use the resource manager instead
 225      */
 226     public function addServer($host, $port = 11211, $weight = 0)
 227     {
 228         trigger_error(
 229             'This method is deprecated and will be removed in the feature'
 230             . ', please use the resource manager instead',
 231             E_USER_DEPRECATED
 232         );
 233
 234         $this->getResourceManager()->addServer($this->getResourceId(), [
 235             'host'   => $host,
 236             'port'   => $port,
 237             'weight' => $weight
 238         ]);
 239
 240         return $this;
 241     }
 242
 243     /**
 244     * Set a list of memcached servers to add on initialize
 245     *
 246     * @param string|array $servers list of servers
 247     * @return MemcachedOptions
 248     * @throws Exception\InvalidArgumentException
 249     */
 250     public function setServers($servers)
 251     {
 252         $this->getResourceManager()->setServers($this->getResourceId(), $servers);
 253         return $this;
 254     }
 255
 256     /**
 257      * Get Servers
 258      *
 259      * @return array
 260      */
 261     public function getServers()
 262     {
 263         return $this->getResourceManager()->getServers($this->getResourceId());
 264     }
 265
 266     /**
 267     * Set libmemcached options
 268     *
 269     * @param array $libOptions
 270     * @return MemcachedOptions
 271     * @link http://php.net/manual/memcached.constants.php
 272     */
 273     public function setLibOptions(array $libOptions)
 274     {
 275         $this->getResourceManager()->setLibOptions($this->getResourceId(), $libOptions);
 276         return $this;
 277     }
 278
 279     /**
 280      * Set libmemcached option
 281      *
 282      * @param string|int $key
 283      * @param mixed $value
 284      * @return MemcachedOptions
 285      * @link http://php.net/manual/memcached.constants.php
 286      * @deprecated Please use lib_options or the resource manager instead
 287      */
 288     public function setLibOption($key, $value)
 289     {
 290         trigger_error(
 291             'This method is deprecated and will be removed in the feature'
 292             . ', please use "lib_options" or the resource manager instead',
 293             E_USER_DEPRECATED
 294         );
 295
 296         $this->getResourceManager()->setLibOption($this->getResourceId(), $key, $value);
 297         return $this;
 298     }
 299
 300     /**
 301      * Get libmemcached options
 302      *
 303      * @return array
 304      * @link http://php.net/manual/memcached.constants.php
 305      */
 306     public function getLibOptions()
 307     {
 308         return $this->getResourceManager()->getLibOptions($this->getResourceId());
 309     }
 310
 311     /**
 312     * Get libmemcached option
 313     *
 314     * @param string|int $key
 315     * @return mixed
 316     * @link http://php.net/manual/memcached.constants.php
 317     * @deprecated Please use lib_options or the resource manager instead
 318     */
 319     public function getLibOption($key)
 320     {
 321         trigger_error(
 322             'This method is deprecated and will be removed in the feature'
 323             . ', please use "lib_options" or the resource manager instead',
 324             E_USER_DEPRECATED
 325         );
 326
 327         return $this->getResourceManager()->getLibOption($this->getResourceId(), $key);
 328     }
 329 }