class CachedConfigCollection implements ConfigCollectionInterface (View source)

Traits

Constants

CACHE_KEY

Properties

protected Middleware[] $middlewares from  MiddlewareAware
protected CacheInterface $cache
protected ConfigCollectionInterface $collection

Nested config to delegate to

protected callable $collectionCreator
protected bool $flush
protected bool $building

Set to true while building config.

protected callable $nestFactory

Injectable factory for nesting config.

Methods

public
getMiddlewares()

No description

public
$this
setMiddlewares(Middleware[] $middlewares)

No description

public
$this
addMiddleware(Middleware $middleware)

No description

protected
array
callMiddleware(string $class, int|bool $excludeMiddleware, callable $last)

Call middleware to get decorated class config

public static 
create()

No description

public
callable
getNestFactory()

Get callback for nesting the inner collection

public
$this
setNestFactory(callable $factory)

Set callback for nesting the inner collection

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

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

public
array
getAll()

Get complete config (excludes middleware)

public
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

public
array
getMetadata()

Returns the entire metadata

public
getHistory()

No description

public
getCollection()

Get or build collection

public
__destruct()

Commits the cache

public
nest()

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

public
$this
setCache(CacheInterface $cache)

Set a PSR-16 cache

public
$this
setCollectionCreator(callable $collectionCreator)

No description

public
callable
getCollectionCreator()

No description

public
CacheInterface
getCache()

No description

public
$this
setFlush(bool $flush)

No description

public
bool
getFlush()

No description

Details

Middleware[] getMiddlewares()

No description

Return Value

Middleware[]

$this setMiddlewares(Middleware[] $middlewares)

No description

Parameters

Middleware[] $middlewares

Return Value

$this

$this addMiddleware(Middleware $middleware)

No description

Parameters

Middleware $middleware

Return Value

$this

protected array callMiddleware(string $class, int|bool $excludeMiddleware, callable $last)

Call middleware to get decorated class config

Parameters

string $class

Class name to pass

int|bool $excludeMiddleware
callable $last

Last config to call

Return Value

array

Class config with middleware applied

static CachedConfigCollection create()

No description

Return Value

CachedConfigCollection

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()

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

Parameters

CacheInterface $cache

Return Value

$this

$this setCollectionCreator(callable $collectionCreator)

No description

Parameters

callable $collectionCreator

Return Value

$this

callable getCollectionCreator()

No description

Return Value

callable

CacheInterface getCache()

No description

Return Value

CacheInterface

$this setFlush(bool $flush)

No description

Parameters

bool $flush

Return Value

$this

bool getFlush()

No description

Return Value

bool