class CachedConfigCollection implements ConfigCollectionInterface (View source)

Traits

Constants

CACHE_KEY

Methods

getMiddlewares()

No description

$this
setMiddlewares(Middleware[] $middlewares)

No description

$this
addMiddleware(Middleware $middleware)

No description

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 = 0)

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 = 0)

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

array
getMetadata()

Returns the entire metadata

getHistory()

No description

getCollection()

Get or build collection

__destruct()

Commits the cache

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

Middleware[] getMiddlewares()

Return Value

Middleware[]

$this setMiddlewares(Middleware[] $middlewares)

Parameters

Middleware[] $middlewares

Return Value

$this

$this addMiddleware(Middleware $middleware)

Parameters

Middleware $middleware

Return Value

$this

callable getNestFactory()

Get callback for nesting the inner collection

Return Value

callable

$this setNestFactory(callable $factory)

Set callback for nesting the inner collection

Parameters

callable $factory

Return Value

$this

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

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

array getAll()

Get complete config (excludes middleware)

Return Value

array

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

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

array getMetadata()

Returns the entire metadata

Return Value

array

getHistory()

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

Parameters

CacheInterface $cache

Return Value

$this

$this setCollectionCreator(callable $collectionCreator)

Parameters

callable $collectionCreator

Return Value

$this

callable getCollectionCreator()

Return Value

callable

CacheInterface getCache()

Return Value

CacheInterface

$this setFlush(bool $flush)

Parameters

bool $flush

Return Value

$this

bool getFlush()

Return Value

bool

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