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

DeltaConfigCollection

class DeltaConfigCollection extends MemoryConfigCollection

Applies config modifications as a set of deltas on top of the middleware, instead of as modifications to the underlying list.

Traits

MiddlewareAware

Constants

REMOVE

Remove delta
MERGE

Merge delta
CLEAR

Remove all config for this class
REPLACE

Replace all config for this class
SET

Set delta

Methods

Middleware[]
getMiddlewares()

No description

$this
setMiddlewares(Middleware[] $middlewares)

No description

from MiddlewareAware
$this
addMiddleware(Middleware $middleware)

No description

from MiddlewareAware
__construct(bool $trackMetadata = false, int $middlewareFlag)

Construct a delta collection

static MemoryConfigCollection
create()

No description

from MemoryConfigCollection
$this
transform(TransformerInterface[] $transformers)

Trigger transformers to load into this store

from MemoryConfigCollection
$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

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

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

from MemoryConfigCollection
$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)

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

No description

from MemoryConfigCollection
$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

from MemoryConfigCollection
getHistory()

No description

from MemoryConfigCollection
serialize()

No description

from MemoryConfigCollection
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.

from MemoryConfigCollection
static DeltaConfigCollection
createFromCollection(ConfigCollectionInterface $parent, int $middlewareFlag)

Create a delta collection from a parent collection

DeltaMiddleware
getDeltaMiddleware()

Get middleware for handling deltas

array
getDeltas(string $class)

Get deltas for the given class

bool
isDeltaReset(string $class = null)

Check if config should be completely reset before getting config

__clone()

No description

Details

at line 105
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 63
__construct(bool $trackMetadata = false, int $middlewareFlag)

Construct a delta collection

Parameters

bool $trackMetadata
int $middlewareFlag Flag to use to disable delta middleware (optional)

in MemoryConfigCollection at line 59
static MemoryConfigCollection create()

Return Value

MemoryConfigCollection

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

Trigger transformers to load into this store

Parameters

TransformerInterface[] $transformers

Return Value

$this

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

in MemoryConfigCollection 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

in MemoryConfigCollection 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 187
$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 219
removeAll()

Delete all entries

in MemoryConfigCollection at line 190
array getAll()

Get complete config (excludes middleware-applied config)

Return Value

array

in MemoryConfigCollection 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 204
$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

in MemoryConfigCollection at line 224
array getMetadata()

Returns the entire metadata

Return Value

array

in MemoryConfigCollection at line 233
getHistory()

in MemoryConfigCollection at line 255
serialize()

at line 148
unserialize($serialized)

Parameters

$serialized

in MemoryConfigCollection 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

at line 77
static DeltaConfigCollection createFromCollection(ConfigCollectionInterface $parent, int $middlewareFlag)

Create a delta collection from a parent collection

Parameters

ConfigCollectionInterface $parent
int $middlewareFlag Flag to use to disable delta middleware (optional)

Return Value

DeltaConfigCollection

at line 100
DeltaMiddleware getDeltaMiddleware()

Get middleware for handling deltas

Return Value

DeltaMiddleware

at line 118
array getDeltas(string $class)

Get deltas for the given class

Parameters

string $class

Return Value

array

at line 132
bool isDeltaReset(string $class = null)

Check if config should be completely reset before getting config

Parameters

string $class Class to check

Return Value

bool

at line 154
__clone()