SettingsProvider implements SettingsProviderInterface

Read onlyYes
FinalYes

Settings provider implementation for providing settings definitions and values.

This provider is used internally by the Settings API to manage setting definitions and their corresponding values. It combines default values from definitions with runtime values provided through the settings array.

Internal

Table of Contents

Interfaces

SettingsProviderInterface

Properties

$name  : string

Methods

__construct()  : mixed
getDefinitions()  : array<string|int, SettingDefinition>
getProvidedSettings()  : array<string|int, SettingValue>

Properties

Methods

__construct()

public __construct(string $name, array<string|int, mixed> $settings[, array<string|int, mixed> $definitions = [] ]) : mixed
Parameters
$name : string
$settings : array<string|int, mixed>
$definitions : array<string|int, mixed> = []

getProvidedSettings()

public getProvidedSettings(array<string|int, mixed> $globalDefinitions) : array<string|int, SettingValue>
Parameters
$globalDefinitions : array<string|int, mixed>
Return values
array<string|int, SettingValue>

        
On this page

Search results