1. interface
  2. SilverStripe
  3. \
  4. Config
  5. \
  6. Collections
  7. \
  8. MutableConfigCollectionInterface

MutableConfigCollectionInterface

interface MutableConfigCollectionInterface implements ConfigCollectionInterface

Methods

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

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

from ConfigCollectionInterface
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 ConfigCollectionInterface
array
getMetadata()

Returns the entire metadata

from ConfigCollectionInterface
getHistory()

No description

from ConfigCollectionInterface
ConfigCollectionInterface
nest()

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

from ConfigCollectionInterface
Middleware[]
getMiddlewares()

No description

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

No description

from ConfigCollectionInterface
$this
addMiddleware(Middleware $middleware)

No description

from ConfigCollectionInterface
array
getAll()

Get complete config (excludes middleware)

from ConfigCollectionInterface
$this
set(string $class, string $name, mixed $value, array $metadata = [])

Sets config for a given field.

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

Merge a config for a class, or a field 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

Details

in ConfigCollectionInterface at line 22
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 ConfigCollectionInterface at line 34
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

in ConfigCollectionInterface at line 41
array getMetadata()

Returns the entire metadata

Return Value

array

in ConfigCollectionInterface at line 48
getHistory()

in ConfigCollectionInterface at line 57
ConfigCollectionInterface nest()

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

Return Value

ConfigCollectionInterface

in ConfigCollectionInterface at line 62
Middleware[] getMiddlewares()

Return Value

Middleware[]

in ConfigCollectionInterface at line 68
$this setMiddlewares(Middleware[] $middlewares)

Parameters

Middleware[] $middlewares

Return Value

$this

in ConfigCollectionInterface at line 74
$this addMiddleware(Middleware $middleware)

Parameters

Middleware $middleware

Return Value

$this

in ConfigCollectionInterface at line 81
array getAll()

Get complete config (excludes middleware)

Return Value

array

at line 17
$this set(string $class, string $name, mixed $value, 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
mixed $value
array $metadata

Return Value

$this

at line 27
$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 36
$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 41
removeAll()

Delete all entries