package Default
inherited_from \Zend\Stdlib\AbstractOptions

 Methods

Constructor

__construct(array|\Traversable|null $options = null) : \Zend\Cache\Pattern\PatternOptions
inherited_from \Zend\Stdlib\AbstractOptions::__construct()

Parameters

$options

array\Traversablenull

Exceptions

\Zend\Cache\Exception\InvalidArgumentException

Returns

\Zend\Cache\Pattern\PatternOptions

Constructor

__construct(array|\Traversable|null $options = null
Inherited

Parameters

$options

array\Traversablenull

Get a configuration property

__get(string $key) : mixed
Inherited
see
inherited_from \Zend\Stdlib\ParameterObjectInterface::__get()

Parameters

$key

string

Exceptions

\Zend\Stdlib\Exception\BadMethodCallException

Returns

mixed

Test if a configuration property is null

__isset(string $key) : boolean
Inherited
see
inherited_from \Zend\Stdlib\ParameterObjectInterface::__isset()

Parameters

$key

string

Returns

boolean

Set a configuration property

__set(string $key, mixed $value) : void
Inherited
see
inherited_from \Zend\Stdlib\ParameterObjectInterface::__set()

Parameters

$key

string

$value

mixed

Exceptions

\Zend\Stdlib\Exception\BadMethodCallException

Set a configuration property to NULL

__unset(string $key) : void
Inherited
see
inherited_from \Zend\Stdlib\ParameterObjectInterface::__unset()

Parameters

$key

string

Exceptions

\Zend\Stdlib\Exception\InvalidArgumentException

Do we cache by default?

getCacheByDefault() : boolean

Used by:

  • ClassCache
  • ObjectCache

Returns

boolean

Will we cache output?

getCacheOutput() : boolean

Used by:

  • CallbackCache
  • ClassCache
  • ObjectCache

Returns

boolean

Get class name

getClass() : null | string

Used by:

  • ClassCache

Returns

nullstring

Get list of methods from which to cache return values

getClassCacheMethods() : array

Used by:

  • ClassCache

Returns

array

Get list of methods from which NOT to cache return values

getClassNonCacheMethods() : array

Used by:

  • ClassCache

Returns

array

Gets directory permission

getDirPermission() : false | integer

Returns

falseinteger

Is file locking enabled?

getFileLocking() : boolean

Used by:

  • CaptureCache

Returns

boolean

Gets file permission

getFilePermission() : false | integer

Returns

falseinteger

Get value for index filename

getIndexFilename() : string

Returns

string

Get object to cache

getObject() : null | object

Returns

nullobject

Should we cache magic properties?

getObjectCacheMagicProperties() : boolean

Used by:

  • ObjectCache

Returns

boolean

Get list of object methods for which to cache return values

getObjectCacheMethods() : array

Returns

array

Get object key

getObjectKey() : string

Used by:

  • ObjectCache

Returns

string

Get list of object methods for which NOT to cache return values

getObjectNonCacheMethods() : array

Returns

array

Get location of public directory

getPublicDir() : null | string

Used by:

  • CaptureCache

Returns

nullstring

Get storage adapter

getStorage() : null | \Zend\Cache\Storage\StorageInterface

Used by:

  • CallbackCache
  • ClassCache
  • ObjectCache
  • OutputCache

Returns

null\Zend\Cache\Storage\StorageInterface

Get umask

getUmask() : false | integer

Used by:

  • CaptureCache

Returns

falseinteger

Set flag indicating whether or not to cache by default

setCacheByDefault(boolean $cacheByDefault) : \Zend\Cache\Pattern\PatternOptions

Used by:

  • ClassCache
  • ObjectCache

Parameters

$cacheByDefault

boolean

Returns

\Zend\Cache\Pattern\PatternOptions

Set whether or not to cache output

setCacheOutput(boolean $cacheOutput) : \Zend\Cache\Pattern\PatternOptions

Used by:

  • CallbackCache
  • ClassCache
  • ObjectCache

Parameters

$cacheOutput

boolean

Returns

\Zend\Cache\Pattern\PatternOptions

Set class name

setClass(string $class) : \Zend\Cache\Pattern\PatternOptions

Used by:

  • ClassCache

Parameters

$class

string

Exceptions

\Zend\Cache\Exception\InvalidArgumentException

Returns

\Zend\Cache\Pattern\PatternOptions

Set list of method return values to cache

setClassCacheMethods(array $classCacheMethods) : \Zend\Cache\Pattern\PatternOptions

Used by:

  • ClassCache

Parameters

$classCacheMethods

array

Returns

\Zend\Cache\Pattern\PatternOptions

Set list of method return values NOT to cache

setClassNonCacheMethods(array $classNonCacheMethods) : \Zend\Cache\Pattern\PatternOptions

Used by:

  • ClassCache

Parameters

$classNonCacheMethods

array

Returns

\Zend\Cache\Pattern\PatternOptions

Set directory permission

setDirPermission(false|integer $dirPermission) : \Zend\Cache\Pattern\PatternOptions

Parameters

$dirPermission

falseinteger

Exceptions

\Zend\Cache\Exception\InvalidArgumentException

Returns

\Zend\Cache\Pattern\PatternOptions

Set whether or not file locking should be used

setFileLocking(boolean $fileLocking) : \Zend\Cache\Pattern\PatternOptions

Used by:

  • CaptureCache

Parameters

$fileLocking

boolean

Returns

\Zend\Cache\Pattern\PatternOptions

Set file permission

setFilePermission(false|integer $filePermission) : \Zend\Cache\Pattern\PatternOptions

Parameters

$filePermission

falseinteger

Exceptions

\Zend\Cache\Exception\InvalidArgumentException

Returns

\Zend\Cache\Pattern\PatternOptions

Set one or more configuration properties

setFromArray(array|\Traversable|\Zend\Stdlib\AbstractOptions $options) : \Zend\Stdlib\AbstractOptions
Inherited

Parameters

$options

array\Traversable\Zend\Stdlib\AbstractOptions

Exceptions

\Zend\Stdlib\Exception\InvalidArgumentException

Returns

\Zend\Stdlib\AbstractOptionsProvides fluent interface

Set value for index filename

setIndexFilename(string $indexFilename) : \Zend\Cache\Pattern\PatternOptions

Parameters

$indexFilename

string

Returns

\Zend\Cache\Pattern\PatternOptions

Set object to cache

setObject(mixed $object) : \Zend\Cache\Pattern\PatternOptions

Parameters

$object

mixed

Exceptions

\Zend\Cache\Exception\InvalidArgumentException

Returns

\Zend\Cache\Pattern\PatternOptions

Set flag indicating whether or not to cache magic properties

setObjectCacheMagicProperties(boolean $objectCacheMagicProperties) : \Zend\Cache\Pattern\PatternOptions

Used by:

  • ObjectCache

Parameters

$objectCacheMagicProperties

boolean

Returns

\Zend\Cache\Pattern\PatternOptions

Set list of object methods for which to cache return values

setObjectCacheMethods(array $objectCacheMethods) : \Zend\Cache\Pattern\PatternOptions

Parameters

$objectCacheMethods

array

Exceptions

\Zend\Cache\Exception\InvalidArgumentException

Returns

\Zend\Cache\Pattern\PatternOptions

Set the object key part.

setObjectKey(null|string $objectKey) : \Zend\Cache\Pattern\PatternOptions

Used to generate a callback key in order to speed up key generation.

Used by:

  • ObjectCache

Parameters

$objectKey

nullstring

The object key or NULL to use the objects class name

Returns

\Zend\Cache\Pattern\PatternOptions

Set list of object methods for which NOT to cache return values

setObjectNonCacheMethods(array $objectNonCacheMethods) : \Zend\Cache\Pattern\PatternOptions

Parameters

$objectNonCacheMethods

array

Exceptions

\Zend\Cache\Exception\InvalidArgumentException

Returns

\Zend\Cache\Pattern\PatternOptions

Set location of public directory

setPublicDir(string $publicDir) : \Zend\Cache\Pattern\PatternOptions

Used by:

  • CaptureCache

Parameters

$publicDir

string

Exceptions

\Zend\Cache\Exception\InvalidArgumentException

Returns

\Zend\Cache\Pattern\PatternOptions

Set storage adapter

setStorage(string|array|\Zend\Cache\Storage\StorageInterface $storage) : \Zend\Cache\Pattern\PatternOptions

Required for the following Pattern classes:

  • CallbackCache
  • ClassCache
  • ObjectCache
  • OutputCache

Parameters

$storage

stringarray\Zend\Cache\Storage\StorageInterface

Returns

\Zend\Cache\Pattern\PatternOptions

Set umask

setUmask(false|integer $umask) : \Zend\Cache\Pattern\PatternOptions

Used by:

  • CaptureCache

Parameters

$umask

falseinteger

Exceptions

\Zend\Cache\Exception\InvalidArgumentException

Returns

\Zend\Cache\Pattern\PatternOptions

Cast to array

toArray() : array
Inherited

Returns

array

Normalize object methods

normalizeObjectMethods(array $methods) : array

Recursively casts values to lowercase, then determines if any are in a list of methods not handled, raising an exception if so.

Parameters

$methods

array

Exceptions

\Zend\Cache\Exception\InvalidArgumentException

Returns

array

Recursively apply strtolower on all values of an array, and return as a list of unique values

recursiveStrtolower(array $array) : array

Parameters

$array

array

Returns

array

Create a storage object from a given specification

storageFactory(array|string|\Zend\Cache\Storage\StorageInterface $storage) : \Zend\Cache\Storage\StorageInterface

Parameters

$storage

arraystring\Zend\Cache\Storage\StorageInterface

Exceptions

\Zend\Cache\Exception\InvalidArgumentException

Returns

\Zend\Cache\Storage\StorageInterface

 Properties

 

We use the __ prefix to avoid collisions with properties in user-implementations.

$__strictMode__ : boolean

Default

true
 

Used by: - ClassCache - ObjectCache

$cacheByDefault : boolean

Default

true
 

Used by: - CallbackCache - ClassCache - ObjectCache

$cacheOutput : boolean

Default

true
 

Used by: - ClassCache

$class : null | string

Default

 

Used by: - ClassCache

$classCacheMethods : array

Default

array()
 

Used by: - ClassCache

$classNonCacheMethods : array

Default

array()
 

Used by: - CaptureCache

$dirPermission : false | integer

Default

448
 

Used by: - CaptureCache

$fileLocking : boolean

Default

true
 

Used by: - CaptureCache

$filePermission : false | integer

Default

384
 

Used by: - CaptureCache

$indexFilename : string

Default

'index.html'
 

Used by: - ObjectCache

$object : null | object

Default

 

Used by: - ObjectCache

$objectCacheMagicProperties : boolean

Default

false
 

Used by: - ObjectCache

$objectCacheMethods : array

Default

array()
 

Used by: - ObjectCache

$objectKey : null | string

Default

 

Used by: - ObjectCache

$objectNonCacheMethods : array

Default

array('__tostring')
 

Used by: - CaptureCache

$publicDir : null | string

Default

 

Used by: - CallbackCache - ClassCache - ObjectCache - OutputCache

$storage : null | \Zend\Cache\Storage\StorageInterface

Default

 

Used by: - CaptureCache

$umask : false | integer

Default

false