interface/modules/zend_modules/library/Zend/Cache/Storage/Adapter/XCacheOptions.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-2013 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 /**
  13  * These are options specific to the XCache adapter
  14  */
  15 class XCacheOptions extends AdapterOptions
  16 {
  17     /**
  18      * Namespace separator
  19      *
  20      * @var string
  21      */
  22     protected $namespaceSeparator = ':';
  23
  24     /**
  25      * Handle admin authentication
  26      *
  27      * @var bool
  28      */
  29     protected $adminAuth = false;
  30
  31     /**
  32      * Username to call admin functions
  33      *
  34      * @var null|string
  35      */
  36     protected $adminUser;
  37
  38     /**
  39      * Password to call admin functions
  40      *
  41      * @var null|string
  42      */
  43     protected $adminPass;
  44
  45     /**
  46      * Set namespace separator
  47      *
  48      * @param  string $namespaceSeparator
  49      * @return XCacheOptions
  50      */
  51     public function setNamespaceSeparator($namespaceSeparator)
  52     {
  53         $namespaceSeparator = (string) $namespaceSeparator;
  54         $this->triggerOptionEvent('namespace_separator', $namespaceSeparator);
  55         $this->namespaceSeparator = $namespaceSeparator;
  56         return $this;
  57     }
  58
  59     /**
  60      * Get namespace separator
  61      *
  62      * @return string
  63      */
  64     public function getNamespaceSeparator()
  65     {
  66         return $this->namespaceSeparator;
  67     }
  68
  69     /**
  70      * Set username to call admin functions
  71      *
  72      * @param  null|string $adminUser
  73      * @return XCacheOptions
  74      */
  75     public function setAdminUser($adminUser)
  76     {
  77         $adminUser = ($adminUser === null) ? null : (string) $adminUser;
  78         if ($this->adminUser !== $adminUser) {
  79             $this->triggerOptionEvent('admin_user', $adminUser);
  80             $this->adminUser = $adminUser;
  81         }
  82         return $this;
  83     }
  84
  85     /**
  86      * Get username to call admin functions
  87      *
  88      * @return string
  89      */
  90     public function getAdminUser()
  91     {
  92         return $this->adminUser;
  93     }
  94
  95     /**
  96      * Enable/Disable admin authentication handling
  97      *
  98      * @param  bool $adminAuth
  99      * @return XCacheOptions
 100      */
 101     public function setAdminAuth($adminAuth)
 102     {
 103         $adminAuth = (bool) $adminAuth;
 104         if ($this->adminAuth !== $adminAuth) {
 105             $this->triggerOptionEvent('admin_auth', $adminAuth);
 106             $this->adminAuth = $adminAuth;
 107         }
 108         return $this;
 109     }
 110
 111     /**
 112      * Get admin authentication enabled
 113      *
 114      * @return bool
 115      */
 116     public function getAdminAuth()
 117     {
 118         return $this->adminAuth;
 119     }
 120
 121     /**
 122      * Set password to call admin functions
 123      *
 124      * @param  null|string $adminPass
 125      * @return XCacheOptions
 126      */
 127     public function setAdminPass($adminPass)
 128     {
 129         $adminPass = ($adminPass === null) ? null : (string) $adminPass;
 130         if ($this->adminPass !== $adminPass) {
 131             $this->triggerOptionEvent('admin_pass', $adminPass);
 132             $this->adminPass = $adminPass;
 133         }
 134         return $this;
 135     }
 136
 137     /**
 138      * Get password to call admin functions
 139      *
 140      * @return string
 141      */
 142     public function getAdminPass()
 143     {
 144         return $this->adminPass;
 145     }
 146 }