Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3/**
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; under version 2
7 * of the License (non-upgradable).
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17 *
18 * Copyright (c) 2019 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT);
19 */
20
21namespace oat\tao\model\settings;
22
23/**
24 * Persistence for settings
25 */
26interface SettingsStorageInterface
27{
28    public const SERVICE_ID = 'tao/settingsStorage';
29
30    /**
31     * Store the given setting
32     *
33     * @param string $settingId
34     * @param mixed $data
35     * @return boolean
36     */
37    public function set($settingId, $data);
38
39    /**
40     * Retrieve the given setting's value or null if no setting is found
41     *
42     * @param string $settingId
43     * @return mixed
44     */
45    public function get($settingId);
46
47    /**
48     * Verifies if a given setting already exists
49     *
50     * @param string $settingId
51     * @return boolean
52     */
53    public function exists($settingId);
54
55    /**
56     * Remove the given setting from storage
57     *
58     * @param string $settingId
59     * @return boolean
60     */
61    public function del($settingId);
62}