class MemoryConfigCollection implements MutableConfigCollectionInterface, Serializable (View source)

Basic mutable config collection stored in memory

Traits

Methods

getMiddlewares()

No description

$this
setMiddlewares(Middleware[] $middlewares)

No description

$this
addMiddleware(Middleware $middleware)

No description

__construct(bool $trackMetadata = false)

ConfigCollection constructor.

create()

No description

$this
transform(TransformerInterface[] $transformers)

Trigger transformers to load into this store

$this
set(string $class, string $name, $data, array $metadata = [])

Sets config for a given field.

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

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

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

$this
remove(string $class, string $name = null)

Remove config for a given class, or field on that class

removeAll()

Delete all entries

array
getAll()

Get complete config (excludes middleware-applied config)

$this
update(string $class, string $name, mixed $value) deprecated

No description

$this
merge(string $class, string $name, mixed $value)

Merge a config for a class, or a field on that class

array
getMetadata()

Returns the entire metadata

getHistory()

No description

serialize()

No description

unserialize($serialized)

No description

nest()

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

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

__construct(bool $trackMetadata = false)

ConfigCollection constructor.

Parameters

bool $trackMetadata

$this transform(TransformerInterface[] $transformers)

Trigger transformers to load into this store

Parameters

TransformerInterface[] $transformers

Return Value

$this

$this set(string $class, string $name, $data, array $metadata = [])

Sets config for a given field.

Set name to null to set the config for the entire class.

Parameters

string $class
string $name
$data
array $metadata

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

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

$this remove(string $class, string $name = null)

Remove config for a given class, or field on that class

Parameters

string $class
string $name

Return Value

$this

removeAll()

Delete all entries

array getAll()

Get complete config (excludes middleware-applied config)

Return Value

array

$this update(string $class, string $name, mixed $value) deprecated

deprecated 4.0...5.0 Synonym for merge()

Parameters

string $class
string $name
mixed $value

Return Value

$this

$this merge(string $class, string $name, mixed $value)

Merge a config for a class, or a field on that class

Parameters

string $class
string $name
mixed $value

Return Value

$this

array getMetadata()

Returns the entire metadata

Return Value

array

getHistory()

serialize()

unserialize($serialized)

Parameters

$serialized

ConfigCollectionInterface nest()

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