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

MemoryConfigCollection

class MemoryConfigCollection implements MutableConfigCollectionInterface, Serializable

Basic mutable config collection stored in memory

Traits

MiddlewareAware

Methods

Middleware[]
getMiddlewares()

No description

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

No description

from MiddlewareAware
$this
addMiddleware(Middleware $middleware)

No description

from MiddlewareAware
__construct(bool $trackMetadata = false)

ConfigCollection constructor.

static MemoryConfigCollection
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)

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

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

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

ConfigCollectionInterface
nest()

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

Details

in MiddlewareAware at line 15
Middleware[] getMiddlewares()

Return Value

Middleware[]

in MiddlewareAware at line 24
$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 51
__construct(bool $trackMetadata = false)

ConfigCollection constructor.

Parameters

bool $trackMetadata

at line 59
static MemoryConfigCollection create()

Return Value

MemoryConfigCollection

at line 70
$this transform(TransformerInterface[] $transformers)

Trigger transformers to load into this store

Parameters

TransformerInterface[] $transformers

Return Value

$this

at line 78
$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

at line 97
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 152
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 164
$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

at line 177
removeAll()

Delete all entries

at line 190
array getAll()

Get complete config (excludes middleware-applied config)

Return Value

array

at line 205
$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

at line 211
$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

at line 224
array getMetadata()

Returns the entire metadata

Return Value

array

at line 233
getHistory()

at line 255
serialize()

at line 265
unserialize($serialized)

Parameters

$serialized

at line 273
ConfigCollectionInterface nest()

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

Return Value

ConfigCollectionInterface