PatternOptions
extends AbstractOptions
in package
Table of Contents
- $__strictMode__ : bool
- We use the __ prefix to avoid collisions with properties in user-implementations.
- $cacheByDefault : bool
- Used by: - ClassCache - ObjectCache
- $cacheOutput : bool
- Used by: - CallbackCache - ClassCache - ObjectCache
- $class : null|string
- Used by: - ClassCache
- $classCacheMethods : array<string|int, mixed>
- Used by: - ClassCache
- $classNonCacheMethods : array<string|int, mixed>
- Used by: - ClassCache
- $dirPermission : false|int
- Used by: - CaptureCache
- $fileLocking : bool
- Used by: - CaptureCache
- $filePermission : false|int
- Used by: - CaptureCache
- $indexFilename : string
- Used by: - CaptureCache
- $object : null|object
- Used by: - ObjectCache
- $objectCacheMagicProperties : bool
- Used by: - ObjectCache
- $objectCacheMethods : array<string|int, mixed>
- Used by: - ObjectCache
- $objectKey : null|string
- Used by: - ObjectCache
- $objectNonCacheMethods : array<string|int, mixed>
- Used by: - ObjectCache
- $publicDir : null|string
- Used by: - CaptureCache
- $storage : null|StorageInterface
- Used by: - CallbackCache - ClassCache - ObjectCache - OutputCache
- $umask : false|int
- Used by: - CaptureCache
- __construct() : PatternOptions
- Constructor
- __get() : mixed
- Get a configuration property
- __isset() : bool
- Test if a configuration property is null
- __set() : void
- Set a configuration property
- __unset() : void
- Set a configuration property to NULL
- getCacheByDefault() : bool
- Do we cache by default?
- getCacheOutput() : bool
- Will we cache output?
- getClass() : null|string
- Get class name
- getClassCacheMethods() : array<string|int, mixed>
- Get list of methods from which to cache return values
- getClassNonCacheMethods() : array<string|int, mixed>
- Get list of methods from which NOT to cache return values
- getDirPermission() : false|int
- Gets directory permission
- getFileLocking() : bool
- Is file locking enabled?
- getFilePermission() : false|int
- Gets file permission
- getIndexFilename() : string
- Get value for index filename
- getObject() : null|object
- Get object to cache
- getObjectCacheMagicProperties() : bool
- Should we cache magic properties?
- getObjectCacheMethods() : array<string|int, mixed>
- Get list of object methods for which to cache return values
- getObjectKey() : string
- Get object key
- getObjectNonCacheMethods() : array<string|int, mixed>
- Get list of object methods for which NOT to cache return values
- getPublicDir() : null|string
- Get location of public directory
- getStorage() : null|StorageInterface
- Get storage adapter
- getUmask() : false|int
- Get umask
- setCacheByDefault() : PatternOptions
- Set flag indicating whether or not to cache by default
- setCacheOutput() : PatternOptions
- Set whether or not to cache output
- setClass() : PatternOptions
- Set class name
- setClassCacheMethods() : PatternOptions
- Set list of method return values to cache
- setClassNonCacheMethods() : PatternOptions
- Set list of method return values NOT to cache
- setDirPermission() : PatternOptions
- Set directory permission
- setFileLocking() : PatternOptions
- Set whether or not file locking should be used
- setFilePermission() : PatternOptions
- Set file permission
- setFromArray() : AbstractOptions
- Set one or more configuration properties
- setIndexFilename() : PatternOptions
- Set value for index filename
- setObject() : PatternOptions
- Set object to cache
- setObjectCacheMagicProperties() : PatternOptions
- Set flag indicating whether or not to cache magic properties
- setObjectCacheMethods() : PatternOptions
- Set list of object methods for which to cache return values
- setObjectKey() : PatternOptions
- Set the object key part.
- setObjectNonCacheMethods() : PatternOptions
- Set list of object methods for which NOT to cache return values
- setPublicDir() : PatternOptions
- Set location of public directory
- setStorage() : PatternOptions
- Set storage adapter
- setUmask() : PatternOptions
- Set umask
- toArray() : array<string|int, mixed>
- Cast to array
- normalizeObjectMethods() : array<string|int, mixed>
- Normalize object methods
- recursiveStrtolower() : array<string|int, mixed>
- Recursively apply strtolower on all values of an array, and return as a list of unique values
- storageFactory() : StorageInterface
- Create a storage object from a given specification
Properties
$__strictMode__
We use the __ prefix to avoid collisions with properties in user-implementations.
protected
bool
$__strictMode__
= true
$cacheByDefault
Used by: - ClassCache - ObjectCache
protected
bool
$cacheByDefault
= true
$cacheOutput
Used by: - CallbackCache - ClassCache - ObjectCache
protected
bool
$cacheOutput
= true
$class
Used by: - ClassCache
protected
null|string
$class
$classCacheMethods
Used by: - ClassCache
protected
array<string|int, mixed>
$classCacheMethods
= []
$classNonCacheMethods
Used by: - ClassCache
protected
array<string|int, mixed>
$classNonCacheMethods
= []
$dirPermission
Used by: - CaptureCache
protected
false|int
$dirPermission
= 0700
$fileLocking
Used by: - CaptureCache
protected
bool
$fileLocking
= true
$filePermission
Used by: - CaptureCache
protected
false|int
$filePermission
= 0600
$indexFilename
Used by: - CaptureCache
protected
string
$indexFilename
= 'index.html'
$object
Used by: - ObjectCache
protected
null|object
$object
$objectCacheMagicProperties
Used by: - ObjectCache
protected
bool
$objectCacheMagicProperties
= false
$objectCacheMethods
Used by: - ObjectCache
protected
array<string|int, mixed>
$objectCacheMethods
= []
$objectKey
Used by: - ObjectCache
protected
null|string
$objectKey
$objectNonCacheMethods
Used by: - ObjectCache
protected
array<string|int, mixed>
$objectNonCacheMethods
= ['__tostring']
$publicDir
Used by: - CaptureCache
protected
null|string
$publicDir
$storage
Used by: - CallbackCache - ClassCache - ObjectCache - OutputCache
protected
null|StorageInterface
$storage
$umask
Used by: - CaptureCache
protected
false|int
$umask
= false
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed>|Traversable|null $options = null ]) : PatternOptions
Parameters
- $options : array<string|int, mixed>|Traversable|null = null
Tags
Return values
PatternOptions —__get()
Get a configuration property
public
__get(string $key) : mixed
Parameters
- $key : string
Tags
Return values
mixed —__isset()
Test if a configuration property is null
public
__isset(string $key) : bool
Parameters
- $key : string
Tags
Return values
bool —__set()
Set a configuration property
public
__set(string $key, mixed $value) : void
Parameters
- $key : string
- $value : mixed
Tags
Return values
void —__unset()
Set a configuration property to NULL
public
__unset(string $key) : void
Parameters
- $key : string
Tags
Return values
void —getCacheByDefault()
Do we cache by default?
public
getCacheByDefault() : bool
Used by:
- ClassCache
- ObjectCache
Return values
bool —getCacheOutput()
Will we cache output?
public
getCacheOutput() : bool
Used by:
- CallbackCache
- ClassCache
- ObjectCache
Return values
bool —getClass()
Get class name
public
getClass() : null|string
Used by:
- ClassCache
Return values
null|string —getClassCacheMethods()
Get list of methods from which to cache return values
public
getClassCacheMethods() : array<string|int, mixed>
Used by:
- ClassCache
Return values
array<string|int, mixed> —getClassNonCacheMethods()
Get list of methods from which NOT to cache return values
public
getClassNonCacheMethods() : array<string|int, mixed>
Used by:
- ClassCache
Return values
array<string|int, mixed> —getDirPermission()
Gets directory permission
public
getDirPermission() : false|int
Return values
false|int —getFileLocking()
Is file locking enabled?
public
getFileLocking() : bool
Used by:
- CaptureCache
Return values
bool —getFilePermission()
Gets file permission
public
getFilePermission() : false|int
Return values
false|int —getIndexFilename()
Get value for index filename
public
getIndexFilename() : string
Return values
string —getObject()
Get object to cache
public
getObject() : null|object
Return values
null|object —getObjectCacheMagicProperties()
Should we cache magic properties?
public
getObjectCacheMagicProperties() : bool
Used by:
- ObjectCache
Return values
bool —getObjectCacheMethods()
Get list of object methods for which to cache return values
public
getObjectCacheMethods() : array<string|int, mixed>
Return values
array<string|int, mixed> —getObjectKey()
Get object key
public
getObjectKey() : string
Used by:
- ObjectCache
Return values
string —getObjectNonCacheMethods()
Get list of object methods for which NOT to cache return values
public
getObjectNonCacheMethods() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPublicDir()
Get location of public directory
public
getPublicDir() : null|string
Used by:
- CaptureCache
Return values
null|string —getStorage()
Get storage adapter
public
getStorage() : null|StorageInterface
Used by:
- CallbackCache
- ClassCache
- ObjectCache
- OutputCache
Return values
null|StorageInterface —getUmask()
Get umask
public
getUmask() : false|int
Used by:
- CaptureCache
Return values
false|int —setCacheByDefault()
Set flag indicating whether or not to cache by default
public
setCacheByDefault(bool $cacheByDefault) : PatternOptions
Used by:
- ClassCache
- ObjectCache
Parameters
- $cacheByDefault : bool
Return values
PatternOptions —Provides a fluent interface
setCacheOutput()
Set whether or not to cache output
public
setCacheOutput(bool $cacheOutput) : PatternOptions
Used by:
- CallbackCache
- ClassCache
- ObjectCache
Parameters
- $cacheOutput : bool
Return values
PatternOptions —Provides a fluent interface
setClass()
Set class name
public
setClass(string $class) : PatternOptions
Used by:
- ClassCache
Parameters
- $class : string
Tags
Return values
PatternOptions —Provides a fluent interface
setClassCacheMethods()
Set list of method return values to cache
public
setClassCacheMethods(array<string|int, mixed> $classCacheMethods) : PatternOptions
Used by:
- ClassCache
Parameters
- $classCacheMethods : array<string|int, mixed>
Return values
PatternOptions —Provides a fluent interface
setClassNonCacheMethods()
Set list of method return values NOT to cache
public
setClassNonCacheMethods(array<string|int, mixed> $classNonCacheMethods) : PatternOptions
Used by:
- ClassCache
Parameters
- $classNonCacheMethods : array<string|int, mixed>
Return values
PatternOptions —Provides a fluent interface
setDirPermission()
Set directory permission
public
setDirPermission(false|int $dirPermission) : PatternOptions
Parameters
- $dirPermission : false|int
Tags
Return values
PatternOptions —Provides a fluent interface
setFileLocking()
Set whether or not file locking should be used
public
setFileLocking(bool $fileLocking) : PatternOptions
Used by:
- CaptureCache
Parameters
- $fileLocking : bool
Return values
PatternOptions —Provides a fluent interface
setFilePermission()
Set file permission
public
setFilePermission(false|int $filePermission) : PatternOptions
Parameters
- $filePermission : false|int
Tags
Return values
PatternOptions —Provides a fluent interface
setFromArray()
Set one or more configuration properties
public
setFromArray(array<string|int, mixed>|Traversable|AbstractOptions $options) : AbstractOptions
Parameters
- $options : array<string|int, mixed>|Traversable|AbstractOptions
Tags
Return values
AbstractOptions —Provides fluent interface
setIndexFilename()
Set value for index filename
public
setIndexFilename(string $indexFilename) : PatternOptions
Parameters
- $indexFilename : string
Return values
PatternOptions —Provides a fluent interface
setObject()
Set object to cache
public
setObject(mixed $object) : PatternOptions
Parameters
- $object : mixed
Tags
Return values
PatternOptions —Provides a fluent interface
setObjectCacheMagicProperties()
Set flag indicating whether or not to cache magic properties
public
setObjectCacheMagicProperties(bool $objectCacheMagicProperties) : PatternOptions
Used by:
- ObjectCache
Parameters
- $objectCacheMagicProperties : bool
Return values
PatternOptions —Provides a fluent interface
setObjectCacheMethods()
Set list of object methods for which to cache return values
public
setObjectCacheMethods(array<string|int, mixed> $objectCacheMethods) : PatternOptions
Parameters
- $objectCacheMethods : array<string|int, mixed>
Tags
Return values
PatternOptions —Provides a fluent interface
setObjectKey()
Set the object key part.
public
setObjectKey(null|string $objectKey) : PatternOptions
Used to generate a callback key in order to speed up key generation.
Used by:
- ObjectCache
Parameters
- $objectKey : null|string
-
The object key or NULL to use the objects class name
Return values
PatternOptions —Provides a fluent interface
setObjectNonCacheMethods()
Set list of object methods for which NOT to cache return values
public
setObjectNonCacheMethods(array<string|int, mixed> $objectNonCacheMethods) : PatternOptions
Parameters
- $objectNonCacheMethods : array<string|int, mixed>
Tags
Return values
PatternOptions —Provides a fluent interface
setPublicDir()
Set location of public directory
public
setPublicDir(string $publicDir) : PatternOptions
Used by:
- CaptureCache
Parameters
- $publicDir : string
Tags
Return values
PatternOptions —Provides a fluent interface
setStorage()
Set storage adapter
public
setStorage(string|array<string|int, mixed>|StorageInterface $storage) : PatternOptions
Required for the following Pattern classes:
- CallbackCache
- ClassCache
- ObjectCache
- OutputCache
Parameters
- $storage : string|array<string|int, mixed>|StorageInterface
Return values
PatternOptions —Provides a fluent interface
setUmask()
Set umask
public
setUmask(false|int $umask) : PatternOptions
Used by:
- CaptureCache
Parameters
- $umask : false|int
Tags
Return values
PatternOptions —Provides a fluent interface
toArray()
Cast to array
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —normalizeObjectMethods()
Normalize object methods
protected
normalizeObjectMethods(array<string|int, mixed> $methods) : array<string|int, mixed>
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<string|int, mixed>
Tags
Return values
array<string|int, mixed> —recursiveStrtolower()
Recursively apply strtolower on all values of an array, and return as a list of unique values
protected
recursiveStrtolower(array<string|int, mixed> $array) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>
Return values
array<string|int, mixed> —storageFactory()
Create a storage object from a given specification
protected
storageFactory(array<string|int, mixed>|string|StorageInterface $storage) : StorageInterface
Parameters
- $storage : array<string|int, mixed>|string|StorageInterface