Skip to main content
Version: 2024.3

Settings Store

The settings store is a simple key value store and allows to persist any kind of settings into the Pimcore database via API. There is no user interface for the Settings Store available. Compared to the TmpStore the settings do not have an expiry date and will not be cleaned up.

Sample use cases for settings store are:

  • Persist if a bundle is installed.
  • Runtime settings of a bundle.
  • ...

The stored settings can be namespaced/grouped with a scope attribute and can be of following scalar data types usable with SettingsStore::TYPE_* constants:

  • SettingsStore::TYPE_STRING (string)
  • SettingsStore::TYPE_BOOLEAN (bool)
  • SettingsStore::TYPE_INTEGER (int)
  • SettingsStore::TYPE_FLOAT (float)

We highly recommend to use the scope attribute when using the settings store for a bundle (e.g. the bundles name), while you can omit it when using the settings store for your app.

Sample Usage​

Recommended


// store or update setting (id, data, type, scope)
SettingsStore::set('my-setting-id', 'this is some setting value', SettingsStore::TYPE_STRING, 'bundle-settings-1');

// load setting by id (id, scope)
$setting = SettingsStore::get('my-setting-id', 'bundle-settings-1');

// load all settings ids for specific scope
$ids = SettingsStore::getIdsByScope('bundle-settings-1');

// delete setting (id, scope)
SettingsStore::delete('my-setting-id', 'bundle-settings-1');

OR


// store or update setting (id, data, type)
SettingsStore::set('my-setting-id', 'this is some setting value', 'string');

// load setting by id
$setting = SettingsStore::get('my-setting-id');

// load all settings ids for specific scope
$ids = SettingsStore::getIdsByScope('bundle-settings-1');

// delete setting
SettingsStore::delete('my-setting-id');