BackendInterface.php
6 years ago
BaseSettingsTable.php
6 years ago
Cache.php
6 years ago
Config.php
6 years ago
MeasurableSettingsTable.php
6 years ago
NullBackend.php
6 years ago
PluginSettingsTable.php
6 years ago
SitesTable.php
6 years ago
BackendInterface.php
48 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Piwik - free/libre analytics platform |
| 4 | * |
| 5 | * @link https://matomo.org |
| 6 | * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 7 | * |
| 8 | */ |
| 9 | namespace Piwik\Settings\Storage\Backend; |
| 10 | |
| 11 | /** |
| 12 | * Interface for a storage backend. Any new storage backend must implement this interface. |
| 13 | */ |
| 14 | interface BackendInterface |
| 15 | { |
| 16 | |
| 17 | /** |
| 18 | * Get an id that identifies the current storage. Eg `Plugin_$pluginName_Settings` could be a storage id |
| 19 | * for plugin settings. It's kind of like a cache key and the value will be actually used for this by a cache |
| 20 | * decorator. |
| 21 | * |
| 22 | * @return string |
| 23 | */ |
| 24 | public function getStorageId(); |
| 25 | |
| 26 | /** |
| 27 | * Saves (persists) the current setting values in the database. Always all values that belong to a group of |
| 28 | * settings or backend needs to be passed. Usually existing values will be deleted and new values will be saved |
| 29 | * @param array $values An array of key value pairs where $settingName => $settingValue. |
| 30 | * Eg array('settingName1' > 'settingValue1') |
| 31 | */ |
| 32 | public function save($values); |
| 33 | |
| 34 | /** |
| 35 | * Deletes all saved settings. |
| 36 | * @return void |
| 37 | */ |
| 38 | public function delete(); |
| 39 | |
| 40 | /** |
| 41 | * Loads previously saved setting values and returns them (if some were saved) |
| 42 | * |
| 43 | * @return array An array of key value pairs where $settingName => $settingValue. |
| 44 | * Eg array('settingName1' > 'settingValue1') |
| 45 | */ |
| 46 | public function load(); |
| 47 | } |
| 48 |