1390. Class

1390.1. Zend\Cache\Pattern\PatternOptions

1390.1.1. Methods

1390.1.1.1. __construct

__construct()

Constructor

Parameters:array|Traversable|null – Return type:PatternOptions Throws :ExceptionInvalidArgumentException

1390.1.1.2. setCacheByDefault

setCacheByDefault()

Set flag indicating whether or not to cache by default

Used by: - ClassCache - ObjectCache

Parameters:bool – Return type:PatternOptions

1390.1.1.3. getCacheByDefault

getCacheByDefault()

Do we cache by default?

Used by: - ClassCache - ObjectCache

Return type:bool

1390.1.1.4. setCacheOutput

setCacheOutput()

Set whether or not to cache output

Used by: - CallbackCache - ClassCache - ObjectCache

Parameters:bool – Return type:PatternOptions

1390.1.1.5. getCacheOutput

getCacheOutput()

Will we cache output?

Used by: - CallbackCache - ClassCache - ObjectCache

Return type:bool

1390.1.1.6. setClass

setClass()

Set class name

Used by: - ClassCache

Parameters:string – Throws ExceptionInvalidArgumentException:   Return type:PatternOptions

1390.1.1.7. getClass

getClass()

Get class name

Used by: - ClassCache

Return type:null|string

1390.1.1.8. setClassCacheMethods

setClassCacheMethods()

Set list of method return values to cache

Used by: - ClassCache

Parameters:array – Return type:PatternOptions

1390.1.1.9. getClassCacheMethods

getClassCacheMethods()

Get list of methods from which to cache return values

Used by: - ClassCache

Return type:array

1390.1.1.10. setClassNonCacheMethods

setClassNonCacheMethods()

Set list of method return values NOT to cache

Used by: - ClassCache

Parameters:array – Return type:PatternOptions

1390.1.1.11. getClassNonCacheMethods

getClassNonCacheMethods()

Get list of methods from which NOT to cache return values

Used by: - ClassCache

Return type:array

1390.1.1.12. setDirPermission

setDirPermission()

Set directory permission

Parameters:false|int – Throws ExceptionInvalidArgumentException:   Return type:PatternOptions

1390.1.1.13. getDirPermission

getDirPermission()

Gets directory permission

Return type:false|int

1390.1.1.14. setUmask

setUmask()

Set umask

Used by: - CaptureCache

Parameters:false|int – Throws ExceptionInvalidArgumentException:   Return type:PatternOptions

1390.1.1.15. getUmask

getUmask()

Get umask

Used by: - CaptureCache

Return type:false|int

1390.1.1.16. setFileLocking

setFileLocking()

Set whether or not file locking should be used

Used by: - CaptureCache

Parameters:bool – Return type:PatternOptions

1390.1.1.17. getFileLocking

getFileLocking()

Is file locking enabled?

Used by: - CaptureCache

Return type:bool

1390.1.1.18. setFilePermission

setFilePermission()

Set file permission

Parameters:false|int – Throws ExceptionInvalidArgumentException:   Return type:PatternOptions

1390.1.1.19. getFilePermission

getFilePermission()

Gets file permission

Return type:false|int

1390.1.1.20. setIndexFilename

setIndexFilename()

Set value for index filename

Parameters:string – Return type:PatternOptions

1390.1.1.21. getIndexFilename

getIndexFilename()

Get value for index filename

Return type:string

1390.1.1.22. setObject

setObject()

Set object to cache

Parameters:mixed – Throws ExceptionInvalidArgumentException:   Return type:$this

1390.1.1.23. getObject

getObject()

Get object to cache

Return type:null|object

1390.1.1.24. setObjectCacheMagicProperties

setObjectCacheMagicProperties()

Set flag indicating whether or not to cache magic properties

Used by: - ObjectCache

Parameters:bool – Return type:PatternOptions

1390.1.1.25. getObjectCacheMagicProperties

getObjectCacheMagicProperties()

Should we cache magic properties?

Used by: - ObjectCache

Return type:bool

1390.1.1.26. setObjectCacheMethods

setObjectCacheMethods()

Set list of object methods for which to cache return values

Parameters:array – Return type:PatternOptions Throws :ExceptionInvalidArgumentException

1390.1.1.27. getObjectCacheMethods

getObjectCacheMethods()

Get list of object methods for which to cache return values

Return type:array

1390.1.1.28. setObjectKey

setObjectKey()

Set the object key part.

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

Used by: - ObjectCache

Parameters:mixed – Return type:$this

1390.1.1.29. getObjectKey

getObjectKey()

Get object key

Used by: - ObjectCache

Return type:mixed

1390.1.1.30. setObjectNonCacheMethods

setObjectNonCacheMethods()

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

Parameters:array – Return type:PatternOptions Throws :ExceptionInvalidArgumentException

1390.1.1.31. getObjectNonCacheMethods

getObjectNonCacheMethods()

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

Return type:array

1390.1.1.32. setPublicDir

setPublicDir()

Set location of public directory

Used by: - CaptureCache

Parameters:string – Throws ExceptionInvalidArgumentException:   Return type:PatternOptions

1390.1.1.33. getPublicDir

getPublicDir()

Get location of public directory

Used by: - CaptureCache

Return type:null|string

1390.1.1.34. setStorage

setStorage()

Set storage adapter

Required for the following Pattern classes: - CallbackCache - ClassCache - ObjectCache - OutputCache

Parameters:string|array|Storage – Return type:PatternOptions

1390.1.1.35. getStorage

getStorage()

Get storage adapter

Used by: - CallbackCache - ClassCache - ObjectCache - OutputCache

Return type:null|Storage

1390.1.1.36. recursiveStrtolower

recursiveStrtolower()

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

Parameters:array – Return type:array

1390.1.1.37. normalizeObjectMethods

normalizeObjectMethods()

Normalize object methods

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

Parameters:array – Return type:array Throws :ExceptionInvalidArgumentException

1390.1.1.38. storageFactory

storageFactory()

Create a storage object from a given specification

Parameters:array|string|Storage – Throws ExceptionInvalidArgumentException:   Return type:Storage