2013-09-20 22:21:24 +04:00
|
|
|
<?php
|
2013-09-21 00:45:22 +04:00
|
|
|
/**
|
|
|
|
* Copyright (c) 2013 Bart Visscher <bartv@thisnet.nl>
|
2013-09-20 22:21:24 +04:00
|
|
|
* This file is licensed under the Affero General Public License version 3 or
|
|
|
|
* later.
|
|
|
|
* See the COPYING-README file.
|
|
|
|
*
|
|
|
|
*/
|
2013-09-21 00:45:22 +04:00
|
|
|
|
2013-09-20 22:21:24 +04:00
|
|
|
namespace OCP;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Access to all the configuration options ownCloud offers
|
|
|
|
*/
|
|
|
|
interface IConfig {
|
|
|
|
/**
|
2013-09-20 23:40:54 +04:00
|
|
|
* Sets a new system wide value
|
2013-09-20 22:21:24 +04:00
|
|
|
* @param string $key the key of the value, under which will be saved
|
|
|
|
* @param string $value the value that should be stored
|
|
|
|
* @todo need a use case for this
|
|
|
|
*/
|
|
|
|
// public function setSystemValue($key, $value);
|
|
|
|
|
|
|
|
/**
|
2013-09-20 23:40:54 +04:00
|
|
|
* Looks up a system wide defined value
|
2013-09-20 22:21:24 +04:00
|
|
|
* @param string $key the key of the value, under which it was saved
|
|
|
|
* @return string the saved value
|
|
|
|
*/
|
|
|
|
public function getSystemValue($key);
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
2013-09-20 23:40:54 +04:00
|
|
|
* Writes a new app wide value
|
2013-09-21 00:45:22 +04:00
|
|
|
* @param string $appName the appName that we want to store the value under
|
2013-09-20 22:21:24 +04:00
|
|
|
* @param string $key the key of the value, under which will be saved
|
|
|
|
* @param string $value the value that should be stored
|
|
|
|
*/
|
2013-09-21 00:45:22 +04:00
|
|
|
public function setAppValue($appName, $key, $value);
|
2013-09-20 22:21:24 +04:00
|
|
|
|
|
|
|
/**
|
2013-09-20 23:40:54 +04:00
|
|
|
* Looks up an app wide defined value
|
2013-09-21 00:45:22 +04:00
|
|
|
* @param string $appName the appName that we stored the value under
|
2013-09-20 22:21:24 +04:00
|
|
|
* @param string $key the key of the value, under which it was saved
|
|
|
|
* @return string the saved value
|
|
|
|
*/
|
2013-09-21 00:45:22 +04:00
|
|
|
public function getAppValue($appName, $key);
|
2013-09-20 22:21:24 +04:00
|
|
|
|
|
|
|
|
|
|
|
/**
|
2013-09-21 00:45:22 +04:00
|
|
|
* Set a user defined value
|
|
|
|
* @param string $userId the userId of the user that we want to store the value under
|
|
|
|
* @param string $appName the appName that we want to store the value under
|
2013-09-20 22:21:24 +04:00
|
|
|
* @param string $key the key under which the value is being stored
|
|
|
|
* @param string $value the value that you want to store
|
|
|
|
*/
|
2013-09-21 00:45:22 +04:00
|
|
|
public function setUserValue($userId, $appName, $key, $value);
|
2013-09-20 22:21:24 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Shortcut for getting a user defined value
|
2013-09-21 00:45:22 +04:00
|
|
|
* @param string $userId the userId of the user that we want to store the value under
|
|
|
|
* @param string $appName the appName that we stored the value under
|
2013-09-20 22:21:24 +04:00
|
|
|
* @param string $key the key under which the value is being stored
|
|
|
|
*/
|
2013-09-21 00:45:22 +04:00
|
|
|
public function getUserValue($userId, $appName, $key);
|
2013-09-20 22:21:24 +04:00
|
|
|
}
|