1. class
  2. SilverStripe
  3. \
  4. Config
  5. \
  6. Collections
  7. \
  8. CachedConfigCollection

CachedConfigCollection

class CachedConfigCollection implements ConfigCollectionInterface

Traits

MiddlewareAware

Constants

CACHE_KEY

Methods

Middleware[]
getMiddlewares()

No description

from MiddlewareAware
$this
setMiddlewares(Middleware[] $middlewares)

No description

$this
addMiddleware(Middleware $middleware)

No description

from MiddlewareAware
static CachedConfigCollection
create()

No description

callable
getNestFactory()

Get callback for nesting the inner collection

$this
setNestFactory(callable $factory)

Set callback for nesting the inner collection

mixed
get(string $class, string $name = null, int|true $excludeMiddleware)

Fetches value for a class, or a property on that class

array
getAll()

Get complete config (excludes middleware)

bool
exists(string $class, string $name = null, int|true $excludeMiddleware)

Checks to see if a config item exists, or a property on that class

array
getMetadata()

Returns the entire metadata

getHistory()

No description

ConfigCollectionInterface
getCollection()

Get or build collection

__destruct()

Commits the cache

ConfigCollectionInterface
nest()

Get nested version of this config, which is normally duplicated version of this config, but could be a subclass.

$this
setCache(CacheInterface $cache)

Set a PSR-16 cache

$this
setCollectionCreator(callable $collectionCreator)

No description

callable
getCollectionCreator()

No description

CacheInterface
getCache()

No description

$this
setFlush(bool $flush)

No description

bool
getFlush()

No description

update($class, $name, $value) deprecated

No description

Details

in MiddlewareAware at line 15
Middleware[] getMiddlewares()

Return Value

Middleware[]

at line 238
$this setMiddlewares(Middleware[] $middlewares)

Parameters

Middleware[] $middlewares

Return Value

$this

in MiddlewareAware at line 34
$this addMiddleware(Middleware $middleware)

Parameters

Middleware $middleware

Return Value

$this

at line 59
static CachedConfigCollection create()

Return Value

CachedConfigCollection

at line 69
callable getNestFactory()

Get callback for nesting the inner collection

Return Value

callable

at line 80
$this setNestFactory(callable $factory)

Set callback for nesting the inner collection

Parameters

callable $factory

Return Value

$this

at line 86
mixed get(string $class, string $name = null, int|true $excludeMiddleware)

Fetches value for a class, or a property on that class

Parameters

string $class Class name to retrieve config for
string $name Optional class property to get
int|true $excludeMiddleware Optional flag of middleware to disable. Passing in true disables all middleware. Can also pass in int flags to specify specific middlewares.

Return Value

mixed

at line 91
array getAll()

Get complete config (excludes middleware)

Return Value

array

at line 96
bool exists(string $class, string $name = null, int|true $excludeMiddleware)

Checks to see if a config item exists, or a property on that class

Parameters

string $class Class name to check config for
string $name Optional class property to restrict check to
int|true $excludeMiddleware Optional flag of middleware to disable. Passing in true disables all middleware. Can also pass in int flags to specify specific middlewares.

Return Value

bool

at line 101
array getMetadata()

Returns the entire metadata

Return Value

array

at line 106
getHistory()

at line 116
ConfigCollectionInterface getCollection()

Get or build collection

Return Value

ConfigCollectionInterface

at line 153
__destruct()

Commits the cache

at line 164
ConfigCollectionInterface nest()

Get nested version of this config, which is normally duplicated version of this config, but could be a subclass.

Return Value

ConfigCollectionInterface

at line 182
$this setCache(CacheInterface $cache)

Set a PSR-16 cache

Parameters

CacheInterface $cache

Return Value

$this

at line 195
$this setCollectionCreator(callable $collectionCreator)

Parameters

callable $collectionCreator

Return Value

$this

at line 204
callable getCollectionCreator()

Return Value

callable

at line 212
CacheInterface getCache()

Return Value

CacheInterface

at line 221
$this setFlush(bool $flush)

Parameters

bool $flush

Return Value

$this

at line 233
bool getFlush()

Return Value

bool

at line 249
update($class, $name, $value) deprecated

deprecated 4.0...5.0 Please use YAML configuration, ::modify()->set() or ::modify()->merge()

Parameters

$class
$name
$value

Exceptions

BadMethodCallException