Zend\Cache\Storage\Adapter\XCacheOptions
These are options specific to the XCache adapter
Synopsis
class XCacheOptions
extends AdapterOptions
{
- // members
- protected string $namespaceSeparator;
- protected bool $adminAuth;
- protected null|string $adminUser;
- protected null|string $adminPass;
- // Inherited members from AdapterOptions
- protected null|Filesystem $adapter;
- protected string $keyPattern;
- protected string $namespace;
- protected bool $readable;
- protected int|float $ttl;
- protected bool $writable;
- // Inherited members from AbstractOptions
- protected bool $__strictMode__;
- // methods
- public XCacheOptions setNamespaceSeparator()
- public string getNamespaceSeparator()
- public XCacheOptions setAdminUser()
- public string getAdminUser()
- public XCacheOptions setAdminAuth()
- public bool getAdminAuth()
- public XCacheOptions setAdminPass()
- public string getAdminPass()
- // Inherited methods from AdapterOptions
- public AdapterOptions setAdapter()
- public AdapterOptions setKeyPattern()
- public string getKeyPattern()
- public AdapterOptions setNamespace()
- public string getNamespace()
- public AbstractAdapter setReadable()
- public bool getReadable()
- public AdapterOptions setTtl()
- public float getTtl()
- public AdapterOptions setWritable()
- public bool getWritable()
- protected void triggerOptionEvent()
- protected void normalizeTtl()
- // Inherited methods from AbstractOptions
- public void __construct()
- public AbstractOptions setFromArray()
- public array toArray()
- public void __set()
- public mixed __get()
- public bool __isset()
- public void __unset()
Hierarchy
Members
protected
- $__strictMode__
—
Zend\Stdlib\bool
We use the __ prefix to avoid collisions with properties in user-implementations. - $adapter
—
Zend\Cache\Storage\Adapter\null|Filesystem
The adapter using these options - $adminAuth
—
Zend\Cache\Storage\Adapter\bool
Handle admin authentication - $adminPass
—
Zend\Cache\Storage\Adapter\null|string
Password to call admin functions - $adminUser
—
Zend\Cache\Storage\Adapter\null|string
Username to call admin functions - $keyPattern
—
string
Validate key against pattern - $namespace
—
string
Namespace option - $namespaceSeparator
—
string
Namespace separator - $readable
—
Zend\Cache\Storage\Adapter\bool
Readable option - $ttl
—
Zend\Cache\Storage\Adapter\int|float
TTL option - $writable
—
Zend\Cache\Storage\Adapter\bool
Writable option
Methods
public
- getAdminAuth() — Get admin authentication enabled
- getAdminPass() — Get password to call admin functions
- getAdminUser() — Get username to call admin functions
- getNamespaceSeparator() — Get namespace separator
- setAdminAuth() — Enable/Disable admin authentication handling
- setAdminPass() — Set password to call admin functions
- setAdminUser() — Set username to call admin functions
- setNamespaceSeparator() — Set namespace separator
Inherited from Zend\Cache\Storage\Adapter\AdapterOptions
protected
- normalizeTtl() — Validates and normalize a TTL.
- triggerOptionEvent() — Triggers an option event if this options instance has a connection to an adapter implements EventsCapableInterface.
public
- getKeyPattern() — Get key pattern
- getNamespace() — Get namespace
- getReadable() — If reading data from cache enabled.
- getTtl() — Get time to live.
- getWritable() — If writing data to cache enabled.
- setAdapter() — Adapter using this instance
- setKeyPattern() — Set key pattern
- setNamespace() — Set namespace.
- setReadable() — Enable/Disable reading data from cache.
- setTtl() — Set time to live.
- setWritable() — Enable/Disable writing data to cache.