vendor/zendframework/zend-cache/src/Storage/Adapter/DbaOptions.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 Zend\Cache\Exception;
  13
  14 /**
  15  * These are options specific to the APC adapter
  16  */
  17 class DbaOptions extends AdapterOptions
  18 {
  19     /**
  20      * Namespace separator
  21      *
  22      * @var string
  23      */
  24     protected $namespaceSeparator = ':';
  25
  26     /**
  27      * Pathname to the database file
  28      *
  29      * @var string
  30      */
  31     protected $pathname = '';
  32
  33     /**
  34      * The mode to open the database
  35      *
  36      * @var string
  37      */
  38     protected $mode = 'c';
  39
  40     /**
  41      * The name of the handler which shall be used for accessing the database.
  42      *
  43      * @var string
  44      */
  45     protected $handler = 'flatfile';
  46
  47     /**
  48      * Set namespace separator
  49      *
  50      * @param  string $namespaceSeparator
  51      * @return DbaOptions Provides a fluent interface
  52      */
  53     public function setNamespaceSeparator($namespaceSeparator)
  54     {
  55         $namespaceSeparator = (string) $namespaceSeparator;
  56         $this->triggerOptionEvent('namespace_separator', $namespaceSeparator);
  57         $this->namespaceSeparator = $namespaceSeparator;
  58         return $this;
  59     }
  60
  61     /**
  62      * Get namespace separator
  63      *
  64      * @return string
  65      */
  66     public function getNamespaceSeparator()
  67     {
  68         return $this->namespaceSeparator;
  69     }
  70
  71     /**
  72      * Set pathname to database file
  73      *
  74      * @param string $pathname
  75      * @return DbaOptions Provides a fluent interface
  76      */
  77     public function setPathname($pathname)
  78     {
  79         $this->pathname = (string) $pathname;
  80         $this->triggerOptionEvent('pathname', $pathname);
  81         return $this;
  82     }
  83
  84     /**
  85      * Get pathname to database file
  86      *
  87      * @return string
  88      */
  89     public function getPathname()
  90     {
  91         return $this->pathname;
  92     }
  93
  94     /**
  95      *
  96      *
  97      * @param string $mode
  98      * @return DbaOptions Provides a fluent interface
  99      */
 100     public function setMode($mode)
 101     {
 102         $this->mode = (string) $mode;
 103         $this->triggerOptionEvent('mode', $mode);
 104         return $this;
 105     }
 106
 107     public function getMode()
 108     {
 109         return $this->mode;
 110     }
 111
 112     /**
 113      *
 114      *
 115      * @param string $handler
 116      * @return DbaOptions Provides a fluent interface
 117      */
 118     public function setHandler($handler)
 119     {
 120         $handler = (string) $handler;
 121
 122         if (! function_exists('dba_handlers') || ! in_array($handler, dba_handlers())) {
 123             throw new Exception\ExtensionNotLoadedException("DBA-Handler '{$handler}' not supported");
 124         }
 125
 126         if ($handler === 'inifile') {
 127             throw new Exception\ExtensionNotLoadedException(
 128                 "DBA-Handler 'inifile' does not reliably support write operations"
 129             );
 130         }
 131
 132         $this->triggerOptionEvent('handler', $handler);
 133         $this->handler = $handler;
 134         return $this;
 135     }
 136
 137     public function getHandler()
 138     {
 139         return $this->handler;
 140     }
 141 }