PHP Интерфейс Piwik\Settings\Storage\Backend\BackendInterface

Показать файл Открыть проект Примеры использования интерфейса

Открытые методы

Метод Описание
delete ( ) : void Deletes all saved settings.
getStorageId ( ) : string Get an id that identifies the current storage. Eg Plugin_$pluginName_Settings could be a storage id for plugin settings. It's kind of like a cache key and the value will be actually used for this by a cache decorator.
load ( ) : array Loads previously saved setting values and returns them (if some were saved)
save ( array $values ) Saves (persists) the current setting values in the database. Always all values that belong to a group of settings or backend needs to be passed. Usually existing values will be deleted and new values will be saved

Описание методов

delete() публичный Метод

Deletes all saved settings.
public delete ( ) : void
Результат void

getStorageId() публичный Метод

Get an id that identifies the current storage. Eg Plugin_$pluginName_Settings could be a storage id for plugin settings. It's kind of like a cache key and the value will be actually used for this by a cache decorator.
public getStorageId ( ) : string
Результат string

load() публичный Метод

Loads previously saved setting values and returns them (if some were saved)
public load ( ) : array
Результат array An array of key value pairs where $settingName => $settingValue. Eg array('settingName1' > 'settingValue1')

save() публичный Метод

Saves (persists) the current setting values in the database. Always all values that belong to a group of settings or backend needs to be passed. Usually existing values will be deleted and new values will be saved
public save ( array $values )
$values array An array of key value pairs where $settingName => $settingValue. Eg array('settingName1' > 'settingValue1')