Zend Framework  3.0
Public Member Functions | Protected Attributes | List of all members
XCacheOptions Class Reference

These are options specific to the XCache adapter. More...

Public Member Functions

 setNamespaceSeparator ($namespaceSeparator)
 Set namespace separator.
 
 getNamespaceSeparator ()
 Get namespace separator.
 
 setAdminUser ($adminUser)
 Set username to call admin functions.
 
 getAdminUser ()
 Get username to call admin functions.
 
 setAdminAuth ($adminAuth)
 Enable/Disable admin authentication handling.
 
 getAdminAuth ()
 Get admin authentication enabled.
 
 setAdminPass ($adminPass)
 Set password to call admin functions.
 
 getAdminPass ()
 Get password to call admin functions.
 
- Public Member Functions inherited from AdapterOptions
 setAdapter (StorageInterface $adapter=null)
 Adapter using this instance.
 
 setKeyPattern ($keyPattern)
 Set key pattern.
 
 getKeyPattern ()
 Get key pattern.
 
 setNamespace ($namespace)
 Set namespace.
 
 getNamespace ()
 Get namespace.
 
 setReadable ($readable)
 Enable/Disable reading data from cache.
 
 getReadable ()
 If reading data from cache enabled.
 
 setTtl ($ttl)
 Set time to live.
 
 getTtl ()
 Get time to live.
 
 setWritable ($writable)
 Enable/Disable writing data to cache.
 
 getWritable ()
 If writing data to cache enabled.
 
 toArray ()
 Cast to array.
 
 setFromArray ($options)
 {}
 
- Public Member Functions inherited from AbstractOptions
 __construct ($options=null)
 Constructor.
 
 setFromArray ($options)
 Set one or more configuration properties.
 
 toArray ()
 Cast to array.
 
 __set ($key, $value)
 Set a configuration property.
 
 __get ($key)
 Get a configuration property.
 
 __isset ($key)
 Test if a configuration property is null.
 
 __unset ($key)
 Set a configuration property to NULL.
 

Protected Attributes

 $namespaceSeparator = ':'
 
 $adminAuth = false
 
 $adminUser
 
 $adminPass
 
- Protected Attributes inherited from AdapterOptions
 $__prioritizedProperties__ = []
 
 $adapter
 
 $keyPattern = ''
 
 $namespace = 'zfcache'
 
 $readable = true
 
 $ttl = 0
 
 $writable = true
 
- Protected Attributes inherited from AbstractOptions
 $__strictMode__ = true
 

Additional Inherited Members

- Protected Member Functions inherited from AdapterOptions
 triggerOptionEvent ($optionName, $optionValue)
 Triggers an option event if this options instance has a connection to an adapter implements EventsCapableInterface.
 
 normalizeTtl (&$ttl)
 Validates and normalize a TTL.
 

Detailed Description

These are options specific to the XCache adapter.

Member Function Documentation

getAdminAuth ( )

Get admin authentication enabled.

Returns
bool
getAdminPass ( )

Get password to call admin functions.

Returns
string
getAdminUser ( )

Get username to call admin functions.

Returns
string
getNamespaceSeparator ( )

Get namespace separator.

Returns
string
setAdminAuth (   $adminAuth)

Enable/Disable admin authentication handling.

Parameters
bool$adminAuth
Returns
XCacheOptions
setAdminPass (   $adminPass)

Set password to call admin functions.

Parameters
null | string$adminPass
Returns
XCacheOptions
setAdminUser (   $adminUser)

Set username to call admin functions.

Parameters
null | string$adminUser
Returns
XCacheOptions
setNamespaceSeparator (   $namespaceSeparator)

Set namespace separator.

Parameters
string$namespaceSeparator
Returns
XCacheOptions

Member Data Documentation

$adminAuth = false
protected
$adminPass
protected
$adminUser
protected
$namespaceSeparator = ':'
protected