interface/modules/zend_modules/library/Zend/Session/SaveHandler/MongoDBOptions.php

   1 <?php
   2
   3 /**
   4  * Zend Framework (http://framework.zend.com/)
   5  *
   6  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   7  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   8  * @license   http://framework.zend.com/license/new-bsd New BSD License
   9  */
  10
  11 namespace Zend\Session\SaveHandler;
  12
  13 use Zend\Session\Exception\InvalidArgumentException;
  14 use Zend\Stdlib\AbstractOptions;
  15
  16 /**
  17  * MongoDB session save handler Options
  18  */
  19 class MongoDBOptions extends AbstractOptions
  20 {
  21     /**
  22      * Database name
  23      *
  24      * @var string
  25      */
  26     protected $database;
  27
  28     /**
  29      * Collection name
  30      *
  31      * @var string
  32      */
  33     protected $collection;
  34
  35     /**
  36      * Save options
  37      *
  38      * @see http://php.net/manual/en/mongocollection.save.php
  39      * @var string
  40      */
  41     protected $saveOptions = array('safe' => true);
  42
  43     /**
  44      * Name field
  45      *
  46      * @var string
  47      */
  48     protected $nameField = 'name';
  49
  50     /**
  51      * Data field
  52      *
  53      * @var string
  54      */
  55     protected $dataField = 'data';
  56
  57     /**
  58      * Lifetime field
  59      *
  60      * @var string
  61      */
  62     protected $lifetimeField = 'lifetime';
  63
  64     /**
  65      * Modified field
  66      *
  67      * @var string
  68      */
  69     protected $modifiedField = 'modified';
  70
  71     /**
  72      * Set database name
  73      *
  74      * @param string $database
  75      * @return MongoDBOptions
  76      * @throws InvalidArgumentException
  77      */
  78     public function setDatabase($database)
  79     {
  80         $database = (string) $database;
  81         if (strlen($database) === 0) {
  82             throw new InvalidArgumentException('$database must be a non-empty string');
  83         }
  84         $this->database = $database;
  85         return $this;
  86     }
  87
  88     /**
  89      * Get database name
  90      *
  91      * @return string
  92      */
  93     public function getDatabase()
  94     {
  95         return $this->database;
  96     }
  97
  98     /**
  99      * Set collection name
 100      *
 101      * @param string $collection
 102      * @return MongoDBOptions
 103      * @throws InvalidArgumentException
 104      */
 105     public function setCollection($collection)
 106     {
 107         $collection = (string) $collection;
 108         if (strlen($collection) === 0) {
 109             throw new InvalidArgumentException('$collection must be a non-empty string');
 110         }
 111         $this->collection = $collection;
 112         return $this;
 113     }
 114
 115     /**
 116      * Get collection name
 117      *
 118      * @return string
 119      */
 120     public function getCollection()
 121     {
 122         return $this->collection;
 123     }
 124
 125     /**
 126      * Set save options
 127      *
 128      * @see http://php.net/manual/en/mongocollection.save.php
 129      * @param array $saveOptions
 130      * @return MongoDBOptions
 131      */
 132     public function setSaveOptions(array $saveOptions)
 133     {
 134         $this->saveOptions = $saveOptions;
 135         return $this;
 136     }
 137
 138     /**
 139      * Get save options
 140      *
 141      * @return string
 142      */
 143     public function getSaveOptions()
 144     {
 145         return $this->saveOptions;
 146     }
 147
 148     /**
 149      * Set name field
 150      *
 151      * @param string $nameField
 152      * @return MongoDBOptions
 153      * @throws InvalidArgumentException
 154      */
 155     public function setNameField($nameField)
 156     {
 157         $nameField = (string) $nameField;
 158         if (strlen($nameField) === 0) {
 159             throw new InvalidArgumentException('$nameField must be a non-empty string');
 160         }
 161         $this->nameField = $nameField;
 162         return $this;
 163     }
 164
 165     /**
 166      * Get name field
 167      *
 168      * @return string
 169      */
 170     public function getNameField()
 171     {
 172         return $this->nameField;
 173     }
 174
 175     /**
 176      * Set data field
 177      *
 178      * @param string $dataField
 179      * @return MongoDBOptions
 180      * @throws InvalidArgumentException
 181      */
 182     public function setDataField($dataField)
 183     {
 184         $dataField = (string) $dataField;
 185         if (strlen($dataField) === 0) {
 186             throw new InvalidArgumentException('$dataField must be a non-empty string');
 187         }
 188         $this->dataField = $dataField;
 189         return $this;
 190     }
 191
 192     /**
 193      * Get data field
 194      *
 195      * @return string
 196      */
 197     public function getDataField()
 198     {
 199         return $this->dataField;
 200     }
 201
 202     /**
 203      * Set lifetime field
 204      *
 205      * @param string $lifetimeField
 206      * @return MongoDBOptions
 207      * @throws InvalidArgumentException
 208      */
 209     public function setLifetimeField($lifetimeField)
 210     {
 211         $lifetimeField = (string) $lifetimeField;
 212         if (strlen($lifetimeField) === 0) {
 213             throw new InvalidArgumentException('$lifetimeField must be a non-empty string');
 214         }
 215         $this->lifetimeField = $lifetimeField;
 216         return $this;
 217     }
 218
 219     /**
 220      * Get lifetime Field
 221      *
 222      * @return string
 223      */
 224     public function getLifetimeField()
 225     {
 226         return $this->lifetimeField;
 227     }
 228
 229     /**
 230      * Set Modified Field
 231      *
 232      * @param string $modifiedField
 233      * @return MongoDBOptions
 234      * @throws InvalidArgumentException
 235      */
 236     public function setModifiedField($modifiedField)
 237     {
 238         $modifiedField = (string) $modifiedField;
 239         if (strlen($modifiedField) === 0) {
 240             throw new InvalidArgumentException('$modifiedField must be a non-empty string');
 241         }
 242         $this->modifiedField = $modifiedField;
 243         return $this;
 244     }
 245
 246     /**
 247      * Get modified Field
 248      *
 249      * @return string
 250      */
 251     public function getModifiedField()
 252     {
 253         return $this->modifiedField;
 254     }
 255 }