vendor/zendframework/zend-cache/src/Storage/Adapter/ExtMongoDbResourceManager.php

   1 <?php
   2 /**
   3  * @see       https://github.com/zendframework/zend-cache for the canonical source repository
   4  * @copyright Copyright (c) 2018 Zend Technologies USA Inc. (https://www.zend.com)
   5  * @license   https://github.com/zendframework/zend-cache/blob/master/LICENSE.md New BSD License
   6  */
   7
   8 namespace Zend\Cache\Storage\Adapter;
   9
  10 use MongoDB\Client;
  11 use MongoDB\Collection;
  12 use MongoDB\Driver\Exception\Exception as MongoDriverException;
  13 use Zend\Cache\Exception;
  14
  15 /**
  16  * Resource manager for the ext-mongodb adapter.
  17  *
  18  * If you are using ext-mongo, use the MongoDbResourceManager instead.
  19  */
  20 class ExtMongoDbResourceManager
  21 {
  22     /**
  23      * Registered resources
  24      *
  25      * @var array[]
  26      */
  27     private $resources = [];
  28
  29     /**
  30      * Check if a resource exists
  31      *
  32      * @param string $id
  33      *
  34      * @return bool
  35      */
  36     public function hasResource($id)
  37     {
  38         return isset($this->resources[$id]);
  39     }
  40
  41     /**
  42      * Set a resource
  43      *
  44      * @param string $id
  45      * @param array|Collection $resource
  46      * @return self Provides a fluent interface
  47      * @throws Exception\RuntimeException
  48      */
  49     public function setResource($id, $resource)
  50     {
  51         if ($resource instanceof Collection) {
  52             $this->resources[$id] = [
  53                 'db'                  => (string) $resource->db,
  54                 'db_instance'         => $resource->db,
  55                 'collection'          => (string) $resource,
  56                 'collection_instance' => $resource,
  57             ];
  58             return $this;
  59         }
  60
  61         if (! is_array($resource)) {
  62             throw new Exception\InvalidArgumentException(sprintf(
  63                 '%s expects an array or %s; received %s',
  64                 __METHOD__,
  65                 Collection::class,
  66                 is_object($resource) ? get_class($resource) : gettype($resource)
  67             ));
  68         }
  69
  70         $this->resources[$id] = $resource;
  71         return $this;
  72     }
  73
  74     /**
  75      * Instantiate and return the Collection resource
  76      *
  77      * @param string $id
  78      * @return Collection
  79      * @throws Exception\RuntimeException
  80      */
  81     public function getResource($id)
  82     {
  83         if (! $this->hasResource($id)) {
  84             throw new Exception\RuntimeException("No resource with id '{$id}'");
  85         }
  86
  87         $resource = $this->resources[$id];
  88         if (! isset($resource['collection_instance'])) {
  89             try {
  90                 if (! isset($resource['db_instance'])) {
  91                     if (! isset($resource['client_instance'])) {
  92                         $resource['client_instance'] = new Client(
  93                             isset($resource['server']) ? $resource['server'] : null,
  94                             isset($resource['connection_options']) ? $resource['connection_options'] : [],
  95                             isset($resource['driver_options']) ? $resource['driver_options'] : []
  96                         );
  97                     }
  98                 }
  99
 100                 $collection = $resource['client_instance']->selectCollection(
 101                     isset($resouce['db']) ? $resource['db'] : 'zend',
 102                     isset($resource['collection']) ? $resource['collection'] : 'cache'
 103                 );
 104                 $collection->createIndex(['key' => 1]);
 105
 106                 $this->resources[$id]['collection_instance'] = $collection;
 107             } catch (MongoDriverException $e) {
 108                 throw new Exception\RuntimeException($e->getMessage(), $e->getCode(), $e);
 109             }
 110         }
 111
 112         return $this->resources[$id]['collection_instance'];
 113     }
 114
 115     /**
 116      * @param string $id
 117      * @param string $server
 118      * @return void
 119      */
 120     public function setServer($id, $server)
 121     {
 122         $this->resources[$id]['server'] = (string) $server;
 123
 124         unset($this->resources[$id]['client_instance']);
 125         unset($this->resources[$id]['db_instance']);
 126         unset($this->resources[$id]['collection_instance']);
 127     }
 128
 129     /**
 130      * @param string $id
 131      * @return null|string
 132      * @throws Exception\RuntimeException if no matching resource discovered
 133      */
 134     public function getServer($id)
 135     {
 136         if (! $this->hasResource($id)) {
 137             throw new Exception\RuntimeException("No resource with id '{$id}'");
 138         }
 139
 140         return isset($this->resources[$id]['server']) ? $this->resources[$id]['server'] : null;
 141     }
 142
 143     /**
 144      * @param string $id
 145      * @param array $connectionOptions
 146      * @return void
 147      */
 148     public function setConnectionOptions($id, array $connectionOptions)
 149     {
 150         $this->resources[$id]['connection_options'] = $connectionOptions;
 151
 152         unset($this->resources[$id]['client_instance']);
 153         unset($this->resources[$id]['db_instance']);
 154         unset($this->resources[$id]['collection_instance']);
 155     }
 156
 157     /**
 158      * @param string $id
 159      * @return array
 160      * @throws Exception\RuntimeException if no matching resource discovered
 161      */
 162     public function getConnectionOptions($id)
 163     {
 164         if (! $this->hasResource($id)) {
 165             throw new Exception\RuntimeException("No resource with id '{$id}'");
 166         }
 167
 168         return isset($this->resources[$id]['connection_options'])
 169             ? $this->resources[$id]['connection_options']
 170             : [];
 171     }
 172
 173     /**
 174      * @param string $id
 175      * @param array $driverOptions
 176      * @return void
 177      */
 178     public function setDriverOptions($id, array $driverOptions)
 179     {
 180         $this->resources[$id]['driver_options'] = $driverOptions;
 181
 182         unset($this->resources[$id]['client_instance']);
 183         unset($this->resources[$id]['db_instance']);
 184         unset($this->resources[$id]['collection_instance']);
 185     }
 186
 187     /**
 188      * @param string $id
 189      * @return array
 190      * @throws Exception\RuntimeException if no matching resource discovered
 191      */
 192     public function getDriverOptions($id)
 193     {
 194         if (! $this->hasResource($id)) {
 195             throw new Exception\RuntimeException("No resource with id '{$id}'");
 196         }
 197
 198         return isset($this->resources[$id]['driver_options']) ? $this->resources[$id]['driver_options'] : [];
 199     }
 200
 201     /**
 202      * @param string $id
 203      * @param string $database
 204      * @return void
 205      */
 206     public function setDatabase($id, $database)
 207     {
 208         $this->resources[$id]['db'] = (string) $database;
 209
 210         unset($this->resources[$id]['db_instance']);
 211         unset($this->resources[$id]['collection_instance']);
 212     }
 213
 214     /**
 215      * @param string $id
 216      * @return string
 217      * @throws Exception\RuntimeException if no matching resource discovered
 218      */
 219     public function getDatabase($id)
 220     {
 221         if (! $this->hasResource($id)) {
 222             throw new Exception\RuntimeException("No resource with id '{$id}'");
 223         }
 224
 225         return isset($this->resources[$id]['db']) ? $this->resources[$id]['db'] : '';
 226     }
 227
 228     /**
 229      * @param string $id
 230      * @param string $collection
 231      * @return void
 232      */
 233     public function setCollection($id, $collection)
 234     {
 235         $this->resources[$id]['collection'] = (string) $collection;
 236
 237         unset($this->resources[$id]['collection_instance']);
 238     }
 239
 240     /**
 241      * @param string $id
 242      * @return string
 243      * @throws Exception\RuntimeException if no matching resource discovered
 244      */
 245     public function getCollection($id)
 246     {
 247         if (! $this->hasResource($id)) {
 248             throw new Exception\RuntimeException("No resource with id '{$id}'");
 249         }
 250
 251         return isset($this->resources[$id]['collection']) ? $this->resources[$id]['collection'] : '';
 252     }
 253 }