Configuration

The config that allows the app to set global, app and user settings can be injected from the ServerContainer. All values are saved as strings and must be cast to the correct value.

  1. <?php
  2. namespace OCA\MyApp\AppInfo;
  4. use \OCP\AppFramework\App;
  6. use \OCA\MyApp\Service\AuthorService;
  9. class Application extends App {
  11.     public function __construct(array $urlParams=array()){
  12.         parent::__construct('myapp', $urlParams);
  14.         $container = $this->getContainer();
  16.         /**
  17.          * Controllers
  18.          */
  19.         $container->registerService('AuthorService', function($c) {
  20.             return new AuthorService(
  21.                 $c->query('Config'),
  22.                 $c->query('AppName')
  23.             );
  24.         });
  26.         $container->registerService('Config', function($c) {
  27.             return $c->query('ServerContainer')->getConfig();
  28.         });
  29.     }
  30. }

System values

System values are saved in the config/config.php and allow the app to modify and read the global configuration:

  1. <?php
  2. namespace OCA\MyApp\Service;
  4. use \OCP\IConfig;
  7. class AuthorService {
  9.     private $config;
  10.     private $appName;
  12.     public function __construct(IConfig $config, $appName){
  13.         $this->config = $config;
  14.         $this->appName = $appName;
  15.     }
  17.     public function getSystemValue($key) {
  18.         return $this->config->getSystemValue($key);
  19.     }
  21.     public function setSystemValue($key, $value) {
  22.         $this->config->setSystemValue($key, $value);
  23.     }
  25. }

App values

App values are saved in the database per app and are useful for setting global app settings:

  1. <?php
  2. namespace OCA\MyApp\Service;
  4. use \OCP\IConfig;
  7. class AuthorService {
  9.     private $config;
  10.     private $appName;
  12.     public function __construct(IConfig $config, $appName){
  13.         $this->config = $config;
  14.         $this->appName = $appName;
  15.     }
  17.     public function getAppValue($key) {
  18.         return $this->config->getAppValue($this->appName, $key);
  19.     }
  21.     public function setAppValue($key, $value) {
  22.         $this->config->setAppValue($this->appName, $key, $value);
  23.     }
  25. }

User values

User values are saved in the database per user and app and are good for saving user specific app settings:

  1. <?php
  2. namespace OCA\MyApp\Service;
  4. use \OCP\IConfig;
  7. class AuthorService {
  9.     private $config;
  10.     private $appName;
  12.     public function __construct(IConfig $config, $appName){
  13.         $this->config = $config;
  14.         $this->appName = $appName;
  15.     }
  17.     public function getUserValue($key, $userId) {
  18.         return $this->config->getUserValue($userId, $this->appName, $key);
  19.     }
  21.     public function setUserValue($key, $userId, $value) {
  22.         $this->config->setUserValue($userId, $this->appName, $key, $value);
  23.     }
  25. }