SettingsRepository
extends BasicFileRepository
in package
implements
SingletonStrategyInterface
Class ConfigurationRepository
Interfaces, Classes and Traits
- SingletonStrategyInterface
- Interface SingletonStrategyInterface
Table of Contents
- SETTINGS_FILE_NAME = 'settings.json'
- $configuration : StyleEditConfiguration
- $configurationList : ConfigurationCollection
- $fileIO : FileIO
- $settingsFileName : string
- $styleEditConfiguration : StyleEditConfiguration|null
- $themeId : string
- __construct() : mixed
- ConfigurationRepository constructor.
- configurationsList() : ConfigurationCollection
- createForFile() : static
- createForTheme() : SettingsRepository
- getAll() : ConfigurationCollection
- getJsonConfigurationFrom() : Configuration|null
- hasConfiguration() : bool
- saveJsonConfigurationFrom() : mixed
- saveOptionToConfiguration() : void
- configuration() : StyleEditConfiguration
- fileIO() : FileIO
- getExistentSettingsFilename() : string
- getSettingsFilename() : string
- loadJsonFilesFromDisk() : array<string|int, mixed>|mixed
- loadVariantSettings() : mixed
- saveConfigurationToVariant() : void
- saveJsonFilesToDisk() : bool|int
- variantSettingsFilename() : string
- loadSettingsObject() : array<string|int, mixed>|mixed
Constants
SETTINGS_FILE_NAME
public
string
SETTINGS_FILE_NAME
= 'settings.json'
Properties
$configuration
protected
StyleEditConfiguration
$configuration
$configurationList
protected
ConfigurationCollection
$configurationList
$fileIO
protected
FileIO
$fileIO
$settingsFileName
protected
string
$settingsFileName
$styleEditConfiguration
protected
StyleEditConfiguration|null
$styleEditConfiguration
$themeId
protected
string
$themeId
Methods
__construct()
ConfigurationRepository constructor.
public
__construct([FileIO|null $fileIO = null ][, StyleEditConfiguration|null $configurations = null ][, CurrentThemeInterface $themeConfig = null ]) : mixed
Parameters
- $fileIO : FileIO|null = null
- $configurations : StyleEditConfiguration|null = null
- $themeConfig : CurrentThemeInterface = null
Tags
Return values
mixed —configurationsList()
public
configurationsList() : ConfigurationCollection
Tags
Return values
ConfigurationCollection —createForFile()
public
static createForFile( $filename) : static
Parameters
Tags
Return values
static —createForTheme()
public
static createForTheme(string $themeId) : SettingsRepository
Parameters
- $themeId : string
Tags
Return values
SettingsRepository —getAll()
public
getAll() : ConfigurationCollection
Tags
Return values
ConfigurationCollection —getJsonConfigurationFrom()
public
getJsonConfigurationFrom(string $name) : Configuration|null
Parameters
- $name : string
Tags
Return values
Configuration|null —hasConfiguration()
public
hasConfiguration() : bool
Tags
Return values
bool —saveJsonConfigurationFrom()
public
saveJsonConfigurationFrom(array<string|int, Configuration> ...$configurations) : mixed
Parameters
- $configurations : array<string|int, Configuration>
Tags
Return values
mixed —saveOptionToConfiguration()
public
saveOptionToConfiguration(OptionInterface $option) : void
Parameters
- $option : OptionInterface
Tags
Return values
void —configuration()
protected
configuration() : StyleEditConfiguration
Tags
Return values
StyleEditConfiguration —fileIO()
protected
fileIO() : FileIO
Tags
Return values
FileIO —getExistentSettingsFilename()
protected
getExistentSettingsFilename(string $filename) : string
Parameters
- $filename : string
Return values
string —getSettingsFilename()
protected
getSettingsFilename() : string
Tags
Return values
string —loadJsonFilesFromDisk()
protected
loadJsonFilesFromDisk( $filePath) : array<string|int, mixed>|mixed
Parameters
Tags
Return values
array<string|int, mixed>|mixed —loadVariantSettings()
protected
loadVariantSettings( $variantId, $variantOptionId) : mixed
Parameters
Tags
Return values
mixed —saveConfigurationToVariant()
protected
saveConfigurationToVariant(Configuration $configuration, string $variant) : void
Parameters
- $configuration : Configuration
- $variant : string
Tags
Return values
void —saveJsonFilesToDisk()
protected
saveJsonFilesToDisk( $object, $filePath) : bool|int
Parameters
Tags
Return values
bool|int —variantSettingsFilename()
protected
variantSettingsFilename(string $variantId, string $variantOptionId) : string
Parameters
- $variantId : string
- $variantOptionId : string
Tags
Return values
string —loadSettingsObject()
private
loadSettingsObject() : array<string|int, mixed>|mixed