vendor/zendframework/zend-cache/src/Storage/Adapter/MongoDbOptions.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 class MongoDbOptions extends AdapterOptions
  13 {
  14     // @codingStandardsIgnoreStart
  15     /**
  16      * Prioritized properties ordered by prio to be set first
  17      * in case a bulk of options sets set at once
  18      *
  19      * @var string[]
  20      */
  21     protected $__prioritizedProperties__ = ['resource_manager', 'resource_id'];
  22     // @codingStandardsIgnoreEnd
  23
  24     /**
  25      * The namespace separator
  26      *
  27      * @var string
  28      */
  29     private $namespaceSeparator = ':';
  30
  31     /**
  32      * The mongo DB resource manager
  33      *
  34      * @var null|MongoDbResourceManager
  35      */
  36     private $resourceManager;
  37
  38     /**
  39      * The resource id of the resource manager
  40      *
  41      * @var string
  42      */
  43     private $resourceId = 'default';
  44
  45     /**
  46      * Set namespace separator
  47      *
  48      * @param  string $namespaceSeparator
  49      *
  50      * @return MongoDbOptions Provides a fluent interface
  51      */
  52     public function setNamespaceSeparator($namespaceSeparator)
  53     {
  54         $namespaceSeparator = (string) $namespaceSeparator;
  55
  56         if ($this->namespaceSeparator !== $namespaceSeparator) {
  57             $this->triggerOptionEvent('namespace_separator', $namespaceSeparator);
  58
  59             $this->namespaceSeparator = $namespaceSeparator;
  60         }
  61
  62         return $this;
  63     }
  64
  65     /**
  66      * Get namespace separator
  67      *
  68      * @return string
  69      */
  70     public function getNamespaceSeparator()
  71     {
  72         return $this->namespaceSeparator;
  73     }
  74
  75     /**
  76      * Set the mongodb resource manager to use
  77      *
  78      * @param null|MongoDbResourceManager $resourceManager
  79      *
  80      * @return MongoDbOptions Provides a fluent interface
  81      */
  82     public function setResourceManager(MongoDbResourceManager $resourceManager = null)
  83     {
  84         if ($this->resourceManager !== $resourceManager) {
  85             $this->triggerOptionEvent('resource_manager', $resourceManager);
  86
  87             $this->resourceManager = $resourceManager;
  88         }
  89
  90         return $this;
  91     }
  92
  93     /**
  94      * Get the mongodb resource manager
  95      *
  96      * @return MongoDbResourceManager
  97      */
  98     public function getResourceManager()
  99     {
 100         return $this->resourceManager ?: $this->resourceManager = new MongoDbResourceManager();
 101     }
 102
 103     /**
 104      * Get the mongodb resource id
 105      *
 106      * @return string
 107      */
 108     public function getResourceId()
 109     {
 110         return $this->resourceId;
 111     }
 112
 113     /**
 114      * Set the mongodb resource id
 115      *
 116      * @param string $resourceId
 117      *
 118      * @return MongoDbOptions Provides a fluent interface
 119      */
 120     public function setResourceId($resourceId)
 121     {
 122         $resourceId = (string) $resourceId;
 123
 124         if ($this->resourceId !== $resourceId) {
 125             $this->triggerOptionEvent('resource_id', $resourceId);
 126
 127             $this->resourceId = $resourceId;
 128         }
 129
 130         return $this;
 131     }
 132
 133     /**
 134      * Set the mongo DB server
 135      *
 136      * @param string $server
 137      *
 138      * @return MongoDbOptions Provides a fluent interface
 139      */
 140     public function setServer($server)
 141     {
 142         $this->getResourceManager()->setServer($this->getResourceId(), $server);
 143         return $this;
 144     }
 145
 146     /**
 147      *
 148      *
 149      * @param array $connectionOptions
 150      *
 151      * @return MongoDbOptions Provides a fluent interface
 152      */
 153     public function setConnectionOptions(array $connectionOptions)
 154     {
 155         $this->getResourceManager()->setConnectionOptions($this->getResourceId(), $connectionOptions);
 156         return $this;
 157     }
 158
 159     /**
 160      *
 161      *
 162      * @param array $driverOptions
 163     MongoDbOptions
 164      * @return MongoDbOptions Provides a fluent interface
 165      */
 166     public function setDriverOptions(array $driverOptions)
 167     {
 168         $this->getResourceManager()->setDriverOptions($this->getResourceId(), $driverOptions);
 169         return $this;
 170     }
 171
 172     /**
 173      *
 174      *
 175      * @param string $database
 176      *
 177      * @return MongoDbOptions Provides a fluent interface
 178      */
 179     public function setDatabase($database)
 180     {
 181         $this->getResourceManager()->setDatabase($this->getResourceId(), $database);
 182         return $this;
 183     }
 184
 185     /**
 186      *
 187      *
 188      * @param string $collection
 189      *
 190      * @return MongoDbOptions Provides a fluent interface
 191      */
 192     public function setCollection($collection)
 193     {
 194         $this->getResourceManager()->setCollection($this->getResourceId(), $collection);
 195         return $this;
 196     }
 197 }